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-codedeploy-api

AWS CodeDeploy Load Balancing API

This package contains the abstract API of Load Balancers as required by the AWS CodeDeploy Construct Library.

You should never need to depend on it directly - instead, depend on the aws-codedeploy package.

Reference

View in Nuget

csproj:

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

dotnet:

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

packages.config:

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

View in Maven Central

Apache Buildr:

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

Apache Ivy:

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

Apache Maven:

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

Gradle / Grails:

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

Groovy Grape:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

View in NPM

npm:

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

package.json:

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

yarn:

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

ILoadBalancer (interface)

class @aws-cdk/aws-codedeploy-api.ILoadBalancer

Language-specific names:

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

An interface of an abstract laod balancer, as needed by CodeDeploy.

asCodeDeployLoadBalancer() → @aws-cdk/aws-codedeploy-api.ILoadBalancerProps

Specify the CodeDeploy-required properties of this load balancer.

Return type:ILoadBalancerProps
Abstract:Yes

ILoadBalancerProps (interface)

class @aws-cdk/aws-codedeploy-api.ILoadBalancerProps

Language-specific names:

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

The properties CodeDeploy requires of a load balancer.

generation
Type:LoadBalancerGeneration
name
Type:string

LoadBalancerGeneration (enum)

class @aws-cdk/aws-codedeploy-api.LoadBalancerGeneration

Language-specific names:

using Amazon.CDK.AWS.CodeDeploy.Api;
import software.amazon.awscdk.services.codedeploy.api.LoadBalancerGeneration;
const { LoadBalancerGeneration } = require('@aws-cdk/aws-codedeploy-api');
import { LoadBalancerGeneration } from '@aws-cdk/aws-codedeploy-api';

The generations of AWS load balancing solutions.

First

The first generation (ELB Classic).

Second

The second generation (ALB and NLB).