Class CfnWorkflowProps

Properties for defining a CfnWorkflow.

Inheritance

object

CfnWorkflowProps

Implements

ICfnWorkflowProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Transfer

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnWorkflowProps : ICfnWorkflowProps

Syntax (vb)

Public Class CfnWorkflowProps Implements ICfnWorkflowProps

Remarks

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

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 cfnWorkflowProps = 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

CfnWorkflowProps()

Properties for defining a CfnWorkflow.

Properties

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	Key-value pairs that can be used to group and search for workflows.

Constructors

CfnWorkflowProps()

Properties for defining a CfnWorkflow.

public CfnWorkflowProps()

Remarks

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

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 cfnWorkflowProps = 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"
                 } }
             };

Properties

Description

Specifies the text description for the workflow.

public string? Description { get; set; }

Property Value

string

Remarks

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

OnExceptionSteps

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

public object? OnExceptionSteps { get; set; }

Property Value

object

Remarks

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

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

Steps

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

public object Steps { get; set; }