Package software.amazon.awscdk.services.appflow

Interface CfnFlow.S3OutputFormatConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.S3OutputFormatConfigProperty.Jsii$Proxy

Enclosing class:

CfnFlow

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

The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the 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.*;
 S3OutputFormatConfigProperty s3OutputFormatConfigProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlow.S3OutputFormatConfigProperty.Builder	builder()
default Object	getAggregationConfig()	The aggregation settings that you can use to customize the output format of your flow data.
default String	getFileType()	Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.
default Object	getPrefixConfig()	Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket.
default Object	getPreserveSourceDataTyping()	If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAggregationConfig

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

The aggregation settings that you can use to customize the output format of your flow data.

See Also:

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

getFileType

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

Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.

See Also:

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

getPrefixConfig

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

Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket.

You can name folders according to the flow frequency and date.

See Also:

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

getPreserveSourceDataTyping

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

If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3.

• true : Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or 1 in your source data is still an integer in your output.
• false : Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of 1 in your source data becomes the string "1" in the output.

See Also:

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

builder

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

Returns:

a CfnFlow.S3OutputFormatConfigProperty.Builder of CfnFlow.S3OutputFormatConfigProperty