data_sources

Creates, updates, deletes or gets a data_source resource or lists data_sources in a region

Overview

Name	data_sources
Type	Resource
Description	Definition of the AWS::QuickSight::DataSource Resource Type.
Id	aws.quicksight.data_sources

Fields

Name	Datatype	Description
alternate_data_source_parameters	array	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.
arn	string	The Amazon Resource Name (ARN) of the data source.
aws_account_id	string
created_time	string	The time that this data source was created.
credentials	object	Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
data_source_id	string
data_source_parameters	object	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.
error_info	object	Error information for the data source creation or update.
last_updated_time	string	The last time that this data source was updated.
name	string
permissions	array
ssl_properties	object	Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.
status	string
tags	array
type	string
vpc_connection_properties	object	VPC connection properties.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Type, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all data_sources in a region.

SELECT
region,
alternate_data_source_parameters,
arn,
aws_account_id,
created_time,
credentials,
data_source_id,
data_source_parameters,
error_info,
last_updated_time,
name,
permissions,
ssl_properties,
status,
tags,
type,
vpc_connection_properties
FROM aws.quicksight.data_sources
WHERE region = 'us-east-1';

Gets all properties from an individual data_source.

SELECT
region,
alternate_data_source_parameters,
arn,
aws_account_id,
created_time,
credentials,
data_source_id,
data_source_parameters,
error_info,
last_updated_time,
name,
permissions,
ssl_properties,
status,
tags,
type,
vpc_connection_properties
FROM aws.quicksight.data_sources
WHERE region = 'us-east-1' AND data__Identifier = '<AwsAccountId>|<DataSourceId>';

INSERT example

Use the following StackQL query and manifest file to create a new data_source resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.quicksight.data_sources (
 Name,
 Type,
 region
)
SELECT 
'{{ Name }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.quicksight.data_sources (
 AlternateDataSourceParameters,
 AwsAccountId,
 Credentials,
 DataSourceId,
 DataSourceParameters,
 ErrorInfo,
 Name,
 Permissions,
 SslProperties,
 Tags,
 Type,
 VpcConnectionProperties,
 region
)
SELECT 
 '{{ AlternateDataSourceParameters }}',
 '{{ AwsAccountId }}',
 '{{ Credentials }}',
 '{{ DataSourceId }}',
 '{{ DataSourceParameters }}',
 '{{ ErrorInfo }}',
 '{{ Name }}',
 '{{ Permissions }}',
 '{{ SslProperties }}',
 '{{ Tags }}',
 '{{ Type }}',
 '{{ VpcConnectionProperties }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: data_source
    props:
      - name: AlternateDataSourceParameters
        value:
          - AmazonElasticsearchParameters:
              Domain: '{{ Domain }}'
            AthenaParameters:
              WorkGroup: '{{ WorkGroup }}'
              RoleArn: '{{ RoleArn }}'
            AuroraParameters:
              Host: '{{ Host }}'
              Port: null
              Database: '{{ Database }}'
            AuroraPostgreSqlParameters:
              Host: '{{ Host }}'
              Port: null
              Database: '{{ Database }}'
            MariaDbParameters:
              Host: '{{ Host }}'
              Port: null
              Database: '{{ Database }}'
            MySqlParameters:
              Host: '{{ Host }}'
              Port: null
              Database: '{{ Database }}'
            OracleParameters:
              Host: '{{ Host }}'
              Port: null
              Database: '{{ Database }}'
            PostgreSqlParameters:
              Host: '{{ Host }}'
              Port: null
              Database: '{{ Database }}'
            PrestoParameters:
              Host: '{{ Host }}'
              Port: null
              Catalog: '{{ Catalog }}'
            RdsParameters:
              InstanceId: '{{ InstanceId }}'
              Database: '{{ Database }}'
            RedshiftParameters:
              Host: '{{ Host }}'
              Port: null
              Database: '{{ Database }}'
              ClusterId: '{{ ClusterId }}'
              IAMParameters:
                RoleArn: '{{ RoleArn }}'
                DatabaseUser: '{{ DatabaseUser }}'
                DatabaseGroups:
                  - '{{ DatabaseGroups[0] }}'
                AutoCreateDatabaseUser: '{{ AutoCreateDatabaseUser }}'
              IdentityCenterConfiguration:
                EnableIdentityPropagation: '{{ EnableIdentityPropagation }}'
            S3Parameters:
              ManifestFileLocation:
                Bucket: '{{ Bucket }}'
                Key: '{{ Key }}'
              RoleArn: '{{ RoleArn }}'
            SnowflakeParameters:
              Host: '{{ Host }}'
              Database: '{{ Database }}'
              Warehouse: '{{ Warehouse }}'
            SparkParameters:
              Host: '{{ Host }}'
              Port: null
            SqlServerParameters:
              Host: '{{ Host }}'
              Port: null
              Database: '{{ Database }}'
            TeradataParameters:
              Host: '{{ Host }}'
              Port: null
              Database: '{{ Database }}'
            AmazonOpenSearchParameters:
              Domain: '{{ Domain }}'
            DatabricksParameters:
              Host: '{{ Host }}'
              Port: null
              SqlEndpointPath: '{{ SqlEndpointPath }}'
            StarburstParameters:
              Host: '{{ Host }}'
              Port: null
              Catalog: '{{ Catalog }}'
              ProductType: '{{ ProductType }}'
            TrinoParameters:
              Host: '{{ Host }}'
              Port: null
              Catalog: '{{ Catalog }}'
      - name: AwsAccountId
        value: '{{ AwsAccountId }}'
      - name: Credentials
        value:
          CredentialPair:
            Username: '{{ Username }}'
            Password: '{{ Password }}'
            AlternateDataSourceParameters:
              - null
          CopySourceArn: '{{ CopySourceArn }}'
          SecretArn: '{{ SecretArn }}'
      - name: DataSourceId
        value: '{{ DataSourceId }}'
      - name: DataSourceParameters
        value: null
      - name: ErrorInfo
        value:
          Type: '{{ Type }}'
          Message: '{{ Message }}'
      - name: Name
        value: '{{ Name }}'
      - name: Permissions
        value:
          - Principal: '{{ Principal }}'
            Actions:
              - '{{ Actions[0] }}'
      - name: SslProperties
        value:
          DisableSsl: '{{ DisableSsl }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Type
        value: '{{ Type }}'
      - name: VpcConnectionProperties
        value:
          VpcConnectionArn: '{{ VpcConnectionArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.quicksight.data_sources
WHERE data__Identifier = '<AwsAccountId|DataSourceId>'
AND region = 'us-east-1';

Permissions

To operate on the data_sources resource, the following permissions are required:

Read

quicksight:DescribeDataSource,
quicksight:DescribeDataSourcePermissions,
quicksight:ListTagsForResource

Create

quicksight:CreateDataSource,
quicksight:DescribeDataSource,
quicksight:DescribeDataSourcePermissions,
quicksight:TagResource,
quicksight:ListTagsForResource

Update

quicksight:DescribeDataSource,
quicksight:DescribeDataSourcePermissions,
quicksight:UpdateDataSource,
quicksight:UpdateDataSourcePermissions,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource

Delete

quicksight:DescribeDataSource,
quicksight:DescribeDataSourcePermissions,
quicksight:DeleteDataSource,
quicksight:ListTagsForResource

List

quicksight:DescribeDataSource,
quicksight:ListDataSources