software.amazon.awssdk.services.kendra.model

Interface CreateDataSourceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>, KendraRequest.Builder, SdkBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDataSourceRequest

public static interface CreateDataSourceRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

Method Summary

Modifier and Type	Method and Description
CreateDataSourceRequest.Builder	clientToken(String clientToken) A token that you provide to identify the request to create a data source.
default CreateDataSourceRequest.Builder	configuration(Consumer<DataSourceConfiguration.Builder> configuration) The connector configuration information that is required to access the repository.
CreateDataSourceRequest.Builder	configuration(DataSourceConfiguration configuration) The connector configuration information that is required to access the repository.
CreateDataSourceRequest.Builder	description(String description) A description for the data source.
CreateDataSourceRequest.Builder	indexId(String indexId) The identifier of the index that should be associated with this data source.
CreateDataSourceRequest.Builder	name(String name) A unique name for the data source.
CreateDataSourceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateDataSourceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateDataSourceRequest.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of a role with permission to access the data source.
CreateDataSourceRequest.Builder	schedule(String schedule) Sets the frequency that Amazon Kendra will check the documents in your repository and update the index.
CreateDataSourceRequest.Builder	tags(Collection<Tag> tags) A list of key-value pairs that identify the data source.
CreateDataSourceRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of key-value pairs that identify the data source.
CreateDataSourceRequest.Builder	tags(Tag... tags) A list of key-value pairs that identify the data source.
CreateDataSourceRequest.Builder	type(DataSourceType type) The type of repository that contains the data source.
CreateDataSourceRequest.Builder	type(String type) The type of repository that contains the data source.

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

CreateDataSourceRequest.Builder name(String name)

A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.

Parameters:

name - A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

indexId

CreateDataSourceRequest.Builder indexId(String indexId)

The identifier of the index that should be associated with this data source.

Parameters:

indexId - The identifier of the index that should be associated with this data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

CreateDataSourceRequest.Builder type(String type)

The type of repository that contains the data source.

Parameters:

type - The type of repository that contains the data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataSourceType, DataSourceType

type

CreateDataSourceRequest.Builder type(DataSourceType type)

The type of repository that contains the data source.

Parameters:

type - The type of repository that contains the data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataSourceType, DataSourceType

configuration

CreateDataSourceRequest.Builder configuration(DataSourceConfiguration configuration)

The connector configuration information that is required to access the 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.

Parameters:

configuration - The connector configuration information that is required to access the 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

configuration

default CreateDataSourceRequest.Builder configuration(Consumer<DataSourceConfiguration.Builder> configuration)

The connector configuration information that is required to access the 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.

This is a convenience that creates an instance of the DataSourceConfiguration.Builder avoiding the need to create one manually via DataSourceConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(DataSourceConfiguration).

Parameters:

configuration - a consumer that will call methods on DataSourceConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

configuration(DataSourceConfiguration)

description

CreateDataSourceRequest.Builder description(String description)

A description for the data source.

Parameters:

description - A description for the data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

schedule

CreateDataSourceRequest.Builder schedule(String schedule)

Sets the frequency that Amazon Kendra will check the documents in your 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 operation to update the index.

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

Parameters:

schedule - Sets the frequency that Amazon Kendra will check the documents in your 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 operation to update the index.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

CreateDataSourceRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of a role with permission to access the data source. For more information, see IAM 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.

Parameters:

roleArn - The Amazon Resource Name (ARN) of a role with permission to access the data source. For more information, see IAM 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateDataSourceRequest.Builder tags(Collection<Tag> tags)

A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.

Parameters:

tags - A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateDataSourceRequest.Builder tags(Tag... tags)

A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.

Parameters:

tags - A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateDataSourceRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of key-value pairs that identify the data source. You can use the tags to identify and organize your resources and to control access to resources.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

clientToken

CreateDataSourceRequest.Builder clientToken(String clientToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateDataSourceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateDataSourceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder