Class CfnWorkflow

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnWorkflow

Implements

IInspectable

IWorkflowRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Transfer

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnWorkflow : CfnResource, IInspectable, IWorkflowRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnWorkflow Inherits CfnResource Implements IInspectable, IWorkflowRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

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.Transfer;

             var copyStepDetails;
             var customStepDetails;
             var deleteStepDetails;
             var tagStepDetails;

             var cfnWorkflow = new CfnWorkflow(this, "MyCfnWorkflow", new CfnWorkflowProps {
                 Steps = new [] { new WorkflowStepProperty {
                     CopyStepDetails = copyStepDetails,
                     CustomStepDetails = customStepDetails,
                     DecryptStepDetails = new DecryptStepDetailsProperty {
                         DestinationFileLocation = new InputFileLocationProperty {
                             EfsFileLocation = new EfsInputFileLocationProperty {
                                 FileSystemId = "fileSystemId",
                                 Path = "path"
                             },
                             S3FileLocation = new S3InputFileLocationProperty {
                                 Bucket = "bucket",
                                 Key = "key"
                             }
                         },
                         Type = "type",

                         // the properties below are optional
                         Name = "name",
                         OverwriteExisting = "overwriteExisting",
                         SourceFileLocation = "sourceFileLocation"
                     },
                     DeleteStepDetails = deleteStepDetails,
                     TagStepDetails = tagStepDetails,
                     Type = "type"
                 } },

                 // the properties below are optional
                 Description = "description",
                 OnExceptionSteps = new [] { new WorkflowStepProperty {
                     CopyStepDetails = copyStepDetails,
                     CustomStepDetails = customStepDetails,
                     DecryptStepDetails = new DecryptStepDetailsProperty {
                         DestinationFileLocation = new InputFileLocationProperty {
                             EfsFileLocation = new EfsInputFileLocationProperty {
                                 FileSystemId = "fileSystemId",
                                 Path = "path"
                             },
                             S3FileLocation = new S3InputFileLocationProperty {
                                 Bucket = "bucket",
                                 Key = "key"
                             }
                         },
                         Type = "type",

                         // the properties below are optional
                         Name = "name",
                         OverwriteExisting = "overwriteExisting",
                         SourceFileLocation = "sourceFileLocation"
                     },
                     DeleteStepDetails = deleteStepDetails,
                     TagStepDetails = tagStepDetails,
                     Type = "type"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnWorkflow(Construct, string, ICfnWorkflowProps)

Create a new AWS::Transfer::Workflow.

Properties

AttrArn	Specifies the unique Amazon Resource Name (ARN) for the workflow.
AttrWorkflowId	A unique identifier for a workflow.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
CfnPropertyNames	Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
Description	Specifies the text description for the workflow.
OnExceptionSteps	Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
Steps	Specifies the details for the steps that are in the specified workflow.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Key-value pairs that can be used to group and search for workflows.
WorkflowRef	A reference to a Workflow resource.

Methods

ArnForWorkflow(IWorkflowRef)	Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.
FromWorkflowArn(Construct, string, string)	Creates a new IWorkflowRef from an ARN.
FromWorkflowId(Construct, string, string)	Creates a new IWorkflowRef from a workflowId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnWorkflow(object)	Checks whether the given object is a CfnWorkflow.
RenderProperties(IDictionary<string, object>)	Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.

Constructors

CfnWorkflow(Construct, string, ICfnWorkflowProps)

Create a new AWS::Transfer::Workflow.

public CfnWorkflow(Construct scope, string id, ICfnWorkflowProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnWorkflowProps

Resource properties.

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

Properties

AttrArn

Specifies the unique Amazon Resource Name (ARN) for the workflow.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrWorkflowId

A unique identifier for a workflow.

public virtual string AttrWorkflowId { get; }

Property Value

string

Remarks

CloudformationAttribute: WorkflowId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

CfnProperties

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

CfnPropertyNames

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

Description

Specifies the text description for the workflow.

public virtual string? Description { get; set; }

Property Value

string

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

OnExceptionSteps

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

public virtual object? OnExceptionSteps { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnWorkflow.IWorkflowStepProperty)[]

Steps

Specifies the details for the steps that are in the specified workflow.

public virtual object Steps { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnWorkflow.IWorkflowStepProperty)[]

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

TagsRaw

Key-value pairs that can be used to group and search for workflows.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

WorkflowRef

A reference to a Workflow resource.

public virtual IWorkflowReference WorkflowRef { get; }

Property Value

IWorkflowReference

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

Methods

ArnForWorkflow(IWorkflowRef)

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.

public static string ArnForWorkflow(IWorkflowRef resource)

Parameters

resource IWorkflowRef

Returns

string

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

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.Transfer;

             var copyStepDetails;
             var customStepDetails;
             var deleteStepDetails;
             var tagStepDetails;

             var cfnWorkflow = new CfnWorkflow(this, "MyCfnWorkflow", new CfnWorkflowProps {
                 Steps = new [] { new WorkflowStepProperty {
                     CopyStepDetails = copyStepDetails,
                     CustomStepDetails = customStepDetails,
                     DecryptStepDetails = new DecryptStepDetailsProperty {
                         DestinationFileLocation = new InputFileLocationProperty {
                             EfsFileLocation = new EfsInputFileLocationProperty {
                                 FileSystemId = "fileSystemId",
                                 Path = "path"
                             },
                             S3FileLocation = new S3InputFileLocationProperty {
                                 Bucket = "bucket",
                                 Key = "key"
                             }
                         },
                         Type = "type",

                         // the properties below are optional
                         Name = "name",
                         OverwriteExisting = "overwriteExisting",
                         SourceFileLocation = "sourceFileLocation"
                     },
                     DeleteStepDetails = deleteStepDetails,
                     TagStepDetails = tagStepDetails,
                     Type = "type"
                 } },

                 // the properties below are optional
                 Description = "description",
                 OnExceptionSteps = new [] { new WorkflowStepProperty {
                     CopyStepDetails = copyStepDetails,
                     CustomStepDetails = customStepDetails,
                     DecryptStepDetails = new DecryptStepDetailsProperty {
                         DestinationFileLocation = new InputFileLocationProperty {
                             EfsFileLocation = new EfsInputFileLocationProperty {
                                 FileSystemId = "fileSystemId",
                                 Path = "path"
                             },
                             S3FileLocation = new S3InputFileLocationProperty {
                                 Bucket = "bucket",
                                 Key = "key"
                             }
                         },
                         Type = "type",

                         // the properties below are optional
                         Name = "name",
                         OverwriteExisting = "overwriteExisting",
                         SourceFileLocation = "sourceFileLocation"
                     },
                     DeleteStepDetails = deleteStepDetails,
                     TagStepDetails = tagStepDetails,
                     Type = "type"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromWorkflowArn(Construct, string, string)

Creates a new IWorkflowRef from an ARN.

public static IWorkflowRef FromWorkflowArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IWorkflowRef

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

FromWorkflowId(Construct, string, string)

Creates a new IWorkflowRef from a workflowId.

public static IWorkflowRef FromWorkflowId(Construct scope, string id, string workflowId)

Parameters

scope Construct

id string

workflowId string

Returns

IWorkflowRef

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

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

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

IsCfnWorkflow(object)

Checks whether the given object is a CfnWorkflow.

public static bool IsCfnWorkflow(object x)

Parameters

x object

Returns

bool

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html

CloudformationResource: AWS::Transfer::Workflow

ExampleMetadata: fixture=_generated

Implements

IInspectable

IWorkflowRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable