Struct aws_sdk_kendra::operation::create_index::builders::CreateIndexFluentBuilder

pub struct CreateIndexFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateIndex.

Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or using one of the supported data sources.

For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.

Implementations

impl CreateIndexFluentBuilder

pub fn as_input(&self) -> &CreateIndexInputBuilder

Access the CreateIndex as a reference.

pub async fn send( self ) -> Result<CreateIndexOutput, SdkError<CreateIndexError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateIndexOutput, CreateIndexError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn name(self, input: impl Into<String>) -> Self

A name for the index.

pub fn set_name(self, input: Option<String>) -> Self

A name for the index.

pub fn get_name(&self) -> &Option<String>

A name for the index.

pub fn edition(self, input: IndexEdition) -> Self

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.

pub fn set_edition(self, input: Option<IndexEdition>) -> Self

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.

pub fn get_edition(&self) -> &Option<IndexEdition>

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.

pub fn role_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_role_arn(self, input: Option<String>) -> Self

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.

pub fn get_role_arn(&self) -> &Option<String>

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.

pub fn server_side_encryption_configuration( self, input: ServerSideEncryptionConfiguration ) -> Self

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.

pub fn set_server_side_encryption_configuration( self, input: Option<ServerSideEncryptionConfiguration> ) -> Self

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.

pub fn get_server_side_encryption_configuration( &self ) -> &Option<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.

pub fn description(self, input: impl Into<String>) -> Self

A description for the index.

pub fn set_description(self, input: Option<String>) -> Self

A description for the index.

pub fn get_description(&self) -> &Option<String>

A description for the index.

pub fn client_token(self, input: impl Into<String>) -> Self

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.

pub fn set_client_token(self, input: Option<String>) -> Self

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.

pub fn get_client_token(&self) -> &Option<String>

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.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_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: _ . : / = + - @.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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: _ . : / = + - @.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

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: _ . : / = + - @.

pub fn user_token_configurations(self, input: UserTokenConfiguration) -> Self

Appends an item to UserTokenConfigurations.

To override the contents of this collection use set_user_token_configurations.

The user token configuration.

pub fn set_user_token_configurations( self, input: Option<Vec<UserTokenConfiguration>> ) -> Self

The user token configuration.

pub fn get_user_token_configurations( &self ) -> &Option<Vec<UserTokenConfiguration>>

The user token configuration.

pub fn user_context_policy(self, input: UserContextPolicy) -> Self

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.

pub fn set_user_context_policy(self, input: Option<UserContextPolicy>) -> Self

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.

pub fn get_user_context_policy(&self) -> &Option<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.

pub fn user_group_resolution_configuration( self, input: UserGroupResolutionConfiguration ) -> Self

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration.

pub fn set_user_group_resolution_configuration( self, input: Option<UserGroupResolutionConfiguration> ) -> Self

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration.

pub fn get_user_group_resolution_configuration( &self ) -> &Option<UserGroupResolutionConfiguration>

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration.

Trait Implementations

impl Clone for CreateIndexFluentBuilder

fn clone(&self) -> CreateIndexFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateIndexFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.