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

Interface CfnExportPropsMixin.S3DestinationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExportPropsMixin.S3DestinationProperty.Jsii$Proxy

Enclosing class:

CfnExportPropsMixin

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

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

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.*;
 S3DestinationProperty s3DestinationProperty = S3DestinationProperty.builder()
         .s3Bucket("s3Bucket")
         .s3OutputConfigurations(S3OutputConfigurationsProperty.builder()
                 .compression("compression")
                 .format("format")
                 .outputType("outputType")
                 .overwrite("overwrite")
                 .build())
         .s3Prefix("s3Prefix")
         .s3Region("s3Region")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnExportPropsMixin.S3DestinationProperty.Builder	builder()
default String	getS3Bucket()	The name of the Amazon S3 bucket used as the destination of a data export file.
default Object	getS3OutputConfigurations()	The output configuration for the data export.
default String	getS3Prefix()	The S3 path prefix you want prepended to the name of your data export.
default String	getS3Region()	The S3 bucket Region.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getS3Bucket

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

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

See Also:

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

getS3OutputConfigurations

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

The output configuration for the data export.

Returns union: either IResolvable or CfnExportPropsMixin.S3OutputConfigurationsProperty

See Also:

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

getS3Prefix

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

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

See Also:

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

getS3Region

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

The S3 bucket Region.

See Also:

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

builder

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

Returns:

a CfnExportPropsMixin.S3DestinationProperty.Builder of CfnExportPropsMixin.S3DestinationProperty