Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters.
When you register a domain, Amazon Route 53 does the following:
- Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
- Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
- Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts.
- If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.
- Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
See: AWS API Reference for RegisterDomain.
- registerDomain :: Text -> Natural -> ContactDetail -> ContactDetail -> ContactDetail -> RegisterDomain
- data RegisterDomain
- rdPrivacyProtectTechContact :: Lens' RegisterDomain (Maybe Bool)
- rdPrivacyProtectRegistrantContact :: Lens' RegisterDomain (Maybe Bool)
- rdAutoRenew :: Lens' RegisterDomain (Maybe Bool)
- rdPrivacyProtectAdminContact :: Lens' RegisterDomain (Maybe Bool)
- rdIdNLangCode :: Lens' RegisterDomain (Maybe Text)
- rdDomainName :: Lens' RegisterDomain Text
- rdDurationInYears :: Lens' RegisterDomain Natural
- rdAdminContact :: Lens' RegisterDomain ContactDetail
- rdRegistrantContact :: Lens' RegisterDomain ContactDetail
- rdTechContact :: Lens' RegisterDomain ContactDetail
- registerDomainResponse :: Int -> Text -> RegisterDomainResponse
- data RegisterDomainResponse
- rdrsStatus :: Lens' RegisterDomainResponse Int
- rdrsOperationId :: Lens' RegisterDomainResponse Text
Creating a Request
:: Text | |
-> Natural | |
-> ContactDetail | |
-> ContactDetail | |
-> ContactDetail | |
-> RegisterDomain |
Creates a value of RegisterDomain
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data RegisterDomain Source
The RegisterDomain request includes the following elements.
See: registerDomain
smart constructor.
Request Lenses
rdPrivacyProtectTechContact :: Lens' RegisterDomain (Maybe Bool) Source
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true
| false
Required: No
rdPrivacyProtectRegistrantContact :: Lens' RegisterDomain (Maybe Bool) Source
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true
| false
Required: No
rdAutoRenew :: Lens' RegisterDomain (Maybe Bool) Source
Indicates whether the domain will be automatically renewed (true
) or
not (false
). Autorenewal only takes effect after the account is
charged.
Type: Boolean
Valid values: true
| false
Default: true
Required: No
rdPrivacyProtectAdminContact :: Lens' RegisterDomain (Maybe Bool) Source
Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
Default: true
Valid values: true
| false
Required: No
rdIdNLangCode :: Lens' RegisterDomain (Maybe Text) Source
Reserved for future use.
rdDomainName :: Lens' RegisterDomain Text Source
The name of a domain.
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
rdDurationInYears :: Lens' RegisterDomain Natural Source
The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
rdAdminContact :: Lens' RegisterDomain ContactDetail Source
Provides detailed contact information.
Type: Complex
Children: FirstName
, MiddleName
, LastName
, ContactType
,
OrganizationName
, AddressLine1
, AddressLine2
, City
, State
,
CountryCode
, ZipCode
, PhoneNumber
, Email
, Fax
, ExtraParams
Required: Yes
rdRegistrantContact :: Lens' RegisterDomain ContactDetail Source
Provides detailed contact information.
Type: Complex
Children: FirstName
, MiddleName
, LastName
, ContactType
,
OrganizationName
, AddressLine1
, AddressLine2
, City
, State
,
CountryCode
, ZipCode
, PhoneNumber
, Email
, Fax
, ExtraParams
Required: Yes
rdTechContact :: Lens' RegisterDomain ContactDetail Source
Provides detailed contact information.
Type: Complex
Children: FirstName
, MiddleName
, LastName
, ContactType
,
OrganizationName
, AddressLine1
, AddressLine2
, City
, State
,
CountryCode
, ZipCode
, PhoneNumber
, Email
, Fax
, ExtraParams
Required: Yes
Destructuring the Response
Creates a value of RegisterDomainResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data RegisterDomainResponse Source
The RegisterDomain response includes the following element.
See: registerDomainResponse
smart constructor.
Response Lenses
rdrsStatus :: Lens' RegisterDomainResponse Int Source
The response status code.
rdrsOperationId :: Lens' RegisterDomainResponse Text Source
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
Type: String
Default: None
Constraints: Maximum 255 characters.