1. Packages
  2. AWS Classic
  3. API Docs
  4. kendra
  5. Experience

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.kendra.Experience

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource for managing an AWS Kendra Experience.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.kendra.Experience("example", {
        indexId: exampleAwsKendraIndex.id,
        description: "My Kendra Experience",
        name: "example",
        roleArn: exampleAwsIamRole.arn,
        configuration: {
            contentSourceConfiguration: {
                directPutContent: true,
                faqIds: [exampleAwsKendraFaq.faqId],
            },
            userIdentityConfiguration: {
                identityAttributeName: "12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245",
            },
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.kendra.Experience("example",
        index_id=example_aws_kendra_index["id"],
        description="My Kendra Experience",
        name="example",
        role_arn=example_aws_iam_role["arn"],
        configuration=aws.kendra.ExperienceConfigurationArgs(
            content_source_configuration=aws.kendra.ExperienceConfigurationContentSourceConfigurationArgs(
                direct_put_content=True,
                faq_ids=[example_aws_kendra_faq["faqId"]],
            ),
            user_identity_configuration=aws.kendra.ExperienceConfigurationUserIdentityConfigurationArgs(
                identity_attribute_name="12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245",
            ),
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kendra"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := kendra.NewExperience(ctx, "example", &kendra.ExperienceArgs{
    			IndexId:     pulumi.Any(exampleAwsKendraIndex.Id),
    			Description: pulumi.String("My Kendra Experience"),
    			Name:        pulumi.String("example"),
    			RoleArn:     pulumi.Any(exampleAwsIamRole.Arn),
    			Configuration: &kendra.ExperienceConfigurationArgs{
    				ContentSourceConfiguration: &kendra.ExperienceConfigurationContentSourceConfigurationArgs{
    					DirectPutContent: pulumi.Bool(true),
    					FaqIds: pulumi.StringArray{
    						exampleAwsKendraFaq.FaqId,
    					},
    				},
    				UserIdentityConfiguration: &kendra.ExperienceConfigurationUserIdentityConfigurationArgs{
    					IdentityAttributeName: pulumi.String("12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Kendra.Experience("example", new()
        {
            IndexId = exampleAwsKendraIndex.Id,
            Description = "My Kendra Experience",
            Name = "example",
            RoleArn = exampleAwsIamRole.Arn,
            Configuration = new Aws.Kendra.Inputs.ExperienceConfigurationArgs
            {
                ContentSourceConfiguration = new Aws.Kendra.Inputs.ExperienceConfigurationContentSourceConfigurationArgs
                {
                    DirectPutContent = true,
                    FaqIds = new[]
                    {
                        exampleAwsKendraFaq.FaqId,
                    },
                },
                UserIdentityConfiguration = new Aws.Kendra.Inputs.ExperienceConfigurationUserIdentityConfigurationArgs
                {
                    IdentityAttributeName = "12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245",
                },
            },
        });
    
    });
    
    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.List;
    import java.util.ArrayList;
    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()
                .indexId(exampleAwsKendraIndex.id())
                .description("My Kendra Experience")
                .name("example")
                .roleArn(exampleAwsIamRole.arn())
                .configuration(ExperienceConfigurationArgs.builder()
                    .contentSourceConfiguration(ExperienceConfigurationContentSourceConfigurationArgs.builder()
                        .directPutContent(true)
                        .faqIds(exampleAwsKendraFaq.faqId())
                        .build())
                    .userIdentityConfiguration(ExperienceConfigurationUserIdentityConfigurationArgs.builder()
                        .identityAttributeName("12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245")
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:kendra:Experience
        properties:
          indexId: ${exampleAwsKendraIndex.id}
          description: My Kendra Experience
          name: example
          roleArn: ${exampleAwsIamRole.arn}
          configuration:
            contentSourceConfiguration:
              directPutContent: true
              faqIds:
                - ${exampleAwsKendraFaq.faqId}
            userIdentityConfiguration:
              identityAttributeName: 12345ec453-1546651e-79c4-4554-91fa-00b43ccfa245
    

    Create Experience Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Experience(name: string, args: ExperienceArgs, opts?: CustomResourceOptions);
    @overload
    def Experience(resource_name: str,
                   args: ExperienceArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Experience(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   index_id: Optional[str] = None,
                   role_arn: Optional[str] = None,
                   configuration: Optional[ExperienceConfigurationArgs] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None)
    func NewExperience(ctx *Context, name string, args ExperienceArgs, opts ...ResourceOption) (*Experience, error)
    public Experience(string name, ExperienceArgs args, CustomResourceOptions? opts = null)
    public Experience(String name, ExperienceArgs args)
    public Experience(String name, ExperienceArgs args, CustomResourceOptions options)
    
    type: aws:kendra:Experience
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ExperienceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ExperienceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ExperienceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExperienceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExperienceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var experienceResource = new Aws.Kendra.Experience("experienceResource", new()
    {
        IndexId = "string",
        RoleArn = "string",
        Configuration = new Aws.Kendra.Inputs.ExperienceConfigurationArgs
        {
            ContentSourceConfiguration = new Aws.Kendra.Inputs.ExperienceConfigurationContentSourceConfigurationArgs
            {
                DataSourceIds = new[]
                {
                    "string",
                },
                DirectPutContent = false,
                FaqIds = new[]
                {
                    "string",
                },
            },
            UserIdentityConfiguration = new Aws.Kendra.Inputs.ExperienceConfigurationUserIdentityConfigurationArgs
            {
                IdentityAttributeName = "string",
            },
        },
        Description = "string",
        Name = "string",
    });
    
    example, err := kendra.NewExperience(ctx, "experienceResource", &kendra.ExperienceArgs{
    	IndexId: pulumi.String("string"),
    	RoleArn: pulumi.String("string"),
    	Configuration: &kendra.ExperienceConfigurationArgs{
    		ContentSourceConfiguration: &kendra.ExperienceConfigurationContentSourceConfigurationArgs{
    			DataSourceIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			DirectPutContent: pulumi.Bool(false),
    			FaqIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    		UserIdentityConfiguration: &kendra.ExperienceConfigurationUserIdentityConfigurationArgs{
    			IdentityAttributeName: pulumi.String("string"),
    		},
    	},
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var experienceResource = new Experience("experienceResource", ExperienceArgs.builder()
        .indexId("string")
        .roleArn("string")
        .configuration(ExperienceConfigurationArgs.builder()
            .contentSourceConfiguration(ExperienceConfigurationContentSourceConfigurationArgs.builder()
                .dataSourceIds("string")
                .directPutContent(false)
                .faqIds("string")
                .build())
            .userIdentityConfiguration(ExperienceConfigurationUserIdentityConfigurationArgs.builder()
                .identityAttributeName("string")
                .build())
            .build())
        .description("string")
        .name("string")
        .build());
    
    experience_resource = aws.kendra.Experience("experienceResource",
        index_id="string",
        role_arn="string",
        configuration=aws.kendra.ExperienceConfigurationArgs(
            content_source_configuration=aws.kendra.ExperienceConfigurationContentSourceConfigurationArgs(
                data_source_ids=["string"],
                direct_put_content=False,
                faq_ids=["string"],
            ),
            user_identity_configuration=aws.kendra.ExperienceConfigurationUserIdentityConfigurationArgs(
                identity_attribute_name="string",
            ),
        ),
        description="string",
        name="string")
    
    const experienceResource = new aws.kendra.Experience("experienceResource", {
        indexId: "string",
        roleArn: "string",
        configuration: {
            contentSourceConfiguration: {
                dataSourceIds: ["string"],
                directPutContent: false,
                faqIds: ["string"],
            },
            userIdentityConfiguration: {
                identityAttributeName: "string",
            },
        },
        description: "string",
        name: "string",
    });
    
    type: aws:kendra:Experience
    properties:
        configuration:
            contentSourceConfiguration:
                dataSourceIds:
                    - string
                directPutContent: false
                faqIds:
                    - string
            userIdentityConfiguration:
                identityAttributeName: string
        description: string
        indexId: string
        name: string
        roleArn: string
    

    Experience Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Experience resource accepts the following input properties:

    IndexId string
    The identifier of the index for your Amazon Kendra experience.
    RoleArn string

    The Amazon Resource Name (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.

    The following arguments are optional:

    Configuration ExperienceConfiguration
    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 string
    A description for your Amazon Kendra experience.
    Name string
    A name for your Amazon Kendra experience.
    IndexId string
    The identifier of the index for your Amazon Kendra experience.
    RoleArn string

    The Amazon Resource Name (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.

    The following arguments are optional:

    Configuration ExperienceConfigurationArgs
    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 string
    A description for your Amazon Kendra experience.
    Name string
    A name for your Amazon Kendra experience.
    indexId String
    The identifier of the index for your Amazon Kendra experience.
    roleArn String

    The Amazon Resource Name (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.

    The following arguments are optional:

    configuration ExperienceConfiguration
    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 String
    A description for your Amazon Kendra experience.
    name String
    A name for your Amazon Kendra experience.
    indexId string
    The identifier of the index for your Amazon Kendra experience.
    roleArn string

    The Amazon Resource Name (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.

    The following arguments are optional:

    configuration ExperienceConfiguration
    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 string
    A description for your Amazon Kendra experience.
    name string
    A name for your Amazon Kendra experience.
    index_id str
    The identifier of the index for your Amazon Kendra experience.
    role_arn str

    The Amazon Resource Name (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.

    The following arguments are optional:

    configuration ExperienceConfigurationArgs
    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 str
    A description for your Amazon Kendra experience.
    name str
    A name for your Amazon Kendra experience.
    indexId String
    The identifier of the index for your Amazon Kendra experience.
    roleArn String

    The Amazon Resource Name (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.

    The following arguments are optional:

    configuration Property Map
    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 String
    A description for your Amazon Kendra experience.
    name String
    A name for your Amazon Kendra experience.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Experience resource produces the following output properties:

    Arn string
    ARN of the Experience.
    Endpoints List<ExperienceEndpoint>
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    ExperienceId string
    The unique identifier of the experience.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The current processing status of your Amazon Kendra experience.
    Arn string
    ARN of the Experience.
    Endpoints []ExperienceEndpoint
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    ExperienceId string
    The unique identifier of the experience.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The current processing status of your Amazon Kendra experience.
    arn String
    ARN of the Experience.
    endpoints List<ExperienceEndpoint>
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    experienceId String
    The unique identifier of the experience.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The current processing status of your Amazon Kendra experience.
    arn string
    ARN of the Experience.
    endpoints ExperienceEndpoint[]
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    experienceId string
    The unique identifier of the experience.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The current processing status of your Amazon Kendra experience.
    arn str
    ARN of the Experience.
    endpoints Sequence[ExperienceEndpoint]
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    experience_id str
    The unique identifier of the experience.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The current processing status of your Amazon Kendra experience.
    arn String
    ARN of the Experience.
    endpoints List<Property Map>
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    experienceId String
    The unique identifier of the experience.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The current processing status of your Amazon Kendra experience.

    Look up Existing Experience Resource

    Get an existing Experience resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ExperienceState, opts?: CustomResourceOptions): Experience
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            configuration: Optional[ExperienceConfigurationArgs] = None,
            description: Optional[str] = None,
            endpoints: Optional[Sequence[ExperienceEndpointArgs]] = None,
            experience_id: Optional[str] = None,
            index_id: Optional[str] = None,
            name: Optional[str] = None,
            role_arn: Optional[str] = None,
            status: Optional[str] = None) -> Experience
    func GetExperience(ctx *Context, name string, id IDInput, state *ExperienceState, opts ...ResourceOption) (*Experience, error)
    public static Experience Get(string name, Input<string> id, ExperienceState? state, CustomResourceOptions? opts = null)
    public static Experience get(String name, Output<String> id, ExperienceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the Experience.
    Configuration ExperienceConfiguration
    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 string
    A description for your Amazon Kendra experience.
    Endpoints List<ExperienceEndpoint>
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    ExperienceId string
    The unique identifier of the experience.
    IndexId string
    The identifier of the index for your Amazon Kendra experience.
    Name string
    A name for your Amazon Kendra experience.
    RoleArn string

    The Amazon Resource Name (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.

    The following arguments are optional:

    Status string
    The current processing status of your Amazon Kendra experience.
    Arn string
    ARN of the Experience.
    Configuration ExperienceConfigurationArgs
    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 string
    A description for your Amazon Kendra experience.
    Endpoints []ExperienceEndpointArgs
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    ExperienceId string
    The unique identifier of the experience.
    IndexId string
    The identifier of the index for your Amazon Kendra experience.
    Name string
    A name for your Amazon Kendra experience.
    RoleArn string

    The Amazon Resource Name (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.

    The following arguments are optional:

    Status string
    The current processing status of your Amazon Kendra experience.
    arn String
    ARN of the Experience.
    configuration ExperienceConfiguration
    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 String
    A description for your Amazon Kendra experience.
    endpoints List<ExperienceEndpoint>
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    experienceId String
    The unique identifier of the experience.
    indexId String
    The identifier of the index for your Amazon Kendra experience.
    name String
    A name for your Amazon Kendra experience.
    roleArn String

    The Amazon Resource Name (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.

    The following arguments are optional:

    status String
    The current processing status of your Amazon Kendra experience.
    arn string
    ARN of the Experience.
    configuration ExperienceConfiguration
    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 string
    A description for your Amazon Kendra experience.
    endpoints ExperienceEndpoint[]
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    experienceId string
    The unique identifier of the experience.
    indexId string
    The identifier of the index for your Amazon Kendra experience.
    name string
    A name for your Amazon Kendra experience.
    roleArn string

    The Amazon Resource Name (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.

    The following arguments are optional:

    status string
    The current processing status of your Amazon Kendra experience.
    arn str
    ARN of the Experience.
    configuration ExperienceConfigurationArgs
    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 str
    A description for your Amazon Kendra experience.
    endpoints Sequence[ExperienceEndpointArgs]
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    experience_id str
    The unique identifier of the experience.
    index_id str
    The identifier of the index for your Amazon Kendra experience.
    name str
    A name for your Amazon Kendra experience.
    role_arn str

    The Amazon Resource Name (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.

    The following arguments are optional:

    status str
    The current processing status of your Amazon Kendra experience.
    arn String
    ARN of the Experience.
    configuration Property Map
    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 String
    A description for your Amazon Kendra experience.
    endpoints List<Property Map>
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by AWS.
    experienceId String
    The unique identifier of the experience.
    indexId String
    The identifier of the index for your Amazon Kendra experience.
    name String
    A name for your Amazon Kendra experience.
    roleArn String

    The Amazon Resource Name (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.

    The following arguments are optional:

    status String
    The current processing status of your Amazon Kendra experience.

    Supporting Types

    ExperienceConfiguration, ExperienceConfigurationArgs

    ContentSourceConfiguration ExperienceConfigurationContentSourceConfiguration
    The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
    UserIdentityConfiguration ExperienceConfigurationUserIdentityConfiguration
    The AWS SSO field name that contains the identifiers of your users, such as their emails. Detailed below.
    ContentSourceConfiguration ExperienceConfigurationContentSourceConfiguration
    The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
    UserIdentityConfiguration ExperienceConfigurationUserIdentityConfiguration
    The AWS SSO field name that contains the identifiers of your users, such as their emails. Detailed below.
    contentSourceConfiguration ExperienceConfigurationContentSourceConfiguration
    The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
    userIdentityConfiguration ExperienceConfigurationUserIdentityConfiguration
    The AWS SSO field name that contains the identifiers of your users, such as their emails. Detailed below.
    contentSourceConfiguration ExperienceConfigurationContentSourceConfiguration
    The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
    userIdentityConfiguration ExperienceConfigurationUserIdentityConfiguration
    The AWS SSO field name that contains the identifiers of your users, such as their emails. Detailed below.
    content_source_configuration ExperienceConfigurationContentSourceConfiguration
    The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
    user_identity_configuration ExperienceConfigurationUserIdentityConfiguration
    The AWS SSO field name that contains the identifiers of your users, such as their emails. Detailed below.
    contentSourceConfiguration Property Map
    The identifiers of your data sources and FAQs. Or, you can specify that you want to use documents indexed via the BatchPutDocument API. The provider will only perform drift detection of its value when present in a configuration. Detailed below.
    userIdentityConfiguration Property Map
    The AWS SSO field name that contains the identifiers of your users, such as their emails. Detailed below.

    ExperienceConfigurationContentSourceConfiguration, ExperienceConfigurationContentSourceConfigurationArgs

    DataSourceIds List<string>
    The identifiers of the data sources you want to use for your Amazon Kendra experience. Maximum number of 100 items.
    DirectPutContent bool
    Whether to use documents you indexed directly using the BatchPutDocument API. Defaults to false.
    FaqIds List<string>
    The identifier of the FAQs that you want to use for your Amazon Kendra experience. Maximum number of 100 items.
    DataSourceIds []string
    The identifiers of the data sources you want to use for your Amazon Kendra experience. Maximum number of 100 items.
    DirectPutContent bool
    Whether to use documents you indexed directly using the BatchPutDocument API. Defaults to false.
    FaqIds []string
    The identifier of the FAQs that you want to use for your Amazon Kendra experience. Maximum number of 100 items.
    dataSourceIds List<String>
    The identifiers of the data sources you want to use for your Amazon Kendra experience. Maximum number of 100 items.
    directPutContent Boolean
    Whether to use documents you indexed directly using the BatchPutDocument API. Defaults to false.
    faqIds List<String>
    The identifier of the FAQs that you want to use for your Amazon Kendra experience. Maximum number of 100 items.
    dataSourceIds string[]
    The identifiers of the data sources you want to use for your Amazon Kendra experience. Maximum number of 100 items.
    directPutContent boolean
    Whether to use documents you indexed directly using the BatchPutDocument API. Defaults to false.
    faqIds string[]
    The identifier of the FAQs that you want to use for your Amazon Kendra experience. Maximum number of 100 items.
    data_source_ids Sequence[str]
    The identifiers of the data sources you want to use for your Amazon Kendra experience. Maximum number of 100 items.
    direct_put_content bool
    Whether to use documents you indexed directly using the BatchPutDocument API. Defaults to false.
    faq_ids Sequence[str]
    The identifier of the FAQs that you want to use for your Amazon Kendra experience. Maximum number of 100 items.
    dataSourceIds List<String>
    The identifiers of the data sources you want to use for your Amazon Kendra experience. Maximum number of 100 items.
    directPutContent Boolean
    Whether to use documents you indexed directly using the BatchPutDocument API. Defaults to false.
    faqIds List<String>
    The identifier of the FAQs that you want to use for your Amazon Kendra experience. Maximum number of 100 items.

    ExperienceConfigurationUserIdentityConfiguration, ExperienceConfigurationUserIdentityConfigurationArgs

    IdentityAttributeName string
    The AWS SSO field name that contains the identifiers of your users, such as their emails.
    IdentityAttributeName string
    The AWS SSO field name that contains the identifiers of your users, such as their emails.
    identityAttributeName String
    The AWS SSO field name that contains the identifiers of your users, such as their emails.
    identityAttributeName string
    The AWS SSO field name that contains the identifiers of your users, such as their emails.
    identity_attribute_name str
    The AWS SSO field name that contains the identifiers of your users, such as their emails.
    identityAttributeName String
    The AWS SSO field name that contains the identifiers of your users, such as their emails.

    ExperienceEndpoint, ExperienceEndpointArgs

    Endpoint string
    The endpoint of your Amazon Kendra experience.
    EndpointType string
    The type of endpoint for your Amazon Kendra experience.
    Endpoint string
    The endpoint of your Amazon Kendra experience.
    EndpointType string
    The type of endpoint for your Amazon Kendra experience.
    endpoint String
    The endpoint of your Amazon Kendra experience.
    endpointType String
    The type of endpoint for your Amazon Kendra experience.
    endpoint string
    The endpoint of your Amazon Kendra experience.
    endpointType string
    The type of endpoint for your Amazon Kendra experience.
    endpoint str
    The endpoint of your Amazon Kendra experience.
    endpoint_type str
    The type of endpoint for your Amazon Kendra experience.
    endpoint String
    The endpoint of your Amazon Kendra experience.
    endpointType String
    The type of endpoint for your Amazon Kendra experience.

    Import

    Using pulumi import, import Kendra Experience using the unique identifiers of the experience and index separated by a slash (/). For example:

    $ pulumi import aws:kendra/experience:Experience example 1045d08d-66ef-4882-b3ed-dfb7df183e90/b34dfdf7-1f2b-4704-9581-79e00296845f
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi