Class: AWSCDK::StepFunctionsTasks::EventBridgeSchedulerTargetProps

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

Overview

Properties for EventBridgeSchedulerTarget.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn:, role:, dead_letter_queue: nil, input: nil, retry_policy: nil) ⇒ EventBridgeSchedulerTargetProps

Returns a new instance of EventBridgeSchedulerTargetProps.

Parameters:

  • arn (String) —

    The Amazon Resource Name (ARN) of the target.

  • role (AWSCDK::IAM::IRole) —

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

  • dead_letter_queue (AWSCDK::SQS::IQueue, nil) (defaults to: nil) —

    Dead letter queue for failed events.

  • input (String, nil) (defaults to: nil) —

    The input to the target.

  • retry_policy (AWSCDK::StepFunctionsTasks::RetryPolicy, nil) (defaults to: nil) —

    The retry policy settings.



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

def initialize(arn:, role:, dead_letter_queue: nil, input: nil, retry_policy: nil)
  @arn = arn
  Jsii::Type.check_type(@arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role")
  @dead_letter_queue = dead_letter_queue
  Jsii::Type.check_type(@dead_letter_queue, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3FzLklRdWV1ZSJ9")), "deadLetterQueue") unless @dead_letter_queue.nil?
  @input = input
  Jsii::Type.check_type(@input, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "input") unless @input.nil?
  @retry_policy = retry_policy.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::RetryPolicy.new(**retry_policy.transform_keys(&:to_sym)) : retry_policy
  Jsii::Type.check_type(@retry_policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5SZXRyeVBvbGljeSJ9")), "retryPolicy") unless @retry_policy.nil?
end

Instance Attribute Details

#arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the target.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'step_functions_tasks/event_bridge_scheduler_target_props.rb', line 31

def arn
  @arn
end

#dead_letter_queue ⇒ AWSCDK::SQS::IQueue? (readonly)

Note:

Default: - No dead letter queue

Dead letter queue for failed events.

Returns:



40
41
42
 
# File 'step_functions_tasks/event_bridge_scheduler_target_props.rb', line 40

def dead_letter_queue
  @dead_letter_queue
end

#input ⇒ String? (readonly)

Note:

Default: - EventBridge Scheduler delivers a default notification to the target

The input to the target.

Returns:

  • (String, nil) 


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

def input
  @input
end

#retry_policy ⇒ AWSCDK::StepFunctionsTasks::RetryPolicy? (readonly)

Note:

Default: - Do not retry

The retry policy settings.

Returns:



50
51
52
 
# File 'step_functions_tasks/event_bridge_scheduler_target_props.rb', line 50

def retry_policy
  @retry_policy
end

#role ⇒ AWSCDK::IAM::IRole (readonly)

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

Returns:



35
36
37
 
# File 'step_functions_tasks/event_bridge_scheduler_target_props.rb', line 35

def role
  @role
end

Class Method Details

.jsii_properties ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'step_functions_tasks/event_bridge_scheduler_target_props.rb', line 52

def self.jsii_properties
  {
    :arn => "arn",
    :role => "role",
    :dead_letter_queue => "deadLetterQueue",
    :input => "input",
    :retry_policy => "retryPolicy",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
 
# File 'step_functions_tasks/event_bridge_scheduler_target_props.rb', line 62

def to_jsii
  result = {}
  result.merge!({
    "arn" => @arn,
    "role" => @role,
    "deadLetterQueue" => @dead_letter_queue,
    "input" => @input,
    "retryPolicy" => @retry_policy,
  })
  result.compact
end