Class Schedule
- All Implemented Interfaces:
IResource
,ISchedule
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
Example:
import software.amazon.awscdk.services.kinesisfirehose.*; CfnDeliveryStream deliveryStream; Map<String, String> payload = Map.of( "Data", "record"); Schedule.Builder.create(this, "Schedule") .schedule(ScheduleExpression.rate(Duration.minutes(60))) .target(KinesisDataFirehosePutRecord.Builder.create(deliveryStream) .input(ScheduleTargetInput.fromObject(payload)) .build()) .build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
(experimental) A fluent builder forSchedule
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.scheduler.alpha.ISchedule
ISchedule.Jsii$Default, ISchedule.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Schedule
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
Schedule
(software.amazon.jsii.JsiiObjectRef objRef) Schedule
(software.constructs.Construct scope, String id, ScheduleProps props) -
Method Summary
Modifier and TypeMethodDescriptiongetGroup()
(experimental) The schedule group associated with this schedule.getKey()
(experimental) The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.(experimental) The arn of the schedule.(experimental) The name of the schedule.static Metric
(experimental) Return the given named metric for all schedules.static Metric
metricAll
(String metricName, MetricOptions props) (experimental) Return the given named metric for all schedules.static Metric
(experimental) Metric for all invocation attempts across all schedules.static Metric
metricAllAttempts
(MetricOptions props) (experimental) Metric for all invocation attempts across all schedules.static Metric
(experimental) Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.static Metric
metricAllDropped
(MetricOptions props) (experimental) Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.static Metric
(experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API across all schedules.static Metric
metricAllErrors
(MetricOptions props) (experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API across all schedules.static Metric
(experimental) Metric for failed invocations that also failed to deliver to DLQ across all schedules.static Metric
metricAllFailedToBeSentToDLQ
(String errorCode) (experimental) Metric for failed invocations that also failed to deliver to DLQ across all schedules.static Metric
metricAllFailedToBeSentToDLQ
(String errorCode, MetricOptions props) (experimental) Metric for failed invocations that also failed to deliver to DLQ across all schedules.static Metric
(experimental) Metric for invocations delivered to the DLQ across all schedules.static Metric
metricAllSentToDLQ
(MetricOptions props) (experimental) Metric for invocations delivered to the DLQ across all schedules.static Metric
(experimental) Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.static Metric
(experimental) Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.static Metric
(experimental) Metric for invocation failures due to API throttling by the target across all schedules.static Metric
(experimental) Metric for invocation failures due to API throttling by the target across all schedules.static Metric
(experimental) Metric for the number of invocations that were throttled across all schedules.static Metric
metricAllThrottled
(MetricOptions props) (experimental) Metric for the number of invocations that were throttled across all schedules.Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Schedule
protected Schedule(software.amazon.jsii.JsiiObjectRef objRef) -
Schedule
protected Schedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
Schedule
@Stability(Experimental) public Schedule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ScheduleProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
metricAll
@Stability(Experimental) @NotNull public static Metric metricAll(@NotNull String metricName, @Nullable MetricOptions props) (experimental) Return the given named metric for all schedules.Default: - sum over 5 minutes
- Parameters:
metricName
- This parameter is required.props
-
-
metricAll
(experimental) Return the given named metric for all schedules.Default: - sum over 5 minutes
- Parameters:
metricName
- This parameter is required.
-
metricAllAttempts
@Stability(Experimental) @NotNull public static Metric metricAllAttempts(@Nullable MetricOptions props) (experimental) Metric for all invocation attempts across all schedules.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricAllAttempts
(experimental) Metric for all invocation attempts across all schedules.Default: - sum over 5 minutes
-
metricAllDropped
@Stability(Experimental) @NotNull public static Metric metricAllDropped(@Nullable MetricOptions props) (experimental) Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.Metric is calculated for all schedules.
Default: - sum over 5 minutes
- Parameters:
props
-
-
metricAllDropped
(experimental) Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.Metric is calculated for all schedules.
Default: - sum over 5 minutes
-
metricAllErrors
@Stability(Experimental) @NotNull public static Metric metricAllErrors(@Nullable MetricOptions props) (experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API across all schedules.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricAllErrors
(experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API across all schedules.Default: - sum over 5 minutes
-
metricAllFailedToBeSentToDLQ
@Stability(Experimental) @NotNull public static Metric metricAllFailedToBeSentToDLQ(@Nullable String errorCode, @Nullable MetricOptions props) (experimental) Metric for failed invocations that also failed to deliver to DLQ across all schedules.Default: - sum over 5 minutes
- Parameters:
errorCode
-props
-
-
metricAllFailedToBeSentToDLQ
@Stability(Experimental) @NotNull public static Metric metricAllFailedToBeSentToDLQ(@Nullable String errorCode) (experimental) Metric for failed invocations that also failed to deliver to DLQ across all schedules.Default: - sum over 5 minutes
- Parameters:
errorCode
-
-
metricAllFailedToBeSentToDLQ
(experimental) Metric for failed invocations that also failed to deliver to DLQ across all schedules.Default: - sum over 5 minutes
-
metricAllSentToDLQ
@Stability(Experimental) @NotNull public static Metric metricAllSentToDLQ(@Nullable MetricOptions props) (experimental) Metric for invocations delivered to the DLQ across all schedules.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricAllSentToDLQ
(experimental) Metric for invocations delivered to the DLQ across all schedules.Default: - sum over 5 minutes
-
metricAllSentToDLQTruncated
@Stability(Experimental) @NotNull public static Metric metricAllSentToDLQTruncated(@Nullable MetricOptions props) (experimental) Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.Metric is calculated for all schedules.
Default: - sum over 5 minutes
- Parameters:
props
-
-
metricAllSentToDLQTruncated
(experimental) Metric for delivery of failed invocations to DLQ when the payload of the event sent to the DLQ exceeds the maximum size allowed by Amazon SQS.Metric is calculated for all schedules.
Default: - sum over 5 minutes
-
metricAllTargetThrottled
@Stability(Experimental) @NotNull public static Metric metricAllTargetThrottled(@Nullable MetricOptions props) (experimental) Metric for invocation failures due to API throttling by the target across all schedules.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricAllTargetThrottled
(experimental) Metric for invocation failures due to API throttling by the target across all schedules.Default: - sum over 5 minutes
-
metricAllThrottled
@Stability(Experimental) @NotNull public static Metric metricAllThrottled(@Nullable MetricOptions props) (experimental) Metric for the number of invocations that were throttled across all schedules.Default: - sum over 5 minutes
- Parameters:
props
-- See Also:
-
metricAllThrottled
(experimental) Metric for the number of invocations that were throttled across all schedules.Default: - sum over 5 minutes
- See Also:
-
getScheduleArn
(experimental) The arn of the schedule.- Specified by:
getScheduleArn
in interfaceISchedule
-
getScheduleName
(experimental) The name of the schedule.- Specified by:
getScheduleName
in interfaceISchedule
-
getGroup
(experimental) The schedule group associated with this schedule. -
getKey
(experimental) The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
-