Package software.amazon.awscdk.services.scheduler

Class IScheduleGroup.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.scheduler.IScheduleGroup.Jsii$Proxy

All Implemented Interfaces:

IResource, IResource.Jsii$Default, IScheduleGroup, IScheduleGroup.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default

Enclosing interface:

IScheduleGroup

@Internal
public static final class IScheduleGroup.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IScheduleGroup.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.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

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

IScheduleGroup.Jsii$Default, IScheduleGroup.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 software.constructs.Node	getNode()	The tree node.
final String	getScheduleGroupArn()	The arn of the schedule group.
final String	getScheduleGroupName()	The name of the schedule group.
final Stack	getStack()	The stack in which this resource is defined.
final Grant	grant(IGrantable grantee, String... actions)	Grant the indicated permissions on this group to the given principal.
final Grant	grantDeleteSchedules(IGrantable identity)	Grant delete schedule permission for schedules in this group to the given principal.
final Grant	grantReadSchedules(IGrantable identity)	Grant list and get schedule permissions for schedules in this group to the given principal.
final Grant	grantWriteSchedules(IGrantable identity)	Grant create and update schedule permissions for schedules in this group to the given principal.
final Metric	metric(String metricName)	Return the given named metric for this group schedules.
final Metric	metric(String metricName, MetricOptions props)	Return the given named metric for this group schedules.
final Metric	metricAttempts()	Metric for all invocation attempts.
final Metric	metricAttempts(MetricOptions props)	Metric for all invocation attempts.
final Metric	metricDropped()	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)	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()	Metric for failed invocations that also failed to deliver to DLQ.
final Metric	metricFailedToBeSentToDLQ(String errorCode)	Metric for failed invocations that also failed to deliver to DLQ.
final Metric	metricFailedToBeSentToDLQ(String errorCode, MetricOptions props)	Metric for failed invocations that also failed to deliver to DLQ.
final Metric	metricSentToDLQ()	Metric for invocations delivered to the DLQ.
final Metric	metricSentToDLQ(MetricOptions props)	Metric for invocations delivered to the DLQ.
final 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.
final Metric	metricSentToDLQTruncated(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.
final Metric	metricTargetErrors()	Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
final Metric	metricTargetErrors(MetricOptions props)	Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
final Metric	metricTargetThrottled()	Metric for invocation failures due to API throttling by the target.
final Metric	metricTargetThrottled(MetricOptions props)	Metric for invocation failures due to API throttling by the target.
final Metric	metricThrottled()	Metric for the number of invocations that were throttled because it exceeds your service quotas.
final Metric	metricThrottled(MetricOptions props)	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 IResource.Jsii$Default

Specified by:

getNode in interface IScheduleGroup.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 IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IScheduleGroup.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IScheduleGroup.Jsii$Default

getScheduleGroupArn

@Stability(Stable)
@NotNull
public final String getScheduleGroupArn()

The arn of the schedule group.

Specified by:

getScheduleGroupArn in interface IScheduleGroup

Specified by:

getScheduleGroupArn in interface IScheduleGroup.Jsii$Default

getScheduleGroupName

@Stability(Stable)
@NotNull
public final String getScheduleGroupName()

The name of the schedule group.

Specified by:

getScheduleGroupName in interface IScheduleGroup

Specified by:

getScheduleGroupName in interface IScheduleGroup.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 IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IScheduleGroup.Jsii$Default

Parameters:

policy - This parameter is required.

grant

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

Specified by:

grant in interface IScheduleGroup.Jsii$Default

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantDeleteSchedules

@Stability(Stable)
@NotNull
public final Grant grantDeleteSchedules(@NotNull
 IGrantable identity)

Grant delete schedule permission for schedules in this group to the given principal.

Specified by:

grantDeleteSchedules in interface IScheduleGroup

Specified by:

grantDeleteSchedules in interface IScheduleGroup.Jsii$Default

Parameters:

identity - This parameter is required.

grantReadSchedules

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

Specified by:

grantReadSchedules in interface IScheduleGroup.Jsii$Default

Parameters:

identity - This parameter is required.

grantWriteSchedules

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

Specified by:

grantWriteSchedules in interface IScheduleGroup.Jsii$Default

Parameters:

identity - This parameter is required.

metric

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

Specified by:

metric in interface IScheduleGroup.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

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

Metric for all invocation attempts.

Default: - sum over 5 minutes

Specified by:

metricAttempts in interface IScheduleGroup

Specified by:

metricAttempts in interface IScheduleGroup.Jsii$Default

Parameters:

props -

metricAttempts

@Stability(Stable)
@NotNull
public final Metric metricAttempts()

Metric for all invocation attempts.

Default: - sum over 5 minutes

Specified by:

metricAttempts in interface IScheduleGroup

metricDropped

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

Specified by:

metricDropped in interface IScheduleGroup.Jsii$Default

Parameters:

props -

metricDropped

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

Specified by:

metricFailedToBeSentToDLQ in interface IScheduleGroup.Jsii$Default

Parameters:

errorCode -

props -

metricFailedToBeSentToDLQ

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

Metric for invocations delivered to the DLQ.

Default: - sum over 5 minutes

Specified by:

metricSentToDLQ in interface IScheduleGroup

Specified by:

metricSentToDLQ in interface IScheduleGroup.Jsii$Default

Parameters:

props -

metricSentToDLQ

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

Specified by:

metricSentToDLQTruncated in interface IScheduleGroup.Jsii$Default

Parameters:

props -

metricSentToDLQTruncated

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

Specified by:

metricTargetErrors in interface IScheduleGroup.Jsii$Default

Parameters:

props -

metricTargetErrors

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

Specified by:

metricTargetThrottled in interface IScheduleGroup.Jsii$Default

Parameters:

props -

metricTargetThrottled

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

Specified by:

metricThrottled in interface IScheduleGroup.Jsii$Default

Parameters:

props -

See Also:

• https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html

metricThrottled

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

• https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html