Package software.amazon.awscdk.services.scheduler.alpha

Class IGroup.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.scheduler.alpha.IGroup.Jsii$Proxy
All Implemented Interfaces:
IResource, IResource.Jsii$Default, IGroup, IGroup.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default
Enclosing interface:
IGroup
@Internal public static final class IGroup.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IGroup.Jsii$Default
A proxy class which represents a concrete javascript instance of this type.

  • Nested Class Summary

    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, software.constructs.IConstruct.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IDependable

    software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.scheduler.alpha.IGroup

    IGroup.Jsii$Default, IGroup.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default, IResource.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    applyRemovalPolicy(RemovalPolicy policy)
    Apply the given removal policy to this resource.
    final ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    final String
    getGroupArn()
    (experimental) The arn of the schedule group.
    final String
    getGroupName()
    (experimental) The name of the schedule group.
    final software.constructs.Node
    getNode()
    The tree node.
    final Stack
    getStack()
    The stack in which this resource is defined.
    final Grant
    grant(IGrantable grantee, @NotNull String... actions)
    (experimental) Grant the indicated permissions on this group to the given principal.
    final Grant
    grantDeleteSchedules(IGrantable identity)
    (experimental) Grant delete schedule permission for schedules in this group to the given principal.
    final Grant
    grantReadSchedules(IGrantable identity)
    (experimental) Grant list and get schedule permissions for schedules in this group to the given principal.
    final Grant
    grantWriteSchedules(IGrantable identity)
    (experimental) Grant create and update schedule permissions for schedules in this group to the given principal.
    final Metric
    metric(String metricName)
    (experimental) Return the given named metric for this group schedules.
    final Metric
    metric(String metricName, MetricOptions props)
    (experimental) Return the given named metric for this group schedules.
    final Metric
    metricAttempts()
    (experimental) Metric for all invocation attempts.
    final Metric
    metricAttempts(MetricOptions props)
    (experimental) Metric for all invocation attempts.
    final Metric
    metricDropped()
    (experimental) Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
    final Metric
    metricDropped(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.
    final Metric
    metricFailedToBeSentToDLQ()
    (experimental) Metric for failed invocations that also failed to deliver to DLQ.
    final Metric
    metricFailedToBeSentToDLQ(String errorCode)
    (experimental) Metric for failed invocations that also failed to deliver to DLQ.
    final Metric
    metricFailedToBeSentToDLQ(String errorCode, MetricOptions props)
    (experimental) Metric for failed invocations that also failed to deliver to DLQ.
    final Metric
    metricSentToDLQ()
    (experimental) Metric for invocations delivered to the DLQ.
    final Metric
    metricSentToDLQ(MetricOptions props)
    (experimental) Metric for invocations delivered to the DLQ.
    final Metric
    metricSentToDLQTruncated()
    (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.
    final Metric
    metricSentToDLQTruncated(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.
    final Metric
    metricTargetErrors()
    (experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
    final Metric
    metricTargetErrors(MetricOptions props)
    (experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
    final Metric
    metricTargetThrottled()
    (experimental) Metric for invocation failures due to API throttling by the target.
    final Metric
    metricTargetThrottled(MetricOptions props)
    (experimental) Metric for invocation failures due to API throttling by the target.
    final Metric
    metricThrottled()
    (experimental) Metric for the number of invocations that were throttled because it exceeds your service quotas.
    final Metric
    metricThrottled(MetricOptions props)
    (experimental) Metric for the number of invocations that were throttled because it exceeds your service quotas.

    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, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

  • Method Details

    • getNode

      @Stability(Stable) @NotNull public final 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 IGroup.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull public final 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 IGroup.Jsii$Default
      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

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

    • getGroupArn

      @Stability(Experimental) @NotNull public final String getGroupArn()
      (experimental) The arn of the schedule group.
      Specified by:
      getGroupArn in interface IGroup
      Specified by:
      getGroupArn in interface IGroup.Jsii$Default

    • getGroupName

      @Stability(Experimental) @NotNull public final String getGroupName()
      (experimental) The name of the schedule group.
      Specified by:
      getGroupName in interface IGroup
      Specified by:
      getGroupName in interface IGroup.Jsii$Default

    • applyRemovalPolicy

      @Stability(Stable) public final 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 IGroup.Jsii$Default
      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • grant

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

      Specified by:
      grant in interface IGroup
      Specified by:
      grant in interface IGroup.Jsii$Default
      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantDeleteSchedules

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

      Specified by:
      grantDeleteSchedules in interface IGroup
      Specified by:
      grantDeleteSchedules in interface IGroup.Jsii$Default
      Parameters:
      identity - This parameter is required.

    • grantReadSchedules

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

      Specified by:
      grantReadSchedules in interface IGroup
      Specified by:
      grantReadSchedules in interface IGroup.Jsii$Default
      Parameters:
      identity - This parameter is required.

    • grantWriteSchedules

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

      Specified by:
      grantWriteSchedules in interface IGroup
      Specified by:
      grantWriteSchedules in interface IGroup.Jsii$Default
      Parameters:
      identity - This parameter is required.

    • metric

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

      Default: - sum over 5 minutes

      Specified by:
      metric in interface IGroup
      Specified by:
      metric in interface IGroup.Jsii$Default
      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Experimental) @NotNull public final Metric metric(@NotNull String metricName)
      (experimental) Return the given named metric for this group schedules.

      Default: - sum over 5 minutes

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

    • metricAttempts

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

      Default: - sum over 5 minutes

      Specified by:
      metricAttempts in interface IGroup
      Specified by:
      metricAttempts in interface IGroup.Jsii$Default
      Parameters:
      props -

    • metricAttempts

      @Stability(Experimental) @NotNull public final Metric metricAttempts()
      (experimental) Metric for all invocation attempts.

      Default: - sum over 5 minutes

      Specified by:
      metricAttempts in interface IGroup

    • metricDropped

      @Stability(Experimental) @NotNull public final Metric metricDropped(@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.

      Default: - sum over 5 minutes

      Specified by:
      metricDropped in interface IGroup
      Specified by:
      metricDropped in interface IGroup.Jsii$Default
      Parameters:
      props -

    • metricDropped

      @Stability(Experimental) @NotNull public final Metric metricDropped()
      (experimental) 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 IGroup

    • metricFailedToBeSentToDLQ

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

      Default: - sum over 5 minutes

      Specified by:
      metricFailedToBeSentToDLQ in interface IGroup
      Specified by:
      metricFailedToBeSentToDLQ in interface IGroup.Jsii$Default
      Parameters:
      errorCode -
      props -

    • metricFailedToBeSentToDLQ

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

      Default: - sum over 5 minutes

      Specified by:
      metricFailedToBeSentToDLQ in interface IGroup
      Parameters:
      errorCode -

    • metricFailedToBeSentToDLQ

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

      Default: - sum over 5 minutes

      Specified by:
      metricFailedToBeSentToDLQ in interface IGroup

    • metricSentToDLQ

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

      Default: - sum over 5 minutes

      Specified by:
      metricSentToDLQ in interface IGroup
      Specified by:
      metricSentToDLQ in interface IGroup.Jsii$Default
      Parameters:
      props -

    • metricSentToDLQ

      @Stability(Experimental) @NotNull public final Metric metricSentToDLQ()
      (experimental) Metric for invocations delivered to the DLQ.

      Default: - sum over 5 minutes

      Specified by:
      metricSentToDLQ in interface IGroup

    • metricSentToDLQTruncated

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

      Default: - sum over 5 minutes

      Specified by:
      metricSentToDLQTruncated in interface IGroup
      Specified by:
      metricSentToDLQTruncated in interface IGroup.Jsii$Default
      Parameters:
      props -

    • metricSentToDLQTruncated

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

      Default: - sum over 5 minutes

      Specified by:
      metricSentToDLQTruncated in interface IGroup

    • metricTargetErrors

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

      Default: - sum over 5 minutes

      Specified by:
      metricTargetErrors in interface IGroup
      Specified by:
      metricTargetErrors in interface IGroup.Jsii$Default
      Parameters:
      props -

    • metricTargetErrors

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

      Default: - sum over 5 minutes

      Specified by:
      metricTargetErrors in interface IGroup

    • metricTargetThrottled

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

      Default: - sum over 5 minutes

      Specified by:
      metricTargetThrottled in interface IGroup
      Specified by:
      metricTargetThrottled in interface IGroup.Jsii$Default
      Parameters:
      props -

    • metricTargetThrottled

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

      Default: - sum over 5 minutes

      Specified by:
      metricTargetThrottled in interface IGroup

    • metricThrottled

      @Stability(Experimental) @NotNull public final Metric metricThrottled(@Nullable MetricOptions props)
      (experimental) 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 IGroup
      Specified by:
      metricThrottled in interface IGroup.Jsii$Default
      Parameters:
      props -
      See Also:

    • metricThrottled

      @Stability(Experimental) @NotNull public final Metric metricThrottled()
      (experimental) 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 IGroup
      See Also: