Class LoadBalancer

java.lang.Object
software.amazon.awssdk.services.lightsail.model.LoadBalancer
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LoadBalancer.Builder,LoadBalancer>
@Generated("software.amazon.awssdk:codegen") public final class LoadBalancer extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LoadBalancer.Builder,LoadBalancer>

Describes a load balancer.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the load balancer (my-load-balancer).

      Returns:
      The name of the load balancer (my-load-balancer).

    • arn

      public final String arn()

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

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

    • supportCode

      public final String supportCode()

      The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

      Returns:
      The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

    • createdAt

      public final Instant createdAt()

      The date when your load balancer was created.

      Returns:
      The date when your load balancer was created.

    • location

      public final ResourceLocation location()

      The AWS Region where your load balancer was created (us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

      Returns:
      The AWS Region where your load balancer was created (us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

    • resourceType

      public final ResourceType resourceType()

      The resource type (LoadBalancer.

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

      Returns:
      The resource type (LoadBalancer.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The resource type (LoadBalancer.

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

      Returns:
      The resource type (LoadBalancer.
      See Also:

    • 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 for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

      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 for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

    • dnsName

      public final String dnsName()

      The DNS name of your Lightsail load balancer.

      Returns:
      The DNS name of your Lightsail load balancer.

    • state

      public final LoadBalancerState state()

      The status of your load balancer. Valid values are below.

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

      Returns:
      The status of your load balancer. Valid values are below.
      See Also:

    • stateAsString

      public final String stateAsString()

      The status of your load balancer. Valid values are below.

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

      Returns:
      The status of your load balancer. Valid values are below.
      See Also:

    • protocol

      public final LoadBalancerProtocol protocol()

      The protocol you have enabled for your load balancer. Valid values are below.

      You can't just have HTTP_HTTPS, but you can have just HTTP.

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

      Returns:
      The protocol you have enabled for your load balancer. Valid values are below.

      You can't just have HTTP_HTTPS, but you can have just HTTP.

      See Also:

    • protocolAsString

      public final String protocolAsString()

      The protocol you have enabled for your load balancer. Valid values are below.

      You can't just have HTTP_HTTPS, but you can have just HTTP.

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

      Returns:
      The protocol you have enabled for your load balancer. Valid values are below.

      You can't just have HTTP_HTTPS, but you can have just HTTP.

      See Also:

    • hasPublicPorts

      public final boolean hasPublicPorts()
      For responses, this returns true if the service returned a value for the PublicPorts 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.

    • publicPorts

      public final List<Integer> publicPorts()

      An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

      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 hasPublicPorts() method.

      Returns:
      An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

    • healthCheckPath

      public final String healthCheckPath()

      The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

      Returns:
      The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

    • instancePort

      public final Integer instancePort()

      The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

      Returns:
      The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

    • hasInstanceHealthSummary

      public final boolean hasInstanceHealthSummary()
      For responses, this returns true if the service returned a value for the InstanceHealthSummary 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.

    • instanceHealthSummary

      public final List<InstanceHealthSummary> instanceHealthSummary()

      An array of InstanceHealthSummary objects describing the health of the load balancer.

      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 hasInstanceHealthSummary() method.

      Returns:
      An array of InstanceHealthSummary objects describing the health of the load balancer.

    • hasTlsCertificateSummaries

      public final boolean hasTlsCertificateSummaries()
      For responses, this returns true if the service returned a value for the TlsCertificateSummaries 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.

    • tlsCertificateSummaries

      public final List<LoadBalancerTlsCertificateSummary> tlsCertificateSummaries()

      An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

      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 hasTlsCertificateSummaries() method.

      Returns:
      An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

    • configurationOptions

      public final Map<LoadBalancerAttributeName,String> configurationOptions()

      A string to string map of the configuration options for your load balancer. Valid values are listed below.

      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 hasConfigurationOptions() method.

      Returns:
      A string to string map of the configuration options for your load balancer. Valid values are listed below.

    • hasConfigurationOptions

      public final boolean hasConfigurationOptions()
      For responses, this returns true if the service returned a value for the ConfigurationOptions 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.

    • configurationOptionsAsStrings

      public final Map<String,String> configurationOptionsAsStrings()

      A string to string map of the configuration options for your load balancer. Valid values are listed below.

      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 hasConfigurationOptions() method.

      Returns:
      A string to string map of the configuration options for your load balancer. Valid values are listed below.

    • ipAddressType

      public final IpAddressType ipAddressType()

      The IP address type of the load balancer.

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

      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 of the load balancer.

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

      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The IP address type of the load balancer.

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

      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 of the load balancer.

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

      See Also:

    • httpsRedirectionEnabled

      public final Boolean httpsRedirectionEnabled()

      A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.

      Returns:
      A Boolean value that indicates whether HTTPS redirection is enabled for the load balancer.

    • tlsPolicyName

      public final String tlsPolicyName()

      The name of the TLS security policy for the load balancer.

      Returns:
      The name of the TLS security policy for the load balancer.

    • toBuilder

      public LoadBalancer.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<LoadBalancer.Builder,LoadBalancer>
      Returns:
      a builder for type T

    • builder

      public static LoadBalancer.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LoadBalancer.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • 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)

    • 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.