ApplicationLoadBalancerAttributes

class aws_cdk.aws_elasticloadbalancingv2.ApplicationLoadBalancerAttributes(*, load_balancer_arn, security_group_id, load_balancer_canonical_hosted_zone_id=None, load_balancer_dns_name=None, security_group_allows_all_outbound=None, vpc=None)

Bases: object

Properties to reference an existing load balancer.

Parameters

  • load_balancer_arn (str) – ARN of the load balancer.

  • security_group_id (str) – ID of the load balancer’s security group.

  • load_balancer_canonical_hosted_zone_id (Optional[str]) – The canonical hosted zone ID of this load balancer. Default: - When not provided, LB cannot be used as Route53 Alias target.

  • load_balancer_dns_name (Optional[str]) – The DNS name of this load balancer. Default: - When not provided, LB cannot be used as Route53 Alias target.

  • security_group_allows_all_outbound (Optional[bool]) – 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

  • vpc (Optional[IVpc]) – 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.

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_elasticloadbalancingv2 as elbv2

# vpc: ec2.Vpc

application_load_balancer_attributes = elbv2.ApplicationLoadBalancerAttributes(
    load_balancer_arn="loadBalancerArn",
    security_group_id="securityGroupId",

    # the properties below are optional
    load_balancer_canonical_hosted_zone_id="loadBalancerCanonicalHostedZoneId",
    load_balancer_dns_name="loadBalancerDnsName",
    security_group_allows_all_outbound=False,
    vpc=vpc
)

Attributes

load_balancer_arn

ARN of the load balancer.

Return type

str

load_balancer_canonical_hosted_zone_id

The canonical hosted zone ID of this load balancer.

Default

  • When not provided, LB cannot be used as Route53 Alias target.

Return type

Optional[str]

load_balancer_dns_name

The DNS name of this load balancer.

Default

  • When not provided, LB cannot be used as Route53 Alias target.

Return type

Optional[str]

security_group_allows_all_outbound

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

Return type

Optional[bool]

security_group_id

ID of the load balancer’s security group.

Return type

str

vpc

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.

Return type

Optional[IVpc]