/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Route53Domains { namespace Model { /** *

The RegisterDomain request includes the following elements.

See * Also:

AWS * API Reference

*/ class AWS_ROUTE53DOMAINS_API RegisterDomainRequest : public Route53DomainsRequest { public: RegisterDomainRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "RegisterDomain"; } Aws::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The domain name that you want to register. The top-level domain (TLD), such * as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see * Domains * that You Can Register with Amazon Route 53 in the Amazon Route 53 * Developer Guide.

The domain name can contain only the following * characters:

  • Letters a through z. Domain names are not case * sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). * You can't specify a hyphen at the beginning or end of a label.

  • *

    Period (.) to separate the labels in the name, such as the . in * example.com.

Internationalized domain names are * not supported for some top-level domains. To determine whether the TLD that you * want to use supports internationalized domain names, see Domains * that You Can Register with Amazon Route 53. For more information, see Formatting * Internationalized Domain Names.

*/ inline const Aws::String& GetDomainName() const{ return m_domainName; } /** *

The domain name that you want to register. The top-level domain (TLD), such * as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see * Domains * that You Can Register with Amazon Route 53 in the Amazon Route 53 * Developer Guide.

The domain name can contain only the following * characters:

  • Letters a through z. Domain names are not case * sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). * You can't specify a hyphen at the beginning or end of a label.

  • *

    Period (.) to separate the labels in the name, such as the . in * example.com.

Internationalized domain names are * not supported for some top-level domains. To determine whether the TLD that you * want to use supports internationalized domain names, see Domains * that You Can Register with Amazon Route 53. For more information, see Formatting * Internationalized Domain Names.

*/ inline bool DomainNameHasBeenSet() const { return m_domainNameHasBeenSet; } /** *

The domain name that you want to register. The top-level domain (TLD), such * as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see * Domains * that You Can Register with Amazon Route 53 in the Amazon Route 53 * Developer Guide.

The domain name can contain only the following * characters:

  • Letters a through z. Domain names are not case * sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). * You can't specify a hyphen at the beginning or end of a label.

  • *

    Period (.) to separate the labels in the name, such as the . in * example.com.

Internationalized domain names are * not supported for some top-level domains. To determine whether the TLD that you * want to use supports internationalized domain names, see Domains * that You Can Register with Amazon Route 53. For more information, see Formatting * Internationalized Domain Names.

*/ inline void SetDomainName(const Aws::String& value) { m_domainNameHasBeenSet = true; m_domainName = value; } /** *

The domain name that you want to register. The top-level domain (TLD), such * as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see * Domains * that You Can Register with Amazon Route 53 in the Amazon Route 53 * Developer Guide.

The domain name can contain only the following * characters:

  • Letters a through z. Domain names are not case * sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). * You can't specify a hyphen at the beginning or end of a label.

  • *

    Period (.) to separate the labels in the name, such as the . in * example.com.

Internationalized domain names are * not supported for some top-level domains. To determine whether the TLD that you * want to use supports internationalized domain names, see Domains * that You Can Register with Amazon Route 53. For more information, see Formatting * Internationalized Domain Names.

*/ inline void SetDomainName(Aws::String&& value) { m_domainNameHasBeenSet = true; m_domainName = std::move(value); } /** *

The domain name that you want to register. The top-level domain (TLD), such * as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see * Domains * that You Can Register with Amazon Route 53 in the Amazon Route 53 * Developer Guide.

The domain name can contain only the following * characters:

  • Letters a through z. Domain names are not case * sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). * You can't specify a hyphen at the beginning or end of a label.

  • *

    Period (.) to separate the labels in the name, such as the . in * example.com.

Internationalized domain names are * not supported for some top-level domains. To determine whether the TLD that you * want to use supports internationalized domain names, see Domains * that You Can Register with Amazon Route 53. For more information, see Formatting * Internationalized Domain Names.

*/ inline void SetDomainName(const char* value) { m_domainNameHasBeenSet = true; m_domainName.assign(value); } /** *

The domain name that you want to register. The top-level domain (TLD), such * as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see * Domains * that You Can Register with Amazon Route 53 in the Amazon Route 53 * Developer Guide.

The domain name can contain only the following * characters:

  • Letters a through z. Domain names are not case * sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). * You can't specify a hyphen at the beginning or end of a label.

  • *

    Period (.) to separate the labels in the name, such as the . in * example.com.

Internationalized domain names are * not supported for some top-level domains. To determine whether the TLD that you * want to use supports internationalized domain names, see Domains * that You Can Register with Amazon Route 53. For more information, see Formatting * Internationalized Domain Names.

*/ inline RegisterDomainRequest& WithDomainName(const Aws::String& value) { SetDomainName(value); return *this;} /** *

The domain name that you want to register. The top-level domain (TLD), such * as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see * Domains * that You Can Register with Amazon Route 53 in the Amazon Route 53 * Developer Guide.

The domain name can contain only the following * characters:

  • Letters a through z. Domain names are not case * sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). * You can't specify a hyphen at the beginning or end of a label.

  • *

    Period (.) to separate the labels in the name, such as the . in * example.com.

Internationalized domain names are * not supported for some top-level domains. To determine whether the TLD that you * want to use supports internationalized domain names, see Domains * that You Can Register with Amazon Route 53. For more information, see Formatting * Internationalized Domain Names.

*/ inline RegisterDomainRequest& WithDomainName(Aws::String&& value) { SetDomainName(std::move(value)); return *this;} /** *

The domain name that you want to register. The top-level domain (TLD), such * as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see * Domains * that You Can Register with Amazon Route 53 in the Amazon Route 53 * Developer Guide.

The domain name can contain only the following * characters:

  • Letters a through z. Domain names are not case * sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). * You can't specify a hyphen at the beginning or end of a label.

  • *

    Period (.) to separate the labels in the name, such as the . in * example.com.

Internationalized domain names are * not supported for some top-level domains. To determine whether the TLD that you * want to use supports internationalized domain names, see Domains * that You Can Register with Amazon Route 53. For more information, see Formatting * Internationalized Domain Names.

*/ inline RegisterDomainRequest& WithDomainName(const char* value) { SetDomainName(value); return *this;} /** *

Reserved for future use.

*/ inline const Aws::String& GetIdnLangCode() const{ return m_idnLangCode; } /** *

Reserved for future use.

*/ inline bool IdnLangCodeHasBeenSet() const { return m_idnLangCodeHasBeenSet; } /** *

Reserved for future use.

*/ inline void SetIdnLangCode(const Aws::String& value) { m_idnLangCodeHasBeenSet = true; m_idnLangCode = value; } /** *

Reserved for future use.

*/ inline void SetIdnLangCode(Aws::String&& value) { m_idnLangCodeHasBeenSet = true; m_idnLangCode = std::move(value); } /** *

Reserved for future use.

*/ inline void SetIdnLangCode(const char* value) { m_idnLangCodeHasBeenSet = true; m_idnLangCode.assign(value); } /** *

Reserved for future use.

*/ inline RegisterDomainRequest& WithIdnLangCode(const Aws::String& value) { SetIdnLangCode(value); return *this;} /** *

Reserved for future use.

*/ inline RegisterDomainRequest& WithIdnLangCode(Aws::String&& value) { SetIdnLangCode(std::move(value)); return *this;} /** *

Reserved for future use.

*/ inline RegisterDomainRequest& WithIdnLangCode(const char* value) { SetIdnLangCode(value); return *this;} /** *

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

*/ inline int GetDurationInYears() const{ return m_durationInYears; } /** *

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

*/ inline bool DurationInYearsHasBeenSet() const { return m_durationInYearsHasBeenSet; } /** *

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

*/ inline void SetDurationInYears(int value) { m_durationInYearsHasBeenSet = true; m_durationInYears = value; } /** *

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

*/ inline RegisterDomainRequest& WithDurationInYears(int value) { SetDurationInYears(value); return *this;} /** *

Indicates whether the domain will be automatically renewed * (true) or not (false). Autorenewal only takes effect * after the account is charged.

Default: true

*/ inline bool GetAutoRenew() const{ return m_autoRenew; } /** *

Indicates whether the domain will be automatically renewed * (true) or not (false). Autorenewal only takes effect * after the account is charged.

Default: true

*/ inline bool AutoRenewHasBeenSet() const { return m_autoRenewHasBeenSet; } /** *

Indicates whether the domain will be automatically renewed * (true) or not (false). Autorenewal only takes effect * after the account is charged.

Default: true

*/ inline void SetAutoRenew(bool value) { m_autoRenewHasBeenSet = true; m_autoRenew = value; } /** *

Indicates whether the domain will be automatically renewed * (true) or not (false). Autorenewal only takes effect * after the account is charged.

Default: true

*/ inline RegisterDomainRequest& WithAutoRenew(bool value) { SetAutoRenew(value); return *this;} /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline const ContactDetail& GetAdminContact() const{ return m_adminContact; } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline bool AdminContactHasBeenSet() const { return m_adminContactHasBeenSet; } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline void SetAdminContact(const ContactDetail& value) { m_adminContactHasBeenSet = true; m_adminContact = value; } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline void SetAdminContact(ContactDetail&& value) { m_adminContactHasBeenSet = true; m_adminContact = std::move(value); } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline RegisterDomainRequest& WithAdminContact(const ContactDetail& value) { SetAdminContact(value); return *this;} /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline RegisterDomainRequest& WithAdminContact(ContactDetail&& value) { SetAdminContact(std::move(value)); return *this;} /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline const ContactDetail& GetRegistrantContact() const{ return m_registrantContact; } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline bool RegistrantContactHasBeenSet() const { return m_registrantContactHasBeenSet; } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline void SetRegistrantContact(const ContactDetail& value) { m_registrantContactHasBeenSet = true; m_registrantContact = value; } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline void SetRegistrantContact(ContactDetail&& value) { m_registrantContactHasBeenSet = true; m_registrantContact = std::move(value); } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline RegisterDomainRequest& WithRegistrantContact(const ContactDetail& value) { SetRegistrantContact(value); return *this;} /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline RegisterDomainRequest& WithRegistrantContact(ContactDetail&& value) { SetRegistrantContact(std::move(value)); return *this;} /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline const ContactDetail& GetTechContact() const{ return m_techContact; } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline bool TechContactHasBeenSet() const { return m_techContactHasBeenSet; } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline void SetTechContact(const ContactDetail& value) { m_techContactHasBeenSet = true; m_techContact = value; } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline void SetTechContact(ContactDetail&& value) { m_techContactHasBeenSet = true; m_techContact = std::move(value); } /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline RegisterDomainRequest& WithTechContact(const ContactDetail& value) { SetTechContact(value); return *this;} /** *

Provides detailed contact information. For information about the values that * you specify for each element, see ContactDetail.

*/ inline RegisterDomainRequest& WithTechContact(ContactDetail&& value) { SetTechContact(std::move(value)); return *this;} /** *

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

*/ inline bool GetPrivacyProtectAdminContact() const{ return m_privacyProtectAdminContact; } /** *

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

*/ inline bool PrivacyProtectAdminContactHasBeenSet() const { return m_privacyProtectAdminContactHasBeenSet; } /** *

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

*/ inline void SetPrivacyProtectAdminContact(bool value) { m_privacyProtectAdminContactHasBeenSet = true; m_privacyProtectAdminContact = value; } /** *

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

*/ inline RegisterDomainRequest& WithPrivacyProtectAdminContact(bool value) { SetPrivacyProtectAdminContact(value); return *this;} /** *

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 *

*/ inline bool GetPrivacyProtectRegistrantContact() const{ return m_privacyProtectRegistrantContact; } /** *

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 *

*/ inline bool PrivacyProtectRegistrantContactHasBeenSet() const { return m_privacyProtectRegistrantContactHasBeenSet; } /** *

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 *

*/ inline void SetPrivacyProtectRegistrantContact(bool value) { m_privacyProtectRegistrantContactHasBeenSet = true; m_privacyProtectRegistrantContact = value; } /** *

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 *

*/ inline RegisterDomainRequest& WithPrivacyProtectRegistrantContact(bool value) { SetPrivacyProtectRegistrantContact(value); return *this;} /** *

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

*/ inline bool GetPrivacyProtectTechContact() const{ return m_privacyProtectTechContact; } /** *

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

*/ inline bool PrivacyProtectTechContactHasBeenSet() const { return m_privacyProtectTechContactHasBeenSet; } /** *

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

*/ inline void SetPrivacyProtectTechContact(bool value) { m_privacyProtectTechContactHasBeenSet = true; m_privacyProtectTechContact = value; } /** *

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

*/ inline RegisterDomainRequest& WithPrivacyProtectTechContact(bool value) { SetPrivacyProtectTechContact(value); return *this;} private: Aws::String m_domainName; bool m_domainNameHasBeenSet; Aws::String m_idnLangCode; bool m_idnLangCodeHasBeenSet; int m_durationInYears; bool m_durationInYearsHasBeenSet; bool m_autoRenew; bool m_autoRenewHasBeenSet; ContactDetail m_adminContact; bool m_adminContactHasBeenSet; ContactDetail m_registrantContact; bool m_registrantContactHasBeenSet; ContactDetail m_techContact; bool m_techContactHasBeenSet; bool m_privacyProtectAdminContact; bool m_privacyProtectAdminContactHasBeenSet; bool m_privacyProtectRegistrantContact; bool m_privacyProtectRegistrantContactHasBeenSet; bool m_privacyProtectTechContact; bool m_privacyProtectTechContactHasBeenSet; }; } // namespace Model } // namespace Route53Domains } // namespace Aws