Class: AWSCDK::Transfer::CfnServer::WorkflowDetailProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Transfer::CfnServer::WorkflowDetailProperty

Defined in:

transfer/cfn_server.rb

Overview

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.

See Also:

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

Instance Attribute Summary

• #execution_role ⇒ String readonly

  Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources.

• #workflow_id ⇒ String readonly

  A unique identifier for the workflow.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(execution_role:, workflow_id:) ⇒ WorkflowDetailProperty constructor

  A new instance of WorkflowDetailProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(execution_role:, workflow_id:) ⇒ WorkflowDetailProperty

Returns a new instance of WorkflowDetailProperty.

Parameters:

• execution_role (String) —

  Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources.

• workflow_id (String) —

  A unique identifier for the workflow.

# File 'transfer/cfn_server.rb', line 1090

def initialize(execution_role:, workflow_id:)
  @execution_role = execution_role
  Jsii::Type.check_type(@execution_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRole")
  @workflow_id = workflow_id
  Jsii::Type.check_type(@workflow_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workflowId")
end

Instance Attribute Details

#execution_role ⇒ String (readonly)

Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html#cfn-transfer-server-workflowdetail-executionrole

# File 'transfer/cfn_server.rb', line 1101

def execution_role
  @execution_role
end

#workflow_id ⇒ String (readonly)

A unique identifier for the workflow.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html#cfn-transfer-server-workflowdetail-workflowid

# File 'transfer/cfn_server.rb', line 1106

def workflow_id
  @workflow_id
end

Class Method Details

.jsii_properties ⇒ Object

# File 'transfer/cfn_server.rb', line 1108

def self.jsii_properties
  {
    :execution_role => "executionRole",
    :workflow_id => "workflowId",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'transfer/cfn_server.rb', line 1115

def to_jsii
  result = {}
  result.merge!({
    "executionRole" => @execution_role,
    "workflowId" => @workflow_id,
  })
  result.compact
end