Package software.amazon.awssdk.services.kendra.model

Class CreateIndexRequest

    • Method Detail

      • name

        public final String name()

        A name for the index.

        Returns:
        A name for the index.

      • edition

        public final IndexEdition 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 production. Once you set the edition for an index, it can't be changed.

        The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

        For more information on quota limits for Enterprise and Developer editions, see Quotas.

        If the service returns an enum value that is not available in the current SDK version, edition will return IndexEdition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from editionAsString().

        Returns:
        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 production. Once you set the edition for an index, it can't be changed.

        The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

        For more information on quota limits for Enterprise and Developer editions, see Quotas.

        See Also:
        IndexEdition

      • editionAsString

        public final String editionAsString()

        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 production. Once you set the edition for an index, it can't be changed.

        The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

        For more information on quota limits for Enterprise and Developer editions, see Quotas.

        If the service returns an enum value that is not available in the current SDK version, edition will return IndexEdition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from editionAsString().

        Returns:
        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 production. Once you set the edition for an index, it can't be changed.

        The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

        For more information on quota limits for Enterprise and Developer editions, see Quotas.

        See Also:
        IndexEdition

      • roleArn

        public final String roleArn()

        The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.

        Returns:
        The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.

      • serverSideEncryptionConfiguration

        public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()

        The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

        Returns:
        The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

      • description

        public final String description()

        A description for the index.

        Returns:
        A description for the index.

      • clientToken

        public final String clientToken()

        A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

        Returns:
        A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

        A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

      • hasUserTokenConfigurations

        public final boolean hasUserTokenConfigurations()
        For responses, this returns true if the service returned a value for the UserTokenConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • userTokenConfigurations

        public final List<UserTokenConfiguration> userTokenConfigurations()

        The user token configuration.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserTokenConfigurations() method.

        Returns:
        The user token configuration.

      • userContextPolicy

        public final UserContextPolicy userContextPolicy()

        The user context policy.

        ATTRIBUTE_FILTER

        All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

        USER_TOKEN

        Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

        If the service returns an enum value that is not available in the current SDK version, userContextPolicy will return UserContextPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userContextPolicyAsString().

        Returns:
        The user context policy.

        ATTRIBUTE_FILTER

        All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

        USER_TOKEN

        Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

        See Also:
        UserContextPolicy

      • userContextPolicyAsString

        public final String userContextPolicyAsString()

        The user context policy.

        ATTRIBUTE_FILTER

        All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

        USER_TOKEN

        Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

        If the service returns an enum value that is not available in the current SDK version, userContextPolicy will return UserContextPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userContextPolicyAsString().

        Returns:
        The user context policy.

        ATTRIBUTE_FILTER

        All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

        USER_TOKEN

        Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

        See Also:
        UserContextPolicy

      • userGroupResolutionConfiguration

        public final UserGroupResolutionConfiguration userGroupResolutionConfiguration()

        Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

        Returns:
        Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object