NetworkLoadBalancerProps

class aws_cdk.aws_ecs_patterns.NetworkLoadBalancerProps(*, listeners, name, domain_name=None, domain_zone=None, public_load_balancer=None)

Bases: object

Properties to define an network load balancer.

Parameters
  • listeners (Sequence[NetworkListenerProps]) – Listeners (at least one listener) attached to this load balancer. Default: - none

  • name (str) – Name of the load balancer.

  • domain_name (Optional[str]) – The domain name for the service, e.g. “api.example.com.”. Default: - No domain name.

  • domain_zone (Optional[IHostedZone]) – The Route53 hosted zone for the domain, e.g. “example.com.”. Default: - No Route53 hosted domain zone.

  • public_load_balancer (Optional[bool]) – Determines whether the Load Balancer will be internet-facing. Default: true

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ecs_patterns as ecs_patterns
import aws_cdk.aws_route53 as route53

# hosted_zone: route53.HostedZone

network_load_balancer_props = ecs_patterns.NetworkLoadBalancerProps(
    listeners=[ecs_patterns.NetworkListenerProps(
        name="name",

        # the properties below are optional
        port=123
    )],
    name="name",

    # the properties below are optional
    domain_name="domainName",
    domain_zone=hosted_zone,
    public_load_balancer=False
)

Attributes

domain_name

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

Default
  • No domain name.

Return type

Optional[str]

domain_zone

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

Default
  • No Route53 hosted domain zone.

Return type

Optional[IHostedZone]

listeners

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

Default
  • none

Return type

List[NetworkListenerProps]

name

Name of the load balancer.

Return type

str

public_load_balancer

Determines whether the Load Balancer will be internet-facing.

Default

true

Return type

Optional[bool]