Module: AWSCDK::Scheduler::ISchedule

Includes:
IResource, Interfaces::AWSScheduler::IScheduleRef
Included in:
Schedule
Defined in:
scheduler/i_schedule.rb

Overview

Interface representing a created or an imported Schedule.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'scheduler/i_schedule.rb', line 97

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :schedule_ref => { kind: :property, name: "scheduleRef", is_optional: false },
    :schedule_arn => { kind: :property, name: "scheduleArn", is_optional: false },
    :schedule_name => { kind: :property, name: "scheduleName", is_optional: false },
    :schedule_group => { kind: :property, name: "scheduleGroup", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



92
93
94
95
 
# File 'scheduler/i_schedule.rb', line 92

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



27
28
29
 
# File 'scheduler/i_schedule.rb', line 27

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'scheduler/i_schedule.rb', line 12

def node()
  jsii_get_property("node")
end

#schedule_arn ⇒ String

The arn of the schedule.

Returns:

  • (String) 


48
49
50
 
# File 'scheduler/i_schedule.rb', line 48

def schedule_arn()
  jsii_get_property("scheduleArn")
end

#schedule_group ⇒ AWSCDK::Scheduler::IScheduleGroup?

The schedule group associated with this schedule.

Returns:



62
63
64
 
# File 'scheduler/i_schedule.rb', line 62

def schedule_group()
  jsii_get_property("scheduleGroup")
end

#schedule_name ⇒ String

The name of the schedule.

Returns:

  • (String) 


55
56
57
 
# File 'scheduler/i_schedule.rb', line 55

def schedule_name()
  jsii_get_property("scheduleName")
end

#schedule_ref ⇒ AWSCDK::Interfaces::AWSScheduler::ScheduleReference

A reference to a Schedule resource.

Returns:



41
42
43
 
# File 'scheduler/i_schedule.rb', line 41

def schedule_ref()
  jsii_get_property("scheduleRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'scheduler/i_schedule.rb', line 34

def stack()
  jsii_get_property("stack")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



73
74
75
76
77
78
 
# File 'scheduler/i_schedule.rb', line 73

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end