latest--aws-quicksight-datasource
sharedDefinition of the AWS::QuickSight::DataSource Resource Type.. Source:- No source definition found, add manually please
Properties
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 the AlternateDataSourceParameters allow list. If the
structures are an exact match, the request is allowed to use the credentials from this
existing data source. If the AlternateDataSourceParameters list is null,
the Credentials originally used with this DataSourceParameters
are automatically allowed.
Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
3 nested properties
The Amazon Resource Name (ARN) of a data source that has the credential pair that you
want to use. When CopySourceArn is not null, the credential pair from the
data source in the ARN is used as the credentials for the
DataSourceCredentials structure.
The combination of user name and password that are used as credentials.
3 nested properties
User name.
Password.
A set of alternate data source parameters that you want to share for these
credentials. The credentials are applied in tandem with the data source parameters when
you copy a data source by using a create or update request. The API operation compares
the DataSourceParameters structure that's in the request with the
structures in the AlternateDataSourceParameters allow list. If the
structures are an exact match, the request is allowed to use the new data source with
the existing credentials. If the AlternateDataSourceParameters list is
null, the DataSourceParameters originally used with these
Credentials is automatically allowed.
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
18 nested properties
Amazon Aurora with PostgreSQL compatibility parameters.
3 nested properties
Port.
Database.
Host.
Teradata parameters.
3 nested properties
Port.
Database.
Host.
Amazon Athena parameters.
2 nested properties
The workgroup that Amazon Athena uses.
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
Spark parameters.
2 nested properties
Port.
Host.
MariaDB parameters.
3 nested properties
Port.
Database.
Host.
3 nested properties
Presto parameters.
3 nested properties
Port.
Host.
Catalog.
Amazon Redshift parameters. The ClusterId field can be blank if
Host and Port are both set. The Host and
Port fields can be blank if the ClusterId field is set.
4 nested properties
Database.
Cluster ID. This field can be blank if the Host and Port are
provided.
Port. This field can be blank if the ClusterId is provided.
Host. This field can be blank if ClusterId is provided.
MySQL parameters.
3 nested properties
Port.
Database.
Host.
SQL Server parameters.
3 nested properties
Port.
Database.
Host.
Amazon Elasticsearch Service parameters.
1 nested properties
The Amazon Elasticsearch Service domain.
Amazon OpenSearch Service parameters.
1 nested properties
The Amazon OpenSearch Service domain.
PostgreSQL parameters.
3 nested properties
Port.
Database.
Host.
Amazon Aurora parameters.
3 nested properties
Port.
Database.
Host.
S3 parameters.
2 nested properties
Amazon S3 manifest file location.
2 nested properties
Amazon S3 bucket.
Amazon S3 key that identifies an object.
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
Databricks parameters.
3 nested properties
Host.
Port.
The HTTP Path of the Databricks data source.
Error information for the data source creation or update.
2 nested properties
Error message.
A display name for the data source.
A list of resource permissions on the data source.
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying data source.
1 nested properties
A Boolean option to control whether SSL should be disabled.
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
VPC connection properties.
1 nested properties
The Amazon Resource Name (ARN) for the VPC connection.
Definitions
Amazon Elasticsearch Service parameters.
The Amazon Elasticsearch Service domain.
Amazon OpenSearch Service parameters.
The Amazon OpenSearch Service domain.
Amazon Athena parameters.
The workgroup that Amazon Athena uses.
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
Amazon Aurora parameters.
Port.
Database.
Host.
Amazon Aurora with PostgreSQL compatibility parameters.
Port.
Database.
Host.
AWS IoT Analytics parameters.
Dataset name.
The combination of user name and password that are used as credentials.
User name.
Password.
A set of alternate data source parameters that you want to share for these
credentials. The credentials are applied in tandem with the data source parameters when
you copy a data source by using a create or update request. The API operation compares
the DataSourceParameters structure that's in the request with the
structures in the AlternateDataSourceParameters allow list. If the
structures are an exact match, the request is allowed to use the new data source with
the existing credentials. If the AlternateDataSourceParameters list is
null, the DataSourceParameters originally used with these
Credentials is automatically allowed.
Databricks parameters.
Host.
Port.
The HTTP Path of the Databricks data source.
Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
The Amazon Resource Name (ARN) of a data source that has the credential pair that you
want to use. When CopySourceArn is not null, the credential pair from the
data source in the ARN is used as the credentials for the
DataSourceCredentials structure.
The combination of user name and password that are used as credentials.
3 nested properties
User name.
Password.
A set of alternate data source parameters that you want to share for these
credentials. The credentials are applied in tandem with the data source parameters when
you copy a data source by using a create or update request. The API operation compares
the DataSourceParameters structure that's in the request with the
structures in the AlternateDataSourceParameters allow list. If the
structures are an exact match, the request is allowed to use the new data source with
the existing credentials. If the AlternateDataSourceParameters list is
null, the DataSourceParameters originally used with these
Credentials is automatically allowed.
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
Error information for the data source creation or update.
Error message.
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
Amazon Aurora with PostgreSQL compatibility parameters.
3 nested properties
Port.
Database.
Host.
Teradata parameters.
3 nested properties
Port.
Database.
Host.
Amazon Athena parameters.
2 nested properties
The workgroup that Amazon Athena uses.
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
Spark parameters.
2 nested properties
Port.
Host.
MariaDB parameters.
3 nested properties
Port.
Database.
Host.
3 nested properties
Presto parameters.
3 nested properties
Port.
Host.
Catalog.
Amazon Redshift parameters. The ClusterId field can be blank if
Host and Port are both set. The Host and
Port fields can be blank if the ClusterId field is set.
4 nested properties
Database.
Cluster ID. This field can be blank if the Host and Port are
provided.
Port. This field can be blank if the ClusterId is provided.
Host. This field can be blank if ClusterId is provided.
MySQL parameters.
3 nested properties
Port.
Database.
Host.
SQL Server parameters.
3 nested properties
Port.
Database.
Host.
Amazon Elasticsearch Service parameters.
1 nested properties
The Amazon Elasticsearch Service domain.
Amazon OpenSearch Service parameters.
1 nested properties
The Amazon OpenSearch Service domain.
PostgreSQL parameters.
3 nested properties
Port.
Database.
Host.
Amazon Aurora parameters.
3 nested properties
Port.
Database.
Host.
S3 parameters.
2 nested properties
Amazon S3 manifest file location.
2 nested properties
Amazon S3 bucket.
Amazon S3 key that identifies an object.
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
Databricks parameters.
3 nested properties
Host.
Port.
The HTTP Path of the Databricks data source.
Amazon S3 manifest file location.
Amazon S3 bucket.
Amazon S3 key that identifies an object.
MariaDB parameters.
Port.
Database.
Host.
MySQL parameters.
Port.
Database.
Host.
PostgreSQL parameters.
Port.
Database.
Host.
Presto parameters.
Port.
Host.
Catalog.
Amazon RDS parameters.
Instance ID.
Database.
Amazon Redshift parameters. The ClusterId field can be blank if
Host and Port are both set. The Host and
Port fields can be blank if the ClusterId field is set.
Database.
Cluster ID. This field can be blank if the Host and Port are
provided.
Port. This field can be blank if the ClusterId is provided.
Host. This field can be blank if ClusterId is provided.
Permission for the resource.
The IAM action to grant or revoke permissions on.
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
-
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
-
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
-
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
S3 parameters.
Amazon S3 manifest file location.
2 nested properties
Amazon S3 bucket.
Amazon S3 key that identifies an object.
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
Snowflake parameters.
Warehouse.
Database.
Host.
Spark parameters.
Port.
Host.
SQL Server parameters.
Port.
Database.
Host.
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying data source.
A Boolean option to control whether SSL should be disabled.
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Tag value.
Tag key.
Teradata parameters.
Port.
Database.
Host.
VPC connection properties.
The Amazon Resource Name (ARN) for the VPC connection.