Interface ICfnIndexProps

Properties for defining a CfnIndex.

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnIndexProps

Syntax (vb)

Public Interface ICfnIndexProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Kendra;

             var cfnIndexProps = new CfnIndexProps {
                 Edition = "edition",
                 Name = "name",
                 RoleArn = "roleArn",

                 // the properties below are optional
                 CapacityUnits = new CapacityUnitsConfigurationProperty {
                     QueryCapacityUnits = 123,
                     StorageCapacityUnits = 123
                 },
                 Description = "description",
                 DocumentMetadataConfigurations = new [] { new DocumentMetadataConfigurationProperty {
                     Name = "name",
                     Type = "type",

                     // the properties below are optional
                     Relevance = new RelevanceProperty {
                         Duration = "duration",
                         Freshness = false,
                         Importance = 123,
                         RankOrder = "rankOrder",
                         ValueImportanceItems = new [] { new ValueImportanceItemProperty {
                             Key = "key",
                             Value = 123
                         } }
                     },
                     Search = new SearchProperty {
                         Displayable = false,
                         Facetable = false,
                         Searchable = false,
                         Sortable = false
                     }
                 } },
                 ServerSideEncryptionConfiguration = new ServerSideEncryptionConfigurationProperty {
                     KmsKeyId = "kmsKeyId"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 UserContextPolicy = "userContextPolicy",
                 UserTokenConfigurations = new [] { new UserTokenConfigurationProperty {
                     JsonTokenTypeConfiguration = new JsonTokenTypeConfigurationProperty {
                         GroupAttributeField = "groupAttributeField",
                         UserNameAttributeField = "userNameAttributeField"
                     },
                     JwtTokenTypeConfiguration = new JwtTokenTypeConfigurationProperty {
                         KeyLocation = "keyLocation",

                         // the properties below are optional
                         ClaimRegex = "claimRegex",
                         GroupAttributeField = "groupAttributeField",
                         Issuer = "issuer",
                         SecretManagerArn = "secretManagerArn",
                         Url = "url",
                         UserNameAttributeField = "userNameAttributeField"
                     }
                 } }
             };

Synopsis

Properties

CapacityUnits	Specifies additional capacity units configured for your Enterprise Edition index.
Description	A description for the index.
DocumentMetadataConfigurations	Specifies the properties of an index field.
Edition	Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.
Name	The name of the index.
RoleArn	An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
ServerSideEncryptionConfiguration	The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
Tags	An array of key-value pairs to apply to this resource.
UserContextPolicy	The user context policy.
UserTokenConfigurations	Defines the type of user token used for the index.

Properties

CapacityUnits

Specifies additional capacity units configured for your Enterprise Edition index.

object? CapacityUnits { get; }

Property Value

object

Remarks

You can add and remove capacity units to fit your usage requirements.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-capacityunits

Description

A description for the index.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-description

DocumentMetadataConfigurations

Specifies the properties of an index field.

object? DocumentMetadataConfigurations { get; }

Property Value

object

Remarks

You can add either a custom or a built-in field. You can add and remove built-in fields at any time. When a built-in field is removed it's configuration reverts to the default for the field. Custom fields can't be removed from an index after they are added.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-documentmetadataconfigurations

Edition

Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.

string Edition { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-edition

Name

The name of the index.

string Name { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-name

RoleArn

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.

string RoleArn { get; }

Property Value

string

Remarks

This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-rolearn

ServerSideEncryptionConfiguration

The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.

object? ServerSideEncryptionConfiguration { get; }

Property Value

object

Remarks

Amazon Kendra doesn't support asymmetric CMKs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-serversideencryptionconfiguration

UserContextPolicy

The user context policy.

string? UserContextPolicy { get; }

Property Value

string

Remarks

ATTRIBUTE_FILTER

USER_TOKEN

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-usercontextpolicy

UserTokenConfigurations

Defines the type of user token used for the index.

object? UserTokenConfigurations { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-usertokenconfigurations