CfnDataSource

class aws_cdk.aws_quicksight.CfnDataSource(scope, id, *, alternate_data_source_parameters=None, aws_account_id=None, credentials=None, data_source_id=None, data_source_parameters=None, error_info=None, name=None, permissions=None, ssl_properties=None, tags=None, type=None, vpc_connection_properties=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::QuickSight::DataSource.

CloudformationResource

AWS::QuickSight::DataSource

Link

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

Create a new AWS::QuickSight::DataSource.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated. See https://github.com/aws/jsii/issues/826
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::QuickSight::DataSource'
alternate_data_source_parameters

AWS::QuickSight::DataSource.AlternateDataSourceParameters.

Link

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

Return type

Union[IResolvable, List[Union[DataSourceParametersProperty, IResolvable]], None]

attr_arn

Arn

Type

cloudformationAttribute

Return type

str

attr_created_time

CreatedTime

Type

cloudformationAttribute

Return type

str

attr_last_updated_time

LastUpdatedTime

Type

cloudformationAttribute

Return type

str

attr_status

Status

Type

cloudformationAttribute

Return type

str

aws_account_id

AWS::QuickSight::DataSource.AwsAccountId.

Link

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

Return type

Optional[str]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

credentials

AWS::QuickSight::DataSource.Credentials.

Link

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

Return type

Union[IResolvable, DataSourceCredentialsProperty, None]

data_source_id

AWS::QuickSight::DataSource.DataSourceId.

Link

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

Return type

Optional[str]

data_source_parameters

AWS::QuickSight::DataSource.DataSourceParameters.

Link

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

Return type

Union[DataSourceParametersProperty, IResolvable, None]

error_info

AWS::QuickSight::DataSource.ErrorInfo.

Link

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

Return type

Union[IResolvable, DataSourceErrorInfoProperty, None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

AWS::QuickSight::DataSource.Name.

Link

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

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

permissions

AWS::QuickSight::DataSource.Permissions.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ResourcePermissionProperty]], None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

ssl_properties

AWS::QuickSight::DataSource.SslProperties.

Link

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

Return type

Union[IResolvable, SslPropertiesProperty, None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::QuickSight::DataSource.Tags.

Link

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

Return type

TagManager

type

AWS::QuickSight::DataSource.Type.

Link

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

Return type

Optional[str]

vpc_connection_properties

AWS::QuickSight::DataSource.VpcConnectionProperties.

Link

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

Return type

Union[IResolvable, VpcConnectionPropertiesProperty, None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AmazonElasticsearchParametersProperty

class CfnDataSource.AmazonElasticsearchParametersProperty(*, domain)

Bases: object

Parameters

domain (str) – CfnDataSource.AmazonElasticsearchParametersProperty.Domain.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-amazonelasticsearchparameters.html

Attributes

domain

CfnDataSource.AmazonElasticsearchParametersProperty.Domain.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-amazonelasticsearchparameters.html#cfn-quicksight-datasource-amazonelasticsearchparameters-domain

Return type

str

AthenaParametersProperty

class CfnDataSource.AthenaParametersProperty(*, work_group=None)

Bases: object

Parameters

work_group (Optional[str]) – CfnDataSource.AthenaParametersProperty.WorkGroup.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html

Attributes

work_group

CfnDataSource.AthenaParametersProperty.WorkGroup.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html#cfn-quicksight-datasource-athenaparameters-workgroup

Return type

Optional[str]

AuroraParametersProperty

class CfnDataSource.AuroraParametersProperty(*, database, host, port)

Bases: object

Parameters
  • database (str) – CfnDataSource.AuroraParametersProperty.Database.

  • host (str) – CfnDataSource.AuroraParametersProperty.Host.

  • port (Union[int, float]) – CfnDataSource.AuroraParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html

Attributes

database

CfnDataSource.AuroraParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html#cfn-quicksight-datasource-auroraparameters-database

Return type

str

host

CfnDataSource.AuroraParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html#cfn-quicksight-datasource-auroraparameters-host

Return type

str

port

CfnDataSource.AuroraParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html#cfn-quicksight-datasource-auroraparameters-port

Return type

Union[int, float]

AuroraPostgreSqlParametersProperty

class CfnDataSource.AuroraPostgreSqlParametersProperty(*, database, host, port)

Bases: object

Parameters
  • database (str) – CfnDataSource.AuroraPostgreSqlParametersProperty.Database.

  • host (str) – CfnDataSource.AuroraPostgreSqlParametersProperty.Host.

  • port (Union[int, float]) – CfnDataSource.AuroraPostgreSqlParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html

Attributes

database

CfnDataSource.AuroraPostgreSqlParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html#cfn-quicksight-datasource-aurorapostgresqlparameters-database

Return type

str

host

CfnDataSource.AuroraPostgreSqlParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html#cfn-quicksight-datasource-aurorapostgresqlparameters-host

Return type

str

port

CfnDataSource.AuroraPostgreSqlParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html#cfn-quicksight-datasource-aurorapostgresqlparameters-port

Return type

Union[int, float]

CredentialPairProperty

class CfnDataSource.CredentialPairProperty(*, password, username, alternate_data_source_parameters=None)

Bases: object

Parameters
  • password (str) – CfnDataSource.CredentialPairProperty.Password.

  • username (str) – CfnDataSource.CredentialPairProperty.Username.

  • alternate_data_source_parameters (Union[IResolvable, Sequence[Union[DataSourceParametersProperty, IResolvable]], None]) – CfnDataSource.CredentialPairProperty.AlternateDataSourceParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html

Attributes

alternate_data_source_parameters

CfnDataSource.CredentialPairProperty.AlternateDataSourceParameters.

Link

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

Return type

Union[IResolvable, List[Union[DataSourceParametersProperty, IResolvable]], None]

password

CfnDataSource.CredentialPairProperty.Password.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html#cfn-quicksight-datasource-credentialpair-password

Return type

str

username

CfnDataSource.CredentialPairProperty.Username.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html#cfn-quicksight-datasource-credentialpair-username

Return type

str

DataSourceCredentialsProperty

class CfnDataSource.DataSourceCredentialsProperty(*, copy_source_arn=None, credential_pair=None)

Bases: object

Parameters
  • copy_source_arn (Optional[str]) – CfnDataSource.DataSourceCredentialsProperty.CopySourceArn.

  • credential_pair (Union[IResolvable, CredentialPairProperty, None]) – CfnDataSource.DataSourceCredentialsProperty.CredentialPair.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html

Attributes

copy_source_arn

CfnDataSource.DataSourceCredentialsProperty.CopySourceArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-copysourcearn

Return type

Optional[str]

credential_pair

CfnDataSource.DataSourceCredentialsProperty.CredentialPair.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourcecredentials.html#cfn-quicksight-datasource-datasourcecredentials-credentialpair

Return type

Union[IResolvable, CredentialPairProperty, None]

DataSourceErrorInfoProperty

class CfnDataSource.DataSourceErrorInfoProperty(*, message=None, type=None)

Bases: object

Parameters
  • message (Optional[str]) – CfnDataSource.DataSourceErrorInfoProperty.Message.

  • type (Optional[str]) – CfnDataSource.DataSourceErrorInfoProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceerrorinfo.html

Attributes

message

CfnDataSource.DataSourceErrorInfoProperty.Message.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceerrorinfo.html#cfn-quicksight-datasource-datasourceerrorinfo-message

Return type

Optional[str]

type

CfnDataSource.DataSourceErrorInfoProperty.Type.

Link

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

Return type

Optional[str]

DataSourceParametersProperty

class CfnDataSource.DataSourceParametersProperty(*, amazon_elasticsearch_parameters=None, athena_parameters=None, aurora_parameters=None, aurora_postgre_sql_parameters=None, maria_db_parameters=None, my_sql_parameters=None, oracle_parameters=None, postgre_sql_parameters=None, presto_parameters=None, rds_parameters=None, redshift_parameters=None, s3_parameters=None, snowflake_parameters=None, spark_parameters=None, sql_server_parameters=None, teradata_parameters=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-datasourceparameters.html

Attributes

amazon_elasticsearch_parameters

CfnDataSource.DataSourceParametersProperty.AmazonElasticsearchParameters.

Link

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

Return type

Union[IResolvable, AmazonElasticsearchParametersProperty, None]

athena_parameters

CfnDataSource.DataSourceParametersProperty.AthenaParameters.

Link

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

Return type

Union[IResolvable, AthenaParametersProperty, None]

aurora_parameters

CfnDataSource.DataSourceParametersProperty.AuroraParameters.

Link

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

Return type

Union[IResolvable, AuroraParametersProperty, None]

aurora_postgre_sql_parameters

CfnDataSource.DataSourceParametersProperty.AuroraPostgreSqlParameters.

Link

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

Return type

Union[IResolvable, AuroraPostgreSqlParametersProperty, None]

maria_db_parameters

CfnDataSource.DataSourceParametersProperty.MariaDbParameters.

Link

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

Return type

Union[IResolvable, MariaDbParametersProperty, None]

my_sql_parameters

CfnDataSource.DataSourceParametersProperty.MySqlParameters.

Link

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

Return type

Union[IResolvable, MySqlParametersProperty, None]

oracle_parameters

CfnDataSource.DataSourceParametersProperty.OracleParameters.

Link

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

Return type

Union[IResolvable, OracleParametersProperty, None]

postgre_sql_parameters

CfnDataSource.DataSourceParametersProperty.PostgreSqlParameters.

Link

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

Return type

Union[IResolvable, PostgreSqlParametersProperty, None]

presto_parameters

CfnDataSource.DataSourceParametersProperty.PrestoParameters.

Link

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

Return type

Union[IResolvable, PrestoParametersProperty, None]

rds_parameters

CfnDataSource.DataSourceParametersProperty.RdsParameters.

Link

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

Return type

Union[IResolvable, RdsParametersProperty, None]

redshift_parameters

CfnDataSource.DataSourceParametersProperty.RedshiftParameters.

Link

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

Return type

Union[IResolvable, RedshiftParametersProperty, None]

s3_parameters

CfnDataSource.DataSourceParametersProperty.S3Parameters.

Link

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

Return type

Union[IResolvable, S3ParametersProperty, None]

snowflake_parameters

CfnDataSource.DataSourceParametersProperty.SnowflakeParameters.

Link

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

Return type

Union[IResolvable, SnowflakeParametersProperty, None]

spark_parameters

CfnDataSource.DataSourceParametersProperty.SparkParameters.

Link

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

Return type

Union[IResolvable, SparkParametersProperty, None]

sql_server_parameters

CfnDataSource.DataSourceParametersProperty.SqlServerParameters.

Link

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

Return type

Union[IResolvable, SqlServerParametersProperty, None]

teradata_parameters

CfnDataSource.DataSourceParametersProperty.TeradataParameters.

Link

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

Return type

Union[IResolvable, TeradataParametersProperty, None]

ManifestFileLocationProperty

class CfnDataSource.ManifestFileLocationProperty(*, bucket, key)

Bases: object

Parameters
  • bucket (str) – CfnDataSource.ManifestFileLocationProperty.Bucket.

  • key (str) – CfnDataSource.ManifestFileLocationProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-manifestfilelocation.html

Attributes

bucket

CfnDataSource.ManifestFileLocationProperty.Bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-manifestfilelocation.html#cfn-quicksight-datasource-manifestfilelocation-bucket

Return type

str

key

CfnDataSource.ManifestFileLocationProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-manifestfilelocation.html#cfn-quicksight-datasource-manifestfilelocation-key

Return type

str

MariaDbParametersProperty

class CfnDataSource.MariaDbParametersProperty(*, database, host, port)

Bases: object

Parameters
  • database (str) – CfnDataSource.MariaDbParametersProperty.Database.

  • host (str) – CfnDataSource.MariaDbParametersProperty.Host.

  • port (Union[int, float]) – CfnDataSource.MariaDbParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html

Attributes

database

CfnDataSource.MariaDbParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html#cfn-quicksight-datasource-mariadbparameters-database

Return type

str

host

CfnDataSource.MariaDbParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html#cfn-quicksight-datasource-mariadbparameters-host

Return type

str

port

CfnDataSource.MariaDbParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html#cfn-quicksight-datasource-mariadbparameters-port

Return type

Union[int, float]

MySqlParametersProperty

class CfnDataSource.MySqlParametersProperty(*, database, host, port)

Bases: object

Parameters
  • database (str) – CfnDataSource.MySqlParametersProperty.Database.

  • host (str) – CfnDataSource.MySqlParametersProperty.Host.

  • port (Union[int, float]) – CfnDataSource.MySqlParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html

Attributes

database

CfnDataSource.MySqlParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html#cfn-quicksight-datasource-mysqlparameters-database

Return type

str

host

CfnDataSource.MySqlParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html#cfn-quicksight-datasource-mysqlparameters-host

Return type

str

port

CfnDataSource.MySqlParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html#cfn-quicksight-datasource-mysqlparameters-port

Return type

Union[int, float]

OracleParametersProperty

class CfnDataSource.OracleParametersProperty(*, database, host, port)

Bases: object

Parameters
  • database (str) – CfnDataSource.OracleParametersProperty.Database.

  • host (str) – CfnDataSource.OracleParametersProperty.Host.

  • port (Union[int, float]) – CfnDataSource.OracleParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html

Attributes

database

CfnDataSource.OracleParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html#cfn-quicksight-datasource-oracleparameters-database

Return type

str

host

CfnDataSource.OracleParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html#cfn-quicksight-datasource-oracleparameters-host

Return type

str

port

CfnDataSource.OracleParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html#cfn-quicksight-datasource-oracleparameters-port

Return type

Union[int, float]

PostgreSqlParametersProperty

class CfnDataSource.PostgreSqlParametersProperty(*, database, host, port)

Bases: object

Parameters
  • database (str) – CfnDataSource.PostgreSqlParametersProperty.Database.

  • host (str) – CfnDataSource.PostgreSqlParametersProperty.Host.

  • port (Union[int, float]) – CfnDataSource.PostgreSqlParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-postgresqlparameters.html

Attributes

database

CfnDataSource.PostgreSqlParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-postgresqlparameters.html#cfn-quicksight-datasource-postgresqlparameters-database

Return type

str

host

CfnDataSource.PostgreSqlParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-postgresqlparameters.html#cfn-quicksight-datasource-postgresqlparameters-host

Return type

str

port

CfnDataSource.PostgreSqlParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-postgresqlparameters.html#cfn-quicksight-datasource-postgresqlparameters-port

Return type

Union[int, float]

PrestoParametersProperty

class CfnDataSource.PrestoParametersProperty(*, catalog, host, port)

Bases: object

Parameters
  • catalog (str) – CfnDataSource.PrestoParametersProperty.Catalog.

  • host (str) – CfnDataSource.PrestoParametersProperty.Host.

  • port (Union[int, float]) – CfnDataSource.PrestoParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-prestoparameters.html

Attributes

catalog

CfnDataSource.PrestoParametersProperty.Catalog.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-prestoparameters.html#cfn-quicksight-datasource-prestoparameters-catalog

Return type

str

host

CfnDataSource.PrestoParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-prestoparameters.html#cfn-quicksight-datasource-prestoparameters-host

Return type

str

port

CfnDataSource.PrestoParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-prestoparameters.html#cfn-quicksight-datasource-prestoparameters-port

Return type

Union[int, float]

RdsParametersProperty

class CfnDataSource.RdsParametersProperty(*, database, instance_id)

Bases: object

Parameters
  • database (str) – CfnDataSource.RdsParametersProperty.Database.

  • instance_id (str) – CfnDataSource.RdsParametersProperty.InstanceId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-rdsparameters.html

Attributes

database

CfnDataSource.RdsParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-rdsparameters.html#cfn-quicksight-datasource-rdsparameters-database

Return type

str

instance_id

CfnDataSource.RdsParametersProperty.InstanceId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-rdsparameters.html#cfn-quicksight-datasource-rdsparameters-instanceid

Return type

str

RedshiftParametersProperty

class CfnDataSource.RedshiftParametersProperty(*, database, cluster_id=None, host=None, port=None)

Bases: object

Parameters
  • database (str) – CfnDataSource.RedshiftParametersProperty.Database.

  • cluster_id (Optional[str]) – CfnDataSource.RedshiftParametersProperty.ClusterId.

  • host (Optional[str]) – CfnDataSource.RedshiftParametersProperty.Host.

  • port (Union[int, float, None]) – CfnDataSource.RedshiftParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html

Attributes

cluster_id

CfnDataSource.RedshiftParametersProperty.ClusterId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-clusterid

Return type

Optional[str]

database

CfnDataSource.RedshiftParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-database

Return type

str

host

CfnDataSource.RedshiftParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-host

Return type

Optional[str]

port

CfnDataSource.RedshiftParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-port

Return type

Union[int, float, None]

ResourcePermissionProperty

class CfnDataSource.ResourcePermissionProperty(*, actions, principal)

Bases: object

Parameters
  • actions (Sequence[str]) – CfnDataSource.ResourcePermissionProperty.Actions.

  • principal (str) – CfnDataSource.ResourcePermissionProperty.Principal.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-resourcepermission.html

Attributes

actions

CfnDataSource.ResourcePermissionProperty.Actions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-resourcepermission.html#cfn-quicksight-datasource-resourcepermission-actions

Return type

List[str]

principal

CfnDataSource.ResourcePermissionProperty.Principal.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-resourcepermission.html#cfn-quicksight-datasource-resourcepermission-principal

Return type

str

S3ParametersProperty

class CfnDataSource.S3ParametersProperty(*, manifest_file_location)

Bases: object

Parameters

manifest_file_location (Union[IResolvable, ManifestFileLocationProperty]) – CfnDataSource.S3ParametersProperty.ManifestFileLocation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-s3parameters.html

Attributes

manifest_file_location

CfnDataSource.S3ParametersProperty.ManifestFileLocation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-s3parameters.html#cfn-quicksight-datasource-s3parameters-manifestfilelocation

Return type

Union[IResolvable, ManifestFileLocationProperty]

SnowflakeParametersProperty

class CfnDataSource.SnowflakeParametersProperty(*, database, host, warehouse)

Bases: object

Parameters
  • database (str) – CfnDataSource.SnowflakeParametersProperty.Database.

  • host (str) – CfnDataSource.SnowflakeParametersProperty.Host.

  • warehouse (str) – CfnDataSource.SnowflakeParametersProperty.Warehouse.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html

Attributes

database

CfnDataSource.SnowflakeParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-database

Return type

str

host

CfnDataSource.SnowflakeParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-host

Return type

str

warehouse

CfnDataSource.SnowflakeParametersProperty.Warehouse.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-warehouse

Return type

str

SparkParametersProperty

class CfnDataSource.SparkParametersProperty(*, host, port)

Bases: object

Parameters
  • host (str) – CfnDataSource.SparkParametersProperty.Host.

  • port (Union[int, float]) – CfnDataSource.SparkParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sparkparameters.html

Attributes

host

CfnDataSource.SparkParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sparkparameters.html#cfn-quicksight-datasource-sparkparameters-host

Return type

str

port

CfnDataSource.SparkParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sparkparameters.html#cfn-quicksight-datasource-sparkparameters-port

Return type

Union[int, float]

SqlServerParametersProperty

class CfnDataSource.SqlServerParametersProperty(*, database, host, port)

Bases: object

Parameters
  • database (str) – CfnDataSource.SqlServerParametersProperty.Database.

  • host (str) – CfnDataSource.SqlServerParametersProperty.Host.

  • port (Union[int, float]) – CfnDataSource.SqlServerParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html

Attributes

database

CfnDataSource.SqlServerParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html#cfn-quicksight-datasource-sqlserverparameters-database

Return type

str

host

CfnDataSource.SqlServerParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html#cfn-quicksight-datasource-sqlserverparameters-host

Return type

str

port

CfnDataSource.SqlServerParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html#cfn-quicksight-datasource-sqlserverparameters-port

Return type

Union[int, float]

SslPropertiesProperty

class CfnDataSource.SslPropertiesProperty(*, disable_ssl=None)

Bases: object

Parameters

disable_ssl (Union[bool, IResolvable, None]) – CfnDataSource.SslPropertiesProperty.DisableSsl.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sslproperties.html

Attributes

disable_ssl

CfnDataSource.SslPropertiesProperty.DisableSsl.

Link

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

Return type

Union[bool, IResolvable, None]

TeradataParametersProperty

class CfnDataSource.TeradataParametersProperty(*, database, host, port)

Bases: object

Parameters
  • database (str) – CfnDataSource.TeradataParametersProperty.Database.

  • host (str) – CfnDataSource.TeradataParametersProperty.Host.

  • port (Union[int, float]) – CfnDataSource.TeradataParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html

Attributes

database

CfnDataSource.TeradataParametersProperty.Database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html#cfn-quicksight-datasource-teradataparameters-database

Return type

str

host

CfnDataSource.TeradataParametersProperty.Host.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html#cfn-quicksight-datasource-teradataparameters-host

Return type

str

port

CfnDataSource.TeradataParametersProperty.Port.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html#cfn-quicksight-datasource-teradataparameters-port

Return type

Union[int, float]

VpcConnectionPropertiesProperty

class CfnDataSource.VpcConnectionPropertiesProperty(*, vpc_connection_arn)

Bases: object

Parameters

vpc_connection_arn (str) – CfnDataSource.VpcConnectionPropertiesProperty.VpcConnectionArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-vpcconnectionproperties.html

Attributes

vpc_connection_arn

CfnDataSource.VpcConnectionPropertiesProperty.VpcConnectionArn.

Link

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

Return type

str