Interface CreateDataSourceRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateDataSourceRequest

@Mutable
@NotThreadSafe
public static interface CreateDataSourceRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

Method Summary

Modifier and Type	Method	Description
CreateDataSourceRequest.Builder	awsAccountId(String awsAccountId)	The Amazon Web Services account ID.
default CreateDataSourceRequest.Builder	credentials(Consumer<DataSourceCredentials.Builder> credentials)	The credentials Amazon Quick Sight that uses to connect to your underlying source.
CreateDataSourceRequest.Builder	credentials(DataSourceCredentials credentials)	The credentials Amazon Quick Sight that uses to connect to your underlying source.
CreateDataSourceRequest.Builder	dataSourceId(String dataSourceId)	An ID for the data source.
default CreateDataSourceRequest.Builder	dataSourceParameters(Consumer<DataSourceParameters.Builder> dataSourceParameters)	The parameters that Amazon Quick Sight uses to connect to your underlying source.
CreateDataSourceRequest.Builder	dataSourceParameters(DataSourceParameters dataSourceParameters)	The parameters that Amazon Quick Sight uses to connect to your underlying source.
CreateDataSourceRequest.Builder	folderArns(String... folderArns)	When you create the data source, Amazon Quick Sight adds the data source to these folders.
CreateDataSourceRequest.Builder	folderArns(Collection<String> folderArns)	When you create the data source, Amazon Quick Sight adds the data source to these folders.
CreateDataSourceRequest.Builder	name(String name)	A display name for the data source.
CreateDataSourceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateDataSourceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateDataSourceRequest.Builder	permissions(Collection<ResourcePermission> permissions)	A list of resource permissions on the data source.
CreateDataSourceRequest.Builder	permissions(Consumer<ResourcePermission.Builder>... permissions)	A list of resource permissions on the data source.
CreateDataSourceRequest.Builder	permissions(ResourcePermission... permissions)	A list of resource permissions on the data source.
default CreateDataSourceRequest.Builder	sslProperties(Consumer<SslProperties.Builder> sslProperties)	Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
CreateDataSourceRequest.Builder	sslProperties(SslProperties sslProperties)	Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
CreateDataSourceRequest.Builder	tags(Collection<Tag> tags)	Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
CreateDataSourceRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
CreateDataSourceRequest.Builder	tags(Tag... tags)	Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
CreateDataSourceRequest.Builder	type(String type)	The type of the data source.
CreateDataSourceRequest.Builder	type(DataSourceType type)	The type of the data source.
default CreateDataSourceRequest.Builder	vpcConnectionProperties(Consumer<VpcConnectionProperties.Builder> vpcConnectionProperties)	Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
CreateDataSourceRequest.Builder	vpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties)	Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying 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.quicksight.model.QuickSightRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

awsAccountId

CreateDataSourceRequest.Builder awsAccountId(String awsAccountId)

The Amazon Web Services account ID.

Parameters:

awsAccountId - The Amazon Web Services account ID.

Returns:

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

dataSourceId

CreateDataSourceRequest.Builder dataSourceId(String dataSourceId)

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Parameters:

dataSourceId - An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

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

name

CreateDataSourceRequest.Builder name(String name)

A display name for the data source.

Parameters:

name - A display name for the 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 the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Parameters:

type - The type of the data source. To return a list of all data sources, use ListDataSources .

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

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 the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Parameters:

type - The type of the data source. To return a list of all data sources, use ListDataSources .

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Returns:

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

See Also:

• DataSourceType
• DataSourceType

dataSourceParameters

CreateDataSourceRequest.Builder dataSourceParameters(DataSourceParameters dataSourceParameters)

The parameters that Amazon Quick Sight uses to connect to your underlying source.

Parameters:

dataSourceParameters - The parameters that Amazon Quick Sight uses to connect to your underlying source.

Returns:

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

dataSourceParameters

default CreateDataSourceRequest.Builder dataSourceParameters(Consumer<DataSourceParameters.Builder> dataSourceParameters)

The parameters that Amazon Quick Sight uses to connect to your underlying source.

This is a convenience method that creates an instance of the DataSourceParameters.Builder avoiding the need to create one manually via DataSourceParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSourceParameters(DataSourceParameters).

Parameters:

dataSourceParameters - a consumer that will call methods on DataSourceParameters.Builder

Returns:

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

See Also:

• dataSourceParameters(DataSourceParameters)

credentials

CreateDataSourceRequest.Builder credentials(DataSourceCredentials credentials)

The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

Parameters:

credentials - The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

Returns:

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

credentials

default CreateDataSourceRequest.Builder credentials(Consumer<DataSourceCredentials.Builder> credentials)

The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

This is a convenience method that creates an instance of the DataSourceCredentials.Builder avoiding the need to create one manually via DataSourceCredentials.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to credentials(DataSourceCredentials).

Parameters:

credentials - a consumer that will call methods on DataSourceCredentials.Builder

Returns:

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

See Also:

• credentials(DataSourceCredentials)

permissions

CreateDataSourceRequest.Builder permissions(Collection<ResourcePermission> permissions)

A list of resource permissions on the data source.

Parameters:

permissions - A list of resource permissions on the data source.

Returns:

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

permissions

CreateDataSourceRequest.Builder permissions(ResourcePermission... permissions)

A list of resource permissions on the data source.

Parameters:

permissions - A list of resource permissions on the data source.

Returns:

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

permissions

CreateDataSourceRequest.Builder permissions(Consumer<ResourcePermission.Builder>... permissions)

A list of resource permissions on the data source.

This is a convenience method that creates an instance of the ResourcePermission.Builder avoiding the need to create one manually via ResourcePermission.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to permissions(List<ResourcePermission>).

Parameters:

permissions - a consumer that will call methods on ResourcePermission.Builder

Returns:

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

See Also:

• permissions(java.util.Collection<ResourcePermission>)

vpcConnectionProperties

CreateDataSourceRequest.Builder vpcConnectionProperties(VpcConnectionProperties vpcConnectionProperties)

Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.

Parameters:

vpcConnectionProperties - Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.

Returns:

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

vpcConnectionProperties

default CreateDataSourceRequest.Builder vpcConnectionProperties(Consumer<VpcConnectionProperties.Builder> vpcConnectionProperties)

Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.

This is a convenience method that creates an instance of the VpcConnectionProperties.Builder avoiding the need to create one manually via VpcConnectionProperties.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConnectionProperties(VpcConnectionProperties).

Parameters:

vpcConnectionProperties - a consumer that will call methods on VpcConnectionProperties.Builder

Returns:

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

See Also:

• vpcConnectionProperties(VpcConnectionProperties)

sslProperties

CreateDataSourceRequest.Builder sslProperties(SslProperties sslProperties)

Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.

Parameters:

sslProperties - Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.

Returns:

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

sslProperties

default CreateDataSourceRequest.Builder sslProperties(Consumer<SslProperties.Builder> sslProperties)

Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.

This is a convenience method that creates an instance of the SslProperties.Builder avoiding the need to create one manually via SslProperties.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sslProperties(SslProperties).

Parameters:

sslProperties - a consumer that will call methods on SslProperties.Builder

Returns:

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

See Also:

• sslProperties(SslProperties)

tags

CreateDataSourceRequest.Builder tags(Collection<Tag> tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Returns:

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

tags

CreateDataSourceRequest.Builder tags(Tag... tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Returns:

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

tags

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

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

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

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

folderArns

CreateDataSourceRequest.Builder folderArns(Collection<String> folderArns)

When you create the data source, Amazon Quick Sight adds the data source to these folders.

Parameters:

folderArns - When you create the data source, Amazon Quick Sight adds the data source to these folders.

Returns:

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

folderArns

CreateDataSourceRequest.Builder folderArns(String... folderArns)

When you create the data source, Amazon Quick Sight adds the data source to these folders.

Parameters:

folderArns - When you create the data source, Amazon Quick Sight adds the data source to these folders.

Returns:

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

overrideConfiguration

CreateDataSourceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.