com.amazonaws.services.elasticloadbalancingv2.model

Class ModifyListenerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticloadbalancingv2.model.ModifyListenerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyListenerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyListenerRequest()

Method Summary

Modifier and Type	Method and Description
ModifyListenerRequest	clone()
boolean	equals(Object obj)
List<Certificate>	getCertificates() [HTTPS listeners] The default SSL server certificate.
List<Action>	getDefaultActions() The actions for the default rule.
String	getListenerArn() The Amazon Resource Name (ARN) of the listener.
Integer	getPort() The port for connections from clients to the load balancer.
String	getProtocol() The protocol for connections from clients to the load balancer.
String	getSslPolicy() [HTTPS listeners] The security policy that defines which protocols and ciphers are supported.
int	hashCode()
void	setCertificates(Collection<Certificate> certificates) [HTTPS listeners] The default SSL server certificate.
void	setDefaultActions(Collection<Action> defaultActions) The actions for the default rule.
void	setListenerArn(String listenerArn) The Amazon Resource Name (ARN) of the listener.
void	setPort(Integer port) The port for connections from clients to the load balancer.
void	setProtocol(ProtocolEnum protocol) The protocol for connections from clients to the load balancer.
void	setProtocol(String protocol) The protocol for connections from clients to the load balancer.
void	setSslPolicy(String sslPolicy) [HTTPS listeners] The security policy that defines which protocols and ciphers are supported.
String	toString() Returns a string representation of this object.
ModifyListenerRequest	withCertificates(Certificate... certificates) [HTTPS listeners] The default SSL server certificate.
ModifyListenerRequest	withCertificates(Collection<Certificate> certificates) [HTTPS listeners] The default SSL server certificate.
ModifyListenerRequest	withDefaultActions(Action... defaultActions) The actions for the default rule.
ModifyListenerRequest	withDefaultActions(Collection<Action> defaultActions) The actions for the default rule.
ModifyListenerRequest	withListenerArn(String listenerArn) The Amazon Resource Name (ARN) of the listener.
ModifyListenerRequest	withPort(Integer port) The port for connections from clients to the load balancer.
ModifyListenerRequest	withProtocol(ProtocolEnum protocol) The protocol for connections from clients to the load balancer.
ModifyListenerRequest	withProtocol(String protocol) The protocol for connections from clients to the load balancer.
ModifyListenerRequest	withSslPolicy(String sslPolicy) [HTTPS listeners] The security policy that defines which protocols and ciphers are supported.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifyListenerRequest

public ModifyListenerRequest()

Method Detail

setListenerArn

public void setListenerArn(String listenerArn)

The Amazon Resource Name (ARN) of the listener.

Parameters:

listenerArn - The Amazon Resource Name (ARN) of the listener.

getListenerArn

public String getListenerArn()

The Amazon Resource Name (ARN) of the listener.

Returns:

The Amazon Resource Name (ARN) of the listener.

withListenerArn

public ModifyListenerRequest withListenerArn(String listenerArn)

The Amazon Resource Name (ARN) of the listener.

Parameters:

listenerArn - The Amazon Resource Name (ARN) of the listener.

Returns:

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

setPort

public void setPort(Integer port)

The port for connections from clients to the load balancer.

Parameters:

port - The port for connections from clients to the load balancer.

getPort

public Integer getPort()

The port for connections from clients to the load balancer.

Returns:

The port for connections from clients to the load balancer.

withPort

public ModifyListenerRequest withPort(Integer port)

The port for connections from clients to the load balancer.

Parameters:

port - The port for connections from clients to the load balancer.

Returns:

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

setProtocol

public void setProtocol(String protocol)

The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

Parameters:

protocol - The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

See Also:

ProtocolEnum

getProtocol

public String getProtocol()

The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

Returns:

The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

See Also:

ProtocolEnum

withProtocol

public ModifyListenerRequest withProtocol(String protocol)

The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

Parameters:

protocol - The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

Returns:

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

See Also:

ProtocolEnum

setProtocol

public void setProtocol(ProtocolEnum protocol)

The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

Parameters:

protocol - The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

See Also:

ProtocolEnum

withProtocol

public ModifyListenerRequest withProtocol(ProtocolEnum protocol)

The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

Parameters:

protocol - The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

Returns:

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

See Also:

ProtocolEnum

setSslPolicy

public void setSslPolicy(String sslPolicy)

[HTTPS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide.

Parameters:

sslPolicy - [HTTPS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide.

getSslPolicy

public String getSslPolicy()

[HTTPS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide.

Returns:

[HTTPS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide.

withSslPolicy

public ModifyListenerRequest withSslPolicy(String sslPolicy)

[HTTPS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide.

Parameters:

sslPolicy - [HTTPS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide.

Returns:

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

getCertificates

public List<Certificate> getCertificates()

[HTTPS listeners] The default SSL server certificate. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list, use AddListenerCertificates.

Returns:

[HTTPS listeners] The default SSL server certificate. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list, use AddListenerCertificates.

setCertificates

public void setCertificates(Collection<Certificate> certificates)

[HTTPS listeners] The default SSL server certificate. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list, use AddListenerCertificates.

Parameters:

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

To create a certificate list, use AddListenerCertificates.

withCertificates

public ModifyListenerRequest withCertificates(Certificate... certificates)

[HTTPS listeners] The default SSL server certificate. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list, use AddListenerCertificates.

NOTE: This method appends the values to the existing list (if any). Use setCertificates(java.util.Collection) or withCertificates(java.util.Collection) if you want to override the existing values.

Parameters:

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

To create a certificate list, use AddListenerCertificates.

Returns:

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

withCertificates

public ModifyListenerRequest withCertificates(Collection<Certificate> certificates)

[HTTPS listeners] The default SSL server certificate. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list, use AddListenerCertificates.

Parameters:

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

To create a certificate list, use AddListenerCertificates.

Returns:

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

getDefaultActions

public List<Action> getDefaultActions()

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 a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

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

[HTTPS listener] 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:

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 a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

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

[HTTPS listener] 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.

setDefaultActions

public void setDefaultActions(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 a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

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

[HTTPS listener] 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 a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

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

[HTTPS listener] 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.

withDefaultActions

public ModifyListenerRequest withDefaultActions(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 a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

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

[HTTPS listener] 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.

NOTE: This method appends the values to the existing list (if any). Use setDefaultActions(java.util.Collection) or withDefaultActions(java.util.Collection) if you want to override the existing values.

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 a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

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

[HTTPS listener] 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.

withDefaultActions

public ModifyListenerRequest withDefaultActions(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 a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

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

[HTTPS listener] 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 a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

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

[HTTPS listener] 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.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ModifyListenerRequest clone()

Overrides:

clone in class AmazonWebServiceRequest