ApplicationLoadBalancer

class aws_cdk.aws_elasticloadbalancingv2.ApplicationLoadBalancer(scope, id, *, http2_enabled=None, idle_timeout=None, ip_address_type=None, security_group=None, vpc, deletion_protection=None, internet_facing=None, load_balancer_name=None, vpc_subnets=None)

Bases: BaseLoadBalancer

Define an Application Load Balancer.

Resource: AWS::ElasticLoadBalancingV2::LoadBalancer
ExampleMetadata: infused

Example:

from aws_cdk.aws_apigatewayv2_integrations import HttpAlbIntegration


vpc = ec2.Vpc(self, "VPC")
lb = elbv2.ApplicationLoadBalancer(self, "lb", vpc=vpc)
listener = lb.add_listener("listener", port=80)
listener.add_targets("target",
    port=80
)

http_endpoint = apigwv2.HttpApi(self, "HttpProxyPrivateApi",
    default_integration=HttpAlbIntegration("DefaultIntegration", listener)
)

Parameters

scope (Construct) –
id (str) –
http2_enabled (Optional[bool]) – Indicates whether HTTP/2 is enabled. Default: true
idle_timeout (Optional[Duration]) – The load balancer idle timeout, in seconds. Default: 60
ip_address_type (Optional[IpAddressType]) – The type of IP addresses to use. Only applies to application load balancers. Default: IpAddressType.Ipv4
security_group (Optional[ISecurityGroup]) – Security group to associate with this load balancer. Default: A security group is created
vpc (IVpc) – The VPC network to place the load balancer in.
deletion_protection (Optional[bool]) – Indicates whether deletion protection is enabled. Default: false
internet_facing (Optional[bool]) – Whether the load balancer has an internet-routable address. Default: false
load_balancer_name (Optional[str]) – Name of the load balancer. Default: - Automatically generated name.
vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – Which subnets place the load balancer in. Default: - the Vpc default strategy.

Methods

add_listener(id, *, certificate_arns=None, certificates=None, default_action=None, default_target_groups=None, open=None, port=None, protocol=None, ssl_policy=None)

Add a new listener to this load balancer.

Parameters

id (str) –
certificate_arns (Optional[Sequence[str]]) – (deprecated) The certificates to use on this listener. Default: - No certificates.
certificates (Optional[Sequence[IListenerCertificate]]) – Certificate list of ACM cert ARNs. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. Default: - No certificates.
default_action (Optional[ListenerAction]) – Default action to take for requests to this listener. This allows full control of the default action of the load balancer, including Action chaining, fixed responses and redirect responses. See the ListenerAction class for all options. Cannot be specified together with defaultTargetGroups. Default: - None.
default_target_groups (Optional[Sequence[IApplicationTargetGroup]]) – Default target groups to load balance to. All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use either defaultAction or addAction(). Cannot be specified together with defaultAction. Default: - None.
open (Optional[bool]) – Allow anyone to connect to the load balancer on the listener port. If this is specified, the load balancer 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 load balancer on the listener port. Default: true
port (Union[int, float, None]) – The port on which the listener listens for requests. Default: - Determined from protocol if known.
protocol (Optional[ApplicationProtocol]) – The protocol to use. Default: - Determined from port if known.
ssl_policy (Optional[SslPolicy]) – The security policy that defines which ciphers and protocols are supported. Default: - The current predefined security policy.

Return type

ApplicationListener

add_redirect(*, open=None, source_port=None, source_protocol=None, target_port=None, target_protocol=None)

Add a redirection listener to this load balancer.

Parameters

open (Optional[bool]) – 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. Default: true
source_port (Union[int, float, None]) – The port number to listen to. Default: 80
source_protocol (Optional[ApplicationProtocol]) – The protocol of the listener being created. Default: HTTP
target_port (Union[int, float, None]) – The port number to redirect to. Default: 443
target_protocol (Optional[ApplicationProtocol]) – The protocol of the redirection target. Default: HTTPS

Return type

ApplicationListener

add_security_group(security_group)

Add a security group to this load balancer.

Parameters

security_group (ISecurityGroup) –

Return type

None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

log_access_logs(bucket, prefix=None)

Enable access logging for this load balancer.

A region must be specified on the stack containing the load balancer; you cannot enable logging on environment-agnostic stacks. See https://docs.aws.amazon.com/cdk/latest/guide/environments.html

Parameters

bucket (IBucket) –
prefix (Optional[str]) –

Return type

None

metric(metric_name, *, account=None, color=None, dimensions=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)

Return the given named metric for this Application Load Balancer.

Parameters

metric_name (str) –
account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – (deprecated) Dimensions of the metric. Default: - No dimensions.
dimensions_map (Optional[Mapping[str, str]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph’s legend. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Default

Average over 5 minutes

Return type