com.amazonaws.services.elasticloadbalancingv2.model

Class CreateListenerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticloadbalancingv2.model.CreateListenerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateListenerRequest
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
CreateListenerRequest()

Method Summary

Modifier and Type	Method and Description
CreateListenerRequest	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	getLoadBalancerArn() The Amazon Resource Name (ARN) of the load balancer.
Integer	getPort() The port on which the load balancer is listening.
String	getProtocol() The protocol for connections from clients to the load balancer.
String	getSslPolicy() [HTTPS listeners] The security policy that defines which ciphers and protocols 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	setLoadBalancerArn(String loadBalancerArn) The Amazon Resource Name (ARN) of the load balancer.
void	setPort(Integer port) The port on which the load balancer is listening.
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 ciphers and protocols are supported.
String	toString() Returns a string representation of this object.
CreateListenerRequest	withCertificates(Certificate... certificates) [HTTPS listeners] The default SSL server certificate.
CreateListenerRequest	withCertificates(Collection<Certificate> certificates) [HTTPS listeners] The default SSL server certificate.
CreateListenerRequest	withDefaultActions(Action... defaultActions) The actions for the default rule.
CreateListenerRequest	withDefaultActions(Collection<Action> defaultActions) The actions for the default rule.
CreateListenerRequest	withLoadBalancerArn(String loadBalancerArn) The Amazon Resource Name (ARN) of the load balancer.
CreateListenerRequest	withPort(Integer port) The port on which the load balancer is listening.
CreateListenerRequest	withProtocol(ProtocolEnum protocol) The protocol for connections from clients to the load balancer.
CreateListenerRequest	withProtocol(String protocol) The protocol for connections from clients to the load balancer.
CreateListenerRequest	withSslPolicy(String sslPolicy) [HTTPS listeners] The security policy that defines which ciphers and protocols 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

CreateListenerRequest

public CreateListenerRequest()

Method Detail

setLoadBalancerArn

public void setLoadBalancerArn(String loadBalancerArn)

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

Parameters:

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

getLoadBalancerArn

public String getLoadBalancerArn()

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

Returns:

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

withLoadBalancerArn

public CreateListenerRequest withLoadBalancerArn(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.

setProtocol

public void setProtocol(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 protocol is TCP.

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 protocol is TCP.

See Also:

ProtocolEnum

getProtocol

public String getProtocol()

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 protocol is TCP.

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 protocol is TCP.

See Also:

ProtocolEnum

withProtocol

public CreateListenerRequest withProtocol(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 protocol is TCP.

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 protocol is 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. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP.

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 protocol is TCP.

See Also:

ProtocolEnum

withProtocol

public CreateListenerRequest withProtocol(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 protocol is TCP.

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 protocol is TCP.

Returns:

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

See Also:

ProtocolEnum

setPort

public void setPort(Integer port)

The port on which the load balancer is listening.

Parameters:

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

getPort

public Integer getPort()

The port on which the load balancer is listening.

Returns:

The port on which the load balancer is listening.

withPort

public CreateListenerRequest withPort(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.

setSslPolicy

public void setSslPolicy(String sslPolicy)

[HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

Parameters:

sslPolicy - [HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

getSslPolicy

public String getSslPolicy()

[HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

Returns:

[HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

withSslPolicy

public CreateListenerRequest withSslPolicy(String sslPolicy)

[HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

Parameters:

sslPolicy - [HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

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 CreateListenerRequest 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 CreateListenerRequest 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 CreateListenerRequest 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 CreateListenerRequest 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 CreateListenerRequest clone()

Overrides:

clone in class AmazonWebServiceRequest