Class: AWSCDK::Transfer::CfnWorkflow::DecryptStepDetailsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
transfer/cfn_workflow.rb

Overview

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(destination_file_location:, type:, name: nil, overwrite_existing: nil, source_file_location: nil) ⇒ DecryptStepDetailsProperty

Returns a new instance of DecryptStepDetailsProperty.

Parameters:

  • destination_file_location (AWSCDK::IResolvable, AWSCDK::Transfer::CfnWorkflow::InputFileLocationProperty) —

    Specifies the location for the file being decrypted.

  • type (String) —

    The type of encryption used.

  • name (String, nil) (defaults to: nil) —

    The name of the step, used as an identifier.

  • overwrite_existing (String, nil) (defaults to: nil) —

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

  • source_file_location (String, nil) (defaults to: nil) —

    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.



756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'transfer/cfn_workflow.rb', line 756

def initialize(destination_file_location:, type:, name: nil, overwrite_existing: nil, source_file_location: nil)
  @destination_file_location = destination_file_location.is_a?(Hash) ? ::AWSCDK::Transfer::CfnWorkflow::InputFileLocationProperty.new(**destination_file_location.transform_keys(&:to_sym)) : destination_file_location
  Jsii::Type.check_type(@destination_file_location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5Xb3JrZmxvdy5JbnB1dEZpbGVMb2NhdGlvblByb3BlcnR5In1dfX0=")), "destinationFileLocation")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @overwrite_existing = overwrite_existing
  Jsii::Type.check_type(@overwrite_existing, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "overwriteExisting") unless @overwrite_existing.nil?
  @source_file_location = source_file_location
  Jsii::Type.check_type(@source_file_location, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceFileLocation") unless @source_file_location.nil?
end

Instance Attribute Details

#destination_file_location ⇒ AWSCDK::IResolvable, AWSCDK::Transfer::CfnWorkflow::InputFileLocationProperty (readonly)

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.

Returns:

See Also:



780
781
782
 
# File 'transfer/cfn_workflow.rb', line 780

def destination_file_location
  @destination_file_location
end

#name ⇒ String? (readonly)

The name of the step, used as an identifier.

Returns:

  • (String, nil)

See Also:



792
793
794
 
# File 'transfer/cfn_workflow.rb', line 792

def name
  @name
end

#overwrite_existing ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



802
803
804
 
# File 'transfer/cfn_workflow.rb', line 802

def overwrite_existing
  @overwrite_existing
end

#source_file_location ⇒ String? (readonly)

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} .

Returns:

  • (String, nil)

See Also:



810
811
812
 
# File 'transfer/cfn_workflow.rb', line 810

def source_file_location
  @source_file_location
end

#type ⇒ String (readonly)

The type of encryption used.

Currently, this value must be PGP .

Returns:

  • (String)

See Also:



787
788
789
 
# File 'transfer/cfn_workflow.rb', line 787

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



812
813
814
815
816
817
818
819
820
 
# File 'transfer/cfn_workflow.rb', line 812

def self.jsii_properties
  {
    :destination_file_location => "destinationFileLocation",
    :type => "type",
    :name => "name",
    :overwrite_existing => "overwriteExisting",
    :source_file_location => "sourceFileLocation",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



822
823
824
825
826
827
828
829
830
831
832
 
# File 'transfer/cfn_workflow.rb', line 822

def to_jsii
  result = {}
  result.merge!({
    "destinationFileLocation" => @destination_file_location,
    "type" => @type,
    "name" => @name,
    "overwriteExisting" => @overwrite_existing,
    "sourceFileLocation" => @source_file_location,
  })
  result.compact
end