IndexArgs class

The set of arguments for Index. The set of arguments for Index.

Constructors

IndexArgs({Input<IndexCapacityUnits?>? capacityUnits, Input<String?>? description, Input<List<IndexDocumentMetadataConfigurationUpdate>?>? documentMetadataConfigurationUpdates, Input<String?>? edition, Input<String?>? name, Input<String?>? region, required Input<String> roleArn, Input<IndexServerSideEncryptionConfiguration?>? serverSideEncryptionConfiguration, Input<Map<String, String>?>? tags, Input<String?>? userContextPolicy, Input<IndexUserGroupResolutionConfiguration?>? userGroupResolutionConfiguration, Input<IndexUserTokenConfigurations?>? userTokenConfigurations})
Creates a new IndexArgs. capacityUnits A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below. 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. 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. tags Tags to apply to the Index. If configured with a provider 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.
const
IndexArgs.fromMap(Map<String, dynamic> map)
factory

Properties

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
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_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.
final
hashCode → int
The hash code for this object.
no setterinherited
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 BatchPutDocument API 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
tags → Input<Map<String, String>?>?
Tags to apply to the Index. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
userContextPolicy → Input<String?>?
The user context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to UserContextPolicy. Defaults to ATTRIBUTE_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