interface NetworkLoadBalancerProps

Language	Type name
.NET	Amazon.CDK.AWS.ECS.Patterns.NetworkLoadBalancerProps
Java	software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancerProps
Python	aws_cdk.aws_ecs_patterns.NetworkLoadBalancerProps
TypeScript (source)	@aws-cdk/aws-ecs-patterns » 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 * as ecs_patterns from '@aws-cdk/aws-ecs-patterns';
import * as route53 from '@aws-cdk/aws-route53';

declare const hostedZone: route53.HostedZone;
const networkLoadBalancerProps: ecs_patterns.NetworkLoadBalancerProps = {
  listeners: [{
    name: 'name',

    // the properties below are optional
    port: 123,
  }],
  name: 'name',

  // the properties below are optional
  domainName: 'domainName',
  domainZone: hostedZone,
  publicLoadBalancer: false,
};

Properties

Name	Type	Description
listeners	NetworkListenerProps[]	Listeners (at least one listener) attached to this load balancer.
name	string	Name of the load balancer.
domainName?	string	The domain name for the service, e.g. "api.example.com.".
domainZone?	IHostedZone	The Route53 hosted zone for the domain, e.g. "example.com.".
publicLoadBalancer?	boolean	Determines whether the Load Balancer will be internet-facing.

---

listeners

Type: NetworkListenerProps[]

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

---

name

Type: string

Name of the load balancer.

---

domainName?

Type: string (optional, default: No domain name.)

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

---

domainZone?

Type: IHostedZone (optional, default: No Route53 hosted domain zone.)

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

---

publicLoadBalancer?

Type: boolean (optional, default: true)

Determines whether the Load Balancer will be internet-facing.