software.amazon.awscdk.services.autoscaling.hooktargets

Class QueueHook

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.autoscaling.hooktargets.QueueHook

All Implemented Interfaces:

ILifecycleHookTarget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.827Z")
 @Stability(value=Stable)
public class QueueHook
extends software.amazon.jsii.JsiiObject
implements ILifecycleHookTarget

Use an SQS queue as a hook target.

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.autoscaling.hooktargets.*;
 import software.amazon.awscdk.services.sqs.*;
 Queue queue;
 QueueHook queueHook = new QueueHook(queue);
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.autoscaling.ILifecycleHookTarget

ILifecycleHookTarget.Jsii$Default, ILifecycleHookTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	QueueHook(IQueue queue)
protected	QueueHook(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	QueueHook(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
LifecycleHookTargetConfig	bind(software.constructs.Construct _scope, BindHookTargetOptions options) If an `IRole` is found in `options`, grant it access to send messages.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

QueueHook

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

QueueHook

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

QueueHook

@Stability(value=Stable)
public QueueHook(@NotNull
                                          IQueue queue)

Parameters:

queue - This parameter is required.

Method Detail

bind

@Stability(value=Stable)
 @NotNull
public LifecycleHookTargetConfig bind(@NotNull
                                                                         software.constructs.Construct _scope,
                                                                         @NotNull
                                                                         BindHookTargetOptions options)

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.

Specified by:

bind in interface ILifecycleHookTarget

Parameters:

_scope - This parameter is required.

options - This parameter is required.

Returns:

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