software.amazon.awscdk.services.scheduler

Interface CfnSchedule.TargetProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSchedule.TargetProperty.Jsii$Proxy

Enclosing class:

CfnSchedule

@Stability(value=Stable)
public static interface CfnSchedule.TargetProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.scheduler.*;
 Object tags;
 TargetProperty targetProperty = TargetProperty.builder()
         .arn("arn")
         .roleArn("roleArn")
         // the properties below are optional
         .deadLetterConfig(DeadLetterConfigProperty.builder()
                 .arn("arn")
                 .build())
         .ecsParameters(EcsParametersProperty.builder()
                 .taskDefinitionArn("taskDefinitionArn")
                 // the properties below are optional
                 .capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                         .capacityProvider("capacityProvider")
                         // the properties below are optional
                         .base(123)
                         .weight(123)
                         .build()))
                 .enableEcsManagedTags(false)
                 .enableExecuteCommand(false)
                 .group("group")
                 .launchType("launchType")
                 .networkConfiguration(NetworkConfigurationProperty.builder()
                         .awsvpcConfiguration(AwsVpcConfigurationProperty.builder()
                                 .subnets(List.of("subnets"))
                                 // the properties below are optional
                                 .assignPublicIp("assignPublicIp")
                                 .securityGroups(List.of("securityGroups"))
                                 .build())
                         .build())
                 .placementConstraints(List.of(PlacementConstraintProperty.builder()
                         .expression("expression")
                         .type("type")
                         .build()))
                 .placementStrategy(List.of(PlacementStrategyProperty.builder()
                         .field("field")
                         .type("type")
                         .build()))
                 .platformVersion("platformVersion")
                 .propagateTags("propagateTags")
                 .referenceId("referenceId")
                 .tags(List.of(tags))
                 .taskCount(123)
                 .build())
         .eventBridgeParameters(EventBridgeParametersProperty.builder()
                 .detailType("detailType")
                 .source("source")
                 .build())
         .input("input")
         .kinesisParameters(KinesisParametersProperty.builder()
                 .partitionKey("partitionKey")
                 .build())
         .retryPolicy(RetryPolicyProperty.builder()
                 .maximumEventAgeInSeconds(123)
                 .maximumRetryAttempts(123)
                 .build())
         .sageMakerPipelineParameters(SageMakerPipelineParametersProperty.builder()
                 .pipelineParameterList(List.of(SageMakerPipelineParameterProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .build())
         .sqsParameters(SqsParametersProperty.builder()
                 .messageGroupId("messageGroupId")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSchedule.TargetProperty.Builder A builder for CfnSchedule.TargetProperty
static class	CfnSchedule.TargetProperty.Jsii$Proxy An implementation for CfnSchedule.TargetProperty

Method Summary

Modifier and Type	Method and Description
static CfnSchedule.TargetProperty.Builder	builder()
String	getArn() The Amazon Resource Name (ARN) of the target.
default Object	getDeadLetterConfig() An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
default Object	getEcsParameters() The templated target type for the Amazon ECS [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.
default Object	getEventBridgeParameters() The templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation.
default String	getInput() The text, or well-formed JSON, passed to the target.
default Object	getKinesisParameters() The templated target type for the Amazon Kinesis [`PutRecord`](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html) API operation.
default Object	getRetryPolicy() 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.
String	getRoleArn() The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
default Object	getSageMakerPipelineParameters() The templated target type for the Amazon SageMaker [`StartPipelineExecution`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.
default Object	getSqsParameters() The templated target type for the Amazon SQS [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API operation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArn

@Stability(value=Stable)
 @NotNull
String getArn()

The Amazon Resource Name (ARN) of the target.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

getDeadLetterConfig

@Stability(value=Stable)
 @Nullable
default Object getDeadLetterConfig()

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.

getEcsParameters

@Stability(value=Stable)
 @Nullable
default Object getEcsParameters()

The templated target type for the Amazon ECS [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.

getEventBridgeParameters

@Stability(value=Stable)
 @Nullable
default Object getEventBridgeParameters()

The templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation.

getInput

@Stability(value=Stable)
 @Nullable
default String getInput()

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, Amazon EventBridge Scheduler delivers a default notification to the target.

getKinesisParameters

@Stability(value=Stable)
 @Nullable
default Object getKinesisParameters()

The templated target type for the Amazon Kinesis [`PutRecord`](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html) API operation.

getRetryPolicy

@Stability(value=Stable)
 @Nullable
default Object getRetryPolicy()

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.

getSageMakerPipelineParameters

@Stability(value=Stable)
 @Nullable
default Object getSageMakerPipelineParameters()

The templated target type for the Amazon SageMaker [`StartPipelineExecution`](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.

getSqsParameters

@Stability(value=Stable)
 @Nullable
default Object getSqsParameters()

The templated target type for the Amazon SQS [`SendMessage`](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the *Amazon SQS Developer Guide* .

builder

@Stability(value=Stable)
static CfnSchedule.TargetProperty.Builder builder()

Returns:

a CfnSchedule.TargetProperty.Builder of CfnSchedule.TargetProperty