pulumi-aws-kotlin/com.pulumi.aws.kendra.kotlin.outputs/GetIndexResult

GetIndexResult

data class GetIndexResult(val arn: String, val capacityUnits: List<GetIndexCapacityUnit>, val createdAt: String, val description: String, val documentMetadataConfigurationUpdates: List<GetIndexDocumentMetadataConfigurationUpdate>, val edition: String, val errorMessage: String, val id: String, val indexStatistics: List<GetIndexIndexStatistic>, val name: String, val roleArn: String, val serverSideEncryptionConfigurations: List<GetIndexServerSideEncryptionConfiguration>, val status: String, val tags: Map<String, String>, val updatedAt: String, val userContextPolicy: String, val userGroupResolutionConfigurations: List<GetIndexUserGroupResolutionConfiguration>, val userTokenConfigurations: List<GetIndexUserTokenConfiguration>)

A collection of values returned by getIndex.

Constructors

fun GetIndexResult(arn: String, capacityUnits: List<GetIndexCapacityUnit>, createdAt: String, description: String, documentMetadataConfigurationUpdates: List<GetIndexDocumentMetadataConfigurationUpdate>, edition: String, errorMessage: String, id: String, indexStatistics: List<GetIndexIndexStatistic>, name: String, roleArn: String, serverSideEncryptionConfigurations: List<GetIndexServerSideEncryptionConfiguration>, status: String, tags: Map<String, String>, updatedAt: String, userContextPolicy: String, userGroupResolutionConfigurations: List<GetIndexUserGroupResolutionConfiguration>, userTokenConfigurations: List<GetIndexUserTokenConfiguration>)

Types

object Companion

Properties

val arn: String

ARN of the Index.

val capacityUnits: List<GetIndexCapacityUnit>

Block that sets the number of additional document storage and query capacity units that should be used by the index. Documented below.

val createdAt: String

Unix datetime that the index was created.

val description: String

Description of the Index.

documentMetadataConfigurationUpdates

val documentMetadataConfigurationUpdates: List<GetIndexDocumentMetadataConfigurationUpdate>

One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Documented below.

val edition: String

Amazon Kendra edition for the index.

val errorMessage: String

When the Status field value is FAILED, this contains a message that explains why.

Identifier of the Index.

indexStatistics

val indexStatistics: List<GetIndexIndexStatistic>

Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Documented below.

val name: String

Name of the index field. Minimum length of 1. Maximum length of 30.

val roleArn: 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.

serverSideEncryptionConfigurations

val serverSideEncryptionConfigurations: List<GetIndexServerSideEncryptionConfiguration>

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. Documented below.

val status: String

Current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the error_message field contains a message that explains why.

val tags: Map<String, String>

Metadata that helps organize the Indices you create.

val updatedAt: String

Unix datetime that the index was last updated.

userContextPolicy

val userContextPolicy: String

User context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to UserContextPolicy(https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.

userGroupResolutionConfigurations

val userGroupResolutionConfigurations: List<GetIndexUserGroupResolutionConfiguration>

A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Documented below.

userTokenConfigurations

val userTokenConfigurations: List<GetIndexUserTokenConfiguration>

A block that specifies the user token configuration. Documented below.