AWS::Scheduler::ScheduleGroup

A schedule group is an Amazon EventBridge Scheduler resource you use to organize your schedules.

Your AWS account comes with a default scheduler group. You associate a new schedule with the default group or with schedule groups that you create and manage. You can create up to 500 schedule groups in your AWS account. With EventBridge Scheduler, you apply tags to schedule groups, not to individual schedules to organize your resources.

For more information about managing schedule groups, see Managing a schedule group in the EventBridge Scheduler User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Scheduler::ScheduleGroup",
  "Properties" : {
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Scheduler::ScheduleGroup
Properties:
  Name: String
  Tags: 
    - Tag

Properties

Name

The name of the schedule group.

Required: No

Type: String

Pattern: ^[0-9a-zA-Z-_.]+$

Minimum: 1

Maximum: 64

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Name attribute of the schedule group.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes that Fn::GetAtt returns. For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the schedule group.

CreationDate

The date and time at which the schedule group was created.

LastModificationDate

The time at which the schedule group was last modified.

State

Specifies the state of the schedule group.

Allowed Values: ACTIVE | DELETING