Class: Aws::Scheduler::Types::Target

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the target.

Returns:

  • (String) 


1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/aws-sdk-scheduler/types.rb', line 1246

class Target < Struct.new(
  :arn,
  :dead_letter_config,
  :ecs_parameters,
  :event_bridge_parameters,
  :input,
  :kinesis_parameters,
  :retry_policy,
  :role_arn,
  :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.

Returns:



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/aws-sdk-scheduler/types.rb', line 1246

class Target < Struct.new(
  :arn,
  :dead_letter_config,
  :ecs_parameters,
  :event_bridge_parameters,
  :input,
  :kinesis_parameters,
  :retry_policy,
  :role_arn,
  :sage_maker_pipeline_parameters,
  :sqs_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#ecs_parameters ⇒ Types::EcsParameters

The templated target type for the Amazon ECS [ ‘RunTask` ][1] API operation.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html

Returns:



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/aws-sdk-scheduler/types.rb', line 1246

class Target < Struct.new(
  :arn,
  :dead_letter_config,
  :ecs_parameters,
  :event_bridge_parameters,
  :input,
  :kinesis_parameters,
  :retry_policy,
  :role_arn,
  :sage_maker_pipeline_parameters,
  :sqs_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#event_bridge_parameters ⇒ Types::EventBridgeParameters

The templated target type for the EventBridge [ ‘PutEvents` ][1] API operation.

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html

Returns:



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/aws-sdk-scheduler/types.rb', line 1246

class Target < Struct.new(
  :arn,
  :dead_letter_config,
  :ecs_parameters,
  :event_bridge_parameters,
  :input,
  :kinesis_parameters,
  :retry_policy,
  :role_arn,
  :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, AWS 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.

Returns:

  • (String) 


1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/aws-sdk-scheduler/types.rb', line 1246

class Target < Struct.new(
  :arn,
  :dead_letter_config,
  :ecs_parameters,
  :event_bridge_parameters,
  :input,
  :kinesis_parameters,
  :retry_policy,
  :role_arn,
  :sage_maker_pipeline_parameters,
  :sqs_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#kinesis_parameters ⇒ Types::KinesisParameters

The templated target type for the Amazon Kinesis [ ‘PutRecord` ](kinesis/latest/APIReference/API_PutRecord.html) API operation.

Returns:



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/aws-sdk-scheduler/types.rb', line 1246

class Target < Struct.new(
  :arn,
  :dead_letter_config,
  :ecs_parameters,
  :event_bridge_parameters,
  :input,
  :kinesis_parameters,
  :retry_policy,
  :role_arn,
  :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.

Returns:



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/aws-sdk-scheduler/types.rb', line 1246

class Target < Struct.new(
  :arn,
  :dead_letter_config,
  :ecs_parameters,
  :event_bridge_parameters,
  :input,
  :kinesis_parameters,
  :retry_policy,
  :role_arn,
  :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.

Returns:

  • (String) 


1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/aws-sdk-scheduler/types.rb', line 1246

class Target < Struct.new(
  :arn,
  :dead_letter_config,
  :ecs_parameters,
  :event_bridge_parameters,
  :input,
  :kinesis_parameters,
  :retry_policy,
  :role_arn,
  :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` ][1] API operation.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html

Returns:



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/aws-sdk-scheduler/types.rb', line 1246

class Target < Struct.new(
  :arn,
  :dead_letter_config,
  :ecs_parameters,
  :event_bridge_parameters,
  :input,
  :kinesis_parameters,
  :retry_policy,
  :role_arn,
  :sage_maker_pipeline_parameters,
  :sqs_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#sqs_parameters ⇒ Types::SqsParameters

The templated target type for the Amazon SQS [ ‘SendMessage` ][1] 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*.

[1]: docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html [2]: docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html

Returns:



1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
 
# File 'lib/aws-sdk-scheduler/types.rb', line 1246

class Target < Struct.new(
  :arn,
  :dead_letter_config,
  :ecs_parameters,
  :event_bridge_parameters,
  :input,
  :kinesis_parameters,
  :retry_policy,
  :role_arn,
  :sage_maker_pipeline_parameters,
  :sqs_parameters)
  SENSITIVE = []
  include Aws::Structure
end