aws-cdk-lib.aws_autoscaling.BindHookTargetOptions

BindHookTargetOptions Struct

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

Source

aws-autoscaling/lib/lifecycle-hook-target.ts

Type last changed

v2.2.0 · 15 Dec 2021

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const lifecycleHook: autoscaling.LifecycleHook;
declare const role: iam.Role;
const bindHookTargetOptions: autoscaling.BindHookTargetOptions = {
  lifecycleHook: lifecycleHook,

  // the properties below are optional
  role: role,
};

Properties

lifecycleHookLifecycleHooklifecycle_hookLifecycleHooklifecycleHookLifecycleHookLifecycleHookLifecycleHookLifecycleHookLifecycleHookrequired#

The lifecycle hook to attach to.

[disable-awslint:ref-via-interface]

role?optionalIRolerole?optionalIRolerole?optionalIRoleRole?optionalIRoleRole?optionalIRole#

The role to use when attaching to the lifecycle hook.

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

[disable-awslint:ref-via-interface]