public static final class CfnDataSource.Builder
extends java.lang.Object
CfnDataSource
.Modifier and Type | Method and Description |
---|---|
CfnDataSource.Builder |
alternateDataSourceParameters(IResolvable alternateDataSourceParameters)
A set of alternate data source parameters that you want to share for the credentials stored with this data source.
|
CfnDataSource.Builder |
alternateDataSourceParameters(java.util.List<? extends java.lang.Object> alternateDataSourceParameters)
A set of alternate data source parameters that you want to share for the credentials stored with this data source.
|
CfnDataSource.Builder |
awsAccountId(java.lang.String awsAccountId)
The AWS account ID.
|
CfnDataSource |
build() |
static CfnDataSource.Builder |
create(Construct scope,
java.lang.String id) |
CfnDataSource.Builder |
credentials(CfnDataSource.DataSourceCredentialsProperty credentials)
The credentials Amazon QuickSight that uses to connect to your underlying source.
|
CfnDataSource.Builder |
credentials(IResolvable credentials)
The credentials Amazon QuickSight that uses to connect to your underlying source.
|
CfnDataSource.Builder |
dataSourceId(java.lang.String dataSourceId)
An ID for the data source.
|
CfnDataSource.Builder |
dataSourceParameters(CfnDataSource.DataSourceParametersProperty dataSourceParameters)
The parameters that Amazon QuickSight uses to connect to your underlying source.
|
CfnDataSource.Builder |
dataSourceParameters(IResolvable dataSourceParameters)
The parameters that Amazon QuickSight uses to connect to your underlying source.
|
CfnDataSource.Builder |
errorInfo(CfnDataSource.DataSourceErrorInfoProperty errorInfo)
Error information from the last update or the creation of the data source.
|
CfnDataSource.Builder |
errorInfo(IResolvable errorInfo)
Error information from the last update or the creation of the data source.
|
CfnDataSource.Builder |
name(java.lang.String name)
A display name for the data source.
|
CfnDataSource.Builder |
permissions(IResolvable permissions)
A list of resource permissions on the data source.
|
CfnDataSource.Builder |
permissions(java.util.List<? extends java.lang.Object> permissions)
A list of resource permissions on the data source.
|
CfnDataSource.Builder |
sslProperties(CfnDataSource.SslPropertiesProperty sslProperties)
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
|
CfnDataSource.Builder |
sslProperties(IResolvable sslProperties)
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
|
CfnDataSource.Builder |
tags(java.util.List<? extends CfnTag> tags)
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
|
CfnDataSource.Builder |
type(java.lang.String type)
The type of the data source.
|
CfnDataSource.Builder |
vpcConnectionProperties(CfnDataSource.VpcConnectionPropertiesProperty vpcConnectionProperties)
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
|
CfnDataSource.Builder |
vpcConnectionProperties(IResolvable vpcConnectionProperties)
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
|
public static CfnDataSource.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnDataSource.AmazonElasticsearchParametersProperty.Builder
.public CfnDataSource.Builder alternateDataSourceParameters(IResolvable alternateDataSourceParameters)
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.
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.this
public CfnDataSource.Builder alternateDataSourceParameters(java.util.List<? extends java.lang.Object> alternateDataSourceParameters)
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.
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.this
public CfnDataSource.Builder awsAccountId(java.lang.String awsAccountId)
awsAccountId
- The AWS account ID. This parameter is required.this
public CfnDataSource.Builder credentials(IResolvable credentials)
Currently, only credentials based on user name and password are supported.
credentials
- The credentials Amazon QuickSight that uses to connect to your underlying source. This parameter is required.this
public CfnDataSource.Builder credentials(CfnDataSource.DataSourceCredentialsProperty credentials)
Currently, only credentials based on user name and password are supported.
credentials
- The credentials Amazon QuickSight that uses to connect to your underlying source. This parameter is required.this
public CfnDataSource.Builder dataSourceId(java.lang.String dataSourceId)
This ID is unique per AWS Region for each AWS account.
dataSourceId
- An ID for the data source. This parameter is required.this
public CfnDataSource.Builder dataSourceParameters(IResolvable dataSourceParameters)
dataSourceParameters
- The parameters that Amazon QuickSight uses to connect to your underlying source. This parameter is required.this
public CfnDataSource.Builder dataSourceParameters(CfnDataSource.DataSourceParametersProperty dataSourceParameters)
dataSourceParameters
- The parameters that Amazon QuickSight uses to connect to your underlying source. This parameter is required.this
public CfnDataSource.Builder errorInfo(IResolvable errorInfo)
errorInfo
- Error information from the last update or the creation of the data source. This parameter is required.this
public CfnDataSource.Builder errorInfo(CfnDataSource.DataSourceErrorInfoProperty errorInfo)
errorInfo
- Error information from the last update or the creation of the data source. This parameter is required.this
public CfnDataSource.Builder name(java.lang.String name)
name
- A display name for the data source. This parameter is required.this
public CfnDataSource.Builder permissions(IResolvable permissions)
permissions
- A list of resource permissions on the data source. This parameter is required.this
public CfnDataSource.Builder permissions(java.util.List<? extends java.lang.Object> permissions)
permissions
- A list of resource permissions on the data source. This parameter is required.this
public CfnDataSource.Builder sslProperties(IResolvable sslProperties)
sslProperties
- Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. This parameter is required.this
public CfnDataSource.Builder sslProperties(CfnDataSource.SslPropertiesProperty sslProperties)
sslProperties
- Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. This parameter is required.this
public CfnDataSource.Builder tags(java.util.List<? extends CfnTag> tags)
tags
- Contains a map of the key-value pairs for the resource tag or tags assigned to the data source. This parameter is required.this
public CfnDataSource.Builder type(java.lang.String type)
Use AMAZON_ELASTICSEARCH
for Amazon OpenSearch Service.
type
- The type of the data source. To return a list of all data sources, use `ListDataSources` . This parameter is required.this
public CfnDataSource.Builder vpcConnectionProperties(IResolvable vpcConnectionProperties)
vpcConnectionProperties
- Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. This parameter is required.this
public CfnDataSource.Builder vpcConnectionProperties(CfnDataSource.VpcConnectionPropertiesProperty vpcConnectionProperties)
vpcConnectionProperties
- Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. This parameter is required.this
public CfnDataSource build()