Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Lightsail.Types.DomainEntry

Description

Synopsis

data DomainEntry = DomainEntry' {
- isAlias :: Maybe Bool
- name :: Maybe Text
- id :: Maybe Text
- options :: Maybe (HashMap Text Text)
- type' :: Maybe Text
- target :: Maybe Text
}
newDomainEntry :: DomainEntry
domainEntry_isAlias :: Lens' DomainEntry (Maybe Bool)
domainEntry_name :: Lens' DomainEntry (Maybe Text)
domainEntry_id :: Lens' DomainEntry (Maybe Text)
domainEntry_options :: Lens' DomainEntry (Maybe (HashMap Text Text))
domainEntry_type :: Lens' DomainEntry (Maybe Text)
domainEntry_target :: Lens' DomainEntry (Maybe Text)

Documentation

data DomainEntry Source #

Describes a domain recordset entry.

See: newDomainEntry smart constructor.

Constructors

DomainEntry'

Fields

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.
id :: Maybe Text
The ID of the domain recordset entry.
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.
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
```
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.

Instances

Instances details

Eq DomainEntry Source #
Instance details Defined in Amazonka.Lightsail.Types.DomainEntry Methods (==) :: DomainEntry -> DomainEntry -> Bool # (/=) :: DomainEntry -> DomainEntry -> Bool #
Read DomainEntry Source #
Instance details Defined in Amazonka.Lightsail.Types.DomainEntry Methods readsPrec :: Int -> ReadS DomainEntry # readList :: ReadS [DomainEntry] # readPrec :: ReadPrec DomainEntry # readListPrec :: ReadPrec [DomainEntry] #
Show DomainEntry Source #
Instance details Defined in Amazonka.Lightsail.Types.DomainEntry Methods showsPrec :: Int -> DomainEntry -> ShowS # show :: DomainEntry -> String # showList :: [DomainEntry] -> ShowS #
Generic DomainEntry Source #
Instance details Defined in Amazonka.Lightsail.Types.DomainEntry Associated Types type Rep DomainEntry :: Type -> Type # Methods from :: DomainEntry -> Rep DomainEntry x # to :: Rep DomainEntry x -> DomainEntry #
NFData DomainEntry Source #
Instance details Defined in Amazonka.Lightsail.Types.DomainEntry Methods rnf :: DomainEntry -> () #
Hashable DomainEntry Source #
Instance details Defined in Amazonka.Lightsail.Types.DomainEntry Methods hashWithSalt :: Int -> DomainEntry -> Int # hash :: DomainEntry -> Int #
ToJSON DomainEntry Source #
Instance details Defined in Amazonka.Lightsail.Types.DomainEntry Methods toJSON :: DomainEntry -> Value # toEncoding :: DomainEntry -> Encoding # toJSONList :: [DomainEntry] -> Value # toEncodingList :: [DomainEntry] -> Encoding #
FromJSON DomainEntry Source #
Instance details Defined in Amazonka.Lightsail.Types.DomainEntry Methods parseJSON :: Value -> Parser DomainEntry # parseJSONList :: Value -> Parser [DomainEntry] #
type Rep DomainEntry Source #
Instance details Defined in Amazonka.Lightsail.Types.DomainEntry type Rep DomainEntry = D1 ('MetaData "DomainEntry" "Amazonka.Lightsail.Types.DomainEntry" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "DomainEntry'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "isAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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: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:id:DomainEntry', domainEntry_id - The ID of the domain recordset entry.

$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: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
```

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

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_id :: Lens' DomainEntry (Maybe Text) Source #

The ID of the domain recordset entry.

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_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
```

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.