Class: AWSCDK::Transfer::CfnServer::WorkflowDetailsProperty

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

Overview

Container for the WorkflowDetail data type.

It is used by actions that trigger a workflow to begin execution.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(on_partial_upload: nil, on_upload: nil) ⇒ WorkflowDetailsProperty

Returns a new instance of WorkflowDetailsProperty.

Parameters:



1135
1136
1137
1138
1139
1140
 
# File 'transfer/cfn_server.rb', line 1135

def initialize(on_partial_upload: nil, on_upload: nil)
  @on_partial_upload = on_partial_upload
  Jsii::Type.check_type(@on_partial_upload, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfdHJhbnNmZXIuQ2ZuU2VydmVyLldvcmtmbG93RGV0YWlsUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "onPartialUpload") unless @on_partial_upload.nil?
  @on_upload = on_upload
  Jsii::Type.check_type(@on_upload, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfdHJhbnNmZXIuQ2ZuU2VydmVyLldvcmtmbG93RGV0YWlsUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "onUpload") unless @on_upload.nil?
end

Instance Attribute Details

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

A trigger that starts a workflow if a file is only partially uploaded.

You can attach a workflow to a server that executes whenever there is a partial upload.

A partial upload occurs when a file is open when the session disconnects.

OnPartialUpload can contain a maximum of one WorkflowDetail object.

Returns:

See Also:



1152
1153
1154
 
# File 'transfer/cfn_server.rb', line 1152

def on_partial_upload
  @on_partial_upload
end

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

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'

OnUpload can contain a maximum of one WorkflowDetail object.

Returns:

See Also:



1163
1164
1165
 
# File 'transfer/cfn_server.rb', line 1163

def on_upload
  @on_upload
end

Class Method Details

.jsii_properties ⇒ Object 



1165
1166
1167
1168
1169
1170
 
# File 'transfer/cfn_server.rb', line 1165

def self.jsii_properties
  {
    :on_partial_upload => "onPartialUpload",
    :on_upload => "onUpload",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'transfer/cfn_server.rb', line 1172

def to_jsii
  result = {}
  result.merge!({
    "onPartialUpload" => @on_partial_upload,
    "onUpload" => @on_upload,
  })
  result.compact
end