Package software.amazon.awscdk.services.transfer

Interface CfnWorkflow.WorkflowStepProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkflow.WorkflowStepProperty.Jsii$Proxy

Enclosing class:

CfnWorkflow

@Stability(Stable)
public static interface CfnWorkflow.WorkflowStepProperty
extends software.amazon.jsii.JsiiSerializable

The basic building block of a workflow.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 Object copyStepDetails;
 Object customStepDetails;
 Object deleteStepDetails;
 Object tagStepDetails;
 WorkflowStepProperty workflowStepProperty = WorkflowStepProperty.builder()
         .copyStepDetails(copyStepDetails)
         .customStepDetails(customStepDetails)
         .decryptStepDetails(DecryptStepDetailsProperty.builder()
                 .destinationFileLocation(InputFileLocationProperty.builder()
                         .efsFileLocation(EfsInputFileLocationProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 .path("path")
                                 .build())
                         .s3FileLocation(S3InputFileLocationProperty.builder()
                                 .bucket("bucket")
                                 .key("key")
                                 .build())
                         .build())
                 .type("type")
                 // the properties below are optional
                 .name("name")
                 .overwriteExisting("overwriteExisting")
                 .sourceFileLocation("sourceFileLocation")
                 .build())
         .deleteStepDetails(deleteStepDetails)
         .tagStepDetails(tagStepDetails)
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkflow.WorkflowStepProperty.Builder	A builder for CfnWorkflow.WorkflowStepProperty
static final class	CfnWorkflow.WorkflowStepProperty.Jsii$Proxy	An implementation for CfnWorkflow.WorkflowStepProperty

Method Summary

Modifier and Type	Method	Description
static CfnWorkflow.WorkflowStepProperty.Builder	builder()
default Object	getCopyStepDetails()	Details for a step that performs a file copy.
default Object	getCustomStepDetails()	Details for a step that invokes an AWS Lambda function.
default Object	getDecryptStepDetails()	Details for a step that decrypts an encrypted file.
default Object	getDeleteStepDetails()	Details for a step that deletes the file.
default Object	getTagStepDetails()	Details for a step that creates one or more tags.
default String	getType()	Currently, the following step types are supported.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCopyStepDetails

@Stability(Stable)
@Nullable
default Object getCopyStepDetails()

Details for a step that performs a file copy.

Consists of the following values:

• A description
• An Amazon S3 location for the destination of the file copy.
• A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-copystepdetails

getCustomStepDetails

@Stability(Stable)
@Nullable
default Object getCustomStepDetails()

Details for a step that invokes an AWS Lambda function.

Consists of the Lambda function's name, target, and timeout (in seconds).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-customstepdetails

getDecryptStepDetails

@Stability(Stable)
@Nullable
default Object getDecryptStepDetails()

Details for a step that decrypts an encrypted file.

Consists of the following values:

• A descriptive name
• An Amazon S3 or Amazon Elastic File System (Amazon EFS) location for the source file to decrypt.
• An S3 or Amazon EFS location for the destination of the file decryption.
• A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE .
• The type of encryption that's used. Currently, only PGP encryption is supported.

Returns union: either IResolvable or CfnWorkflow.DecryptStepDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-decryptstepdetails

getDeleteStepDetails

@Stability(Stable)
@Nullable
default Object getDeleteStepDetails()

Details for a step that deletes the file.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-deletestepdetails

getTagStepDetails

@Stability(Stable)
@Nullable
default Object getTagStepDetails()

Details for a step that creates one or more tags.

You specify one or more tags. Each tag contains a key-value pair.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-tagstepdetails

getType

@Stability(Stable)
@Nullable
default String getType()

Currently, the following step types are supported.

• COPY - Copy the file to another location.
• CUSTOM - Perform a custom step with an AWS Lambda function target.
• DECRYPT - Decrypt a file that was encrypted before it was uploaded.
• DELETE - Delete the file.
• TAG - Add a tag to the file.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html#cfn-transfer-workflow-workflowstep-type

builder

@Stability(Stable)
static CfnWorkflow.WorkflowStepProperty.Builder builder()

Returns:

a CfnWorkflow.WorkflowStepProperty.Builder of CfnWorkflow.WorkflowStepProperty