Class: AWSCDK::Transfer::CfnWorkflowProps

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

Overview

Properties for defining a CfnWorkflow.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(steps:, description: nil, on_exception_steps: nil, tags: nil) ⇒ CfnWorkflowProps

Returns a new instance of CfnWorkflowProps.

Parameters:



13
14
15
16
17
18
19
20
21
22
 
# File 'transfer/cfn_workflow_props.rb', line 13

def initialize(steps:, description: nil, on_exception_steps: nil, tags: nil)
  @steps = steps
  Jsii::Type.check_type(@steps, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfdHJhbnNmZXIuQ2ZuV29ya2Zsb3cuV29ya2Zsb3dTdGVwUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "steps")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @on_exception_steps = on_exception_steps
  Jsii::Type.check_type(@on_exception_steps, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfdHJhbnNmZXIuQ2ZuV29ya2Zsb3cuV29ya2Zsb3dTdGVwUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "onExceptionSteps") unless @on_exception_steps.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

Specifies the text description for the workflow.

Returns:

  • (String, nil)

See Also:



33
34
35
 
# File 'transfer/cfn_workflow_props.rb', line 33

def description
  @description
end

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

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

Returns:

See Also:



38
39
40
 
# File 'transfer/cfn_workflow_props.rb', line 38

def on_exception_steps
  @on_exception_steps
end

#steps ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Transfer::CfnWorkflow::WorkflowStepProperty> (readonly)

Specifies the details for the steps that are in the specified workflow.

Returns:

See Also:



28
29
30
 
# File 'transfer/cfn_workflow_props.rb', line 28

def steps
  @steps
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Key-value pairs that can be used to group and search for workflows.

Tags are metadata attached to workflows for any purpose.

Returns:

See Also:



45
46
47
 
# File 'transfer/cfn_workflow_props.rb', line 45

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'transfer/cfn_workflow_props.rb', line 47

def self.jsii_properties
  {
    :steps => "steps",
    :description => "description",
    :on_exception_steps => "onExceptionSteps",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'transfer/cfn_workflow_props.rb', line 56

def to_jsii
  result = {}
  result.merge!({
    "steps" => @steps,
    "description" => @description,
    "onExceptionSteps" => @on_exception_steps,
    "tags" => @tags,
  })
  result.compact
end