Class: Aws::Scheduler::Types::Target
- Inherits:
-
Struct
- Object
- Struct
- Aws::Scheduler::Types::Target
- Defined in:
- gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb
Overview
The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#arn ⇒ String
The Amazon Resource Name (ARN) of the target.
-
#dead_letter_config ⇒ Types::DeadLetterConfig
An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
-
#ecs_parameters ⇒ Types::EcsParameters
The templated target type for the Amazon ECS [
RunTask][1] API operation. -
#event_bridge_parameters ⇒ Types::EventBridgeParameters
The templated target type for the EventBridge [
PutEvents][1] API operation. -
#event_bridge_put_events_v2_parameters ⇒ Types::EventBridgePutEventsV2Parameters
The templated target type for the EventBridge event bus v2 [
PutEvents][1] API operation. -
#event_bridge_put_raw_events_parameters ⇒ Types::EventBridgePutRawEventsParameters
The templated target type for the EventBridge event bus v2 [
PutRawEvents][1] API operation. -
#input ⇒ String
The text, or well-formed JSON, passed to the target.
-
#kinesis_parameters ⇒ Types::KinesisParameters
The templated target type for the Amazon Kinesis [
PutRecord][1] API operation. -
#retry_policy ⇒ Types::RetryPolicy
A
RetryPolicyobject 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. -
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
-
#sage_maker_pipeline_parameters ⇒ Types::SageMakerPipelineParameters
The templated target type for the Amazon SageMaker [
StartPipelineExecution][1] API operation. -
#sqs_parameters ⇒ Types::SqsParameters
The templated target type for the Amazon SQS [
SendMessage][1] API operation.
Instance Attribute Details
#arn ⇒ String
The Amazon Resource Name (ARN) of the target.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |
#dead_letter_config ⇒ Types::DeadLetterConfig
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.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |
#ecs_parameters ⇒ Types::EcsParameters
The templated target type for the Amazon ECS RunTask API
operation.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |
#event_bridge_parameters ⇒ Types::EventBridgeParameters
The templated target type for the EventBridge PutEvents API
operation.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |
#event_bridge_put_events_v2_parameters ⇒ Types::EventBridgePutEventsV2Parameters
The templated target type for the EventBridge event bus v2
PutEvents API operation.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |
#event_bridge_put_raw_events_parameters ⇒ Types::EventBridgePutRawEventsParameters
The templated target type for the EventBridge event bus v2
PutRawEvents API operation.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |
#input ⇒ String
The text, or well-formed JSON, passed to the target. If you are
configuring a templated Lambda, Amazon Web Services Step Functions,
or Amazon EventBridge target, the input must be a well-formed JSON.
For all other target types, a JSON is not required. If you do not
specify anything for this field, EventBridge Scheduler delivers a
default notification to the target. The maximum size of the Input
field is 256 KB.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |
#kinesis_parameters ⇒ Types::KinesisParameters
The templated target type for the Amazon Kinesis PutRecord
API operation.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |
#retry_policy ⇒ Types::RetryPolicy
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.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |
#sage_maker_pipeline_parameters ⇒ Types::SageMakerPipelineParameters
The templated target type for the Amazon SageMaker
StartPipelineExecution API operation.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |
#sqs_parameters ⇒ Types::SqsParameters
The templated target type for the Amazon SQS SendMessage
API operation. Contains the message group ID to use when the target
is a FIFO queue. If you specify an Amazon SQS FIFO queue as a
target, the queue must have content-based deduplication enabled. For
more information, see Using the Amazon SQS message deduplication
ID in the Amazon SQS Developer Guide.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 1319 class Target < Struct.new( :arn, :role_arn, :dead_letter_config, :retry_policy, :input, :ecs_parameters, :event_bridge_parameters, :event_bridge_put_events_v2_parameters, :event_bridge_put_raw_events_parameters, :kinesis_parameters, :sage_maker_pipeline_parameters, :sqs_parameters) SENSITIVE = [] include Aws::Structure end |