software.amazon.awssdk.services.lightsail.model

Class CreateLoadBalancerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.CreateLoadBalancerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLoadBalancerRequest.Builder,CreateLoadBalancerRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLoadBalancerRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateLoadBalancerRequest.Builder	builder()
List<String>	certificateAlternativeNames() The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com ).
String	certificateDomainName() The domain name with which your certificate is associated (e.g., example.com).
String	certificateName() The name of the SSL/TLS certificate.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasCertificateAlternativeNames() Returns true if the CertificateAlternativeNames 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()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	healthCheckPath() The path you provided to perform the load balancer health check.
Integer	instancePort() The instance port where you're creating your load balancer.
String	loadBalancerName() The name of your load balancer.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLoadBalancerRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() The tag keys and optional values to add to the resource during create.
CreateLoadBalancerRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

loadBalancerName

public String loadBalancerName()

The name of your load balancer.

Returns:

The name of your load balancer.

instancePort

public Integer instancePort()

The instance port where you're creating your load balancer.

Returns:

The instance port where you're creating your load balancer.

healthCheckPath

public String healthCheckPath()

The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/").

You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

Returns:

The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/").

You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

certificateName

public String certificateName()

The name of the SSL/TLS certificate.

If you specify certificateName, then certificateDomainName is required (and vice-versa).

Returns:

The name of the SSL/TLS certificate.

If you specify certificateName, then certificateDomainName is required (and vice-versa).

certificateDomainName

public String certificateDomainName()

The domain name with which your certificate is associated (e.g., example.com).

If you specify certificateDomainName, then certificateName is required (and vice-versa).

Returns:

The domain name with which your certificate is associated (e.g., example.com).

If you specify certificateDomainName, then certificateName is required (and vice-versa).

hasCertificateAlternativeNames

public boolean hasCertificateAlternativeNames()

Returns true if the CertificateAlternativeNames 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.

certificateAlternativeNames

public List<String> certificateAlternativeNames()

The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com ).

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

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

Returns:

The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com).

hasTags

public boolean hasTags()

Returns true if the Tags 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.

tags

public List<Tag> tags()

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

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

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

Returns:

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

toBuilder

public CreateLoadBalancerRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLoadBalancerRequest.Builder,CreateLoadBalancerRequest>

Specified by:

toBuilder in class LightsailRequest

Returns:

a builder for type T

builder

public static CreateLoadBalancerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateLoadBalancerRequest.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.