interface CfnWorkflowProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Transfer.CfnWorkflowProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awstransfer#CfnWorkflowProps |
![]() | software.amazon.awscdk.services.transfer.CfnWorkflowProps |
![]() | aws_cdk.aws_transfer.CfnWorkflowProps |
![]() | aws-cdk-lib » aws_transfer » CfnWorkflowProps |
Properties for defining a CfnWorkflow
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-workflow.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_transfer as transfer } from 'aws-cdk-lib';
declare const copyStepDetails: any;
declare const customStepDetails: any;
declare const deleteStepDetails: any;
declare const tagStepDetails: any;
const cfnWorkflowProps: transfer.CfnWorkflowProps = {
steps: [{
copyStepDetails: copyStepDetails,
customStepDetails: customStepDetails,
decryptStepDetails: {
destinationFileLocation: {
efsFileLocation: {
fileSystemId: 'fileSystemId',
path: 'path',
},
s3FileLocation: {
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: [{
copyStepDetails: copyStepDetails,
customStepDetails: customStepDetails,
decryptStepDetails: {
destinationFileLocation: {
efsFileLocation: {
fileSystemId: 'fileSystemId',
path: 'path',
},
s3FileLocation: {
bucket: 'bucket',
key: 'key',
},
},
type: 'type',
// the properties below are optional
name: 'name',
overwriteExisting: 'overwriteExisting',
sourceFileLocation: 'sourceFileLocation',
},
deleteStepDetails: deleteStepDetails,
tagStepDetails: tagStepDetails,
type: 'type',
}],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
steps | IResolvable | IResolvable | Workflow [] | Specifies the details for the steps that are in the specified workflow. |
description? | string | Specifies the text description for the workflow. |
on | IResolvable | IResolvable | Workflow [] | Specifies the steps (actions) to take if errors are encountered during execution of the workflow. |
tags? | Cfn [] | Key-value pairs that can be used to group and search for workflows. |
steps
Type:
IResolvable
|
IResolvable
|
Workflow
[]
Specifies the details for the steps that are in the specified workflow.
description?
Type:
string
(optional)
Specifies the text description for the workflow.
onExceptionSteps?
Type:
IResolvable
|
IResolvable
|
Workflow
[]
(optional)
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
tags?
Type:
Cfn
[]
(optional)
Key-value pairs that can be used to group and search for workflows.
Tags are metadata attached to workflows for any purpose.