Class: AWSCDK::AutoScalingHookTargets::QueueHook

Inherits:

Jsii::Object

• Object
• Jsii::Object
• AWSCDK::AutoScalingHookTargets::QueueHook

Includes:

AWSCDK::Autoscaling::ILifecycleHookTarget

Defined in:

auto_scaling_hook_targets/queue_hook.rb

Overview

Use an SQS queue as a hook target.

Class Method Summary

• .jsii_overridable_methods ⇒ Object

Instance Method Summary

• #bind(_scope, options) ⇒ AWSCDK::Autoscaling::LifecycleHookTargetConfig

  If an IRole is found in options, grant it access to send messages.

• #initialize(queue) ⇒ QueueHook constructor

  A new instance of QueueHook.

Constructor Details

#initialize(queue) ⇒ QueueHook

Returns a new instance of QueueHook.

Parameters:

• queue (AWSCDK::SQS::IQueue)

# File 'auto_scaling_hook_targets/queue_hook.rb', line 10

def initialize(queue)
  Jsii::Type.check_type(queue, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3FzLklRdWV1ZSJ9")), "queue")
  Jsii::Object.instance_method(:initialize).bind(self).call(queue)
end

Class Method Details

.jsii_overridable_methods ⇒ Object

# File 'auto_scaling_hook_targets/queue_hook.rb', line 15

def self.jsii_overridable_methods
  {
    :bind => { kind: :method, name: "bind", is_optional: false },
  }
end

Instance Method Details

#bind(_scope, options) ⇒ AWSCDK::Autoscaling::LifecycleHookTargetConfig

If an IRole is found in options, grant it access to send messages.

Otherwise, create a new IRole and grant it access to send messages.

Parameters:

• _scope (Constructs::Construct)
• options (AWSCDK::Autoscaling::BindHookTargetOptions)

Returns:

• (AWSCDK::Autoscaling::LifecycleHookTargetConfig) —

  the IRole with access to send messages and the ARN of the queue it has access to send messages to.

# File 'auto_scaling_hook_targets/queue_hook.rb', line 28

def bind(_scope, options)
  Jsii::Type.check_type(_scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "_scope")
  options = options.is_a?(Hash) ? ::AWSCDK::Autoscaling::BindHookTargetOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXV0b3NjYWxpbmcuQmluZEhvb2tUYXJnZXRPcHRpb25zIn0=")), "options")
  jsii_call_method("bind", [_scope, options])
end