Class CfnIndex

Creates an Amazon Kendra index.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnIndex
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIndex : CfnResource, IInspectable, IIndexRef, IConstruct, IDependable, ITaggable
Syntax (vb)
Public Class CfnIndex Inherits CfnResource Implements IInspectable, IIndexRef, IConstruct, IDependable, ITaggable
Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

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 cfnIndex = new CfnIndex(this, "MyCfnIndex", 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

Constructors

CfnIndex(Construct, string, ICfnIndexProps)

Creates an Amazon Kendra index.

Properties

AttrArn

The Amazon Resource Name (ARN) of the index.
AttrId

The identifier for the index.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CapacityUnits

Specifies additional capacity units configured for your Enterprise Edition index.
CfnProperties

Creates an Amazon Kendra 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.
IndexRef

A reference to a Index resource.
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

Tag Manager which manages the tags for this resource.
TagsRaw

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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

Creates an Amazon Kendra index.

Constructors

CfnIndex(Construct, string, ICfnIndexProps)

Creates an Amazon Kendra index.

public CfnIndex(Construct scope, string id, ICfnIndexProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnIndexProps

Resource properties.

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the index.

public virtual string AttrArn { get; }
Property Value

string

Remarks

For example: arn:aws:kendra:us-west-2:111122223333:index/0123456789abcdef .

CloudformationAttribute: Arn

AttrId

The identifier for the index.

public virtual string AttrId { get; }
Property Value

string

Remarks

For example: f4aeaa10-8056-4b2c-a343-522ca0f41234 .

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

CapacityUnits

Specifies additional capacity units configured for your Enterprise Edition index.

public virtual object? CapacityUnits { get; set; }
Property Value

object

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

CfnProperties

Creates an Amazon Kendra index.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

Description

A description for the index.

public virtual string? Description { get; set; }
Property Value

string

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

DocumentMetadataConfigurations

Specifies the properties of an index field.

public virtual object? DocumentMetadataConfigurations { get; set; }
Property Value

object

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

Edition

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

public virtual string Edition { get; set; }
Property Value

string

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

IndexRef

A reference to a Index resource.

public virtual IIndexReference IndexRef { get; }
Property Value

IIndexReference

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

Name

The name of the index.

public virtual string Name { get; set; }
Property Value

string

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

RoleArn

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

public virtual string RoleArn { get; set; }
Property Value

string

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

ServerSideEncryptionConfiguration

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

public virtual object? ServerSideEncryptionConfiguration { get; set; }
Property Value

object

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

TagsRaw

An array of key-value pairs to apply to this resource.

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

UserContextPolicy

The user context policy.

public virtual string? UserContextPolicy { get; set; }
Property Value

string

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

UserTokenConfigurations

Defines the type of user token used for the index.

public virtual object? UserTokenConfigurations { get; set; }
Property Value

object

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates an Amazon Kendra index.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.

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

CloudformationResource: AWS::Kendra::Index

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable