Class ScheduleTarget


  • public final class ScheduleTarget
    extends java.lang.Object
    • Method Detail

      • arn

        public java.lang.String arn()
        Returns:
        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](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets-universal.html#supported-universal-targets).
      • deadLetterConfig

        public java.util.Optional<ScheduleTargetDeadLetterConfig> deadLetterConfig()
        Returns:
        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.
      • ecsParameters

        public java.util.Optional<ScheduleTargetEcsParameters> ecsParameters()
        Returns:
        Templated target type for the Amazon ECS [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation. Detailed below.
      • eventbridgeParameters

        public java.util.Optional<ScheduleTargetEventbridgeParameters> eventbridgeParameters()
        Returns:
        Templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation. Detailed below.
      • input

        public java.util.Optional<java.lang.String> input()
        Returns:
        Text, or well-formed JSON, passed to the target. Read more in [Universal target](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets-universal.html).
      • kinesisParameters

        public java.util.Optional<ScheduleTargetKinesisParameters> kinesisParameters()
        Returns:
        Templated target type for the Amazon Kinesis [`PutRecord`](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html) API operation. Detailed below.
      • retryPolicy

        public java.util.Optional<ScheduleTargetRetryPolicy> retryPolicy()
        Returns:
        Information about the retry policy settings. Detailed below.
      • roleArn

        public java.lang.String roleArn()
        Returns:
        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](https://docs.aws.amazon.com/scheduler/latest/UserGuide/setting-up.html#setting-up-execution-role). The following arguments are optional:
      • sagemakerPipelineParameters

        public java.util.Optional<ScheduleTargetSagemakerPipelineParameters> sagemakerPipelineParameters()
        Returns:
        Templated target type for the Amazon SageMaker [`StartPipelineExecution`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation. Detailed below.
      • sqsParameters

        public java.util.Optional<ScheduleTargetSqsParameters> sqsParameters()
        Returns:
        The templated target type for the Amazon SQS [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API operation. Detailed below.