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("software.amazon.awssdk:codegen") public final class CreateListenerRequest extends ElasticLoadBalancingV2Request implements ToCopyableBuilder<CreateListenerRequest.Builder,CreateListenerRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateListenerRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>alpnPolicy()[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy.static CreateListenerRequest.Builderbuilder()List<Certificate>certificates()[HTTPS and TLS listeners] The default certificate for the listener.List<Action>defaultActions()The actions for the default rule.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAlpnPolicy()For responses, this returns true if the service returned a value for the AlpnPolicy property.booleanhasCertificates()For responses, this returns true if the service returned a value for the Certificates property.booleanhasDefaultActions()For responses, this returns true if the service returned a value for the DefaultActions property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringloadBalancerArn()The Amazon Resource Name (ARN) of the load balancer.MutualAuthenticationAttributesmutualAuthentication()The mutual authentication configuration information.Integerport()The port on which the load balancer is listening.ProtocolEnumprotocol()The protocol for connections from clients to the load balancer.StringprotocolAsString()The protocol for connections from clients to the load balancer.List<SdkField<?>>sdkFields()static Class<? extends CreateListenerRequest.Builder>serializableBuilderClass()StringsslPolicy()[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.List<Tag>tags()The tags to assign to the listener.CreateListenerRequest.BuildertoBuilder()StringtoString()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 final String loadBalancerArn()
The Amazon Resource Name (ARN) of the load balancer.
- Returns:
- The Amazon Resource Name (ARN) of the load balancer.
-
protocol
public final 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. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.
If the service returns an enum value that is not available in the current SDK version,
protocolwill returnProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprotocolAsString().- 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. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.
- See Also:
ProtocolEnum
-
protocolAsString
public final 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. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.
If the service returns an enum value that is not available in the current SDK version,
protocolwill returnProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprotocolAsString().- 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. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.
- See Also:
ProtocolEnum
-
port
public final Integer port()
The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.
- Returns:
- The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.
-
sslPolicy
public final String sslPolicy()
[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.
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.
For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide.
-
hasCertificates
public final boolean hasCertificates()
For responses, this returns true if the service returned a value for the Certificates property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
certificates
public final List<Certificate> certificates()
[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set
CertificateArnto the certificate ARN but do not setIsDefault.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCertificates()method.- Returns:
- [HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one
certificate. Set
CertificateArnto the certificate ARN but do not setIsDefault.
-
hasDefaultActions
public final boolean hasDefaultActions()
For responses, this returns true if the service returned a value for the DefaultActions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
defaultActions
public final List<Action> defaultActions()
The actions for the default rule.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDefaultActions()method.- Returns:
- The actions for the default rule.
-
hasAlpnPolicy
public final boolean hasAlpnPolicy()
For responses, this returns true if the service returned a value for the AlpnPolicy property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
alpnPolicy
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAlpnPolicy()method.- 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.
-
-
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<Tag> tags()
The tags to assign to the listener.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- The tags to assign to the listener.
-
mutualAuthentication
public final MutualAuthenticationAttributes mutualAuthentication()
The mutual authentication configuration information.
- Returns:
- The mutual authentication configuration information.
-
toBuilder
public CreateListenerRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateListenerRequest.Builder,CreateListenerRequest>- Specified by:
toBuilderin classElasticLoadBalancingV2Request
-
builder
public static CreateListenerRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateListenerRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-