class CfnDataSourcePropsMixin

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.QuickSight.CfnDataSourcePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsquicksight#CfnDataSourcePropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.quicksight.CfnDataSourcePropsMixin
Python	aws_cdk.cfn_property_mixins.aws_quicksight.CfnDataSourcePropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_quicksight » CfnDataSourcePropsMixin

Implements IMixin

Extends Mixin

Creates a data source.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnDataSourcePropsMixin = new quicksight.CfnDataSourcePropsMixin({
  alternateDataSourceParameters: [{
    amazonElasticsearchParameters: {
      domain: 'domain',
    },
    amazonOpenSearchParameters: {
      domain: 'domain',
    },
    athenaParameters: {
      identityCenterConfiguration: {
        enableIdentityPropagation: false,
      },
      roleArn: 'roleArn',
      workGroup: 'workGroup',
    },
    auroraParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    auroraPostgreSqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    databricksParameters: {
      host: 'host',
      port: 123,
      sqlEndpointPath: 'sqlEndpointPath',
    },
    mariaDbParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    mySqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    oracleParameters: {
      database: 'database',
      host: 'host',
      port: 123,
      useServiceName: false,
    },
    postgreSqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    prestoParameters: {
      catalog: 'catalog',
      host: 'host',
      port: 123,
    },
    rdsParameters: {
      database: 'database',
      instanceId: 'instanceId',
    },
    redshiftParameters: {
      clusterId: 'clusterId',
      database: 'database',
      host: 'host',
      iamParameters: {
        autoCreateDatabaseUser: false,
        databaseGroups: ['databaseGroups'],
        databaseUser: 'databaseUser',
        roleArn: 'roleArn',
      },
      identityCenterConfiguration: {
        enableIdentityPropagation: false,
      },
      port: 123,
    },
    s3Parameters: {
      manifestFileLocation: {
        bucket: 'bucket',
        key: 'key',
      },
      roleArn: 'roleArn',
    },
    snowflakeParameters: {
      authenticationType: 'authenticationType',
      database: 'database',
      databaseAccessControlRole: 'databaseAccessControlRole',
      host: 'host',
      oAuthParameters: {
        identityProviderResourceUri: 'identityProviderResourceUri',
        identityProviderVpcConnectionProperties: {
          vpcConnectionArn: 'vpcConnectionArn',
        },
        oAuthScope: 'oAuthScope',
        tokenProviderUrl: 'tokenProviderUrl',
      },
      warehouse: 'warehouse',
    },
    sparkParameters: {
      host: 'host',
      port: 123,
    },
    sqlServerParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    starburstParameters: {
      authenticationType: 'authenticationType',
      catalog: 'catalog',
      databaseAccessControlRole: 'databaseAccessControlRole',
      host: 'host',
      oAuthParameters: {
        identityProviderResourceUri: 'identityProviderResourceUri',
        identityProviderVpcConnectionProperties: {
          vpcConnectionArn: 'vpcConnectionArn',
        },
        oAuthScope: 'oAuthScope',
        tokenProviderUrl: 'tokenProviderUrl',
      },
      port: 123,
      productType: 'productType',
    },
    teradataParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    trinoParameters: {
      catalog: 'catalog',
      host: 'host',
      port: 123,
    },
  }],
  awsAccountId: 'awsAccountId',
  credentials: {
    copySourceArn: 'copySourceArn',
    credentialPair: {
      alternateDataSourceParameters: [{
        amazonElasticsearchParameters: {
          domain: 'domain',
        },
        amazonOpenSearchParameters: {
          domain: 'domain',
        },
        athenaParameters: {
          identityCenterConfiguration: {
            enableIdentityPropagation: false,
          },
          roleArn: 'roleArn',
          workGroup: 'workGroup',
        },
        auroraParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        auroraPostgreSqlParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        databricksParameters: {
          host: 'host',
          port: 123,
          sqlEndpointPath: 'sqlEndpointPath',
        },
        mariaDbParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        mySqlParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        oracleParameters: {
          database: 'database',
          host: 'host',
          port: 123,
          useServiceName: false,
        },
        postgreSqlParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        prestoParameters: {
          catalog: 'catalog',
          host: 'host',
          port: 123,
        },
        rdsParameters: {
          database: 'database',
          instanceId: 'instanceId',
        },
        redshiftParameters: {
          clusterId: 'clusterId',
          database: 'database',
          host: 'host',
          iamParameters: {
            autoCreateDatabaseUser: false,
            databaseGroups: ['databaseGroups'],
            databaseUser: 'databaseUser',
            roleArn: 'roleArn',
          },
          identityCenterConfiguration: {
            enableIdentityPropagation: false,
          },
          port: 123,
        },
        s3Parameters: {
          manifestFileLocation: {
            bucket: 'bucket',
            key: 'key',
          },
          roleArn: 'roleArn',
        },
        snowflakeParameters: {
          authenticationType: 'authenticationType',
          database: 'database',
          databaseAccessControlRole: 'databaseAccessControlRole',
          host: 'host',
          oAuthParameters: {
            identityProviderResourceUri: 'identityProviderResourceUri',
            identityProviderVpcConnectionProperties: {
              vpcConnectionArn: 'vpcConnectionArn',
            },
            oAuthScope: 'oAuthScope',
            tokenProviderUrl: 'tokenProviderUrl',
          },
          warehouse: 'warehouse',
        },
        sparkParameters: {
          host: 'host',
          port: 123,
        },
        sqlServerParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        starburstParameters: {
          authenticationType: 'authenticationType',
          catalog: 'catalog',
          databaseAccessControlRole: 'databaseAccessControlRole',
          host: 'host',
          oAuthParameters: {
            identityProviderResourceUri: 'identityProviderResourceUri',
            identityProviderVpcConnectionProperties: {
              vpcConnectionArn: 'vpcConnectionArn',
            },
            oAuthScope: 'oAuthScope',
            tokenProviderUrl: 'tokenProviderUrl',
          },
          port: 123,
          productType: 'productType',
        },
        teradataParameters: {
          database: 'database',
          host: 'host',
          port: 123,
        },
        trinoParameters: {
          catalog: 'catalog',
          host: 'host',
          port: 123,
        },
      }],
      password: 'password',
      username: 'username',
    },
    keyPairCredentials: {
      keyPairUsername: 'keyPairUsername',
      privateKey: 'privateKey',
      privateKeyPassphrase: 'privateKeyPassphrase',
    },
    secretArn: 'secretArn',
  },
  dataSourceId: 'dataSourceId',
  dataSourceParameters: {
    amazonElasticsearchParameters: {
      domain: 'domain',
    },
    amazonOpenSearchParameters: {
      domain: 'domain',
    },
    athenaParameters: {
      identityCenterConfiguration: {
        enableIdentityPropagation: false,
      },
      roleArn: 'roleArn',
      workGroup: 'workGroup',
    },
    auroraParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    auroraPostgreSqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    databricksParameters: {
      host: 'host',
      port: 123,
      sqlEndpointPath: 'sqlEndpointPath',
    },
    mariaDbParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    mySqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    oracleParameters: {
      database: 'database',
      host: 'host',
      port: 123,
      useServiceName: false,
    },
    postgreSqlParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    prestoParameters: {
      catalog: 'catalog',
      host: 'host',
      port: 123,
    },
    rdsParameters: {
      database: 'database',
      instanceId: 'instanceId',
    },
    redshiftParameters: {
      clusterId: 'clusterId',
      database: 'database',
      host: 'host',
      iamParameters: {
        autoCreateDatabaseUser: false,
        databaseGroups: ['databaseGroups'],
        databaseUser: 'databaseUser',
        roleArn: 'roleArn',
      },
      identityCenterConfiguration: {
        enableIdentityPropagation: false,
      },
      port: 123,
    },
    s3Parameters: {
      manifestFileLocation: {
        bucket: 'bucket',
        key: 'key',
      },
      roleArn: 'roleArn',
    },
    snowflakeParameters: {
      authenticationType: 'authenticationType',
      database: 'database',
      databaseAccessControlRole: 'databaseAccessControlRole',
      host: 'host',
      oAuthParameters: {
        identityProviderResourceUri: 'identityProviderResourceUri',
        identityProviderVpcConnectionProperties: {
          vpcConnectionArn: 'vpcConnectionArn',
        },
        oAuthScope: 'oAuthScope',
        tokenProviderUrl: 'tokenProviderUrl',
      },
      warehouse: 'warehouse',
    },
    sparkParameters: {
      host: 'host',
      port: 123,
    },
    sqlServerParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    starburstParameters: {
      authenticationType: 'authenticationType',
      catalog: 'catalog',
      databaseAccessControlRole: 'databaseAccessControlRole',
      host: 'host',
      oAuthParameters: {
        identityProviderResourceUri: 'identityProviderResourceUri',
        identityProviderVpcConnectionProperties: {
          vpcConnectionArn: 'vpcConnectionArn',
        },
        oAuthScope: 'oAuthScope',
        tokenProviderUrl: 'tokenProviderUrl',
      },
      port: 123,
      productType: 'productType',
    },
    teradataParameters: {
      database: 'database',
      host: 'host',
      port: 123,
    },
    trinoParameters: {
      catalog: 'catalog',
      host: 'host',
      port: 123,
    },
  },
  errorInfo: {
    message: 'message',
    type: 'type',
  },
  folderArns: ['folderArns'],
  name: 'name',
  permissions: [{
    actions: ['actions'],
    principal: 'principal',
    resource: 'resource',
  }],
  sslProperties: {
    disableSsl: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
  vpcConnectionProperties: {
    vpcConnectionArn: 'vpcConnectionArn',
  },
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnDataSourcePropsMixin(props: CfnDataSourceMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDataSourceMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::QuickSight::DataSource.

Properties

Name	Type	Description
props	CfnDataSourceMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDataSourceMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.