IndexState constructor
- Input<
String?> ? arn, - Input<
IndexCapacityUnits?> ? capacityUnits, - Input<
String?> ? createdAt, - Input<
String?> ? description, - Input<
List< ? documentMetadataConfigurationUpdates,IndexDocumentMetadataConfigurationUpdate> ?> - Input<
String?> ? edition, - Input<
String?> ? errorMessage, - Input<
List< ? indexStatistics,IndexIndexStatistic> ?> - Input<
String?> ? name, - Input<
String?> ? region, - Input<
String?> ? roleArn, - Input<
IndexServerSideEncryptionConfiguration?> ? serverSideEncryptionConfiguration, - Input<
String?> ? status, - Input<
Map< ? tags,String, String> ?> - Input<
Map< ? tagsAll,String, String> ?> - Input<
String?> ? updatedAt, - Input<
String?> ? userContextPolicy, - Input<
IndexUserGroupResolutionConfiguration?> ? userGroupResolutionConfiguration, - Input<
IndexUserTokenConfigurations?> ? userTokenConfigurations,
Creates a new IndexState.
arn ARN of the Index.
capacityUnits A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
createdAt The Unix datetime that the index was created.
description The description of the Index.
documentMetadataConfigurationUpdates One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Minimum number of 0 items. Maximum number of 500 items. If specified, you must define all elements, including those that are provided by default. These index fields are documented at Amazon Kendra Index documentation. For an example resource that defines these default index fields, refer to the default example above. For an example resource that appends additional index fields, refer to the append example above. All arguments for each block must be specified. Note that blocks cannot be removed since index fields cannot be deleted. This argument is detailed below.
edition The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Use GEN_AI_ENTERPRISE_EDITION for creating generative AI applications. Once you set the edition for an index, it can't be changed. Defaults to ENTERPRISE_EDITION.
errorMessage When the Status field value is FAILED, this contains a message that explains why.
indexStatistics A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
name Specifies the name of the Index.
region Region where this resource will be managed. Defaults to the Region set in the provider configuration.
roleArn An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.
serverSideEncryptionConfiguration A block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Detailed below.
status The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the errorMessage field contains a message that explains why.
tags Tags to apply to the Index. If configured with a provider
tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
updatedAt The Unix datetime that the index was last updated.
userContextPolicy The user context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to UserContextPolicy. Defaults to ATTRIBUTE_FILTER.
userGroupResolutionConfiguration A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.
userTokenConfigurations A block that specifies the user token configuration. Detailed below.
Implementation
const IndexState({
this.arn,
this.capacityUnits,
this.createdAt,
this.description,
this.documentMetadataConfigurationUpdates,
this.edition,
this.errorMessage,
this.indexStatistics,
this.name,
this.region,
this.roleArn,
this.serverSideEncryptionConfiguration,
this.status,
this.tags,
this.tagsAll,
this.updatedAt,
this.userContextPolicy,
this.userGroupResolutionConfiguration,
this.userTokenConfigurations,
});