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	awscc.quicksight.data_sources

Fields

Name	Datatype	Description
status	string
created_time	string	<p>The time that this data source was created.</p>
▶error_info	object	<p>Error information for the data source creation or update.</p>
last_updated_time	string	<p>The last time that this data source was updated.</p>
folder_arns	array
name	string
▶data_source_parameters	object	<p>The parameters that Amazon QuickSight uses to connect to your underlying data source.<br />This is a variant type structure. For this structure to be valid, only one of the<br />attributes can be non-null.</p>
type	string
▶vpc_connection_properties	object	<p>VPC connection properties.</p>
alternate_data_source_parameters	array	<p>A set of alternate data source parameters that you want to share for the credentials<br />stored with this data source. The credentials are applied in tandem with the data source<br />parameters when you copy a data source by using a create or update request. The API<br />operation compares the &#95;&#95;CODE&#95;BLOCK&#95;0&#95;&#95; structure that's in the request<br />with the structures in the &#95;&#95;CODE&#95;BLOCK&#95;1&#95;&#95; allow list. If the<br />structures are an exact match, the request is allowed to use the credentials from this<br />existing data source. If the &#95;&#95;CODE&#95;BLOCK&#95;2&#95;&#95; list is null,<br />the &#95;&#95;CODE&#95;BLOCK&#95;3&#95;&#95; originally used with this &#95;&#95;CODE&#95;BLOCK&#95;4&#95;&#95;<br />are automatically allowed.</p>
aws_account_id	string
▶permissions	array
arn	string	<p>The Amazon Resource Name (ARN) of the data source.</p>
▶ssl_properties	object	<p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your<br />underlying data source.</p>
▶credentials	object	<p>Data source credentials. This is a variant type structure. For this structure to be<br />valid, only one of the attributes can be non-null.</p>
data_source_id	string
▶tags	array
region	string	AWS region.

For more information, see AWS::QuickSight::DataSource.

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 properties from an individual data_source.

SELECT
region,
status,
created_time,
error_info,
last_updated_time,
folder_arns,
name,
data_source_parameters,
type,
vpc_connection_properties,
alternate_data_source_parameters,
aws_account_id,
permissions,
arn,
ssl_properties,
credentials,
data_source_id,
tags
FROM awscc.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 awscc.quicksight.data_sources (
 Name,
 Type,
 region
)
SELECT 
'{{ Name }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.quicksight.data_sources (
 ErrorInfo,
 FolderArns,
 Name,
 DataSourceParameters,
 Type,
 VpcConnectionProperties,
 AlternateDataSourceParameters,
 AwsAccountId,
 Permissions,
 SslProperties,
 Credentials,
 DataSourceId,
 Tags,
 region
)
SELECT 
 '{{ ErrorInfo }}',
 '{{ FolderArns }}',
 '{{ Name }}',
 '{{ DataSourceParameters }}',
 '{{ Type }}',
 '{{ VpcConnectionProperties }}',
 '{{ AlternateDataSourceParameters }}',
 '{{ AwsAccountId }}',
 '{{ Permissions }}',
 '{{ SslProperties }}',
 '{{ Credentials }}',
 '{{ DataSourceId }}',
 '{{ Tags }}',
 '{{ 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: ErrorInfo
        value:
          Type: '{{ Type }}'
          Message: '{{ Message }}'
      - name: FolderArns
        value:
          - '{{ FolderArns[0] }}'
      - name: Name
        value: '{{ Name }}'
      - name: DataSourceParameters
        value:
          AuroraPostgreSqlParameters:
            Port: null
            Database: '{{ Database }}'
            Host: '{{ Host }}'
          TeradataParameters:
            Port: null
            Database: '{{ Database }}'
            Host: '{{ Host }}'
          RdsParameters:
            InstanceId: '{{ InstanceId }}'
            Database: '{{ Database }}'
          AthenaParameters:
            WorkGroup: '{{ WorkGroup }}'
            IdentityCenterConfiguration:
              EnableIdentityPropagation: '{{ EnableIdentityPropagation }}'
            RoleArn: '{{ RoleArn }}'
          SparkParameters:
            Port: null
            Host: '{{ Host }}'
          MariaDbParameters:
            Port: null
            Database: '{{ Database }}'
            Host: '{{ Host }}'
          OracleParameters:
            UseServiceName: '{{ UseServiceName }}'
            Port: null
            Database: '{{ Database }}'
            Host: '{{ Host }}'
          PrestoParameters:
            Port: null
            Host: '{{ Host }}'
            Catalog: '{{ Catalog }}'
          StarburstParameters:
            Port: null
            DatabaseAccessControlRole: '{{ DatabaseAccessControlRole }}'
            ProductType: '{{ ProductType }}'
            OAuthParameters:
              TokenProviderUrl: '{{ TokenProviderUrl }}'
              OAuthScope: '{{ OAuthScope }}'
              IdentityProviderVpcConnectionProperties:
                VpcConnectionArn: '{{ VpcConnectionArn }}'
              IdentityProviderResourceUri: '{{ IdentityProviderResourceUri }}'
            Host: '{{ Host }}'
            Catalog: '{{ Catalog }}'
            AuthenticationType: '{{ AuthenticationType }}'
          RedshiftParameters:
            IAMParameters:
              AutoCreateDatabaseUser: '{{ AutoCreateDatabaseUser }}'
              DatabaseUser: '{{ DatabaseUser }}'
              RoleArn: '{{ RoleArn }}'
              DatabaseGroups:
                - '{{ DatabaseGroups[0] }}'
            ClusterId: '{{ ClusterId }}'
            Port: null
            Database: '{{ Database }}'
            Host: '{{ Host }}'
            IdentityCenterConfiguration: null
          MySqlParameters:
            Port: null
            Database: '{{ Database }}'
            Host: '{{ Host }}'
          SqlServerParameters:
            Port: null
            Database: '{{ Database }}'
            Host: '{{ Host }}'
          SnowflakeParameters:
            Warehouse: '{{ Warehouse }}'
            DatabaseAccessControlRole: '{{ DatabaseAccessControlRole }}'
            Database: '{{ Database }}'
            OAuthParameters: null
            Host: '{{ Host }}'
            AuthenticationType: null
          AmazonElasticsearchParameters:
            Domain: '{{ Domain }}'
          AmazonOpenSearchParameters:
            Domain: '{{ Domain }}'
          PostgreSqlParameters:
            Port: null
            Database: '{{ Database }}'
            Host: '{{ Host }}'
          AuroraParameters:
            Port: null
            Database: '{{ Database }}'
            Host: '{{ Host }}'
          S3Parameters:
            ManifestFileLocation:
              Bucket: '{{ Bucket }}'
              Key: '{{ Key }}'
            RoleArn: '{{ RoleArn }}'
          TrinoParameters:
            Port: null
            Host: '{{ Host }}'
            Catalog: '{{ Catalog }}'
          DatabricksParameters:
            Port: null
            Host: '{{ Host }}'
            SqlEndpointPath: '{{ SqlEndpointPath }}'
      - name: Type
        value: '{{ Type }}'
      - name: VpcConnectionProperties
        value: null
      - name: AlternateDataSourceParameters
        value:
          - null
      - name: AwsAccountId
        value: '{{ AwsAccountId }}'
      - name: Permissions
        value:
          - Principal: '{{ Principal }}'
            Actions:
              - '{{ Actions[0] }}'
      - name: SslProperties
        value:
          DisableSsl: '{{ DisableSsl }}'
      - name: Credentials
        value:
          SecretArn: '{{ SecretArn }}'
          CopySourceArn: '{{ CopySourceArn }}'
          CredentialPair:
            AlternateDataSourceParameters:
              - null
            Username: '{{ Username }}'
            Password: '{{ Password }}'
      - name: DataSourceId
        value: '{{ DataSourceId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.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,
quicksight:CreateFolderMembership,
quicksight:DeleteFolderMembership,
quicksight:ListFoldersForResource

Update

quicksight:DescribeDataSource,
quicksight:DescribeDataSourcePermissions,
quicksight:UpdateDataSource,
quicksight:UpdateDataSourcePermissions,
quicksight:CreateFolderMembership,
quicksight:DeleteFolderMembership,
quicksight:ListFoldersForResource,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource

List

quicksight:DescribeDataSource,
quicksight:ListDataSources

Delete

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