(scheduler-alpha): Schedule description is not set

[WtfJoke]

Describe the bug

If you specify a description on a schedule its not set in the created Scheduled Rule.

Regression Issue

• Select this option if this issue appears to be a regression.

Last Known Working CDK Version

No response

Expected Behavior

I would have expected that the description of a schedule will be set.

Current Behavior

The schedule is created without description

Reproduction Steps

import { Schedule, ScheduleExpression} from "@aws-cdk/aws-scheduler-alpha";
import { StepFunctionsStartExecution } from "@aws-cdk/aws-scheduler-targets-alpha";

new Schedule(scope, "SomeSchedule", {
        description: `Some description`,
        schedule: ScheduleExpression.rate(Duration.days(7)),
        target: new StepFunctionsStartExecution(someSfn, {}),
});

Possible Solution

Set field description of CfnSchedule in Schedule here:

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

Lines 328 to 329 in 34dcc5a

	const resource = new CfnSchedule(this, 'Resource', {
	name: this.physicalName,

Additional Information/Context

No response

CDK CLI Version

2.150.0

Framework Version

No response

Node.js Version

20.17.0

OS

windows 11

Language

TypeScript

Language Version

5.5.4

Other information

No response

[ashishdhingra]

Reproducible using code below:

import * as cdk from 'aws-cdk-lib';
import * as sfn from 'aws-cdk-lib/aws-stepfunctions';
import * as lambda from 'aws-cdk-lib/aws-lambda';
import * as stepfunction from 'aws-cdk-lib/aws-stepfunctions';
import * as stepfunctiontasks from 'aws-cdk-lib/aws-stepfunctions-tasks';
import * as scheduler from '@aws-cdk/aws-scheduler-alpha';
import * as schedulertargets from '@aws-cdk/aws-scheduler-targets-alpha';

export class CdktestStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const helloFunction = new lambda.Function(this, 'MyLambdaFunction', {
      code: lambda.Code.fromInline(`
            exports.handler = (event, context, callback) => {
                callback(null, "Hello World!");
            };
        `),
      runtime: lambda.Runtime.NODEJS_18_X,
      handler: "index.handler",
      timeout: cdk.Duration.seconds(3)
    });
    const stateMachine = new stepfunction.StateMachine(this, 'MyStateMachine', {
      definition: new stepfunctiontasks.LambdaInvoke(this, "MyLambdaTask", {
        lambdaFunction: helloFunction
      }).next(new sfn.Succeed(this, "GreetedWorld"))
    });

    new scheduler.Schedule(this, "SomeSchedule", {
      description: `Some description`,
      schedule: scheduler.ScheduleExpression.rate(cdk.Duration.days(7)),
      target: new schedulertargets.StepFunctionsStartExecution(stateMachine, {}),
    });
  }
}

Running cdk synth generates following CFN template:

...
  SomeSchedule2B2B2075:
    Type: AWS::Scheduler::Schedule
    Properties:
      FlexibleTimeWindow:
        Mode: "OFF"
      ScheduleExpression: rate(7 days)
      ScheduleExpressionTimezone: Etc/UTC
      State: ENABLED
      Target:
        Arn:
          Ref: MyStateMachine6C968CA5
        RetryPolicy:
          MaximumEventAgeInSeconds: 86400
          MaximumRetryAttempts: 185
        RoleArn:
          Fn::GetAtt:
            - SchedulerRoleForTarget1441a743A31888
            - Arn
    Metadata:
      aws:cdk:path: CdktestStack/SomeSchedule/Resource
...

Description is not emitted for AWS::Scheduler::Schedule.

Looks like ScheduleProps.description is not used to set Description while creating CfnSchedule object here.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.