software.amazon.awssdk.services.elasticloadbalancingv2.model

Class CreateListenerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticloadbalancingv2.model.ElasticLoadBalancingV2Request

software.amazon.awssdk.services.elasticloadbalancingv2.model.CreateListenerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateListenerRequest.Builder,CreateListenerRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateListenerRequest
extends ElasticLoadBalancingV2Request
implements ToCopyableBuilder<CreateListenerRequest.Builder,CreateListenerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateListenerRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	alpnPolicy() [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
static CreateListenerRequest.Builder	builder()
List<Certificate>	certificates() [HTTPS and TLS listeners] The default certificate for the listener.
List<Action>	defaultActions() The actions for the default rule.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAlpnPolicy() Returns true if the AlpnPolicy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasCertificates() Returns true if the Certificates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasDefaultActions() Returns true if the DefaultActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	loadBalancerArn() The Amazon Resource Name (ARN) of the load balancer.
Integer	port() The port on which the load balancer is listening.
ProtocolEnum	protocol() The protocol for connections from clients to the load balancer.
String	protocolAsString() The protocol for connections from clients to the load balancer.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateListenerRequest.Builder>	serializableBuilderClass()
String	sslPolicy() [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.
CreateListenerRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

loadBalancerArn

public String loadBalancerArn()

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

Returns:

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

protocol

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

If the service returns an enum value that is not available in the current SDK version, protocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

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.

See Also:

ProtocolEnum

protocolAsString

public String protocolAsString()

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.

If the service returns an enum value that is not available in the current SDK version, protocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

Returns:

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.

See Also:

ProtocolEnum

port

public Integer port()

The port on which the load balancer is listening.

Returns:

The port on which the load balancer is listening.

sslPolicy

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

Returns:

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

hasCertificates

public boolean hasCertificates()

Returns true if the Certificates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

certificates

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasCertificates() to see if a value was sent in this field.

Returns:

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

hasDefaultActions

public boolean hasDefaultActions()

Returns true if the DefaultActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

defaultActions

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDefaultActions() to see if a value was sent in this field.

Returns:

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.

hasAlpnPolicy

public boolean hasAlpnPolicy()

Returns true if the AlpnPolicy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

alpnPolicy

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAlpnPolicy() to see if a value was sent in this field.

Returns:

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

toBuilder

public CreateListenerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateListenerRequest.Builder,CreateListenerRequest>

Specified by:

toBuilder in class ElasticLoadBalancingV2Request

builder

public static CreateListenerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateListenerRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo