Package software.amazon.awscdk.services.scheduler

Class ScheduleGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.scheduler.ScheduleGroup
All Implemented Interfaces:
IEnvironmentAware, IScheduleGroupRef, IResource, IScheduleGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:45.317Z") @Stability(Stable) public class ScheduleGroup extends Resource implements IScheduleGroup
A Schedule Group.

Example: 

 LambdaInvoke target;
 ScheduleGroup scheduleGroup = ScheduleGroup.Builder.create(this, "ScheduleGroup")
         .scheduleGroupName("MyScheduleGroup")
         .build();
 Schedule.Builder.create(this, "Schedule")
         .schedule(ScheduleExpression.rate(Duration.minutes(10)))
         .target(target)
         .scheduleGroup(scheduleGroup)
         .build();

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Stable) public static final String PROPERTY_INJECTION_ID
      Uniquely identifies this class.

  • Constructor Details

    • ScheduleGroup

      protected ScheduleGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • ScheduleGroup

      protected ScheduleGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • ScheduleGroup

      @Stability(Stable) public ScheduleGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ScheduleGroupProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -

    • ScheduleGroup

      @Stability(Stable) public ScheduleGroup(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.

  • Method Details

    • fromDefaultScheduleGroup

      @Stability(Stable) @NotNull public static IScheduleGroup fromDefaultScheduleGroup(@NotNull software.constructs.Construct scope, @NotNull String id)
      Import a default schedule group.

      Parameters:
      scope - construct scope. This parameter is required.
      id - construct id. This parameter is required.

    • fromScheduleGroupArn

      @Stability(Stable) @NotNull public static IScheduleGroup fromScheduleGroupArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String scheduleGroupArn)
      Import an external schedule group by ARN.

      Parameters:
      scope - construct scope. This parameter is required.
      id - construct id. This parameter is required.
      scheduleGroupArn - the ARN of the schedule group to import (e.g. arn:aws:scheduler:region:account-id:schedule-group/group-name). This parameter is required.

    • fromScheduleGroupName

      @Stability(Stable) @NotNull public static IScheduleGroup fromScheduleGroupName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String scheduleGroupName)
      Import an existing schedule group with a given name.

      Parameters:
      scope - construct scope. This parameter is required.
      id - construct id. This parameter is required.
      scheduleGroupName - the name of the existing schedule group to import. This parameter is required.

    • grant

      @Stability(Stable) @NotNull public Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      Grant the indicated permissions on this schedule group to the given principal.

      Specified by:
      grant in interface IScheduleGroup
      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantDeleteSchedules

      @Stability(Stable) @NotNull public Grant grantDeleteSchedules(@NotNull IGrantable identity)
      Grant delete schedule permission for schedules in this group to the given principal.

      Specified by:
      grantDeleteSchedules in interface IScheduleGroup
      Parameters:
      identity - This parameter is required.

    • grantReadSchedules

      @Stability(Stable) @NotNull public Grant grantReadSchedules(@NotNull IGrantable identity)
      Grant list and get schedule permissions for schedules in this group to the given principal.

      Specified by:
      grantReadSchedules in interface IScheduleGroup
      Parameters:
      identity - This parameter is required.

    • grantWriteSchedules

      @Stability(Stable) @NotNull public Grant grantWriteSchedules(@NotNull IGrantable identity)
      Grant create and update schedule permissions for schedules in this group to the given principal.

      Specified by:
      grantWriteSchedules in interface IScheduleGroup
      Parameters:
      identity - This parameter is required.

    • metric

      @Stability(Stable) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this schedule group.

      Default: - sum over 5 minutes

      Specified by:
      metric in interface IScheduleGroup
      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Stable) @NotNull public Metric metric(@NotNull String metricName)
      Return the given named metric for this schedule group.

      Default: - sum over 5 minutes

      Specified by:
      metric in interface IScheduleGroup
      Parameters:
      metricName - This parameter is required.

    • metricAttempts

      @Stability(Stable) @NotNull public Metric metricAttempts(@Nullable MetricOptions props)
      Metric for all invocation attempts.

      Default: - sum over 5 minutes

      Specified by:
      metricAttempts in interface IScheduleGroup
      Parameters:
      props -

    • metricAttempts

      @Stability(Stable) @NotNull public Metric metricAttempts()
      Metric for all invocation attempts.

      Default: - sum over 5 minutes

      Specified by:
      metricAttempts in interface IScheduleGroup

    • metricDropped

      @Stability(Stable) @NotNull public Metric metricDropped(@Nullable MetricOptions props)
      Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.

      Default: - sum over 5 minutes

      Specified by:
      metricDropped in interface IScheduleGroup
      Parameters:
      props -

    • metricDropped

      @Stability(Stable) @NotNull public Metric metricDropped()
      Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.

      Default: - sum over 5 minutes

      Specified by:
      metricDropped in interface IScheduleGroup

    • metricFailedToBeSentToDLQ

      @Stability(Stable) @NotNull public Metric metricFailedToBeSentToDLQ(@Nullable String errorCode, @Nullable MetricOptions props)
      Metric for failed invocations that also failed to deliver to DLQ.

      Default: - sum over 5 minutes

      Specified by:
      metricFailedToBeSentToDLQ in interface IScheduleGroup
      Parameters:
      errorCode -
      props -

    • metricFailedToBeSentToDLQ

      @Stability(Stable) @NotNull public Metric metricFailedToBeSentToDLQ(@Nullable String errorCode)
      Metric for failed invocations that also failed to deliver to DLQ.

      Default: - sum over 5 minutes

      Specified by:
      metricFailedToBeSentToDLQ in interface IScheduleGroup
      Parameters:
      errorCode -

    • metricFailedToBeSentToDLQ

      @Stability(Stable) @NotNull public Metric metricFailedToBeSentToDLQ()
      Metric for failed invocations that also failed to deliver to DLQ.

      Default: - sum over 5 minutes

      Specified by:
      metricFailedToBeSentToDLQ in interface IScheduleGroup

    • metricSentToDLQ

      @Stability(Stable) @NotNull public Metric metricSentToDLQ(@Nullable MetricOptions props)
      Metric for invocations delivered to the DLQ.

      Default: - sum over 5 minutes

      Specified by:
      metricSentToDLQ in interface IScheduleGroup
      Parameters:
      props -

    • metricSentToDLQ

      @Stability(Stable) @NotNull public Metric metricSentToDLQ()
      Metric for invocations delivered to the DLQ.

      Default: - sum over 5 minutes

      Specified by:
      metricSentToDLQ in interface IScheduleGroup

    • metricSentToDLQTruncated

      @Stability(Stable) @NotNull public Metric metricSentToDLQTruncated(@Nullable MetricOptions props)
      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.

      Default: - sum over 5 minutes

      Specified by:
      metricSentToDLQTruncated in interface IScheduleGroup
      Parameters:
      props -

    • metricSentToDLQTruncated

      @Stability(Stable) @NotNull public Metric metricSentToDLQTruncated()
      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.

      Default: - sum over 5 minutes

      Specified by:
      metricSentToDLQTruncated in interface IScheduleGroup

    • metricTargetErrors

      @Stability(Stable) @NotNull public Metric metricTargetErrors(@Nullable MetricOptions props)
      Emitted when the target returns an exception after EventBridge Scheduler calls the target API.

      Default: - sum over 5 minutes

      Specified by:
      metricTargetErrors in interface IScheduleGroup
      Parameters:
      props -

    • metricTargetErrors

      @Stability(Stable) @NotNull public Metric metricTargetErrors()
      Emitted when the target returns an exception after EventBridge Scheduler calls the target API.

      Default: - sum over 5 minutes

      Specified by:
      metricTargetErrors in interface IScheduleGroup

    • metricTargetThrottled

      @Stability(Stable) @NotNull public Metric metricTargetThrottled(@Nullable MetricOptions props)
      Metric for invocation failures due to API throttling by the target.

      Default: - sum over 5 minutes

      Specified by:
      metricTargetThrottled in interface IScheduleGroup
      Parameters:
      props -

    • metricTargetThrottled

      @Stability(Stable) @NotNull public Metric metricTargetThrottled()
      Metric for invocation failures due to API throttling by the target.

      Default: - sum over 5 minutes

      Specified by:
      metricTargetThrottled in interface IScheduleGroup

    • metricThrottled

      @Stability(Stable) @NotNull public Metric metricThrottled(@Nullable MetricOptions props)
      Metric for the number of invocations that were throttled because it exceeds your service quotas.

      Default: - sum over 5 minutes

      Specified by:
      metricThrottled in interface IScheduleGroup
      Parameters:
      props -
      See Also:

    • metricThrottled

      @Stability(Stable) @NotNull public Metric metricThrottled()
      Metric for the number of invocations that were throttled because it exceeds your service quotas.

      Default: - sum over 5 minutes

      Specified by:
      metricThrottled in interface IScheduleGroup
      See Also:

    • getGrants

      @Stability(Stable) @NotNull public ScheduleGroupGrants getGrants()
      Collection of grant methods for a ScheduleGroup.

    • getScheduleGroupArn

      @Stability(Stable) @NotNull public String getScheduleGroupArn()
      The arn of the schedule group.
      Specified by:
      getScheduleGroupArn in interface IScheduleGroup

    • getScheduleGroupName

      @Stability(Stable) @NotNull public String getScheduleGroupName()
      The name of the schedule group.
      Specified by:
      getScheduleGroupName in interface IScheduleGroup

    • getScheduleGroupRef

      @Stability(Stable) @NotNull public ScheduleGroupReference getScheduleGroupRef()
      A reference to a ScheduleGroup resource.
      Specified by:
      getScheduleGroupRef in interface IScheduleGroupRef