/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include 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:
AWS
* API Reference
The Amazon Resource Name (ARN) of the target.
*/ inline const Aws::String& GetArn() const{ return m_arn; } /** *The Amazon Resource Name (ARN) of the target.
*/ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** *The Amazon Resource Name (ARN) of the target.
*/ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** *The Amazon Resource Name (ARN) of the target.
*/ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** *The Amazon Resource Name (ARN) of the target.
*/ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** *The Amazon Resource Name (ARN) of the target.
*/ inline Target& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** *The Amazon Resource Name (ARN) of the target.
*/ inline Target& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) of the target.
*/ inline Target& WithArn(const char* value) { SetArn(value); return *this;} /** *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.
*/ inline const DeadLetterConfig& GetDeadLetterConfig() const{ return m_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.
*/ inline bool DeadLetterConfigHasBeenSet() const { return m_deadLetterConfigHasBeenSet; } /** *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.
*/ inline void SetDeadLetterConfig(const DeadLetterConfig& value) { m_deadLetterConfigHasBeenSet = true; m_deadLetterConfig = value; } /** *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.
*/ inline void SetDeadLetterConfig(DeadLetterConfig&& value) { m_deadLetterConfigHasBeenSet = true; m_deadLetterConfig = std::move(value); } /** *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.
*/ inline Target& WithDeadLetterConfig(const DeadLetterConfig& value) { SetDeadLetterConfig(value); return *this;} /** *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.
*/ inline Target& WithDeadLetterConfig(DeadLetterConfig&& value) { SetDeadLetterConfig(std::move(value)); return *this;} /** *The templated target type for the Amazon ECS
* RunTask
API operation.
The templated target type for the Amazon ECS
* RunTask
API operation.
The templated target type for the Amazon ECS
* RunTask
API operation.
The templated target type for the Amazon ECS
* RunTask
API operation.
The templated target type for the Amazon ECS
* RunTask
API operation.
The templated target type for the Amazon ECS
* RunTask
API operation.
The templated target type for the EventBridge
* PutEvents
API operation.
The templated target type for the EventBridge
* PutEvents
API operation.
The templated target type for the EventBridge
* PutEvents
API operation.
The templated target type for the EventBridge
* PutEvents
API operation.
The templated target type for the EventBridge
* PutEvents
API operation.
The templated target type for the EventBridge
* PutEvents
API operation.
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.
*/ inline const Aws::String& GetInput() const{ return m_input; } /** *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.
*/ inline bool InputHasBeenSet() const { return m_inputHasBeenSet; } /** *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.
*/ inline void SetInput(const Aws::String& value) { m_inputHasBeenSet = true; m_input = value; } /** *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.
*/ inline void SetInput(Aws::String&& value) { m_inputHasBeenSet = true; m_input = std::move(value); } /** *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.
*/ inline void SetInput(const char* value) { m_inputHasBeenSet = true; m_input.assign(value); } /** *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.
*/ inline Target& WithInput(const Aws::String& value) { SetInput(value); return *this;} /** *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.
*/ inline Target& WithInput(Aws::String&& value) { SetInput(std::move(value)); return *this;} /** *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.
*/ inline Target& WithInput(const char* value) { SetInput(value); return *this;} /** *The templated target type for the Amazon Kinesis PutRecord
* API operation.
The templated target type for the Amazon Kinesis PutRecord
* API operation.
The templated target type for the Amazon Kinesis PutRecord
* API operation.
The templated target type for the Amazon Kinesis PutRecord
* API operation.
The templated target type for the Amazon Kinesis PutRecord
* API operation.
The templated target type for the Amazon Kinesis PutRecord
* API operation.
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.
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.
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.
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.
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.
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.
The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler * will use for this target when the schedule is invoked.
*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler * will use for this target when the schedule is invoked.
*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler * will use for this target when the schedule is invoked.
*/ inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; } /** *The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler * will use for this target when the schedule is invoked.
*/ inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler * will use for this target when the schedule is invoked.
*/ inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler * will use for this target when the schedule is invoked.
*/ inline Target& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler * will use for this target when the schedule is invoked.
*/ inline Target& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler * will use for this target when the schedule is invoked.
*/ inline Target& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *The templated target type for the Amazon SageMaker
* StartPipelineExecution
API operation.
The templated target type for the Amazon SageMaker
* StartPipelineExecution
API operation.
The templated target type for the Amazon SageMaker
* StartPipelineExecution
API operation.
The templated target type for the Amazon SageMaker
* StartPipelineExecution
API operation.
The templated target type for the Amazon SageMaker
* StartPipelineExecution
API operation.
The templated target type for the Amazon SageMaker
* StartPipelineExecution
API operation.
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.
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.
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.
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.
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.
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.