AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateFlow operation. Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Appflow.AmazonAppflowRequest
      Amazon.Appflow.Model.CreateFlowRequest

Namespace: Amazon.Appflow.Model
Assembly: AWSSDK.Appflow.dll
Version: 3.x.y.z

Syntax

C#
public class CreateFlowRequest : AmazonAppflowRequest
         IAmazonWebServiceRequest

The CreateFlowRequest type exposes the following members

Constructors

NameDescription
Public Method CreateFlowRequest()

Properties

NameTypeDescription
Public Property ClientToken System.String

Gets and sets the property ClientToken.

The clientToken parameter is an idempotency token. It ensures that your CreateFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token is active for 8 hours.

Public Property Description System.String

Gets and sets the property Description.

A description of the flow you want to create.

Public Property DestinationFlowConfigList System.Collections.Generic.List<Amazon.Appflow.Model.DestinationFlowConfig>

Gets and sets the property DestinationFlowConfigList.

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

Public Property FlowName System.String

Gets and sets the property FlowName.

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Public Property KmsArn System.String

Gets and sets the property KmsArn.

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. 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 Property MetadataCatalogConfig Amazon.Appflow.Model.MetadataCatalogConfig

Gets and sets the property MetadataCatalogConfig.

Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

Public Property SourceFlowConfig Amazon.Appflow.Model.SourceFlowConfig

Gets and sets the property SourceFlowConfig.

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

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

Public Property Tasks System.Collections.Generic.List<Amazon.Appflow.Model.Task>

Gets and sets the property Tasks.

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

Public Property TriggerConfig Amazon.Appflow.Model.TriggerConfig

Gets and sets the property TriggerConfig.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5