Class: AWSCDK::Scheduler::ScheduleGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
scheduler/schedule_group_props.rb

Overview

Properties for a Schedule Group.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(removal_policy: nil, schedule_group_name: nil) ⇒ ScheduleGroupProps

Returns a new instance of ScheduleGroupProps.

Parameters:

  • removal_policy (AWSCDK::RemovalPolicy, nil) (defaults to: nil) —

    The removal policy for the group.

  • schedule_group_name (String, nil) (defaults to: nil) —

    The name of the schedule group.



9
10
11
12
13
14
 
# File 'scheduler/schedule_group_props.rb', line 9

def initialize(removal_policy: nil, schedule_group_name: nil)
  @removal_policy = removal_policy
  Jsii::Type.check_type(@removal_policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "removalPolicy") unless @removal_policy.nil?
  @schedule_group_name = schedule_group_name
  Jsii::Type.check_type(@schedule_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scheduleGroupName") unless @schedule_group_name.nil?
end

Instance Attribute Details

#removal_policy ⇒ AWSCDK::RemovalPolicy? (readonly)

Note:

Default: RemovalPolicy.RETAIN

The removal policy for the group.

If the group is removed also all schedules are removed.

Returns:



22
23
24
 
# File 'scheduler/schedule_group_props.rb', line 22

def removal_policy
  @removal_policy
end

#schedule_group_name ⇒ String? (readonly)

Note:

Default: - A unique name will be generated

The name of the schedule group.

Up to 64 letters (uppercase and lowercase), numbers, hyphens, underscores and dots are allowed.

Returns:

  • (String, nil) 


29
30
31
 
# File 'scheduler/schedule_group_props.rb', line 29

def schedule_group_name
  @schedule_group_name
end

Class Method Details

.jsii_properties ⇒ Object 



31
32
33
34
35
36
 
# File 'scheduler/schedule_group_props.rb', line 31

def self.jsii_properties
  {
    :removal_policy => "removalPolicy",
    :schedule_group_name => "scheduleGroupName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'scheduler/schedule_group_props.rb', line 38

def to_jsii
  result = {}
  result.merge!({
    "removalPolicy" => @removal_policy,
    "scheduleGroupName" => @schedule_group_name,
  })
  result.compact
end