Class: AWSCDK::Scheduler::ScheduleTargetConfig

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
scheduler/schedule_target_config.rb

Overview

Config of a Schedule Target used during initialization of Schedule.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arn:, role:, dead_letter_config: nil, ecs_parameters: nil, event_bridge_parameters: nil, input: nil, kinesis_parameters: nil, retry_policy: nil, sage_maker_pipeline_parameters: nil, sqs_parameters: nil) ⇒ ScheduleTargetConfig

Returns a new instance of ScheduleTargetConfig.

Parameters:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'scheduler/schedule_target_config.rb', line 17

def initialize(arn:, role:, dead_letter_config: nil, ecs_parameters: nil, event_bridge_parameters: nil, input: nil, kinesis_parameters: nil, retry_policy: nil, sage_maker_pipeline_parameters: nil, sqs_parameters: 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_config = dead_letter_config.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::DeadLetterConfigProperty.new(**dead_letter_config.transform_keys(&:to_sym)) : dead_letter_config
  Jsii::Type.check_type(@dead_letter_config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2NoZWR1bGVyLkNmblNjaGVkdWxlLkRlYWRMZXR0ZXJDb25maWdQcm9wZXJ0eSJ9")), "deadLetterConfig") unless @dead_letter_config.nil?
  @ecs_parameters = ecs_parameters.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::ECSParametersProperty.new(**ecs_parameters.transform_keys(&:to_sym)) : ecs_parameters
  Jsii::Type.check_type(@ecs_parameters, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2NoZWR1bGVyLkNmblNjaGVkdWxlLkVjc1BhcmFtZXRlcnNQcm9wZXJ0eSJ9")), "ecsParameters") unless @ecs_parameters.nil?
  @event_bridge_parameters = event_bridge_parameters.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::EventBridgeParametersProperty.new(**event_bridge_parameters.transform_keys(&:to_sym)) : event_bridge_parameters
  Jsii::Type.check_type(@event_bridge_parameters, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2NoZWR1bGVyLkNmblNjaGVkdWxlLkV2ZW50QnJpZGdlUGFyYW1ldGVyc1Byb3BlcnR5In0=")), "eventBridgeParameters") unless @event_bridge_parameters.nil?
  @input = input
  Jsii::Type.check_type(@input, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2NoZWR1bGVyLlNjaGVkdWxlVGFyZ2V0SW5wdXQifQ==")), "input") unless @input.nil?
  @kinesis_parameters = kinesis_parameters.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::KinesisParametersProperty.new(**kinesis_parameters.transform_keys(&:to_sym)) : kinesis_parameters
  Jsii::Type.check_type(@kinesis_parameters, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2NoZWR1bGVyLkNmblNjaGVkdWxlLktpbmVzaXNQYXJhbWV0ZXJzUHJvcGVydHkifQ==")), "kinesisParameters") unless @kinesis_parameters.nil?
  @retry_policy = retry_policy.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::RetryPolicyProperty.new(**retry_policy.transform_keys(&:to_sym)) : retry_policy
  Jsii::Type.check_type(@retry_policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2NoZWR1bGVyLkNmblNjaGVkdWxlLlJldHJ5UG9saWN5UHJvcGVydHkifQ==")), "retryPolicy") unless @retry_policy.nil?
  @sage_maker_pipeline_parameters = sage_maker_pipeline_parameters.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::SageMakerPipelineParametersProperty.new(**sage_maker_pipeline_parameters.transform_keys(&:to_sym)) : sage_maker_pipeline_parameters
  Jsii::Type.check_type(@sage_maker_pipeline_parameters, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2NoZWR1bGVyLkNmblNjaGVkdWxlLlNhZ2VNYWtlclBpcGVsaW5lUGFyYW1ldGVyc1Byb3BlcnR5In0=")), "sageMakerPipelineParameters") unless @sage_maker_pipeline_parameters.nil?
  @sqs_parameters = sqs_parameters.is_a?(Hash) ? ::AWSCDK::Scheduler::CfnSchedule::SQSParametersProperty.new(**sqs_parameters.transform_keys(&:to_sym)) : sqs_parameters
  Jsii::Type.check_type(@sqs_parameters, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2NoZWR1bGVyLkNmblNjaGVkdWxlLlNxc1BhcmFtZXRlcnNQcm9wZXJ0eSJ9")), "sqsParameters") unless @sqs_parameters.nil?
end

Instance Attribute Details

#arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the target.

Returns:

  • (String) 


43
44
45
 
# File 'scheduler/schedule_target_config.rb', line 43

def arn
  @arn
end

#dead_letter_config ⇒ AWSCDK::Scheduler::CfnSchedule::DeadLetterConfigProperty? (readonly)

Note:

Default: - No dead-letter queue

An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.

If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

Returns:



54
55
56
 
# File 'scheduler/schedule_target_config.rb', line 54

def dead_letter_config
  @dead_letter_config
end

#ecs_parameters ⇒ AWSCDK::Scheduler::CfnSchedule::ECSParametersProperty? (readonly)

Note:

Default: - No parameters

The templated target type for the Amazon ECS RunTask API Operation.

Returns:



59
60
61
 
# File 'scheduler/schedule_target_config.rb', line 59

def ecs_parameters
  @ecs_parameters
end

#event_bridge_parameters ⇒ AWSCDK::Scheduler::CfnSchedule::EventBridgeParametersProperty? (readonly)

Note:

Default: - No parameters

The templated target type for the EventBridge PutEvents API operation.

Returns:



64
65
66
 
# File 'scheduler/schedule_target_config.rb', line 64

def event_bridge_parameters
  @event_bridge_parameters
end

#input ⇒ AWSCDK::Scheduler::ScheduleTargetInput? (readonly)

Note:

Default: - No input

What input to pass to the target.

Returns:



69
70
71
 
# File 'scheduler/schedule_target_config.rb', line 69

def input
  @input
end

#kinesis_parameters ⇒ AWSCDK::Scheduler::CfnSchedule::KinesisParametersProperty? (readonly)

Note:

Default: - No parameters

The templated target type for the Amazon Kinesis PutRecord API operation.

Returns:



74
75
76
 
# File 'scheduler/schedule_target_config.rb', line 74

def kinesis_parameters
  @kinesis_parameters
end

#retry_policy ⇒ AWSCDK::Scheduler::CfnSchedule::RetryPolicyProperty? (readonly)

Note:

Default: - Maximum retry attempts of 185 and maximum age of 86400 seconds (1 day)

A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

Returns:



79
80
81
 
# File 'scheduler/schedule_target_config.rb', line 79

def retry_policy
  @retry_policy
end

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

Role to use to invoke this event target.

Returns:



47
48
49
 
# File 'scheduler/schedule_target_config.rb', line 47

def role
  @role
end

#sage_maker_pipeline_parameters ⇒ AWSCDK::Scheduler::CfnSchedule::SageMakerPipelineParametersProperty? (readonly)

Note:

Default: - No parameters

The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

Returns:



84
85
86
 
# File 'scheduler/schedule_target_config.rb', line 84

def sage_maker_pipeline_parameters
  @sage_maker_pipeline_parameters
end

#sqs_parameters ⇒ AWSCDK::Scheduler::CfnSchedule::SQSParametersProperty? (readonly)

Note:

Default: - No parameters

The templated target type for the Amazon SQS SendMessage API Operation.

Returns:



89
90
91
 
# File 'scheduler/schedule_target_config.rb', line 89

def sqs_parameters
  @sqs_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'scheduler/schedule_target_config.rb', line 91

def self.jsii_properties
  {
    :arn => "arn",
    :role => "role",
    :dead_letter_config => "deadLetterConfig",
    :ecs_parameters => "ecsParameters",
    :event_bridge_parameters => "eventBridgeParameters",
    :input => "input",
    :kinesis_parameters => "kinesisParameters",
    :retry_policy => "retryPolicy",
    :sage_maker_pipeline_parameters => "sageMakerPipelineParameters",
    :sqs_parameters => "sqsParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'scheduler/schedule_target_config.rb', line 106

def to_jsii
  result = {}
  result.merge!({
    "arn" => @arn,
    "role" => @role,
    "deadLetterConfig" => @dead_letter_config,
    "ecsParameters" => @ecs_parameters,
    "eventBridgeParameters" => @event_bridge_parameters,
    "input" => @input,
    "kinesisParameters" => @kinesis_parameters,
    "retryPolicy" => @retry_policy,
    "sageMakerPipelineParameters" => @sage_maker_pipeline_parameters,
    "sqsParameters" => @sqs_parameters,
  })
  result.compact
end