@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-19T23:09:11.139Z") @Stability(value=Stable) public class CfnDataSource extends CfnResource implements IInspectable
Creates a data source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;
CfnDataSource cfnDataSource = CfnDataSource.Builder.create(this, "MyCfnDataSource")
.alternateDataSourceParameters(List.of(DataSourceParametersProperty.builder()
.amazonElasticsearchParameters(AmazonElasticsearchParametersProperty.builder()
.domain("domain")
.build())
.amazonOpenSearchParameters(AmazonOpenSearchParametersProperty.builder()
.domain("domain")
.build())
.athenaParameters(AthenaParametersProperty.builder()
.workGroup("workGroup")
.build())
.auroraParameters(AuroraParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.auroraPostgreSqlParameters(AuroraPostgreSqlParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.databricksParameters(DatabricksParametersProperty.builder()
.host("host")
.port(123)
.sqlEndpointPath("sqlEndpointPath")
.build())
.mariaDbParameters(MariaDbParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.mySqlParameters(MySqlParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.oracleParameters(OracleParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.postgreSqlParameters(PostgreSqlParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.prestoParameters(PrestoParametersProperty.builder()
.catalog("catalog")
.host("host")
.port(123)
.build())
.rdsParameters(RdsParametersProperty.builder()
.database("database")
.instanceId("instanceId")
.build())
.redshiftParameters(RedshiftParametersProperty.builder()
.database("database")
// the properties below are optional
.clusterId("clusterId")
.host("host")
.port(123)
.build())
.s3Parameters(S3ParametersProperty.builder()
.manifestFileLocation(ManifestFileLocationProperty.builder()
.bucket("bucket")
.key("key")
.build())
.build())
.snowflakeParameters(SnowflakeParametersProperty.builder()
.database("database")
.host("host")
.warehouse("warehouse")
.build())
.sparkParameters(SparkParametersProperty.builder()
.host("host")
.port(123)
.build())
.sqlServerParameters(SqlServerParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.teradataParameters(TeradataParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.build()))
.awsAccountId("awsAccountId")
.credentials(DataSourceCredentialsProperty.builder()
.copySourceArn("copySourceArn")
.credentialPair(CredentialPairProperty.builder()
.password("password")
.username("username")
// the properties below are optional
.alternateDataSourceParameters(List.of(DataSourceParametersProperty.builder()
.amazonElasticsearchParameters(AmazonElasticsearchParametersProperty.builder()
.domain("domain")
.build())
.amazonOpenSearchParameters(AmazonOpenSearchParametersProperty.builder()
.domain("domain")
.build())
.athenaParameters(AthenaParametersProperty.builder()
.workGroup("workGroup")
.build())
.auroraParameters(AuroraParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.auroraPostgreSqlParameters(AuroraPostgreSqlParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.databricksParameters(DatabricksParametersProperty.builder()
.host("host")
.port(123)
.sqlEndpointPath("sqlEndpointPath")
.build())
.mariaDbParameters(MariaDbParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.mySqlParameters(MySqlParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.oracleParameters(OracleParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.postgreSqlParameters(PostgreSqlParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.prestoParameters(PrestoParametersProperty.builder()
.catalog("catalog")
.host("host")
.port(123)
.build())
.rdsParameters(RdsParametersProperty.builder()
.database("database")
.instanceId("instanceId")
.build())
.redshiftParameters(RedshiftParametersProperty.builder()
.database("database")
// the properties below are optional
.clusterId("clusterId")
.host("host")
.port(123)
.build())
.s3Parameters(S3ParametersProperty.builder()
.manifestFileLocation(ManifestFileLocationProperty.builder()
.bucket("bucket")
.key("key")
.build())
.build())
.snowflakeParameters(SnowflakeParametersProperty.builder()
.database("database")
.host("host")
.warehouse("warehouse")
.build())
.sparkParameters(SparkParametersProperty.builder()
.host("host")
.port(123)
.build())
.sqlServerParameters(SqlServerParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.teradataParameters(TeradataParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.build()))
.build())
.secretArn("secretArn")
.build())
.dataSourceId("dataSourceId")
.dataSourceParameters(DataSourceParametersProperty.builder()
.amazonElasticsearchParameters(AmazonElasticsearchParametersProperty.builder()
.domain("domain")
.build())
.amazonOpenSearchParameters(AmazonOpenSearchParametersProperty.builder()
.domain("domain")
.build())
.athenaParameters(AthenaParametersProperty.builder()
.workGroup("workGroup")
.build())
.auroraParameters(AuroraParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.auroraPostgreSqlParameters(AuroraPostgreSqlParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.databricksParameters(DatabricksParametersProperty.builder()
.host("host")
.port(123)
.sqlEndpointPath("sqlEndpointPath")
.build())
.mariaDbParameters(MariaDbParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.mySqlParameters(MySqlParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.oracleParameters(OracleParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.postgreSqlParameters(PostgreSqlParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.prestoParameters(PrestoParametersProperty.builder()
.catalog("catalog")
.host("host")
.port(123)
.build())
.rdsParameters(RdsParametersProperty.builder()
.database("database")
.instanceId("instanceId")
.build())
.redshiftParameters(RedshiftParametersProperty.builder()
.database("database")
// the properties below are optional
.clusterId("clusterId")
.host("host")
.port(123)
.build())
.s3Parameters(S3ParametersProperty.builder()
.manifestFileLocation(ManifestFileLocationProperty.builder()
.bucket("bucket")
.key("key")
.build())
.build())
.snowflakeParameters(SnowflakeParametersProperty.builder()
.database("database")
.host("host")
.warehouse("warehouse")
.build())
.sparkParameters(SparkParametersProperty.builder()
.host("host")
.port(123)
.build())
.sqlServerParameters(SqlServerParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.teradataParameters(TeradataParametersProperty.builder()
.database("database")
.host("host")
.port(123)
.build())
.build())
.errorInfo(DataSourceErrorInfoProperty.builder()
.message("message")
.type("type")
.build())
.name("name")
.permissions(List.of(ResourcePermissionProperty.builder()
.actions(List.of("actions"))
.principal("principal")
.build()))
.sslProperties(SslPropertiesProperty.builder()
.disableSsl(false)
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.type("type")
.vpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
.vpcConnectionArn("vpcConnectionArn")
.build())
.build();
| Modifier and Type | Class and Description |
|---|---|
static interface |
CfnDataSource.AmazonElasticsearchParametersProperty
The parameters for OpenSearch.
|
static interface |
CfnDataSource.AmazonOpenSearchParametersProperty
The parameters for OpenSearch.
|
static interface |
CfnDataSource.AthenaParametersProperty
Parameters for Amazon Athena.
|
static interface |
CfnDataSource.AuroraParametersProperty
Parameters for Amazon Aurora.
|
static interface |
CfnDataSource.AuroraPostgreSqlParametersProperty
Parameters for Amazon Aurora PostgreSQL-Compatible Edition.
|
static class |
CfnDataSource.Builder
A fluent builder for
CfnDataSource. |
static interface |
CfnDataSource.CredentialPairProperty
The combination of user name and password that are used as credentials.
|
static interface |
CfnDataSource.DatabricksParametersProperty
The required parameters that are needed to connect to a Databricks data source.
|
static interface |
CfnDataSource.DataSourceCredentialsProperty
Data source credentials.
|
static interface |
CfnDataSource.DataSourceErrorInfoProperty
Error information for the data source creation or update.
|
static interface |
CfnDataSource.DataSourceParametersProperty
The parameters that Amazon QuickSight uses to connect to your underlying data source.
|
static interface |
CfnDataSource.ManifestFileLocationProperty
Amazon S3 manifest file location.
|
static interface |
CfnDataSource.MariaDbParametersProperty
The parameters for MariaDB.
|
static interface |
CfnDataSource.MySqlParametersProperty
The parameters for MySQL.
|
static interface |
CfnDataSource.OracleParametersProperty
Oracle parameters.
|
static interface |
CfnDataSource.PostgreSqlParametersProperty
The parameters for PostgreSQL.
|
static interface |
CfnDataSource.PrestoParametersProperty
The parameters for Presto.
|
static interface |
CfnDataSource.RdsParametersProperty
The parameters for Amazon RDS.
|
static interface |
CfnDataSource.RedshiftParametersProperty
The parameters for Amazon Redshift.
|
static interface |
CfnDataSource.ResourcePermissionProperty
Permission for the resource.
|
static interface |
CfnDataSource.S3ParametersProperty
The parameters for S3.
|
static interface |
CfnDataSource.SnowflakeParametersProperty
The parameters for Snowflake.
|
static interface |
CfnDataSource.SparkParametersProperty
The parameters for Spark.
|
static interface |
CfnDataSource.SqlServerParametersProperty
The parameters for SQL Server.
|
static interface |
CfnDataSource.SslPropertiesProperty
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
|
static interface |
CfnDataSource.TeradataParametersProperty
The parameters for Teradata.
|
static interface |
CfnDataSource.VpcConnectionPropertiesProperty
VPC connection properties.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnDataSource(Construct scope,
String id)
Create a new `AWS::QuickSight::DataSource`.
|
|
CfnDataSource(Construct scope,
String id,
CfnDataSourceProps props)
Create a new `AWS::QuickSight::DataSource`.
|
protected |
CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
Object |
getAlternateDataSourceParameters()
A set of alternate data source parameters that you want to share for the credentials stored with this data source.
|
String |
getAttrArn()
The Amazon Resource Name (ARN) of the dataset.
|
String |
getAttrCreatedTime()
The time that this data source was created.
|
String |
getAttrLastUpdatedTime()
The last time that this data source was updated.
|
String |
getAttrStatus()
The HTTP status of the request.
|
String |
getAwsAccountId()
The AWS account ID.
|
protected Map<String,Object> |
getCfnProperties() |
Object |
getCredentials()
The credentials Amazon QuickSight that uses to connect to your underlying source.
|
String |
getDataSourceId()
An ID for the data source.
|
Object |
getDataSourceParameters()
The parameters that Amazon QuickSight uses to connect to your underlying source.
|
Object |
getErrorInfo()
Error information from the last update or the creation of the data source.
|
String |
getName()
A display name for the data source.
|
Object |
getPermissions()
A list of resource permissions on the data source.
|
Object |
getSslProperties()
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
|
TagManager |
getTags()
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
|
String |
getType()
The type of the data source.
|
Object |
getVpcConnectionProperties()
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAlternateDataSourceParameters(IResolvable value)
A set of alternate data source parameters that you want to share for the credentials stored with this data source.
|
void |
setAlternateDataSourceParameters(List<Object> value)
A set of alternate data source parameters that you want to share for the credentials stored with this data source.
|
void |
setAwsAccountId(String value)
The AWS account ID.
|
void |
setCredentials(CfnDataSource.DataSourceCredentialsProperty value)
The credentials Amazon QuickSight that uses to connect to your underlying source.
|
void |
setCredentials(IResolvable value)
The credentials Amazon QuickSight that uses to connect to your underlying source.
|
void |
setDataSourceId(String value)
An ID for the data source.
|
void |
setDataSourceParameters(CfnDataSource.DataSourceParametersProperty value)
The parameters that Amazon QuickSight uses to connect to your underlying source.
|
void |
setDataSourceParameters(IResolvable value)
The parameters that Amazon QuickSight uses to connect to your underlying source.
|
void |
setErrorInfo(CfnDataSource.DataSourceErrorInfoProperty value)
Error information from the last update or the creation of the data source.
|
void |
setErrorInfo(IResolvable value)
Error information from the last update or the creation of the data source.
|
void |
setName(String value)
A display name for the data source.
|
void |
setPermissions(IResolvable value)
A list of resource permissions on the data source.
|
void |
setPermissions(List<Object> value)
A list of resource permissions on the data source.
|
void |
setSslProperties(CfnDataSource.SslPropertiesProperty value)
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
|
void |
setSslProperties(IResolvable value)
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
|
void |
setType(String value)
The type of the data source.
|
void |
setVpcConnectionProperties(CfnDataSource.VpcConnectionPropertiesProperty value)
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
|
void |
setVpcConnectionProperties(IResolvable value)
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatejsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnDataSource(@NotNull
Construct scope,
@NotNull
String id,
@Nullable
CfnDataSourceProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties.@Stability(value=Stable)
public CfnDataSource(@NotNull
Construct scope,
@NotNull
String id)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull public String getAttrCreatedTime()
@Stability(value=Stable) @NotNull public String getAttrLastUpdatedTime()
@Stability(value=Stable) @NotNull public String getAttrStatus()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
@Stability(value=Stable) @Nullable public Object getAlternateDataSourceParameters()
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.
@Stability(value=Stable)
public void setAlternateDataSourceParameters(@Nullable
IResolvable value)
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.
@Stability(value=Stable)
public void setAlternateDataSourceParameters(@Nullable
List<Object> value)
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.
@Stability(value=Stable) @Nullable public String getAwsAccountId()
@Stability(value=Stable)
public void setAwsAccountId(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getCredentials()
Currently, only credentials based on user name and password are supported.
@Stability(value=Stable)
public void setCredentials(@Nullable
IResolvable value)
Currently, only credentials based on user name and password are supported.
@Stability(value=Stable)
public void setCredentials(@Nullable
CfnDataSource.DataSourceCredentialsProperty value)
Currently, only credentials based on user name and password are supported.
@Stability(value=Stable) @Nullable public String getDataSourceId()
This ID is unique per AWS Region for each AWS account.
@Stability(value=Stable)
public void setDataSourceId(@Nullable
String value)
This ID is unique per AWS Region for each AWS account.
@Stability(value=Stable) @Nullable public Object getDataSourceParameters()
@Stability(value=Stable)
public void setDataSourceParameters(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setDataSourceParameters(@Nullable
CfnDataSource.DataSourceParametersProperty value)
@Stability(value=Stable) @Nullable public Object getErrorInfo()
@Stability(value=Stable)
public void setErrorInfo(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setErrorInfo(@Nullable
CfnDataSource.DataSourceErrorInfoProperty value)
@Stability(value=Stable) @Nullable public String getName()
@Stability(value=Stable)
public void setName(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getPermissions()
@Stability(value=Stable)
public void setPermissions(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setPermissions(@Nullable
List<Object> value)
@Stability(value=Stable) @Nullable public Object getSslProperties()
@Stability(value=Stable)
public void setSslProperties(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setSslProperties(@Nullable
CfnDataSource.SslPropertiesProperty value)
@Stability(value=Stable) @Nullable public String getType()
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
@Stability(value=Stable)
public void setType(@Nullable
String value)
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
@Stability(value=Stable) @Nullable public Object getVpcConnectionProperties()
@Stability(value=Stable)
public void setVpcConnectionProperties(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setVpcConnectionProperties(@Nullable
CfnDataSource.VpcConnectionPropertiesProperty value)
Copyright © 2023. All rights reserved.