Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). 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 either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the 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 .
- registerDomain :: Text -> Natural -> ContactDetail -> ContactDetail -> ContactDetail -> RegisterDomain
- data RegisterDomain
- rPrivacyProtectTechContact :: Lens' RegisterDomain (Maybe Bool)
- rPrivacyProtectRegistrantContact :: Lens' RegisterDomain (Maybe Bool)
- rAutoRenew :: Lens' RegisterDomain (Maybe Bool)
- rPrivacyProtectAdminContact :: Lens' RegisterDomain (Maybe Bool)
- rIdNLangCode :: Lens' RegisterDomain (Maybe Text)
- rDomainName :: Lens' RegisterDomain Text
- rDurationInYears :: Lens' RegisterDomain Natural
- rAdminContact :: Lens' RegisterDomain ContactDetail
- rRegistrantContact :: Lens' RegisterDomain ContactDetail
- rTechContact :: Lens' RegisterDomain ContactDetail
- registerDomainResponse :: Int -> Text -> RegisterDomainResponse
- data RegisterDomainResponse
- rdrsResponseStatus :: 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:
rPrivacyProtectTechContact
- Whether you want to conceal contact information from WHOIS queries. If you specifytrue
, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specifyfalse
, WHOIS queries return the information that you entered for the technical contact. Default:true
rPrivacyProtectRegistrantContact
- Whether you want to conceal contact information from WHOIS queries. If you specifytrue
, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specifyfalse
, WHOIS queries return the information that you entered for the registrant contact (the domain owner). Default:true
rAutoRenew
- Indicates whether the domain will be automatically renewed (true
) or not (false
). Autorenewal only takes effect after the account is charged. Default:true
rPrivacyProtectAdminContact
- Whether you want to conceal contact information from WHOIS queries. If you specifytrue
, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specifyfalse
, WHOIS queries return the information that you entered for the admin contact. Default:true
rIdNLangCode
- Reserved for future use.rDomainName
- The domain name that you want to register. 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.rDurationInYears
- The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide . Default: 1rAdminContact
- Provides detailed contact information.rRegistrantContact
- Provides detailed contact information.rTechContact
- Provides detailed contact information.
data RegisterDomain Source #
The RegisterDomain request includes the following elements.
See: registerDomain
smart constructor.
Request Lenses
rPrivacyProtectTechContact :: Lens' RegisterDomain (Maybe Bool) Source #
Whether you want to conceal contact information from WHOIS queries. If you specify true
, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false
, WHOIS queries return the information that you entered for the technical contact. Default: true
rPrivacyProtectRegistrantContact :: Lens' RegisterDomain (Maybe Bool) Source #
Whether you want to conceal contact information from WHOIS queries. If you specify true
, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false
, WHOIS queries return the information that you entered for the registrant contact (the domain owner). Default: true
rAutoRenew :: 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. Default: true
rPrivacyProtectAdminContact :: Lens' RegisterDomain (Maybe Bool) Source #
Whether you want to conceal contact information from WHOIS queries. If you specify true
, WHOIS ("who is") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false
, WHOIS queries return the information that you entered for the admin contact. Default: true
rIdNLangCode :: Lens' RegisterDomain (Maybe Text) Source #
Reserved for future use.
rDomainName :: Lens' RegisterDomain Text Source #
The domain name that you want to register. 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.
rDurationInYears :: Lens' RegisterDomain Natural Source #
The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide . Default: 1
rAdminContact :: Lens' RegisterDomain ContactDetail Source #
Provides detailed contact information.
rRegistrantContact :: Lens' RegisterDomain ContactDetail Source #
Provides detailed contact information.
rTechContact :: Lens' RegisterDomain ContactDetail Source #
Provides detailed contact information.
Destructuring the Response
registerDomainResponse Source #
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:
rdrsResponseStatus
- -- | The response status code.rdrsOperationId
- Identifier for tracking the progress of the request. To use this ID to query the operation status, useGetOperationDetail
.
data RegisterDomainResponse Source #
The RegisterDomain response includes the following element.
See: registerDomainResponse
smart constructor.
Response Lenses
rdrsResponseStatus :: 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
.