Package software.amazon.awscdk.cfnpropertymixins.services.appflow

Interface CfnFlowPropsMixin.DestinationFlowConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowPropsMixin.DestinationFlowConfigProperty.Jsii$Proxy

Enclosing class:

CfnFlowPropsMixin

@Stability(Stable)
public static interface CfnFlowPropsMixin.DestinationFlowConfigProperty
extends software.amazon.jsii.JsiiSerializable

Contains information about the configuration of destination connectors present in the flow.

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.appflow.*;
 DestinationFlowConfigProperty destinationFlowConfigProperty = DestinationFlowConfigProperty.builder()
         .apiVersion("apiVersion")
         .connectorProfileName("connectorProfileName")
         .connectorType("connectorType")
         .destinationConnectorProperties(DestinationConnectorPropertiesProperty.builder()
                 .customConnector(CustomConnectorDestinationPropertiesProperty.builder()
                         .customProperties(Map.of(
                                 "customPropertiesKey", "customProperties"))
                         .entityName("entityName")
                         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .failOnFirstError(false)
                                 .build())
                         .idFieldNames(List.of("idFieldNames"))
                         .writeOperationType("writeOperationType")
                         .build())
                 .eventBridge(EventBridgeDestinationPropertiesProperty.builder()
                         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .failOnFirstError(false)
                                 .build())
                         .object("object")
                         .build())
                 .lookoutMetrics(LookoutMetricsDestinationPropertiesProperty.builder()
                         .object("object")
                         .build())
                 .marketo(MarketoDestinationPropertiesProperty.builder()
                         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .failOnFirstError(false)
                                 .build())
                         .object("object")
                         .build())
                 .redshift(RedshiftDestinationPropertiesProperty.builder()
                         .bucketPrefix("bucketPrefix")
                         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .failOnFirstError(false)
                                 .build())
                         .intermediateBucketName("intermediateBucketName")
                         .object("object")
                         .build())
                 .s3(S3DestinationPropertiesProperty.builder()
                         .bucketName("bucketName")
                         .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())
                 .salesforce(SalesforceDestinationPropertiesProperty.builder()
                         .dataTransferApi("dataTransferApi")
                         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .failOnFirstError(false)
                                 .build())
                         .idFieldNames(List.of("idFieldNames"))
                         .object("object")
                         .writeOperationType("writeOperationType")
                         .build())
                 .sapoData(SAPODataDestinationPropertiesProperty.builder()
                         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .failOnFirstError(false)
                                 .build())
                         .idFieldNames(List.of("idFieldNames"))
                         .objectPath("objectPath")
                         .successResponseHandlingConfig(SuccessResponseHandlingConfigProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .build())
                         .writeOperationType("writeOperationType")
                         .build())
                 .snowflake(SnowflakeDestinationPropertiesProperty.builder()
                         .bucketPrefix("bucketPrefix")
                         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .failOnFirstError(false)
                                 .build())
                         .intermediateBucketName("intermediateBucketName")
                         .object("object")
                         .build())
                 .upsolver(UpsolverDestinationPropertiesProperty.builder()
                         .bucketName("bucketName")
                         .bucketPrefix("bucketPrefix")
                         .s3OutputFormatConfig(UpsolverS3OutputFormatConfigProperty.builder()
                                 .aggregationConfig(AggregationConfigProperty.builder()
                                         .aggregationType("aggregationType")
                                         .targetFileSize(123)
                                         .build())
                                 .fileType("fileType")
                                 .prefixConfig(PrefixConfigProperty.builder()
                                         .pathPrefixHierarchy(List.of("pathPrefixHierarchy"))
                                         .prefixFormat("prefixFormat")
                                         .prefixType("prefixType")
                                         .build())
                                 .build())
                         .build())
                 .zendesk(ZendeskDestinationPropertiesProperty.builder()
                         .errorHandlingConfig(ErrorHandlingConfigProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .failOnFirstError(false)
                                 .build())
                         .idFieldNames(List.of("idFieldNames"))
                         .object("object")
                         .writeOperationType("writeOperationType")
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlowPropsMixin.DestinationFlowConfigProperty.Builder	builder()
default String	getApiVersion()	The API version that the destination connector uses.
default String	getConnectorProfileName()	The name of the connector profile.
default String	getConnectorType()	The type of destination connector, such as Sales force, Amazon S3, and so on.
default Object	getDestinationConnectorProperties()	This stores the information that is required to query a particular connector.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiVersion

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

The API version that the destination connector uses.

See Also:

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

getConnectorProfileName

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

The name of the connector profile.

This name must be unique for each connector profile in the AWS account .

See Also:

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

getConnectorType

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

The type of destination connector, such as Sales force, Amazon S3, and so on.

See Also:

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

getDestinationConnectorProperties

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

This stores the information that is required to query a particular connector.

Returns union: either IResolvable or CfnFlowPropsMixin.DestinationConnectorPropertiesProperty

See Also:

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

builder

@Stability(Stable)
static CfnFlowPropsMixin.DestinationFlowConfigProperty.Builder builder()

Returns:

a CfnFlowPropsMixin.DestinationFlowConfigProperty.Builder of CfnFlowPropsMixin.DestinationFlowConfigProperty