class CfnWorkflowPropsMixin

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

Implements IMixin

Extends Mixin

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.

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 } from '@aws-cdk/mixins-preview';
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 cfnWorkflowPropsMixin = new transfer_mixins.CfnWorkflowPropsMixin({
  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',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnWorkflowPropsMixin(props: CfnWorkflowMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnWorkflowMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Transfer::Workflow.

Properties

Name	Type	Description
props	CfnWorkflowMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnWorkflowMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.