Class Experience


  • public class Experience
    extends com.pulumi.resources.CustomResource
    Resource for managing an AWS Kendra Experience. ## Example Usage ### Basic Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.kendra.Experience;
     import com.pulumi.aws.kendra.ExperienceArgs;
     import com.pulumi.aws.kendra.inputs.ExperienceConfigurationArgs;
     import com.pulumi.aws.kendra.inputs.ExperienceConfigurationContentSourceConfigurationArgs;
     import com.pulumi.aws.kendra.inputs.ExperienceConfigurationUserIdentityConfigurationArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new Experience("example", ExperienceArgs.builder()
                 .configuration(ExperienceConfigurationArgs.builder()
                     .contentSourceConfiguration(ExperienceConfigurationContentSourceConfigurationArgs.builder()
                         .directPutContent(true)
                         .faqIds(exampleAwsKendraFaq.faqId())
                         .build())
                     .userIdentityConfiguration(ExperienceConfigurationUserIdentityConfigurationArgs.builder()
                         .identityAttributeName("12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245")
                         .build())
                     .build())
                 .indexId(exampleAwsKendraIndex.id())
                 .description("My Kendra Experience")
                 .name("example")
                 .roleArn(exampleAwsIamRole.arn())
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import Kendra Experience using the unique identifiers of the experience and index separated by a slash (`/`). For example: ```sh $ pulumi import aws:kendra/experience:Experience example 1045d08d-66ef-4882-b3ed-dfb7df183e90/b34dfdf7-1f2b-4704-9581-79e00296845f ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<ExperienceConfiguration> configuration()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.List<ExperienceEndpoint>> endpoints()  
      com.pulumi.core.Output<java.lang.String> experienceId()  
      static Experience get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ExperienceState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> indexId()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> roleArn()  
      com.pulumi.core.Output<java.lang.String> status()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Experience

        public Experience​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • Experience

        public Experience​(java.lang.String name,
                          ExperienceArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • Experience

        public Experience​(java.lang.String name,
                          ExperienceArgs args,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the Experience.
      • configuration

        public com.pulumi.core.Output<ExperienceConfiguration> configuration()
        Returns:
        Configuration information for your Amazon Kendra experience. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description for your Amazon Kendra experience.
      • endpoints

        public com.pulumi.core.Output<java.util.List<ExperienceEndpoint>> endpoints()
        Returns:
        Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
      • experienceId

        public com.pulumi.core.Output<java.lang.String> experienceId()
        Returns:
        Unique identifier of the experience.
      • indexId

        public com.pulumi.core.Output<java.lang.String> indexId()
        Returns:
        Identifier of the index for your Amazon Kendra experience.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name for your Amazon Kendra experience.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. > **NOTE:** By default of the AWS Kendra API, updates to an existing `aws.kendra.Experience` resource (e.g. updating the `name`) will also update the `configuration.content_source_configuration.direct_put_content` parameter to `false` if not already provided.
      • roleArn

        public com.pulumi.core.Output<java.lang.String> roleArn()
        Returns:
        ARN of a role with permission to access `Query API`, `QuerySuggestions API`, `SubmitFeedback API`, and `AWS SSO` that stores your user and group information. For more information, see [IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). The following arguments are optional:
      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Current processing status of your Amazon Kendra experience.
      • get

        public static Experience get​(java.lang.String name,
                                     com.pulumi.core.Output<java.lang.String> id,
                                     @Nullable
                                     ExperienceState state,
                                     @Nullable
                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.