Class: AWSCDK::Transfer::CfnWorkflow::WorkflowStepProperty

Inherits:

Jsii::Struct

Object
Jsii::Struct
AWSCDK::Transfer::CfnWorkflow::WorkflowStepProperty

show all

Defined in:: transfer/cfn_workflow.rb

Overview

The basic building block of a workflow.

See Also:

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

Instance Attribute Summary collapse

#copy_step_details ⇒ Object^? readonly
Details for a step that performs a file copy.
#custom_step_details ⇒ Object^? readonly
Details for a step that invokes an AWS Lambda function.
#decrypt_step_details ⇒ AWSCDK::IResolvable, ... readonly
Details for a step that decrypts an encrypted file.
#delete_step_details ⇒ Object^? readonly
Details for a step that deletes the file.
#tag_step_details ⇒ Object^? readonly
Details for a step that creates one or more tags.
#type ⇒ String^? readonly
Currently, the following step types are supported.

Class Method Summary collapse

.jsii_properties ⇒ Object

Instance Method Summary collapse

#initialize(copy_step_details: nil, custom_step_details: nil, decrypt_step_details: nil, delete_step_details: nil, tag_step_details: nil, type: nil) ⇒ WorkflowStepProperty constructor
A new instance of WorkflowStepProperty.
#to_jsii ⇒ Object

Constructor Details

#initialize(copy_step_details: nil, custom_step_details: nil, decrypt_step_details: nil, delete_step_details: nil, tag_step_details: nil, type: nil) ⇒ `WorkflowStepProperty`

Returns a new instance of WorkflowStepProperty.

Parameters:

copy_step_details (Object, nil) (defaults to: nil) —
Details for a step that performs a file copy.
custom_step_details (Object, nil) (defaults to: nil) —
Details for a step that invokes an AWS Lambda function.
decrypt_step_details (AWSCDK::IResolvable, AWSCDK::Transfer::CfnWorkflow::DecryptStepDetailsProperty, nil) (defaults to: nil) —
Details for a step that decrypts an encrypted file.
delete_step_details (Object, nil) (defaults to: nil) —
Details for a step that deletes the file.
tag_step_details (Object, nil) (defaults to: nil) —
Details for a step that creates one or more tags.
type (String, nil) (defaults to: nil) —
Currently, the following step types are supported.

# File 'transfer/cfn_workflow.rb', line 1160

def initialize(copy_step_details: nil, custom_step_details: nil, decrypt_step_details: nil, delete_step_details: nil, tag_step_details: nil, type: nil)
  @copy_step_details = copy_step_details
  Jsii::Type.check_type(@copy_step_details, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "copyStepDetails") unless @copy_step_details.nil?
  @custom_step_details = custom_step_details
  Jsii::Type.check_type(@custom_step_details, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "customStepDetails") unless @custom_step_details.nil?
  @decrypt_step_details = decrypt_step_details.is_a?(Hash) ? ::AWSCDK::Transfer::CfnWorkflow::DecryptStepDetailsProperty.new(**decrypt_step_details.transform_keys(&:to_sym)) : decrypt_step_details
  Jsii::Type.check_type(@decrypt_step_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190cmFuc2Zlci5DZm5Xb3JrZmxvdy5EZWNyeXB0U3RlcERldGFpbHNQcm9wZXJ0eSJ9XX19")), "decryptStepDetails") unless @decrypt_step_details.nil?
  @delete_step_details = delete_step_details
  Jsii::Type.check_type(@delete_step_details, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "deleteStepDetails") unless @delete_step_details.nil?
  @tag_step_details = tag_step_details
  Jsii::Type.check_type(@tag_step_details, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tagStepDetails") unless @tag_step_details.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#copy_step_details ⇒ `Object`^? (readonly)

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 .

Returns:

(Object, nil)

See Also:

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



1185
1186
1187

# File 'transfer/cfn_workflow.rb', line 1185

def copy_step_details
  @copy_step_details
end

#custom_step_details ⇒ `Object`^? (readonly)

Details for a step that invokes an AWS Lambda function.

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

Returns:

(Object, nil)

See Also:

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



1192
1193
1194

# File 'transfer/cfn_workflow.rb', line 1192

def custom_step_details
  @custom_step_details
end

#decrypt_step_details ⇒ `AWSCDK::IResolvable`, ... (readonly)

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:

(AWSCDK::IResolvable, AWSCDK::Transfer::CfnWorkflow::DecryptStepDetailsProperty, nil)

See Also:

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



1205
1206
1207

# File 'transfer/cfn_workflow.rb', line 1205

def decrypt_step_details
  @decrypt_step_details
end

#delete_step_details ⇒ `Object`^? (readonly)

Details for a step that deletes the file.

Returns:

(Object, nil)

See Also:

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



1210
1211
1212

# File 'transfer/cfn_workflow.rb', line 1210

def delete_step_details
  @delete_step_details
end

#tag_step_details ⇒ `Object`^? (readonly)

Details for a step that creates one or more tags.

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

Returns:

(Object, nil)

See Also:

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



1217
1218
1219

# File 'transfer/cfn_workflow.rb', line 1217

def tag_step_details
  @tag_step_details
end

#type ⇒ `String`^? (readonly)

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.

Returns:

(String, nil)

See Also:

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



1228
1229
1230

# File 'transfer/cfn_workflow.rb', line 1228

def type
  @type
end

Class Method Details

.jsii_properties ⇒ `Object`

# File 'transfer/cfn_workflow.rb', line 1230

def self.jsii_properties
  {
    :copy_step_details => "copyStepDetails",
    :custom_step_details => "customStepDetails",
    :decrypt_step_details => "decryptStepDetails",
    :delete_step_details => "deleteStepDetails",
    :tag_step_details => "tagStepDetails",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ `Object`

# File 'transfer/cfn_workflow.rb', line 1241

def to_jsii
  result = {}
  result.merge!({
    "copyStepDetails" => @copy_step_details,
    "customStepDetails" => @custom_step_details,
    "decryptStepDetails" => @decrypt_step_details,
    "deleteStepDetails" => @delete_step_details,
    "tagStepDetails" => @tag_step_details,
    "type" => @type,
  })
  result.compact
end

Class: AWSCDK::Transfer::CfnWorkflow::WorkflowStepProperty

Overview

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(copy_step_details: nil, custom_step_details: nil, decrypt_step_details: nil, delete_step_details: nil, tag_step_details: nil, type: nil) ⇒ WorkflowStepProperty

Instance Attribute Details

#copy_step_details ⇒ Object? (readonly)

#custom_step_details ⇒ Object? (readonly)

#decrypt_step_details ⇒ AWSCDK::IResolvable, ... (readonly)

#delete_step_details ⇒ Object? (readonly)

#tag_step_details ⇒ Object? (readonly)

#type ⇒ String? (readonly)

Class Method Details

.jsii_properties ⇒ Object

Instance Method Details

#to_jsii ⇒ Object

#initialize(copy_step_details: nil, custom_step_details: nil, decrypt_step_details: nil, delete_step_details: nil, tag_step_details: nil, type: nil) ⇒ `WorkflowStepProperty`

#copy_step_details ⇒ `Object`^? (readonly)

#custom_step_details ⇒ `Object`^? (readonly)

#decrypt_step_details ⇒ `AWSCDK::IResolvable`, ... (readonly)

#delete_step_details ⇒ `Object`^? (readonly)

#tag_step_details ⇒ `Object`^? (readonly)

#type ⇒ `String`^? (readonly)

.jsii_properties ⇒ `Object`

#to_jsii ⇒ `Object`