BaseLoadBalancer
- class aws_cdk.aws_elasticloadbalancingv2.BaseLoadBalancer(scope, id, base_props, additional_props)
Bases:
Resource
Base class for both Application and Network Load Balancers.
- Parameters:
scope (
Construct
) –id (
str
) –base_props (
Union
[BaseLoadBalancerProps
,Dict
[str
,Any
]]) –additional_props (
Any
) –
Methods
- 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
- 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:
- 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.
- load_balancer_arn
The ARN of this load balancer.
Example value:
arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/50dc6c495c0c9188
- Attribute:
true
- load_balancer_canonical_hosted_zone_id
The canonical hosted zone ID of this load balancer.
Example value:
Z2P70J7EXAMPLE
- Attribute:
true
- load_balancer_dns_name
The DNS name of this load balancer.
Example value:
my-load-balancer-424835706.us-west-2.elb.amazonaws.com
- Attribute:
true
- load_balancer_full_name
The full name of this load balancer.
Example value:
app/my-load-balancer/50dc6c495c0c9188
- Attribute:
true
- load_balancer_name
The name of this load balancer.
Example value:
my-load-balancer
- Attribute:
true
- load_balancer_security_groups
true
- Type:
attribute
- node
The tree node.
- stack
The stack in which this resource is defined.
- vpc
The VPC this load balancer has been created in.
This property is always defined (not
null
orundefined
) for sub-classes ofBaseLoadBalancer
.
Static Methods
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool