Package software.amazon.awscdk.services.scheduler

Interface IScheduleGroup

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, IScheduleGroupRef, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IScheduleGroup.Jsii$Default
All Known Implementing Classes:
IScheduleGroup.Jsii$Proxy, ScheduleGroup
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:17.729Z") @Stability(Stable) public interface IScheduleGroup extends software.amazon.jsii.JsiiSerializable, IResource, IScheduleGroupRef
Interface representing a created or an imported ScheduleGroup.

  • Method Details

    • getScheduleGroupArn

      @Stability(Stable) @NotNull String getScheduleGroupArn()
      The arn of the schedule group.

    • getScheduleGroupName

      @Stability(Stable) @NotNull String getScheduleGroupName()
      The name of the schedule group.

    • grant

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

      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantDeleteSchedules

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

      Parameters:
      identity - This parameter is required.

    • grantReadSchedules

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

      Parameters:
      identity - This parameter is required.

    • grantWriteSchedules

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

      Parameters:
      identity - This parameter is required.

    • metric

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

      Default: - sum over 5 minutes

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

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

      Default: - sum over 5 minutes

      Parameters:
      metricName - This parameter is required.

    • metricAttempts

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

      Default: - sum over 5 minutes

      Parameters:
      props -

    • metricAttempts

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

      Default: - sum over 5 minutes

    • metricDropped

      @Stability(Stable) @NotNull 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

      Parameters:
      props -

    • metricDropped

      @Stability(Stable) @NotNull 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

    • metricFailedToBeSentToDLQ

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

      Default: - sum over 5 minutes

      Parameters:
      errorCode -
      props -

    • metricFailedToBeSentToDLQ

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

      Default: - sum over 5 minutes

      Parameters:
      errorCode -

    • metricFailedToBeSentToDLQ

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

      Default: - sum over 5 minutes

    • metricSentToDLQ

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

      Default: - sum over 5 minutes

      Parameters:
      props -

    • metricSentToDLQ

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

      Default: - sum over 5 minutes

    • metricSentToDLQTruncated

      @Stability(Stable) @NotNull 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

      Parameters:
      props -

    • metricSentToDLQTruncated

      @Stability(Stable) @NotNull 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

    • metricTargetErrors

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

      Default: - sum over 5 minutes

      Parameters:
      props -

    • metricTargetErrors

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

      Default: - sum over 5 minutes

    • metricTargetThrottled

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

      Default: - sum over 5 minutes

      Parameters:
      props -

    • metricTargetThrottled

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

      Default: - sum over 5 minutes

    • metricThrottled

      @Stability(Stable) @NotNull 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

      Parameters:
      props -
      See Also:

    • metricThrottled

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

      Default: - sum over 5 minutes

      See Also:

    • getNode

      @Stability(Stable) @NotNull software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct

    • getEnv

      @Stability(Stable) @NotNull ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

      For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IEnvironmentAware