Class Group
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.scheduler.alpha.Group
- All Implemented Interfaces:
IResource
,IGroup
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-09-11T18:01:25.886Z")
@Stability(Experimental)
public class Group
extends Resource
implements IGroup
Example:
LambdaInvoke target; Group group = Group.Builder.create(this, "Group") .groupName("MyGroup") .build(); Schedule.Builder.create(this, "Schedule") .schedule(ScheduleExpression.rate(Duration.minutes(10))) .target(target) .group(group) .build();
-
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
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
-
Constructor Summary
ModifierConstructorDescriptionprotected
Group
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
Group
(software.amazon.jsii.JsiiObjectRef objRef) Group
(software.constructs.Construct scope, String id, GroupProps props) -
Method Summary
Modifier and TypeMethodDescriptionstatic IGroup
fromDefaultGroup
(software.constructs.Construct scope, String id) (experimental) Import a default schedule group.static IGroup
fromGroupArn
(software.constructs.Construct scope, String id, String groupArn) (experimental) Import an external group by ARN.static IGroup
fromGroupName
(software.constructs.Construct scope, String id, String groupName) (experimental) Import an existing group with a given name.(experimental) The arn of the schedule group.(experimental) The name of the schedule group.grant
(IGrantable grantee, @NotNull String... actions) (experimental) Grant the indicated permissions on this group to the given principal.grantDeleteSchedules
(IGrantable identity) (experimental) Grant delete schedule permission for schedules in this group to the given principal.grantReadSchedules
(IGrantable identity) (experimental) Grant list and get schedule permissions for schedules in this group to the given principal.grantWriteSchedules
(IGrantable identity) (experimental) Grant create and update schedule permissions for schedules in this group to the given principal.(experimental) Return the given named metric for this group schedules.metric
(String metricName, MetricOptions props) (experimental) Return the given named metric for this group schedules.(experimental) Metric for all invocation attempts.metricAttempts
(MetricOptions props) (experimental) Metric for all invocation attempts.(experimental) Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.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.(experimental) Metric for failed invocations that also failed to deliver to DLQ.metricFailedToBeSentToDLQ
(String errorCode) (experimental) Metric for failed invocations that also failed to deliver to DLQ.metricFailedToBeSentToDLQ
(String errorCode, MetricOptions props) (experimental) Metric for failed invocations that also failed to deliver to DLQ.(experimental) Metric for invocations delivered to the DLQ.metricSentToDLQ
(MetricOptions props) (experimental) Metric for invocations delivered to the DLQ.(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.(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.(experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API.metricTargetErrors
(MetricOptions props) (experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API.(experimental) Metric for invocation failures due to API throttling by the target.(experimental) Metric for invocation failures due to API throttling by the target.(experimental) Metric for the number of invocations that were throttled because it exceeds your service quotas.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.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
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, wait, wait, wait
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Group
protected Group(software.amazon.jsii.JsiiObjectRef objRef) -
Group
protected Group(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
Group
@Stability(Experimental) public Group(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull GroupProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
fromDefaultGroup
@Stability(Experimental) @NotNull public static IGroup fromDefaultGroup(@NotNull software.constructs.Construct scope, @NotNull String id) (experimental) Import a default schedule group.- Parameters:
scope
- construct scope. This parameter is required.id
- construct id. This parameter is required.
-
fromGroupArn
@Stability(Experimental) @NotNull public static IGroup fromGroupArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String groupArn) (experimental) Import an external group by ARN.- Parameters:
scope
- construct scope. This parameter is required.id
- construct id. This parameter is required.groupArn
- the ARN of the group to import (e.g.arn:aws:scheduler:region:account-id:schedule-group/group-name
). This parameter is required.
-
fromGroupName
@Stability(Experimental) @NotNull public static IGroup fromGroupName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String groupName) (experimental) Import an existing group with a given name.- Parameters:
scope
- construct scope. This parameter is required.id
- construct id. This parameter is required.groupName
- the name of the existing group to import. This parameter is required.
-
grant
@Stability(Experimental) @NotNull public Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) (experimental) Grant the indicated permissions on this group to the given principal. -
grantDeleteSchedules
(experimental) Grant delete schedule permission for schedules in this group to the given principal.- Specified by:
grantDeleteSchedules
in interfaceIGroup
- Parameters:
identity
- This parameter is required.
-
grantReadSchedules
(experimental) Grant list and get schedule permissions for schedules in this group to the given principal.- Specified by:
grantReadSchedules
in interfaceIGroup
- Parameters:
identity
- This parameter is required.
-
grantWriteSchedules
(experimental) Grant create and update schedule permissions for schedules in this group to the given principal.- Specified by:
grantWriteSchedules
in interfaceIGroup
- Parameters:
identity
- This parameter is required.
-
metric
@Stability(Experimental) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props) (experimental) Return the given named metric for this group schedules.Default: - sum over 5 minutes
-
metric
(experimental) Return the given named metric for this group schedules.Default: - sum over 5 minutes
-
metricAttempts
(experimental) Metric for all invocation attempts.Default: - sum over 5 minutes
- Specified by:
metricAttempts
in interfaceIGroup
- Parameters:
props
-
-
metricAttempts
(experimental) Metric for all invocation attempts.Default: - sum over 5 minutes
- Specified by:
metricAttempts
in interfaceIGroup
-
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 interfaceIGroup
- Parameters:
props
-
-
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 interfaceIGroup
-
metricFailedToBeSentToDLQ
@Stability(Experimental) @NotNull public 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 interfaceIGroup
- Parameters:
errorCode
-props
-
-
metricFailedToBeSentToDLQ
@Stability(Experimental) @NotNull public 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 interfaceIGroup
- Parameters:
errorCode
-
-
metricFailedToBeSentToDLQ
(experimental) Metric for failed invocations that also failed to deliver to DLQ.Default: - sum over 5 minutes
- Specified by:
metricFailedToBeSentToDLQ
in interfaceIGroup
-
metricSentToDLQ
(experimental) Metric for invocations delivered to the DLQ.Default: - sum over 5 minutes
- Specified by:
metricSentToDLQ
in interfaceIGroup
- Parameters:
props
-
-
metricSentToDLQ
(experimental) Metric for invocations delivered to the DLQ.Default: - sum over 5 minutes
- Specified by:
metricSentToDLQ
in interfaceIGroup
-
metricSentToDLQTruncated
@Stability(Experimental) @NotNull public 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 interfaceIGroup
- Parameters:
props
-
-
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 interfaceIGroup
-
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 interfaceIGroup
- Parameters:
props
-
-
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 interfaceIGroup
-
metricTargetThrottled
@Stability(Experimental) @NotNull public 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 interfaceIGroup
- Parameters:
props
-
-
metricTargetThrottled
(experimental) Metric for invocation failures due to API throttling by the target.Default: - sum over 5 minutes
- Specified by:
metricTargetThrottled
in interfaceIGroup
-
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 interfaceIGroup
- Parameters:
props
-- See Also:
-
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 interfaceIGroup
- See Also:
-
getGroupArn
(experimental) The arn of the schedule group.- Specified by:
getGroupArn
in interfaceIGroup
-
getGroupName
(experimental) The name of the schedule group.- Specified by:
getGroupName
in interfaceIGroup
-