Package com.pulumi.aws.kendra.outputs

Class GetIndexResult

  • public final class GetIndexResult
extends java.lang.Object

    • Method Detail

      • arn

        public java.lang.String arn()
        Returns:
        ARN of the Index.

      • capacityUnits

        public java.util.List<GetIndexCapacityUnit> capacityUnits()
        Returns:
        Block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.

      • createdAt

        public java.lang.String createdAt()
        Returns:
        Unix datetime that the index was created.

      • description

        public java.lang.String description()
        Returns:
        Description of the Index.

      • documentMetadataConfigurationUpdates

        public java.util.List<GetIndexDocumentMetadataConfigurationUpdate> documentMetadataConfigurationUpdates()
        Returns:
        One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Detailed below.

      • edition

        public java.lang.String edition()
        Returns:
        Amazon Kendra edition for the index.

      • errorMessage

        public java.lang.String errorMessage()
        Returns:
        When the Status field value is `FAILED`, this contains a message that explains why.

      • id

        public java.lang.String id()

      • indexStatistics

        public java.util.List<GetIndexIndexStatistic> indexStatistics()
        Returns:
        Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.

      • name

        public java.lang.String name()
        Returns:
        Name of the index field. Minimum length of 1. Maximum length of 30.

      • region

        public java.lang.String region()

      • roleArn

        public java.lang.String roleArn()
        Returns:
        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

        public java.util.List<GetIndexServerSideEncryptionConfiguration> serverSideEncryptionConfigurations()
        Returns:
        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

        public java.lang.String status()
        Returns:
        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

        public java.util.Map<java.lang.String,​java.lang.String> tags()
        Returns:
        Metadata that helps organize the Indices you create.

      • updatedAt

        public java.lang.String updatedAt()
        Returns:
        Unix datetime that the index was last updated.

      • userContextPolicy

        public java.lang.String userContextPolicy()
        Returns:
        User context policy. Valid values are `ATTRIBUTE_FILTER` or `USER_TOKEN`. For more information, refer to [UserContextPolicy](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateIndex.html#kendra-CreateIndex-request-UserContextPolicy).

      • userGroupResolutionConfigurations

        public java.util.List<GetIndexUserGroupResolutionConfiguration> userGroupResolutionConfigurations()
        Returns:
        Block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Detailed below.

      • userTokenConfigurations

        public java.util.List<GetIndexUserTokenConfiguration> userTokenConfigurations()
        Returns:
        Block that specifies the user token configuration. Detailed below.