# CfnSchedule A *schedule* is the main resource you create, configure, and manage using Amazon EventBridge Scheduler. Every schedule has a *schedule expression* that determines when, and with what frequency, the schedule runs. EventBridge Scheduler supports three types of schedules: rate, cron, and one-time schedules. For more information about different schedule types, see [Schedule types](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in the *EventBridge Scheduler User Guide* . When you create a schedule, you configure a target for the schedule to invoke. A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler supports two types of targets: *templated* targets invoke common API operations across a core groups of services, and customizeable *universal* targets that you can use to call more than 6,000 operations across over 270 services. For more information about configuring targets, see [Managing targets](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets.html) in the *EventBridge Scheduler User Guide* . For more information about managing schedules, changing the schedule state, setting up flexible time windows, and configuring a dead-letter queue for a schedule, see [Managing a schedule](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-schedule.html) in the *EventBridge Scheduler User Guide* . Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnSchedule Implements: IInspectable, IEnvironmentAware, IScheduleRef, IConstruct, IDependable - CloudFormation: [`AWS::Scheduler::Schedule`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-scheduler-schedule.html) - Source: Generated code - Type last changed: v2.252.0 · 30 Apr 2026 ## Example ```ts // The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import { aws_scheduler as scheduler } from 'aws-cdk-lib'; declare const tags: any; const cfnSchedule = new scheduler.CfnSchedule(this, 'MyCfnSchedule', { flexibleTimeWindow: { mode: 'mode', // the properties below are optional maximumWindowInMinutes: 123, }, scheduleExpression: 'scheduleExpression', target: { arn: 'arn', roleArn: 'roleArn', // the properties below are optional deadLetterConfig: { arn: 'arn', }, ecsParameters: { taskDefinitionArn: 'taskDefinitionArn', // the properties below are optional capacityProviderStrategy: [{ capacityProvider: 'capacityProvider', // the properties below are optional base: 123, weight: 123, }], enableEcsManagedTags: false, enableExecuteCommand: false, group: 'group', launchType: 'launchType', networkConfiguration: { awsvpcConfiguration: { subnets: ['subnets'], // the properties below are optional assignPublicIp: 'assignPublicIp', securityGroups: ['securityGroups'], }, }, placementConstraints: [{ expression: 'expression', type: 'type', }], placementStrategy: [{ field: 'field', type: 'type', }], platformVersion: 'platformVersion', propagateTags: 'propagateTags', referenceId: 'referenceId', tags: tags, taskCount: 123, }, eventBridgeParameters: { detailType: 'detailType', source: 'source', }, input: 'input', kinesisParameters: { partitionKey: 'partitionKey', }, retryPolicy: { maximumEventAgeInSeconds: 123, maximumRetryAttempts: 123, }, sageMakerPipelineParameters: { pipelineParameterList: [{ name: 'name', value: 'value', }], }, sqsParameters: { messageGroupId: 'messageGroupId', }, }, // the properties below are optional description: 'description', endDate: 'endDate', groupName: 'groupName', kmsKeyArn: 'kmsKeyArn', name: 'name', scheduleExpressionTimezone: 'scheduleExpressionTimezone', startDate: 'startDate', state: 'state', }); ``` ## Initializer ```ts new CfnSchedule(scope: Construct, id: string, props: CfnScheduleProps) ``` ## Construct Props - `description`: string — The description you specify for the schedule. - `endDate`: string — The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the `EndDate` you specify. EventBridge Scheduler ignores `EndDate` for one-time schedules. - `flexibleTimeWindow`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnSchedule.FlexibleTimeWindowProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.CfnSchedule.FlexibleTimeWindowProperty.html) (required) — Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. - `groupName`: string — The name of the schedule group associated with this schedule. - `kmsKeyArn`: string | [IKeyRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_kms.IKeyRef.html) — The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data. - `name`: string — The name of the schedule. - `scheduleExpression`: string (required) — The expression that defines when the schedule runs. The following formats are supported. - `at` expression - `at(yyyy-mm-ddThh:mm:ss)` - `rate` expression - `rate(value unit)` - `cron` expression - `cron(fields)` You can use `at` expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use `rate` and `cron` expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month. A `cron` expression consists of six fields separated by white spaces: `(minutes hours day_of_month month day_of_week year)` . A `rate` expression consists of a *value* as a positive integer, and a *unit* with the following options: `minute` | `minutes` | `hour` | `hours` | `day` | `days` For more information and examples, see [Schedule types on EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html) in the *EventBridge Scheduler User Guide* . - `scheduleExpressionTimezone`: string — The timezone in which the scheduling expression is evaluated. - `startDate`: string — The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the `StartDate` you specify. EventBridge Scheduler ignores `StartDate` for one-time schedules. - `state`: string — Specifies whether the schedule is enabled or disabled. *Allowed Values* : `ENABLED` | `DISABLED` - `target`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnSchedule.TargetProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.CfnSchedule.TargetProperty.html) (required) — The schedule's target details. ## Properties - `attrArn`: string (required) — The Amazon Resource Name (ARN) for the Amazon EventBridge Scheduler schedule. - `CFN_RESOURCE_TYPE_NAME`: string (required) (static) — The CloudFormation resource type name for this resource class. - `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) (required) — Options for this resource, such as condition, update policy etc. - `cfnResourceType`: string (required) — AWS resource type. - `creationStack`: string[] (required) - `description`: string — The description you specify for the schedule. - `endDate`: string — The date, in UTC, before which the schedule can invoke its target. - `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) - `flexibleTimeWindow`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnSchedule.FlexibleTimeWindowProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.CfnSchedule.FlexibleTimeWindowProperty.html) (required) — Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. - `groupName`: string — The name of the schedule group associated with this schedule. - `kmsKeyArn`: string — The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data. - `logicalId`: string (required) — The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. - `name`: string — The name of the schedule. - `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node. - `ref`: string (required) — Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. - `scheduleExpression`: string (required) — The expression that defines when the schedule runs. The following formats are supported. - `scheduleExpressionTimezone`: string — The timezone in which the scheduling expression is evaluated. - `scheduleRef`: [ScheduleReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_scheduler.ScheduleReference.html) (required) — A reference to a Schedule resource. - `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). - `startDate`: string — The date, in UTC, after which the schedule can begin invoking its target. - `state`: string — Specifies whether the schedule is enabled or disabled. - `target`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnSchedule.TargetProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_scheduler.CfnSchedule.TargetProperty.html) (required) — The schedule's target details. ## Methods - `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`. **Parameters** - `path` — The path of the value to delete. - `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead. This method has been renamed to `addResourceDependency` to more clearly set it apart from `construct.node.addDependency`. See the documentation of that function for more details. - `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. This method has been renamed to `addResourceDependency`, which makes it more clear that this method operates at a different level from the construct-level `construct.node.addDependency()` mechanism. - `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata. - `addOverride(path: string, value: any): void` — Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. **Parameters** - `path` — - The path of the property, you can use dot notation to override values in complex types. - `value` — - The value. - `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition. **Parameters** - `propertyPath` — The path to the property. - `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. **Parameters** - `propertyPath` — The path of the property. - `value` — The value. - `addResourceDependency(target: CfnResource, reason?: string): void` — Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use `construct.node.addDependency` instead. - `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource. When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context. **Parameters** - `strength` — - The reference strength to use for this resource. - `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — Sets the deletion policy of the resource based on the removal policy specified. 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`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: - `arnForSchedule(resource: IScheduleRef): string` (static) - `cfnPropertyName(cdkPropertyName: string): string` - `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. **Parameters** - `attributeName` — The name of the attribute. - `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata. - `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes. **Parameters** - `inspector` — tree inspector to collect and process attributes. - `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. **Returns:** The construct as a stack element or undefined if it is not a stack element. - `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource. - `isCfnSchedule(x: any): boolean` (static) — Checks whether the given object is a CfnSchedule. - `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. **Parameters** - `x` — Any object. **Returns:** true if `x` is an object created from a class which extends `Construct`. - `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on. For resources depended on directly, returns the `CfnResource` object. For dependencies on other stacks, returns the `Stack` object. The order of the array is not guaranteed. - `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID. **Parameters** - `newLogicalId` — The new logical ID to use for this stack element. - `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. - `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. - `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another. **Parameters** - `target` — The dependency to replace. - `newTarget` — The new dependency to add. - `toString(): string` — Returns a string representation of this construct. **Returns:** a string representation of this resource - `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs.