Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Class CfnDataSourcePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.quicksight.CfnDataSourcePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSourcePropsMixin>

Enclosing class:

CfnDataSourcePropsMixin

@Stability(Stable)
public static final class CfnDataSourcePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSourcePropsMixin>

A fluent builder for CfnDataSourcePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnDataSourcePropsMixin.Builder	alternateDataSourceParameters(List<? extends Object> alternateDataSourceParameters)	A set of alternate data source parameters that you want to share for the credentials stored with this data source.
CfnDataSourcePropsMixin.Builder	alternateDataSourceParameters(IResolvable alternateDataSourceParameters)	A set of alternate data source parameters that you want to share for the credentials stored with this data source.
CfnDataSourcePropsMixin.Builder	awsAccountId(String awsAccountId)	The AWS account ID.
CfnDataSourcePropsMixin	build()
static CfnDataSourcePropsMixin.Builder	create()
static CfnDataSourcePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnDataSourcePropsMixin.Builder	credentials(CfnDataSourcePropsMixin.DataSourceCredentialsProperty credentials)	The credentials Amazon Quick Sight that uses to connect to your underlying source.
CfnDataSourcePropsMixin.Builder	credentials(IResolvable credentials)	The credentials Amazon Quick Sight that uses to connect to your underlying source.
CfnDataSourcePropsMixin.Builder	dataSourceId(String dataSourceId)	An ID for the data source.
CfnDataSourcePropsMixin.Builder	dataSourceParameters(CfnDataSourcePropsMixin.DataSourceParametersProperty dataSourceParameters)	The parameters that Amazon Quick Sight uses to connect to your underlying source.
CfnDataSourcePropsMixin.Builder	dataSourceParameters(IResolvable dataSourceParameters)	The parameters that Amazon Quick Sight uses to connect to your underlying source.
CfnDataSourcePropsMixin.Builder	errorInfo(CfnDataSourcePropsMixin.DataSourceErrorInfoProperty errorInfo)	Error information from the last update or the creation of the data source.
CfnDataSourcePropsMixin.Builder	errorInfo(IResolvable errorInfo)	Error information from the last update or the creation of the data source.
CfnDataSourcePropsMixin.Builder	folderArns(List<String> folderArns)
CfnDataSourcePropsMixin.Builder	name(String name)	A display name for the data source.
CfnDataSourcePropsMixin.Builder	permissions(List<? extends Object> permissions)	A list of resource permissions on the data source.
CfnDataSourcePropsMixin.Builder	permissions(IResolvable permissions)	A list of resource permissions on the data source.
CfnDataSourcePropsMixin.Builder	sslProperties(CfnDataSourcePropsMixin.SslPropertiesProperty sslProperties)	Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
CfnDataSourcePropsMixin.Builder	sslProperties(IResolvable sslProperties)	Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
CfnDataSourcePropsMixin.Builder	tags(List<? extends CfnTag> tags)	Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
CfnDataSourcePropsMixin.Builder	type(String type)	The type of the data source.
CfnDataSourcePropsMixin.Builder	vpcConnectionProperties(CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty vpcConnectionProperties)	Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
CfnDataSourcePropsMixin.Builder	vpcConnectionProperties(IResolvable 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDataSourcePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnDataSourcePropsMixin.Builder.

create

@Stability(Stable)
public static CfnDataSourcePropsMixin.Builder create()

Returns:

a new instance of CfnDataSourcePropsMixin.Builder.

alternateDataSourceParameters

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder alternateDataSourceParameters(IResolvable alternateDataSourceParameters)

A set of alternate data source parameters that you want to share for the credentials stored with this data source.

The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

Parameters:

alternateDataSourceParameters - A set of alternate data source parameters that you want to share for the credentials stored with this data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-alternatedatasourceparameters

alternateDataSourceParameters

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder alternateDataSourceParameters(List<? extends Object> alternateDataSourceParameters)

A set of alternate data source parameters that you want to share for the credentials stored with this data source.

The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

Parameters:

alternateDataSourceParameters - A set of alternate data source parameters that you want to share for the credentials stored with this data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-alternatedatasourceparameters

awsAccountId

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder awsAccountId(String awsAccountId)

The AWS account ID.

Parameters:

awsAccountId - The AWS account ID. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-awsaccountid

credentials

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder credentials(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-credentials

credentials

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder credentials(CfnDataSourcePropsMixin.DataSourceCredentialsProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-credentials

dataSourceId

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder dataSourceId(String dataSourceId)

An ID for the data source.

This ID is unique per AWS Region for each AWS account.

Parameters:

dataSourceId - An ID for the data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-datasourceid

dataSourceParameters

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder dataSourceParameters(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-datasourceparameters

dataSourceParameters

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder dataSourceParameters(CfnDataSourcePropsMixin.DataSourceParametersProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-datasourceparameters

errorInfo

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder errorInfo(IResolvable errorInfo)

Error information from the last update or the creation of the data source.

Parameters:

errorInfo - Error information from the last update or the creation of the data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-errorinfo

errorInfo

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder errorInfo(CfnDataSourcePropsMixin.DataSourceErrorInfoProperty errorInfo)

Error information from the last update or the creation of the data source.

Parameters:

errorInfo - Error information from the last update or the creation of the data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-errorinfo

folderArns

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder folderArns(List<String> folderArns)

Parameters:

folderArns - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-folderarns

name

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder name(String name)

A display name for the data source.

Parameters:

name - A display name for the data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-name

permissions

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder permissions(IResolvable permissions)

A list of resource permissions on the data source.

Parameters:

permissions - A list of resource permissions on the data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-permissions

permissions

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder permissions(List<? extends Object> permissions)

A list of resource permissions on the data source.

Parameters:

permissions - A list of resource permissions on the data source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-permissions

sslProperties

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder sslProperties(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-sslproperties

sslProperties

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder sslProperties(CfnDataSourcePropsMixin.SslPropertiesProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-sslproperties

tags

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder tags(List<? extends CfnTag> 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-tags

type

@Stability(Stable)
public CfnDataSourcePropsMixin.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 . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-type

vpcConnectionProperties

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder vpcConnectionProperties(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-vpcconnectionproperties

vpcConnectionProperties

@Stability(Stable)
public CfnDataSourcePropsMixin.Builder vpcConnectionProperties(CfnDataSourcePropsMixin.VpcConnectionPropertiesProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-vpcconnectionproperties

build

@Stability(Stable)
public CfnDataSourcePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataSourcePropsMixin>

Returns:

a newly built instance of CfnDataSourcePropsMixin.