Package software.amazon.awscdk.services.quicksight

Class CfnDataSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.quicksight.CfnDataSource

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:36.689Z")
@Stability(Stable)
public class CfnDataSource
extends CfnResource
implements IInspectable, ITaggable

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")
         .name("name")
         .type("type")
         // 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")
                         .iamParameters(RedshiftIAMParametersProperty.builder()
                                 .roleArn("roleArn")
                                 // the properties below are optional
                                 .autoCreateDatabaseUser(false)
                                 .databaseGroups(List.of("databaseGroups"))
                                 .databaseUser("databaseUser")
                                 .build())
                         .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                                 .enableIdentityPropagation(false)
                                 .build())
                         .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")
                         // the properties below are optional
                         .authenticationType("authenticationType")
                         .databaseAccessControlRole("databaseAccessControlRole")
                         .oAuthParameters(OAuthParametersProperty.builder()
                                 .tokenProviderUrl("tokenProviderUrl")
                                 // the properties below are optional
                                 .identityProviderResourceUri("identityProviderResourceUri")
                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                         .vpcConnectionArn("vpcConnectionArn")
                                         .build())
                                 .oAuthScope("oAuthScope")
                                 .build())
                         .build())
                 .sparkParameters(SparkParametersProperty.builder()
                         .host("host")
                         .port(123)
                         .build())
                 .sqlServerParameters(SqlServerParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .starburstParameters(StarburstParametersProperty.builder()
                         .catalog("catalog")
                         .host("host")
                         .port(123)
                         // the properties below are optional
                         .authenticationType("authenticationType")
                         .databaseAccessControlRole("databaseAccessControlRole")
                         .oAuthParameters(OAuthParametersProperty.builder()
                                 .tokenProviderUrl("tokenProviderUrl")
                                 // the properties below are optional
                                 .identityProviderResourceUri("identityProviderResourceUri")
                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                         .vpcConnectionArn("vpcConnectionArn")
                                         .build())
                                 .oAuthScope("oAuthScope")
                                 .build())
                         .productType("productType")
                         .build())
                 .teradataParameters(TeradataParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .trinoParameters(TrinoParametersProperty.builder()
                         .catalog("catalog")
                         .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")
                                         .iamParameters(RedshiftIAMParametersProperty.builder()
                                                 .roleArn("roleArn")
                                                 // the properties below are optional
                                                 .autoCreateDatabaseUser(false)
                                                 .databaseGroups(List.of("databaseGroups"))
                                                 .databaseUser("databaseUser")
                                                 .build())
                                         .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                                                 .enableIdentityPropagation(false)
                                                 .build())
                                         .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")
                                         // the properties below are optional
                                         .authenticationType("authenticationType")
                                         .databaseAccessControlRole("databaseAccessControlRole")
                                         .oAuthParameters(OAuthParametersProperty.builder()
                                                 .tokenProviderUrl("tokenProviderUrl")
                                                 // the properties below are optional
                                                 .identityProviderResourceUri("identityProviderResourceUri")
                                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                                         .vpcConnectionArn("vpcConnectionArn")
                                                         .build())
                                                 .oAuthScope("oAuthScope")
                                                 .build())
                                         .build())
                                 .sparkParameters(SparkParametersProperty.builder()
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .sqlServerParameters(SqlServerParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .starburstParameters(StarburstParametersProperty.builder()
                                         .catalog("catalog")
                                         .host("host")
                                         .port(123)
                                         // the properties below are optional
                                         .authenticationType("authenticationType")
                                         .databaseAccessControlRole("databaseAccessControlRole")
                                         .oAuthParameters(OAuthParametersProperty.builder()
                                                 .tokenProviderUrl("tokenProviderUrl")
                                                 // the properties below are optional
                                                 .identityProviderResourceUri("identityProviderResourceUri")
                                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                                         .vpcConnectionArn("vpcConnectionArn")
                                                         .build())
                                                 .oAuthScope("oAuthScope")
                                                 .build())
                                         .productType("productType")
                                         .build())
                                 .teradataParameters(TeradataParametersProperty.builder()
                                         .database("database")
                                         .host("host")
                                         .port(123)
                                         .build())
                                 .trinoParameters(TrinoParametersProperty.builder()
                                         .catalog("catalog")
                                         .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")
                         .iamParameters(RedshiftIAMParametersProperty.builder()
                                 .roleArn("roleArn")
                                 // the properties below are optional
                                 .autoCreateDatabaseUser(false)
                                 .databaseGroups(List.of("databaseGroups"))
                                 .databaseUser("databaseUser")
                                 .build())
                         .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                                 .enableIdentityPropagation(false)
                                 .build())
                         .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")
                         // the properties below are optional
                         .authenticationType("authenticationType")
                         .databaseAccessControlRole("databaseAccessControlRole")
                         .oAuthParameters(OAuthParametersProperty.builder()
                                 .tokenProviderUrl("tokenProviderUrl")
                                 // the properties below are optional
                                 .identityProviderResourceUri("identityProviderResourceUri")
                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                         .vpcConnectionArn("vpcConnectionArn")
                                         .build())
                                 .oAuthScope("oAuthScope")
                                 .build())
                         .build())
                 .sparkParameters(SparkParametersProperty.builder()
                         .host("host")
                         .port(123)
                         .build())
                 .sqlServerParameters(SqlServerParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .starburstParameters(StarburstParametersProperty.builder()
                         .catalog("catalog")
                         .host("host")
                         .port(123)
                         // the properties below are optional
                         .authenticationType("authenticationType")
                         .databaseAccessControlRole("databaseAccessControlRole")
                         .oAuthParameters(OAuthParametersProperty.builder()
                                 .tokenProviderUrl("tokenProviderUrl")
                                 // the properties below are optional
                                 .identityProviderResourceUri("identityProviderResourceUri")
                                 .identityProviderVpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                                         .vpcConnectionArn("vpcConnectionArn")
                                         .build())
                                 .oAuthScope("oAuthScope")
                                 .build())
                         .productType("productType")
                         .build())
                 .teradataParameters(TeradataParametersProperty.builder()
                         .database("database")
                         .host("host")
                         .port(123)
                         .build())
                 .trinoParameters(TrinoParametersProperty.builder()
                         .catalog("catalog")
                         .host("host")
                         .port(123)
                         .build())
                 .build())
         .errorInfo(DataSourceErrorInfoProperty.builder()
                 .message("message")
                 .type("type")
                 .build())
         .folderArns(List.of("folderArns"))
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 // the properties below are optional
                 .resource("resource")
                 .build()))
         .sslProperties(SslPropertiesProperty.builder()
                 .disableSsl(false)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcConnectionProperties(VpcConnectionPropertiesProperty.builder()
                 .vpcConnectionArn("vpcConnectionArn")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	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 final 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.IdentityCenterConfigurationProperty	The parameters for an IAM Identity Center configuration.
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.OAuthParametersProperty	An object that contains information needed to create a data source connection that uses OAuth client credentials.
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.RedshiftIAMParametersProperty	A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API.
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.StarburstParametersProperty	The parameters that are required to connect to a Starburst data source.
static interface	CfnDataSource.TeradataParametersProperty	The parameters for Teradata.
static interface	CfnDataSource.TrinoParametersProperty	The parameters that are required to connect to a Trino data source.
static interface	CfnDataSource.VpcConnectionPropertiesProperty	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.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDataSource(software.constructs.Construct scope, String id, CfnDataSourceProps props)

Method Summary

Modifier and Type	Method	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.
List<String>	getFolderArns()
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()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	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(List<Object> value)	A set of alternate data source parameters that you want to share for the credentials stored with this data source.
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	setAwsAccountId(String value)	The AWS account ID.
void	setCredentials(IResolvable value)	The credentials Amazon QuickSight that uses to connect to your underlying source.
void	setCredentials(CfnDataSource.DataSourceCredentialsProperty 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(IResolvable value)	The parameters that Amazon QuickSight uses to connect to your underlying source.
void	setDataSourceParameters(CfnDataSource.DataSourceParametersProperty value)	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	setErrorInfo(CfnDataSource.DataSourceErrorInfoProperty value)	Error information from the last update or the creation of the data source.
void	setFolderArns(List<String> value)
void	setName(String value)	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	setSslProperties(CfnDataSource.SslPropertiesProperty value)	Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
void	setTagsRaw(List<CfnTag> value)	Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
void	setType(String value)	The type of the data 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.
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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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

@Stability(Stable)
public static final String 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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDataSourceProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the dataset.

getAttrCreatedTime

@Stability(Stable)
@NotNull
public String getAttrCreatedTime()

The time that this data source was created.

getAttrLastUpdatedTime

@Stability(Stable)
@NotNull
public String getAttrLastUpdatedTime()

The last time that this data source was updated.

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The HTTP status of the request.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getName

@Stability(Stable)
@NotNull
public String getName()

A display name for the data source.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

A display name for the data source.

getType

@Stability(Stable)
@NotNull
public String getType()

The type of the data source.

To return a list of all data sources, use ListDataSources .

setType

@Stability(Stable)
public void setType(@NotNull
 String value)

The type of the data source.

To return a list of all data sources, use ListDataSources .

getAlternateDataSourceParameters

@Stability(Stable)
@Nullable
public Object getAlternateDataSourceParameters()

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

setAlternateDataSourceParameters

@Stability(Stable)
public void setAlternateDataSourceParameters(@Nullable
 IResolvable value)

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

setAlternateDataSourceParameters

@Stability(Stable)
public void setAlternateDataSourceParameters(@Nullable
 List<Object> value)

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

getAwsAccountId

@Stability(Stable)
@Nullable
public String getAwsAccountId()

The AWS account ID.

setAwsAccountId

@Stability(Stable)
public void setAwsAccountId(@Nullable
 String value)

The AWS account ID.

getCredentials

@Stability(Stable)
@Nullable
public Object getCredentials()

The credentials Amazon QuickSight that uses to connect to your underlying source.

setCredentials

@Stability(Stable)
public void setCredentials(@Nullable
 IResolvable value)

The credentials Amazon QuickSight that uses to connect to your underlying source.

setCredentials

@Stability(Stable)
public void setCredentials(@Nullable
 CfnDataSource.DataSourceCredentialsProperty value)

The credentials Amazon QuickSight that uses to connect to your underlying source.

getDataSourceId

@Stability(Stable)
@Nullable
public String getDataSourceId()

An ID for the data source.

setDataSourceId

@Stability(Stable)
public void setDataSourceId(@Nullable
 String value)

An ID for the data source.

getDataSourceParameters

@Stability(Stable)
@Nullable
public Object getDataSourceParameters()

The parameters that Amazon QuickSight uses to connect to your underlying source.

setDataSourceParameters

@Stability(Stable)
public void setDataSourceParameters(@Nullable
 IResolvable value)

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

@Stability(Stable)
@Nullable
public Object getErrorInfo()

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

setErrorInfo

@Stability(Stable)
public void setErrorInfo(@Nullable
 IResolvable value)

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.

getFolderArns

@Stability(Stable)
@Nullable
public List<String> getFolderArns()

setFolderArns

@Stability(Stable)
public void setFolderArns(@Nullable
 List<String> value)

getPermissions

@Stability(Stable)
@Nullable
public Object getPermissions()

A list of resource permissions on the data source.

setPermissions

@Stability(Stable)
public void setPermissions(@Nullable
 IResolvable value)

A list of resource permissions on the data source.

setPermissions

@Stability(Stable)
public void setPermissions(@Nullable
 List<Object> value)

A list of resource permissions on the data source.

getSslProperties

@Stability(Stable)
@Nullable
public Object getSslProperties()

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

setSslProperties

@Stability(Stable)
public void setSslProperties(@Nullable
 IResolvable value)

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.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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

getVpcConnectionProperties

@Stability(Stable)
@Nullable
public Object getVpcConnectionProperties()

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
 IResolvable value)

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.