Package software.amazon.awscdk.services.scheduler

Class CfnScheduleGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.scheduler.CfnScheduleGroup
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IScheduleGroupRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:45.308Z") @Stability(Stable) public class CfnScheduleGroup extends CfnResource implements IInspectable, IScheduleGroupRef, ITaggable
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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.scheduler.*;
 CfnScheduleGroup cfnScheduleGroup = CfnScheduleGroup.Builder.create(this, "MyCfnScheduleGroup")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnScheduleGroup

      protected CfnScheduleGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnScheduleGroup

      protected CfnScheduleGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnScheduleGroup

      @Stability(Stable) public CfnScheduleGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnScheduleGroupProps props)
      Create a new AWS::Scheduler::ScheduleGroup.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnScheduleGroup

      @Stability(Stable) public CfnScheduleGroup(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::Scheduler::ScheduleGroup.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForScheduleGroup

      @Stability(Stable) @NotNull public static String arnForScheduleGroup(@NotNull IScheduleGroupRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnScheduleGroup

      @Stability(Stable) @NotNull public static Boolean isCfnScheduleGroup(@NotNull Object x)
      Checks whether the given object is a CfnScheduleGroup.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the schedule group.

    • getAttrCreationDate

      @Stability(Stable) @NotNull public String getAttrCreationDate()
      The date and time at which the schedule group was created.

    • getAttrLastModificationDate

      @Stability(Stable) @NotNull public String getAttrLastModificationDate()
      The time at which the schedule group was last modified.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      Specifies the state of the schedule group.

      Allowed Values : ACTIVE | DELETING

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getScheduleGroupRef

      @Stability(Stable) @NotNull public ScheduleGroupReference getScheduleGroupRef()
      A reference to a ScheduleGroup resource.
      Specified by:
      getScheduleGroupRef in interface IScheduleGroupRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the schedule group.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the schedule group.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.