software.amazon.awscdk.services.scheduler

Class CfnScheduleGroup

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.144Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnScheduleGroup.Builder A fluent builder for CfnScheduleGroup.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnScheduleGroup(Construct scope, java.lang.String id) Create a new `AWS::Scheduler::ScheduleGroup`.
	CfnScheduleGroup(Construct scope, java.lang.String id, CfnScheduleGroupProps props) Create a new `AWS::Scheduler::ScheduleGroup`.
protected	CfnScheduleGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnScheduleGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the schedule group.
java.lang.String	getAttrCreationDate() The date and time at which the schedule group was created.
java.lang.String	getAttrLastModificationDate() The time at which the schedule group was last modified.
java.lang.String	getAttrState() Specifies the state of the schedule group.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getName() The name of the schedule group.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setName(java.lang.String value) The name of the schedule group.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnScheduleGroup

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

CfnScheduleGroup

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

CfnScheduleGroup

public CfnScheduleGroup(Construct scope,
                        java.lang.String id,
                        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

public CfnScheduleGroup(Construct scope,
                        java.lang.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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getAttrCreationDate

public java.lang.String getAttrCreationDate()

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

getAttrLastModificationDate

public java.lang.String getAttrLastModificationDate()

The time at which the schedule group was last modified.

getAttrState

public java.lang.String getAttrState()

Specifies the state of the schedule group.

Allowed Values : ACTIVE | DELETING

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

For more information, see Tag .

getName

public java.lang.String getName()

The name of the schedule group.

setName

public void setName(java.lang.String value)

The name of the schedule group.