Class CfnDataSource
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::QuickSight::DataSource
.
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() .roleArn("roleArn") .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()) // the properties below are optional .roleArn("roleArn") .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() .roleArn("roleArn") .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()) // the properties below are optional .roleArn("roleArn") .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() .roleArn("roleArn") .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()) // the properties below are optional .roleArn("roleArn") .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();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
The parameters for OpenSearch.static interface
The parameters for OpenSearch.static interface
Parameters for Amazon Athena.static interface
Parameters for Amazon Aurora.static interface
Parameters for Amazon Aurora PostgreSQL-Compatible Edition.static final class
A fluent builder forCfnDataSource
.static interface
The combination of user name and password that are used as credentials.static interface
The required parameters that are needed to connect to a Databricks data source.static interface
Data source credentials.static interface
Error information for the data source creation or update.static interface
The parameters that Amazon QuickSight uses to connect to your underlying data source.static interface
Amazon S3 manifest file location.static interface
The parameters for MariaDB.static interface
The parameters for MySQL.static interface
Oracle parameters.static interface
The parameters for PostgreSQL.static interface
The parameters for Presto.static interface
The parameters for Amazon RDS.static interface
The parameters for Amazon Redshift.static interface
Permission for the resource.static interface
The parameters for S3.static interface
The parameters for Snowflake.static interface
The parameters for Spark.static interface
The parameters for SQL Server.static interface
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.static interface
The parameters for Teradata.static interface
VPC connection properties.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnDataSource
(Construct scope, String id) Create a newAWS::QuickSight::DataSource
.CfnDataSource
(Construct scope, String id, CfnDataSourceProps props) Create a newAWS::QuickSight::DataSource
.protected
CfnDataSource
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDataSource
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionA set of alternate data source parameters that you want to share for the credentials stored with this data source.The Amazon Resource Name (ARN) of the dataset.The time that this data source was created.The last time that this data source was updated.The HTTP status of the request.The AWS account ID.The credentials Amazon QuickSight that uses to connect to your underlying source.An ID for the data source.The parameters that Amazon QuickSight uses to connect to your underlying source.Error information from the last update or the creation of the data source.getName()
A display name for the data source.A list of resource permissions on the data source.Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.getTags()
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.getType()
The type of the data source.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.renderProperties
(Map<String, Object> props) void
A set of alternate data source parameters that you want to share for the credentials stored with this data source.void
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
(IResolvable value) The credentials Amazon QuickSight that uses to connect to your underlying source.void
The credentials Amazon QuickSight that uses to connect to your underlying source.void
setDataSourceId
(String value) An ID for the data source.void
The parameters that Amazon QuickSight uses to connect to your underlying source.void
The parameters that Amazon QuickSight uses to connect to your underlying source.void
setErrorInfo
(IResolvable value) Error information from the last update or the creation of the data source.void
Error information from the last update or the creation of the data source.void
A display name for the data source.void
setPermissions
(List<Object> value) A list of resource permissions on the data source.void
setPermissions
(IResolvable value) A list of resource permissions on the data source.void
setSslProperties
(IResolvable value) Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.void
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.void
The type of the data source.void
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.void
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDataSource
protected CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDataSource
protected CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDataSource
@Stability(Stable) public CfnDataSource(@NotNull Construct scope, @NotNull String id, @Nullable CfnDataSourceProps props) Create a newAWS::QuickSight::DataSource
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnDataSource
Create a newAWS::QuickSight::DataSource
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the dataset. -
getAttrCreatedTime
The time that this data source was created. -
getAttrLastUpdatedTime
The last time that this data source was updated. -
getAttrStatus
The HTTP status of the request. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source. -
getAlternateDataSourceParameters
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 theAlternateDataSourceParameters
allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If theAlternateDataSourceParameters
list is null, theCredentials
originally used with thisDataSourceParameters
are automatically allowed. -
setAlternateDataSourceParameters
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 theAlternateDataSourceParameters
allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If theAlternateDataSourceParameters
list is null, theCredentials
originally used with thisDataSourceParameters
are automatically allowed. -
setAlternateDataSourceParameters
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 theAlternateDataSourceParameters
allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If theAlternateDataSourceParameters
list is null, theCredentials
originally used with thisDataSourceParameters
are automatically allowed. -
getAwsAccountId
The AWS account ID. -
setAwsAccountId
The AWS account ID. -
getCredentials
The credentials Amazon QuickSight that uses to connect to your underlying source.Currently, only credentials based on user name and password are supported.
-
setCredentials
The credentials Amazon QuickSight that uses to connect to your underlying source.Currently, only credentials based on user name and password are supported.
-
setCredentials
@Stability(Stable) public void setCredentials(@Nullable CfnDataSource.DataSourceCredentialsProperty value) The credentials Amazon QuickSight that uses to connect to your underlying source.Currently, only credentials based on user name and password are supported.
-
getDataSourceId
An ID for the data source.This ID is unique per AWS Region for each AWS account.
-
setDataSourceId
An ID for the data source.This ID is unique per AWS Region for each AWS account.
-
getDataSourceParameters
The parameters that Amazon QuickSight uses to connect to your underlying source. -
setDataSourceParameters
The parameters that Amazon QuickSight uses to connect to your underlying source. -
setDataSourceParameters
@Stability(Stable) public void setDataSourceParameters(@Nullable CfnDataSource.DataSourceParametersProperty value) The parameters that Amazon QuickSight uses to connect to your underlying source. -
getErrorInfo
Error information from the last update or the creation of the data source. -
setErrorInfo
Error information from the last update or the creation of the data source. -
setErrorInfo
@Stability(Stable) public void setErrorInfo(@Nullable CfnDataSource.DataSourceErrorInfoProperty value) Error information from the last update or the creation of the data source. -
getName
A display name for the data source. -
setName
A display name for the data source. -
getPermissions
A list of resource permissions on the data source. -
setPermissions
A list of resource permissions on the data source. -
setPermissions
A list of resource permissions on the data source. -
getSslProperties
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. -
setSslProperties
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. -
setSslProperties
@Stability(Stable) public void setSslProperties(@Nullable CfnDataSource.SslPropertiesProperty value) Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. -
getType
The type of the data source. To return a list of all data sources, useListDataSources
.Use
AMAZON_ELASTICSEARCH
for Amazon OpenSearch Service. -
setType
The type of the data source. To return a list of all data sources, useListDataSources
.Use
AMAZON_ELASTICSEARCH
for Amazon OpenSearch Service. -
getVpcConnectionProperties
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. -
setVpcConnectionProperties
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. -
setVpcConnectionProperties
@Stability(Stable) public void setVpcConnectionProperties(@Nullable CfnDataSource.VpcConnectionPropertiesProperty value) Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
-