Class BaseLoadBalancer

Base class for both Application and Network Load Balancers.

Inheritance
System.Object
Construct
Resource
BaseLoadBalancer
ApplicationLoadBalancer
NetworkLoadBalancer
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.AWS.ElasticLoadBalancingV2.dll
Syntax (csharp)
public abstract class BaseLoadBalancer : Resource, IResource, IConstruct, IDependable
Syntax (vb)
Public MustInherit Class BaseLoadBalancer
    Inherits Resource
    Implements IResource, IConstruct, IDependable

Synopsis

Constructors

BaseLoadBalancer(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
BaseLoadBalancer(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
BaseLoadBalancer(Construct, String, IBaseLoadBalancerProps, Object)

Properties

LoadBalancerArn

The ARN of this load balancer.
LoadBalancerCanonicalHostedZoneId

The canonical hosted zone ID of this load balancer.
LoadBalancerDnsName

The DNS name of this load balancer.
LoadBalancerFullName

The full name of this load balancer.
LoadBalancerName

The name of this load balancer.
LoadBalancerSecurityGroups
Vpc

The VPC this load balancer has been created in.

Methods

LogAccessLogs(IBucket, String)

Enable access logging for this load balancer.
RemoveAttribute(String)

Remove an attribute from the load balancer.
SetAttribute(String, String)

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

Validate the current construct.

Constructors

BaseLoadBalancer(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected BaseLoadBalancer(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

BaseLoadBalancer(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected BaseLoadBalancer(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

BaseLoadBalancer(Construct, String, IBaseLoadBalancerProps, Object)

protected BaseLoadBalancer(Construct scope, string id, IBaseLoadBalancerProps baseProps, object additionalProps)
Parameters
scope Constructs.Construct
id System.String
baseProps IBaseLoadBalancerProps
additionalProps System.Object

Properties

LoadBalancerArn

The ARN of this load balancer.

public virtual string LoadBalancerArn { get; }
Property Value

System.String

Remarks

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

Attribute: true

LoadBalancerCanonicalHostedZoneId

The canonical hosted zone ID of this load balancer.

public virtual string LoadBalancerCanonicalHostedZoneId { get; }
Property Value

System.String

Remarks

Example value: Z2P70J7EXAMPLE

Attribute: true

LoadBalancerDnsName

The DNS name of this load balancer.

public virtual string LoadBalancerDnsName { get; }
Property Value

System.String

Remarks

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

Attribute: true

LoadBalancerFullName

The full name of this load balancer.

public virtual string LoadBalancerFullName { get; }
Property Value

System.String

Remarks

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

Attribute: true

LoadBalancerName

The name of this load balancer.

public virtual string LoadBalancerName { get; }
Property Value

System.String

Remarks

Example value: my-load-balancer

Attribute: true

LoadBalancerSecurityGroups

public virtual string[] LoadBalancerSecurityGroups { get; }
Property Value

System.String[]

Remarks

Attribute: true

Vpc

The VPC this load balancer has been created in.

public virtual IVpc Vpc { get; }
Property Value

IVpc

Remarks

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

Methods

LogAccessLogs(IBucket, String)

Enable access logging for this load balancer.

public virtual void LogAccessLogs(IBucket bucket, string prefix = null)
Parameters
bucket IBucket
prefix System.String
Remarks

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

RemoveAttribute(String)

Remove an attribute from the load balancer.

public virtual void RemoveAttribute(string key)
Parameters
key System.String

SetAttribute(String, String)

Set a non-standard attribute on the load balancer.

public virtual void SetAttribute(string key, string value = null)
Parameters
key System.String
value System.String
Remarks

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

Validate()

Validate the current construct.

protected override string[] Validate()
Returns

System.String[]

Overrides
Remarks

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

Implements

Constructs.IConstruct