software.amazon.awscdk.services.elasticloadbalancingv2

Class BaseLoadBalancer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.elasticloadbalancingv2.BaseLoadBalancer

All Implemented Interfaces:

IDependable, IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Direct Known Subclasses:

ApplicationLoadBalancer, NetworkLoadBalancer

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:06.506Z")
 @Stability(value=Experimental)
public abstract class BaseLoadBalancer
extends Resource

(experimental) Base class for both Application and Network Load Balancers.

Nested Class Summary

Nested classes/interfaces inherited from class software.constructs.Construct

software.constructs.Construct.Builder

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseLoadBalancer(software.constructs.Construct scope, String id, BaseLoadBalancerProps baseProps, Object additionalProps)
protected	BaseLoadBalancer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BaseLoadBalancer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getLoadBalancerArn() (experimental) The ARN of this load balancer.
String	getLoadBalancerCanonicalHostedZoneId() (experimental) The canonical hosted zone ID of this load balancer.
String	getLoadBalancerDnsName() (experimental) The DNS name of this load balancer.
String	getLoadBalancerFullName() (experimental) The full name of this load balancer.
String	getLoadBalancerName() (experimental) The name of this load balancer.
List<String>	getLoadBalancerSecurityGroups()
IVpc	getVpc() (experimental) The VPC this load balancer has been created in.
void	logAccessLogs(IBucket bucket) (experimental) Enable access logging for this load balancer.
void	logAccessLogs(IBucket bucket, String prefix) (experimental) Enable access logging for this load balancer.
void	removeAttribute(String key) (experimental) Remove an attribute from the load balancer.
void	setAttribute(String key) (experimental) Set a non-standard attribute on the load balancer.
void	setAttribute(String key, String value) (experimental) Set a non-standard attribute on the load balancer.
protected List<String>	validate() (experimental) Validate the current construct.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

BaseLoadBalancer

protected BaseLoadBalancer(software.amazon.jsii.JsiiObjectRef objRef)

BaseLoadBalancer

protected BaseLoadBalancer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

BaseLoadBalancer

@Stability(value=Experimental)
protected BaseLoadBalancer(@NotNull
                                                          software.constructs.Construct scope,
                                                          @NotNull
                                                          String id,
                                                          @NotNull
                                                          BaseLoadBalancerProps baseProps,
                                                          @NotNull
                                                          Object additionalProps)

Parameters:

scope - This parameter is required.

id - This parameter is required.

baseProps - This parameter is required.

additionalProps - This parameter is required.

Method Detail

logAccessLogs

@Stability(value=Experimental)
public void logAccessLogs(@NotNull
                                                         IBucket bucket,
                                                         @Nullable
                                                         String prefix)

(experimental) 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 - This parameter is required.

prefix -

logAccessLogs

@Stability(value=Experimental)
public void logAccessLogs(@NotNull
                                                         IBucket bucket)

(experimental) 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 - This parameter is required.

removeAttribute

@Stability(value=Experimental)
public void removeAttribute(@NotNull
                                                           String key)

(experimental) Remove an attribute from the load balancer.

Parameters:

key - This parameter is required.

setAttribute

@Stability(value=Experimental)
public void setAttribute(@NotNull
                                                        String key,
                                                        @Nullable
                                                        String value)

(experimental) Set a non-standard attribute on the load balancer.

Parameters:

key - This parameter is required.

value -

See Also:

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

setAttribute

@Stability(value=Experimental)
public void setAttribute(@NotNull
                                                        String key)

(experimental) Set a non-standard attribute on the load balancer.

Parameters:

key - This parameter is required.

See Also:

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

validate

@Stability(value=Experimental)
 @NotNull
protected List<String> validate()

(experimental) Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Overrides:

validate in class Construct

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getLoadBalancerArn

@Stability(value=Experimental)
 @NotNull
public String getLoadBalancerArn()

(experimental) The ARN of this load balancer.

Example value: arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/50dc6c495c0c9188

getLoadBalancerCanonicalHostedZoneId

@Stability(value=Experimental)
 @NotNull
public String getLoadBalancerCanonicalHostedZoneId()

(experimental) The canonical hosted zone ID of this load balancer.

Example value: Z2P70J7EXAMPLE

getLoadBalancerDnsName

@Stability(value=Experimental)
 @NotNull
public String getLoadBalancerDnsName()

(experimental) The DNS name of this load balancer.

Example value: my-load-balancer-424835706.us-west-2.elb.amazonaws.com

getLoadBalancerFullName

@Stability(value=Experimental)
 @NotNull
public String getLoadBalancerFullName()

(experimental) The full name of this load balancer.

Example value: app/my-load-balancer/50dc6c495c0c9188

getLoadBalancerName

@Stability(value=Experimental)
 @NotNull
public String getLoadBalancerName()

(experimental) The name of this load balancer.

Example value: my-load-balancer

getLoadBalancerSecurityGroups

@Stability(value=Experimental)
 @NotNull
public List<String> getLoadBalancerSecurityGroups()

getVpc

@Stability(value=Experimental)
 @Nullable
public IVpc getVpc()

(experimental) The VPC this load balancer has been created in.

This property is always defined (not null or undefined) for sub-classes of BaseLoadBalancer.