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

Interface CfnExportPropsMixin.ExportProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExportPropsMixin.ExportProperty.Jsii$Proxy

Enclosing class:

CfnExportPropsMixin

@Stability(Stable)
public static interface CfnExportPropsMixin.ExportProperty
extends software.amazon.jsii.JsiiSerializable

The details that are available for an export.

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.*;
 ExportProperty exportProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnExportPropsMixin.ExportProperty.Builder	A builder for CfnExportPropsMixin.ExportProperty
static final class	CfnExportPropsMixin.ExportProperty.Jsii$Proxy	An implementation for CfnExportPropsMixin.ExportProperty

Method Summary

Modifier and Type	Method	Description
static CfnExportPropsMixin.ExportProperty.Builder	builder()
default Object	getDataQuery()	The data query for this specific data export.
default String	getDescription()	The description for this specific data export.
default Object	getDestinationConfigurations()	The destination configuration for this specific data export.
default String	getExportArn()	The Amazon Resource Name (ARN) for this export.
default String	getName()	The name of this specific data export.
default Object	getRefreshCadence()	The cadence for AWS to update the export in your S3 bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataQuery

@Stability(Stable)
@Nullable
default Object getDataQuery()

The data query for this specific data export.

Returns union: either IResolvable or CfnExportPropsMixin.DataQueryProperty

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description for this specific data export.

See Also:

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

getDestinationConfigurations

@Stability(Stable)
@Nullable
default Object getDestinationConfigurations()

The destination configuration for this specific data export.

Returns union: either IResolvable or CfnExportPropsMixin.DestinationConfigurationsProperty

See Also:

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

getExportArn

@Stability(Stable)
@Nullable
default String getExportArn()

The Amazon Resource Name (ARN) for this export.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of this specific data export.

See Also:

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

getRefreshCadence

@Stability(Stable)
@Nullable
default Object getRefreshCadence()

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

Returns union: either IResolvable or CfnExportPropsMixin.RefreshCadenceProperty

See Also:

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

builder

@Stability(Stable)
static CfnExportPropsMixin.ExportProperty.Builder builder()

Returns:

a CfnExportPropsMixin.ExportProperty.Builder of CfnExportPropsMixin.ExportProperty