interface CfnWorkflowMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Transfer.Mixins.CfnWorkflowMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awstransfer/mixins#CfnWorkflowMixinProps
Java	software.amazon.awscdk.mixins.preview.services.transfer.mixins.CfnWorkflowMixinProps
Python	aws_cdk.mixins_preview.aws_transfer.mixins.CfnWorkflowMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_transfer » mixins » CfnWorkflowMixinProps

Properties for CfnWorkflowPropsMixin.

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 { mixins as transfer_mixins } from '@aws-cdk/mixins-preview/aws-transfer';

declare const copyStepDetails: any;
declare const customStepDetails: any;
declare const deleteStepDetails: any;
declare const tagStepDetails: any;
const cfnWorkflowMixinProps: transfer_mixins.CfnWorkflowMixinProps = {
  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',
  }],
  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',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
description?	string	Specifies 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.
steps?	IResolvable | (IResolvable | WorkflowStepProperty)[]	Specifies the details for the steps that are in the specified workflow.
tags?	CfnTag[]	Key-value pairs that can be used to group and search for workflows.

---

description?

Type: string (optional)

Specifies the text description for the workflow.

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

---

onExceptionSteps?

Type: IResolvable | (IResolvable | WorkflowStepProperty)[] (optional)

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

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

---

steps?

Type: IResolvable | (IResolvable | WorkflowStepProperty)[] (optional)

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

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

---

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.

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