Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface ApplicationLoadBalancerAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApplicationLoadBalancerAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:15.184Z")
@Stability(Stable)
public interface ApplicationLoadBalancerAttributes
extends software.amazon.jsii.JsiiSerializable

Properties to reference an existing load balancer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 Vpc vpc;
 ApplicationLoadBalancerAttributes applicationLoadBalancerAttributes = ApplicationLoadBalancerAttributes.builder()
         .loadBalancerArn("loadBalancerArn")
         .securityGroupId("securityGroupId")
         // the properties below are optional
         .loadBalancerCanonicalHostedZoneId("loadBalancerCanonicalHostedZoneId")
         .loadBalancerDnsName("loadBalancerDnsName")
         .securityGroupAllowsAllOutbound(false)
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ApplicationLoadBalancerAttributes.Builder	A builder for ApplicationLoadBalancerAttributes
static final class	ApplicationLoadBalancerAttributes.Jsii$Proxy	An implementation for ApplicationLoadBalancerAttributes

Method Summary

Modifier and Type	Method	Description
static ApplicationLoadBalancerAttributes.Builder	builder()
String	getLoadBalancerArn()	ARN of the load balancer.
default String	getLoadBalancerCanonicalHostedZoneId()	The canonical hosted zone ID of this load balancer.
default String	getLoadBalancerDnsName()	The DNS name of this load balancer.
default Boolean	getSecurityGroupAllowsAllOutbound()	Whether the security group allows all outbound traffic or not.
String	getSecurityGroupId()	ID of the load balancer's security group.
default IVpc	getVpc()	The VPC this load balancer has been created in, if available.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLoadBalancerArn

@Stability(Stable)
@NotNull
String getLoadBalancerArn()

ARN of the load balancer.

getSecurityGroupId

@Stability(Stable)
@NotNull
String getSecurityGroupId()

ID of the load balancer's security group.

getLoadBalancerCanonicalHostedZoneId

@Stability(Stable)
@Nullable
default String getLoadBalancerCanonicalHostedZoneId()

The canonical hosted zone ID of this load balancer.

Default: - When not provided, LB cannot be used as Route53 Alias target.

getLoadBalancerDnsName

@Stability(Stable)
@Nullable
default String getLoadBalancerDnsName()

The DNS name of this load balancer.

Default: - When not provided, LB cannot be used as Route53 Alias target.

getSecurityGroupAllowsAllOutbound

@Stability(Stable)
@Nullable
default Boolean getSecurityGroupAllowsAllOutbound()

Whether the security group allows all outbound traffic or not.

Unless set to false, no egress rules will be added to the security group.

Default: true

getVpc

@Stability(Stable)
@Nullable
default IVpc getVpc()

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

Default: - If the Load Balancer was imported and a VPC was not specified, the VPC is not available.

builder

@Stability(Stable)
static ApplicationLoadBalancerAttributes.Builder builder()

Returns:

a ApplicationLoadBalancerAttributes.Builder of ApplicationLoadBalancerAttributes