ScheduleTarget class
Constructors
-
ScheduleTarget({required Input<
String> arn, Input<ScheduleTargetDeadLetterConfig?> ? deadLetterConfig, Input<ScheduleTargetEcsParameters?> ? ecsParameters, Input<ScheduleTargetEventbridgeParameters?> ? eventbridgeParameters, Input<String?> ? input, Input<ScheduleTargetKinesisParameters?> ? kinesisParameters, Input<ScheduleTargetRetryPolicy?> ? retryPolicy, required Input<String> roleArn, Input<ScheduleTargetSagemakerPipelineParameters?> ? sagemakerPipelineParameters, Input<ScheduleTargetSqsParameters?> ? sqsParameters}) -
Creates a new ScheduleTarget.
arnARN of the target of this schedule, such as a SQS queue or ECS cluster. For universal targets, this is a Service ARN specific to the target service.deadLetterConfigInformation 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. Detailed below.ecsParametersTemplated target type for the Amazon ECSRunTaskAPI operation. Detailed below.eventbridgeParametersTemplated target type for the EventBridgePutEventsAPI operation. Detailed below.inputText, or well-formed JSON, passed to the target. Read more in Universal target.kinesisParametersTemplated target type for the Amazon KinesisPutRecordAPI operation. Detailed below.retryPolicyInformation about the retry policy settings. Detailed below.roleArnARN of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. Read more in Set up the execution role.sagemakerPipelineParametersTemplated target type for the Amazon SageMaker AIStartPipelineExecutionAPI operation. Detailed below.sqsParametersThe templated target type for the Amazon SQSSendMessageAPI operation. Detailed below.const -
ScheduleTarget.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String> -
ARN of the target of this schedule, such as a SQS queue or ECS cluster. For universal targets, this is a Service ARN specific to the target service.
final
-
deadLetterConfig
→ Input<
ScheduleTargetDeadLetterConfig?> ? -
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. Detailed below.
final
-
ecsParameters
→ Input<
ScheduleTargetEcsParameters?> ? -
Templated target type for the Amazon ECS
RunTaskAPI operation. Detailed below.final -
eventbridgeParameters
→ Input<
ScheduleTargetEventbridgeParameters?> ? -
Templated target type for the EventBridge
PutEventsAPI operation. Detailed below.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
input
→ Input<
String?> ? -
Text, or well-formed JSON, passed to the target. Read more in Universal target.
final
-
kinesisParameters
→ Input<
ScheduleTargetKinesisParameters?> ? -
Templated target type for the Amazon Kinesis
PutRecordAPI operation. Detailed below.final -
retryPolicy
→ Input<
ScheduleTargetRetryPolicy?> ? -
Information about the retry policy settings. Detailed below.
final
-
roleArn
→ Input<
String> -
ARN of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. Read more in Set up the execution role.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sagemakerPipelineParameters
→ Input<
ScheduleTargetSagemakerPipelineParameters?> ? -
Templated target type for the Amazon SageMaker AI
StartPipelineExecutionAPI operation. Detailed below.final -
sqsParameters
→ Input<
ScheduleTargetSqsParameters?> ? -
The templated target type for the Amazon SQS
SendMessageAPI operation. Detailed below.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited