software.amazon.awscdk.services.elasticloadbalancingv2

Class BaseApplicationListenerProps.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.BaseApplicationListenerProps.Builder

Enclosing interface:

BaseApplicationListenerProps

public static final class BaseApplicationListenerProps.Builder
extends java.lang.Object

A builder for BaseApplicationListenerProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BaseApplicationListenerProps	build() Builds the configured instance.
BaseApplicationListenerProps.Builder	certificateArns(java.util.List<java.lang.String> certificateArns) Deprecated. Use the `certificates` property instead
BaseApplicationListenerProps.Builder	certificates(java.util.List<? extends IListenerCertificate> certificates) Sets the value of BaseApplicationListenerProps.getCertificates()
BaseApplicationListenerProps.Builder	defaultAction(ListenerAction defaultAction) Sets the value of BaseApplicationListenerProps.getDefaultAction()
BaseApplicationListenerProps.Builder	defaultTargetGroups(java.util.List<? extends IApplicationTargetGroup> defaultTargetGroups) Sets the value of BaseApplicationListenerProps.getDefaultTargetGroups()
BaseApplicationListenerProps.Builder	open(java.lang.Boolean open) Sets the value of BaseApplicationListenerProps.getOpen()
BaseApplicationListenerProps.Builder	port(java.lang.Number port) Sets the value of BaseApplicationListenerProps.getPort()
BaseApplicationListenerProps.Builder	protocol(ApplicationProtocol protocol) Sets the value of BaseApplicationListenerProps.getProtocol()
BaseApplicationListenerProps.Builder	sslPolicy(SslPolicy sslPolicy) Sets the value of BaseApplicationListenerProps.getSslPolicy()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

certificateArns

@Deprecated
public BaseApplicationListenerProps.Builder certificateArns(java.util.List<java.lang.String> certificateArns)

Deprecated. Use the `certificates` property instead

Sets the value of BaseApplicationListenerProps.getCertificateArns()

Parameters:

certificateArns - The certificates to use on this listener.

Returns:

this

certificates

public BaseApplicationListenerProps.Builder certificates(java.util.List<? extends IListenerCertificate> certificates)

Sets the value of BaseApplicationListenerProps.getCertificates()

Parameters:

certificates - Certificate list of ACM cert ARNs. You must provide exactly one certificate if the listener protocol is HTTPS or TLS.

Returns:

this

defaultAction

public BaseApplicationListenerProps.Builder defaultAction(ListenerAction defaultAction)

Sets the value of BaseApplicationListenerProps.getDefaultAction()

Parameters:

defaultAction - Default action to take for requests to this listener. This allows full control of the default action of the load balancer, including Action chaining, fixed responses and redirect responses.

See the ListenerAction class for all options.

Cannot be specified together with defaultTargetGroups.

Returns:

this

defaultTargetGroups

public BaseApplicationListenerProps.Builder defaultTargetGroups(java.util.List<? extends IApplicationTargetGroup> defaultTargetGroups)

Sets the value of BaseApplicationListenerProps.getDefaultTargetGroups()

Parameters:

defaultTargetGroups - Default target groups to load balance to. All target groups will be load balanced to with equal weight and without stickiness. For a more complex configuration than that, use either defaultAction or addAction().

Cannot be specified together with defaultAction.

Returns:

this

open

public BaseApplicationListenerProps.Builder open(java.lang.Boolean open)

Sets the value of BaseApplicationListenerProps.getOpen()

Parameters:

open - Allow anyone to connect to the load balancer on the listener port. If this is specified, the load balancer will be opened up to anyone who can reach it. For internal load balancers this is anyone in the same VPC. For public load balancers, this is anyone on the internet.

If you want to be more selective about who can access this load balancer, set this to false and use the listener's connections object to selectively grant access to the load balancer on the listener port.

Returns:

this

port

public BaseApplicationListenerProps.Builder port(java.lang.Number port)

Sets the value of BaseApplicationListenerProps.getPort()

Parameters:

port - The port on which the listener listens for requests.

Returns:

this

protocol

public BaseApplicationListenerProps.Builder protocol(ApplicationProtocol protocol)

Sets the value of BaseApplicationListenerProps.getProtocol()

Parameters:

protocol - The protocol to use.

Returns:

this

sslPolicy

public BaseApplicationListenerProps.Builder sslPolicy(SslPolicy sslPolicy)

Sets the value of BaseApplicationListenerProps.getSslPolicy()

Parameters:

sslPolicy - The security policy that defines which ciphers and protocols are supported.

Returns:

this

build

public BaseApplicationListenerProps build()

Builds the configured instance.

Returns:

a new instance of BaseApplicationListenerProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided