software.amazon.awssdk.services.elasticloadbalancingv2.model

Interface CreateListenerRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateListenerRequest.Builder,CreateListenerRequest>, ElasticLoadBalancingV2Request.Builder, SdkBuilder<CreateListenerRequest.Builder,CreateListenerRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateListenerRequest

public static interface CreateListenerRequest.Builder
extends ElasticLoadBalancingV2Request.Builder, SdkPojo, CopyableBuilder<CreateListenerRequest.Builder,CreateListenerRequest>

Method Summary

Modifier and Type	Method and Description
CreateListenerRequest.Builder	alpnPolicy(Collection<String> alpnPolicy) [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
CreateListenerRequest.Builder	alpnPolicy(String... alpnPolicy) [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
CreateListenerRequest.Builder	certificates(Certificate... certificates) [HTTPS and TLS listeners] The default certificate for the listener.
CreateListenerRequest.Builder	certificates(Collection<Certificate> certificates) [HTTPS and TLS listeners] The default certificate for the listener.
CreateListenerRequest.Builder	certificates(Consumer<Certificate.Builder>... certificates) [HTTPS and TLS listeners] The default certificate for the listener.
CreateListenerRequest.Builder	defaultActions(Action... defaultActions) The actions for the default rule.
CreateListenerRequest.Builder	defaultActions(Collection<Action> defaultActions) The actions for the default rule.
CreateListenerRequest.Builder	defaultActions(Consumer<Action.Builder>... defaultActions) The actions for the default rule.
CreateListenerRequest.Builder	loadBalancerArn(String loadBalancerArn) The Amazon Resource Name (ARN) of the load balancer.
CreateListenerRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateListenerRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateListenerRequest.Builder	port(Integer port) The port on which the load balancer is listening.
CreateListenerRequest.Builder	protocol(ProtocolEnum protocol) The protocol for connections from clients to the load balancer.
CreateListenerRequest.Builder	protocol(String protocol) The protocol for connections from clients to the load balancer.
CreateListenerRequest.Builder	sslPolicy(String sslPolicy) [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.

Methods inherited from interface software.amazon.awssdk.services.elasticloadbalancingv2.model.ElasticLoadBalancingV2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

loadBalancerArn

CreateListenerRequest.Builder loadBalancerArn(String loadBalancerArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

protocol

CreateListenerRequest.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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProtocolEnum, ProtocolEnum

protocol

CreateListenerRequest.Builder protocol(ProtocolEnum 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ProtocolEnum, ProtocolEnum

port

CreateListenerRequest.Builder port(Integer port)

The port on which the load balancer is listening.

Parameters:

port - The port on which the load balancer is listening.

Returns:

Returns a reference to this object so that method calls can be chained together.

sslPolicy

CreateListenerRequest.Builder sslPolicy(String sslPolicy)

[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. The following are the possible values:

• ELBSecurityPolicy-2016-08

• ELBSecurityPolicy-TLS-1-0-2015-04

• ELBSecurityPolicy-TLS-1-1-2017-01

• ELBSecurityPolicy-TLS-1-2-2017-01

• ELBSecurityPolicy-TLS-1-2-Ext-2018-06

• ELBSecurityPolicy-FS-2018-06

• ELBSecurityPolicy-FS-1-1-2019-08

• ELBSecurityPolicy-FS-1-2-2019-08

• ELBSecurityPolicy-FS-1-2-Res-2019-08

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. The following are the possible values:

• ELBSecurityPolicy-2016-08

• ELBSecurityPolicy-TLS-1-0-2015-04

• ELBSecurityPolicy-TLS-1-1-2017-01

• ELBSecurityPolicy-TLS-1-2-2017-01

• ELBSecurityPolicy-TLS-1-2-Ext-2018-06

• ELBSecurityPolicy-FS-2018-06

• ELBSecurityPolicy-FS-1-1-2019-08

• ELBSecurityPolicy-FS-1-2-2019-08

• ELBSecurityPolicy-FS-1-2-Res-2019-08

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

Returns:

Returns a reference to this object so that method calls can be chained together.

certificates

CreateListenerRequest.Builder certificates(Collection<Certificate> certificates)

[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list for the listener, use AddListenerCertificates.

Parameters:

certificates - [HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list for the listener, use AddListenerCertificates.

Returns:

Returns a reference to this object so that method calls can be chained together.

certificates

CreateListenerRequest.Builder certificates(Certificate... certificates)

[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list for the listener, use AddListenerCertificates.

Parameters:

certificates - [HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list for the listener, use AddListenerCertificates.

Returns:

Returns a reference to this object so that method calls can be chained together.

certificates

CreateListenerRequest.Builder certificates(Consumer<Certificate.Builder>... certificates)

[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list for the listener, use AddListenerCertificates.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #certificates(List).

Parameters:

certificates - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#certificates(List)

defaultActions

CreateListenerRequest.Builder defaultActions(Collection<Action> defaultActions)

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

If the action type is forward, you specify one or more target groups. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

Parameters:

defaultActions - The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

If the action type is forward, you specify one or more target groups. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultActions

CreateListenerRequest.Builder defaultActions(Action... defaultActions)

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

If the action type is forward, you specify one or more target groups. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

Parameters:

defaultActions - The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

If the action type is forward, you specify one or more target groups. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultActions

CreateListenerRequest.Builder defaultActions(Consumer<Action.Builder>... defaultActions)

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

If the action type is forward, you specify one or more target groups. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #defaultActions(List).

Parameters:

defaultActions - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#defaultActions(List)

alpnPolicy

CreateListenerRequest.Builder alpnPolicy(Collection<String> alpnPolicy)

[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:

• HTTP1Only

• HTTP2Only

• HTTP2Optional

• HTTP2Preferred

• None

For more information, see ALPN Policies in the Network Load Balancers Guide.

Parameters:

alpnPolicy - [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:

• HTTP1Only

• HTTP2Only

• HTTP2Optional

• HTTP2Preferred

• None

For more information, see ALPN Policies in the Network Load Balancers Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

alpnPolicy

CreateListenerRequest.Builder alpnPolicy(String... alpnPolicy)

[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:

• HTTP1Only

• HTTP2Only

• HTTP2Optional

• HTTP2Preferred

• None

For more information, see ALPN Policies in the Network Load Balancers Guide.

Parameters:

alpnPolicy - [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:

• HTTP1Only

• HTTP2Only

• HTTP2Optional

• HTTP2Preferred

• None

For more information, see ALPN Policies in the Network Load Balancers Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateListenerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateListenerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder