This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-autoscaling-api

AWS AutoScaling API Library

This is a sister package to @aws-cdk/aws-autoscaling. It contains interface definitions that cannot be placed inside the other package to avoid dependency cycles.

It does not need to be used directly.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.AutoScaling.Api" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.AutoScaling.Api --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.AutoScaling.Api" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:autoscaling-api:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="autoscaling-api" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>autoscaling-api</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:autoscaling-api:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='autoscaling-api', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-autoscaling-api@0.25.3

package.json:

{
  "@aws-cdk/aws-autoscaling-api": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-autoscaling-api@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-autoscaling-api@0.25.3

package.json:

{
  "@aws-cdk/aws-autoscaling-api": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-autoscaling-api@0.25.3

ILifecycleHook (interface)

class @aws-cdk/aws-autoscaling-api.ILifecycleHook

Language-specific names:

using Amazon.CDK.AWS.AutoScaling.Api;
import software.amazon.awscdk.services.autoscaling.api.ILifecycleHook;
// ILifecycleHook is an interface
import { ILifecycleHook } from '@aws-cdk/aws-autoscaling-api';

A basic lifecycle hook object

role

The role for the lifecycle hook to execute

Type:@aws-cdk/aws-iam.IRole (readonly)

ILifecycleHookTarget (interface)

class @aws-cdk/aws-autoscaling-api.ILifecycleHookTarget

Language-specific names:

using Amazon.CDK.AWS.AutoScaling.Api;
import software.amazon.awscdk.services.autoscaling.api.ILifecycleHookTarget;
// ILifecycleHookTarget is an interface
import { ILifecycleHookTarget } from '@aws-cdk/aws-autoscaling-api';

Interface for autoscaling lifecycle hook targets

asLifecycleHookTarget(lifecycleHook) → @aws-cdk/aws-autoscaling-api.LifecycleHookTargetProps

Called when this object is used as the target of a lifecycle hook

Parameters:lifecycleHook (ILifecycleHook) –
Return type:LifecycleHookTargetProps
Abstract:Yes

LifecycleHookTargetProps (interface)

class @aws-cdk/aws-autoscaling-api.LifecycleHookTargetProps

Language-specific names:

using Amazon.CDK.AWS.AutoScaling.Api;
import software.amazon.awscdk.services.autoscaling.api.LifecycleHookTargetProps;
// LifecycleHookTargetProps is an interface
import { LifecycleHookTargetProps } from '@aws-cdk/aws-autoscaling-api';

Properties to add the target to a lifecycle hook

notificationTargetArn

The ARN to use as the notification target

Type:string