BaseLoadBalancer

class aws_cdk.aws_elasticloadbalancingv2.BaseLoadBalancer(scope, id, base_props, additional_props)

Bases: aws_cdk.core.Resource

Base class for both Application and Network Load Balancers.

Parameters

Methods

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

remove_attribute(key)

Remove an attribute from the load balancer.

Parameters

key (str) –

Return type

None

set_attribute(key, value=None)

Set a non-standard attribute on the load balancer.

Parameters
  • key (str) –

  • value (Optional[str]) –

See

https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

env

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.

Return type

ResourceEnvironment

load_balancer_arn

The ARN of this load balancer.

Attribute

true

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
arn:aws:elasticloadbalancing:us-west-2123456789012loadbalancer / app / my - internal - load - balancer / 50dc6c495c0c9188
Return type

str

load_balancer_canonical_hosted_zone_id

The canonical hosted zone ID of this load balancer.

Attribute

true

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
Z2P70J7EXAMPLE
Return type

str

load_balancer_dns_name

The DNS name of this load balancer.

Attribute

true

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
my - load - balancer - 424835706.us - west - 2.elb.amazonaws.com
Return type

str

load_balancer_full_name

The full name of this load balancer.

Attribute

true

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
app / my - load - balancer / 50dc6c495c0c9188
Return type

str

load_balancer_name

The name of this load balancer.

Attribute

true

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
my - load - balancer
Return type

str

load_balancer_security_groups

true

Type

attribute

Return type

List[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

vpc

The VPC this load balancer has been created in.

Return type

IVpc

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool