interface NetworkLoadBalancerProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ECS.Patterns.NetworkLoadBalancerProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsecspatterns#NetworkLoadBalancerProps |
![]() | software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancerProps |
![]() | aws_cdk.aws_ecs_patterns.NetworkLoadBalancerProps |
![]() | aws-cdk-lib » 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 { aws_ecs_patterns as ecs_patterns } from 'aws-cdk-lib';
import { aws_route53 as route53 } from 'aws-cdk-lib';
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 | Network [] | Listeners (at least one listener) attached to this load balancer. |
name | string | Name of the load balancer. |
domain | string | The domain name for the service, e.g. "api.example.com.". |
domain | IHosted | The Route53 hosted zone for the domain, e.g. "example.com.". |
public | boolean | Determines whether the Load Balancer will be internet-facing. |
listeners
Type:
Network
[]
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:
IHosted
(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.