Class CfnFlow
The AWS::AppFlow::Flow resource is an Amazon AppFlow resource type that specifies a new flow.
Inherited Members
Namespace: Amazon.CDK.AWS.AppFlow
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFlow : CfnResource, IInspectable, IFlowRef, IConstruct, IDependable, IEnvironmentAware, ITaggableSyntax (vb)
Public Class CfnFlow Inherits CfnResource Implements IInspectable, IFlowRef, IConstruct, IDependable, IEnvironmentAware, ITaggableRemarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppFlow;
var cfnFlow = new CfnFlow(this, "MyCfnFlow", new CfnFlowProps {
DestinationFlowConfigList = new [] { new DestinationFlowConfigProperty {
ConnectorType = "connectorType",
DestinationConnectorProperties = new DestinationConnectorPropertiesProperty {
CustomConnector = new CustomConnectorDestinationPropertiesProperty {
EntityName = "entityName",
// the properties below are optional
CustomProperties = new Dictionary<string, string> {
{ "customPropertiesKey", "customProperties" }
},
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
WriteOperationType = "writeOperationType"
},
EventBridge = new EventBridgeDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
LookoutMetrics = new LookoutMetricsDestinationPropertiesProperty {
Object = "object"
},
Marketo = new MarketoDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
Redshift = new RedshiftDestinationPropertiesProperty {
IntermediateBucketName = "intermediateBucketName",
Object = "object",
// the properties below are optional
BucketPrefix = "bucketPrefix",
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
S3 = new S3DestinationPropertiesProperty {
BucketName = "bucketName",
// the properties below are optional
BucketPrefix = "bucketPrefix",
S3OutputFormatConfig = new S3OutputFormatConfigProperty {
AggregationConfig = new AggregationConfigProperty {
AggregationType = "aggregationType",
TargetFileSize = 123
},
FileType = "fileType",
PrefixConfig = new PrefixConfigProperty {
PathPrefixHierarchy = new [] { "pathPrefixHierarchy" },
PrefixFormat = "prefixFormat",
PrefixType = "prefixType"
},
PreserveSourceDataTyping = false
}
},
Salesforce = new SalesforceDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
DataTransferApi = "dataTransferApi",
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
WriteOperationType = "writeOperationType"
},
SapoData = new SAPODataDestinationPropertiesProperty {
ObjectPath = "objectPath",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
SuccessResponseHandlingConfig = new SuccessResponseHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix"
},
WriteOperationType = "writeOperationType"
},
Snowflake = new SnowflakeDestinationPropertiesProperty {
IntermediateBucketName = "intermediateBucketName",
Object = "object",
// the properties below are optional
BucketPrefix = "bucketPrefix",
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
Upsolver = new UpsolverDestinationPropertiesProperty {
BucketName = "bucketName",
S3OutputFormatConfig = new UpsolverS3OutputFormatConfigProperty {
PrefixConfig = new PrefixConfigProperty {
PathPrefixHierarchy = new [] { "pathPrefixHierarchy" },
PrefixFormat = "prefixFormat",
PrefixType = "prefixType"
},
// the properties below are optional
AggregationConfig = new AggregationConfigProperty {
AggregationType = "aggregationType",
TargetFileSize = 123
},
FileType = "fileType"
},
// the properties below are optional
BucketPrefix = "bucketPrefix"
},
Zendesk = new ZendeskDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
WriteOperationType = "writeOperationType"
}
},
// the properties below are optional
ApiVersion = "apiVersion",
ConnectorProfileName = "connectorProfileName"
} },
FlowName = "flowName",
SourceFlowConfig = new SourceFlowConfigProperty {
ConnectorType = "connectorType",
SourceConnectorProperties = new SourceConnectorPropertiesProperty {
Amplitude = new AmplitudeSourcePropertiesProperty {
Object = "object"
},
CustomConnector = new CustomConnectorSourcePropertiesProperty {
EntityName = "entityName",
// the properties below are optional
CustomProperties = new Dictionary<string, string> {
{ "customPropertiesKey", "customProperties" }
},
DataTransferApi = new DataTransferApiProperty {
Name = "name",
Type = "type"
}
},
Datadog = new DatadogSourcePropertiesProperty {
Object = "object"
},
Dynatrace = new DynatraceSourcePropertiesProperty {
Object = "object"
},
GoogleAnalytics = new GoogleAnalyticsSourcePropertiesProperty {
Object = "object"
},
InforNexus = new InforNexusSourcePropertiesProperty {
Object = "object"
},
Marketo = new MarketoSourcePropertiesProperty {
Object = "object"
},
Pardot = new PardotSourcePropertiesProperty {
Object = "object"
},
S3 = new S3SourcePropertiesProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
// the properties below are optional
S3InputFormatConfig = new S3InputFormatConfigProperty {
S3InputFileType = "s3InputFileType"
}
},
Salesforce = new SalesforceSourcePropertiesProperty {
Object = "object",
// the properties below are optional
DataTransferApi = "dataTransferApi",
EnableDynamicFieldUpdate = false,
IncludeDeletedRecords = false
},
SapoData = new SAPODataSourcePropertiesProperty {
ObjectPath = "objectPath",
// the properties below are optional
PaginationConfig = new SAPODataPaginationConfigProperty {
MaxPageSize = 123
},
ParallelismConfig = new SAPODataParallelismConfigProperty {
MaxParallelism = 123
}
},
ServiceNow = new ServiceNowSourcePropertiesProperty {
Object = "object"
},
Singular = new SingularSourcePropertiesProperty {
Object = "object"
},
Slack = new SlackSourcePropertiesProperty {
Object = "object"
},
Trendmicro = new TrendmicroSourcePropertiesProperty {
Object = "object"
},
Veeva = new VeevaSourcePropertiesProperty {
Object = "object",
// the properties below are optional
DocumentType = "documentType",
IncludeAllVersions = false,
IncludeRenditions = false,
IncludeSourceFiles = false
},
Zendesk = new ZendeskSourcePropertiesProperty {
Object = "object"
}
},
// the properties below are optional
ApiVersion = "apiVersion",
ConnectorProfileName = "connectorProfileName",
IncrementalPullConfig = new IncrementalPullConfigProperty {
DatetimeTypeFieldName = "datetimeTypeFieldName"
}
},
Tasks = new [] { new TaskProperty {
SourceFields = new [] { "sourceFields" },
TaskType = "taskType",
// the properties below are optional
ConnectorOperator = new ConnectorOperatorProperty {
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"
},
DestinationField = "destinationField",
TaskProperties = new [] { new TaskPropertiesObjectProperty {
Key = "key",
Value = "value"
} }
} },
TriggerConfig = new TriggerConfigProperty {
TriggerType = "triggerType",
// the properties below are optional
TriggerProperties = new ScheduledTriggerPropertiesProperty {
ScheduleExpression = "scheduleExpression",
// the properties below are optional
DataPullMode = "dataPullMode",
FirstExecutionFrom = 123,
FlowErrorDeactivationThreshold = 123,
ScheduleEndTime = 123,
ScheduleOffset = 123,
ScheduleStartTime = 123,
TimeZone = "timeZone"
}
},
// the properties below are optional
Description = "description",
FlowStatus = "flowStatus",
KmsArn = "kmsArn",
MetadataCatalogConfig = new MetadataCatalogConfigProperty {
GlueDataCatalog = new GlueDataCatalogProperty {
DatabaseName = "databaseName",
RoleArn = "roleArn",
TablePrefix = "tablePrefix"
}
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});Synopsis
Constructors
| CfnFlow(Construct, string, ICfnFlowProps) | Create a new |
Properties
| AttrFlowArn | The flow's Amazon Resource Name (ARN). |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | The |
| Description | A user-entered description of the flow. |
| DestinationFlowConfigList | The configuration that controls how Amazon AppFlow places data in the destination connector. |
| FlowName | The specified name of the flow. |
| FlowRef | A reference to a Flow resource. |
| FlowStatus | Sets the status of the flow. |
| KmsArn | The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. |
| MetadataCatalogConfig | Specifies the configuration that Amazon AppFlow uses when it catalogs your data. |
| SourceFlowConfig | Contains information about the configuration of the source connector used in the flow. |
| Tags | Tag Manager which manages the tags for this resource. |
| TagsRaw | The tags used to organize, track, or control access for your flow. |
| Tasks | A list of tasks that Amazon AppFlow performs while transferring the data in the flow run. |
| TriggerConfig | The trigger settings that determine how and when Amazon AppFlow runs the specified flow. |
Methods
| ArnForFlow(IFlowRef) | The |
| FromFlowArn(Construct, string, string) | Creates a new IFlowRef from an ARN. |
| FromFlowName(Construct, string, string) | Creates a new IFlowRef from a flowName. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnFlow(object) | Checks whether the given object is a CfnFlow. |
| RenderProperties(IDictionary<string, object>) | The |
Constructors
CfnFlow(Construct, string, ICfnFlowProps)
Create a new AWS::AppFlow::Flow.
public CfnFlow(Construct scope, string id, ICfnFlowProps props)Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnFlowProps
Resource properties.
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
Properties
AttrFlowArn
The flow's Amazon Resource Name (ARN).
public virtual string AttrFlowArn { get; }Property Value
Remarks
CloudformationAttribute: FlowArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::AppFlow::Flow resource is an Amazon AppFlow resource type that specifies a new flow.
protected override IDictionary<string, object> CfnProperties { get; }Property Value
Overrides
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
Description
A user-entered description of the flow.
public virtual string? Description { get; set; }Property Value
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
DestinationFlowConfigList
The configuration that controls how Amazon AppFlow places data in the destination connector.
public virtual object DestinationFlowConfigList { get; set; }Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnFlow.IDestinationFlowConfigProperty)[]
FlowName
The specified name of the flow.
public virtual string FlowName { get; set; }Property Value
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
FlowRef
A reference to a Flow resource.
public virtual IFlowReference FlowRef { get; }Property Value
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
FlowStatus
Sets the status of the flow.
public virtual string? FlowStatus { get; set; }Property Value
Remarks
You can specify one of the following values:.
KmsArn
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
public virtual string? KmsArn { get; set; }Property Value
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
MetadataCatalogConfig
Specifies the configuration that Amazon AppFlow uses when it catalogs your data.
public virtual object? MetadataCatalogConfig { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnFlow.IMetadataCatalogConfigProperty
SourceFlowConfig
Contains information about the configuration of the source connector used in the flow.
public virtual object SourceFlowConfig { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnFlow.ISourceFlowConfigProperty
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }Property Value
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
TagsRaw
The tags used to organize, track, or control access for your flow.
public virtual ICfnTag[]? TagsRaw { get; set; }Property Value
ICfnTag[]
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
Tasks
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
public virtual object Tasks { get; set; }Property Value
Remarks
Type union: either IResolvable or (either IResolvable or CfnFlow.ITaskProperty)[]
TriggerConfig
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
public virtual object TriggerConfig { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnFlow.ITriggerConfigProperty
Methods
ArnForFlow(IFlowRef)
The AWS::AppFlow::Flow resource is an Amazon AppFlow resource type that specifies a new flow.
public static string ArnForFlow(IFlowRef resource)Parameters
- resource IFlowRef
Returns
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppFlow;
var cfnFlow = new CfnFlow(this, "MyCfnFlow", new CfnFlowProps {
DestinationFlowConfigList = new [] { new DestinationFlowConfigProperty {
ConnectorType = "connectorType",
DestinationConnectorProperties = new DestinationConnectorPropertiesProperty {
CustomConnector = new CustomConnectorDestinationPropertiesProperty {
EntityName = "entityName",
// the properties below are optional
CustomProperties = new Dictionary<string, string> {
{ "customPropertiesKey", "customProperties" }
},
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
WriteOperationType = "writeOperationType"
},
EventBridge = new EventBridgeDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
LookoutMetrics = new LookoutMetricsDestinationPropertiesProperty {
Object = "object"
},
Marketo = new MarketoDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
Redshift = new RedshiftDestinationPropertiesProperty {
IntermediateBucketName = "intermediateBucketName",
Object = "object",
// the properties below are optional
BucketPrefix = "bucketPrefix",
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
S3 = new S3DestinationPropertiesProperty {
BucketName = "bucketName",
// the properties below are optional
BucketPrefix = "bucketPrefix",
S3OutputFormatConfig = new S3OutputFormatConfigProperty {
AggregationConfig = new AggregationConfigProperty {
AggregationType = "aggregationType",
TargetFileSize = 123
},
FileType = "fileType",
PrefixConfig = new PrefixConfigProperty {
PathPrefixHierarchy = new [] { "pathPrefixHierarchy" },
PrefixFormat = "prefixFormat",
PrefixType = "prefixType"
},
PreserveSourceDataTyping = false
}
},
Salesforce = new SalesforceDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
DataTransferApi = "dataTransferApi",
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
WriteOperationType = "writeOperationType"
},
SapoData = new SAPODataDestinationPropertiesProperty {
ObjectPath = "objectPath",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
SuccessResponseHandlingConfig = new SuccessResponseHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix"
},
WriteOperationType = "writeOperationType"
},
Snowflake = new SnowflakeDestinationPropertiesProperty {
IntermediateBucketName = "intermediateBucketName",
Object = "object",
// the properties below are optional
BucketPrefix = "bucketPrefix",
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
}
},
Upsolver = new UpsolverDestinationPropertiesProperty {
BucketName = "bucketName",
S3OutputFormatConfig = new UpsolverS3OutputFormatConfigProperty {
PrefixConfig = new PrefixConfigProperty {
PathPrefixHierarchy = new [] { "pathPrefixHierarchy" },
PrefixFormat = "prefixFormat",
PrefixType = "prefixType"
},
// the properties below are optional
AggregationConfig = new AggregationConfigProperty {
AggregationType = "aggregationType",
TargetFileSize = 123
},
FileType = "fileType"
},
// the properties below are optional
BucketPrefix = "bucketPrefix"
},
Zendesk = new ZendeskDestinationPropertiesProperty {
Object = "object",
// the properties below are optional
ErrorHandlingConfig = new ErrorHandlingConfigProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
FailOnFirstError = false
},
IdFieldNames = new [] { "idFieldNames" },
WriteOperationType = "writeOperationType"
}
},
// the properties below are optional
ApiVersion = "apiVersion",
ConnectorProfileName = "connectorProfileName"
} },
FlowName = "flowName",
SourceFlowConfig = new SourceFlowConfigProperty {
ConnectorType = "connectorType",
SourceConnectorProperties = new SourceConnectorPropertiesProperty {
Amplitude = new AmplitudeSourcePropertiesProperty {
Object = "object"
},
CustomConnector = new CustomConnectorSourcePropertiesProperty {
EntityName = "entityName",
// the properties below are optional
CustomProperties = new Dictionary<string, string> {
{ "customPropertiesKey", "customProperties" }
},
DataTransferApi = new DataTransferApiProperty {
Name = "name",
Type = "type"
}
},
Datadog = new DatadogSourcePropertiesProperty {
Object = "object"
},
Dynatrace = new DynatraceSourcePropertiesProperty {
Object = "object"
},
GoogleAnalytics = new GoogleAnalyticsSourcePropertiesProperty {
Object = "object"
},
InforNexus = new InforNexusSourcePropertiesProperty {
Object = "object"
},
Marketo = new MarketoSourcePropertiesProperty {
Object = "object"
},
Pardot = new PardotSourcePropertiesProperty {
Object = "object"
},
S3 = new S3SourcePropertiesProperty {
BucketName = "bucketName",
BucketPrefix = "bucketPrefix",
// the properties below are optional
S3InputFormatConfig = new S3InputFormatConfigProperty {
S3InputFileType = "s3InputFileType"
}
},
Salesforce = new SalesforceSourcePropertiesProperty {
Object = "object",
// the properties below are optional
DataTransferApi = "dataTransferApi",
EnableDynamicFieldUpdate = false,
IncludeDeletedRecords = false
},
SapoData = new SAPODataSourcePropertiesProperty {
ObjectPath = "objectPath",
// the properties below are optional
PaginationConfig = new SAPODataPaginationConfigProperty {
MaxPageSize = 123
},
ParallelismConfig = new SAPODataParallelismConfigProperty {
MaxParallelism = 123
}
},
ServiceNow = new ServiceNowSourcePropertiesProperty {
Object = "object"
},
Singular = new SingularSourcePropertiesProperty {
Object = "object"
},
Slack = new SlackSourcePropertiesProperty {
Object = "object"
},
Trendmicro = new TrendmicroSourcePropertiesProperty {
Object = "object"
},
Veeva = new VeevaSourcePropertiesProperty {
Object = "object",
// the properties below are optional
DocumentType = "documentType",
IncludeAllVersions = false,
IncludeRenditions = false,
IncludeSourceFiles = false
},
Zendesk = new ZendeskSourcePropertiesProperty {
Object = "object"
}
},
// the properties below are optional
ApiVersion = "apiVersion",
ConnectorProfileName = "connectorProfileName",
IncrementalPullConfig = new IncrementalPullConfigProperty {
DatetimeTypeFieldName = "datetimeTypeFieldName"
}
},
Tasks = new [] { new TaskProperty {
SourceFields = new [] { "sourceFields" },
TaskType = "taskType",
// the properties below are optional
ConnectorOperator = new ConnectorOperatorProperty {
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"
},
DestinationField = "destinationField",
TaskProperties = new [] { new TaskPropertiesObjectProperty {
Key = "key",
Value = "value"
} }
} },
TriggerConfig = new TriggerConfigProperty {
TriggerType = "triggerType",
// the properties below are optional
TriggerProperties = new ScheduledTriggerPropertiesProperty {
ScheduleExpression = "scheduleExpression",
// the properties below are optional
DataPullMode = "dataPullMode",
FirstExecutionFrom = 123,
FlowErrorDeactivationThreshold = 123,
ScheduleEndTime = 123,
ScheduleOffset = 123,
ScheduleStartTime = 123,
TimeZone = "timeZone"
}
},
// the properties below are optional
Description = "description",
FlowStatus = "flowStatus",
KmsArn = "kmsArn",
MetadataCatalogConfig = new MetadataCatalogConfigProperty {
GlueDataCatalog = new GlueDataCatalogProperty {
DatabaseName = "databaseName",
RoleArn = "roleArn",
TablePrefix = "tablePrefix"
}
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});FromFlowArn(Construct, string, string)
Creates a new IFlowRef from an ARN.
public static IFlowRef FromFlowArn(Construct scope, string id, string arn)Parameters
Returns
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
FromFlowName(Construct, string, string)
Creates a new IFlowRef from a flowName.
public static IFlowRef FromFlowName(Construct scope, string id, string flowName)Parameters
Returns
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
IsCfnFlow(object)
Checks whether the given object is a CfnFlow.
public static bool IsCfnFlow(object x)Parameters
- x object
Returns
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::AppFlow::Flow resource is an Amazon AppFlow resource type that specifies a new flow.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
If you want to use 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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-flow.html
CloudformationResource: AWS::AppFlow::Flow
ExampleMetadata: fixture=_generated
Implements
Constructs.IConstruct
Constructs.IDependable