Module: AWSCDK::Autoscaling::ILifecycleHook

Includes:
IResource, Interfaces::AWSAutoscaling::ILifecycleHookRef
Included in:
LifecycleHook
Defined in:
autoscaling/i_lifecycle_hook.rb

Overview

A basic lifecycle hook object.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
 
# File 'autoscaling/i_lifecycle_hook.rb', line 84

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :lifecycle_hook_ref => { kind: :property, name: "lifecycleHookRef", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :role => { kind: :property, name: "role", is_optional: false },
    :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:



79
80
81
82
 
# File 'autoscaling/i_lifecycle_hook.rb', line 79

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 'autoscaling/i_lifecycle_hook.rb', line 27

def env()
  jsii_get_property("env")
end

#lifecycle_hook_ref ⇒ AWSCDK::Interfaces::AWSAutoscaling::LifecycleHookReference

A reference to a LifecycleHook resource.

Returns:



34
35
36
 
# File 'autoscaling/i_lifecycle_hook.rb', line 34

def lifecycle_hook_ref()
  jsii_get_property("lifecycleHookRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'autoscaling/i_lifecycle_hook.rb', line 12

def node()
  jsii_get_property("node")
end

#role ⇒ AWSCDK::IAM::IRole

Note:

Default: - A default role is created if 'notificationTarget' is specified. Otherwise, no role is created.

The role for the lifecycle hook to execute.

Returns:



49
50
51
 
# File 'autoscaling/i_lifecycle_hook.rb', line 49

def role()
  jsii_get_property("role")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



41
42
43
 
# File 'autoscaling/i_lifecycle_hook.rb', line 41

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



60
61
62
63
64
65
 
# File 'autoscaling/i_lifecycle_hook.rb', line 60

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