software.amazon.awscdk.services.ecs.patterns

Interface ApplicationLoadBalancerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApplicationLoadBalancerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.787Z")
 @Stability(value=Stable)
public interface ApplicationLoadBalancerProps
extends software.amazon.jsii.JsiiSerializable

Properties to define an application 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.*;
 import software.amazon.awscdk.services.certificatemanager.*;
 import software.amazon.awscdk.services.ecs.patterns.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 import software.amazon.awscdk.services.route53.*;
 Certificate certificate;
 HostedZone hostedZone;
 ApplicationLoadBalancerProps applicationLoadBalancerProps = ApplicationLoadBalancerProps.builder()
         .listeners(List.of(ApplicationListenerProps.builder()
                 .name("name")
                 // the properties below are optional
                 .certificate(certificate)
                 .port(123)
                 .protocol(ApplicationProtocol.HTTP)
                 .sslPolicy(SslPolicy.RECOMMENDED_TLS)
                 .build()))
         .name("name")
         // the properties below are optional
         .domainName("domainName")
         .domainZone(hostedZone)
         .idleTimeout(Duration.minutes(30))
         .publicLoadBalancer(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ApplicationLoadBalancerProps.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.
default Duration	getIdleTimeout() The load balancer idle timeout, in seconds.
List<ApplicationListenerProps>	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 Detail

getListeners

@Stability(value=Stable)
 @NotNull
List<ApplicationListenerProps> getListeners()

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

getName

@Stability(value=Stable)
 @NotNull
String getName()

Name of the load balancer.

getDomainName

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

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

Default: - No domain name.

getDomainZone

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

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

Default: - No Route53 hosted domain zone.

getIdleTimeout

@Stability(value=Stable)
 @Nullable
default Duration getIdleTimeout()

The load balancer idle timeout, in seconds.

Default: - CloudFormation sets idle timeout to 60 seconds

getPublicLoadBalancer

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

Determines whether the Load Balancer will be internet-facing.

Default: true

builder

@Stability(value=Stable)
static ApplicationLoadBalancerProps.Builder builder()

Returns:

a ApplicationLoadBalancerProps.Builder of ApplicationLoadBalancerProps