@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)", date="2022-08-17T17:31:08.902Z") public class CfnFlow extends CfnResource implements IInspectable
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.*; Object customProperties; 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(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") .build()) .fileType("fileType") .prefixConfig(PrefixConfigProperty.builder() .prefixFormat("prefixFormat") .prefixType("prefixType") .build()) .preserveSourceDataTyping(false) .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()) .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() .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 .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(customProperties) .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 .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") .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") .kmsArn("kmsArn") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and 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 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
Example:
|
static interface |
CfnFlow.CustomConnectorSourcePropertiesProperty
Example:
|
static interface |
CfnFlow.DatadogSourcePropertiesProperty
The properties that are applied when Datadog is being used as a source.
|
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.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.PrefixConfigProperty
Determines the prefix that Amazon AppFlow applies to the destination folder name.
|
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.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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnFlow(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrFlowArn()
The flow's Amazon Resource Name (ARN).
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
A user-entered description of the flow.
|
java.lang.Object |
getDestinationFlowConfigList()
The configuration that controls how Amazon AppFlow places data in the destination connector.
|
java.lang.String |
getFlowName()
The specified name of the flow.
|
java.lang.String |
getKmsArn()
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
|
java.lang.Object |
getSourceFlowConfig()
Contains information about the configuration of the source connector used in the flow.
|
TagManager |
getTags()
The tags used to organize, track, or control access for your flow.
|
java.lang.Object |
getTasks()
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDescription(java.lang.String value)
A user-entered description of the flow.
|
void |
setDestinationFlowConfigList(IResolvable value)
The configuration that controls how Amazon AppFlow places data in the destination connector.
|
void |
setDestinationFlowConfigList(java.util.List<java.lang.Object> value)
The configuration that controls how Amazon AppFlow places data in the destination connector.
|
void |
setFlowName(java.lang.String value)
The specified name of the flow.
|
void |
setKmsArn(java.lang.String value)
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
|
void |
setSourceFlowConfig(CfnFlow.SourceFlowConfigProperty value)
Contains information about the configuration of the source connector used in the flow.
|
void |
setSourceFlowConfig(IResolvable value)
Contains information about the configuration of the source connector used in the flow.
|
void |
setTasks(IResolvable value)
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
|
void |
setTasks(java.util.List<java.lang.Object> value)
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
|
void |
setTriggerConfig(CfnFlow.TriggerConfigProperty value)
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
|
void |
setTriggerConfig(IResolvable value)
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnFlow(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnFlow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnFlow(Construct scope, java.lang.String id, CfnFlowProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrFlowArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.Object getDestinationFlowConfigList()
public void setDestinationFlowConfigList(IResolvable value)
public void setDestinationFlowConfigList(java.util.List<java.lang.Object> value)
public java.lang.String getFlowName()
Spaces are not allowed. Use underscores (_) or hyphens (-) only.
public void setFlowName(java.lang.String value)
Spaces are not allowed. Use underscores (_) or hyphens (-) only.
public java.lang.Object getSourceFlowConfig()
public void setSourceFlowConfig(IResolvable value)
public void setSourceFlowConfig(CfnFlow.SourceFlowConfigProperty value)
public java.lang.Object getTasks()
public void setTasks(IResolvable value)
public void setTasks(java.util.List<java.lang.Object> value)
public java.lang.Object getTriggerConfig()
public void setTriggerConfig(IResolvable value)
public void setTriggerConfig(CfnFlow.TriggerConfigProperty value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getKmsArn()
This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
public void setKmsArn(java.lang.String value)
This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.