Package software.amazon.awscdk.services.appflow

Interface CfnFlow.S3DestinationPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.S3DestinationPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnFlow

@Stability(Stable)
public static interface CfnFlow.S3DestinationPropertiesProperty
extends software.amazon.jsii.JsiiSerializable

The properties that are applied when Amazon S3 is used as a destination.

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.appflow.*;
 S3DestinationPropertiesProperty s3DestinationPropertiesProperty = S3DestinationPropertiesProperty.builder()
         .bucketName("bucketName")
         // the properties below are optional
         .bucketPrefix("bucketPrefix")
         .s3OutputFormatConfig(S3OutputFormatConfigProperty.builder()
                 .aggregationConfig(AggregationConfigProperty.builder()
                         .aggregationType("aggregationType")
                         .targetFileSize(123)
                         .build())
                 .fileType("fileType")
                 .prefixConfig(PrefixConfigProperty.builder()
                         .pathPrefixHierarchy(List.of("pathPrefixHierarchy"))
                         .prefixFormat("prefixFormat")
                         .prefixType("prefixType")
                         .build())
                 .preserveSourceDataTyping(false)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3destinationproperties.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlow.S3DestinationPropertiesProperty.Builder	builder()
String	getBucketName()	The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
default String	getBucketPrefix()	The object key for the destination bucket in which Amazon AppFlow places the files.
default Object	getS3OutputFormatConfig()	The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketName

@Stability(Stable)
@NotNull
String getBucketName()

The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3destinationproperties.html#cfn-appflow-flow-s3destinationproperties-bucketname

getBucketPrefix

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

The object key for the destination bucket in which Amazon AppFlow places the files.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3destinationproperties.html#cfn-appflow-flow-s3destinationproperties-bucketprefix

getS3OutputFormatConfig

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

The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3destinationproperties.html#cfn-appflow-flow-s3destinationproperties-s3outputformatconfig

builder

@Stability(Stable)
static CfnFlow.S3DestinationPropertiesProperty.Builder builder()

Returns:

a CfnFlow.S3DestinationPropertiesProperty.Builder of CfnFlow.S3DestinationPropertiesProperty