Interface IGroup
Namespace: Amazon.CDK.AWS.Scheduler.Alpha
Assembly: Amazon.CDK.AWS.Scheduler.Alpha.dll
Syntax (csharp)
public interface IGroup : IResourceSyntax (vb)
Public Interface IGroup
Inherits IResource, IConstruct, IDependableRemarks
Stability: Experimental
Synopsis
Properties
| Group |
(experimental) The arn of the schedule group. |
| Group |
(experimental) The name of the schedule group. |
Methods
| Grant(IGrantable, String[]) | (experimental) Grant the indicated permissions on this group to the given principal. |
| Grant |
(experimental) Grant delete schedule permission for schedules in this group to the given principal. |
| Grant |
(experimental) Grant list and get schedule permissions for schedules in this group to the given principal. |
| Grant |
(experimental) Grant create and update schedule permissions for schedules in this group to the given principal. |
| Metric(String, IMetric |
(experimental) Return the given named metric for this group schedules. |
| Metric |
(experimental) Metric for all invocation attempts. |
| Metric |
(experimental) Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted. |
| Metric |
(experimental) Metric for failed invocations that also failed to deliver to DLQ. |
| Metric |
(experimental) Metric for invocations delivered to the DLQ. |
| 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. |
| Metric |
(experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API. |
| Metric |
(experimental) Metric for invocation failures due to API throttling by the target. |
| Metric |
(experimental) Metric for the number of invocations that were throttled because it exceeds your service quotas. |
Properties
GroupArn
(experimental) The arn of the schedule group.
string GroupArn { get; }Property Value
System.
Remarks
Stability: Experimental
Attribute: true
GroupName
(experimental) The name of the schedule group.
string GroupName { get; }Property Value
System.
Remarks
Stability: Experimental
Attribute: true
Methods
Grant(IGrantable, String[])
(experimental) Grant the indicated permissions on this group to the given principal.
Grant Grant(IGrantable grantee, params string[] actions)Parameters
- grantee IGrantable
- actions System.
String []
Returns
Remarks
Stability: Experimental
GrantDeleteSchedules(IGrantable)
(experimental) Grant delete schedule permission for schedules in this group to the given principal.
Grant GrantDeleteSchedules(IGrantable identity)Parameters
- identity IGrantable
Returns
Remarks
Stability: Experimental
GrantReadSchedules(IGrantable)
(experimental) Grant list and get schedule permissions for schedules in this group to the given principal.
Grant GrantReadSchedules(IGrantable identity)Parameters
- identity IGrantable
Returns
Remarks
Stability: Experimental
GrantWriteSchedules(IGrantable)
(experimental) Grant create and update schedule permissions for schedules in this group to the given principal.
Grant GrantWriteSchedules(IGrantable identity)Parameters
- identity IGrantable
Returns
Remarks
Stability: Experimental
Metric(String, IMetricOptions)
(experimental) Return the given named metric for this group schedules.
Metric Metric(string metricName, IMetricOptions props = null)Parameters
- metricName System.
String - props IMetric
Options
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental
MetricAttempts(IMetricOptions)
(experimental) Metric for all invocation attempts.
Metric MetricAttempts(IMetricOptions props = null)Parameters
- props IMetric
Options
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental
MetricDropped(IMetricOptions)
(experimental) Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
Metric MetricDropped(IMetricOptions props = null)Parameters
- props IMetric
Options
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental
MetricFailedToBeSentToDLQ(String, IMetricOptions)
(experimental) Metric for failed invocations that also failed to deliver to DLQ.
Metric MetricFailedToBeSentToDLQ(string errorCode = null, IMetricOptions props = null)Parameters
- errorCode System.
String - props IMetric
Options
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental
MetricSentToDLQ(IMetricOptions)
(experimental) Metric for invocations delivered to the DLQ.
Metric MetricSentToDLQ(IMetricOptions props = null)Parameters
- props IMetric
Options
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental
MetricSentToDLQTruncated(IMetricOptions)
(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.
Metric MetricSentToDLQTruncated(IMetricOptions props = null)Parameters
- props IMetric
Options
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental
MetricTargetErrors(IMetricOptions)
(experimental) Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
Metric MetricTargetErrors(IMetricOptions props = null)Parameters
- props IMetric
Options
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental
MetricTargetThrottled(IMetricOptions)
(experimental) Metric for invocation failures due to API throttling by the target.
Metric MetricTargetThrottled(IMetricOptions props = null)Parameters
- props IMetric
Options
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental
MetricThrottled(IMetricOptions)
(experimental) Metric for the number of invocations that were throttled because it exceeds your service quotas.
Metric MetricThrottled(IMetricOptions props = null)Parameters
- props IMetric
Options
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental
See: https://docs.aws.amazon.com/scheduler/latest/UserGuide/scheduler-quotas.html