AWS::Kendra::Index
Specifies a new Amazon Kendra index. And index is a collection of documents and associated metadata that you want to search for relevant documents.
Once the index is active you can add documents to your index using the BatchPutDocument operation or using one of the supported data sources.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Kendra::Index", "Properties" : { "CapacityUnits" :
CapacityUnitsConfiguration
, "Description" :String
, "DocumentMetadataConfigurations" :[ DocumentMetadataConfiguration, ... ]
, "Edition" :String
, "Name" :String
, "RoleArn" :String
, "ServerSideEncryptionConfiguration" :ServerSideEncryptionConfiguration
, "Tags" :[ Tag, ... ]
, "UserContextPolicy" :String
, "UserTokenConfigurations" :[ UserTokenConfiguration, ... ]
} }
YAML
Type: AWS::Kendra::Index Properties: CapacityUnits:
CapacityUnitsConfiguration
Description:String
DocumentMetadataConfigurations:- DocumentMetadataConfiguration
Edition:String
Name:String
RoleArn:String
ServerSideEncryptionConfiguration:ServerSideEncryptionConfiguration
Tags:- Tag
UserContextPolicy:String
UserTokenConfigurations:- UserTokenConfiguration
Properties
CapacityUnits
-
Specifies capacity units configured for your index. You can add and remove capacity units to tune an index to your requirements. You can set capacity units only for Enterprise edition indexes.
Required: No
Type: CapacityUnitsConfiguration
Update requires: No interruption
Description
-
A description of the index.
Required: No
Type: String
Update requires: No interruption
DocumentMetadataConfigurations
-
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.
Required: No
Type: List of DocumentMetadataConfiguration
Update requires: No interruption
Edition
-
Indicates whether the index is a enterprise edition index or a developer edition index. Valid values are
DEVELOPER_EDITION
andENTERPRISE_EDITION
.Required: Yes
Type: String
Allowed values:
DEVELOPER_EDITION | ENTERPRISE_EDITION
Update requires: Replacement
Name
-
The identifier of the index.
Required: Yes
Type: String
Minimum:
1
Maximum:
1000
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*
Update requires: No interruption
RoleArn
-
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.
Required: Yes
Type: String
Update requires: No interruption
ServerSideEncryptionConfiguration
-
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.
Required: No
Type: ServerSideEncryptionConfiguration
Update requires: Replacement
Tags
-
An array of key-value pairs to apply to this resource.
For more information, see Tag.
Required: No
Type: List of Tag
Update requires: No interruption
UserContextPolicy
-
The user context policy.
ATTRIBUTE_FILTER
-
All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.
USER_TOKEN
-
Enables SSO and token-based user access control. All documents with no access control and all documents accessible to the user will be searchable and displayable.
Required: No
Type: String
Update requires: No interruption
-
UserTokenConfigurations
-
Defines the type of user token used for the index.
Required: No
Type: List of UserTokenConfiguration
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the index ID. For example:
{"Ref": "index-id"}
For more information about using the Ref
function, see Ref.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt.