Class CfnWorkflow
A CloudFormation AWS::Transfer::Workflow
.
Inherited Members
Namespace: Amazon.CDK.AWS.Transfer
Assembly: Amazon.CDK.AWS.Transfer.dll
Syntax (csharp)
public class CfnWorkflow : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnWorkflow
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. 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.
CloudformationResource: AWS::Transfer::Workflow
Link: 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 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"
}
},
Name = "name",
OverwriteExisting = "overwriteExisting",
SourceFileLocation = "sourceFileLocation",
Type = "type"
},
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"
}
},
Name = "name",
OverwriteExisting = "overwriteExisting",
SourceFileLocation = "sourceFileLocation",
Type = "type"
},
DeleteStepDetails = deleteStepDetails,
TagStepDetails = tagStepDetails,
Type = "type"
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnWorkflow(Construct, String, ICfnWorkflowProps) | Create a new |
CfnWorkflow(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnWorkflow(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | |
AttrWorkflowId | A unique identifier for a workflow. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnWorkflowProps
- resource properties.
CfnWorkflow(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnWorkflow(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnWorkflow(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnWorkflow(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrWorkflowId
A unique identifier for a workflow.
public virtual string AttrWorkflowId { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
Specifies the text description for the workflow.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
OnExceptionSteps
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
public virtual object OnExceptionSteps { get; set; }
Property Value
System.Object
Remarks
Steps
Specifies the details for the steps that are in the specified workflow.
public virtual object Steps { get; set; }
Property Value
System.Object
Remarks
Tags
Key-value pairs that can be used to group and search for workflows.
public virtual TagManager Tags { get; }
Property Value
Remarks
Tags are metadata attached to workflows for any purpose.
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>