Package 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, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:25.265Z")
@Stability(Stable)
public class CfnFlow
extends CfnResource
implements IInspectable, ITaggable

The AWS::AppFlow::Flow resource is an Amazon AppFlow resource type that specifies a new flow.

If you want to use AWS CloudFormation to create a connector profile for connectors that implement OAuth (such as Salesforce, Slack, Zendesk, and Google Analytics), you must fetch the access and refresh tokens. You can do this by implementing your own UI for OAuth, or by retrieving the tokens from elsewhere. Alternatively, you can use the Amazon AppFlow console to create the connector profile, and then use that connector profile in the flow creation CloudFormation template.

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()
                         .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())
                 // the properties below are optional
                 .apiVersion("apiVersion")
                 .connectorProfileName("connectorProfileName")
                 .build()))
         .flowName("flowName")
         .sourceFlowConfig(SourceFlowConfigProperty.builder()
                 .connectorType("connectorType")
                 .sourceConnectorProperties(SourceConnectorPropertiesProperty.builder()
                         .amplitude(AmplitudeSourcePropertiesProperty.builder()
                                 .object("object")
                                 .build())
                         .customConnector(CustomConnectorSourcePropertiesProperty.builder()
                                 .entityName("entityName")
                                 // the properties below are optional
                                 .customProperties(Map.of(
                                         "customPropertiesKey", "customProperties"))
                                 .dataTransferApi(DataTransferApiProperty.builder()
                                         .name("name")
                                         .type("type")
                                         .build())
                                 .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())
                         .pardot(PardotSourcePropertiesProperty.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
                                 .dataTransferApi("dataTransferApi")
                                 .enableDynamicFieldUpdate(false)
                                 .includeDeletedRecords(false)
                                 .build())
                         .sapoData(SAPODataSourcePropertiesProperty.builder()
                                 .objectPath("objectPath")
                                 // the properties below are optional
                                 .paginationConfig(SAPODataPaginationConfigProperty.builder()
                                         .maxPageSize(123)
                                         .build())
                                 .parallelismConfig(SAPODataParallelismConfigProperty.builder()
                                         .maxParallelism(123)
                                         .build())
                                 .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
                 .apiVersion("apiVersion")
                 .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")
                         .customConnector("customConnector")
                         .datadog("datadog")
                         .dynatrace("dynatrace")
                         .googleAnalytics("googleAnalytics")
                         .inforNexus("inforNexus")
                         .marketo("marketo")
                         .pardot("pardot")
                         .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")
                         .firstExecutionFrom(123)
                         .flowErrorDeactivationThreshold(123)
                         .scheduleEndTime(123)
                         .scheduleOffset(123)
                         .scheduleStartTime(123)
                         .timeZone("timeZone")
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .flowStatus("flowStatus")
         .kmsArn("kmsArn")
         .metadataCatalogConfig(MetadataCatalogConfigProperty.builder()
                 .glueDataCatalog(GlueDataCatalogProperty.builder()
                         .databaseName("databaseName")
                         .roleArn("roleArn")
                         .tablePrefix("tablePrefix")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnFlow.AggregationConfigProperty	The aggregation settings that you can use to customize the output format of your flow data.
static interface	CfnFlow.AmplitudeSourcePropertiesProperty	The properties that are applied when Amplitude is being used as a source.
static final class	CfnFlow.Builder	A fluent builder for CfnFlow.
static interface	CfnFlow.ConnectorOperatorProperty	The operation to be performed on the provided source fields.
static interface	CfnFlow.CustomConnectorDestinationPropertiesProperty	The properties that are applied when the custom connector is being used as a destination.
static interface	CfnFlow.CustomConnectorSourcePropertiesProperty	The properties that are applied when the custom connector is being used as a source.
static interface	CfnFlow.DatadogSourcePropertiesProperty	The properties that are applied when Datadog is being used as a source.
static interface	CfnFlow.DataTransferApiProperty	The API of the connector application that Amazon AppFlow uses to transfer your data.
static interface	CfnFlow.DestinationConnectorPropertiesProperty	This stores the information that is required to query a particular connector.
static interface	CfnFlow.DestinationFlowConfigProperty	Contains information about the configuration of destination connectors present in the flow.
static interface	CfnFlow.DynatraceSourcePropertiesProperty	The properties that are applied when Dynatrace is being used as a source.
static interface	CfnFlow.ErrorHandlingConfigProperty	The settings that determine how Amazon AppFlow handles an error when placing data in the destination.
static interface	CfnFlow.EventBridgeDestinationPropertiesProperty	The properties that are applied when Amazon EventBridge is being used as a destination.
static interface	CfnFlow.GlueDataCatalogProperty	Trigger settings of the flow.
static interface	CfnFlow.GoogleAnalyticsSourcePropertiesProperty	The properties that are applied when Google Analytics is being used as a source.
static interface	CfnFlow.IncrementalPullConfigProperty	Specifies the configuration used when importing incremental records from the source.
static interface	CfnFlow.InforNexusSourcePropertiesProperty	The properties that are applied when Infor Nexus is being used as a source.
static interface	CfnFlow.LookoutMetricsDestinationPropertiesProperty	The properties that are applied when Amazon Lookout for Metrics is used as a destination.
static interface	CfnFlow.MarketoDestinationPropertiesProperty	The properties that Amazon AppFlow applies when you use Marketo as a flow destination.
static interface	CfnFlow.MarketoSourcePropertiesProperty	The properties that are applied when Marketo is being used as a source.
static interface	CfnFlow.MetadataCatalogConfigProperty	Specifies the configuration that Amazon AppFlow uses when it catalogs your data.
static interface	CfnFlow.PardotSourcePropertiesProperty	The properties that are applied when Salesforce Pardot is being used as a source.
static interface	CfnFlow.PrefixConfigProperty	Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination.
static interface	CfnFlow.RedshiftDestinationPropertiesProperty	The properties that are applied when Amazon Redshift is being used as a destination.
static interface	CfnFlow.S3DestinationPropertiesProperty	The properties that are applied when Amazon S3 is used as a destination.
static interface	CfnFlow.S3InputFormatConfigProperty	When you use Amazon S3 as the source, the configuration format that you provide the flow input data.
static interface	CfnFlow.S3OutputFormatConfigProperty	The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.
static interface	CfnFlow.S3SourcePropertiesProperty	The properties that are applied when Amazon S3 is being used as the flow source.
static interface	CfnFlow.SalesforceDestinationPropertiesProperty	The properties that are applied when Salesforce is being used as a destination.
static interface	CfnFlow.SalesforceSourcePropertiesProperty	The properties that are applied when Salesforce is being used as a source.
static interface	CfnFlow.SAPODataDestinationPropertiesProperty	The properties that are applied when using SAPOData as a flow destination.
static interface	CfnFlow.SAPODataPaginationConfigProperty	SAP Source connector page size.
static interface	CfnFlow.SAPODataParallelismConfigProperty	SAP Source connector parallelism factor.
static interface	CfnFlow.SAPODataSourcePropertiesProperty	The properties that are applied when using SAPOData as a flow source.
static interface	CfnFlow.ScheduledTriggerPropertiesProperty	Specifies the configuration details of a schedule-triggered flow as defined by the user.
static interface	CfnFlow.ServiceNowSourcePropertiesProperty	The properties that are applied when ServiceNow is being used as a source.
static interface	CfnFlow.SingularSourcePropertiesProperty	The properties that are applied when Singular is being used as a source.
static interface	CfnFlow.SlackSourcePropertiesProperty	The properties that are applied when Slack is being used as a source.
static interface	CfnFlow.SnowflakeDestinationPropertiesProperty	The properties that are applied when Snowflake is being used as a destination.
static interface	CfnFlow.SourceConnectorPropertiesProperty	Specifies the information that is required to query a particular connector.
static interface	CfnFlow.SourceFlowConfigProperty	Contains information about the configuration of the source connector used in the flow.
static interface	CfnFlow.SuccessResponseHandlingConfigProperty	Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.
static interface	CfnFlow.TaskPropertiesObjectProperty	A map used to store task-related information.
static interface	CfnFlow.TaskProperty	A class for modeling different type of tasks.
static interface	CfnFlow.TrendmicroSourcePropertiesProperty	The properties that are applied when using Trend Micro as a flow source.
static interface	CfnFlow.TriggerConfigProperty	The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
static interface	CfnFlow.UpsolverDestinationPropertiesProperty	The properties that are applied when Upsolver is used as a destination.
static interface	CfnFlow.UpsolverS3OutputFormatConfigProperty	The configuration that determines how Amazon AppFlow formats the flow output data when Upsolver is used as the destination.
static interface	CfnFlow.VeevaSourcePropertiesProperty	The properties that are applied when using Veeva as a flow source.
static interface	CfnFlow.ZendeskDestinationPropertiesProperty	The properties that are applied when Zendesk is used as a destination.
static interface	CfnFlow.ZendeskSourcePropertiesProperty	The properties that are applied when using Zendesk as a flow source.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnFlow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFlow(software.amazon.jsii.JsiiObjectRef objRef)
	CfnFlow(software.constructs.Construct scope, String id, CfnFlowProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrFlowArn()	The flow's Amazon Resource Name (ARN).
protected Map<String,Object>	getCfnProperties()
String	getDescription()	A user-entered description of the flow.
Object	getDestinationFlowConfigList()	The configuration that controls how Amazon AppFlow places data in the destination connector.
String	getFlowName()	The specified name of the flow.
String	getFlowStatus()	Sets the status of the flow.
String	getKmsArn()	The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
Object	getMetadataCatalogConfig()	Specifies the configuration that Amazon AppFlow uses when it catalogs your data.
Object	getSourceFlowConfig()	Contains information about the configuration of the source connector used in the flow.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags used to organize, track, or control access for your flow.
Object	getTasks()	A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
Object	getTriggerConfig()	The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	A user-entered description of the flow.
void	setDestinationFlowConfigList(List<Object> value)	The configuration that controls how Amazon AppFlow places data in the destination connector.
void	setDestinationFlowConfigList(IResolvable value)	The configuration that controls how Amazon AppFlow places data in the destination connector.
void	setFlowName(String value)	The specified name of the flow.
void	setFlowStatus(String value)	Sets the status of the flow.
void	setKmsArn(String value)	The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
void	setMetadataCatalogConfig(IResolvable value)	Specifies the configuration that Amazon AppFlow uses when it catalogs your data.
void	setMetadataCatalogConfig(CfnFlow.MetadataCatalogConfigProperty value)	Specifies the configuration that Amazon AppFlow uses when it catalogs your data.
void	setSourceFlowConfig(IResolvable value)	Contains information about the configuration of the source connector used in the flow.
void	setSourceFlowConfig(CfnFlow.SourceFlowConfigProperty value)	Contains information about the configuration of the source connector used in the flow.
void	setTagsRaw(List<CfnTag> value)	The tags used to organize, track, or control access for your flow.
void	setTasks(List<Object> value)	A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
void	setTasks(IResolvable value)	A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
void	setTriggerConfig(IResolvable value)	The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
void	setTriggerConfig(CfnFlow.TriggerConfigProperty value)	The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnFlow

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

CfnFlow

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

CfnFlow

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

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(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(Stable)
@NotNull
public String getAttrFlowArn()

The flow's Amazon Resource Name (ARN).

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getDestinationFlowConfigList

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

The configuration that controls how Amazon AppFlow places data in the destination connector.

setDestinationFlowConfigList

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

The configuration that controls how Amazon AppFlow places data in the destination connector.

setDestinationFlowConfigList

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

The configuration that controls how Amazon AppFlow places data in the destination connector.

getFlowName

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

The specified name of the flow.

setFlowName

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

The specified name of the flow.

getSourceFlowConfig

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

Contains information about the configuration of the source connector used in the flow.

setSourceFlowConfig

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

Contains information about the configuration of the source connector used in the flow.

setSourceFlowConfig

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

Contains information about the configuration of the source connector used in the flow.

getTasks

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

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

setTasks

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

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

setTasks

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

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

getTriggerConfig

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

The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

setTriggerConfig

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

The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

setTriggerConfig

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

The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

getDescription

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

A user-entered description of the flow.

setDescription

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

A user-entered description of the flow.

getFlowStatus

@Stability(Stable)
@Nullable
public String getFlowStatus()

Sets the status of the flow.

You can specify one of the following values:.

setFlowStatus

@Stability(Stable)
public void setFlowStatus(@Nullable
 String value)

Sets the status of the flow.

You can specify one of the following values:.

getKmsArn

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

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.

setKmsArn

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

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.

getMetadataCatalogConfig

@Stability(Stable)
@Nullable
public Object getMetadataCatalogConfig()

Specifies the configuration that Amazon AppFlow uses when it catalogs your data.

setMetadataCatalogConfig

@Stability(Stable)
public void setMetadataCatalogConfig(@Nullable
 IResolvable value)

Specifies the configuration that Amazon AppFlow uses when it catalogs your data.

setMetadataCatalogConfig

@Stability(Stable)
public void setMetadataCatalogConfig(@Nullable
 CfnFlow.MetadataCatalogConfigProperty value)

Specifies the configuration that Amazon AppFlow uses when it catalogs your data.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

The tags used to organize, track, or control access for your flow.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

The tags used to organize, track, or control access for your flow.