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

AWS Application and Network Load Balancing Construct Library

The @aws-cdk/aws-elasticloadbalancingv2 package provides constructs for configuring application and network load balancers.

For more information, see the AWS documentation for Application Load Balancers and Network Load Balancers.

Defining an Application Load Balancer

You define an application load balancer by creating an instance of ApplicationLoadBalancer, adding a Listener to the load balancer and adding Targets to the Listener:

import ec2 = require('@aws-cdk/aws-ec2');
import elbv2 = require('@aws-cdk/aws-elasticloadbalancingv2');
import autoscaling = require('@aws-cdk/aws-autoscaling');

// ...

const vpc = new ec2.VpcNetwork(...);

// Create the load balancer in a VPC. 'internetFacing' is 'false'
// by default, which creates an internal load balancer.
const lb = new elbv2.ApplicationLoadBalancer(this, 'LB', {
    vpc,
    internetFacing: true
});

// Add a listener and open up the load balancer's security group
// to the world. 'open' is the default, set this to 'false'
// and use `listener.connections` if you want to be selective
// about who can access the listener.
const listener = lb.addListener('Listener', {
    port: 80,
    open: true,
});

// Create an AutoScaling group and add it as a load balancing
// target to the listener.
const asg = new autoscaling.AutoScalingGroup(...);
listener.addTargets('ApplicationFleet', {
    port: 8080,
    targets: [asg]
});

The security groups of the load balancer and the target are automatically updated to allow the network traffic.

Conditions

It’s possible to route traffic to targets based on conditions in the incoming HTTP request. Path- and host-based conditions are supported. For example, the following will route requests to the indicated AutoScalingGroup only if the requested host in the request is example.com:

listener.addTargets('Example.Com Fleet', {
    priority: 10,
    hostHeader: 'example.com',
    port: 8080,
    targets: [asg]
});

priority is a required field when you add targets with conditions. The lowest number wins.

Every listener must have at least one target without conditions.

Defining a Network Load Balancer

Network Load Balancers are defined in a similar way to Application Load Balancers:

import ec2 = require('@aws-cdk/aws-ec2');
import elbv2 = require('@aws-cdk/aws-elasticloadbalancingv2');
import autoscaling = require('@aws-cdk/aws-autoscaling');

// Create the load balancer in a VPC. 'internetFacing' is 'false'
// by default, which creates an internal load balancer.
const lb = new elbv2.NetworkLoadBalancer(this, 'LB', {
    vpc,
    internetFacing: true
});

// Add a listener on a particular port.
const listener = lb.addListener('Listener', {
    port: 443,
});

// Add targets on a particular port.
listener.addTargets('AppFleet', {
    port: 443,
    targets: [asg]
});

One thing to keep in mind is that network load balancers do not have security groups, and no automatic security group configuration is done for you. You will have to configure the security groups of the target yourself to allow traffic by clients and/or load balancer instances, depending on your target types. See Target Groups for your Network Load Balancers and Register targets with your Target Group for more information.

Targets and Target Groups

Application and Network Load Balancers organize load balancing targets in Target Groups. If you add your balancing targets (such as AutoScalingGroups, ECS services or individual instances) to your listener directly, the appropriate TargetGroup will be automatically created for you.

If you need more control over the Target Groups created, create an instance of ApplicationTargetGroup or NetworkTargetGroup, add the members you desire, and add it to the listener by calling addTargetGroups instead of addTargets.

addTargets() will always return the Target Group it just created for you:

const group = listener.addTargets('AppFleet', {
    port: 443,
    targets: [asg1],
});

group.addTarget(asg2);

Configuring Health Checks

Health checks are configured upon creation of a target group:

listener.addTargets('AppFleet', {
    port: 8080,
    targets: [asg],
    healthCheck: {
        path: '/ping',
        intervalSecs: 60,
    }
});

The health check can also be configured after creation by calling configureHealthCheck() on the created object.

No attempts are made to configure security groups for the port you’re configuring a health check for, but if the health check is on the same port you’re routing traffic to, the security group already allows the traffic. If not, you will have to configure the security groups appropriately:

listener.addTargets('AppFleet', {
    port: 8080,
    targets: [asg],
    healthCheck: {
        port: 8088,
    }
});

listener.connections.allowFrom(lb, new TcpPort(8088));

Protocol for Load Balancer Targets

Constructs that want to be a load balancer target should implement IApplicationLoadBalancerTarget and/or INetworkLoadBalancerTarget, and provide an implementation for the function attachToXxxTargetGroup(), which can call functions on the load balancer and should return metadata about the load balancing target:

public attachToApplicationTargetGroup(targetGroup: ApplicationTargetGroup): LoadBalancerTargetProps {
    targetGroup.registerConnectable(...);
    return {
        targetType: TargetType.Instance | TargetType.Ip
        targetJson: { id: ..., port: ... },
    };
}

targetType should be one of Instance or Ip. If the target can be directly added to the target group, targetJson should contain the id of the target (either instance ID or IP address depending on the type) and optionally a port or availabilityZone override.

Application load balancer targets can call registerConnectable() on the target group to register themselves for addition to the load balancer’s security group rules.

If your load balancer target requires that the TargetGroup has been associated with a LoadBalancer before registration can happen (such as is the case for ECS Services for example), take a resource dependency on targetGroup.loadBalancerDependency() as follows:

// Make sure that the listener has been created, and so the TargetGroup
// has been associated with the LoadBalancer, before 'resource' is created.
resourced.addDependency(targetGroup.loadBalancerDependency());

Reference

View in Nuget

csproj:

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

dotnet:

dotnet add package Amazon.CDK.AWS.ElasticLoadBalancingV2 --version 0.25.3

packages.config:

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

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:elasticloadbalancingv2:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="elasticloadbalancingv2" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>elasticloadbalancingv2</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:elasticloadbalancingv2:0.25.3'

Groovy Grape:

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

View in NPM

npm:

$ npm i @aws-cdk/aws-elasticloadbalancingv2@0.25.3

package.json:

{
  "@aws-cdk/aws-elasticloadbalancingv2": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-elasticloadbalancingv2@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-elasticloadbalancingv2@0.25.3

package.json:

{
  "@aws-cdk/aws-elasticloadbalancingv2": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-elasticloadbalancingv2@0.25.3

AddApplicationTargetGroupsProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.AddApplicationTargetGroupsProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.AddApplicationTargetGroupsProps;
// AddApplicationTargetGroupsProps is an interface
import { AddApplicationTargetGroupsProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for adding a new target group to a listener

Extends:AddRuleProps
targetGroups

Target groups to forward requests to

Type:IApplicationTargetGroup[]
hostHeader

Inherited from @aws-cdk/aws-elasticloadbalancingv2.AddRuleProps

Rule applies if the requested host matches the indicated host

May contain up to three ‘*’ wildcards.

Requires that priority is set.

Type:string (optional)
Default:No host condition
pathPattern

Inherited from @aws-cdk/aws-elasticloadbalancingv2.AddRuleProps

Rule applies if the requested path matches the given path pattern

May contain up to three ‘*’ wildcards.

Requires that priority is set.

Type:string (optional)
Default:No path condition
priority

Inherited from @aws-cdk/aws-elasticloadbalancingv2.AddRuleProps

Priority of this target group

The rule with the lowest priority will be used for every request.

If priority is not given, these target groups will be added as

defaults, and must not have conditions.

Priorities must be unique.

Type:number (optional)
Default:Target groups are used as defaults

AddApplicationTargetsProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.AddApplicationTargetsProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.AddApplicationTargetsProps;
// AddApplicationTargetsProps is an interface
import { AddApplicationTargetsProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for adding new targets to a listener

Extends:AddRuleProps
deregistrationDelaySec

The amount of time for Elastic Load Balancing to wait before deregistering a target.

The range is 0–3600 seconds.

Type:number (optional)
Default:300
healthCheck

Health check configuration

Type:HealthCheck (optional)
Default:No health check
port

The port on which the listener listens for requests.

Type:number (optional)
Default:Determined from protocol if known
protocol

The protocol to use

Type:ApplicationProtocol (optional)
Default:Determined from port if known
slowStartSec

The time period during which the load balancer sends a newly registered

target a linearly increasing share of the traffic to the target group.

The range is 30–900 seconds (15 minutes).

Type:number (optional)
Default:0
stickinessCookieDurationSec

The stickiness cookie expiration period.

Setting this value enables load balancer stickiness.

After this period, the cookie is considered stale. The minimum value is

1 second and the maximum value is 7 days (604800 seconds).

Type:number (optional)
Default:86400 (1 day)
targetGroupName

The name of the target group.

This name must be unique per region per account, can have a maximum of

32 characters, must contain only alphanumeric characters or hyphens, and

must not begin or end with a hyphen.

Type:string (optional)
Default:Automatically generated
targets

The targets to add to this target group.

Can be Instance, IPAddress, or any self-registering load balancing

target. If you use either Instance or IPAddress as targets, all

target must be of the same type.

Type:IApplicationLoadBalancerTarget[] (optional)
hostHeader

Inherited from @aws-cdk/aws-elasticloadbalancingv2.AddRuleProps

Rule applies if the requested host matches the indicated host

May contain up to three ‘*’ wildcards.

Requires that priority is set.

Type:string (optional)
Default:No host condition
pathPattern

Inherited from @aws-cdk/aws-elasticloadbalancingv2.AddRuleProps

Rule applies if the requested path matches the given path pattern

May contain up to three ‘*’ wildcards.

Requires that priority is set.

Type:string (optional)
Default:No path condition
priority

Inherited from @aws-cdk/aws-elasticloadbalancingv2.AddRuleProps

Priority of this target group

The rule with the lowest priority will be used for every request.

If priority is not given, these target groups will be added as

defaults, and must not have conditions.

Priorities must be unique.

Type:number (optional)
Default:Target groups are used as defaults

AddNetworkTargetsProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.AddNetworkTargetsProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.AddNetworkTargetsProps;
// AddNetworkTargetsProps is an interface
import { AddNetworkTargetsProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for adding new network targets to a listener

port

The port on which the listener listens for requests.

Type:number
Default:Determined from protocol if known
deregistrationDelaySec

The amount of time for Elastic Load Balancing to wait before deregistering a target.

The range is 0–3600 seconds.

Type:number (optional)
Default:300
healthCheck

Health check configuration

Type:HealthCheck (optional)
Default:No health check
proxyProtocolV2

Indicates whether Proxy Protocol version 2 is enabled.

Type:boolean (optional)
Default:false
targetGroupName

The name of the target group.

This name must be unique per region per account, can have a maximum of

32 characters, must contain only alphanumeric characters or hyphens, and

must not begin or end with a hyphen.

Type:string (optional)
Default:Automatically generated
targets

The targets to add to this target group.

Can be Instance, IPAddress, or any self-registering load balancing

target. If you use either Instance or IPAddress as targets, all

target must be of the same type.

Type:INetworkLoadBalancerTarget[] (optional)

AddRuleProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.AddRuleProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.AddRuleProps;
// AddRuleProps is an interface
import { AddRuleProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for adding a conditional load balancing rule

hostHeader

Rule applies if the requested host matches the indicated host

May contain up to three ‘*’ wildcards.

Requires that priority is set.

Type:string (optional)
Default:No host condition
pathPattern

Rule applies if the requested path matches the given path pattern

May contain up to three ‘*’ wildcards.

Requires that priority is set.

Type:string (optional)
Default:No path condition
priority

Priority of this target group

The rule with the lowest priority will be used for every request.

If priority is not given, these target groups will be added as

defaults, and must not have conditions.

Priorities must be unique.

Type:number (optional)
Default:Target groups are used as defaults

ApplicationListener

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationListener(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListener;
const { ApplicationListener } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { ApplicationListener } from '@aws-cdk/aws-elasticloadbalancingv2';

Define an ApplicationListener

Extends:

BaseListener

Implements:

IApplicationListener

Parameters:
static import(scope, id, props) → @aws-cdk/aws-elasticloadbalancingv2.IApplicationListener

Import an existing listener

Parameters:
Return type:

IApplicationListener

addCertificateArns(_id, arns)

Implements @aws-cdk/aws-elasticloadbalancingv2.IApplicationListener.addCertificateArns()

Add one or more certificates to this listener.

Parameters:
  • _id (string) –
  • arns (string[]) –
addTargetGroups(id, props)

Implements @aws-cdk/aws-elasticloadbalancingv2.IApplicationListener.addTargetGroups()

Load balance incoming requests to the given target groups.

It’s possible to add conditions to the TargetGroups added in this way.

At least one TargetGroup must be added without conditions.

Parameters:
addTargets(id, props) → @aws-cdk/aws-elasticloadbalancingv2.ApplicationTargetGroup

Implements @aws-cdk/aws-elasticloadbalancingv2.IApplicationListener.addTargets()

Load balance incoming requests to the given load balancing targets.

This method implicitly creates an ApplicationTargetGroup for the targets

involved.

It’s possible to add conditions to the targets added in this way. At least

one set of targets must be added without conditions.

Parameters:
Returns:

The newly created target group

Return type:

ApplicationTargetGroup

export() → @aws-cdk/aws-elasticloadbalancingv2.ApplicationListenerImportProps

Implements @aws-cdk/aws-elasticloadbalancingv2.IApplicationListener.export()

Export this listener

Return type:ApplicationListenerImportProps
registerConnectable(connectable, portRange)

Implements @aws-cdk/aws-elasticloadbalancingv2.IApplicationListener.registerConnectable()

Register that a connectable that has been added to this load balancer.

Don’t call this directly. It is called by ApplicationTargetGroup.

Parameters:
validate() → string[]

Overrides @aws-cdk/aws-elasticloadbalancingv2.BaseListener.validate()

Validate this listener.

Protected method

Return type:string[]
connections

Implements @aws-cdk/aws-ec2.IConnectable.connections()

Manage connections to this ApplicationListener

Type:@aws-cdk/aws-ec2.Connections (readonly)
loadBalancer

Load balancer this listener is associated with

Type:IApplicationLoadBalancer (readonly)
listenerArn

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseListener

Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ApplicationListenerCertificate

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationListenerCertificate(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListenerCertificate;
const { ApplicationListenerCertificate } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { ApplicationListenerCertificate } from '@aws-cdk/aws-elasticloadbalancingv2';

Add certificates to a listener

Extends:

@aws-cdk/cdk.Construct

Parameters:
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ApplicationListenerCertificateProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationListenerCertificateProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListenerCertificateProps;
// ApplicationListenerCertificateProps is an interface
import { ApplicationListenerCertificateProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for adding a set of certificates to a listener

certificateArns

ARNs of certificates to attach

Duplicates are not allowed.

Type:string[]
listener

The listener to attach the rule to

Type:IApplicationListener

ApplicationListenerImportProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationListenerImportProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListenerImportProps;
// ApplicationListenerImportProps is an interface
import { ApplicationListenerImportProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties to reference an existing listener

listenerArn

ARN of the listener

Type:string
securityGroupId

Security group ID of the load balancer this listener is associated with

Type:string
defaultPort

The default port on which this listener is listening

Type:string (optional)

ApplicationListenerProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationListenerProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListenerProps;
// ApplicationListenerProps is an interface
import { ApplicationListenerProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for defining a standalone ApplicationListener

Extends:BaseApplicationListenerProps
loadBalancer

The load balancer to attach this listener to

Type:IApplicationLoadBalancer
certificateArns

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerProps

The certificates to use on this listener

Type:string[] (optional)
defaultTargetGroups

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerProps

Default target groups to load balance to

Type:IApplicationTargetGroup[] (optional)
Default:None
open

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerProps

Allow anyone to connect to this listener

If this is specified, the listener will be opened up to anyone who can reach it.

For internal load balancers this is anyone in the same VPC. For public load

balancers, this is anyone on the internet.

If you want to be more selective about who can access this load

balancer, set this to false and use the listener’s connections

object to selectively grant access to the listener.

Type:boolean (optional)
Default:true
port

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerProps

The port on which the listener listens for requests.

Type:number (optional)
Default:Determined from protocol if known
protocol

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerProps

The protocol to use

Type:ApplicationProtocol (optional)
Default:Determined from port if known
sslPolicy

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerProps

The security policy that defines which ciphers and protocols are supported.

Type:SslPolicy (optional)
Default:the current predefined security policy.

ApplicationListenerRule

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationListenerRule(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListenerRule;
const { ApplicationListenerRule } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { ApplicationListenerRule } from '@aws-cdk/aws-elasticloadbalancingv2';

Define a new listener rule

Extends:

@aws-cdk/cdk.Construct

Parameters:
addTargetGroup(targetGroup)

Add a TargetGroup to load balance to

Parameters:targetGroup (IApplicationTargetGroup) –
setCondition(field[, values])

Add a non-standard condition to this rule

Parameters:
  • field (string) –
  • values (string[] (optional)) –
validate() → string[]

Overrides @aws-cdk/cdk.Construct.validate()

Validate the rule

Protected method

Return type:string[]
listenerRuleArn

The ARN of this rule

Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ApplicationListenerRuleProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationListenerRuleProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListenerRuleProps;
// ApplicationListenerRuleProps is an interface
import { ApplicationListenerRuleProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for defining a listener rule

Extends:BaseApplicationListenerRuleProps
listener

The listener to attach the rule to

Type:IApplicationListener
priority

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerRuleProps

Priority of the rule

The rule with the lowest priority will be used for every request.

Priorities must be unique.

Type:number
hostHeader

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerRuleProps

Rule applies if the requested host matches the indicated host

May contain up to three ‘*’ wildcards.

Type:string (optional)
Default:No host condition
pathPattern

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerRuleProps

Rule applies if the requested path matches the given path pattern

May contain up to three ‘*’ wildcards.

Type:string (optional)
Default:No path condition
targetGroups

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerRuleProps

Target groups to forward requests to

Type:IApplicationTargetGroup[] (optional)

ApplicationLoadBalancer

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancer(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationLoadBalancer;
const { ApplicationLoadBalancer } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { ApplicationLoadBalancer } from '@aws-cdk/aws-elasticloadbalancingv2';

Define an Application Load Balancer

Extends:

BaseLoadBalancer

Implements:

IApplicationLoadBalancer

Parameters:
static import(scope, id, props) → @aws-cdk/aws-elasticloadbalancingv2.IApplicationLoadBalancer

Import an existing Application Load Balancer

Parameters:
Return type:

IApplicationLoadBalancer

addListener(id, props) → @aws-cdk/aws-elasticloadbalancingv2.ApplicationListener

Implements @aws-cdk/aws-elasticloadbalancingv2.IApplicationLoadBalancer.addListener()

Add a new listener to this load balancer

Parameters:
Return type:

ApplicationListener

export() → @aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancerImportProps

Implements @aws-cdk/aws-elasticloadbalancingv2.IApplicationLoadBalancer.export()

Export this load balancer

Return type:ApplicationLoadBalancerImportProps
logAccessLogs(bucket[, prefix])

Enable access logging for this load balancer

Parameters:
metric(metricName[, props]) → @aws-cdk/aws-cloudwatch.Metric

Return the given named metric for this Application Load Balancer

Parameters:
Return type:

@aws-cdk/aws-cloudwatch.Metric

metricActiveConnectionCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The total number of concurrent TCP connections active from clients to the

load balancer and from the load balancer to targets.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricClientTlsNegotiationErrorCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of TLS connections initiated by the client that did not

establish a session with the load balancer. Possible causes include a

mismatch of ciphers or protocols.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricConsumedLCUs([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of load balancer capacity units (LCU) used by your load balancer.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricElbAuthError([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of user authentications that could not be completed

Because an authenticate action was misconfigured, the load balancer

couldn’t establish a connection with the IdP, or the load balancer

couldn’t complete the authentication flow due to an internal error.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricElbAuthFailure([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of user authentications that could not be completed because the

IdP denied access to the user or an authorization code was used more than

once.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricElbAuthLatency([props]) → @aws-cdk/aws-cloudwatch.Metric

The time elapsed, in milliseconds, to query the IdP for the ID token and user info.

If one or more of these operations fail, this is the time to failure.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricElbAuthSuccess([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of authenticate actions that were successful.

This metric is incremented at the end of the authentication workflow,

after the load balancer has retrieved the user claims from the IdP.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricHttpCodeElb(code[, props]) → @aws-cdk/aws-cloudwatch.Metric

The number of HTTP 3xx/4xx/5xx codes that originate from the load balancer.

This does not include any response codes generated by the targets.

Parameters:
Return type:

@aws-cdk/aws-cloudwatch.Metric

metricHttpCodeTarget(code[, props]) → @aws-cdk/aws-cloudwatch.Metric

The number of HTTP 2xx/3xx/4xx/5xx response codes generated by all targets

in the load balancer.

This does not include any response codes generated by the load balancer.

Parameters:
Return type:

@aws-cdk/aws-cloudwatch.Metric

metricHttpFixedResponseCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of fixed-response actions that were successful.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricHttpRedirectCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of redirect actions that were successful.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricHttpRedirectUrlLimitExceededCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of redirect actions that couldn’t be completed because the URL

in the response location header is larger than 8K.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricIPv6ProcessedBytes([props]) → @aws-cdk/aws-cloudwatch.Metric

The total number of bytes processed by the load balancer over IPv6.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricIPv6RequestCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of IPv6 requests received by the load balancer.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricNewConnectionCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The total number of new TCP connections established from clients to the

load balancer and from the load balancer to targets.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricProcessedBytes([props]) → @aws-cdk/aws-cloudwatch.Metric

The total number of bytes processed by the load balancer over IPv4 and IPv6.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricRejectedConnectionCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of connections that were rejected because the load balancer had

reached its maximum number of connections.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricRequestCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of requests processed over IPv4 and IPv6.

This count includes only the requests with a response generated by a target of the load balancer.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricRuleEvaluations([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of rules processed by the load balancer given a request rate averaged over an hour.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricTargetConnectionErrorCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of connections that were not successfully established between the load balancer and target.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricTargetResponseTime([props]) → @aws-cdk/aws-cloudwatch.Metric

The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricTargetTLSNegotiationErrorCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of TLS connections initiated by the load balancer that did not establish a session with the target.

Possible causes include a mismatch of ciphers or protocols.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
connections

Implements @aws-cdk/aws-ec2.IConnectable.connections()

Type:@aws-cdk/aws-ec2.Connections (readonly)
asAliasRecordTarget() → @aws-cdk/aws-route53.AliasRecordTargetProps

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

Return hosted zone ID and DNS name, usable for Route53 alias targets

Return type:@aws-cdk/aws-route53.AliasRecordTargetProps
removeAttribute(key)

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

Remove an attribute from the load balancer

Parameters:key (string) –
setAttribute(key[, value])

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

Set a non-standard attribute on the load balancer

Parameters:
  • key (string) –
  • value (string (optional)) –
canonicalHostedZoneId

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The canonical hosted zone ID of this load balancer

Type:string (readonly)
dnsName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The DNS name of this load balancer

Type:string (readonly)
fullName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The full name of this load balancer

Type:string (readonly)
loadBalancerArn

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The ARN of this load balancer

Type:string (readonly)
loadBalancerName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The name of this load balancer

Type:string (readonly)
vpc

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The VPC this load balancer has been created in, if available

If the Load Balancer was imported, the VPC is not available.

Type:@aws-cdk/aws-ec2.IVpcNetwork (optional) (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ApplicationLoadBalancerImportProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancerImportProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationLoadBalancerImportProps;
// ApplicationLoadBalancerImportProps is an interface
import { ApplicationLoadBalancerImportProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties to reference an existing load balancer

loadBalancerArn

ARN of the load balancer

Type:string
securityGroupId

ID of the load balancer’s security group

Type:string

ApplicationLoadBalancerProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancerProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationLoadBalancerProps;
// ApplicationLoadBalancerProps is an interface
import { ApplicationLoadBalancerProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for defining an Application Load Balancer

Extends:BaseLoadBalancerProps
http2Enabled

Indicates whether HTTP/2 is enabled.

Type:boolean (optional)
Default:true
idleTimeoutSecs

The load balancer idle timeout, in seconds

Type:number (optional)
Default:60
ipAddressType

The type of IP addresses to use

Only applies to application load balancers.

Type:IpAddressType (optional)
Default:IpAddressType.Ipv4
securityGroup

Security group to associate with this load balancer

Type:@aws-cdk/aws-ec2.ISecurityGroup (optional)
Default:A security group is created
vpc

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancerProps

The VPC network to place the load balancer in

Type:@aws-cdk/aws-ec2.IVpcNetwork
deletionProtection

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancerProps

Indicates whether deletion protection is enabled.

Type:boolean (optional)
Default:false
internetFacing

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancerProps

Whether the load balancer has an internet-routable address

Type:boolean (optional)
Default:false
loadBalancerName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancerProps

Name of the load balancer

Type:string (optional)
Default:Automatically generated name
vpcPlacement

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancerProps

Where in the VPC to place the load balancer

Type:@aws-cdk/aws-ec2.VpcPlacementStrategy (optional)
Default:Public subnets if internetFacing, otherwise private subnets

ApplicationProtocol (enum)

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationProtocol

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationProtocol;
const { ApplicationProtocol } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { ApplicationProtocol } from '@aws-cdk/aws-elasticloadbalancingv2';

Load balancing protocol for application load balancers

Http

HTTP

Https

HTTPS

ApplicationTargetGroup

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationTargetGroup(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationTargetGroup;
const { ApplicationTargetGroup } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { ApplicationTargetGroup } from '@aws-cdk/aws-elasticloadbalancingv2';

Define an Application Target Group

Extends:

TargetGroupBase

Implements:

IApplicationTargetGroup

Parameters:
static import(scope, id, props) → @aws-cdk/aws-elasticloadbalancingv2.IApplicationTargetGroup

Import an existing target group

Parameters:
Return type:

IApplicationTargetGroup

addTarget(*targets)

Add a load balancing target to this target group

Parameters:*targets (IApplicationLoadBalancerTarget) –
enableCookieStickiness(durationSec)

Enable sticky routing via a cookie to members of this target group

Parameters:durationSec (number) –
metric(metricName[, props]) → @aws-cdk/aws-cloudwatch.Metric

Return the given named metric for this Application Load Balancer Target Group

Returns the metric for this target group from the point of view of the first

load balancer load balancing to it. If you have multiple load balancers load

sending traffic to the same target group, you will have to override the dimensions

on this metric.

Parameters:
Return type:

@aws-cdk/aws-cloudwatch.Metric

metricHealthyHostCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of healthy hosts in the target group

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricHttpCodeTarget(code[, props]) → @aws-cdk/aws-cloudwatch.Metric

The number of HTTP 2xx/3xx/4xx/5xx response codes generated by all targets in this target group.

This does not include any response codes generated by the load balancer.

Parameters:
Return type:

@aws-cdk/aws-cloudwatch.Metric

metricIPv6RequestCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of IPv6 requests received by the target group

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricRequestCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of requests processed over IPv4 and IPv6.

This count includes only the requests with a response generated by a target of the load balancer.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricRequestCountPerTarget([props]) → @aws-cdk/aws-cloudwatch.Metric

The average number of requests received by each target in a target group.

The only valid statistic is Sum. Note that this represents the average not the sum.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricTargetConnectionErrorCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of connections that were not successfully established between the load balancer and target.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricTargetResponseTime([props]) → @aws-cdk/aws-cloudwatch.Metric

The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricTargetTLSNegotiationErrorCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of TLS connections initiated by the load balancer that did not establish a session with the target.

Possible causes include a mismatch of ciphers or protocols.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricUnhealthyHostCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of unhealthy hosts in the target group

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
registerConnectable(connectable[, portRange])

Register a connectable as a member of this target group.

Don’t call this directly. It will be called by load balancing targets.

Parameters:
registerListener(listener[, associatingConstruct])

Implements @aws-cdk/aws-elasticloadbalancingv2.IApplicationTargetGroup.registerListener()

Register a listener that is load balancing to this target group.

Don’t call this directly. It will be called by listeners.

Parameters:
firstLoadBalancerFullName

Implements @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase.firstLoadBalancerFullName()

Full name of first load balancer

Type:string (readonly)
addLoadBalancerTarget(props)

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Register the given load balancing target as part of this group

Protected method

Parameters:props (LoadBalancerTargetProps) –
asCodeDeployLoadBalancer() → @aws-cdk/aws-codedeploy-api.ILoadBalancerProps

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Specify the CodeDeploy-required properties of this load balancer.

Return type:@aws-cdk/aws-codedeploy-api.ILoadBalancerProps
configureHealthCheck(healthCheck)

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Set/replace the target group’s health check

Parameters:healthCheck (HealthCheck) –
export() → @aws-cdk/aws-elasticloadbalancingv2.TargetGroupImportProps

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Export this target group

Return type:TargetGroupImportProps
setAttribute(key[, value])

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Set a non-standard attribute on the target group

Parameters:
  • key (string) –
  • value (string (optional)) –
defaultPort

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Default port configured for members of this target group

Protected property

Type:string (readonly)
loadBalancerArns

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Health check for the members of this target group

A token representing a list of ARNs of the load balancers that route traffic to this target group

Type:string (readonly)
loadBalancerAttached

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer

Type:@aws-cdk/cdk.IDependable (readonly)
loadBalancerAttachedDependencies

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Configurable dependable with all resources that lead to load balancer attachment

Protected property

Type:@aws-cdk/cdk.ConcreteDependable (readonly)
targetGroupArn

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

The ARN of the target group

Type:string (readonly)
targetGroupFullName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

The full name of the target group

Type:string (readonly)
targetGroupLoadBalancerArns

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

ARNs of load balancers load balancing to this TargetGroup

Type:string[] (readonly)
targetGroupName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

The name of the target group

Type:string (readonly)
healthCheck

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Type:HealthCheck
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ApplicationTargetGroupProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.ApplicationTargetGroupProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationTargetGroupProps;
// ApplicationTargetGroupProps is an interface
import { ApplicationTargetGroupProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for defining an Application Target Group

Extends:BaseTargetGroupProps
port

The port on which the listener listens for requests.

Type:number (optional)
Default:Determined from protocol if known
protocol

The protocol to use

Type:ApplicationProtocol (optional)
Default:Determined from port if known
slowStartSec

The time period during which the load balancer sends a newly registered

target a linearly increasing share of the traffic to the target group.

The range is 30–900 seconds (15 minutes).

Type:number (optional)
Default:0
stickinessCookieDurationSec

The stickiness cookie expiration period.

Setting this value enables load balancer stickiness.

After this period, the cookie is considered stale. The minimum value is

1 second and the maximum value is 7 days (604800 seconds).

Type:number (optional)
Default:86400 (1 day)
targets

The targets to add to this target group.

Can be Instance, IPAddress, or any self-registering load balancing

target. If you use either Instance or IPAddress as targets, all

target must be of the same type.

Type:IApplicationLoadBalancerTarget[] (optional)
vpc

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseTargetGroupProps

The virtual private cloud (VPC).

Type:@aws-cdk/aws-ec2.IVpcNetwork
deregistrationDelaySec

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseTargetGroupProps

The amount of time for Elastic Load Balancing to wait before deregistering a target.

The range is 0–3600 seconds.

Type:number (optional)
Default:300
healthCheck

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseTargetGroupProps

Health check configuration

Type:HealthCheck (optional)
Default:No health check
targetGroupName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseTargetGroupProps

The name of the target group.

This name must be unique per region per account, can have a maximum of

32 characters, must contain only alphanumeric characters or hyphens, and

must not begin or end with a hyphen.

Type:string (optional)
Default:Automatically generated
targetType

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseTargetGroupProps

The type of targets registered to this TargetGroup, either IP or Instance.

All targets registered into the group must be of this type. If you

register targets to the TargetGroup in the CDK app, the TargetType is

determined automatically.

Type:TargetType (optional)
Default:Determined automatically

BaseApplicationListenerProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.BaseApplicationListenerProps;
// BaseApplicationListenerProps is an interface
import { BaseApplicationListenerProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Basic properties for an ApplicationListener

certificateArns

The certificates to use on this listener

Type:string[] (optional)
defaultTargetGroups

Default target groups to load balance to

Type:IApplicationTargetGroup[] (optional)
Default:None
open

Allow anyone to connect to this listener

If this is specified, the listener will be opened up to anyone who can reach it.

For internal load balancers this is anyone in the same VPC. For public load

balancers, this is anyone on the internet.

If you want to be more selective about who can access this load

balancer, set this to false and use the listener’s connections

object to selectively grant access to the listener.

Type:boolean (optional)
Default:true
port

The port on which the listener listens for requests.

Type:number (optional)
Default:Determined from protocol if known
protocol

The protocol to use

Type:ApplicationProtocol (optional)
Default:Determined from port if known
sslPolicy

The security policy that defines which ciphers and protocols are supported.

Type:SslPolicy (optional)
Default:the current predefined security policy.

BaseApplicationListenerRuleProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.BaseApplicationListenerRuleProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.BaseApplicationListenerRuleProps;
// BaseApplicationListenerRuleProps is an interface
import { BaseApplicationListenerRuleProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Basic properties for defining a rule on a listener

priority

Priority of the rule

The rule with the lowest priority will be used for every request.

Priorities must be unique.

Type:number
hostHeader

Rule applies if the requested host matches the indicated host

May contain up to three ‘*’ wildcards.

Type:string (optional)
Default:No host condition
pathPattern

Rule applies if the requested path matches the given path pattern

May contain up to three ‘*’ wildcards.

Type:string (optional)
Default:No path condition
targetGroups

Target groups to forward requests to

Type:IApplicationTargetGroup[] (optional)

BaseListener

class @aws-cdk/aws-elasticloadbalancingv2.BaseListener(scope, id, additionalProps)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.BaseListener;
const { BaseListener } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { BaseListener } from '@aws-cdk/aws-elasticloadbalancingv2';

Base class for listeners

Extends:

@aws-cdk/cdk.Construct

Abstract:

Yes

Parameters:
validate() → string[]

Overrides @aws-cdk/cdk.Construct.validate()

Validate this listener

Protected method

Return type:string[]
listenerArn
Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

BaseLoadBalancer

class @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer(scope, id, baseProps, additionalProps)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.BaseLoadBalancer;
const { BaseLoadBalancer } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { BaseLoadBalancer } from '@aws-cdk/aws-elasticloadbalancingv2';

Base class for both Application and Network Load Balancers

Extends:

@aws-cdk/cdk.Construct

Implements:

@aws-cdk/aws-route53.IAliasRecordTarget

Abstract:

Yes

Parameters:
asAliasRecordTarget() → @aws-cdk/aws-route53.AliasRecordTargetProps

Implements @aws-cdk/aws-route53.IAliasRecordTarget.asAliasRecordTarget()

Return hosted zone ID and DNS name, usable for Route53 alias targets

Return type:@aws-cdk/aws-route53.AliasRecordTargetProps
removeAttribute(key)

Remove an attribute from the load balancer

Parameters:key (string) –
setAttribute(key[, value])

Set a non-standard attribute on the load balancer

Parameters:
  • key (string) –
  • value (string (optional)) –
canonicalHostedZoneId

The canonical hosted zone ID of this load balancer

Type:string (readonly)
dnsName

The DNS name of this load balancer

Type:string (readonly)
fullName

The full name of this load balancer

Type:string (readonly)
loadBalancerArn

The ARN of this load balancer

Type:string (readonly)
loadBalancerName

The name of this load balancer

Type:string (readonly)
vpc

The VPC this load balancer has been created in, if available

If the Load Balancer was imported, the VPC is not available.

Type:@aws-cdk/aws-ec2.IVpcNetwork (optional) (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

BaseLoadBalancerProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancerProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.BaseLoadBalancerProps;
// BaseLoadBalancerProps is an interface
import { BaseLoadBalancerProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Shared properties of both Application and Network Load Balancers

vpc

The VPC network to place the load balancer in

Type:@aws-cdk/aws-ec2.IVpcNetwork
deletionProtection

Indicates whether deletion protection is enabled.

Type:boolean (optional)
Default:false
internetFacing

Whether the load balancer has an internet-routable address

Type:boolean (optional)
Default:false
loadBalancerName

Name of the load balancer

Type:string (optional)
Default:Automatically generated name
vpcPlacement

Where in the VPC to place the load balancer

Type:@aws-cdk/aws-ec2.VpcPlacementStrategy (optional)
Default:Public subnets if internetFacing, otherwise private subnets

BaseNetworkListenerProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.BaseNetworkListenerProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.BaseNetworkListenerProps;
// BaseNetworkListenerProps is an interface
import { BaseNetworkListenerProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Basic properties for a Network Listener

port

The port on which the listener listens for requests.

Type:number
defaultTargetGroups

Default target groups to load balance to

Type:INetworkTargetGroup[] (optional)
Default:None

BaseTargetGroupProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.BaseTargetGroupProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.BaseTargetGroupProps;
// BaseTargetGroupProps is an interface
import { BaseTargetGroupProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Basic properties of both Application and Network Target Groups

vpc

The virtual private cloud (VPC).

Type:@aws-cdk/aws-ec2.IVpcNetwork
deregistrationDelaySec

The amount of time for Elastic Load Balancing to wait before deregistering a target.

The range is 0–3600 seconds.

Type:number (optional)
Default:300
healthCheck

Health check configuration

Type:HealthCheck (optional)
Default:No health check
targetGroupName

The name of the target group.

This name must be unique per region per account, can have a maximum of

32 characters, must contain only alphanumeric characters or hyphens, and

must not begin or end with a hyphen.

Type:string (optional)
Default:Automatically generated
targetType

The type of targets registered to this TargetGroup, either IP or Instance.

All targets registered into the group must be of this type. If you

register targets to the TargetGroup in the CDK app, the TargetType is

determined automatically.

Type:TargetType (optional)
Default:Determined automatically

CfnListener

class @aws-cdk/aws-elasticloadbalancingv2.CfnListener(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListener;
const { CfnListener } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { CfnListener } from '@aws-cdk/aws-elasticloadbalancingv2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
listenerArn
Type:string (readonly)
propertyOverrides
Type:CfnListenerProps (readonly)
class ActionProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListener.ActionProperty;
// CfnListener.ActionProperty is an interface
import { CfnListener.ActionProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
type

CfnListener.ActionProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-defaultactions-type

Type:string
authenticateCognitoConfig

CfnListener.ActionProperty.AuthenticateCognitoConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-authenticatecognitoconfig

Type:@aws-cdk/cdk.Token or AuthenticateCognitoConfigProperty (optional)
authenticateOidcConfig

CfnListener.ActionProperty.AuthenticateOidcConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-authenticateoidcconfig

Type:@aws-cdk/cdk.Token or AuthenticateOidcConfigProperty (optional)
fixedResponseConfig

CfnListener.ActionProperty.FixedResponseConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-fixedresponseconfig

Type:@aws-cdk/cdk.Token or FixedResponseConfigProperty (optional)
order

CfnListener.ActionProperty.Order

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-order

Type:number or @aws-cdk/cdk.Token (optional)
redirectConfig

CfnListener.ActionProperty.RedirectConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-action-redirectconfig

Type:@aws-cdk/cdk.Token or RedirectConfigProperty (optional)
targetGroupArn

CfnListener.ActionProperty.TargetGroupArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-defaultactions.html#cfn-elasticloadbalancingv2-listener-defaultactions-targetgrouparn

Type:string (optional)
class AuthenticateCognitoConfigProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListener.AuthenticateCognitoConfigProperty;
// CfnListener.AuthenticateCognitoConfigProperty is an interface
import { CfnListener.AuthenticateCognitoConfigProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
userPoolArn

CfnListener.AuthenticateCognitoConfigProperty.UserPoolArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolarn

Type:string
userPoolClientId

CfnListener.AuthenticateCognitoConfigProperty.UserPoolClientId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolclientid

Type:string
userPoolDomain

CfnListener.AuthenticateCognitoConfigProperty.UserPoolDomain

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpooldomain

Type:string
authenticationRequestExtraParams

CfnListener.AuthenticateCognitoConfigProperty.AuthenticationRequestExtraParams

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-authenticationrequestextraparams

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
onUnauthenticatedRequest

CfnListener.AuthenticateCognitoConfigProperty.OnUnauthenticatedRequest

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-onunauthenticatedrequest

Type:string (optional)
scope

CfnListener.AuthenticateCognitoConfigProperty.Scope

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-scope

Type:string (optional)
sessionCookieName

CfnListener.AuthenticateCognitoConfigProperty.SessionCookieName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessioncookiename

Type:string (optional)
sessionTimeout

CfnListener.AuthenticateCognitoConfigProperty.SessionTimeout

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessiontimeout

Type:number or @aws-cdk/cdk.Token (optional)
class AuthenticateOidcConfigProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListener.AuthenticateOidcConfigProperty;
// CfnListener.AuthenticateOidcConfigProperty is an interface
import { CfnListener.AuthenticateOidcConfigProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
authorizationEndpoint

CfnListener.AuthenticateOidcConfigProperty.AuthorizationEndpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-authorizationendpoint

Type:string
clientId

CfnListener.AuthenticateOidcConfigProperty.ClientId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-clientid

Type:string
clientSecret

CfnListener.AuthenticateOidcConfigProperty.ClientSecret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-clientsecret

Type:string
issuer

CfnListener.AuthenticateOidcConfigProperty.Issuer

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-issuer

Type:string
tokenEndpoint

CfnListener.AuthenticateOidcConfigProperty.TokenEndpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-tokenendpoint

Type:string
userInfoEndpoint

CfnListener.AuthenticateOidcConfigProperty.UserInfoEndpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-userinfoendpoint

Type:string
authenticationRequestExtraParams

CfnListener.AuthenticateOidcConfigProperty.AuthenticationRequestExtraParams

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-authenticationrequestextraparams

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
onUnauthenticatedRequest

CfnListener.AuthenticateOidcConfigProperty.OnUnauthenticatedRequest

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-onunauthenticatedrequest

Type:string (optional)
scope

CfnListener.AuthenticateOidcConfigProperty.Scope

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-scope

Type:string (optional)
sessionCookieName

CfnListener.AuthenticateOidcConfigProperty.SessionCookieName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-sessioncookiename

Type:string (optional)
sessionTimeout

CfnListener.AuthenticateOidcConfigProperty.SessionTimeout

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-sessiontimeout

Type:number or @aws-cdk/cdk.Token (optional)
class CertificateProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListener.CertificateProperty;
// CfnListener.CertificateProperty is an interface
import { CfnListener.CertificateProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
certificateArn

CfnListener.CertificateProperty.CertificateArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html#cfn-elasticloadbalancingv2-listener-certificates-certificatearn

Type:string (optional)
class FixedResponseConfigProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListener.FixedResponseConfigProperty;
// CfnListener.FixedResponseConfigProperty is an interface
import { CfnListener.FixedResponseConfigProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
statusCode

CfnListener.FixedResponseConfigProperty.StatusCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-statuscode

Type:string
contentType

CfnListener.FixedResponseConfigProperty.ContentType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-contenttype

Type:string (optional)
messageBody

CfnListener.FixedResponseConfigProperty.MessageBody

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listener-fixedresponseconfig-messagebody

Type:string (optional)
class RedirectConfigProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListener.RedirectConfigProperty;
// CfnListener.RedirectConfigProperty is an interface
import { CfnListener.RedirectConfigProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
statusCode

CfnListener.RedirectConfigProperty.StatusCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-statuscode

Type:string
host

CfnListener.RedirectConfigProperty.Host

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-host

Type:string (optional)
path

CfnListener.RedirectConfigProperty.Path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-path

Type:string (optional)
port

CfnListener.RedirectConfigProperty.Port

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-port

Type:string (optional)
protocol

CfnListener.RedirectConfigProperty.Protocol

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-protocol

Type:string (optional)
query

CfnListener.RedirectConfigProperty.Query

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-redirectconfig.html#cfn-elasticloadbalancingv2-listener-redirectconfig-query

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnListenerCertificate

class @aws-cdk/aws-elasticloadbalancingv2.CfnListenerCertificate(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerCertificate;
const { CfnListenerCertificate } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { CfnListenerCertificate } from '@aws-cdk/aws-elasticloadbalancingv2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
listenerCertificateArn
Type:string (readonly)
propertyOverrides
Type:CfnListenerCertificateProps (readonly)
class CertificateProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerCertificate.CertificateProperty;
// CfnListenerCertificate.CertificateProperty is an interface
import { CfnListenerCertificate.CertificateProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
certificateArn

CfnListenerCertificate.CertificateProperty.CertificateArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html#cfn-elasticloadbalancingv2-listener-certificates-certificatearn

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnListenerCertificateProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.CfnListenerCertificateProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerCertificateProps;
// CfnListenerCertificateProps is an interface
import { CfnListenerCertificateProps } from '@aws-cdk/aws-elasticloadbalancingv2';
certificates

AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificates

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html#cfn-elasticloadbalancingv2-listenercertificate-certificates

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or CertificateProperty)[]
listenerArn

AWS::ElasticLoadBalancingV2::ListenerCertificate.ListenerArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html#cfn-elasticloadbalancingv2-listenercertificate-listenerarn

Type:string

CfnListenerProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.CfnListenerProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerProps;
// CfnListenerProps is an interface
import { CfnListenerProps } from '@aws-cdk/aws-elasticloadbalancingv2';
defaultActions

AWS::ElasticLoadBalancingV2::Listener.DefaultActions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-defaultactions

Type:@aws-cdk/cdk.Token or (ActionProperty or @aws-cdk/cdk.Token)[]
loadBalancerArn

AWS::ElasticLoadBalancingV2::Listener.LoadBalancerArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-loadbalancerarn

Type:string
port

AWS::ElasticLoadBalancingV2::Listener.Port

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-port

Type:number or @aws-cdk/cdk.Token
protocol

AWS::ElasticLoadBalancingV2::Listener.Protocol

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-protocol

Type:string
certificates

AWS::ElasticLoadBalancingV2::Listener.Certificates

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-certificates

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or CertificateProperty)[] (optional)
sslPolicy

AWS::ElasticLoadBalancingV2::Listener.SslPolicy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-sslpolicy

Type:string (optional)

CfnListenerRule

class @aws-cdk/aws-elasticloadbalancingv2.CfnListenerRule(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerRule;
const { CfnListenerRule } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { CfnListenerRule } from '@aws-cdk/aws-elasticloadbalancingv2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
listenerRuleArn
Type:string (readonly)
propertyOverrides
Type:CfnListenerRuleProps (readonly)
class ActionProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerRule.ActionProperty;
// CfnListenerRule.ActionProperty is an interface
import { CfnListenerRule.ActionProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
type

CfnListenerRule.ActionProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listener-actions-type

Type:string
authenticateCognitoConfig

CfnListenerRule.ActionProperty.AuthenticateCognitoConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-authenticatecognitoconfig

Type:@aws-cdk/cdk.Token or AuthenticateCognitoConfigProperty (optional)
authenticateOidcConfig

CfnListenerRule.ActionProperty.AuthenticateOidcConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-authenticateoidcconfig

Type:@aws-cdk/cdk.Token or AuthenticateOidcConfigProperty (optional)
fixedResponseConfig

CfnListenerRule.ActionProperty.FixedResponseConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-fixedresponseconfig

Type:@aws-cdk/cdk.Token or FixedResponseConfigProperty (optional)
order

CfnListenerRule.ActionProperty.Order

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-order

Type:number or @aws-cdk/cdk.Token (optional)
redirectConfig

CfnListenerRule.ActionProperty.RedirectConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listenerrule-action-redirectconfig

Type:@aws-cdk/cdk.Token or RedirectConfigProperty (optional)
targetGroupArn

CfnListenerRule.ActionProperty.TargetGroupArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-actions.html#cfn-elasticloadbalancingv2-listener-actions-targetgrouparn

Type:string (optional)
class AuthenticateCognitoConfigProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerRule.AuthenticateCognitoConfigProperty;
// CfnListenerRule.AuthenticateCognitoConfigProperty is an interface
import { CfnListenerRule.AuthenticateCognitoConfigProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
userPoolArn

CfnListenerRule.AuthenticateCognitoConfigProperty.UserPoolArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpoolarn

Type:string
userPoolClientId

CfnListenerRule.AuthenticateCognitoConfigProperty.UserPoolClientId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpoolclientid

Type:string
userPoolDomain

CfnListenerRule.AuthenticateCognitoConfigProperty.UserPoolDomain

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-userpooldomain

Type:string
authenticationRequestExtraParams

CfnListenerRule.AuthenticateCognitoConfigProperty.AuthenticationRequestExtraParams

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-authenticationrequestextraparams

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
onUnauthenticatedRequest

CfnListenerRule.AuthenticateCognitoConfigProperty.OnUnauthenticatedRequest

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-onunauthenticatedrequest

Type:string (optional)
scope

CfnListenerRule.AuthenticateCognitoConfigProperty.Scope

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-scope

Type:string (optional)
sessionCookieName

CfnListenerRule.AuthenticateCognitoConfigProperty.SessionCookieName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-sessioncookiename

Type:string (optional)
sessionTimeout

CfnListenerRule.AuthenticateCognitoConfigProperty.SessionTimeout

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-sessiontimeout

Type:number or @aws-cdk/cdk.Token (optional)
class AuthenticateOidcConfigProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerRule.AuthenticateOidcConfigProperty;
// CfnListenerRule.AuthenticateOidcConfigProperty is an interface
import { CfnListenerRule.AuthenticateOidcConfigProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
authorizationEndpoint

CfnListenerRule.AuthenticateOidcConfigProperty.AuthorizationEndpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-authorizationendpoint

Type:string
clientId

CfnListenerRule.AuthenticateOidcConfigProperty.ClientId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-clientid

Type:string
clientSecret

CfnListenerRule.AuthenticateOidcConfigProperty.ClientSecret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-clientsecret

Type:string
issuer

CfnListenerRule.AuthenticateOidcConfigProperty.Issuer

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-issuer

Type:string
tokenEndpoint

CfnListenerRule.AuthenticateOidcConfigProperty.TokenEndpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-tokenendpoint

Type:string
userInfoEndpoint

CfnListenerRule.AuthenticateOidcConfigProperty.UserInfoEndpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-userinfoendpoint

Type:string
authenticationRequestExtraParams

CfnListenerRule.AuthenticateOidcConfigProperty.AuthenticationRequestExtraParams

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-authenticationrequestextraparams

Type:@aws-cdk/cdk.Token or string => (string or @aws-cdk/cdk.Token) (optional)
onUnauthenticatedRequest

CfnListenerRule.AuthenticateOidcConfigProperty.OnUnauthenticatedRequest

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-onunauthenticatedrequest

Type:string (optional)
scope

CfnListenerRule.AuthenticateOidcConfigProperty.Scope

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-scope

Type:string (optional)
sessionCookieName

CfnListenerRule.AuthenticateOidcConfigProperty.SessionCookieName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-sessioncookiename

Type:string (optional)
sessionTimeout

CfnListenerRule.AuthenticateOidcConfigProperty.SessionTimeout

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-sessiontimeout

Type:number or @aws-cdk/cdk.Token (optional)
class FixedResponseConfigProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerRule.FixedResponseConfigProperty;
// CfnListenerRule.FixedResponseConfigProperty is an interface
import { CfnListenerRule.FixedResponseConfigProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
statusCode

CfnListenerRule.FixedResponseConfigProperty.StatusCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-statuscode

Type:string
contentType

CfnListenerRule.FixedResponseConfigProperty.ContentType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-contenttype

Type:string (optional)
messageBody

CfnListenerRule.FixedResponseConfigProperty.MessageBody

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-fixedresponseconfig.html#cfn-elasticloadbalancingv2-listenerrule-fixedresponseconfig-messagebody

Type:string (optional)
class RedirectConfigProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerRule.RedirectConfigProperty;
// CfnListenerRule.RedirectConfigProperty is an interface
import { CfnListenerRule.RedirectConfigProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
statusCode

CfnListenerRule.RedirectConfigProperty.StatusCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-statuscode

Type:string
host

CfnListenerRule.RedirectConfigProperty.Host

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-host

Type:string (optional)
path

CfnListenerRule.RedirectConfigProperty.Path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-path

Type:string (optional)
port

CfnListenerRule.RedirectConfigProperty.Port

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-port

Type:string (optional)
protocol

CfnListenerRule.RedirectConfigProperty.Protocol

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-protocol

Type:string (optional)
query

CfnListenerRule.RedirectConfigProperty.Query

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-redirectconfig.html#cfn-elasticloadbalancingv2-listenerrule-redirectconfig-query

Type:string (optional)
class RuleConditionProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerRule.RuleConditionProperty;
// CfnListenerRule.RuleConditionProperty is an interface
import { CfnListenerRule.RuleConditionProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
field

CfnListenerRule.RuleConditionProperty.Field

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-conditions-field

Type:string (optional)
values

CfnListenerRule.RuleConditionProperty.Values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-conditions.html#cfn-elasticloadbalancingv2-listenerrule-conditions-values

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnListenerRuleProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.CfnListenerRuleProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerRuleProps;
// CfnListenerRuleProps is an interface
import { CfnListenerRuleProps } from '@aws-cdk/aws-elasticloadbalancingv2';
actions

AWS::ElasticLoadBalancingV2::ListenerRule.Actions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-actions

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ActionProperty)[]
conditions

AWS::ElasticLoadBalancingV2::ListenerRule.Conditions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-conditions

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or RuleConditionProperty)[]
listenerArn

AWS::ElasticLoadBalancingV2::ListenerRule.ListenerArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-listenerarn

Type:string
priority

AWS::ElasticLoadBalancingV2::ListenerRule.Priority

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html#cfn-elasticloadbalancingv2-listenerrule-priority

Type:number or @aws-cdk/cdk.Token

CfnLoadBalancer

class @aws-cdk/aws-elasticloadbalancingv2.CfnLoadBalancer(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnLoadBalancer;
const { CfnLoadBalancer } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { CfnLoadBalancer } from '@aws-cdk/aws-elasticloadbalancingv2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
loadBalancerArn
Type:string (readonly)
loadBalancerCanonicalHostedZoneId
Type:string (readonly)
loadBalancerDnsName
Type:string (readonly)
loadBalancerFullName
Type:string (readonly)
loadBalancerName
Type:string (readonly)
loadBalancerSecurityGroups
Type:string[] (readonly)
propertyOverrides
Type:CfnLoadBalancerProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class LoadBalancerAttributeProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnLoadBalancer.LoadBalancerAttributeProperty;
// CfnLoadBalancer.LoadBalancerAttributeProperty is an interface
import { CfnLoadBalancer.LoadBalancerAttributeProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
key

CfnLoadBalancer.LoadBalancerAttributeProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattributes.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes-key

Type:string (optional)
value

CfnLoadBalancer.LoadBalancerAttributeProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-loadbalancerattributes.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes-value

Type:string (optional)
class SubnetMappingProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnLoadBalancer.SubnetMappingProperty;
// CfnLoadBalancer.SubnetMappingProperty is an interface
import { CfnLoadBalancer.SubnetMappingProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
allocationId

CfnLoadBalancer.SubnetMappingProperty.AllocationId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-allocationid

Type:string
subnetId

CfnLoadBalancer.SubnetMappingProperty.SubnetId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-loadbalancer-subnetmapping.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmapping-subnetid

Type:string
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnLoadBalancerProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.CfnLoadBalancerProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnLoadBalancerProps;
// CfnLoadBalancerProps is an interface
import { CfnLoadBalancerProps } from '@aws-cdk/aws-elasticloadbalancingv2';
ipAddressType

AWS::ElasticLoadBalancingV2::LoadBalancer.IpAddressType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-ipaddresstype

Type:string (optional)
loadBalancerAttributes

AWS::ElasticLoadBalancingV2::LoadBalancer.LoadBalancerAttributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-loadbalancerattributes

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or LoadBalancerAttributeProperty)[] (optional)
name

AWS::ElasticLoadBalancingV2::LoadBalancer.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-name

Type:string (optional)
scheme

AWS::ElasticLoadBalancingV2::LoadBalancer.Scheme

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-scheme

Type:string (optional)
securityGroups

AWS::ElasticLoadBalancingV2::LoadBalancer.SecurityGroups

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-securitygroups

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
subnetMappings

AWS::ElasticLoadBalancingV2::LoadBalancer.SubnetMappings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnetmappings

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or SubnetMappingProperty)[] (optional)
subnets

AWS::ElasticLoadBalancingV2::LoadBalancer.Subnets

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-subnets

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
tags

AWS::ElasticLoadBalancingV2::LoadBalancer.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)
type

AWS::ElasticLoadBalancingV2::LoadBalancer.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#cfn-elasticloadbalancingv2-loadbalancer-type

Type:string (optional)

CfnTargetGroup

class @aws-cdk/aws-elasticloadbalancingv2.CfnTargetGroup(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnTargetGroup;
const { CfnTargetGroup } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { CfnTargetGroup } from '@aws-cdk/aws-elasticloadbalancingv2';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnTargetGroupProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
targetGroupArn
Type:string (readonly)
targetGroupFullName
Type:string (readonly)
targetGroupLoadBalancerArns
Type:string[] (readonly)
targetGroupName
Type:string (readonly)
class MatcherProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnTargetGroup.MatcherProperty;
// CfnTargetGroup.MatcherProperty is an interface
import { CfnTargetGroup.MatcherProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
httpCode

CfnTargetGroup.MatcherProperty.HttpCode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html#cfn-elasticloadbalancingv2-targetgroup-matcher-httpcode

Type:string
class TargetDescriptionProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnTargetGroup.TargetDescriptionProperty;
// CfnTargetGroup.TargetDescriptionProperty is an interface
import { CfnTargetGroup.TargetDescriptionProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
id

CfnTargetGroup.TargetDescriptionProperty.Id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-id

Type:string
availabilityZone

CfnTargetGroup.TargetDescriptionProperty.AvailabilityZone

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-availabilityzone

Type:string (optional)
port

CfnTargetGroup.TargetDescriptionProperty.Port

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html#cfn-elasticloadbalancingv2-targetgroup-targetdescription-port

Type:number or @aws-cdk/cdk.Token (optional)
class TargetGroupAttributeProperty

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnTargetGroup.TargetGroupAttributeProperty;
// CfnTargetGroup.TargetGroupAttributeProperty is an interface
import { CfnTargetGroup.TargetGroupAttributeProperty } from '@aws-cdk/aws-elasticloadbalancingv2';
key

CfnTargetGroup.TargetGroupAttributeProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattribute-key

Type:string (optional)
value

CfnTargetGroup.TargetGroupAttributeProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattribute-value

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnTargetGroupProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.CfnTargetGroupProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.CfnTargetGroupProps;
// CfnTargetGroupProps is an interface
import { CfnTargetGroupProps } from '@aws-cdk/aws-elasticloadbalancingv2';
healthCheckEnabled

AWS::ElasticLoadBalancingV2::TargetGroup.HealthCheckEnabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckenabled

Type:boolean or @aws-cdk/cdk.Token (optional)
healthCheckIntervalSeconds

AWS::ElasticLoadBalancingV2::TargetGroup.HealthCheckIntervalSeconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckintervalseconds

Type:number or @aws-cdk/cdk.Token (optional)
healthCheckPath

AWS::ElasticLoadBalancingV2::TargetGroup.HealthCheckPath

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckpath

Type:string (optional)
healthCheckPort

AWS::ElasticLoadBalancingV2::TargetGroup.HealthCheckPort

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckport

Type:string (optional)
healthCheckProtocol

AWS::ElasticLoadBalancingV2::TargetGroup.HealthCheckProtocol

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthcheckprotocol

Type:string (optional)
healthCheckTimeoutSeconds

AWS::ElasticLoadBalancingV2::TargetGroup.HealthCheckTimeoutSeconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthchecktimeoutseconds

Type:number or @aws-cdk/cdk.Token (optional)
healthyThresholdCount

AWS::ElasticLoadBalancingV2::TargetGroup.HealthyThresholdCount

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-healthythresholdcount

Type:number or @aws-cdk/cdk.Token (optional)
matcher

AWS::ElasticLoadBalancingV2::TargetGroup.Matcher

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-matcher

Type:@aws-cdk/cdk.Token or MatcherProperty (optional)
name

AWS::ElasticLoadBalancingV2::TargetGroup.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-name

Type:string (optional)
port

AWS::ElasticLoadBalancingV2::TargetGroup.Port

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-port

Type:number or @aws-cdk/cdk.Token (optional)
protocol

AWS::ElasticLoadBalancingV2::TargetGroup.Protocol

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-protocol

Type:string (optional)
tags

AWS::ElasticLoadBalancingV2::TargetGroup.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)
targetGroupAttributes

AWS::ElasticLoadBalancingV2::TargetGroup.TargetGroupAttributes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targetgroupattributes

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TargetGroupAttributeProperty)[] (optional)
targets

AWS::ElasticLoadBalancingV2::TargetGroup.Targets

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targets

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TargetDescriptionProperty)[] (optional)
targetType

AWS::ElasticLoadBalancingV2::TargetGroup.TargetType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-targettype

Type:string (optional)
unhealthyThresholdCount

AWS::ElasticLoadBalancingV2::TargetGroup.UnhealthyThresholdCount

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-unhealthythresholdcount

Type:number or @aws-cdk/cdk.Token (optional)
vpcId

AWS::ElasticLoadBalancingV2::TargetGroup.VpcId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html#cfn-elasticloadbalancingv2-targetgroup-vpcid

Type:string (optional)

HealthCheck (interface)

class @aws-cdk/aws-elasticloadbalancingv2.HealthCheck

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.HealthCheck;
// HealthCheck is an interface
import { HealthCheck } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for configuring a health check

healthyHttpCodes

HTTP code to use when checking for a successful response from a target.

For Application Load Balancers, you can specify values between 200 and

499, and the default value is 200. You can specify multiple values (for

example, “200,202”) or a range of values (for example, “200-299”).

Type:string (optional)
healthyThresholdCount

The number of consecutive health checks successes required before considering an unhealthy target healthy.

For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3.

Type:number (optional)
Default:5 for ALBs, 3 for NLBs
intervalSecs

The approximate number of seconds between health checks for an individual target.

Type:number (optional)
Default:30
path

The ping path destination where Elastic Load Balancing sends health check requests.

Type:string (optional)
Default:/
port

The port that the load balancer uses when performing health checks on the targets.

Type:string (optional)
Default:‘traffic-port’
protocol

The protocol the load balancer uses when performing health checks on targets.

The TCP protocol is supported only if the protocol of the target group

is TCP.

Type:Protocol (optional)
Default:HTTP for ALBs, TCP for NLBs
timeoutSeconds

The amount of time, in seconds, during which no response from a target means a failed health check.

For Application Load Balancers, the range is 2–60 seconds and the

default is 5 seconds. For Network Load Balancers, this is 10 seconds for

TCP and HTTPS health checks and 6 seconds for HTTP health checks.

Type:number (optional)
Default:5 for ALBs, 10 or 6 for NLBs
unhealthyThresholdCount

The number of consecutive health check failures required before considering a target unhealthy.

For Application Load Balancers, the default is 2. For Network Load

Balancers, this value must be the same as the healthy threshold count.

Type:number (optional)
Default:2

HttpCodeElb (enum)

class @aws-cdk/aws-elasticloadbalancingv2.HttpCodeElb

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.HttpCodeElb;
const { HttpCodeElb } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { HttpCodeElb } from '@aws-cdk/aws-elasticloadbalancingv2';

Count of HTTP status originating from the load balancer

This count does not include any response codes generated by the targets.

Elb3xxCount

The number of HTTP 3XX redirection codes that originate from the load balancer.

Elb4xxCount

The number of HTTP 4XX client error codes that originate from the load balancer.

Client errors are generated when requests are malformed or incomplete.

These requests have not been received by the target. This count does not

include any response codes generated by the targets.

Elb5xxCount

The number of HTTP 5XX server error codes that originate from the load balancer.

HttpCodeTarget (enum)

class @aws-cdk/aws-elasticloadbalancingv2.HttpCodeTarget

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.HttpCodeTarget;
const { HttpCodeTarget } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { HttpCodeTarget } from '@aws-cdk/aws-elasticloadbalancingv2';

Count of HTTP status originating from the targets

Target2xxCount

The number of 2xx response codes from targets

Target3xxCount

The number of 3xx response codes from targets

Target4xxCount

The number of 4xx response codes from targets

Target5xxCount

The number of 5xx response codes from targets

IApplicationListener (interface)

class @aws-cdk/aws-elasticloadbalancingv2.IApplicationListener

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationListener;
// IApplicationListener is an interface
import { IApplicationListener } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties to reference an existing listener

Extends:@aws-cdk/cdk.IConstruct
Extends:@aws-cdk/aws-ec2.IConnectable
listenerArn

ARN of the listener

Type:string (readonly)
addCertificateArns(id, arns)

Add one or more certificates to this listener.

Parameters:
  • id (string) –
  • arns (string[]) –
Abstract:

Yes

addTargetGroups(id, props)

Load balance incoming requests to the given target groups.

It’s possible to add conditions to the TargetGroups added in this way.

At least one TargetGroup must be added without conditions.

Parameters:
Abstract:

Yes

addTargets(id, props) → @aws-cdk/aws-elasticloadbalancingv2.ApplicationTargetGroup

Load balance incoming requests to the given load balancing targets.

This method implicitly creates an ApplicationTargetGroup for the targets

involved.

It’s possible to add conditions to the targets added in this way. At least

one set of targets must be added without conditions.

Parameters:
Returns:

The newly created target group

Return type:

ApplicationTargetGroup

Abstract:

Yes

export() → @aws-cdk/aws-elasticloadbalancingv2.ApplicationListenerImportProps

Export this listener

Return type:ApplicationListenerImportProps
Abstract:Yes
registerConnectable(connectable, portRange)

Register that a connectable that has been added to this load balancer.

Don’t call this directly. It is called by ApplicationTargetGroup.

Parameters:
Abstract:

Yes

connections

Inherited from @aws-cdk/aws-ec2.IConnectable

Type:@aws-cdk/aws-ec2.Connections (readonly)
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

IApplicationLoadBalancer (interface)

class @aws-cdk/aws-elasticloadbalancingv2.IApplicationLoadBalancer

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancer;
// IApplicationLoadBalancer is an interface
import { IApplicationLoadBalancer } from '@aws-cdk/aws-elasticloadbalancingv2';

An application load balancer

Extends:@aws-cdk/cdk.IConstruct
Extends:@aws-cdk/aws-ec2.IConnectable
loadBalancerArn

The ARN of this load balancer

Type:string (readonly)
vpc

The VPC this load balancer has been created in (if available)

Type:@aws-cdk/aws-ec2.IVpcNetwork (optional) (readonly)
addListener(id, props) → @aws-cdk/aws-elasticloadbalancingv2.ApplicationListener

Add a new listener to this load balancer

Parameters:
Return type:

ApplicationListener

Abstract:

Yes

export() → @aws-cdk/aws-elasticloadbalancingv2.ApplicationLoadBalancerImportProps

Export this load balancer

Return type:ApplicationLoadBalancerImportProps
Abstract:Yes
connections

Inherited from @aws-cdk/aws-ec2.IConnectable

Type:@aws-cdk/aws-ec2.Connections (readonly)
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

IApplicationLoadBalancerTarget (interface)

class @aws-cdk/aws-elasticloadbalancingv2.IApplicationLoadBalancerTarget

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancerTarget;
// IApplicationLoadBalancerTarget is an interface
import { IApplicationLoadBalancerTarget } from '@aws-cdk/aws-elasticloadbalancingv2';

Interface for constructs that can be targets of an application load balancer

attachToApplicationTargetGroup(targetGroup) → @aws-cdk/aws-elasticloadbalancingv2.LoadBalancerTargetProps

Attach load-balanced target to a TargetGroup

May return JSON to directly add to the [Targets] list, or return undefined

if the target will register itself with the load balancer.

Parameters:targetGroup (ApplicationTargetGroup) –
Return type:LoadBalancerTargetProps
Abstract:Yes

IApplicationTargetGroup (interface)

class @aws-cdk/aws-elasticloadbalancingv2.IApplicationTargetGroup

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationTargetGroup;
// IApplicationTargetGroup is an interface
import { IApplicationTargetGroup } from '@aws-cdk/aws-elasticloadbalancingv2';

A Target Group for Application Load Balancers

Extends:ITargetGroup
registerListener(listener[, associatingConstruct])

Register a listener that is load balancing to this target group.

Don’t call this directly. It will be called by listeners.

Parameters:
Abstract:

Yes

export() → @aws-cdk/aws-elasticloadbalancingv2.TargetGroupImportProps

Inherited from @aws-cdk/aws-elasticloadbalancingv2.ITargetGroup

Export this target group

Return type:TargetGroupImportProps
Abstract:Yes
loadBalancerArns

Inherited from @aws-cdk/aws-elasticloadbalancingv2.ITargetGroup

A token representing a list of ARNs of the load balancers that route traffic to this target group

Type:string (readonly)
loadBalancerAttached

Inherited from @aws-cdk/aws-elasticloadbalancingv2.ITargetGroup

Return an object to depend on the listeners added to this target group

Type:@aws-cdk/cdk.IDependable (readonly)
targetGroupArn

Inherited from @aws-cdk/aws-elasticloadbalancingv2.ITargetGroup

ARN of the target group

Type:string (readonly)
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

INetworkListener (interface)

class @aws-cdk/aws-elasticloadbalancingv2.INetworkListener

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.INetworkListener;
// INetworkListener is an interface
import { INetworkListener } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties to reference an existing listener

Extends:@aws-cdk/cdk.IConstruct
listenerArn

ARN of the listener

Type:string (readonly)
export() → @aws-cdk/aws-elasticloadbalancingv2.NetworkListenerImportProps

Export this listener

Return type:NetworkListenerImportProps
Abstract:Yes
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

INetworkLoadBalancer (interface)

class @aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancer

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.INetworkLoadBalancer;
// INetworkLoadBalancer is an interface
import { INetworkLoadBalancer } from '@aws-cdk/aws-elasticloadbalancingv2';

A network load balancer

Extends:@aws-cdk/cdk.IConstruct
loadBalancerArn

The ARN of this load balancer

Type:string (readonly)
vpc

The VPC this load balancer has been created in (if available)

Type:@aws-cdk/aws-ec2.IVpcNetwork (optional) (readonly)
addListener(id, props) → @aws-cdk/aws-elasticloadbalancingv2.NetworkListener

Add a listener to this load balancer

Parameters:
Returns:

The newly created listener

Return type:

NetworkListener

Abstract:

Yes

export() → @aws-cdk/aws-elasticloadbalancingv2.NetworkLoadBalancerImportProps

Export this load balancer

Return type:NetworkLoadBalancerImportProps
Abstract:Yes
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

INetworkLoadBalancerTarget (interface)

class @aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancerTarget

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.INetworkLoadBalancerTarget;
// INetworkLoadBalancerTarget is an interface
import { INetworkLoadBalancerTarget } from '@aws-cdk/aws-elasticloadbalancingv2';

Interface for constructs that can be targets of an network load balancer

attachToNetworkTargetGroup(targetGroup) → @aws-cdk/aws-elasticloadbalancingv2.LoadBalancerTargetProps

Attach load-balanced target to a TargetGroup

May return JSON to directly add to the [Targets] list, or return undefined

if the target will register itself with the load balancer.

Parameters:targetGroup (NetworkTargetGroup) –
Return type:LoadBalancerTargetProps
Abstract:Yes

INetworkTargetGroup (interface)

class @aws-cdk/aws-elasticloadbalancingv2.INetworkTargetGroup

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.INetworkTargetGroup;
// INetworkTargetGroup is an interface
import { INetworkTargetGroup } from '@aws-cdk/aws-elasticloadbalancingv2';

A network target group

Extends:ITargetGroup
registerListener(listener)

Register a listener that is load balancing to this target group.

Don’t call this directly. It will be called by listeners.

Parameters:listener (INetworkListener) –
Abstract:Yes
export() → @aws-cdk/aws-elasticloadbalancingv2.TargetGroupImportProps

Inherited from @aws-cdk/aws-elasticloadbalancingv2.ITargetGroup

Export this target group

Return type:TargetGroupImportProps
Abstract:Yes
loadBalancerArns

Inherited from @aws-cdk/aws-elasticloadbalancingv2.ITargetGroup

A token representing a list of ARNs of the load balancers that route traffic to this target group

Type:string (readonly)
loadBalancerAttached

Inherited from @aws-cdk/aws-elasticloadbalancingv2.ITargetGroup

Return an object to depend on the listeners added to this target group

Type:@aws-cdk/cdk.IDependable (readonly)
targetGroupArn

Inherited from @aws-cdk/aws-elasticloadbalancingv2.ITargetGroup

ARN of the target group

Type:string (readonly)
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

ITargetGroup (interface)

class @aws-cdk/aws-elasticloadbalancingv2.ITargetGroup

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.ITargetGroup;
// ITargetGroup is an interface
import { ITargetGroup } from '@aws-cdk/aws-elasticloadbalancingv2';

A target group

Extends:@aws-cdk/cdk.IConstruct
loadBalancerArns

A token representing a list of ARNs of the load balancers that route traffic to this target group

Type:string (readonly)
loadBalancerAttached

Return an object to depend on the listeners added to this target group

Type:@aws-cdk/cdk.IDependable (readonly)
targetGroupArn

ARN of the target group

Type:string (readonly)
export() → @aws-cdk/aws-elasticloadbalancingv2.TargetGroupImportProps

Export this target group

Return type:TargetGroupImportProps
Abstract:Yes
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

InstanceTarget

class @aws-cdk/aws-elasticloadbalancingv2.InstanceTarget(instanceId[, port])

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.InstanceTarget;
const { InstanceTarget } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { InstanceTarget } from '@aws-cdk/aws-elasticloadbalancingv2';

An EC2 instance that is the target for load balancing

If you register a target of this type, you are responsible for making

sure the load balancer’s security group can connect to the instance.

Implements:

IApplicationLoadBalancerTarget

Implements:

INetworkLoadBalancerTarget

Parameters:
  • instanceId (string) – Instance ID of the instance to register to
  • port (number (optional)) – Override the default port for the target group
attachToApplicationTargetGroup(targetGroup) → @aws-cdk/aws-elasticloadbalancingv2.LoadBalancerTargetProps

Implements @aws-cdk/aws-elasticloadbalancingv2.IApplicationLoadBalancerTarget.attachToApplicationTargetGroup()

Register this instance target with a load balancer

Don’t call this, it is called automatically when you add the target to a

load balancer.

Parameters:targetGroup (ApplicationTargetGroup) –
Return type:LoadBalancerTargetProps
attachToNetworkTargetGroup(targetGroup) → @aws-cdk/aws-elasticloadbalancingv2.LoadBalancerTargetProps

Implements @aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancerTarget.attachToNetworkTargetGroup()

Register this instance target with a load balancer

Don’t call this, it is called automatically when you add the target to a

load balancer.

Parameters:targetGroup (NetworkTargetGroup) –
Return type:LoadBalancerTargetProps
instanceId

Instance ID of the instance to register to

Type:string (readonly)
port

Override the default port for the target group

Type:number (optional) (readonly)

IpAddressType (enum)

class @aws-cdk/aws-elasticloadbalancingv2.IpAddressType

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.IpAddressType;
const { IpAddressType } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { IpAddressType } from '@aws-cdk/aws-elasticloadbalancingv2';

What kind of addresses to allocate to the load balancer

Ipv4

Allocate IPv4 addresses

DualStack

Allocate both IPv4 and IPv6 addresses

IpTarget

class @aws-cdk/aws-elasticloadbalancingv2.IpTarget(ipAddress[, port[, availabilityZone]])

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.IpTarget;
const { IpTarget } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { IpTarget } from '@aws-cdk/aws-elasticloadbalancingv2';

An IP address that is a target for load balancing.

Specify IP addresses from the subnets of the virtual private cloud (VPC) for

the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and

192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can’t specify

publicly routable IP addresses.

If you register a target of this type, you are responsible for making

sure the load balancer’s security group can send packets to the IP address.

Implements:

IApplicationLoadBalancerTarget

Implements:

INetworkLoadBalancerTarget

Parameters:
  • ipAddress (string) – The IP Address to load balance to
  • port (number (optional)) – Override the group’s default port
  • availabilityZone (string (optional)) – Availability zone to send traffic from
attachToApplicationTargetGroup(targetGroup) → @aws-cdk/aws-elasticloadbalancingv2.LoadBalancerTargetProps

Implements @aws-cdk/aws-elasticloadbalancingv2.IApplicationLoadBalancerTarget.attachToApplicationTargetGroup()

Register this instance target with a load balancer

Don’t call this, it is called automatically when you add the target to a

load balancer.

Parameters:targetGroup (ApplicationTargetGroup) –
Return type:LoadBalancerTargetProps
attachToNetworkTargetGroup(targetGroup) → @aws-cdk/aws-elasticloadbalancingv2.LoadBalancerTargetProps

Implements @aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancerTarget.attachToNetworkTargetGroup()

Register this instance target with a load balancer

Don’t call this, it is called automatically when you add the target to a

load balancer.

Parameters:targetGroup (NetworkTargetGroup) –
Return type:LoadBalancerTargetProps
ipAddress

The IP Address to load balance to

Type:string (readonly)
availabilityZone

Availability zone to send traffic from

Type:string (optional) (readonly)
port

Override the group’s default port

Type:number (optional) (readonly)

LoadBalancerTargetProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.LoadBalancerTargetProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.LoadBalancerTargetProps;
// LoadBalancerTargetProps is an interface
import { LoadBalancerTargetProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Result of attaching a target to load balancer

targetType

What kind of target this is

Type:TargetType
targetJson

JSON representing the target’s direct addition to the TargetGroup list

May be omitted if the target is going to register itself later.

Type:any (optional)

NetworkListener

class @aws-cdk/aws-elasticloadbalancingv2.NetworkListener(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.NetworkListener;
const { NetworkListener } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { NetworkListener } from '@aws-cdk/aws-elasticloadbalancingv2';

Define a Network Listener

Extends:

BaseListener

Implements:

INetworkListener

Parameters:
static import(scope, id, props) → @aws-cdk/aws-elasticloadbalancingv2.INetworkListener

Import an existing listener

Parameters:
Return type:

INetworkListener

addTargetGroups(_id, *targetGroups)

Load balance incoming requests to the given target groups.

Parameters:
addTargets(id, props) → @aws-cdk/aws-elasticloadbalancingv2.NetworkTargetGroup

Load balance incoming requests to the given load balancing targets.

This method implicitly creates an ApplicationTargetGroup for the targets

involved.

Parameters:
Returns:

The newly created target group

Return type:

NetworkTargetGroup

export() → @aws-cdk/aws-elasticloadbalancingv2.NetworkListenerImportProps

Implements @aws-cdk/aws-elasticloadbalancingv2.INetworkListener.export()

Export this listener

Return type:NetworkListenerImportProps
validate() → string[]

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseListener

Validate this listener

Protected method

Return type:string[]
listenerArn

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseListener

Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

NetworkListenerImportProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.NetworkListenerImportProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.NetworkListenerImportProps;
// NetworkListenerImportProps is an interface
import { NetworkListenerImportProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties to reference an existing listener

listenerArn

ARN of the listener

Type:string

NetworkListenerProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.NetworkListenerProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.NetworkListenerProps;
// NetworkListenerProps is an interface
import { NetworkListenerProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for a Network Listener attached to a Load Balancer

Extends:BaseNetworkListenerProps
loadBalancer

The load balancer to attach this listener to

Type:INetworkLoadBalancer
port

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseNetworkListenerProps

The port on which the listener listens for requests.

Type:number
defaultTargetGroups

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseNetworkListenerProps

Default target groups to load balance to

Type:INetworkTargetGroup[] (optional)
Default:None

NetworkLoadBalancer

class @aws-cdk/aws-elasticloadbalancingv2.NetworkLoadBalancer(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.NetworkLoadBalancer;
const { NetworkLoadBalancer } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { NetworkLoadBalancer } from '@aws-cdk/aws-elasticloadbalancingv2';

Define a new network load balancer

Extends:

BaseLoadBalancer

Implements:

INetworkLoadBalancer

Parameters:
static import(scope, id, props) → @aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancer
Parameters:
Return type:

INetworkLoadBalancer

addListener(id, props) → @aws-cdk/aws-elasticloadbalancingv2.NetworkListener

Implements @aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancer.addListener()

Add a listener to this load balancer

Parameters:
Returns:

The newly created listener

Return type:

NetworkListener

export() → @aws-cdk/aws-elasticloadbalancingv2.NetworkLoadBalancerImportProps

Implements @aws-cdk/aws-elasticloadbalancingv2.INetworkLoadBalancer.export()

Export this load balancer

Return type:NetworkLoadBalancerImportProps
metric(metricName[, props]) → @aws-cdk/aws-cloudwatch.Metric

Return the given named metric for this Network Load Balancer

Parameters:
Return type:

@aws-cdk/aws-cloudwatch.Metric

metricActiveFlowCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The total number of concurrent TCP flows (or connections) from clients to targets.

This metric includes connections in the SYN_SENT and ESTABLISHED states.

TCP connections are not terminated at the load balancer, so a client

opening a TCP connection to a target counts as a single flow.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricConsumedLCUs([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of load balancer capacity units (LCU) used by your load balancer.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricHealthyHostCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of targets that are considered healthy.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricNewFlowCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The total number of new TCP flows (or connections) established from clients to targets in the time period.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricProcessedBytes([props]) → @aws-cdk/aws-cloudwatch.Metric

The total number of bytes processed by the load balancer, including TCP/IP headers.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricTcpClientResetCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The total number of reset (RST) packets sent from a client to a target.

These resets are generated by the client and forwarded by the load balancer.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricTcpElbResetCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The total number of reset (RST) packets generated by the load balancer.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricTcpTargetResetCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The total number of reset (RST) packets sent from a target to a client.

These resets are generated by the target and forwarded by the load balancer.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
metricUnHealthyHostCount([props]) → @aws-cdk/aws-cloudwatch.Metric

The number of targets that are considered unhealthy.

Parameters:props (@aws-cdk/aws-cloudwatch.MetricCustomization (optional)) –
Return type:@aws-cdk/aws-cloudwatch.Metric
asAliasRecordTarget() → @aws-cdk/aws-route53.AliasRecordTargetProps

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

Return hosted zone ID and DNS name, usable for Route53 alias targets

Return type:@aws-cdk/aws-route53.AliasRecordTargetProps
removeAttribute(key)

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

Remove an attribute from the load balancer

Parameters:key (string) –
setAttribute(key[, value])

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

Set a non-standard attribute on the load balancer

Parameters:
  • key (string) –
  • value (string (optional)) –
canonicalHostedZoneId

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The canonical hosted zone ID of this load balancer

Type:string (readonly)
dnsName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The DNS name of this load balancer

Type:string (readonly)
fullName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The full name of this load balancer

Type:string (readonly)
loadBalancerArn

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The ARN of this load balancer

Type:string (readonly)
loadBalancerName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The name of this load balancer

Type:string (readonly)
vpc

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancer

The VPC this load balancer has been created in, if available

If the Load Balancer was imported, the VPC is not available.

Type:@aws-cdk/aws-ec2.IVpcNetwork (optional) (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

NetworkLoadBalancerImportProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.NetworkLoadBalancerImportProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.NetworkLoadBalancerImportProps;
// NetworkLoadBalancerImportProps is an interface
import { NetworkLoadBalancerImportProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties to reference an existing load balancer

loadBalancerArn

ARN of the load balancer

Type:string

NetworkLoadBalancerProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.NetworkLoadBalancerProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.NetworkLoadBalancerProps;
// NetworkLoadBalancerProps is an interface
import { NetworkLoadBalancerProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for a network load balancer

Extends:BaseLoadBalancerProps
crossZoneEnabled

Indicates whether cross-zone load balancing is enabled.

Type:boolean (optional)
Default:false
vpc

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancerProps

The VPC network to place the load balancer in

Type:@aws-cdk/aws-ec2.IVpcNetwork
deletionProtection

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancerProps

Indicates whether deletion protection is enabled.

Type:boolean (optional)
Default:false
internetFacing

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancerProps

Whether the load balancer has an internet-routable address

Type:boolean (optional)
Default:false
loadBalancerName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancerProps

Name of the load balancer

Type:string (optional)
Default:Automatically generated name
vpcPlacement

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseLoadBalancerProps

Where in the VPC to place the load balancer

Type:@aws-cdk/aws-ec2.VpcPlacementStrategy (optional)
Default:Public subnets if internetFacing, otherwise private subnets

NetworkTargetGroup

class @aws-cdk/aws-elasticloadbalancingv2.NetworkTargetGroup(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.NetworkTargetGroup;
const { NetworkTargetGroup } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { NetworkTargetGroup } from '@aws-cdk/aws-elasticloadbalancingv2';

Define a Network Target Group

Extends:

TargetGroupBase

Implements:

INetworkTargetGroup

Parameters:
static import(scope, id, props) → @aws-cdk/aws-elasticloadbalancingv2.INetworkTargetGroup

Import an existing listener

Parameters:
Return type:

INetworkTargetGroup

addTarget(*targets)

Add a load balancing target to this target group

Parameters:*targets (INetworkLoadBalancerTarget) –
registerListener(listener)

Implements @aws-cdk/aws-elasticloadbalancingv2.INetworkTargetGroup.registerListener()

Register a listener that is load balancing to this target group.

Don’t call this directly. It will be called by listeners.

Parameters:listener (INetworkListener) –
firstLoadBalancerFullName

Implements @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase.firstLoadBalancerFullName()

Full name of first load balancer

Type:string (readonly)
addLoadBalancerTarget(props)

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Register the given load balancing target as part of this group

Protected method

Parameters:props (LoadBalancerTargetProps) –
asCodeDeployLoadBalancer() → @aws-cdk/aws-codedeploy-api.ILoadBalancerProps

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Specify the CodeDeploy-required properties of this load balancer.

Return type:@aws-cdk/aws-codedeploy-api.ILoadBalancerProps
configureHealthCheck(healthCheck)

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Set/replace the target group’s health check

Parameters:healthCheck (HealthCheck) –
export() → @aws-cdk/aws-elasticloadbalancingv2.TargetGroupImportProps

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Export this target group

Return type:TargetGroupImportProps
setAttribute(key[, value])

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Set a non-standard attribute on the target group

Parameters:
  • key (string) –
  • value (string (optional)) –
defaultPort

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Default port configured for members of this target group

Protected property

Type:string (readonly)
loadBalancerArns

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Health check for the members of this target group

A token representing a list of ARNs of the load balancers that route traffic to this target group

Type:string (readonly)
loadBalancerAttached

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer

Type:@aws-cdk/cdk.IDependable (readonly)
loadBalancerAttachedDependencies

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Configurable dependable with all resources that lead to load balancer attachment

Protected property

Type:@aws-cdk/cdk.ConcreteDependable (readonly)
targetGroupArn

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

The ARN of the target group

Type:string (readonly)
targetGroupFullName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

The full name of the target group

Type:string (readonly)
targetGroupLoadBalancerArns

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

ARNs of load balancers load balancing to this TargetGroup

Type:string[] (readonly)
targetGroupName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

The name of the target group

Type:string (readonly)
healthCheck

Inherited from @aws-cdk/aws-elasticloadbalancingv2.TargetGroupBase

Type:HealthCheck
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

NetworkTargetGroupProps (interface)

class @aws-cdk/aws-elasticloadbalancingv2.NetworkTargetGroupProps

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.NetworkTargetGroupProps;
// NetworkTargetGroupProps is an interface
import { NetworkTargetGroupProps } from '@aws-cdk/aws-elasticloadbalancingv2';

Properties for a new Network Target Group

Extends:BaseTargetGroupProps
port

The port on which the listener listens for requests.

Type:number
proxyProtocolV2

Indicates whether Proxy Protocol version 2 is enabled.

Type:boolean (optional)
Default:false
targets

The targets to add to this target group.

Can be Instance, IPAddress, or any self-registering load balancing

target. If you use either Instance or IPAddress as targets, all

target must be of the same type.

Type:INetworkLoadBalancerTarget[] (optional)
vpc

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseTargetGroupProps

The virtual private cloud (VPC).

Type:@aws-cdk/aws-ec2.IVpcNetwork
deregistrationDelaySec

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseTargetGroupProps

The amount of time for Elastic Load Balancing to wait before deregistering a target.

The range is 0–3600 seconds.

Type:number (optional)
Default:300
healthCheck

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseTargetGroupProps

Health check configuration

Type:HealthCheck (optional)
Default:No health check
targetGroupName

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseTargetGroupProps

The name of the target group.

This name must be unique per region per account, can have a maximum of

32 characters, must contain only alphanumeric characters or hyphens, and

must not begin or end with a hyphen.

Type:string (optional)
Default:Automatically generated
targetType

Inherited from @aws-cdk/aws-elasticloadbalancingv2.BaseTargetGroupProps

The type of targets registered to this TargetGroup, either IP or Instance.

All targets registered into the group must be of this type. If you

register targets to the TargetGroup in the CDK app, the TargetType is

determined automatically.

Type:TargetType (optional)
Default:Determined automatically

Protocol (enum)

class @aws-cdk/aws-elasticloadbalancingv2.Protocol

Language-specific names:

using Amazon.CDK.AWS.ElasticLoadBalancingV2;
import software.amazon.awscdk.services.elasticloadbalancingv2.Protocol;
const { Protocol } = require('@aws-cdk/aws-elasticloadbalancingv2');
import { Protocol } from '@aws-cdk/aws-elasticloadbalancingv2';

Backend protocol for health checks

Http

HTTP

Https

HTTPS

Tcp

TCP

SslPolicy (enum)

class @aws-cdk/aws-elasticloadbalancingv2.SslPolicy

Language-specific names: