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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The ID of the domain recordset entry.

Returns:

  • (String)


6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 6427

class DomainEntry < Struct.new(
  :id,
  :name,
  :target,
  :is_alias,
  :type,
  :options)
  SENSITIVE = []
  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)


6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 6427

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

#nameString

The name of the domain.

Returns:

  • (String)


6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 6427

class DomainEntry < Struct.new(
  :id,
  :name,
  :target,
  :is_alias,
  :type,
  :options)
  SENSITIVE = []
  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>)


6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 6427

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

#targetString

The target IP address (e.g., 192.0.2.0), or 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. For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net. For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.

Returns:

  • (String)


6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 6427

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

#typeString

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:

  • A

  • AAAA

  • CNAME

  • MX

  • NS

  • SOA

  • SRV

  • TXT

Returns:

  • (String)


6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 6427

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