Class: Aws::Lightsail::Types::Subdomain

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::Subdomain

Defined in:

gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the subdomain.

• #attached_resource ⇒ Types::SubdomainAttachableResource

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

• #attaching_resource ⇒ Types::SubdomainAttachableResource

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

• #children ⇒ Array<Types::Subdomain>

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

• #created_at ⇒ Time

  The timestamp when the subdomain was created.

• #depth ⇒ Integer

  The number of labels in the subdomain.

• #fqdn ⇒ String

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

• #location ⇒ Types::ResourceLocation

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

• #parent_fqdn ⇒ String

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

• #state ⇒ String

  The state of the subdomain.

• #subdomain_name ⇒ String

  The subdomain (for example, mysite or blog.mysite).

• #tags ⇒ Array<Types::Tag>

  The tag keys and optional values for the subdomain.

Instance Attribute Details

#arn ⇒ String

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:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#attached_resource ⇒ Types::SubdomainAttachableResource

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:

• (Types::SubdomainAttachableResource)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#attaching_resource ⇒ Types::SubdomainAttachableResource

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:

• (Types::SubdomainAttachableResource)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#children ⇒ Array<Types::Subdomain>

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:

• (Array<Types::Subdomain>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp when the subdomain was created.

Returns:

• (Time)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#depth ⇒ Integer

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:

• (Integer)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#fqdn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ Types::ResourceLocation

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

Returns:

• (Types::ResourceLocation)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#parent_fqdn ⇒ String

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:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

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:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#subdomain_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 15242

class Subdomain < Struct.new(
  :subdomain_name,
  :arn,
  :fqdn,
  :depth,
  :state,
  :attached_resource,
  :attaching_resource,
  :location,
  :created_at,
  :parent_fqdn,
  :children,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end