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>

  • Method Details

    • 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, 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 final String certificateDomainName()

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

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

      Returns:
      The domain name with which your certificate is associated (example.com).

      If you specify certificateDomainName, then certificateName is 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 the isEmpty() 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 the isEmpty() 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 TagResource action 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 TagResource action 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 ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

      The default value is dualstack.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      The IP address type for the load balancer.

      The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

      The default value is dualstack.

      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The IP address type for the load balancer.

      The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

      The default value is dualstack.

      If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().

      Returns:
      The IP address type for the load balancer.

      The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

      The default value is dualstack.

      See Also:

    • 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()
      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 final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final 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 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <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 final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.