Package software.amazon.awscdk.services.ecs.patterns

Interface NetworkLoadBalancerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NetworkLoadBalancerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:01.257Z")
@Stability(Stable)
public interface NetworkLoadBalancerProps
extends software.amazon.jsii.JsiiSerializable

Properties to define an network load balancer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.patterns.*;
 import software.amazon.awscdk.services.route53.*;
 HostedZone hostedZone;
 NetworkLoadBalancerProps networkLoadBalancerProps = NetworkLoadBalancerProps.builder()
         .listeners(List.of(NetworkListenerProps.builder()
                 .name("name")
                 // the properties below are optional
                 .port(123)
                 .build()))
         .name("name")
         // the properties below are optional
         .domainName("domainName")
         .domainZone(hostedZone)
         .publicLoadBalancer(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	NetworkLoadBalancerProps.Builder	A builder for NetworkLoadBalancerProps
static final class	NetworkLoadBalancerProps.Jsii$Proxy	An implementation for NetworkLoadBalancerProps

Method Summary

Modifier and Type	Method	Description
static NetworkLoadBalancerProps.Builder	builder()
default String	getDomainName()	The domain name for the service, e.g.
default IHostedZone	getDomainZone()	The Route53 hosted zone for the domain, e.g.
List<NetworkListenerProps>	getListeners()	Listeners (at least one listener) attached to this load balancer.
String	getName()	Name of the load balancer.
default Boolean	getPublicLoadBalancer()	Determines whether the Load Balancer will be internet-facing.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getListeners

@Stability(Stable)
@NotNull
List<NetworkListenerProps> getListeners()

Listeners (at least one listener) attached to this load balancer.

Default: - none

getName

@Stability(Stable)
@NotNull
String getName()

Name of the load balancer.

getDomainName

@Stability(Stable)
@Nullable
default String getDomainName()

The domain name for the service, e.g. "api.example.com.".

Default: - No domain name.

getDomainZone

@Stability(Stable)
@Nullable
default IHostedZone getDomainZone()

The Route53 hosted zone for the domain, e.g. "example.com.".

Default: - No Route53 hosted domain zone.

getPublicLoadBalancer

@Stability(Stable)
@Nullable
default Boolean getPublicLoadBalancer()

Determines whether the Load Balancer will be internet-facing.

Default: true

builder

@Stability(Stable)
static NetworkLoadBalancerProps.Builder builder()

Returns:

a NetworkLoadBalancerProps.Builder of NetworkLoadBalancerProps