Package software.amazon.awscdk.services.scheduler

Class CfnScheduleGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.scheduler.CfnScheduleGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.731Z") @Stability(Stable) public class CfnScheduleGroup extends CfnResource implements IInspectable
A CloudFormation 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 .

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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnScheduleGroup

      @Stability(Stable) public CfnScheduleGroup(@NotNull 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 -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • 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.