IndexState class
Input properties used for looking up and filtering Index resources.
Constructors
-
IndexState({Input<
String?> ? arn, Input<IndexCapacityUnits?> ? capacityUnits, Input<String?> ? createdAt, Input<String?> ? description, Input<List< ? documentMetadataConfigurationUpdates, Input<IndexDocumentMetadataConfigurationUpdate> ?>String?> ? edition, Input<String?> ? errorMessage, Input<List< ? indexStatistics, Input<IndexIndexStatistic> ?>String?> ? name, Input<String?> ? region, Input<String?> ? roleArn, Input<IndexServerSideEncryptionConfiguration?> ? serverSideEncryptionConfiguration, Input<String?> ? status, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? updatedAt, Input<String?> ? userContextPolicy, Input<IndexUserGroupResolutionConfiguration?> ? userGroupResolutionConfiguration, Input<IndexUserTokenConfigurations?> ? userTokenConfigurations}) -
Creates a new IndexState.
arnARN of the Index.capacityUnitsA block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.createdAtThe Unix datetime that the index was created.descriptionThe description of the Index.documentMetadataConfigurationUpdatesOne 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.editionThe Amazon Kendra edition to use for the index. ChooseDEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. UseGEN_AI_ENTERPRISE_EDITIONfor creating generative AI applications. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION.errorMessageWhen the Status field value isFAILED, this contains a message that explains why.indexStatisticsA block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.nameSpecifies the name of the Index.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.roleArnAn 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 theBatchPutDocumentAPI to index documents from an Amazon S3 bucket.serverSideEncryptionConfigurationA 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.statusThe current status of the index. When the value isACTIVE, the index is ready for use. If the Status field value isFAILED, theerrorMessagefield contains a message that explains why.tagsTags to apply to the Index. If configured with a providertagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.updatedAtThe Unix datetime that the index was last updated.userContextPolicyThe user context policy. Valid values areATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER.userGroupResolutionConfigurationA 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.userTokenConfigurationsA block that specifies the user token configuration. Detailed below.const -
IndexState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN of the Index.
final
-
capacityUnits
→ Input<
IndexCapacityUnits?> ? -
A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
final
-
createdAt
→ Input<
String?> ? -
The Unix datetime that the index was created.
final
-
description
→ Input<
String?> ? -
The description of the Index.
final
-
documentMetadataConfigurationUpdates
→ Input<
List< ?IndexDocumentMetadataConfigurationUpdate> ?> -
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.
final
-
edition
→ Input<
String?> ? -
The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITIONfor indexes intended for development, testing, or proof of concept. UseENTERPRISE_EDITIONfor your production databases. UseGEN_AI_ENTERPRISE_EDITIONfor creating generative AI applications. Once you set the edition for an index, it can't be changed. Defaults toENTERPRISE_EDITION.final -
errorMessage
→ Input<
String?> ? -
When the Status field value is
FAILED, this contains a message that explains why.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
indexStatistics
→ Input<
List< ?IndexIndexStatistic> ?> -
A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
final
-
name
→ Input<
String?> ? -
Specifies the name of the Index.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
roleArn
→ Input<
String?> ? -
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
BatchPutDocumentAPI to index documents from an Amazon S3 bucket.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serverSideEncryptionConfiguration
→ Input<
IndexServerSideEncryptionConfiguration?> ? -
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.
final
-
status
→ Input<
String?> ? -
The current status of the index. When the value is
ACTIVE, the index is ready for use. If the Status field value isFAILED, theerrorMessagefield contains a message that explains why.final -
Tags to apply to the Index. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
updatedAt
→ Input<
String?> ? -
The Unix datetime that the index was last updated.
final
-
userContextPolicy
→ Input<
String?> ? -
The user context policy. Valid values are
ATTRIBUTE_FILTERorUSER_TOKEN. For more information, refer to UserContextPolicy. Defaults toATTRIBUTE_FILTER.final -
userGroupResolutionConfiguration
→ Input<
IndexUserGroupResolutionConfiguration?> ? -
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.
final
-
userTokenConfigurations
→ Input<
IndexUserTokenConfigurations?> ? -
A block that specifies the user token configuration. Detailed below.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited