Struct aws_sdk_kendra::operation::create_data_source::builders::CreateDataSourceFluentBuilder

pub struct CreateDataSourceFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateDataSource.

Creates a data source connector that you want to use with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

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 CreateDataSourceFluentBuilder

pub fn as_input(&self) -> &CreateDataSourceInputBuilder

Access the CreateDataSource as a reference.

pub async fn send( self, ) -> Result<CreateDataSourceOutput, SdkError<CreateDataSourceError, 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<CreateDataSourceOutput, CreateDataSourceError, 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 data source connector.

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

A name for the data source connector.

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

A name for the data source connector.

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

The identifier of the index you want to use with the data source connector.

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

The identifier of the index you want to use with the data source connector.

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

The identifier of the index you want to use with the data source connector.

pub fn type(self, input: DataSourceType) -> Self

The type of data source repository. For example, SHAREPOINT.

pub fn set_type(self, input: Option<DataSourceType>) -> Self

The type of data source repository. For example, SHAREPOINT.

pub fn get_type(&self) -> &Option<DataSourceType>

The type of data source repository. For example, SHAREPOINT.

pub fn configuration(self, input: DataSourceConfiguration) -> Self

Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

pub fn set_configuration(self, input: Option<DataSourceConfiguration>) -> Self

Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

pub fn get_configuration(&self) -> &Option<DataSourceConfiguration>

Configuration information to connect to your data source repository.

You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The Configuration parameter is required for all other data sources.

pub fn vpc_configuration(self, input: DataSourceVpcConfiguration) -> Self

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

pub fn set_vpc_configuration( self, input: Option<DataSourceVpcConfiguration>, ) -> Self

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

pub fn get_vpc_configuration(&self) -> &Option<DataSourceVpcConfiguration>

Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.

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

A description for the data source connector.

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

A description for the data source connector.

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

A description for the data source connector.

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

Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

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

Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

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

Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand.

You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

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

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

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

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

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

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..

You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

The RoleArn parameter is required for all other data sources.

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 data source connector. You can also use tags to help control access to the data source connector. 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 data source connector. You can also use tags to help control access to the data source connector. 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 data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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

A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

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

A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

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

A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

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

The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

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

The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

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

The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

pub fn custom_document_enrichment_configuration( self, input: CustomDocumentEnrichmentConfiguration, ) -> Self

Configuration information for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

pub fn set_custom_document_enrichment_configuration( self, input: Option<CustomDocumentEnrichmentConfiguration>, ) -> Self

Configuration information for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

pub fn get_custom_document_enrichment_configuration( &self, ) -> &Option<CustomDocumentEnrichmentConfiguration>

Configuration information for altering document metadata and content during the document ingestion process.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Trait Implementations

impl Clone for CreateDataSourceFluentBuilder

fn clone(&self) -> CreateDataSourceFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDataSourceFluentBuilder

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

Formats the value using the given formatter.