Interface CreateDataSourceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateDataSourceRequest.Builder,
,CreateDataSourceRequest> KendraRequest.Builder
,SdkBuilder<CreateDataSourceRequest.Builder,
,CreateDataSourceRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateDataSourceRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) A token that you provide to identify the request to create a data source connector.default CreateDataSourceRequest.Builder
configuration
(Consumer<DataSourceConfiguration.Builder> configuration) Configuration information to connect to your data source repository.configuration
(DataSourceConfiguration configuration) Configuration information to connect to your data source repository.default CreateDataSourceRequest.Builder
customDocumentEnrichmentConfiguration
(Consumer<CustomDocumentEnrichmentConfiguration.Builder> customDocumentEnrichmentConfiguration) Configuration information for altering document metadata and content during the document ingestion process.customDocumentEnrichmentConfiguration
(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration) Configuration information for altering document metadata and content during the document ingestion process.description
(String description) A description for the data source connector.The identifier of the index you want to use with the data source connector.languageCode
(String languageCode) The code for a language.A name for the data source connector.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index.tags
(Collection<Tag> tags) A list of key-value pairs that identify or categorize the data source connector.tags
(Consumer<Tag.Builder>... tags) A list of key-value pairs that identify or categorize the data source connector.A list of key-value pairs that identify or categorize the data source connector.The type of data source repository.type
(DataSourceType type) The type of data source repository.default CreateDataSourceRequest.Builder
vpcConfiguration
(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration) Configuration information for an Amazon Virtual Private Cloud to connect to your data source.vpcConfiguration
(DataSourceVpcConfiguration vpcConfiguration) Configuration information for an Amazon Virtual Private Cloud to connect to your data source.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
A name for the data source connector.
- Parameters:
name
- A name for the data source connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
indexId
The identifier of the index you want to use with the data source connector.
- Parameters:
indexId
- The identifier of the index you want to use with the data source connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The type of data source repository. For example,
SHAREPOINT
.- Parameters:
type
- The type of data source repository. For example,SHAREPOINT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The type of data source repository. For example,
SHAREPOINT
.- Parameters:
type
- The type of data source repository. For example,SHAREPOINT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
configuration
Configuration information to connect to your data source repository.
You can't specify the
Configuration
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.The
Configuration
parameter is required for all other data sources.- Parameters:
configuration
- Configuration information to connect to your data source repository.You can't specify the
Configuration
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.The
Configuration
parameter is required for all other data sources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configuration
default CreateDataSourceRequest.Builder configuration(Consumer<DataSourceConfiguration.Builder> configuration) Configuration information to connect to your data source repository.
You can't specify the
Configuration
parameter when theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.The
This is a convenience method that creates an instance of theConfiguration
parameter is required for all other data sources.DataSourceConfiguration.Builder
avoiding the need to create one manually viaDataSourceConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconfiguration(DataSourceConfiguration)
.- Parameters:
configuration
- a consumer that will call methods onDataSourceConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
vpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.
- Parameters:
vpcConfiguration
- Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcConfiguration
default CreateDataSourceRequest.Builder vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration) Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.
This is a convenience method that creates an instance of theDataSourceVpcConfiguration.Builder
avoiding the need to create one manually viaDataSourceVpcConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcConfiguration(DataSourceVpcConfiguration)
.- Parameters:
vpcConfiguration
- a consumer that will call methods onDataSourceVpcConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
description
A description for the data source connector.
- Parameters:
description
- A description for the data source connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
schedule
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 theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.- Parameters:
schedule
- 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 theStartDataSourceSyncJob
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 theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleArn
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 theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.The
RoleArn
parameter is required for all other data sources.- Parameters:
roleArn
- 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 theType
parameter is set toCUSTOM
. If you do, you receive aValidationException
exception.The
RoleArn
parameter is required for all other data sources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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: _ . : / = + - @.
- Parameters:
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: _ . : / = + - @.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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: _ . : / = + - @.
- Parameters:
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: _ . : / = + - @.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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: _ . : / = + - @.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientToken
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.- Parameters:
clientToken
- A token that you provide to identify the request to create a data source connector. Multiple calls to theCreateDataSource
API with the same client token will create only one data source connector.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
languageCode
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.
- Parameters:
languageCode
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customDocumentEnrichmentConfiguration
CreateDataSourceRequest.Builder customDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration 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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customDocumentEnrichmentConfiguration
default CreateDataSourceRequest.Builder customDocumentEnrichmentConfiguration(Consumer<CustomDocumentEnrichmentConfiguration.Builder> 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.
This is a convenience method that creates an instance of theCustomDocumentEnrichmentConfiguration.Builder
avoiding the need to create one manually viaCustomDocumentEnrichmentConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration)
.- Parameters:
customDocumentEnrichmentConfiguration
- a consumer that will call methods onCustomDocumentEnrichmentConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateDataSourceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateDataSourceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-