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, IResource, IResource.Jsii$Default, IScheduleGroup, 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
Internal default implementation for IScheduleGroup.

  • Method Details

    • getNode

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

    • getEnv

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

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • 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

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • 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 -

    • 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 -

    • 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 -

    • 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 -

    • 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 -

    • 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 -

    • 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 -

    • 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 -

    • 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: