interface ISchedule

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

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IScheduleRef

Implemented by Schedule

Obtainable from Schedule.fromScheduleArn()

Interface representing a created or an imported Schedule.

Properties

Name	Type	Description
env	`ResourceEnvironment`	The environment this resource belongs to.
node	`Node`	The tree node.
scheduleArn	`string`	The arn of the schedule.
scheduleName	`string`	The name of the schedule.
scheduleRef🔹	`ScheduleReference`	A reference to a Schedule resource.
stack	`Stack`	The stack in which this resource is defined.
scheduleGroup?	`IScheduleGroup`	The schedule group associated with this schedule.

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.

scheduleArn

Type: string

The arn of the schedule.

scheduleName

Type: string

The name of the schedule.

scheduleRef🔹

Type: ScheduleReference

A reference to a Schedule resource.

stack

Type: Stack

The stack in which this resource is defined.

scheduleGroup?

Type: IScheduleGroup (optional)

The schedule group associated with this schedule.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
with(...mixins)	Applies one or more mixins to this construct.

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

with(...mixins)

public with(...mixins: IMixin[]): IConstruct