interface CfnIndexProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Kendra.CfnIndexProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnIndexProps |
![]() | software.amazon.awscdk.services.kendra.CfnIndexProps |
![]() | aws_cdk.aws_kendra.CfnIndexProps |
![]() | aws-cdk-lib » aws_kendra » CfnIndexProps |
Properties for defining a CfnIndex
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const cfnIndexProps: kendra.CfnIndexProps = {
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',
},
}],
};
Properties
Name | Type | Description |
---|---|---|
edition | string | Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index. |
name | string | The name of the index. |
role | string | An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. |
capacity | IResolvable | Capacity | Specifies additional capacity units configured for your Enterprise Edition index. |
description? | string | A description for the index. |
document | IResolvable | IResolvable | Document [] | Specifies the properties of an index field. |
server | IResolvable | Server | The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. |
tags? | Cfn [] | An array of key-value pairs to apply to this resource. |
user | string | The user context policy. |
user | IResolvable | IResolvable | User [] | Defines the type of user token used for the index. |
edition
Type:
string
Indicates whether the index is a Enterprise Edition index, a Developer Edition index, or a GenAI Enterprise Edition index.
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
|
Capacity
(optional)
Specifies additional capacity units configured for your Enterprise Edition index.
You can add and remove capacity units to fit your usage requirements.
description?
Type:
string
(optional)
A description for the index.
documentMetadataConfigurations?
Type:
IResolvable
|
IResolvable
|
Document
[]
(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
|
Server
(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:
Cfn
[]
(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 inUserContext
.
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
|
User
[]
(optional)
Defines the type of user token used for the index.