Class Subdomain

java.lang.Object
software.amazon.awssdk.services.lightsail.model.Subdomain
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Subdomain.Builder,Subdomain>

@Generated("software.amazon.awssdk:codegen") public final class Subdomain extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Subdomain.Builder,Subdomain>

Describes a Lightsail subdomain. A subdomain is the name that you choose, such as mysite or blog.mysite. Its web address is the subdomain followed by amazonlightsail.com, such as blog.mysite.amazonlightsail.com. You can associate a subdomain with a Lightsail resource to make the resource reachable at the web address.

See Also:
  • Method Details

    • subdomainName

      public final String subdomainName()

      The subdomain (for example, mysite or blog.mysite). To get the web address, use the fqdn parameter.

      Returns:
      The subdomain (for example, mysite or blog.mysite). To get the web address, use the fqdn parameter.
    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the subdomain.

      If you create a subdomain with a depth of 2, such as blog.mysite, without first creating the subdomain with a depth of 1 (mysite), Lightsail holds mysite for your account in the IMPLICIT state. It doesn't have an ARN until you create a subdomain with that name.

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

      If you create a subdomain with a depth of 2, such as blog.mysite, without first creating the subdomain with a depth of 1 (mysite), Lightsail holds mysite for your account in the IMPLICIT state. It doesn't have an ARN until you create a subdomain with that name.

    • fqdn

      public final String fqdn()

      The web address of the subdomain, which is the subdomain followed by amazonlightsail.com (for example, blog.mysite.amazonlightsail.com).

      Returns:
      The web address of the subdomain, which is the subdomain followed by amazonlightsail.com (for example, blog.mysite.amazonlightsail.com).
    • depth

      public final Integer depth()

      The number of labels in the subdomain. A top-level subdomain, such as mysite, has a depth of 1. A nested subdomain, such as blog.mysite, has a depth of 2.

      Returns:
      The number of labels in the subdomain. A top-level subdomain, such as mysite, has a depth of 1. A nested subdomain, such as blog.mysite, has a depth of 2.
    • state

      public final SubdomainState state()

      The state of the subdomain.

      The following states are possible:

      • CREATING – The subdomain is being created.

      • CREATE_FAILED – The subdomain couldn't be created. Delete the subdomain, and then create it again if the name is still available.

      • UNATTACHED – The subdomain is ready, and isn't associated with a resource.

      • ATTACHING – The subdomain is being associated with a resource.

      • ATTACHED – The subdomain is associated with a resource, and routes traffic to it.

      • DETACHING – The subdomain is being disassociated from a resource.

      • TRANSFERRING – The subdomain is being moved from one resource to another resource.

      • IMPLICIT – The subdomain is the parent of one or more nested subdomains that you created, but you didn't create the parent subdomain itself. You can't associate or delete a subdomain in this state. To use it, create it with the CreateSubdomain action.

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

      Returns:
      The state of the subdomain.

      The following states are possible:

      • CREATING – The subdomain is being created.

      • CREATE_FAILED – The subdomain couldn't be created. Delete the subdomain, and then create it again if the name is still available.

      • UNATTACHED – The subdomain is ready, and isn't associated with a resource.

      • ATTACHING – The subdomain is being associated with a resource.

      • ATTACHED – The subdomain is associated with a resource, and routes traffic to it.

      • DETACHING – The subdomain is being disassociated from a resource.

      • TRANSFERRING – The subdomain is being moved from one resource to another resource.

      • IMPLICIT – The subdomain is the parent of one or more nested subdomains that you created, but you didn't create the parent subdomain itself. You can't associate or delete a subdomain in this state. To use it, create it with the CreateSubdomain action.

      See Also:
    • stateAsString

      public final String stateAsString()

      The state of the subdomain.

      The following states are possible:

      • CREATING – The subdomain is being created.

      • CREATE_FAILED – The subdomain couldn't be created. Delete the subdomain, and then create it again if the name is still available.

      • UNATTACHED – The subdomain is ready, and isn't associated with a resource.

      • ATTACHING – The subdomain is being associated with a resource.

      • ATTACHED – The subdomain is associated with a resource, and routes traffic to it.

      • DETACHING – The subdomain is being disassociated from a resource.

      • TRANSFERRING – The subdomain is being moved from one resource to another resource.

      • IMPLICIT – The subdomain is the parent of one or more nested subdomains that you created, but you didn't create the parent subdomain itself. You can't associate or delete a subdomain in this state. To use it, create it with the CreateSubdomain action.

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

      Returns:
      The state of the subdomain.

      The following states are possible:

      • CREATING – The subdomain is being created.

      • CREATE_FAILED – The subdomain couldn't be created. Delete the subdomain, and then create it again if the name is still available.

      • UNATTACHED – The subdomain is ready, and isn't associated with a resource.

      • ATTACHING – The subdomain is being associated with a resource.

      • ATTACHED – The subdomain is associated with a resource, and routes traffic to it.

      • DETACHING – The subdomain is being disassociated from a resource.

      • TRANSFERRING – The subdomain is being moved from one resource to another resource.

      • IMPLICIT – The subdomain is the parent of one or more nested subdomains that you created, but you didn't create the parent subdomain itself. You can't associate or delete a subdomain in this state. To use it, create it with the CreateSubdomain action.

      See Also:
    • attachedResource

      public final SubdomainAttachableResource attachedResource()

      An object that describes the resource that the subdomain is associated with.

      When the subdomain is in the TRANSFERRING state, this is the resource that the subdomain is being moved from.

      Returns:
      An object that describes the resource that the subdomain is associated with.

      When the subdomain is in the TRANSFERRING state, this is the resource that the subdomain is being moved from.

    • attachingResource

      public final SubdomainAttachableResource attachingResource()

      An object that describes the resource that the subdomain is being associated with.

      This parameter is returned only when the subdomain is in the ATTACHING or TRANSFERRING state.

      Returns:
      An object that describes the resource that the subdomain is being associated with.

      This parameter is returned only when the subdomain is in the ATTACHING or TRANSFERRING state.

    • location

      public final ResourceLocation location()

      An object that describes the location of the subdomain, such as the AWS Region.

      Returns:
      An object that describes the location of the subdomain, such as the AWS Region.
    • createdAt

      public final Instant createdAt()

      The timestamp when the subdomain was created.

      Returns:
      The timestamp when the subdomain was created.
    • parentFqdn

      public final String parentFqdn()

      The web address of the parent subdomain (for example, mysite.amazonlightsail.com for blog.mysite).

      This parameter isn't returned for a subdomain with a depth of 1.

      Returns:
      The web address of the parent subdomain (for example, mysite.amazonlightsail.com for blog.mysite).

      This parameter isn't returned for a subdomain with a depth of 1.

    • hasChildren

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

      public final List<Subdomain> children()

      An array of objects that describe the nested subdomains of the subdomain.

      This parameter is returned only by the GetSubdomains action when you don't specify a subdomain.

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

      Returns:
      An array of objects that describe the nested subdomains of the subdomain.

      This parameter is returned only by the GetSubdomains action when you don't specify a subdomain.

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

      This parameter is returned only by the GetSubdomains action when you specify a subdomain.

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

      This parameter is returned only by the GetSubdomains action when you specify a subdomain.

    • toBuilder

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

      public static Subdomain.Builder builder()
    • serializableBuilderClass

      public static Class<? extends Subdomain.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.
    • sdkFieldNameToField

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