feat(scheduler): disable Schedule on creation

packages/@aws-cdk/aws-scheduler-alpha/lib/schedule.ts

@@ -57,9 +57,15 @@ export interface ScheduleProps {
   /**
    * The schedule's group.
    *
-   * @deafult - By default a schedule will be associated with the `default` group.
+   * @default - By default a schedule will be associated with the `default` group.
    */
   readonly group?: IGroup;
+
+  /**
+   * Indicates whether the schedule is enabled.
+   * @default true
+   */
+  readonly enabled?: boolean;
 }
 
 /**
@@ -95,6 +101,7 @@ export class Schedule extends Resource implements ISchedule {
       scheduleExpression: props.schedule.expressionString,
       scheduleExpressionTimezone: props.schedule.timeZone?.timezoneName,
       groupName: this.group?.groupName,
+      state: props.enabled == null ? 'ENABLED' : (props.enabled ? 'ENABLED' : 'DISABLED'),
       target: {
         arn: targetConfig.arn,
         roleArn: targetConfig.role.roleArn,

packages/@aws-cdk/aws-scheduler-alpha/test/schedule.test.ts

@@ -0,0 +1,63 @@
+import { App, Stack } from 'aws-cdk-lib';
+
+import { Template } from 'aws-cdk-lib/assertions';
+import * as iam from 'aws-cdk-lib/aws-iam';
+import * as lambda from 'aws-cdk-lib/aws-lambda';
+import { IScheduleTarget, Schedule, ScheduleTargetConfig } from '../lib';
+import { ScheduleExpression } from '../lib/schedule-expression';
+
+class SomeLambdaTarget implements IScheduleTarget {
+  public constructor(private readonly fn: lambda.IFunction, private readonly role: iam.IRole) {
+  }
+
+  public bind(): ScheduleTargetConfig {
+    return {
+      arn: this.fn.functionArn,
+      role: this.role,
+    };
+  }
+}
+
+describe('Schedule', () => {
+  let stack: Stack;
+  let func: lambda.IFunction;
+  const expr = ScheduleExpression.at(new Date(Date.UTC(1969, 10, 20, 0, 0, 0)));
+
+  beforeEach(() => {
+    const app = new App();
+    stack = new Stack(app, 'Stack', { env: { region: 'us-east-1', account: '123456789012' } });
+    func = new lambda.Function(stack, 'MyLambda', {
+      code: new lambda.InlineCode('foo'),
+      handler: 'index.handler',
+      runtime: lambda.Runtime.NODEJS_LATEST,
+      tracing: lambda.Tracing.PASS_THROUGH,
+    });
+  });
+
+  test('schedule is enabled by default', () => {
+    // WHEN
+    const schedule = new Schedule(stack, 'TestSchedule', {
+      schedule: expr,
+      target: new SomeLambdaTarget(func, iam.Role.fromRoleArn(stack, 'ImportedRole', 'arn:aws:iam::123456789012:role/someRole')),
+    });
+
+    // THEN
+    Template.fromStack(stack).hasResourceProperties('AWS::Scheduler::Schedule', {
+      State: 'ENABLED',
+    });
+  });
+
+  test('schedule can be disabled', () => {
+    // WHEN
+    const schedule = new Schedule(stack, 'TestSchedule', {
+      schedule: expr,
+      target: new SomeLambdaTarget(func, iam.Role.fromRoleArn(stack, 'ImportedRole', 'arn:aws:iam::123456789012:role/someRole')),
+      enabled: false,
+    });
+
+    // THEN
+    Template.fromStack(stack).hasResourceProperties('AWS::Scheduler::Schedule', {
+      State: 'DISABLED',
+    });
+  });
+});