Class: AWSCDK::StepFunctionsTasks::EventBridgeSchedulerTarget

Inherits:
Jsii::Object
  • Object
show all
Defined in:
step_functions_tasks/event_bridge_scheduler_target.rb

Overview

The target that EventBridge Scheduler will invoke.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(props) ⇒ EventBridgeSchedulerTarget

Returns a new instance of EventBridgeSchedulerTarget.

Parameters:



9
10
11
12
13
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 9

def initialize(props)
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::EventBridgeSchedulerTargetProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5FdmVudEJyaWRnZVNjaGVkdWxlclRhcmdldFByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



15
16
17
18
19
20
21
22
23
24
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 15

def self.jsii_overridable_methods
  {
    :arn => { kind: :property, name: "arn", is_optional: false },
    :role => { kind: :property, name: "role", is_optional: false },
    :dead_letter_queue => { kind: :property, name: "deadLetterQueue", is_optional: true },
    :input => { kind: :property, name: "input", is_optional: true },
    :retry_policy => { kind: :property, name: "retryPolicy", is_optional: true },
    :render_target_object => { kind: :method, name: "renderTargetObject", is_optional: false },
  }
end

Instance Method Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the target.

Returns:

  • (String) 


29
30
31
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 29

def arn()
  jsii_get_property("arn")
end

#arn=(value) ⇒ Object 



33
34
35
36
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 33

def arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  jsii_set_property("arn", value)
end

#dead_letter_queue ⇒ AWSCDK::SQS::IQueue?

Dead letter queue for failed events.

Returns:



53
54
55
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 53

def dead_letter_queue()
  jsii_get_property("deadLetterQueue")
end

#dead_letter_queue=(value) ⇒ Object 



57
58
59
60
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 57

def dead_letter_queue=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3FzLklRdWV1ZSJ9")), "deadLetterQueue") unless value.nil?
  jsii_set_property("deadLetterQueue", value)
end

#input ⇒ String?

The input to the target.

Returns:

  • (String, nil) 


65
66
67
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 65

def input()
  jsii_get_property("input")
end

#input=(value) ⇒ Object 



69
70
71
72
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 69

def input=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "input") unless value.nil?
  jsii_set_property("input", value)
end

#render_target_object ⇒ Object

return the target object for the EventBridge Scheduler.

Returns:

  • (Object) 


90
91
92
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 90

def render_target_object()
  jsii_call_method("renderTargetObject", [])
end

#retry_policy ⇒ AWSCDK::StepFunctionsTasks::RetryPolicy?

The retry policy settings.

Returns:



77
78
79
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 77

def retry_policy()
  jsii_get_property("retryPolicy")
end

#retry_policy=(value) ⇒ Object 



81
82
83
84
85
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 81

def retry_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::RetryPolicy.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5SZXRyeVBvbGljeSJ9")), "retryPolicy") unless value.nil?
  jsii_set_property("retryPolicy", value)
end

#role ⇒ AWSCDK::IAM::IRole

The IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

Returns:



41
42
43
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 41

def role()
  jsii_get_property("role")
end

#role=(value) ⇒ Object 



45
46
47
48
 
# File 'step_functions_tasks/event_bridge_scheduler_target.rb', line 45

def role=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role")
  jsii_set_property("role", value)
end