Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

Registration

Registers a new domain name and creates a corresponding Registration resource. Call RetrieveRegisterParameters first to check availability of the domain name and determine parameters like price that are needed to build a call to this method. A successful call creates a Registration resource in state REGISTRATION_PENDING, which resolves to ACTIVE within 1-2 minutes, indicating that the domain was successfully registered. If the resource ends up in state REGISTRATION_FAILED, it indicates that the domain was not registered successfully, and you can safely delete the resource and retry registration. Auto-naming is currently not supported for this resource.

Create Registration Resource

new Registration(name: string, args: RegistrationArgs, opts?: CustomResourceOptions);
@overload
def Registration(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 contact_notices: Optional[Sequence[RegistrationContactNoticesItem]] = None,
                 contact_settings: Optional[ContactSettingsArgs] = None,
                 dns_settings: Optional[DnsSettingsArgs] = None,
                 domain_name: Optional[str] = None,
                 domain_notices: Optional[Sequence[RegistrationDomainNoticesItem]] = None,
                 labels: Optional[Mapping[str, str]] = None,
                 location: Optional[str] = None,
                 management_settings: Optional[ManagementSettingsArgs] = None,
                 project: Optional[str] = None,
                 validate_only: Optional[bool] = None,
                 yearly_price: Optional[MoneyArgs] = None)
@overload
def Registration(resource_name: str,
                 args: RegistrationArgs,
                 opts: Optional[ResourceOptions] = None)
func NewRegistration(ctx *Context, name string, args RegistrationArgs, opts ...ResourceOption) (*Registration, error)
public Registration(string name, RegistrationArgs args, CustomResourceOptions? opts = null)
public Registration(String name, RegistrationArgs args)
public Registration(String name, RegistrationArgs args, CustomResourceOptions options)
type: google-native:domains/v1:Registration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args RegistrationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args RegistrationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RegistrationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RegistrationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args RegistrationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Registration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Registration resource accepts the following input properties:

ContactSettings Pulumi.GoogleNative.Domains.V1.Inputs.ContactSettingsArgs

Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.

DomainName string

Immutable. The domain name. Unicode domain names must be expressed in Punycode format.

YearlyPrice Pulumi.GoogleNative.Domains.V1.Inputs.MoneyArgs

Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

ContactNotices List<Pulumi.GoogleNative.Domains.V1.RegistrationContactNoticesItem>

The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.

DnsSettings Pulumi.GoogleNative.Domains.V1.Inputs.DnsSettingsArgs

Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.

DomainNotices List<Pulumi.GoogleNative.Domains.V1.RegistrationDomainNoticesItem>

The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.

Labels Dictionary<string, string>

Set of labels associated with the Registration.

Location string
ManagementSettings Pulumi.GoogleNative.Domains.V1.Inputs.ManagementSettingsArgs

Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.

Project string
ValidateOnly bool

When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation

ContactSettings ContactSettingsArgs

Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.

DomainName string

Immutable. The domain name. Unicode domain names must be expressed in Punycode format.

YearlyPrice MoneyArgs

Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

ContactNotices []RegistrationContactNoticesItem

The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.

DnsSettings DnsSettingsArgs

Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.

DomainNotices []RegistrationDomainNoticesItem

The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.

Labels map[string]string

Set of labels associated with the Registration.

Location string
ManagementSettings ManagementSettingsArgs

Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.

Project string
ValidateOnly bool

When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation

contactSettings ContactSettingsArgs

Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.

domainName String

Immutable. The domain name. Unicode domain names must be expressed in Punycode format.

yearlyPrice MoneyArgs

Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

contactNotices List<RegistrationContactNoticesItem>

The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.

dnsSettings DnsSettingsArgs

Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.

domainNotices List<RegistrationDomainNoticesItem>

The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.

labels Map<String,String>

Set of labels associated with the Registration.

location String
managementSettings ManagementSettingsArgs

Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.

project String
validateOnly Boolean

When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation

contactSettings ContactSettingsArgs

Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.

domainName string

Immutable. The domain name. Unicode domain names must be expressed in Punycode format.

yearlyPrice MoneyArgs

Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

contactNotices RegistrationContactNoticesItem[]

The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.

dnsSettings DnsSettingsArgs

Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.

domainNotices RegistrationDomainNoticesItem[]

The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.

labels {[key: string]: string}

Set of labels associated with the Registration.

location string
managementSettings ManagementSettingsArgs

Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.

project string
validateOnly boolean

When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation

contact_settings ContactSettingsArgs

Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.

domain_name str

Immutable. The domain name. Unicode domain names must be expressed in Punycode format.

yearly_price MoneyArgs

Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

contact_notices Sequence[RegistrationContactNoticesItem]

The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.

dns_settings DnsSettingsArgs

Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.

domain_notices Sequence[RegistrationDomainNoticesItem]

The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.

labels Mapping[str, str]

Set of labels associated with the Registration.

location str
management_settings ManagementSettingsArgs

Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.

project str
validate_only bool

When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation

contactSettings Property Map

Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.

domainName String

Immutable. The domain name. Unicode domain names must be expressed in Punycode format.

yearlyPrice Property Map

Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.

contactNotices List<"CONTACT_NOTICE_UNSPECIFIED" | "PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT">

The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.

dnsSettings Property Map

Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.

domainNotices List<"DOMAIN_NOTICE_UNSPECIFIED" | "HSTS_PRELOADED">

The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.

labels Map<String>

Set of labels associated with the Registration.

location String
managementSettings Property Map

Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.

project String
validateOnly Boolean

When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation

Outputs

All input properties are implicitly available as output properties. Additionally, the Registration resource produces the following output properties:

CreateTime string

The creation timestamp of the Registration resource.

ExpireTime string

The expiration timestamp of the Registration.

Id string

The provider-assigned unique ID for this managed resource.

Issues List<string>

The set of issues with the Registration that require attention.

Name string

Name of the Registration resource, in the format projects/*/locations/*/registrations/.

PendingContactSettings Pulumi.GoogleNative.Domains.V1.Outputs.ContactSettingsResponse

Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.

RegisterFailureReason string

The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.

State string

The state of the Registration

SupportedPrivacy List<string>

Set of options for the contact_settings.privacy field that this Registration supports.

TransferFailureReason string

The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

CreateTime string

The creation timestamp of the Registration resource.

ExpireTime string

The expiration timestamp of the Registration.

Id string

The provider-assigned unique ID for this managed resource.

Issues []string

The set of issues with the Registration that require attention.

Name string

Name of the Registration resource, in the format projects/*/locations/*/registrations/.

PendingContactSettings ContactSettingsResponse

Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.

RegisterFailureReason string

The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.

State string

The state of the Registration

SupportedPrivacy []string

Set of options for the contact_settings.privacy field that this Registration supports.

TransferFailureReason string

The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

createTime String

The creation timestamp of the Registration resource.

expireTime String

The expiration timestamp of the Registration.

id String

The provider-assigned unique ID for this managed resource.

issues List<String>

The set of issues with the Registration that require attention.

name String

Name of the Registration resource, in the format projects/*/locations/*/registrations/.

pendingContactSettings ContactSettingsResponse

Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.

registerFailureReason String

The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.

state String

The state of the Registration

supportedPrivacy List<String>

Set of options for the contact_settings.privacy field that this Registration supports.

transferFailureReason String

The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

createTime string

The creation timestamp of the Registration resource.

expireTime string

The expiration timestamp of the Registration.

id string

The provider-assigned unique ID for this managed resource.

issues string[]

The set of issues with the Registration that require attention.

name string

Name of the Registration resource, in the format projects/*/locations/*/registrations/.

pendingContactSettings ContactSettingsResponse

Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.

registerFailureReason string

The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.

state string

The state of the Registration

supportedPrivacy string[]

Set of options for the contact_settings.privacy field that this Registration supports.

transferFailureReason string

The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

create_time str

The creation timestamp of the Registration resource.

expire_time str

The expiration timestamp of the Registration.

id str

The provider-assigned unique ID for this managed resource.

issues Sequence[str]

The set of issues with the Registration that require attention.

name str

Name of the Registration resource, in the format projects/*/locations/*/registrations/.

pending_contact_settings ContactSettingsResponse

Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.

register_failure_reason str

The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.

state str

The state of the Registration

supported_privacy Sequence[str]

Set of options for the contact_settings.privacy field that this Registration supports.

transfer_failure_reason str

The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

createTime String

The creation timestamp of the Registration resource.

expireTime String

The expiration timestamp of the Registration.

id String

The provider-assigned unique ID for this managed resource.

issues List<String>

The set of issues with the Registration that require attention.

name String

Name of the Registration resource, in the format projects/*/locations/*/registrations/.

pendingContactSettings Property Map

Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.

registerFailureReason String

The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.

state String

The state of the Registration

supportedPrivacy List<String>

Set of options for the contact_settings.privacy field that this Registration supports.

transferFailureReason String

The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

Supporting Types

Contact

Email string

Email address of the contact.

PhoneNumber string

Phone number of the contact in international format. For example, "+1-800-555-0123".

PostalAddress Pulumi.GoogleNative.Domains.V1.Inputs.PostalAddress

Postal address of the contact.

FaxNumber string

Fax number of the contact in international format. For example, "+1-800-555-0123".

Email string

Email address of the contact.

PhoneNumber string

Phone number of the contact in international format. For example, "+1-800-555-0123".

PostalAddress PostalAddress

Postal address of the contact.

FaxNumber string

Fax number of the contact in international format. For example, "+1-800-555-0123".

email String

Email address of the contact.

phoneNumber String

Phone number of the contact in international format. For example, "+1-800-555-0123".

postalAddress PostalAddress

Postal address of the contact.

faxNumber String

Fax number of the contact in international format. For example, "+1-800-555-0123".

email string

Email address of the contact.

phoneNumber string

Phone number of the contact in international format. For example, "+1-800-555-0123".

postalAddress PostalAddress

Postal address of the contact.

faxNumber string

Fax number of the contact in international format. For example, "+1-800-555-0123".

email str

Email address of the contact.

phone_number str

Phone number of the contact in international format. For example, "+1-800-555-0123".

postal_address PostalAddress

Postal address of the contact.

fax_number str

Fax number of the contact in international format. For example, "+1-800-555-0123".

email String

Email address of the contact.

phoneNumber String

Phone number of the contact in international format. For example, "+1-800-555-0123".

postalAddress Property Map

Postal address of the contact.

faxNumber String

Fax number of the contact in international format. For example, "+1-800-555-0123".

ContactResponse

Email string

Email address of the contact.

FaxNumber string

Fax number of the contact in international format. For example, "+1-800-555-0123".

PhoneNumber string

Phone number of the contact in international format. For example, "+1-800-555-0123".

PostalAddress Pulumi.GoogleNative.Domains.V1.Inputs.PostalAddressResponse

Postal address of the contact.

Email string

Email address of the contact.

FaxNumber string

Fax number of the contact in international format. For example, "+1-800-555-0123".

PhoneNumber string

Phone number of the contact in international format. For example, "+1-800-555-0123".

PostalAddress PostalAddressResponse

Postal address of the contact.

email String

Email address of the contact.

faxNumber String

Fax number of the contact in international format. For example, "+1-800-555-0123".

phoneNumber String

Phone number of the contact in international format. For example, "+1-800-555-0123".

postalAddress PostalAddressResponse

Postal address of the contact.

email string

Email address of the contact.

faxNumber string

Fax number of the contact in international format. For example, "+1-800-555-0123".

phoneNumber string

Phone number of the contact in international format. For example, "+1-800-555-0123".

postalAddress PostalAddressResponse

Postal address of the contact.

email str

Email address of the contact.

fax_number str

Fax number of the contact in international format. For example, "+1-800-555-0123".

phone_number str

Phone number of the contact in international format. For example, "+1-800-555-0123".

postal_address PostalAddressResponse

Postal address of the contact.

email String

Email address of the contact.

faxNumber String

Fax number of the contact in international format. For example, "+1-800-555-0123".

phoneNumber String

Phone number of the contact in international format. For example, "+1-800-555-0123".

postalAddress Property Map

Postal address of the contact.

ContactSettings

AdminContact Pulumi.GoogleNative.Domains.V1.Inputs.Contact

The administrative contact for the Registration.

Privacy Pulumi.GoogleNative.Domains.V1.ContactSettingsPrivacy

Privacy setting for the contacts associated with the Registration.

RegistrantContact Pulumi.GoogleNative.Domains.V1.Inputs.Contact

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

TechnicalContact Pulumi.GoogleNative.Domains.V1.Inputs.Contact

The technical contact for the Registration.

AdminContact Contact

The administrative contact for the Registration.

Privacy ContactSettingsPrivacy

Privacy setting for the contacts associated with the Registration.

RegistrantContact Contact

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

TechnicalContact Contact

The technical contact for the Registration.

adminContact Contact

The administrative contact for the Registration.

privacy ContactSettingsPrivacy

Privacy setting for the contacts associated with the Registration.

registrantContact Contact

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

technicalContact Contact

The technical contact for the Registration.

adminContact Contact

The administrative contact for the Registration.

privacy ContactSettingsPrivacy

Privacy setting for the contacts associated with the Registration.

registrantContact Contact

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

technicalContact Contact

The technical contact for the Registration.

admin_contact Contact

The administrative contact for the Registration.

privacy ContactSettingsPrivacy

Privacy setting for the contacts associated with the Registration.

registrant_contact Contact

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

technical_contact Contact

The technical contact for the Registration.

adminContact Property Map

The administrative contact for the Registration.

privacy "CONTACT_PRIVACY_UNSPECIFIED" | "PUBLIC_CONTACT_DATA" | "PRIVATE_CONTACT_DATA" | "REDACTED_CONTACT_DATA"

Privacy setting for the contacts associated with the Registration.

registrantContact Property Map

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

technicalContact Property Map

The technical contact for the Registration.

ContactSettingsPrivacy

ContactPrivacyUnspecified
CONTACT_PRIVACY_UNSPECIFIED

The contact privacy settings are undefined.

PublicContactData
PUBLIC_CONTACT_DATA

All the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.

PrivateContactData
PRIVATE_CONTACT_DATA

None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.

RedactedContactData
REDACTED_CONTACT_DATA

Some data from ContactSettings is publicly available. The actual information redacted depends on the domain. For details, see the registration privacy article.

ContactSettingsPrivacyContactPrivacyUnspecified
CONTACT_PRIVACY_UNSPECIFIED

The contact privacy settings are undefined.

ContactSettingsPrivacyPublicContactData
PUBLIC_CONTACT_DATA

All the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.

ContactSettingsPrivacyPrivateContactData
PRIVATE_CONTACT_DATA

None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.

ContactSettingsPrivacyRedactedContactData
REDACTED_CONTACT_DATA

Some data from ContactSettings is publicly available. The actual information redacted depends on the domain. For details, see the registration privacy article.

ContactPrivacyUnspecified
CONTACT_PRIVACY_UNSPECIFIED

The contact privacy settings are undefined.

PublicContactData
PUBLIC_CONTACT_DATA

All the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.

PrivateContactData
PRIVATE_CONTACT_DATA

None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.

RedactedContactData
REDACTED_CONTACT_DATA

Some data from ContactSettings is publicly available. The actual information redacted depends on the domain. For details, see the registration privacy article.

ContactPrivacyUnspecified
CONTACT_PRIVACY_UNSPECIFIED

The contact privacy settings are undefined.

PublicContactData
PUBLIC_CONTACT_DATA

All the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.

PrivateContactData
PRIVATE_CONTACT_DATA

None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.

RedactedContactData
REDACTED_CONTACT_DATA

Some data from ContactSettings is publicly available. The actual information redacted depends on the domain. For details, see the registration privacy article.

CONTACT_PRIVACY_UNSPECIFIED
CONTACT_PRIVACY_UNSPECIFIED

The contact privacy settings are undefined.

PUBLIC_CONTACT_DATA
PUBLIC_CONTACT_DATA

All the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.

PRIVATE_CONTACT_DATA
PRIVATE_CONTACT_DATA

None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.

REDACTED_CONTACT_DATA
REDACTED_CONTACT_DATA

Some data from ContactSettings is publicly available. The actual information redacted depends on the domain. For details, see the registration privacy article.

"CONTACT_PRIVACY_UNSPECIFIED"
CONTACT_PRIVACY_UNSPECIFIED

The contact privacy settings are undefined.

"PUBLIC_CONTACT_DATA"
PUBLIC_CONTACT_DATA

All the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.

"PRIVATE_CONTACT_DATA"
PRIVATE_CONTACT_DATA

None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.

"REDACTED_CONTACT_DATA"
REDACTED_CONTACT_DATA

Some data from ContactSettings is publicly available. The actual information redacted depends on the domain. For details, see the registration privacy article.

ContactSettingsResponse

AdminContact Pulumi.GoogleNative.Domains.V1.Inputs.ContactResponse

The administrative contact for the Registration.

Privacy string

Privacy setting for the contacts associated with the Registration.

RegistrantContact Pulumi.GoogleNative.Domains.V1.Inputs.ContactResponse

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

TechnicalContact Pulumi.GoogleNative.Domains.V1.Inputs.ContactResponse

The technical contact for the Registration.

AdminContact ContactResponse

The administrative contact for the Registration.

Privacy string

Privacy setting for the contacts associated with the Registration.

RegistrantContact ContactResponse

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

TechnicalContact ContactResponse

The technical contact for the Registration.

adminContact ContactResponse

The administrative contact for the Registration.

privacy String

Privacy setting for the contacts associated with the Registration.

registrantContact ContactResponse

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

technicalContact ContactResponse

The technical contact for the Registration.

adminContact ContactResponse

The administrative contact for the Registration.

privacy string

Privacy setting for the contacts associated with the Registration.

registrantContact ContactResponse

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

technicalContact ContactResponse

The technical contact for the Registration.

admin_contact ContactResponse

The administrative contact for the Registration.

privacy str

Privacy setting for the contacts associated with the Registration.

registrant_contact ContactResponse

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

technical_contact ContactResponse

The technical contact for the Registration.

adminContact Property Map

The administrative contact for the Registration.

privacy String

Privacy setting for the contacts associated with the Registration.

registrantContact Property Map

The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.

technicalContact Property Map

The technical contact for the Registration.

CustomDns

NameServers List<string>

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

DsRecords List<Pulumi.GoogleNative.Domains.V1.Inputs.DsRecord>

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

NameServers []string

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

DsRecords []DsRecord

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

nameServers List<String>

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

dsRecords List<DsRecord>

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

nameServers string[]

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

dsRecords DsRecord[]

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

name_servers Sequence[str]

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

ds_records Sequence[DsRecord]

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

nameServers List<String>

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

dsRecords List<Property Map>

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

CustomDnsResponse

DsRecords List<Pulumi.GoogleNative.Domains.V1.Inputs.DsRecordResponse>

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

NameServers List<string>

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

DsRecords []DsRecordResponse

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

NameServers []string

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

dsRecords List<DsRecordResponse>

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

nameServers List<String>

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

dsRecords DsRecordResponse[]

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

nameServers string[]

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

ds_records Sequence[DsRecordResponse]

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

name_servers Sequence[str]

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

dsRecords List<Property Map>

The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

nameServers List<String>

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.

DnsSettings

CustomDns Pulumi.GoogleNative.Domains.V1.Inputs.CustomDns

An arbitrary DNS provider identified by its name servers.

GlueRecords List<Pulumi.GoogleNative.Domains.V1.Inputs.GlueRecord>

The list of glue records for this Registration. Commonly empty.

GoogleDomainsDns Pulumi.GoogleNative.Domains.V1.Inputs.GoogleDomainsDns

The free DNS zone provided by Google Domains.

CustomDns CustomDns

An arbitrary DNS provider identified by its name servers.

GlueRecords []GlueRecord

The list of glue records for this Registration. Commonly empty.

GoogleDomainsDns GoogleDomainsDns

The free DNS zone provided by Google Domains.

customDns CustomDns

An arbitrary DNS provider identified by its name servers.

glueRecords List<GlueRecord>

The list of glue records for this Registration. Commonly empty.

googleDomainsDns GoogleDomainsDns

The free DNS zone provided by Google Domains.

customDns CustomDns

An arbitrary DNS provider identified by its name servers.

glueRecords GlueRecord[]

The list of glue records for this Registration. Commonly empty.

googleDomainsDns GoogleDomainsDns

The free DNS zone provided by Google Domains.

custom_dns CustomDns

An arbitrary DNS provider identified by its name servers.

glue_records Sequence[GlueRecord]

The list of glue records for this Registration. Commonly empty.

google_domains_dns GoogleDomainsDns

The free DNS zone provided by Google Domains.

customDns Property Map

An arbitrary DNS provider identified by its name servers.

glueRecords List<Property Map>

The list of glue records for this Registration. Commonly empty.

googleDomainsDns Property Map

The free DNS zone provided by Google Domains.

DnsSettingsResponse

CustomDns Pulumi.GoogleNative.Domains.V1.Inputs.CustomDnsResponse

An arbitrary DNS provider identified by its name servers.

GlueRecords List<Pulumi.GoogleNative.Domains.V1.Inputs.GlueRecordResponse>

The list of glue records for this Registration. Commonly empty.

GoogleDomainsDns Pulumi.GoogleNative.Domains.V1.Inputs.GoogleDomainsDnsResponse

The free DNS zone provided by Google Domains.

CustomDns CustomDnsResponse

An arbitrary DNS provider identified by its name servers.

GlueRecords []GlueRecordResponse

The list of glue records for this Registration. Commonly empty.

GoogleDomainsDns GoogleDomainsDnsResponse

The free DNS zone provided by Google Domains.

customDns CustomDnsResponse

An arbitrary DNS provider identified by its name servers.

glueRecords List<GlueRecordResponse>

The list of glue records for this Registration. Commonly empty.

googleDomainsDns GoogleDomainsDnsResponse

The free DNS zone provided by Google Domains.

customDns CustomDnsResponse

An arbitrary DNS provider identified by its name servers.

glueRecords GlueRecordResponse[]

The list of glue records for this Registration. Commonly empty.

googleDomainsDns GoogleDomainsDnsResponse

The free DNS zone provided by Google Domains.

custom_dns CustomDnsResponse

An arbitrary DNS provider identified by its name servers.

glue_records Sequence[GlueRecordResponse]

The list of glue records for this Registration. Commonly empty.

google_domains_dns GoogleDomainsDnsResponse

The free DNS zone provided by Google Domains.

customDns Property Map

An arbitrary DNS provider identified by its name servers.

glueRecords List<Property Map>

The list of glue records for this Registration. Commonly empty.

googleDomainsDns Property Map

The free DNS zone provided by Google Domains.

DsRecord

Algorithm Pulumi.GoogleNative.Domains.V1.DsRecordAlgorithm

The algorithm used to generate the referenced DNSKEY.

Digest string

The digest generated from the referenced DNSKEY.

DigestType Pulumi.GoogleNative.Domains.V1.DsRecordDigestType

The hash function used to generate the digest of the referenced DNSKEY.

KeyTag int

The key tag of the record. Must be set in range 0 -- 65535.

Algorithm DsRecordAlgorithm

The algorithm used to generate the referenced DNSKEY.

Digest string

The digest generated from the referenced DNSKEY.

DigestType DsRecordDigestType

The hash function used to generate the digest of the referenced DNSKEY.

KeyTag int

The key tag of the record. Must be set in range 0 -- 65535.

algorithm DsRecordAlgorithm

The algorithm used to generate the referenced DNSKEY.

digest String

The digest generated from the referenced DNSKEY.

digestType DsRecordDigestType

The hash function used to generate the digest of the referenced DNSKEY.

keyTag Integer

The key tag of the record. Must be set in range 0 -- 65535.

algorithm DsRecordAlgorithm

The algorithm used to generate the referenced DNSKEY.

digest string

The digest generated from the referenced DNSKEY.

digestType DsRecordDigestType

The hash function used to generate the digest of the referenced DNSKEY.

keyTag number

The key tag of the record. Must be set in range 0 -- 65535.

algorithm DsRecordAlgorithm

The algorithm used to generate the referenced DNSKEY.

digest str

The digest generated from the referenced DNSKEY.

digest_type DsRecordDigestType

The hash function used to generate the digest of the referenced DNSKEY.

key_tag int

The key tag of the record. Must be set in range 0 -- 65535.

algorithm "ALGORITHM_UNSPECIFIED" | "RSAMD5" | "DH" | "DSA" | "ECC" | "RSASHA1" | "DSANSEC3SHA1" | "RSASHA1NSEC3SHA1" | "RSASHA256" | "RSASHA512" | "ECCGOST" | "ECDSAP256SHA256" | "ECDSAP384SHA384" | "ED25519" | "ED448" | "INDIRECT" | "PRIVATEDNS" | "PRIVATEOID"

The algorithm used to generate the referenced DNSKEY.

digest String

The digest generated from the referenced DNSKEY.

digestType "DIGEST_TYPE_UNSPECIFIED" | "SHA1" | "SHA256" | "GOST3411" | "SHA384"

The hash function used to generate the digest of the referenced DNSKEY.

keyTag Number

The key tag of the record. Must be set in range 0 -- 65535.

DsRecordAlgorithm

AlgorithmUnspecified
ALGORITHM_UNSPECIFIED

The algorithm is unspecified.

Rsamd5
RSAMD5

RSA/MD5. Cannot be used for new deployments.

Dh
DH

Diffie-Hellman. Cannot be used for new deployments.

Dsa
DSA

DSA/SHA1. Not recommended for new deployments.

Ecc
ECC

ECC. Not recommended for new deployments.

Rsasha1
RSASHA1

RSA/SHA-1. Not recommended for new deployments.

Dsansec3sha1
DSANSEC3SHA1

DSA-NSEC3-SHA1. Not recommended for new deployments.

Rsasha1nsec3sha1
RSASHA1NSEC3SHA1

RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.

Rsasha256
RSASHA256

RSA/SHA-256.

Rsasha512
RSASHA512

RSA/SHA-512.

Eccgost
ECCGOST

GOST R 34.10-2001.

Ecdsap256sha256
ECDSAP256SHA256

ECDSA Curve P-256 with SHA-256.

Ecdsap384sha384
ECDSAP384SHA384

ECDSA Curve P-384 with SHA-384.

Ed25519
ED25519

Ed25519.

Ed448
ED448

Ed448.

Indirect
INDIRECT

Reserved for Indirect Keys. Cannot be used for new deployments.

Privatedns
PRIVATEDNS

Private algorithm. Cannot be used for new deployments.

Privateoid
PRIVATEOID

Private algorithm OID. Cannot be used for new deployments.

DsRecordAlgorithmAlgorithmUnspecified
ALGORITHM_UNSPECIFIED

The algorithm is unspecified.

DsRecordAlgorithmRsamd5
RSAMD5

RSA/MD5. Cannot be used for new deployments.

DsRecordAlgorithmDh
DH

Diffie-Hellman. Cannot be used for new deployments.

DsRecordAlgorithmDsa
DSA

DSA/SHA1. Not recommended for new deployments.

DsRecordAlgorithmEcc
ECC

ECC. Not recommended for new deployments.

DsRecordAlgorithmRsasha1
RSASHA1

RSA/SHA-1. Not recommended for new deployments.

DsRecordAlgorithmDsansec3sha1
DSANSEC3SHA1

DSA-NSEC3-SHA1. Not recommended for new deployments.

DsRecordAlgorithmRsasha1nsec3sha1
RSASHA1NSEC3SHA1

RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.

DsRecordAlgorithmRsasha256
RSASHA256

RSA/SHA-256.

DsRecordAlgorithmRsasha512
RSASHA512

RSA/SHA-512.

DsRecordAlgorithmEccgost
ECCGOST

GOST R 34.10-2001.

DsRecordAlgorithmEcdsap256sha256
ECDSAP256SHA256

ECDSA Curve P-256 with SHA-256.

DsRecordAlgorithmEcdsap384sha384
ECDSAP384SHA384

ECDSA Curve P-384 with SHA-384.

DsRecordAlgorithmEd25519
ED25519

Ed25519.

DsRecordAlgorithmEd448
ED448

Ed448.

DsRecordAlgorithmIndirect
INDIRECT

Reserved for Indirect Keys. Cannot be used for new deployments.

DsRecordAlgorithmPrivatedns
PRIVATEDNS

Private algorithm. Cannot be used for new deployments.

DsRecordAlgorithmPrivateoid
PRIVATEOID

Private algorithm OID. Cannot be used for new deployments.

AlgorithmUnspecified
ALGORITHM_UNSPECIFIED

The algorithm is unspecified.

Rsamd5
RSAMD5

RSA/MD5. Cannot be used for new deployments.

Dh
DH

Diffie-Hellman. Cannot be used for new deployments.

Dsa
DSA

DSA/SHA1. Not recommended for new deployments.

Ecc
ECC

ECC. Not recommended for new deployments.

Rsasha1
RSASHA1

RSA/SHA-1. Not recommended for new deployments.

Dsansec3sha1
DSANSEC3SHA1

DSA-NSEC3-SHA1. Not recommended for new deployments.

Rsasha1nsec3sha1
RSASHA1NSEC3SHA1

RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.

Rsasha256
RSASHA256

RSA/SHA-256.

Rsasha512
RSASHA512

RSA/SHA-512.

Eccgost
ECCGOST

GOST R 34.10-2001.

Ecdsap256sha256
ECDSAP256SHA256

ECDSA Curve P-256 with SHA-256.

Ecdsap384sha384
ECDSAP384SHA384

ECDSA Curve P-384 with SHA-384.

Ed25519
ED25519

Ed25519.

Ed448
ED448

Ed448.

Indirect
INDIRECT

Reserved for Indirect Keys. Cannot be used for new deployments.

Privatedns
PRIVATEDNS

Private algorithm. Cannot be used for new deployments.

Privateoid
PRIVATEOID

Private algorithm OID. Cannot be used for new deployments.

AlgorithmUnspecified
ALGORITHM_UNSPECIFIED

The algorithm is unspecified.

Rsamd5
RSAMD5

RSA/MD5. Cannot be used for new deployments.

Dh
DH

Diffie-Hellman. Cannot be used for new deployments.

Dsa
DSA

DSA/SHA1. Not recommended for new deployments.

Ecc
ECC

ECC. Not recommended for new deployments.

Rsasha1
RSASHA1

RSA/SHA-1. Not recommended for new deployments.

Dsansec3sha1
DSANSEC3SHA1

DSA-NSEC3-SHA1. Not recommended for new deployments.

Rsasha1nsec3sha1
RSASHA1NSEC3SHA1

RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.

Rsasha256
RSASHA256

RSA/SHA-256.

Rsasha512
RSASHA512

RSA/SHA-512.

Eccgost
ECCGOST

GOST R 34.10-2001.

Ecdsap256sha256
ECDSAP256SHA256

ECDSA Curve P-256 with SHA-256.

Ecdsap384sha384
ECDSAP384SHA384

ECDSA Curve P-384 with SHA-384.

Ed25519
ED25519

Ed25519.

Ed448
ED448

Ed448.

Indirect
INDIRECT

Reserved for Indirect Keys. Cannot be used for new deployments.

Privatedns
PRIVATEDNS

Private algorithm. Cannot be used for new deployments.

Privateoid
PRIVATEOID

Private algorithm OID. Cannot be used for new deployments.

ALGORITHM_UNSPECIFIED
ALGORITHM_UNSPECIFIED

The algorithm is unspecified.

RSAMD5
RSAMD5

RSA/MD5. Cannot be used for new deployments.

DH
DH

Diffie-Hellman. Cannot be used for new deployments.

DSA
DSA

DSA/SHA1. Not recommended for new deployments.

ECC
ECC

ECC. Not recommended for new deployments.

RSASHA1
RSASHA1

RSA/SHA-1. Not recommended for new deployments.

DSANSEC3SHA1
DSANSEC3SHA1

DSA-NSEC3-SHA1. Not recommended for new deployments.

RSASHA1NSEC3SHA1
RSASHA1NSEC3SHA1

RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.

RSASHA256
RSASHA256

RSA/SHA-256.

RSASHA512
RSASHA512

RSA/SHA-512.

ECCGOST
ECCGOST

GOST R 34.10-2001.

ECDSAP256SHA256
ECDSAP256SHA256

ECDSA Curve P-256 with SHA-256.

ECDSAP384SHA384
ECDSAP384SHA384

ECDSA Curve P-384 with SHA-384.

ED25519
ED25519

Ed25519.

ED448
ED448

Ed448.

INDIRECT
INDIRECT

Reserved for Indirect Keys. Cannot be used for new deployments.

PRIVATEDNS
PRIVATEDNS

Private algorithm. Cannot be used for new deployments.

PRIVATEOID
PRIVATEOID

Private algorithm OID. Cannot be used for new deployments.

"ALGORITHM_UNSPECIFIED"
ALGORITHM_UNSPECIFIED

The algorithm is unspecified.

"RSAMD5"
RSAMD5

RSA/MD5. Cannot be used for new deployments.

"DH"
DH

Diffie-Hellman. Cannot be used for new deployments.

"DSA"
DSA

DSA/SHA1. Not recommended for new deployments.

"ECC"
ECC

ECC. Not recommended for new deployments.

"RSASHA1"
RSASHA1

RSA/SHA-1. Not recommended for new deployments.

"DSANSEC3SHA1"
DSANSEC3SHA1

DSA-NSEC3-SHA1. Not recommended for new deployments.

"RSASHA1NSEC3SHA1"
RSASHA1NSEC3SHA1

RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.

"RSASHA256"
RSASHA256

RSA/SHA-256.

"RSASHA512"
RSASHA512

RSA/SHA-512.

"ECCGOST"
ECCGOST

GOST R 34.10-2001.

"ECDSAP256SHA256"
ECDSAP256SHA256

ECDSA Curve P-256 with SHA-256.

"ECDSAP384SHA384"
ECDSAP384SHA384

ECDSA Curve P-384 with SHA-384.

"ED25519"
ED25519

Ed25519.

"ED448"
ED448

Ed448.

"INDIRECT"
INDIRECT

Reserved for Indirect Keys. Cannot be used for new deployments.

"PRIVATEDNS"
PRIVATEDNS

Private algorithm. Cannot be used for new deployments.

"PRIVATEOID"
PRIVATEOID

Private algorithm OID. Cannot be used for new deployments.

DsRecordDigestType

DigestTypeUnspecified
DIGEST_TYPE_UNSPECIFIED

The DigestType is unspecified.

Sha1
SHA1

SHA-1. Not recommended for new deployments.

Sha256
SHA256

SHA-256.

Gost3411
GOST3411

GOST R 34.11-94.

Sha384
SHA384

SHA-384.

DsRecordDigestTypeDigestTypeUnspecified
DIGEST_TYPE_UNSPECIFIED

The DigestType is unspecified.

DsRecordDigestTypeSha1
SHA1

SHA-1. Not recommended for new deployments.

DsRecordDigestTypeSha256
SHA256

SHA-256.

DsRecordDigestTypeGost3411
GOST3411

GOST R 34.11-94.

DsRecordDigestTypeSha384
SHA384

SHA-384.

DigestTypeUnspecified
DIGEST_TYPE_UNSPECIFIED

The DigestType is unspecified.

Sha1
SHA1

SHA-1. Not recommended for new deployments.

Sha256
SHA256

SHA-256.

Gost3411
GOST3411

GOST R 34.11-94.

Sha384
SHA384

SHA-384.

DigestTypeUnspecified
DIGEST_TYPE_UNSPECIFIED

The DigestType is unspecified.

Sha1
SHA1

SHA-1. Not recommended for new deployments.

Sha256
SHA256

SHA-256.

Gost3411
GOST3411

GOST R 34.11-94.

Sha384
SHA384

SHA-384.

DIGEST_TYPE_UNSPECIFIED
DIGEST_TYPE_UNSPECIFIED

The DigestType is unspecified.

SHA1
SHA1

SHA-1. Not recommended for new deployments.

SHA256
SHA256

SHA-256.

GOST3411
GOST3411

GOST R 34.11-94.

SHA384
SHA384

SHA-384.

"DIGEST_TYPE_UNSPECIFIED"
DIGEST_TYPE_UNSPECIFIED

The DigestType is unspecified.

"SHA1"
SHA1

SHA-1. Not recommended for new deployments.

"SHA256"
SHA256

SHA-256.

"GOST3411"
GOST3411

GOST R 34.11-94.

"SHA384"
SHA384

SHA-384.

DsRecordResponse

Algorithm string

The algorithm used to generate the referenced DNSKEY.

Digest string

The digest generated from the referenced DNSKEY.

DigestType string

The hash function used to generate the digest of the referenced DNSKEY.

KeyTag int

The key tag of the record. Must be set in range 0 -- 65535.

Algorithm string

The algorithm used to generate the referenced DNSKEY.

Digest string

The digest generated from the referenced DNSKEY.

DigestType string

The hash function used to generate the digest of the referenced DNSKEY.

KeyTag int

The key tag of the record. Must be set in range 0 -- 65535.

algorithm String

The algorithm used to generate the referenced DNSKEY.

digest String

The digest generated from the referenced DNSKEY.

digestType String

The hash function used to generate the digest of the referenced DNSKEY.

keyTag Integer

The key tag of the record. Must be set in range 0 -- 65535.

algorithm string

The algorithm used to generate the referenced DNSKEY.

digest string

The digest generated from the referenced DNSKEY.

digestType string

The hash function used to generate the digest of the referenced DNSKEY.

keyTag number

The key tag of the record. Must be set in range 0 -- 65535.

algorithm str

The algorithm used to generate the referenced DNSKEY.

digest str

The digest generated from the referenced DNSKEY.

digest_type str

The hash function used to generate the digest of the referenced DNSKEY.

key_tag int

The key tag of the record. Must be set in range 0 -- 65535.

algorithm String

The algorithm used to generate the referenced DNSKEY.

digest String

The digest generated from the referenced DNSKEY.

digestType String

The hash function used to generate the digest of the referenced DNSKEY.

keyTag Number

The key tag of the record. Must be set in range 0 -- 65535.

GlueRecord

HostName string

Domain name of the host in Punycode format.

Ipv4Addresses List<string>

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

Ipv6Addresses List<string>

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

HostName string

Domain name of the host in Punycode format.

Ipv4Addresses []string

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

Ipv6Addresses []string

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

hostName String

Domain name of the host in Punycode format.

ipv4Addresses List<String>

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

ipv6Addresses List<String>

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

hostName string

Domain name of the host in Punycode format.

ipv4Addresses string[]

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

ipv6Addresses string[]

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

host_name str

Domain name of the host in Punycode format.

ipv4_addresses Sequence[str]

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

ipv6_addresses Sequence[str]

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

hostName String

Domain name of the host in Punycode format.

ipv4Addresses List<String>

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

ipv6Addresses List<String>

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

GlueRecordResponse

HostName string

Domain name of the host in Punycode format.

Ipv4Addresses List<string>

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

Ipv6Addresses List<string>

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

HostName string

Domain name of the host in Punycode format.

Ipv4Addresses []string

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

Ipv6Addresses []string

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

hostName String

Domain name of the host in Punycode format.

ipv4Addresses List<String>

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

ipv6Addresses List<String>

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

hostName string

Domain name of the host in Punycode format.

ipv4Addresses string[]

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

ipv6Addresses string[]

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

host_name str

Domain name of the host in Punycode format.

ipv4_addresses Sequence[str]

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

ipv6_addresses Sequence[str]

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

hostName String

Domain name of the host in Punycode format.

ipv4Addresses List<String>

List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.

ipv6Addresses List<String>

List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

GoogleDomainsDns

DsState Pulumi.GoogleNative.Domains.V1.GoogleDomainsDnsDsState

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

DsState GoogleDomainsDnsDsState

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

dsState GoogleDomainsDnsDsState

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

dsState GoogleDomainsDnsDsState

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

ds_state GoogleDomainsDnsDsState

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

dsState "DS_STATE_UNSPECIFIED" | "DS_RECORDS_UNPUBLISHED" | "DS_RECORDS_PUBLISHED"

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

GoogleDomainsDnsDsState

DsStateUnspecified
DS_STATE_UNSPECIFIED

DS state is unspecified.

DsRecordsUnpublished
DS_RECORDS_UNPUBLISHED

DNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.

DsRecordsPublished
DS_RECORDS_PUBLISHED

DNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.

GoogleDomainsDnsDsStateDsStateUnspecified
DS_STATE_UNSPECIFIED

DS state is unspecified.

GoogleDomainsDnsDsStateDsRecordsUnpublished
DS_RECORDS_UNPUBLISHED

DNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.

GoogleDomainsDnsDsStateDsRecordsPublished
DS_RECORDS_PUBLISHED

DNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.

DsStateUnspecified
DS_STATE_UNSPECIFIED

DS state is unspecified.

DsRecordsUnpublished
DS_RECORDS_UNPUBLISHED

DNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.

DsRecordsPublished
DS_RECORDS_PUBLISHED

DNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.

DsStateUnspecified
DS_STATE_UNSPECIFIED

DS state is unspecified.

DsRecordsUnpublished
DS_RECORDS_UNPUBLISHED

DNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.

DsRecordsPublished
DS_RECORDS_PUBLISHED

DNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.

DS_STATE_UNSPECIFIED
DS_STATE_UNSPECIFIED

DS state is unspecified.

DS_RECORDS_UNPUBLISHED
DS_RECORDS_UNPUBLISHED

DNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.

DS_RECORDS_PUBLISHED
DS_RECORDS_PUBLISHED

DNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.

"DS_STATE_UNSPECIFIED"
DS_STATE_UNSPECIFIED

DS state is unspecified.

"DS_RECORDS_UNPUBLISHED"
DS_RECORDS_UNPUBLISHED

DNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.

"DS_RECORDS_PUBLISHED"
DS_RECORDS_PUBLISHED

DNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.

GoogleDomainsDnsResponse

DsRecords List<Pulumi.GoogleNative.Domains.V1.Inputs.DsRecordResponse>

The list of DS records published for this domain. The list is automatically populated when ds_state is DS_RECORDS_PUBLISHED, otherwise it remains empty.

DsState string

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

NameServers List<string>

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format. This field is automatically populated with the name servers assigned to the Google Domains DNS zone.

DsRecords []DsRecordResponse

The list of DS records published for this domain. The list is automatically populated when ds_state is DS_RECORDS_PUBLISHED, otherwise it remains empty.

DsState string

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

NameServers []string

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format. This field is automatically populated with the name servers assigned to the Google Domains DNS zone.

dsRecords List<DsRecordResponse>

The list of DS records published for this domain. The list is automatically populated when ds_state is DS_RECORDS_PUBLISHED, otherwise it remains empty.

dsState String

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

nameServers List<String>

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format. This field is automatically populated with the name servers assigned to the Google Domains DNS zone.

dsRecords DsRecordResponse[]

The list of DS records published for this domain. The list is automatically populated when ds_state is DS_RECORDS_PUBLISHED, otherwise it remains empty.

dsState string

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

nameServers string[]

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format. This field is automatically populated with the name servers assigned to the Google Domains DNS zone.

ds_records Sequence[DsRecordResponse]

The list of DS records published for this domain. The list is automatically populated when ds_state is DS_RECORDS_PUBLISHED, otherwise it remains empty.

ds_state str

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

name_servers Sequence[str]

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format. This field is automatically populated with the name servers assigned to the Google Domains DNS zone.

dsRecords List<Property Map>

The list of DS records published for this domain. The list is automatically populated when ds_state is DS_RECORDS_PUBLISHED, otherwise it remains empty.

dsState String

The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

nameServers List<String>

A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format. This field is automatically populated with the name servers assigned to the Google Domains DNS zone.

ManagementSettings

TransferLockState Pulumi.GoogleNative.Domains.V1.ManagementSettingsTransferLockState

Controls whether the domain can be transferred to another registrar.

TransferLockState ManagementSettingsTransferLockState

Controls whether the domain can be transferred to another registrar.

transferLockState ManagementSettingsTransferLockState

Controls whether the domain can be transferred to another registrar.

transferLockState ManagementSettingsTransferLockState

Controls whether the domain can be transferred to another registrar.

transfer_lock_state ManagementSettingsTransferLockState

Controls whether the domain can be transferred to another registrar.

transferLockState "TRANSFER_LOCK_STATE_UNSPECIFIED" | "UNLOCKED" | "LOCKED"

Controls whether the domain can be transferred to another registrar.

ManagementSettingsResponse

RenewalMethod string

The renewal method for this Registration.

TransferLockState string

Controls whether the domain can be transferred to another registrar.

RenewalMethod string

The renewal method for this Registration.

TransferLockState string

Controls whether the domain can be transferred to another registrar.

renewalMethod String

The renewal method for this Registration.

transferLockState String

Controls whether the domain can be transferred to another registrar.

renewalMethod string

The renewal method for this Registration.

transferLockState string

Controls whether the domain can be transferred to another registrar.

renewal_method str

The renewal method for this Registration.

transfer_lock_state str

Controls whether the domain can be transferred to another registrar.

renewalMethod String

The renewal method for this Registration.

transferLockState String

Controls whether the domain can be transferred to another registrar.

ManagementSettingsTransferLockState

TransferLockStateUnspecified
TRANSFER_LOCK_STATE_UNSPECIFIED

The state is unspecified.

Unlocked
UNLOCKED

The domain is unlocked and can be transferred to another registrar.

Locked
LOCKED

The domain is locked and cannot be transferred to another registrar.

ManagementSettingsTransferLockStateTransferLockStateUnspecified
TRANSFER_LOCK_STATE_UNSPECIFIED

The state is unspecified.

ManagementSettingsTransferLockStateUnlocked
UNLOCKED

The domain is unlocked and can be transferred to another registrar.

ManagementSettingsTransferLockStateLocked
LOCKED

The domain is locked and cannot be transferred to another registrar.

TransferLockStateUnspecified
TRANSFER_LOCK_STATE_UNSPECIFIED

The state is unspecified.

Unlocked
UNLOCKED

The domain is unlocked and can be transferred to another registrar.

Locked
LOCKED

The domain is locked and cannot be transferred to another registrar.

TransferLockStateUnspecified
TRANSFER_LOCK_STATE_UNSPECIFIED

The state is unspecified.

Unlocked
UNLOCKED

The domain is unlocked and can be transferred to another registrar.

Locked
LOCKED

The domain is locked and cannot be transferred to another registrar.

TRANSFER_LOCK_STATE_UNSPECIFIED
TRANSFER_LOCK_STATE_UNSPECIFIED

The state is unspecified.

UNLOCKED
UNLOCKED

The domain is unlocked and can be transferred to another registrar.

LOCKED
LOCKED

The domain is locked and cannot be transferred to another registrar.

"TRANSFER_LOCK_STATE_UNSPECIFIED"
TRANSFER_LOCK_STATE_UNSPECIFIED

The state is unspecified.

"UNLOCKED"
UNLOCKED

The domain is unlocked and can be transferred to another registrar.

"LOCKED"
LOCKED

The domain is locked and cannot be transferred to another registrar.

Money

CurrencyCode string

The three-letter currency code defined in ISO 4217.

Nanos int

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

Units string

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

CurrencyCode string

The three-letter currency code defined in ISO 4217.

Nanos int

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

Units string

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

currencyCode String

The three-letter currency code defined in ISO 4217.

nanos Integer

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

units String

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

currencyCode string

The three-letter currency code defined in ISO 4217.

nanos number

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

units string

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

currency_code str

The three-letter currency code defined in ISO 4217.

nanos int

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

units str

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

currencyCode String

The three-letter currency code defined in ISO 4217.

nanos Number

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

units String

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

PostalAddress

RegionCode string

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

AddressLines List<string>

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

AdministrativeArea string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

LanguageCode string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

Locality string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

Organization string

Optional. The name of the organization at the address.

PostalCode string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

Recipients List<string>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

Revision int

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

SortingCode string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

Sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

RegionCode string

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

AddressLines []string

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

AdministrativeArea string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

LanguageCode string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

Locality string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

Organization string

Optional. The name of the organization at the address.

PostalCode string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

Recipients []string

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

Revision int

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

SortingCode string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

Sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

regionCode String

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

addressLines List<String>

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrativeArea String

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

languageCode String

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality String

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization String

Optional. The name of the organization at the address.

postalCode String

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients List<String>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

revision Integer

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sortingCode String

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality String

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

regionCode string

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

addressLines string[]

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrativeArea string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

languageCode string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization string

Optional. The name of the organization at the address.

postalCode string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients string[]

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

revision number

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sortingCode string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

region_code str

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

address_lines Sequence[str]

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrative_area str

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

language_code str

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality str

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization str

Optional. The name of the organization at the address.

postal_code str

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients Sequence[str]

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

revision int

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sorting_code str

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality str

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

regionCode String

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

addressLines List<String>

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrativeArea String

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

languageCode String

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality String

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization String

Optional. The name of the organization at the address.

postalCode String

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients List<String>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

revision Number

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sortingCode String

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality String

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

PostalAddressResponse

AddressLines List<string>

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

AdministrativeArea string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

LanguageCode string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

Locality string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

Organization string

Optional. The name of the organization at the address.

PostalCode string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

Recipients List<string>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

RegionCode string

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

Revision int

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

SortingCode string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

Sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

AddressLines []string

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

AdministrativeArea string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

LanguageCode string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

Locality string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

Organization string

Optional. The name of the organization at the address.

PostalCode string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

Recipients []string

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

RegionCode string

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

Revision int

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

SortingCode string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

Sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

addressLines List<String>

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrativeArea String

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

languageCode String

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality String

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization String

Optional. The name of the organization at the address.

postalCode String

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients List<String>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

regionCode String

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

revision Integer

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sortingCode String

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality String

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

addressLines string[]

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrativeArea string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

languageCode string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization string

Optional. The name of the organization at the address.

postalCode string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients string[]

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

regionCode string

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

revision number

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sortingCode string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

address_lines Sequence[str]

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrative_area str

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

language_code str

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality str

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization str

Optional. The name of the organization at the address.

postal_code str

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients Sequence[str]

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

region_code str

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

revision int

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sorting_code str

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality str

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

addressLines List<String>

Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

administrativeArea String

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

languageCode String

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".

locality String

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

organization String

Optional. The name of the organization at the address.

postalCode String

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

recipients List<String>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

regionCode String

CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

revision Number

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.

sortingCode String

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality String

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

RegistrationContactNoticesItem

ContactNoticeUnspecified
CONTACT_NOTICE_UNSPECIFIED

The notice is undefined.

PublicContactDataAcknowledgement
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT

Required when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.

RegistrationContactNoticesItemContactNoticeUnspecified
CONTACT_NOTICE_UNSPECIFIED

The notice is undefined.

RegistrationContactNoticesItemPublicContactDataAcknowledgement
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT

Required when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.

ContactNoticeUnspecified
CONTACT_NOTICE_UNSPECIFIED

The notice is undefined.

PublicContactDataAcknowledgement
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT

Required when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.

ContactNoticeUnspecified
CONTACT_NOTICE_UNSPECIFIED

The notice is undefined.

PublicContactDataAcknowledgement
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT

Required when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.

CONTACT_NOTICE_UNSPECIFIED
CONTACT_NOTICE_UNSPECIFIED

The notice is undefined.

PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT

Required when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.

"CONTACT_NOTICE_UNSPECIFIED"
CONTACT_NOTICE_UNSPECIFIED

The notice is undefined.

"PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT"
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT

Required when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.

RegistrationDomainNoticesItem

DomainNoticeUnspecified
DOMAIN_NOTICE_UNSPECIFIED

The notice is undefined.

HstsPreloaded
HSTS_PRELOADED

Indicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.

RegistrationDomainNoticesItemDomainNoticeUnspecified
DOMAIN_NOTICE_UNSPECIFIED

The notice is undefined.

RegistrationDomainNoticesItemHstsPreloaded
HSTS_PRELOADED

Indicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.

DomainNoticeUnspecified
DOMAIN_NOTICE_UNSPECIFIED

The notice is undefined.

HstsPreloaded
HSTS_PRELOADED

Indicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.

DomainNoticeUnspecified
DOMAIN_NOTICE_UNSPECIFIED

The notice is undefined.

HstsPreloaded
HSTS_PRELOADED

Indicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.

DOMAIN_NOTICE_UNSPECIFIED
DOMAIN_NOTICE_UNSPECIFIED

The notice is undefined.

HSTS_PRELOADED
HSTS_PRELOADED

Indicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.

"DOMAIN_NOTICE_UNSPECIFIED"
DOMAIN_NOTICE_UNSPECIFIED

The notice is undefined.

"HSTS_PRELOADED"
HSTS_PRELOADED

Indicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0