AWS CDK Reference

Appearance

v2.274.0

CfnWorkflowProps Struct ​

Properties for defining a CfnWorkflow.

Source
Generated code
Type last changed
v2.2.0 · 15 Dec 2021

Example ​

ts
// 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 ​

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
Specifies the text description for the workflow.
onExceptionStepsIResolvable | IResolvable | CfnWorkflow.WorkflowStepProperty[]on_exception_stepstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, WorkflowStepProperty]]]onExceptionStepsIResolvableOnExceptionStepsIResolvableOnExceptionStepsinterface{}#
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
stepsIResolvable | IResolvable | CfnWorkflow.WorkflowStepProperty[]stepstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, WorkflowStepProperty]]]stepsIResolvableStepsIResolvableStepsinterface{}required#
Specifies the details for the steps that are in the specified workflow.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
Key-value pairs that can be used to group and search for workflows.

Tags are metadata attached to workflows for any purpose.