pub struct CreateDataSourceFluentBuilder { /* private fields */ }
Expand description
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§
Source§impl CreateDataSourceFluentBuilder
impl CreateDataSourceFluentBuilder
Sourcepub fn as_input(&self) -> &CreateDataSourceInputBuilder
pub fn as_input(&self) -> &CreateDataSourceInputBuilder
Access the CreateDataSource as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateDataSourceOutput, SdkError<CreateDataSourceError, HttpResponse>>
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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateDataSourceOutput, CreateDataSourceError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateDataSourceOutput, CreateDataSourceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn index_id(self, input: impl Into<String>) -> Self
pub fn index_id(self, input: impl Into<String>) -> Self
The identifier of the index you want to use with the data source connector.
Sourcepub fn set_index_id(self, input: Option<String>) -> Self
pub fn set_index_id(self, input: Option<String>) -> Self
The identifier of the index you want to use with the data source connector.
Sourcepub fn get_index_id(&self) -> &Option<String>
pub fn get_index_id(&self) -> &Option<String>
The identifier of the index you want to use with the data source connector.
Sourcepub fn type(self, input: DataSourceType) -> Self
pub fn type(self, input: DataSourceType) -> Self
The type of data source repository. For example, SHAREPOINT
.
Sourcepub fn set_type(self, input: Option<DataSourceType>) -> Self
pub fn set_type(self, input: Option<DataSourceType>) -> Self
The type of data source repository. For example, SHAREPOINT
.
Sourcepub fn get_type(&self) -> &Option<DataSourceType>
pub fn get_type(&self) -> &Option<DataSourceType>
The type of data source repository. For example, SHAREPOINT
.
Sourcepub fn configuration(self, input: DataSourceConfiguration) -> Self
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.
Sourcepub fn set_configuration(self, input: Option<DataSourceConfiguration>) -> Self
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.
Sourcepub fn get_configuration(&self) -> &Option<DataSourceConfiguration>
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.
Sourcepub fn vpc_configuration(self, input: DataSourceVpcConfiguration) -> Self
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.
Sourcepub fn set_vpc_configuration(
self,
input: Option<DataSourceVpcConfiguration>,
) -> Self
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.
Sourcepub fn get_vpc_configuration(&self) -> &Option<DataSourceVpcConfiguration>
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.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description for the data source connector.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description for the data source connector.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description for the data source connector.
Sourcepub fn schedule(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_schedule(self, input: Option<String>) -> Self
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.
Sourcepub fn get_schedule(&self) -> &Option<String>
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.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_role_arn(&self) -> &Option<String>
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.
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: _ . : / = + - @.
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: _ . : / = + - @.
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: _ . : / = + - @.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
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.
Sourcepub fn get_client_token(&self) -> &Option<String>
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.
Sourcepub fn language_code(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_language_code(self, input: Option<String>) -> Self
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.
Sourcepub fn get_language_code(&self) -> &Option<String>
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.
Sourcepub fn custom_document_enrichment_configuration(
self,
input: CustomDocumentEnrichmentConfiguration,
) -> Self
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.
Sourcepub fn set_custom_document_enrichment_configuration(
self,
input: Option<CustomDocumentEnrichmentConfiguration>,
) -> Self
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.
Sourcepub fn get_custom_document_enrichment_configuration(
&self,
) -> &Option<CustomDocumentEnrichmentConfiguration>
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§
Source§impl Clone for CreateDataSourceFluentBuilder
impl Clone for CreateDataSourceFluentBuilder
Source§fn clone(&self) -> CreateDataSourceFluentBuilder
fn clone(&self) -> CreateDataSourceFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateDataSourceFluentBuilder
impl !RefUnwindSafe for CreateDataSourceFluentBuilder
impl Send for CreateDataSourceFluentBuilder
impl Sync for CreateDataSourceFluentBuilder
impl Unpin for CreateDataSourceFluentBuilder
impl !UnwindSafe for CreateDataSourceFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);