interface IScheduleGroup

Language	Type name
.NET	Amazon.CDK.AWS.Scheduler.IScheduleGroup
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsscheduler#IScheduleGroup
Java	software.amazon.awscdk.services.scheduler.IScheduleGroup
Python	aws_cdk.aws_scheduler.IScheduleGroup
TypeScript (source)	aws-cdk-lib » aws_scheduler » IScheduleGroup

Implemented by ScheduleGroup

Obtainable from ScheduleGroup.fromDefaultScheduleGroup(), ScheduleGroup.fromScheduleGroupArn(), ScheduleGroup.fromScheduleGroupName()

Interface representing a created or an imported ScheduleGroup.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
scheduleGroupArn	string	The arn of the schedule group.
scheduleGroupName	string	The name of the schedule group.
scheduleGroupRef🔹	ScheduleGroupReference	A reference to a ScheduleGroup resource.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

scheduleGroupArn

Type: string

The arn of the schedule group.

---

scheduleGroupName

Type: string

The name of the schedule group.

---

scheduleGroupRef🔹

Type: ScheduleGroupReference

A reference to a ScheduleGroup resource.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grant(grantee, ...actions)	Grant the indicated permissions on this group to the given principal.
grantDeleteSchedules(identity)	Grant delete schedule permission for schedules in this group to the given principal.
grantReadSchedules(identity)	Grant list and get schedule permissions for schedules in this group to the given principal.
grantWriteSchedules(identity)	Grant create and update schedule permissions for schedules in this group to the given principal.
metric(metricName, props?)	Return the given named metric for this group schedules.
metricAttempts(props?)	Metric for all invocation attempts.
metricDropped(props?)	Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.
metricFailedToBeSentToDLQ(errorCode?, props?)	Metric for failed invocations that also failed to deliver to DLQ.
metricSentToDLQ(props?)	Metric for invocations delivered to the DLQ.
metricSentToDLQTruncated(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.
metricTargetErrors(props?)	Emitted when the target returns an exception after EventBridge Scheduler calls the target API.
metricTargetThrottled(props?)	Metric for invocation failures due to API throttling by the target.
metricThrottled(props?)	Metric for the number of invocations that were throttled because it exceeds your service quotas.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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).

---

grant(grantee, ...actions)

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable
• actions string

Returns

• Grant

Grant the indicated permissions on this group to the given principal.

---

grantDeleteSchedules(identity)

public grantDeleteSchedules(identity: IGrantable): Grant

Parameters

• identity IGrantable

Returns

• Grant

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

---

grantReadSchedules(identity)

public grantReadSchedules(identity: IGrantable): Grant

Parameters

• identity IGrantable

Returns

• Grant

Grant list and get schedule permissions for schedules in this group to the given principal.

---

grantWriteSchedules(identity)

public grantWriteSchedules(identity: IGrantable): Grant

Parameters

• identity IGrantable

Returns

• Grant

Grant create and update schedule permissions for schedules in this group to the given principal.

---

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for this group schedules.

---

metricAttempts(props?)

public metricAttempts(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for all invocation attempts.

---

metricDropped(props?)

public metricDropped(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for dropped invocations when EventBridge Scheduler stops attempting to invoke the target after a schedule's retry policy has been exhausted.

---

metricFailedToBeSentToDLQ(errorCode?, props?)

public metricFailedToBeSentToDLQ(errorCode?: string, props?: MetricOptions): Metric

Parameters

• errorCode string
• props MetricOptions

Returns

• Metric

Metric for failed invocations that also failed to deliver to DLQ.

---

metricSentToDLQ(props?)

public metricSentToDLQ(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for invocations delivered to the DLQ.

---

metricSentToDLQTruncated(props?)

public metricSentToDLQTruncated(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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(props?)

public metricTargetErrors(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Emitted when the target returns an exception after EventBridge Scheduler calls the target API.

---

metricTargetThrottled(props?)

public metricTargetThrottled(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for invocation failures due to API throttling by the target.

---

metricThrottled(props?)

public metricThrottled(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of invocations that were throttled because it exceeds your service quotas.

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