Package software.amazon.awscdk.services.bcmdataexports

Class CfnExport

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.bcmdataexports.CfnExport
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-11T03:45:50.662Z") @Stability(Stable) public class CfnExport extends CfnResource implements IInspectable, ITaggableV2
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.services.bcmdataexports.*;
 CfnExport cfnExport = CfnExport.Builder.create(this, "MyCfnExport")
         .export(ExportProperty.builder()
                 .dataQuery(DataQueryProperty.builder()
                         .queryStatement("queryStatement")
                         // the properties below are optional
                         .tableConfigurations(Map.of(
                                 "tableConfigurationsKey", Map.of(
                                         "tableConfigurationsKey", "tableConfigurations")))
                         .build())
                 .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())
                 .name("name")
                 .refreshCadence(RefreshCadenceProperty.builder()
                         .frequency("frequency")
                         .build())
                 // the properties below are optional
                 .description("description")
                 .exportArn("exportArn")
                 .build())
         // the properties below are optional
         .tags(List.of(ResourceTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnExport

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

    • CfnExport

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

    • CfnExport

      @Stability(Stable) public CfnExport(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnExportProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrExportArn

      @Stability(Stable) @NotNull public String getAttrExportArn()
      The Amazon Resource Name (ARN) for this export.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getExport

      @Stability(Stable) @NotNull public Object getExport()
      The details that are available for an export.

    • setExport

      @Stability(Stable) public void setExport(@NotNull IResolvable value)
      The details that are available for an export.

    • setExport

      @Stability(Stable) public void setExport(@NotNull CfnExport.ExportProperty value)
      The details that are available for an export.

    • getTags

      @Stability(Stable) @Nullable public List<CfnExport.ResourceTagProperty> getTags()

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnExport.ResourceTagProperty> value)