Struct aws_sdk_kendra::operation::create_data_source::CreateDataSourceInput

#[non_exhaustive]
pub struct CreateDataSourceInput {
    pub name: Option<String>,
    pub index_id: Option<String>,
    pub type: Option<DataSourceType>,
    pub configuration: Option<DataSourceConfiguration>,
    pub vpc_configuration: Option<DataSourceVpcConfiguration>,
    pub description: Option<String>,
    pub schedule: Option<String>,
    pub role_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub client_token: Option<String>,
    pub language_code: Option<String>,
    pub custom_document_enrichment_configuration: Option<CustomDocumentEnrichmentConfiguration>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

A name for the data source connector.

index_id: Option<String>

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

type: Option<DataSourceType>

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

configuration: 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.

vpc_configuration: Option<DataSourceVpcConfiguration>

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

description: Option<String>

A description for the data source connector.

schedule: 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.

role_arn: 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.

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

client_token: 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.

language_code: 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.

custom_document_enrichment_configuration: 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.

Implementations

impl CreateDataSourceInput

pub fn name(&self) -> Option<&str>

A name for the data source connector.

pub fn index_id(&self) -> Option<&str>

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

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

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

pub fn 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) -> 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) -> Option<&str>

A description for the data source connector.

pub fn schedule(&self) -> Option<&str>

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) -> Option<&str>

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn client_token(&self) -> Option<&str>

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) -> Option<&str>

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, ) -> 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.

impl CreateDataSourceInput

pub fn builder() -> CreateDataSourceInputBuilder

Creates a new builder-style object to manufacture CreateDataSourceInput.

Trait Implementations

impl Clone for CreateDataSourceInput

fn clone(&self) -> CreateDataSourceInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDataSourceInput

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

Formats the value using the given formatter.

impl PartialEq for CreateDataSourceInput

fn eq(&self, other: &CreateDataSourceInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateDataSourceInput