Package software.amazon.awscdk.services.appflow

Interface CfnFlow.DestinationConnectorPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.DestinationConnectorPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnFlow

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

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

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

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlow.DestinationConnectorPropertiesProperty.Builder	builder()
default Object	getCustomConnector()	The properties that are required to query the custom Connector.
default Object	getEventBridge()	The properties required to query Amazon EventBridge.
default Object	getLookoutMetrics()	The properties required to query Amazon Lookout for Metrics.
default Object	getMarketo()	The properties required to query Marketo.
default Object	getRedshift()	The properties required to query Amazon Redshift.
default Object	getS3()	The properties required to query Amazon S3.
default Object	getSalesforce()	The properties required to query Salesforce.
default Object	getSapoData()	The properties required to query SAPOData.
default Object	getSnowflake()	The properties required to query Snowflake.
default Object	getUpsolver()	The properties required to query Upsolver.
default Object	getZendesk()	The properties required to query Zendesk.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCustomConnector

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

The properties that are required to query the custom Connector.

Returns union: either IResolvable or CfnFlow.CustomConnectorDestinationPropertiesProperty

See Also:

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

getEventBridge

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

The properties required to query Amazon EventBridge.

Returns union: either IResolvable or CfnFlow.EventBridgeDestinationPropertiesProperty

See Also:

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

getLookoutMetrics

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

The properties required to query Amazon Lookout for Metrics.

Returns union: either IResolvable or CfnFlow.LookoutMetricsDestinationPropertiesProperty

See Also:

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

getMarketo

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

The properties required to query Marketo.

Returns union: either IResolvable or CfnFlow.MarketoDestinationPropertiesProperty

See Also:

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

getRedshift

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

The properties required to query Amazon Redshift.

Returns union: either IResolvable or CfnFlow.RedshiftDestinationPropertiesProperty

See Also:

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

getS3

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

The properties required to query Amazon S3.

Returns union: either IResolvable or CfnFlow.S3DestinationPropertiesProperty

See Also:

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

getSalesforce

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

The properties required to query Salesforce.

Returns union: either IResolvable or CfnFlow.SalesforceDestinationPropertiesProperty

See Also:

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

getSapoData

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

The properties required to query SAPOData.

Returns union: either IResolvable or CfnFlow.SAPODataDestinationPropertiesProperty

See Also:

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

getSnowflake

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

The properties required to query Snowflake.

Returns union: either IResolvable or CfnFlow.SnowflakeDestinationPropertiesProperty

See Also:

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

getUpsolver

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

The properties required to query Upsolver.

Returns union: either IResolvable or CfnFlow.UpsolverDestinationPropertiesProperty

See Also:

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

getZendesk

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

The properties required to query Zendesk.

Returns union: either IResolvable or CfnFlow.ZendeskDestinationPropertiesProperty

See Also:

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

builder

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

Returns:

a CfnFlow.DestinationConnectorPropertiesProperty.Builder of CfnFlow.DestinationConnectorPropertiesProperty