Package com.pulumi.aws.kendra.inputs

Class IndexState.Builder

  • Enclosing class:
    IndexState
    public static final class IndexState.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

      • Builder

        public Builder​(IndexState defaults)

    • Method Detail

      • arn

        public IndexState.Builder arn​(@Nullable
                              com.pulumi.core.Output<java.lang.String> arn)
        Parameters:
        arn - ARN of the Index.
        Returns:
        builder

      • arn

        public IndexState.Builder arn​(java.lang.String arn)
        Parameters:
        arn - ARN of the Index.
        Returns:
        builder

      • capacityUnits

        public IndexState.Builder capacityUnits​(@Nullable
                                        com.pulumi.core.Output<IndexCapacityUnitsArgs> capacityUnits)
        Parameters:
        capacityUnits - Block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
        Returns:
        builder

      • capacityUnits

        public IndexState.Builder capacityUnits​(IndexCapacityUnitsArgs capacityUnits)
        Parameters:
        capacityUnits - Block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
        Returns:
        builder

      • createdAt

        public IndexState.Builder createdAt​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> createdAt)
        Parameters:
        createdAt - Unix datetime that the index was created.
        Returns:
        builder

      • createdAt

        public IndexState.Builder createdAt​(java.lang.String createdAt)
        Parameters:
        createdAt - Unix datetime that the index was created.
        Returns:
        builder

      • description

        public IndexState.Builder description​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> description)
        Parameters:
        description - Description of the Index.
        Returns:
        builder

      • description

        public IndexState.Builder description​(java.lang.String description)
        Parameters:
        description - Description of the Index.
        Returns:
        builder

      • documentMetadataConfigurationUpdates

        public IndexState.Builder documentMetadataConfigurationUpdates​(@Nullable
                                                               com.pulumi.core.Output<java.util.List<IndexDocumentMetadataConfigurationUpdateArgs>> documentMetadataConfigurationUpdates)
        Parameters:
        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](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.
        Returns:
        builder

      • documentMetadataConfigurationUpdates

        public IndexState.Builder documentMetadataConfigurationUpdates​(java.util.List<IndexDocumentMetadataConfigurationUpdateArgs> documentMetadataConfigurationUpdates)
        Parameters:
        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](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.
        Returns:
        builder

      • documentMetadataConfigurationUpdates

        public IndexState.Builder documentMetadataConfigurationUpdates​(IndexDocumentMetadataConfigurationUpdateArgs... documentMetadataConfigurationUpdates)
        Parameters:
        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](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.
        Returns:
        builder

      • edition

        public IndexState.Builder edition​(@Nullable
                                  com.pulumi.core.Output<java.lang.String> edition)
        Parameters:
        edition - 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`.
        Returns:
        builder

      • edition

        public IndexState.Builder edition​(java.lang.String edition)
        Parameters:
        edition - 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`.
        Returns:
        builder

      • errorMessage

        public IndexState.Builder errorMessage​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> errorMessage)
        Parameters:
        errorMessage - When the Status field value is `FAILED`, this contains a message that explains why.
        Returns:
        builder

      • errorMessage

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

      • indexStatistics

        public IndexState.Builder indexStatistics​(@Nullable
                                          com.pulumi.core.Output<java.util.List<IndexIndexStatisticArgs>> indexStatistics)
        Parameters:
        indexStatistics - Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
        Returns:
        builder

      • indexStatistics

        public IndexState.Builder indexStatistics​(java.util.List<IndexIndexStatisticArgs> indexStatistics)
        Parameters:
        indexStatistics - Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
        Returns:
        builder

      • indexStatistics

        public IndexState.Builder indexStatistics​(IndexIndexStatisticArgs... indexStatistics)
        Parameters:
        indexStatistics - Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
        Returns:
        builder

      • name

        public IndexState.Builder name​(@Nullable
                               com.pulumi.core.Output<java.lang.String> name)
        Parameters:
        name - Name of the Index.
        Returns:
        builder

      • name

        public IndexState.Builder name​(java.lang.String name)
        Parameters:
        name - Name of the Index.
        Returns:
        builder

      • region

        public IndexState.Builder region​(@Nullable
                                 com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - 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.
        Returns:
        builder

      • region

        public IndexState.Builder region​(java.lang.String region)
        Parameters:
        region - 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.
        Returns:
        builder

      • roleArn

        public IndexState.Builder roleArn​(@Nullable
                                  com.pulumi.core.Output<java.lang.String> roleArn)
        Parameters:
        roleArn - 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.
        Returns:
        builder

      • roleArn

        public IndexState.Builder roleArn​(java.lang.String roleArn)
        Parameters:
        roleArn - 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.
        Returns:
        builder

      • serverSideEncryptionConfiguration

        public IndexState.Builder serverSideEncryptionConfiguration​(@Nullable
                                                            com.pulumi.core.Output<IndexServerSideEncryptionConfigurationArgs> serverSideEncryptionConfiguration)
        Parameters:
        serverSideEncryptionConfiguration - 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.
        Returns:
        builder

      • serverSideEncryptionConfiguration

        public IndexState.Builder serverSideEncryptionConfiguration​(IndexServerSideEncryptionConfigurationArgs serverSideEncryptionConfiguration)
        Parameters:
        serverSideEncryptionConfiguration - 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.
        Returns:
        builder

      • status

        public IndexState.Builder status​(@Nullable
                                 com.pulumi.core.Output<java.lang.String> status)
        Parameters:
        status - 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.
        Returns:
        builder

      • status

        public IndexState.Builder status​(java.lang.String status)
        Parameters:
        status - 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.
        Returns:
        builder

      • tags

        public IndexState.Builder tags​(@Nullable
                               com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tags

        public IndexState.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tagsAll

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

      • tagsAll

        public IndexState.Builder tagsAll​(java.util.Map<java.lang.String,​java.lang.String> tagsAll)
        Parameters:
        tagsAll - Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
        Returns:
        builder

      • updatedAt

        public IndexState.Builder updatedAt​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> updatedAt)
        Parameters:
        updatedAt - Unix datetime that the index was last updated.
        Returns:
        builder

      • updatedAt

        public IndexState.Builder updatedAt​(java.lang.String updatedAt)
        Parameters:
        updatedAt - Unix datetime that the index was last updated.
        Returns:
        builder

      • userContextPolicy

        public IndexState.Builder userContextPolicy​(@Nullable
                                            com.pulumi.core.Output<java.lang.String> userContextPolicy)
        Parameters:
        userContextPolicy - 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`.
        Returns:
        builder

      • userContextPolicy

        public IndexState.Builder userContextPolicy​(java.lang.String userContextPolicy)
        Parameters:
        userContextPolicy - 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`.
        Returns:
        builder

      • userGroupResolutionConfiguration

        public IndexState.Builder userGroupResolutionConfiguration​(@Nullable
                                                           com.pulumi.core.Output<IndexUserGroupResolutionConfigurationArgs> userGroupResolutionConfiguration)
        Parameters:
        userGroupResolutionConfiguration - 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.
        Returns:
        builder

      • userGroupResolutionConfiguration

        public IndexState.Builder userGroupResolutionConfiguration​(IndexUserGroupResolutionConfigurationArgs userGroupResolutionConfiguration)
        Parameters:
        userGroupResolutionConfiguration - 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.
        Returns:
        builder

      • userTokenConfigurations

        public IndexState.Builder userTokenConfigurations​(@Nullable
                                                  com.pulumi.core.Output<IndexUserTokenConfigurationsArgs> userTokenConfigurations)
        Parameters:
        userTokenConfigurations - Block that specifies the user token configuration. Detailed below.
        Returns:
        builder

      • userTokenConfigurations

        public IndexState.Builder userTokenConfigurations​(IndexUserTokenConfigurationsArgs userTokenConfigurations)
        Parameters:
        userTokenConfigurations - Block that specifies the user token configuration. Detailed below.
        Returns:
        builder