Package com.pulumi.aws.kendra.inputs

Class IndexState

  • public final class IndexState
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the Index.

      • capacityUnits

        public java.util.Optional<com.pulumi.core.Output<IndexCapacityUnitsArgs>> 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.util.Optional<com.pulumi.core.Output<java.lang.String>> createdAt()
        Returns:
        Unix datetime that the index was created.

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description of the Index.

      • documentMetadataConfigurationUpdates

        public java.util.Optional<com.pulumi.core.Output<java.util.List<IndexDocumentMetadataConfigurationUpdateArgs>>> documentMetadataConfigurationUpdates()
        Returns:
        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](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index.html). 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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> edition()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> errorMessage()
        Returns:
        When the Status field value is `FAILED`, this contains a message that explains why.

      • indexStatistics

        public java.util.Optional<com.pulumi.core.Output<java.util.List<IndexIndexStatisticArgs>>> 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.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the Index.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • roleArn

        public java.util.Optional<com.pulumi.core.Output<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.

      • serverSideEncryptionConfiguration

        public java.util.Optional<com.pulumi.core.Output<IndexServerSideEncryptionConfigurationArgs>> serverSideEncryptionConfiguration()
        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.util.Optional<com.pulumi.core.Output<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.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the Index. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • updatedAt

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> updatedAt()
        Returns:
        Unix datetime that the index was last updated.

      • userContextPolicy

        public java.util.Optional<com.pulumi.core.Output<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). Defaults to `ATTRIBUTE_FILTER`.

      • userGroupResolutionConfiguration

        public java.util.Optional<com.pulumi.core.Output<IndexUserGroupResolutionConfigurationArgs>> userGroupResolutionConfiguration()
        Returns:
        Block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see [UserGroupResolutionConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html). Detailed below.

      • userTokenConfigurations

        public java.util.Optional<com.pulumi.core.Output<IndexUserTokenConfigurationsArgs>> userTokenConfigurations()
        Returns:
        Block that specifies the user token configuration. Detailed below.