Interface ScheduleTargetBaseProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
KinesisStreamPutRecordProps
,SageMakerStartPipelineExecutionProps
,SqsSendMessageProps
- All Known Implementing Classes:
KinesisStreamPutRecordProps.Jsii$Proxy
,SageMakerStartPipelineExecutionProps.Jsii$Proxy
,ScheduleTargetBaseProps.Jsii$Proxy
,SqsSendMessageProps.Jsii$Proxy
Example:
import software.amazon.awscdk.services.events.*; EventBus eventBus = EventBus.Builder.create(this, "EventBus") .eventBusName("DomainEvents") .build(); EventBridgePutEventsEntry eventEntry = EventBridgePutEventsEntry.builder() .eventBus(eventBus) .source("PetService") .detail(ScheduleTargetInput.fromObject(Map.of("Name", "Fluffy"))) .detailType("🐶") .build(); Schedule.Builder.create(this, "Schedule") .schedule(ScheduleExpression.rate(Duration.hours(1))) .target(EventBridgePutEvents.Builder.create(eventEntry).build()) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forScheduleTargetBaseProps
static final class
An implementation forScheduleTargetBaseProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default IQueue
(experimental) The SQS queue to be used as deadLetterQueue.default ScheduleTargetInput
getInput()
(experimental) Input passed to the target.default Duration
(experimental) The maximum age of a request that Scheduler sends to a target for processing.default Number
(experimental) The maximum number of times to retry when the target returns an error.default IRole
getRole()
(experimental) An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDeadLetterQueue
(experimental) The SQS queue to be used as deadLetterQueue.The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.
Default: - no dead-letter queue
-
getInput
(experimental) Input passed to the target.Default: - no input.
-
getMaxEventAge
(experimental) The maximum age of a request that Scheduler sends to a target for processing.Minimum value of 60. Maximum value of 86400.
Default: Duration.hours(24)
-
getRetryAttempts
(experimental) The maximum number of times to retry when the target returns an error.Minimum value of 0. Maximum value of 185.
Default: 185
-
getRole
(experimental) An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.If none provided templates target will automatically create an IAM role with all the minimum necessary permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets will grant minimal required permissions.
Universal target automatically create an IAM role if you do not specify your own IAM role. However, in comparison with templated targets, for universal targets you must grant the required IAM permissions yourself.
Default: - created by target
-
builder
- Returns:
- a
ScheduleTargetBaseProps.Builder
ofScheduleTargetBaseProps
-