Interface IGroup.Jsii$Default
- All Superinterfaces:
software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
,IGroup
,IResource
,IResource.Jsii$Default
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IGroup.Jsii$Proxy
- Enclosing interface:
IGroup
IGroup
.-
Nested Class Summary
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
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.default ResourceEnvironment
getEnv()
The environment this resource belongs to.default String
(experimental) The arn of the schedule group.default String
(experimental) The name of the schedule group.default software.constructs.Node
getNode()
The tree node.default Stack
getStack()
The stack in which this resource is defined.default Grant
grant
(IGrantable grantee, @NotNull String... actions) (experimental) Grant the indicated permissions on this group to the given principal.default Grant
grantDeleteSchedules
(IGrantable identity) (experimental) Grant delete schedule permission for schedules in this group to the given principal.default Grant
grantReadSchedules
(IGrantable identity) (experimental) Grant list and get schedule permissions for schedules in this group to the given principal.default Grant
grantWriteSchedules
(IGrantable identity) (experimental) Grant create and update schedule permissions for schedules in this group to the given principal.default Metric
metric
(String metricName, MetricOptions props) (experimental) Return the given named metric for this group schedules.default Metric
metricAttempts
(MetricOptions props) (experimental) Metric for all invocation attempts.default 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.default Metric
metricFailedToBeSentToDLQ
(String errorCode, MetricOptions props) (experimental) Metric for failed invocations that also failed to deliver to DLQ.default Metric
metricSentToDLQ
(MetricOptions props) (experimental) Metric for invocations delivered to the DLQ.default Metric
(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 Metric
metricTargetErrors
(MetricOptions props) (experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API.default Metric
(experimental) Metric for invocation failures due to API throttling by the target.default Metric
metricThrottled
(MetricOptions props) (experimental) Metric for the number of invocations that were throttled because it exceeds your service quotas.Methods inherited from interface software.amazon.awscdk.services.scheduler.alpha.IGroup
metric, metricAttempts, metricDropped, metricFailedToBeSentToDLQ, metricFailedToBeSentToDLQ, metricSentToDLQ, metricSentToDLQTruncated, metricTargetErrors, metricTargetThrottled, metricThrottled
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
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
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
grant
@Stability(Experimental) @NotNull default 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 default Metric metric(@NotNull String metricName, @Nullable MetricOptions props) (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
-
-
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
-
-
metricFailedToBeSentToDLQ
@Stability(Experimental) @NotNull default 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
-
-
metricSentToDLQ
(experimental) Metric for invocations delivered to the DLQ.Default: - sum over 5 minutes
- Specified by:
metricSentToDLQ
in interfaceIGroup
- Parameters:
props
-
-
metricSentToDLQTruncated
@Stability(Experimental) @NotNull default 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
-
-
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
-
-
metricTargetThrottled
@Stability(Experimental) @NotNull default 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
-
-
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:
-