Interface Subdomain.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<Subdomain.Builder,,Subdomain> SdkBuilder<Subdomain.Builder,,Subdomain> SdkPojo
- Enclosing class:
Subdomain
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the subdomain.default Subdomain.BuilderattachedResource(Consumer<SubdomainAttachableResource.Builder> attachedResource) An object that describes the resource that the subdomain is associated with.attachedResource(SubdomainAttachableResource attachedResource) An object that describes the resource that the subdomain is associated with.default Subdomain.BuilderattachingResource(Consumer<SubdomainAttachableResource.Builder> attachingResource) An object that describes the resource that the subdomain is being associated with.attachingResource(SubdomainAttachableResource attachingResource) An object that describes the resource that the subdomain is being associated with.children(Collection<Subdomain> children) An array of objects that describe the nested subdomains of the subdomain.children(Consumer<Subdomain.Builder>... children) An array of objects that describe the nested subdomains of the subdomain.An array of objects that describe the nested subdomains of the subdomain.The timestamp when the subdomain was created.The number of labels in the subdomain.The web address of the subdomain, which is the subdomain followed byamazonlightsail.com(for example,blog.mysite.amazonlightsail.com).default Subdomain.Builderlocation(Consumer<ResourceLocation.Builder> location) An object that describes the location of the subdomain, such as the AWS Region.location(ResourceLocation location) An object that describes the location of the subdomain, such as the AWS Region.parentFqdn(String parentFqdn) The web address of the parent subdomain (for example,mysite.amazonlightsail.comforblog.mysite).The state of the subdomain.state(SubdomainState state) The state of the subdomain.subdomainName(String subdomainName) The subdomain (for example,mysiteorblog.mysite).tags(Collection<Tag> tags) The tag keys and optional values for the subdomain.tags(Consumer<Tag.Builder>... tags) The tag keys and optional values for the subdomain.The tag keys and optional values for the subdomain.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
subdomainName
The subdomain (for example,
mysiteorblog.mysite). To get the web address, use thefqdnparameter.- Parameters:
subdomainName- The subdomain (for example,mysiteorblog.mysite). To get the web address, use thefqdnparameter.- 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 holdsmysitefor your account in theIMPLICITstate. 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 holdsmysitefor your account in theIMPLICITstate. 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 byamazonlightsail.com(for example,blog.mysite.amazonlightsail.com).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
depth
The number of labels in the subdomain. A top-level subdomain, such as
mysite, has a depth of1. A nested subdomain, such asblog.mysite, has a depth of2.- Parameters:
depth- The number of labels in the subdomain. A top-level subdomain, such asmysite, has a depth of1. A nested subdomain, such asblog.mysite, has a depth of2.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theCreateSubdomainaction.
- 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 theCreateSubdomainaction.
-
- 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 theCreateSubdomainaction.
- 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 theCreateSubdomainaction.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
attachedResource
An object that describes the resource that the subdomain is associated with.
When the subdomain is in the
TRANSFERRINGstate, 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
TRANSFERRINGstate, 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
This is a convenience method that creates an instance of theTRANSFERRINGstate, this is the resource that the subdomain is being moved from.SubdomainAttachableResource.Builderavoiding the need to create one manually viaSubdomainAttachableResource.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toattachedResource(SubdomainAttachableResource).- Parameters:
attachedResource- a consumer that will call methods onSubdomainAttachableResource.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
ATTACHINGorTRANSFERRINGstate.- 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
ATTACHINGorTRANSFERRINGstate.- 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
This is a convenience method that creates an instance of theATTACHINGorTRANSFERRINGstate.SubdomainAttachableResource.Builderavoiding the need to create one manually viaSubdomainAttachableResource.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toattachingResource(SubdomainAttachableResource).- Parameters:
attachingResource- a consumer that will call methods onSubdomainAttachableResource.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
An object that describes the location of the subdomain, such as the AWS Region.
This is a convenience method that creates an instance of theResourceLocation.Builderavoiding the need to create one manually viaResourceLocation.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolocation(ResourceLocation).- Parameters:
location- a consumer that will call methods onResourceLocation.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The web address of the parent subdomain (for example,
mysite.amazonlightsail.comforblog.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.comforblog.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
An array of objects that describe the nested subdomains of the subdomain.
This parameter is returned only by the
GetSubdomainsaction 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
GetSubdomainsaction 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
GetSubdomainsaction 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
GetSubdomainsaction 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
This is a convenience method that creates an instance of theGetSubdomainsaction when you don't specify a subdomain.Subdomain.Builderavoiding the need to create one manually viaSubdomain.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tochildren(List<Subdomain>).- Parameters:
children- a consumer that will call methods onSubdomain.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
GetSubdomainsaction 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
GetSubdomainsaction 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
GetSubdomainsaction 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
GetSubdomainsaction 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
This is a convenience method that creates an instance of theGetSubdomainsaction when you specify a subdomain.Tag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totags(List<Tag>).- Parameters:
tags- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-