Package software.amazon.awscdk.services.autoscaling

Interface BindHookTargetOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BindHookTargetOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:04.593Z")
@Stability(Stable)
public interface BindHookTargetOptions
extends software.amazon.jsii.JsiiSerializable

Options needed to bind a target to a lifecycle hook.

[disable-awslint:ref-via-interface] The lifecycle hook to attach to and an IRole to use

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.*;
 import software.amazon.awscdk.services.iam.*;
 LifecycleHook lifecycleHook;
 Role role;
 BindHookTargetOptions bindHookTargetOptions = BindHookTargetOptions.builder()
         .lifecycleHook(lifecycleHook)
         // the properties below are optional
         .role(role)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BindHookTargetOptions.Builder	A builder for BindHookTargetOptions
static final class	BindHookTargetOptions.Jsii$Proxy	An implementation for BindHookTargetOptions

Method Summary

Modifier and Type	Method	Description
static BindHookTargetOptions.Builder	builder()
LifecycleHook	getLifecycleHook()	The lifecycle hook to attach to.
default IRole	getRole()	The role to use when attaching to the lifecycle hook.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLifecycleHook

@Stability(Stable)
@NotNull
LifecycleHook getLifecycleHook()

The lifecycle hook to attach to.

[disable-awslint:ref-via-interface]

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

The role to use when attaching to the lifecycle hook.

[disable-awslint:ref-via-interface]

Default: : a role is not created unless the target arn is specified

builder

@Stability(Stable)
static BindHookTargetOptions.Builder builder()

Returns:

a BindHookTargetOptions.Builder of BindHookTargetOptions