DecryptStepDetailsProperty Struct
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
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';
const decryptStepDetailsProperty: transfer.CfnWorkflow.DecryptStepDetailsProperty = {
destinationFileLocation: {
efsFileLocation: {
fileSystemId: 'fileSystemId',
path: 'path',
},
s3FileLocation: {
bucket: 'bucket',
key: 'key',
},
},
type: 'type',
// the properties below are optional
name: 'name',
overwriteExisting: 'overwriteExisting',
sourceFileLocation: 'sourceFileLocation',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_transfer as transfer
decrypt_step_details_property = transfer.CfnWorkflow.DecryptStepDetailsProperty(
destination_file_location=transfer.CfnWorkflow.InputFileLocationProperty(
efs_file_location=transfer.CfnWorkflow.EfsInputFileLocationProperty(
file_system_id="fileSystemId",
path="path"
),
s3_file_location=transfer.CfnWorkflow.S3InputFileLocationProperty(
bucket="bucket",
key="key"
)
),
type="type",
# the properties below are optional
name="name",
overwrite_existing="overwriteExisting",
source_file_location="sourceFileLocation"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Transfer;
var decryptStepDetailsProperty = new DecryptStepDetailsProperty {
DestinationFileLocation = new InputFileLocationProperty {
EfsFileLocation = new EfsInputFileLocationProperty {
FileSystemId = "fileSystemId",
Path = "path"
},
S3FileLocation = new S3InputFileLocationProperty {
Bucket = "bucket",
Key = "key"
}
},
Type = "type",
// the properties below are optional
Name = "name",
OverwriteExisting = "overwriteExisting",
SourceFileLocation = "sourceFileLocation"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
decryptStepDetailsProperty := &DecryptStepDetailsProperty{
DestinationFileLocation: &InputFileLocationProperty{
EfsFileLocation: &EfsInputFileLocationProperty{
FileSystemId: jsii.String("fileSystemId"),
Path: jsii.String("path"),
},
S3FileLocation: &S3InputFileLocationProperty{
Bucket: jsii.String("bucket"),
Key: jsii.String("key"),
},
},
Type: jsii.String("type"),
// the properties below are optional
Name: jsii.String("name"),
OverwriteExisting: jsii.String("overwriteExisting"),
SourceFileLocation: jsii.String("sourceFileLocation"),
}
Properties
destinationFileLocationIResolvable | CfnWorkflow.InputFileLocationPropertydestination_file_locationtyping.Union[IResolvable, InputFileLocationProperty]destinationFileLocationIResolvableDestinationFileLocationIResolvableDestinationFileLocationinterface{}required#Specifies the location for the file being decrypted.
notes
Use ${Transfer:UserName} or ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.
- Set the value of
DestinationFileLocationto${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
DestinationFileLocationto${Transfer:UploadDate}to decrypt uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.
The system resolves
UploadDateto a date format of YYYY-MM-DD , based on the date the file is uploaded in UTC.
The name of the step, used as an identifier.
overwriteExistingoptionalstringoverwrite_existingoptionalstroverwriteExistingoptionalStringOverwriteExistingoptionalstringOverwriteExistingoptional*string#A flag that indicates whether to overwrite an existing file of the same name. The default is `FALSE` .
notes
If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
- If
OverwriteExistingisTRUE, the existing file is replaced with the file being processed. - If
OverwriteExistingisFALSE, nothing happens, and the workflow processing stops.
sourceFileLocationoptionalstringsource_file_locationoptionalstrsourceFileLocationoptionalStringSourceFileLocationoptionalstringSourceFileLocationoptional*string#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.
notes
- 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}.
The type of encryption used.
Currently, this value must be PGP .