class CfnIndex (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Kendra.CfnIndex`
Java	`software.amazon.awscdk.services.kendra.CfnIndex`
Python	`aws_cdk.aws_kendra.CfnIndex`
TypeScript	`@aws-cdk/aws-kendra` » `CfnIndex`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::Kendra::Index.

Creates an Amazon Kendra index

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kendra from '@aws-cdk/aws-kendra';
const cfnIndex = new kendra.CfnIndex(this, 'MyCfnIndex', {
  edition: 'edition',
  name: 'name',
  roleArn: 'roleArn',

  // the properties below are optional
  capacityUnits: {
    queryCapacityUnits: 123,
    storageCapacityUnits: 123,
  },
  description: 'description',
  documentMetadataConfigurations: [{
    name: 'name',
    type: 'type',

    // the properties below are optional
    relevance: {
      duration: 'duration',
      freshness: false,
      importance: 123,
      rankOrder: 'rankOrder',
      valueImportanceItems: [{
        key: 'key',
        value: 123,
      }],
    },
    search: {
      displayable: false,
      facetable: false,
      searchable: false,
      sortable: false,
    },
  }],
  serverSideEncryptionConfiguration: {
    kmsKeyId: 'kmsKeyId',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userContextPolicy: 'userContextPolicy',
  userTokenConfigurations: [{
    jsonTokenTypeConfiguration: {
      groupAttributeField: 'groupAttributeField',
      userNameAttributeField: 'userNameAttributeField',
    },
    jwtTokenTypeConfiguration: {
      keyLocation: 'keyLocation',

      // the properties below are optional
      claimRegex: 'claimRegex',
      groupAttributeField: 'groupAttributeField',
      issuer: 'issuer',
      secretManagerArn: 'secretManagerArn',
      url: 'url',
      userNameAttributeField: 'userNameAttributeField',
    },
  }],
});

Initializer

new CfnIndex(scope: Construct, id: string, props: CfnIndexProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnIndexProps — - resource properties.

Create a new AWS::Kendra::Index.

Construct Props

Name	Type	Description
edition	`string`	Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
name	`string`	The name of the index.
roleArn	`string`	An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
capacityUnits?	`IResolvable` `\|` `CapacityUnitsConfigurationProperty`	`AWS::Kendra::Index.CapacityUnits`.
description?	`string`	A description for the index.
documentMetadataConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `DocumentMetadataConfigurationProperty[]`	Specifies the properties of an index field.
serverSideEncryptionConfiguration?	`IResolvable` `\|` `ServerSideEncryptionConfigurationProperty`	The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this resource.
userContextPolicy?	`string`	The user context policy.
userTokenConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `UserTokenConfigurationProperty[]`	Defines the type of user token used for the index.

edition

Type: string

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

Valid values are DEVELOPER_EDITION and ENTERPRISE_EDITION .

name

Type: string

The name of the index.

roleArn

Type: string

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

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

capacityUnits?

Type: IResolvable | CapacityUnitsConfigurationProperty (optional)

AWS::Kendra::Index.CapacityUnits.

description?

Type: string (optional)

A description for the index.

documentMetadataConfigurations?

Type: IResolvable | IResolvable | DocumentMetadataConfigurationProperty[] (optional)

Specifies the properties of an index field.

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.

serverSideEncryptionConfiguration?

Type: IResolvable | ServerSideEncryptionConfigurationProperty (optional)

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

Amazon Kendra doesn't support asymmetric CMKs.

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .

userContextPolicy?

Type: string (optional)

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

userTokenConfigurations?

Type: IResolvable | IResolvable | UserTokenConfigurationProperty[] (optional)

Defines the type of user token used for the index.

Properties

Name	Type	Description
attrArn	`string`	The Amazon Resource Name (ARN) of the index.
attrId	`string`	The identifier for the index.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
edition	`string`	Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name of the index.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
roleArn	`string`	An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	An array of key-value pairs to apply to this resource.
capacityUnits?	`IResolvable` `\|` `CapacityUnitsConfigurationProperty`	`AWS::Kendra::Index.CapacityUnits`.
description?	`string`	A description for the index.
documentMetadataConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `DocumentMetadataConfigurationProperty[]`	Specifies the properties of an index field.
serverSideEncryptionConfiguration?	`IResolvable` `\|` `ServerSideEncryptionConfigurationProperty`	The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
userContextPolicy?	`string`	The user context policy.
userTokenConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `UserTokenConfigurationProperty[]`	Defines the type of user token used for the index.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

The Amazon Resource Name (ARN) of the index.

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

attrId

Type: string

The identifier for the index.

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

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

edition

Type: string

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

Valid values are DEVELOPER_EDITION and ENTERPRISE_EDITION .

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

The name of the index.

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

roleArn

Type: string

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

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

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

capacityUnits?

Type: IResolvable | CapacityUnitsConfigurationProperty (optional)

AWS::Kendra::Index.CapacityUnits.

description?

Type: string (optional)

A description for the index.

documentMetadataConfigurations?

Type: IResolvable | IResolvable | DocumentMetadataConfigurationProperty[] (optional)

Specifies the properties of an index field.

serverSideEncryptionConfiguration?

Type: IResolvable | ServerSideEncryptionConfigurationProperty (optional)

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

Amazon Kendra doesn't support asymmetric CMKs.

userContextPolicy?

Type: string (optional)

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext .

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

userTokenConfigurations?

Type: IResolvable | IResolvable | UserTokenConfigurationProperty[] (optional)

Defines the type of user token used for the index.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }