Interface Subdomain.Builder

  • Method Details

    • subdomainName

      Subdomain.Builder subdomainName(String subdomainName)

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

      Parameters:
      subdomainName - The subdomain (for example, mysite or blog.mysite). To get the web address, use the fqdn parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • fqdn

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

      Parameters:
      fqdn - The web address of the subdomain, which is the subdomain followed by amazonlightsail.com (for example, blog.mysite.amazonlightsail.com).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • depth

      Subdomain.Builder depth(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • state

      Subdomain.Builder state(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • attachedResource

      Subdomain.Builder attachedResource(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • attachedResource

      default Subdomain.Builder attachedResource(Consumer<SubdomainAttachableResource.Builder> 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.

      This is a convenience method that creates an instance of the SubdomainAttachableResource.Builder avoiding the need to create one manually via SubdomainAttachableResource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachedResource(SubdomainAttachableResource).

      Parameters:
      attachedResource - a consumer that will call methods on SubdomainAttachableResource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • attachingResource

      Subdomain.Builder attachingResource(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • attachingResource

      default Subdomain.Builder attachingResource(Consumer<SubdomainAttachableResource.Builder> 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.

      This is a convenience method that creates an instance of the SubdomainAttachableResource.Builder avoiding the need to create one manually via SubdomainAttachableResource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachingResource(SubdomainAttachableResource).

      Parameters:
      attachingResource - a consumer that will call methods on SubdomainAttachableResource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • location

      Subdomain.Builder location(ResourceLocation location)

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

      Parameters:
      location - An object that describes the location of the subdomain, such as the AWS Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • location

      default Subdomain.Builder location(Consumer<ResourceLocation.Builder> location)

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

      This is a convenience method that creates an instance of the ResourceLocation.Builder avoiding the need to create one manually via ResourceLocation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to location(ResourceLocation).

      Parameters:
      location - a consumer that will call methods on ResourceLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • createdAt

      Subdomain.Builder createdAt(Instant createdAt)

      The timestamp when the subdomain was created.

      Parameters:
      createdAt - The timestamp when the subdomain was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • parentFqdn

      Subdomain.Builder parentFqdn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • children

      Subdomain.Builder children(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • children

      Subdomain.Builder children(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      This is a convenience method that creates an instance of the Subdomain.Builder avoiding the need to create one manually via Subdomain.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to children(List<Subdomain>).

      Parameters:
      children - a consumer that will call methods on Subdomain.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      Subdomain.Builder tags(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: