Class: Aws::Route53Domains::Types::RegisterDomainRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-route53domains/types.rb

Overview

The RegisterDomain request includes the following elements.

See Also:

Constant Summary collapse

SENSITIVE = 
[:admin_contact, :registrant_contact, :tech_contact, :billing_contact]

Instance Attribute Summary collapse

Instance Attribute Details

#admin_contact ⇒ Types::ContactDetail

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

[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html

Returns:



2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end

#auto_renew ⇒ Boolean

Indicates whether the domain will be automatically renewed (‘true`) or not (`false`). Auto renewal only takes effect after the account is charged.

Default: ‘true`

Returns:

  • (Boolean) 


2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end

#billing_contact ⇒ Types::ContactDetail

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

[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html

Returns:



2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end

#domain_name ⇒ String

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

[1]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html [2]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html#domain-name-format-idns

Returns:

  • (String) 


2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end

#duration_in_years ⇒ Integer

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

[1]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html

Returns:

  • (Integer) 


2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end

#idn_lang_code ⇒ String

Reserved for future use.

Returns:

  • (String) 


2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end

#privacy_protect_admin_contact ⇒ Boolean

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 or for our registrar associate, Gandi. If you specify `false`, WHOIS queries return the information that you entered for the admin contact.

<note markdown=“1”> You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

</note>

Default: ‘true`

Returns:

  • (Boolean) 


2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end

#privacy_protect_billing_contact ⇒ Boolean

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 or for our registrar associate, Gandi. If you specify `false`, WHOIS queries return the information that you entered for the billing contact.

<note markdown=“1”> You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

</note>

Returns:

  • (Boolean) 


2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end

#privacy_protect_registrant_contact ⇒ Boolean

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 or for our registrar associate, Gandi. If you specify `false`, WHOIS queries return the information that you entered for the registrant contact (the domain owner).

<note markdown=“1”> You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

</note>

Default: ‘true`

Returns:

  • (Boolean) 


2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end

#privacy_protect_tech_contact ⇒ Boolean

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 or for our registrar associate, Gandi. If you specify `false`, WHOIS queries return the information that you entered for the technical contact.

<note markdown=“1”> You must specify the same privacy setting for the administrative, billing, registrant, and technical contacts.

</note>

Default: ‘true`

Returns:

  • (Boolean) 


2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end

#registrant_contact ⇒ Types::ContactDetail

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

[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html

Returns:



2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end

#tech_contact ⇒ Types::ContactDetail

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

[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html

Returns:



2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/aws-sdk-route53domains/types.rb', line 2402

class RegisterDomainRequest < Struct.new(
  :domain_name,
  :idn_lang_code,
  :duration_in_years,
  :auto_renew,
  :admin_contact,
  :registrant_contact,
  :tech_contact,
  :privacy_protect_admin_contact,
  :privacy_protect_registrant_contact,
  :privacy_protect_tech_contact,
  :billing_contact,
  :privacy_protect_billing_contact)
  SENSITIVE = [:admin_contact, :registrant_contact, :tech_contact, :billing_contact]
  include Aws::Structure
end