aws-cdk-lib.aws_autoscaling.BindHookTargetOptions

interface BindHookTargetOptions

LanguageType name
.NETAmazon.CDK.AWS.AutoScaling.BindHookTargetOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsautoscaling#BindHookTargetOptions
Javasoftware.amazon.awscdk.services.autoscaling.BindHookTargetOptions
Pythonaws_cdk.aws_autoscaling.BindHookTargetOptions
TypeScript (source)aws-cdk-lib » aws_autoscaling » BindHookTargetOptions

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 { 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

NameTypeDescription
lifecycleHookLifecycleHookThe lifecycle hook to attach to.
role?IRoleThe role to use when attaching to the lifecycle hook.

lifecycleHook

Type: LifecycleHook

The lifecycle hook to attach to.

[disable-awslint:ref-via-interface]


role?

Type: IRole (optional, default: : a role is not created unless the target arn is specified)

The role to use when attaching to the lifecycle hook.

[disable-awslint:ref-via-interface]