Package software.amazon.awscdk.services.transfer

Interface CfnWorkflow.DecryptStepDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkflow.DecryptStepDetailsProperty.Jsii$Proxy

Enclosing class:

CfnWorkflow

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

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.

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.*;
 DecryptStepDetailsProperty decryptStepDetailsProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWorkflow.DecryptStepDetailsProperty.Builder	builder()
Object	getDestinationFileLocation()	Specifies the location for the file being decrypted.
default String	getName()	The name of the step, used as an identifier.
default String	getOverwriteExisting()	A flag that indicates whether to overwrite an existing file of the same name.
default String	getSourceFileLocation()	Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
String	getType()	The type of encryption used.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinationFileLocation

@Stability(Stable)
@NotNull
Object getDestinationFileLocation()

Specifies the location for the file being decrypted.

Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

• Set the value of DestinationFileLocation to ${Transfer:UserName} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
• Set the value of DestinationFileLocation to ${Transfer:UploadDate} to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

The system resolves UploadDate to a date format of YYYY-MM-DD , based on the date the file is uploaded in UTC.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

The type of encryption used.

Currently, this value must be PGP .

See Also:

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

getName

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

The name of the step, used as an identifier.

See Also:

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

getOverwriteExisting

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

A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE .

If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

• If OverwriteExisting is TRUE , the existing file is replaced with the file being processed.
• If OverwriteExisting is FALSE , nothing happens, and the workflow processing stops.

See Also:

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

getSourceFileLocation

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

Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.

• To use the previous file as the input, enter ${previous.file} . In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.
• To use the originally uploaded file location as input for this step, enter ${original.file} .

See Also:

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

builder

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

Returns:

a CfnWorkflow.DecryptStepDetailsProperty.Builder of CfnWorkflow.DecryptStepDetailsProperty