class CfnExportPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.BCMDataExports.Mixins.CfnExportPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbcmdataexports/mixins#CfnExportPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.bcmdataexports.mixins.CfnExportPropsMixin
Python	aws_cdk.mixins_preview.aws_bcmdataexports.mixins.CfnExportPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_bcmdataexports » mixins » CfnExportPropsMixin

Implements IMixin

Extends Mixin

Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.

A DataQuery consists of both a QueryStatement and TableConfigurations .

The QueryStatement is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query . To view the available tables and columns, see the Data Exports table dictionary .

The TableConfigurations is a collection of specified TableProperties for the table being queried in the QueryStatement . TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see Data query . To view the table properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response of all tables and their available properties.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as bcmdataexports_mixins } from '@aws-cdk/mixins-preview/aws-bcmdataexports';
const cfnExportPropsMixin = new bcmdataexports_mixins.CfnExportPropsMixin({
  export: {
    dataQuery: {
      queryStatement: 'queryStatement',
      tableConfigurations: {
        tableConfigurationsKey: {
          tableConfigurationsKey: 'tableConfigurations',
        },
      },
    },
    description: 'description',
    destinationConfigurations: {
      s3Destination: {
        s3Bucket: 's3Bucket',
        s3OutputConfigurations: {
          compression: 'compression',
          format: 'format',
          outputType: 'outputType',
          overwrite: 'overwrite',
        },
        s3Prefix: 's3Prefix',
        s3Region: 's3Region',
      },
    },
    exportArn: 'exportArn',
    name: 'name',
    refreshCadence: {
      frequency: 'frequency',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnExportPropsMixin(props: CfnExportMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::BCMDataExports::Export.

Properties

Name	Type	Description
props	CfnExportMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnExportMixinProps

---

strategy

Type: PropertyMergeStrategy

---

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): IConstruct

Parameters

• construct IConstruct

Returns

• 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.