aws-cdk-lib.aws_transfer.CfnWorkflowProps

interface CfnWorkflowProps

LanguageType name
.NETAmazon.CDK.AWS.Transfer.CfnWorkflowProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awstransfer#CfnWorkflowProps
Javasoftware.amazon.awscdk.services.transfer.CfnWorkflowProps
Pythonaws_cdk.aws_transfer.CfnWorkflowProps
TypeScript aws-cdk-lib » aws_transfer » CfnWorkflowProps

Properties for defining a CfnWorkflow.

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',
        },
      },
      name: 'name',
      overwriteExisting: 'overwriteExisting',
      sourceFileLocation: 'sourceFileLocation',
      type: 'type',
    },
    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',
        },
      },
      name: 'name',
      overwriteExisting: 'overwriteExisting',
      sourceFileLocation: 'sourceFileLocation',
      type: 'type',
    },
    deleteStepDetails: deleteStepDetails,
    tagStepDetails: tagStepDetails,
    type: 'type',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
stepsIResolvable | IResolvable | WorkflowStepProperty[]Specifies the details for the steps that are in the specified workflow.
description?stringSpecifies the text description for the workflow.
onExceptionSteps?IResolvable | IResolvable | WorkflowStepProperty[]Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
tags?CfnTag[]Key-value pairs that can be used to group and search for workflows.

steps

Type: IResolvable | IResolvable | WorkflowStepProperty[]

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 | WorkflowStepProperty[] (optional)

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


tags?

Type: CfnTag[] (optional)

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

Tags are metadata attached to workflows for any purpose.