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