Interface CfnSchedulePropsMixin.TargetProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnSchedulePropsMixin.TargetProperty.Jsii$Proxy
- Enclosing class:
CfnSchedulePropsMixin
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.cfnpropertymixins.services.scheduler.*;
Object tags;
TargetProperty targetProperty = TargetProperty.builder()
.arn("arn")
.deadLetterConfig(DeadLetterConfigProperty.builder()
.arn("arn")
.build())
.ecsParameters(EcsParametersProperty.builder()
.capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
.base(123)
.capacityProvider("capacityProvider")
.weight(123)
.build()))
.enableEcsManagedTags(false)
.enableExecuteCommand(false)
.group("group")
.launchType("launchType")
.networkConfiguration(NetworkConfigurationProperty.builder()
.awsvpcConfiguration(AwsVpcConfigurationProperty.builder()
.assignPublicIp("assignPublicIp")
.securityGroups(List.of("securityGroups"))
.subnets(List.of("subnets"))
.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(tags)
.taskCount(123)
.taskDefinitionArn("taskDefinitionArn")
.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())
.roleArn("roleArn")
.sageMakerPipelineParameters(SageMakerPipelineParametersProperty.builder()
.pipelineParameterList(List.of(SageMakerPipelineParameterProperty.builder()
.name("name")
.value("value")
.build()))
.build())
.sqsParameters(SqsParametersProperty.builder()
.messageGroupId("messageGroupId")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnSchedulePropsMixin.TargetPropertystatic final classAn implementation forCfnSchedulePropsMixin.TargetProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectgetArn()The Amazon Resource Name (ARN) of the target.default ObjectAn object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.default ObjectThe templated target type for the Amazon ECSRunTaskAPI operation.default ObjectThe templated target type for the EventBridgePutEventsAPI operation.default StringgetInput()The text, or well-formed JSON, passed to the target.default ObjectThe templated target type for the Amazon KinesisPutRecordAPI operation.default ObjectARetryPolicyobject 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.default ObjectThe Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.default ObjectThe templated target type for the Amazon SageMakerStartPipelineExecutionAPI operation.default ObjectThe templated target type for the Amazon SQSSendMessageAPI operation.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getArn
The Amazon Resource Name (ARN) of the target.Returns union: either
StringorIFunctionReforIQueueReforIStateMachineRef- See Also:
-
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.
Returns union: either
IResolvableorCfnSchedulePropsMixin.DeadLetterConfigProperty- See Also:
-
getEcsParameters
The templated target type for the Amazon ECSRunTaskAPI operation.Returns union: either
IResolvableorCfnSchedulePropsMixin.EcsParametersProperty- See Also:
-
getEventBridgeParameters
The templated target type for the EventBridgePutEventsAPI operation.Returns union: either
IResolvableorCfnSchedulePropsMixin.EventBridgeParametersProperty- See Also:
-
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.
- See Also:
-
getKinesisParameters
The templated target type for the Amazon KinesisPutRecordAPI operation.Returns union: either
IResolvableorCfnSchedulePropsMixin.KinesisParametersProperty- See Also:
-
getRetryPolicy
ARetryPolicyobject 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 union: either
IResolvableorCfnSchedulePropsMixin.RetryPolicyProperty- See Also:
-
getRoleArn
The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.- See Also:
-
getSageMakerPipelineParameters
The templated target type for the Amazon SageMakerStartPipelineExecutionAPI operation.Returns union: either
IResolvableorCfnSchedulePropsMixin.SageMakerPipelineParametersProperty- See Also:
-
getSqsParameters
The templated target type for the Amazon SQSSendMessageAPI 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 .Returns union: either
IResolvableorCfnSchedulePropsMixin.SqsParametersProperty- See Also:
-
builder
-