You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Lightsail::Types::DomainEntry

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Note:

When making an API call, you may pass DomainEntry data as a hash:

{
  id: "NonEmptyString",
  name: "DomainName",
  target: "string",
  is_alias: false,
  type: "DomainEntryType",
  options: {
    "DomainEntryOptionsKeys" => "string",
  },
}

Describes a domain recordset entry.

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The ID of the domain recordset entry.

Returns:

  • (String)


1738
1739
1740
1741
1742
1743
1744
1745
1746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1738

class DomainEntry < Struct.new(
  :id,
  :name,
  :target,
  :is_alias,
  :type,
  :options)
  include Aws::Structure
end

#is_aliasBoolean

When true, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer

Returns:

  • (Boolean)


1738
1739
1740
1741
1742
1743
1744
1745
1746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1738

class DomainEntry < Struct.new(
  :id,
  :name,
  :target,
  :is_alias,
  :type,
  :options)
  include Aws::Structure
end

#nameString

The name of the domain.

Returns:

  • (String)


1738
1739
1740
1741
1742
1743
1744
1745
1746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1738

class DomainEntry < Struct.new(
  :id,
  :name,
  :target,
  :is_alias,
  :type,
  :options)
  include Aws::Structure
end

#optionsHash<String,String>

(Deprecated) The options for the domain entry.

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

Returns:

  • (Hash<String,String>)


1738
1739
1740
1741
1742
1743
1744
1745
1746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1738

class DomainEntry < Struct.new(
  :id,
  :name,
  :target,
  :is_alias,
  :type,
  :options)
  include Aws::Structure
end

#targetString

The target AWS name server (e.g., ns-111.awsdns-22.com.).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure to also set isAlias to true when setting up an A record for a load balancer.

Returns:

  • (String)


1738
1739
1740
1741
1742
1743
1744
1745
1746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1738

class DomainEntry < Struct.new(
  :id,
  :name,
  :target,
  :is_alias,
  :type,
  :options)
  include Aws::Structure
end

#typeString

The type of domain entry (e.g., SOA or NS).

Returns:

  • (String)


1738
1739
1740
1741
1742
1743
1744
1745
1746
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1738

class DomainEntry < Struct.new(
  :id,
  :name,
  :target,
  :is_alias,
  :type,
  :options)
  include Aws::Structure
end