Package software.amazon.awscdk.cfnpropertymixins.services.bcmdataexports

Class CfnExportPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.bcmdataexports.CfnExportPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:56.403Z") @Stability(Stable) public class CfnExportPropsMixin extends Mixin implements software.constructs.IMixin
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.bcmdataexports.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnExportPropsMixin cfnExportPropsMixin = CfnExportPropsMixin.Builder.create(CfnExportMixinProps.builder()
         .export(ExportProperty.builder()
                 .dataQuery(DataQueryProperty.builder()
                         .queryStatement("queryStatement")
                         .tableConfigurations(Map.of(
                                 "tableConfigurationsKey", Map.of(
                                         "tableConfigurationsKey", "tableConfigurations")))
                         .build())
                 .description("description")
                 .destinationConfigurations(DestinationConfigurationsProperty.builder()
                         .s3Destination(S3DestinationProperty.builder()
                                 .s3Bucket("s3Bucket")
                                 .s3OutputConfigurations(S3OutputConfigurationsProperty.builder()
                                         .compression("compression")
                                         .format("format")
                                         .outputType("outputType")
                                         .overwrite("overwrite")
                                         .build())
                                 .s3Prefix("s3Prefix")
                                 .s3Region("s3Region")
                                 .build())
                         .build())
                 .exportArn("exportArn")
                 .name("name")
                 .refreshCadence(RefreshCadenceProperty.builder()
                         .frequency("frequency")
                         .build())
                 .build())
         .tags(List.of(ResourceTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnExportPropsMixin

      protected CfnExportPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnExportPropsMixin

      protected CfnExportPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnExportPropsMixin

      @Stability(Stable) public CfnExportPropsMixin(@NotNull CfnExportMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::BCMDataExports::Export.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnExportPropsMixin

      @Stability(Stable) public CfnExportPropsMixin(@NotNull CfnExportMixinProps props)
      Create a mixin to apply properties to AWS::BCMDataExports::Export.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnExportMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()