fix(scheduler-alpha): deprecate Group in favour of ScheduleGroup

packages/@aws-cdk/aws-scheduler-alpha/README.md

@@ -100,22 +100,22 @@ const oneTimeSchedule = new Schedule(this, 'Schedule', {
 Your AWS account comes with a default scheduler group. You can access the default group in CDK with:
 
 ```ts
-const defaultGroup = Group.fromDefaultGroup(this, "DefaultGroup");
+const defaultScheduleGroup = ScheduleGroup.fromDefaultScheduleGroup(this, "DefaultGroup");
 ```
 
 You can add a schedule to a custom scheduling group managed by you. If a custom group is not specified, the schedule is added to the default group.
 
 ```ts
 declare const target: targets.LambdaInvoke;
 
-const group = new Group(this, "Group", {
-    groupName: "MyGroup",
+const scheduleGroup = new ScheduleGroup(this, "ScheduleGroup", {
+    scheduleGroupName: "MyScheduleGroup",
 });
 
 new Schedule(this, 'Schedule', {
     schedule: ScheduleExpression.rate(Duration.minutes(10)),
     target,
-    group,
+    scheduleGroup,
 });
 ```
 
@@ -300,25 +300,25 @@ new cloudwatch.Alarm(this, 'SchedulesErrorAlarm', {
 });
  ```
 
-### Metrics for a Group
+### Metrics for a Schedule Group
 
-To view metrics for a specific group you can use methods on class `Group`:
+To view metrics for a specific group you can use methods on class `ScheduleGroup`:
 
 ```ts
-const group = new Group(this, "Group", {
-    groupName: "MyGroup",
+const scheduleGroup = new ScheduleGroup(this, "ScheduleGroup", {
+    scheduleGroupName: "MyScheduleGroup",
 });
 
 new cloudwatch.Alarm(this, 'MyGroupErrorAlarm', {
-    metric: group.metricTargetErrors(),
+    metric: scheduleGroup.metricTargetErrors(),
     evaluationPeriods: 1,
     threshold: 0
 });
 
 // Or use default group
-const defaultGroup = Group.fromDefaultGroup(this, "DefaultGroup");
-new cloudwatch.Alarm(this, 'DefaultGroupErrorAlarm', {
-    metric: defaultGroup.metricTargetErrors(),
+const defaultScheduleGroup = ScheduleGroup.fromDefaultScheduleGroup(this, "DefaultScheduleGroup");
+new cloudwatch.Alarm(this, 'DefaultScheduleGroupErrorAlarm', {
+    metric: defaultScheduleGroup.metricTargetErrors(),
     evaluationPeriods: 1,
     threshold: 0
 });

packages/@aws-cdk/aws-scheduler-alpha/awslint.json

@@ -1,23 +1,10 @@
 {
   "exclude": [
-    "construct-ctor-props-optional:@aws-cdk/aws-scheduler-alpha.Group",
     "props-physical-name:@aws-cdk/aws-scheduler-alpha.GroupProps",
-    "from-method:@aws-cdk/aws-scheduler-alpha.Schedule",
-    "attribute-tag:@aws-cdk/aws-scheduler-alpha.Schedule.scheduleArn",
-    "attribute-tag:@aws-cdk/aws-scheduler-alpha.Schedule.scheduleName",
+    "attribute-tag:@aws-cdk/aws-scheduler-alpha.Schedule.scheduleGroup",
     "docs-public-apis:@aws-cdk/aws-scheduler-alpha.ContextAttribute.name",
     "docs-public-apis:@aws-cdk/aws-scheduler-alpha.Group",
     "docs-public-apis:@aws-cdk/aws-scheduler-alpha.GroupProps",
-    "docs-public-apis:@aws-cdk/aws-scheduler-alpha.IGroup",
-    "props-default-doc:@aws-cdk/aws-scheduler-alpha.ScheduleProps.targetOverrides",
-    "props-default-doc:@aws-cdk/aws-scheduler-alpha.ScheduleTargetConfig.deadLetterConfig",
-    "props-default-doc:@aws-cdk/aws-scheduler-alpha.ScheduleTargetConfig.ecsParameters",
-    "props-default-doc:@aws-cdk/aws-scheduler-alpha.ScheduleTargetConfig.eventBridgeParameters",
-    "props-default-doc:@aws-cdk/aws-scheduler-alpha.ScheduleTargetConfig.input",
-    "props-default-doc:@aws-cdk/aws-scheduler-alpha.ScheduleTargetConfig.kinesisParameters",
-    "props-default-doc:@aws-cdk/aws-scheduler-alpha.ScheduleTargetConfig.retryPolicy",
-    "props-default-doc:@aws-cdk/aws-scheduler-alpha.ScheduleTargetConfig.sageMakerPipelineParameters",
-    "props-default-doc:@aws-cdk/aws-scheduler-alpha.ScheduleTargetConfig.sqsParameters",
-    "docs-public-apis:@aws-cdk/aws-scheduler-alpha.ScheduleTargetProps"
+    "docs-public-apis:@aws-cdk/aws-scheduler-alpha.IGroup"
   ]
 }

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

@@ -290,6 +290,7 @@ abstract class GroupBase extends Resource implements IGroup {
 }
 /**
  * @resource AWS::Scheduler::ScheduleGroup
+ * @deprecated Use `ScheduleGroup` instead. `Group` will be removed when this module is stabilized.
  */
 export class Group extends GroupBase {
   /**
@@ -298,6 +299,7 @@ export class Group extends GroupBase {
    * @param scope construct scope
    * @param id construct id
    * @param groupArn the ARN of the group to import (e.g. `arn:aws:scheduler:region:account-id:schedule-group/group-name`)
+   * @deprecated Use `ScheduleGroup.fromScheduleGroupArn()` instead.
    */
   public static fromGroupArn(scope: Construct, id: string, groupArn: string): IGroup {
     const arnComponents = Stack.of(scope).splitArn(groupArn, ArnFormat.SLASH_RESOURCE_NAME);
@@ -314,6 +316,7 @@ export class Group extends GroupBase {
    *
    * @param scope construct scope
    * @param id construct id
+   * @deprecated Use `ScheduleGroup.fromDefaultScheduleGroup()` instead.
    */
   public static fromDefaultGroup(scope: Construct, id: string): IGroup {
     return Group.fromGroupName(scope, id, 'default');
@@ -325,6 +328,7 @@ export class Group extends GroupBase {
    * @param scope construct scope
    * @param id construct id
    * @param groupName the name of the existing group to import
+   * @deprecated Use `ScheduleGroup.fromScheduleGroupName()` instead.
    */
   public static fromGroupName(scope: Construct, id: string, groupName: string): IGroup {
     const groupArn = Stack.of(scope).formatArn({
@@ -338,12 +342,12 @@ export class Group extends GroupBase {
   public readonly groupName: string;
   public readonly groupArn: string;
 
-  public constructor(scope: Construct, id: string, props: GroupProps) {
+  public constructor(scope: Construct, id: string, props?: GroupProps) {
     super(scope, id);
     // Enhanced CDK Analytics Telemetry
     addConstructMetadata(this, props);
 
-    this.groupName = props.groupName ?? Names.uniqueResourceName(this, {
+    this.groupName = props?.groupName ?? Names.uniqueResourceName(this, {
       maxLength: 64,
       separator: '-',
     });
@@ -352,7 +356,7 @@ export class Group extends GroupBase {
       name: this.groupName,
     });
 
-    group.applyRemovalPolicy(props.removalPolicy);
+    group.applyRemovalPolicy(props?.removalPolicy);
 
     this.groupArn = this.getResourceArnAttribute(group.attrArn, {
       service: 'scheduler',

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

@@ -3,3 +3,4 @@ export * from './input';
 export * from './schedule';
 export * from './group';
 export * from './target';
+export * from './schedule-group';