software.amazon.awscdk.services.appflow

Class CfnFlow

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appflow.CfnFlow

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.832Z")
 @Stability(value=Stable)
public class CfnFlow
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppFlow::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.services.appflow.*;
 CfnFlow cfnFlow = CfnFlow.Builder.create(this, "MyCfnFlow")
         .destinationFlowConfigList(List.of(DestinationFlowConfigProperty.builder()
                 .connectorType("connectorType")
                 .destinationConnectorProperties(DestinationConnectorPropertiesProperty.builder()
                         .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())
                         .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")
                                                 .build())
                                         .fileType("fileType")
                                         .prefixConfig(PrefixConfigProperty.builder()
                                                 .prefixFormat("prefixFormat")
                                                 .prefixType("prefixType")
                                                 .build())
                                         .build())
                                 .build())
                         .salesforce(SalesforceDestinationPropertiesProperty.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())
                         .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()
                                                 .prefixFormat("prefixFormat")
                                                 .prefixType("prefixType")
                                                 .build())
                                         // the properties below are optional
                                         .aggregationConfig(AggregationConfigProperty.builder()
                                                 .aggregationType("aggregationType")
                                                 .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())
                 // the properties below are optional
                 .connectorProfileName("connectorProfileName")
                 .build()))
         .flowName("flowName")
         .sourceFlowConfig(SourceFlowConfigProperty.builder()
                 .connectorType("connectorType")
                 .sourceConnectorProperties(SourceConnectorPropertiesProperty.builder()
                         .amplitude(AmplitudeSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .datadog(DatadogSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .dynatrace(DynatraceSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .googleAnalytics(GoogleAnalyticsSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .inforNexus(InforNexusSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .marketo(MarketoSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .s3(S3SourcePropertiesProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 // the properties below are optional
                                 .s3InputFormatConfig(S3InputFormatConfigProperty.builder()
                                         .s3InputFileType("s3InputFileType")
                                         .build())
                                 .build())
                         .salesforce(SalesforceSourcePropertiesProperty.builder()
                                 .object("object")
                                 // the properties below are optional
                                 .enableDynamicFieldUpdate(false)
                                 .includeDeletedRecords(false)
                                 .build())
                         .sapoData(SAPODataSourcePropertiesProperty.builder()
                                 .objectPath("objectPath")
                                 .build())
                         .serviceNow(ServiceNowSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .singular(SingularSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .slack(SlackSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .trendmicro(TrendmicroSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .veeva(VeevaSourcePropertiesProperty.builder()
                                 .object("object")
                                 // the properties below are optional
                                 .documentType("documentType")
                                 .includeAllVersions(false)
                                 .includeRenditions(false)
                                 .includeSourceFiles(false)
                                 .build())
                         .zendesk(ZendeskSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .build())
                 // the properties below are optional
                 .connectorProfileName("connectorProfileName")
                 .incrementalPullConfig(IncrementalPullConfigProperty.builder()
                         .datetimeTypeFieldName("datetimeTypeFieldName")
                         .build())
                 .build())
         .tasks(List.of(TaskProperty.builder()
                 .sourceFields(List.of("sourceFields"))
                 .taskType("taskType")
                 // the properties below are optional
                 .connectorOperator(ConnectorOperatorProperty.builder()
                         .amplitude("amplitude")
                         .datadog("datadog")
                         .dynatrace("dynatrace")
                         .googleAnalytics("googleAnalytics")
                         .inforNexus("inforNexus")
                         .marketo("marketo")
                         .s3("s3")
                         .salesforce("salesforce")
                         .sapoData("sapoData")
                         .serviceNow("serviceNow")
                         .singular("singular")
                         .slack("slack")
                         .trendmicro("trendmicro")
                         .veeva("veeva")
                         .zendesk("zendesk")
                         .build())
                 .destinationField("destinationField")
                 .taskProperties(List.of(TaskPropertiesObjectProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .triggerConfig(TriggerConfigProperty.builder()
                 .triggerType("triggerType")
                 // the properties below are optional
                 .triggerProperties(ScheduledTriggerPropertiesProperty.builder()
                         .scheduleExpression("scheduleExpression")
                         // the properties below are optional
                         .dataPullMode("dataPullMode")
                         .scheduleEndTime(123)
                         .scheduleOffset(123)
                         .scheduleStartTime(123)
                         .timeZone("timeZone")
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .kmsArn("kmsArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnFlow.AggregationConfigProperty Example:
static interface	CfnFlow.AmplitudeSourcePropertiesProperty Example:
static class	CfnFlow.Builder A fluent builder for CfnFlow.
static interface	CfnFlow.ConnectorOperatorProperty Example:
static interface	CfnFlow.DatadogSourcePropertiesProperty Example:
static interface	CfnFlow.DestinationConnectorPropertiesProperty Example:
static interface	CfnFlow.DestinationFlowConfigProperty Example:
static interface	CfnFlow.DynatraceSourcePropertiesProperty Example:
static interface	CfnFlow.ErrorHandlingConfigProperty Example:
static interface	CfnFlow.EventBridgeDestinationPropertiesProperty Example:
static interface	CfnFlow.GoogleAnalyticsSourcePropertiesProperty Example:
static interface	CfnFlow.IncrementalPullConfigProperty Example:
static interface	CfnFlow.InforNexusSourcePropertiesProperty Example:
static interface	CfnFlow.LookoutMetricsDestinationPropertiesProperty Example:
static interface	CfnFlow.MarketoSourcePropertiesProperty Example:
static interface	CfnFlow.PrefixConfigProperty Example:
static interface	CfnFlow.RedshiftDestinationPropertiesProperty Example:
static interface	CfnFlow.S3DestinationPropertiesProperty Example:
static interface	CfnFlow.S3InputFormatConfigProperty Example:
static interface	CfnFlow.S3OutputFormatConfigProperty Example:
static interface	CfnFlow.S3SourcePropertiesProperty Example:
static interface	CfnFlow.SalesforceDestinationPropertiesProperty Example:
static interface	CfnFlow.SalesforceSourcePropertiesProperty Example:
static interface	CfnFlow.SAPODataSourcePropertiesProperty Example:
static interface	CfnFlow.ScheduledTriggerPropertiesProperty Example:
static interface	CfnFlow.ServiceNowSourcePropertiesProperty Example:
static interface	CfnFlow.SingularSourcePropertiesProperty Example:
static interface	CfnFlow.SlackSourcePropertiesProperty Example:
static interface	CfnFlow.SnowflakeDestinationPropertiesProperty Example:
static interface	CfnFlow.SourceConnectorPropertiesProperty Example:
static interface	CfnFlow.SourceFlowConfigProperty Example:
static interface	CfnFlow.TaskPropertiesObjectProperty Example:
static interface	CfnFlow.TaskProperty Example:
static interface	CfnFlow.TrendmicroSourcePropertiesProperty Example:
static interface	CfnFlow.TriggerConfigProperty Example:
static interface	CfnFlow.UpsolverDestinationPropertiesProperty Example:
static interface	CfnFlow.UpsolverS3OutputFormatConfigProperty Example:
static interface	CfnFlow.VeevaSourcePropertiesProperty Example:
static interface	CfnFlow.ZendeskDestinationPropertiesProperty Example:
static interface	CfnFlow.ZendeskSourcePropertiesProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFlow(software.constructs.Construct scope, String id, CfnFlowProps props) Create a new `AWS::AppFlow::Flow`.
protected	CfnFlow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFlow(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrFlowArn()
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::AppFlow::Flow.Description`.
Object	getDestinationFlowConfigList() `AWS::AppFlow::Flow.DestinationFlowConfigList`.
String	getFlowName() `AWS::AppFlow::Flow.FlowName`.
String	getKmsArn() `AWS::AppFlow::Flow.KMSArn`.
Object	getSourceFlowConfig() `AWS::AppFlow::Flow.SourceFlowConfig`.
TagManager	getTags() `AWS::AppFlow::Flow.Tags`.
Object	getTasks() `AWS::AppFlow::Flow.Tasks`.
Object	getTriggerConfig() `AWS::AppFlow::Flow.TriggerConfig`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) `AWS::AppFlow::Flow.Description`.
void	setDestinationFlowConfigList(IResolvable value) `AWS::AppFlow::Flow.DestinationFlowConfigList`.
void	setDestinationFlowConfigList(List<Object> value) `AWS::AppFlow::Flow.DestinationFlowConfigList`.
void	setFlowName(String value) `AWS::AppFlow::Flow.FlowName`.
void	setKmsArn(String value) `AWS::AppFlow::Flow.KMSArn`.
void	setSourceFlowConfig(CfnFlow.SourceFlowConfigProperty value) `AWS::AppFlow::Flow.SourceFlowConfig`.
void	setSourceFlowConfig(IResolvable value) `AWS::AppFlow::Flow.SourceFlowConfig`.
void	setTasks(IResolvable value) `AWS::AppFlow::Flow.Tasks`.
void	setTasks(List<Object> value) `AWS::AppFlow::Flow.Tasks`.
void	setTriggerConfig(CfnFlow.TriggerConfigProperty value) `AWS::AppFlow::Flow.TriggerConfig`.
void	setTriggerConfig(IResolvable value) `AWS::AppFlow::Flow.TriggerConfig`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFlow

protected CfnFlow(software.amazon.jsii.JsiiObjectRef objRef)

CfnFlow

protected CfnFlow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFlow

@Stability(value=Stable)
public CfnFlow(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id,
                                        @NotNull
                                        CfnFlowProps props)

Create a new `AWS::AppFlow::Flow`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrFlowArn

@Stability(value=Stable)
 @NotNull
public String getAttrFlowArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::AppFlow::Flow.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::AppFlow::Flow.Description`.

getDestinationFlowConfigList

@Stability(value=Stable)
 @NotNull
public Object getDestinationFlowConfigList()

`AWS::AppFlow::Flow.DestinationFlowConfigList`.

setDestinationFlowConfigList

@Stability(value=Stable)
public void setDestinationFlowConfigList(@NotNull
                                                                  IResolvable value)

`AWS::AppFlow::Flow.DestinationFlowConfigList`.

setDestinationFlowConfigList

@Stability(value=Stable)
public void setDestinationFlowConfigList(@NotNull
                                                                  List<Object> value)

`AWS::AppFlow::Flow.DestinationFlowConfigList`.

getFlowName

@Stability(value=Stable)
 @NotNull
public String getFlowName()

`AWS::AppFlow::Flow.FlowName`.

setFlowName

@Stability(value=Stable)
public void setFlowName(@NotNull
                                                 String value)

`AWS::AppFlow::Flow.FlowName`.

getKmsArn

@Stability(value=Stable)
 @Nullable
public String getKmsArn()

`AWS::AppFlow::Flow.KMSArn`.

setKmsArn

@Stability(value=Stable)
public void setKmsArn(@Nullable
                                               String value)

`AWS::AppFlow::Flow.KMSArn`.

getSourceFlowConfig

@Stability(value=Stable)
 @NotNull
public Object getSourceFlowConfig()

`AWS::AppFlow::Flow.SourceFlowConfig`.

setSourceFlowConfig

@Stability(value=Stable)
public void setSourceFlowConfig(@NotNull
                                                         CfnFlow.SourceFlowConfigProperty value)

`AWS::AppFlow::Flow.SourceFlowConfig`.

setSourceFlowConfig

@Stability(value=Stable)
public void setSourceFlowConfig(@NotNull
                                                         IResolvable value)

`AWS::AppFlow::Flow.SourceFlowConfig`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::AppFlow::Flow.Tags`.

getTasks

@Stability(value=Stable)
 @NotNull
public Object getTasks()

`AWS::AppFlow::Flow.Tasks`.

setTasks

@Stability(value=Stable)
public void setTasks(@NotNull
                                              IResolvable value)

`AWS::AppFlow::Flow.Tasks`.

setTasks

@Stability(value=Stable)
public void setTasks(@NotNull
                                              List<Object> value)

`AWS::AppFlow::Flow.Tasks`.

getTriggerConfig

@Stability(value=Stable)
 @NotNull
public Object getTriggerConfig()

`AWS::AppFlow::Flow.TriggerConfig`.

setTriggerConfig

@Stability(value=Stable)
public void setTriggerConfig(@NotNull
                                                      CfnFlow.TriggerConfigProperty value)

`AWS::AppFlow::Flow.TriggerConfig`.

setTriggerConfig

@Stability(value=Stable)
public void setTriggerConfig(@NotNull
                                                      IResolvable value)

`AWS::AppFlow::Flow.TriggerConfig`.