software.amazon.awscdk.services.ecs.patterns

Interface NetworkLoadBalancerProps

All Known Implementing Classes:

NetworkLoadBalancerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:01.643Z")
public interface NetworkLoadBalancerProps

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 and Description
static class	NetworkLoadBalancerProps.Builder A builder for NetworkLoadBalancerProps
static class	NetworkLoadBalancerProps.Jsii$Proxy An implementation for NetworkLoadBalancerProps

Method Summary

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

Method Detail

getListeners

java.util.List<NetworkListenerProps> getListeners()

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

Default: - none

getName

java.lang.String getName()

Name of the load balancer.

getDomainName

default java.lang.String getDomainName()

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

Default: - No domain name.

getDomainZone

default IHostedZone getDomainZone()

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

Default: - No Route53 hosted domain zone.

getPublicLoadBalancer

default java.lang.Boolean getPublicLoadBalancer()

Determines whether the Load Balancer will be internet-facing.

Default: true

builder

static NetworkLoadBalancerProps.Builder builder()

Returns:

a NetworkLoadBalancerProps.Builder of NetworkLoadBalancerProps