Package software.amazon.awscdk.services.scheduler

Interface IScheduleGroup.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, IScheduleGroup, IScheduleGroupRef, IScheduleGroupRef.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IScheduleGroup.Jsii$Proxy
Enclosing interface:
IScheduleGroup
@Internal public static interface IScheduleGroup.Jsii$Default extends IScheduleGroup, IResource.Jsii$Default, IScheduleGroupRef.Jsii$Default
Internal default implementation for IScheduleGroup.

  • Method Details

    • getScheduleGroupArn

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

    • getScheduleGroupName

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

    • grant

      @Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      Grant the indicated permissions on this 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 default 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 default 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 default 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 default Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this group schedules.

      Default: - sum over 5 minutes

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

    • metric

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

      Default: - sum over 5 minutes

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

    • metricAttempts

      @Stability(Stable) @NotNull default 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 default Metric metricAttempts()
      Metric for all invocation attempts.

      Default: - sum over 5 minutes

      Specified by:
      metricAttempts in interface IScheduleGroup

    • metricDropped

      @Stability(Stable) @NotNull default 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 default 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 default 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 default 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 default 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 default 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 default Metric metricSentToDLQ()
      Metric for invocations delivered to the DLQ.

      Default: - sum over 5 minutes

      Specified by:
      metricSentToDLQ in interface IScheduleGroup

    • metricSentToDLQTruncated

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