amazonka-lightsail-2.0: Amazon Lightsail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Lightsail.Types.DomainEntry

Description

 
Synopsis

Documentation

data DomainEntry Source #

Describes a domain recordset entry.

See: newDomainEntry smart constructor.

Constructors

DomainEntry' 

Fields

  • id :: Maybe Text

    The ID of the domain recordset entry.

  • isAlias :: Maybe Bool

    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.

  • name :: Maybe Text

    The name of the domain.

  • options :: Maybe (HashMap Text Text)

    (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.

  • target :: Maybe Text

    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.

  • type' :: Maybe Text

    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

Instances

Instances details
FromJSON DomainEntry Source # 
Instance details

Defined in Amazonka.Lightsail.Types.DomainEntry

ToJSON DomainEntry Source # 
Instance details

Defined in Amazonka.Lightsail.Types.DomainEntry

Generic DomainEntry Source # 
Instance details

Defined in Amazonka.Lightsail.Types.DomainEntry

Associated Types

type Rep DomainEntry :: Type -> Type #

Read DomainEntry Source # 
Instance details

Defined in Amazonka.Lightsail.Types.DomainEntry

Show DomainEntry Source # 
Instance details

Defined in Amazonka.Lightsail.Types.DomainEntry

NFData DomainEntry Source # 
Instance details

Defined in Amazonka.Lightsail.Types.DomainEntry

Methods

rnf :: DomainEntry -> () #

Eq DomainEntry Source # 
Instance details

Defined in Amazonka.Lightsail.Types.DomainEntry

Hashable DomainEntry Source # 
Instance details

Defined in Amazonka.Lightsail.Types.DomainEntry

type Rep DomainEntry Source # 
Instance details

Defined in Amazonka.Lightsail.Types.DomainEntry

newDomainEntry :: DomainEntry Source #

Create a value of DomainEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:DomainEntry', domainEntry_id - The ID of the domain recordset entry.

$sel:isAlias:DomainEntry', domainEntry_isAlias - 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.

$sel:name:DomainEntry', domainEntry_name - The name of the domain.

$sel:options:DomainEntry', domainEntry_options - (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.

$sel:target:DomainEntry', domainEntry_target - 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.

$sel:type':DomainEntry', domainEntry_type - 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

domainEntry_id :: Lens' DomainEntry (Maybe Text) Source #

The ID of the domain recordset entry.

domainEntry_isAlias :: Lens' DomainEntry (Maybe Bool) Source #

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.

domainEntry_name :: Lens' DomainEntry (Maybe Text) Source #

The name of the domain.

domainEntry_options :: Lens' DomainEntry (Maybe (HashMap Text Text)) Source #

(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.

domainEntry_target :: Lens' DomainEntry (Maybe Text) Source #

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.

domainEntry_type :: Lens' DomainEntry (Maybe Text) Source #

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