CfnExportPropsMixin

class aws_cdk.mixins_preview.aws_bcmdataexports.mixins.CfnExportPropsMixin(props, *, strategy=None)

Bases: 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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bcmdataexports-export.html
CloudformationResource:: AWS::BCMDataExports::Export
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_bcmdataexports import mixins as bcmdataexports_mixins

cfn_export_props_mixin = bcmdataexports_mixins.CfnExportPropsMixin(bcmdataexports_mixins.CfnExportMixinProps(
    export=bcmdataexports_mixins.CfnExportPropsMixin.ExportProperty(
        data_query=bcmdataexports_mixins.CfnExportPropsMixin.DataQueryProperty(
            query_statement="queryStatement",
            table_configurations={
                "table_configurations_key": {
                    "table_configurations_key": "tableConfigurations"
                }
            }
        ),
        description="description",
        destination_configurations=bcmdataexports_mixins.CfnExportPropsMixin.DestinationConfigurationsProperty(
            s3_destination=bcmdataexports_mixins.CfnExportPropsMixin.S3DestinationProperty(
                s3_bucket="s3Bucket",
                s3_output_configurations=bcmdataexports_mixins.CfnExportPropsMixin.S3OutputConfigurationsProperty(
                    compression="compression",
                    format="format",
                    output_type="outputType",
                    overwrite="overwrite"
                ),
                s3_prefix="s3Prefix",
                s3_region="s3Region"
            )
        ),
        export_arn="exportArn",
        name="name",
        refresh_cadence=bcmdataexports_mixins.CfnExportPropsMixin.RefreshCadenceProperty(
            frequency="frequency"
        )
    ),
    tags=[bcmdataexports_mixins.CfnExportPropsMixin.ResourceTagProperty(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnExportMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['export', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DataQueryProperty

class CfnExportPropsMixin.DataQueryProperty(*, query_statement=None, table_configurations=None)

Bases: object

The SQL query of column selections and row filters from the data table you want.

Parameters:

query_statement (Optional[str]) – The query statement.
table_configurations (Union[IResolvable, Mapping[str, Union[Mapping[str, str], IResolvable]], None]) – The table configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-dataquery.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bcmdataexports import mixins as bcmdataexports_mixins

data_query_property = bcmdataexports_mixins.CfnExportPropsMixin.DataQueryProperty(
    query_statement="queryStatement",
    table_configurations={
        "table_configurations_key": {
            "table_configurations_key": "tableConfigurations"
        }
    }
)

Attributes

query_statement

The query statement.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-dataquery.html#cfn-bcmdataexports-export-dataquery-querystatement

table_configurations

The table configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-dataquery.html#cfn-bcmdataexports-export-dataquery-tableconfigurations

DestinationConfigurationsProperty

class CfnExportPropsMixin.DestinationConfigurationsProperty(*, s3_destination=None)

Bases: object

The destinations used for data exports.

Parameters:: s3_destination (Union[IResolvable, S3DestinationProperty, Dict[str, Any], None]) – An object that describes the destination of the data exports file.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-destinationconfigurations.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bcmdataexports import mixins as bcmdataexports_mixins

destination_configurations_property = bcmdataexports_mixins.CfnExportPropsMixin.DestinationConfigurationsProperty(
    s3_destination=bcmdataexports_mixins.CfnExportPropsMixin.S3DestinationProperty(
        s3_bucket="s3Bucket",
        s3_output_configurations=bcmdataexports_mixins.CfnExportPropsMixin.S3OutputConfigurationsProperty(
            compression="compression",
            format="format",
            output_type="outputType",
            overwrite="overwrite"
        ),
        s3_prefix="s3Prefix",
        s3_region="s3Region"
    )
)

Attributes

s3_destination

An object that describes the destination of the data exports file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-destinationconfigurations.html#cfn-bcmdataexports-export-destinationconfigurations-s3destination

ExportProperty

class CfnExportPropsMixin.ExportProperty(*, data_query=None, description=None, destination_configurations=None, export_arn=None, name=None, refresh_cadence=None)

Bases: object

The details that are available for an export.

Parameters:

data_query (Union[IResolvable, DataQueryProperty, Dict[str, Any], None]) – The data query for this specific data export.
description (Optional[str]) – The description for this specific data export.
destination_configurations (Union[IResolvable, DestinationConfigurationsProperty, Dict[str, Any], None]) – The destination configuration for this specific data export.
export_arn (Optional[str]) – The Amazon Resource Name (ARN) for this export.
name (Optional[str]) – The name of this specific data export.
refresh_cadence (Union[IResolvable, RefreshCadenceProperty, Dict[str, Any], None]) – The cadence for AWS to update the export in your S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bcmdataexports import mixins as bcmdataexports_mixins

export_property = bcmdataexports_mixins.CfnExportPropsMixin.ExportProperty(
    data_query=bcmdataexports_mixins.CfnExportPropsMixin.DataQueryProperty(
        query_statement="queryStatement",
        table_configurations={
            "table_configurations_key": {
                "table_configurations_key": "tableConfigurations"
            }
        }
    ),
    description="description",
    destination_configurations=bcmdataexports_mixins.CfnExportPropsMixin.DestinationConfigurationsProperty(
        s3_destination=bcmdataexports_mixins.CfnExportPropsMixin.S3DestinationProperty(
            s3_bucket="s3Bucket",
            s3_output_configurations=bcmdataexports_mixins.CfnExportPropsMixin.S3OutputConfigurationsProperty(
                compression="compression",
                format="format",
                output_type="outputType",
                overwrite="overwrite"
            ),
            s3_prefix="s3Prefix",
            s3_region="s3Region"
        )
    ),
    export_arn="exportArn",
    name="name",
    refresh_cadence=bcmdataexports_mixins.CfnExportPropsMixin.RefreshCadenceProperty(
        frequency="frequency"
    )
)

Attributes

data_query

The data query for this specific data export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-dataquery

description

The description for this specific data export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-description

destination_configurations

The destination configuration for this specific data export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-destinationconfigurations

export_arn

The Amazon Resource Name (ARN) for this export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-exportarn

name

The name of this specific data export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-name

refresh_cadence

The cadence for AWS to update the export in your S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-export.html#cfn-bcmdataexports-export-export-refreshcadence

RefreshCadenceProperty

class CfnExportPropsMixin.RefreshCadenceProperty(*, frequency=None)

Bases: object

The cadence for AWS to update the data export in your S3 bucket.

Parameters:: frequency (Optional[str]) – The frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-refreshcadence.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bcmdataexports import mixins as bcmdataexports_mixins

refresh_cadence_property = bcmdataexports_mixins.CfnExportPropsMixin.RefreshCadenceProperty(
    frequency="frequency"
)

Attributes

frequency

The frequency that data exports are updated.

The export refreshes each time the source data updates, up to three times daily.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-refreshcadence.html#cfn-bcmdataexports-export-refreshcadence-frequency

ResourceTagProperty

class CfnExportPropsMixin.ResourceTagProperty(*, key=None, value=None)

Bases: object

The tag structure that contains a tag key and value.

Parameters:

key (Optional[str]) – The key that’s associated with the tag.
value (Optional[str]) – The value that’s associated with the tag.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-resourcetag.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bcmdataexports import mixins as bcmdataexports_mixins

resource_tag_property = bcmdataexports_mixins.CfnExportPropsMixin.ResourceTagProperty(
    key="key",
    value="value"
)

Attributes

key

The key that’s associated with the tag.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-resourcetag.html#cfn-bcmdataexports-export-resourcetag-key

value

The value that’s associated with the tag.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-resourcetag.html#cfn-bcmdataexports-export-resourcetag-value

S3DestinationProperty

class CfnExportPropsMixin.S3DestinationProperty(*, s3_bucket=None, s3_output_configurations=None, s3_prefix=None, s3_region=None)

Bases: object

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a data exports file.

Parameters:

s3_bucket (Optional[str]) – The name of the Amazon S3 bucket used as the destination of a data export file.
s3_output_configurations (Union[IResolvable, S3OutputConfigurationsProperty, Dict[str, Any], None]) – The output configuration for the data export.
s3_prefix (Optional[str]) – The S3 path prefix you want prepended to the name of your data export.
s3_region (Optional[str]) – The S3 bucket Region.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3destination.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bcmdataexports import mixins as bcmdataexports_mixins

s3_destination_property = bcmdataexports_mixins.CfnExportPropsMixin.S3DestinationProperty(
    s3_bucket="s3Bucket",
    s3_output_configurations=bcmdataexports_mixins.CfnExportPropsMixin.S3OutputConfigurationsProperty(
        compression="compression",
        format="format",
        output_type="outputType",
        overwrite="overwrite"
    ),
    s3_prefix="s3Prefix",
    s3_region="s3Region"
)

Attributes

s3_bucket

The name of the Amazon S3 bucket used as the destination of a data export file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3destination.html#cfn-bcmdataexports-export-s3destination-s3bucket

s3_output_configurations

The output configuration for the data export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3destination.html#cfn-bcmdataexports-export-s3destination-s3outputconfigurations

s3_prefix

The S3 path prefix you want prepended to the name of your data export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3destination.html#cfn-bcmdataexports-export-s3destination-s3prefix

s3_region

The S3 bucket Region.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3destination.html#cfn-bcmdataexports-export-s3destination-s3region

S3OutputConfigurationsProperty

class CfnExportPropsMixin.S3OutputConfigurationsProperty(*, compression=None, format=None, output_type=None, overwrite=None)

Bases: object

The compression type, file format, and overwrite preference for the data export.

Parameters:

compression (Optional[str]) – The compression type for the data export.
format (Optional[str]) – The file format for the data export.
output_type (Optional[str]) – The output type for the data export.
overwrite (Optional[str]) – The rule to follow when generating a version of the data export file. You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3outputconfigurations.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bcmdataexports import mixins as bcmdataexports_mixins

s3_output_configurations_property = bcmdataexports_mixins.CfnExportPropsMixin.S3OutputConfigurationsProperty(
    compression="compression",
    format="format",
    output_type="outputType",
    overwrite="overwrite"
)

Attributes

compression

The compression type for the data export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3outputconfigurations.html#cfn-bcmdataexports-export-s3outputconfigurations-compression

format

The file format for the data export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3outputconfigurations.html#cfn-bcmdataexports-export-s3outputconfigurations-format

output_type

The output type for the data export.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3outputconfigurations.html#cfn-bcmdataexports-export-s3outputconfigurations-outputtype

overwrite

The rule to follow when generating a version of the data export file.

You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bcmdataexports-export-s3outputconfigurations.html#cfn-bcmdataexports-export-s3outputconfigurations-overwrite