interface IApplicationLoadBalancer
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ElasticLoadBalancingV2.IApplicationLoadBalancer |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2#IApplicationLoadBalancer |
![]() | software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancer |
![]() | aws_cdk.aws_elasticloadbalancingv2.IApplicationLoadBalancer |
![]() | aws-cdk-lib » aws_elasticloadbalancingv2 » IApplicationLoadBalancer |
Implemented by
Application
Obtainable from
Application
.fromApplicationLoadBalancerAttributes()
, Application
.fromLookup()
An application load balancer.
Properties
Name | Type | Description |
---|---|---|
connections | Connections | The network connections associated with this resource. |
env | Resource | The environment this resource belongs to. |
listeners | Application [] | A list of listeners that have been added to the load balancer. |
load | string | The ARN of this load balancer. |
load | string | The canonical hosted zone ID of this load balancer. |
load | string | The DNS name of this load balancer. |
metrics | IApplication | All metrics available for this load balancer. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
ip | Ip | The IP Address Type for this load balancer. |
vpc? | IVpc | The VPC this load balancer has been created in (if available). |
connections
Type:
Connections
The network connections associated with this resource.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
listeners
Type:
Application
[]
A list of listeners that have been added to the load balancer.
This list is only valid for owned constructs.
loadBalancerArn
Type:
string
The ARN of this load balancer.
loadBalancerCanonicalHostedZoneId
Type:
string
The canonical hosted zone ID of this load balancer.
Example value: Z2P70J7EXAMPLE
loadBalancerDnsName
Type:
string
The DNS name of this load balancer.
Example value: my-load-balancer-424835706.us-west-2.elb.amazonaws.com
metrics
Type:
IApplication
All metrics available for this load balancer.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
ipAddressType?
Type:
Ip
(optional, default: IpAddressType.IPV4)
The IP Address Type for this load balancer.
If the @aws-cdk/aws-elasticloadbalancingV2:albDualstackWithoutPublicIpv4SecurityGroupRulesDefault
feature flag is set (the default for new projects), and addListener()
is called with open: true
,
the load balancer's security group will automatically include both IPv4 and IPv6 ingress rules
when using IpAddressType.DUAL_STACK_WITHOUT_PUBLIC_IPV4
.
For existing projects that only have IPv4 rules, you can opt-in to IPv6 ingress rules by enabling the feature flag in your cdk.json file. Note that enabling this feature flag will modify existing security group rules.
vpc?
Type:
IVpc
(optional)
The VPC this load balancer has been created in (if available).
If this interface is the result of an import call to fromApplicationLoadBalancerAttributes, the vpc attribute will be undefined unless specified in the optional properties of that method.
Methods
Name | Description |
---|---|
add | Add a new listener to this load balancer. |
apply | Apply the given removal policy to this resource. |
addListener(id, props)
public addListener(id: string, props: BaseApplicationListenerProps): ApplicationListener
Parameters
- id
string
- props
Base
Application Listener Props
Returns
Add a new listener to this load balancer.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
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
).