Package software.amazon.awscdk.services.elasticloadbalancingv2

Class CfnListener.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.CfnListener.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnListener>

Enclosing class:

CfnListener

@Stability(Stable)
public static final class CfnListener.Builder
extends Object
implements software.amazon.jsii.Builder<CfnListener>

A fluent builder for CfnListener.

Method Summary

Modifier and Type	Method	Description
CfnListener.Builder	alpnPolicy(List<String> alpnPolicy)	[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
CfnListener	build()
CfnListener.Builder	certificates(List<? extends Object> certificates)	The default SSL server certificate for a secure listener.
CfnListener.Builder	certificates(IResolvable certificates)	The default SSL server certificate for a secure listener.
static CfnListener.Builder	create(software.constructs.Construct scope, String id)
CfnListener.Builder	defaultActions(List<? extends Object> defaultActions)	The actions for the default rule.
CfnListener.Builder	defaultActions(IResolvable defaultActions)	The actions for the default rule.
CfnListener.Builder	listenerAttributes(List<? extends Object> listenerAttributes)	The listener attributes.
CfnListener.Builder	listenerAttributes(IResolvable listenerAttributes)	The listener attributes.
CfnListener.Builder	loadBalancerArn(String loadBalancerArn)	The Amazon Resource Name (ARN) of the load balancer.
CfnListener.Builder	mutualAuthentication(IResolvable mutualAuthentication)	The mutual authentication configuration information.
CfnListener.Builder	mutualAuthentication(CfnListener.MutualAuthenticationProperty mutualAuthentication)	The mutual authentication configuration information.
CfnListener.Builder	port(Number port)	The port on which the load balancer is listening.
CfnListener.Builder	protocol(String protocol)	The protocol for connections from clients to the load balancer.
CfnListener.Builder	sslPolicy(String sslPolicy)	[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnListener.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnListener.Builder.

defaultActions

@Stability(Stable)
public CfnListener.Builder defaultActions(IResolvable defaultActions)

The actions for the default rule. You cannot define a condition for a default rule.

To create additional rules for an Application Load Balancer, use AWS::ElasticLoadBalancingV2::ListenerRule .

Parameters:

defaultActions - The actions for the default rule. You cannot define a condition for a default rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-defaultactions

defaultActions

@Stability(Stable)
public CfnListener.Builder defaultActions(List<? extends Object> defaultActions)

The actions for the default rule. You cannot define a condition for a default rule.

To create additional rules for an Application Load Balancer, use AWS::ElasticLoadBalancingV2::ListenerRule .

Parameters:

defaultActions - The actions for the default rule. You cannot define a condition for a default rule. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-defaultactions

loadBalancerArn

@Stability(Stable)
public CfnListener.Builder loadBalancerArn(String loadBalancerArn)

The Amazon Resource Name (ARN) of the load balancer.

Parameters:

loadBalancerArn - The Amazon Resource Name (ARN) of the load balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-loadbalancerarn

alpnPolicy

@Stability(Stable)
public CfnListener.Builder alpnPolicy(List<String> alpnPolicy)

[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.

Parameters:

alpnPolicy - [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-alpnpolicy

certificates

@Stability(Stable)
public CfnListener.Builder certificates(IResolvable certificates)

The default SSL server certificate for a secure listener.

You must provide exactly one certificate if the listener protocol is HTTPS or TLS.

To create a certificate list for a secure listener, use AWS::ElasticLoadBalancingV2::ListenerCertificate .

Parameters:

certificates - The default SSL server certificate for a secure listener. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-certificates

certificates

@Stability(Stable)
public CfnListener.Builder certificates(List<? extends Object> certificates)

The default SSL server certificate for a secure listener.

You must provide exactly one certificate if the listener protocol is HTTPS or TLS.

To create a certificate list for a secure listener, use AWS::ElasticLoadBalancingV2::ListenerCertificate .

Parameters:

certificates - The default SSL server certificate for a secure listener. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-certificates

listenerAttributes

@Stability(Stable)
public CfnListener.Builder listenerAttributes(IResolvable listenerAttributes)

The listener attributes.

Parameters:

listenerAttributes - The listener attributes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-listenerattributes

listenerAttributes

@Stability(Stable)
public CfnListener.Builder listenerAttributes(List<? extends Object> listenerAttributes)

The listener attributes.

Parameters:

listenerAttributes - The listener attributes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-listenerattributes

mutualAuthentication

@Stability(Stable)
public CfnListener.Builder mutualAuthentication(IResolvable mutualAuthentication)

The mutual authentication configuration information.

Parameters:

mutualAuthentication - The mutual authentication configuration information. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-mutualauthentication

mutualAuthentication

@Stability(Stable)
public CfnListener.Builder mutualAuthentication(CfnListener.MutualAuthenticationProperty mutualAuthentication)

The mutual authentication configuration information.

Parameters:

mutualAuthentication - The mutual authentication configuration information. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-mutualauthentication

port

@Stability(Stable)
public CfnListener.Builder port(Number port)

The port on which the load balancer is listening.

You can't specify a port for a Gateway Load Balancer.

Parameters:

port - The port on which the load balancer is listening. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-port

protocol

@Stability(Stable)
public CfnListener.Builder protocol(String protocol)

The protocol for connections from clients to the load balancer.

For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You can't specify a protocol for a Gateway Load Balancer.

Parameters:

protocol - The protocol for connections from clients to the load balancer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-protocol

sslPolicy

@Stability(Stable)
public CfnListener.Builder sslPolicy(String sslPolicy)

[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.

Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.

For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide .

Parameters:

sslPolicy - [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-sslpolicy

build

@Stability(Stable)
public CfnListener build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnListener>

Returns:

a newly built instance of CfnListener.