Struct aws_sdk_qbusiness::operation::create_data_source::CreateDataSourceInput

#[non_exhaustive]
pub struct CreateDataSourceInput {
    pub application_id: Option<String>,
    pub index_id: Option<String>,
    pub display_name: Option<String>,
    pub configuration: Option<Document>,
    pub vpc_configuration: Option<DataSourceVpcConfiguration>,
    pub description: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub sync_schedule: Option<String>,
    pub role_arn: Option<String>,
    pub client_token: Option<String>,
    pub document_enrichment_configuration: Option<DocumentEnrichmentConfiguration>,
}

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.

application_id: Option<String>

The identifier of the Amazon Q application the data source will be attached to.

index_id: Option<String>

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

display_name: Option<String>

A name for the data source connector.

configuration: Option<Document>

Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.

vpc_configuration: Option<DataSourceVpcConfiguration>

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q connectors.

description: Option<String>

A description for the data source connector.

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

sync_schedule: Option<String>

Sets the frequency for Amazon Q to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q won't periodically 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.

client_token: Option<String>

A token you provide to identify a 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.

document_enrichment_configuration: Option<DocumentEnrichmentConfiguration>

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

For more information, see Custom document enrichment.

Implementations

impl CreateDataSourceInput

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

The identifier of the Amazon Q application the data source will be attached to.

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

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

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

A name for the data source connector.

pub fn configuration(&self) -> Option<&Document>

Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.

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

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q connectors.

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

A description for the data source connector.

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

Sets the frequency for Amazon Q to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q won't periodically 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.

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

A token you provide to identify a 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 document_enrichment_configuration( &self ) -> Option<&DocumentEnrichmentConfiguration>

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

For more information, see Custom document enrichment.

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CreateDataSourceInput