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("software.amazon.awssdk:codegen") public final class CreateLoadBalancerRequest extends LightsailRequest implements ToCopyableBuilder<CreateLoadBalancerRequest.Builder,CreateLoadBalancerRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateLoadBalancerRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateLoadBalancerRequest.Builderbuilder()List<String>certificateAlternativeNames()The optional alternative domains and subdomains to use with your SSL/TLS certificate (www.example.com,example.com,m.example.com,blog.example.com).StringcertificateDomainName()The domain name with which your certificate is associated (example.com).StringcertificateName()The name of the SSL/TLS certificate.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCertificateAlternativeNames()For responses, this returns true if the service returned a value for the CertificateAlternativeNames property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringhealthCheckPath()The path you provided to perform the load balancer health check.IntegerinstancePort()The instance port where you're creating your load balancer.IpAddressTypeipAddressType()The IP address type for the load balancer.StringipAddressTypeAsString()The IP address type for the load balancer.StringloadBalancerName()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.StringtlsPolicyName()The name of the TLS policy to apply to the load balancer.CreateLoadBalancerRequest.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
-
loadBalancerName
public final String loadBalancerName()
The name of your load balancer.
- Returns:
- The name of your load balancer.
-
instancePort
public final 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 final 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 (
"/").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 (
"/").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 final String certificateName()
The name of the SSL/TLS certificate.
If you specify
certificateName, thencertificateDomainNameis required (and vice-versa).- Returns:
- The name of the SSL/TLS certificate.
If you specify
certificateName, thencertificateDomainNameis required (and vice-versa).
-
certificateDomainName
public final String certificateDomainName()
The domain name with which your certificate is associated (
example.com).If you specify
certificateDomainName, thencertificateNameis required (and vice-versa).- Returns:
- The domain name with which your certificate is associated (
example.com).If you specify
certificateDomainName, thencertificateNameis required (and vice-versa).
-
hasCertificateAlternativeNames
public final boolean hasCertificateAlternativeNames()
For responses, this returns true if the service returned a value for the CertificateAlternativeNames 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.
-
certificateAlternativeNames
public final List<String> certificateAlternativeNames()
The optional alternative domains and subdomains to use with your SSL/TLS certificate (
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.
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
hasCertificateAlternativeNames()method.- Returns:
- The optional alternative domains and subdomains to use with your SSL/TLS certificate (
www.example.com,example.com,m.example.com,blog.example.com).
-
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 tag keys and optional values to add to the resource during create.
Use the
TagResourceaction to tag a resource after it's created.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 tag keys and optional values to add to the resource during create.
Use the
TagResourceaction to tag a resource after it's created.
-
ipAddressType
public final IpAddressType ipAddressType()
The IP address type for the load balancer.
The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack.If the service returns an enum value that is not available in the current SDK version,
ipAddressTypewill returnIpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromipAddressTypeAsString().- Returns:
- The IP address type for the load balancer.
The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack. - See Also:
IpAddressType
-
ipAddressTypeAsString
public final String ipAddressTypeAsString()
The IP address type for the load balancer.
The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack.If the service returns an enum value that is not available in the current SDK version,
ipAddressTypewill returnIpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromipAddressTypeAsString().- Returns:
- The IP address type for the load balancer.
The possible values are
ipv4for IPv4 only, anddualstackfor IPv4 and IPv6.The default value is
dualstack. - See Also:
IpAddressType
-
tlsPolicyName
public final String tlsPolicyName()
The name of the TLS policy to apply to the load balancer.
Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.
For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
- Returns:
- The name of the TLS policy to apply to the load balancer.
Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.
For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
-
toBuilder
public CreateLoadBalancerRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateLoadBalancerRequest.Builder,CreateLoadBalancerRequest>- Specified by:
toBuilderin classLightsailRequest
-
builder
public static CreateLoadBalancerRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateLoadBalancerRequest.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
-
-