1. Packages
  2. Google Cloud Native
  3. API Docs
  4. domains
  5. domains/v1beta1
  6. getRegistration

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.domains/v1beta1.getRegistration

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Gets the details of a Registration resource.

Using getRegistration

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRegistration(args: GetRegistrationArgs, opts?: InvokeOptions): Promise<GetRegistrationResult>
function getRegistrationOutput(args: GetRegistrationOutputArgs, opts?: InvokeOptions): Output<GetRegistrationResult>
Copy
def get_registration(location: Optional[str] = None,
                     project: Optional[str] = None,
                     registration_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRegistrationResult
def get_registration_output(location: Optional[pulumi.Input[str]] = None,
                     project: Optional[pulumi.Input[str]] = None,
                     registration_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetRegistrationResult]
Copy
func LookupRegistration(ctx *Context, args *LookupRegistrationArgs, opts ...InvokeOption) (*LookupRegistrationResult, error)
func LookupRegistrationOutput(ctx *Context, args *LookupRegistrationOutputArgs, opts ...InvokeOption) LookupRegistrationResultOutput
Copy

> Note: This function is named LookupRegistration in the Go SDK.

public static class GetRegistration 
{
    public static Task<GetRegistrationResult> InvokeAsync(GetRegistrationArgs args, InvokeOptions? opts = null)
    public static Output<GetRegistrationResult> Invoke(GetRegistrationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRegistrationResult> getRegistration(GetRegistrationArgs args, InvokeOptions options)
public static Output<GetRegistrationResult> getRegistration(GetRegistrationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:domains/v1beta1:getRegistration
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
RegistrationId This property is required. string
Project string
Location This property is required. string
RegistrationId This property is required. string
Project string
location This property is required. String
registrationId This property is required. String
project String
location This property is required. string
registrationId This property is required. string
project string
location This property is required. str
registration_id This property is required. str
project str
location This property is required. String
registrationId This property is required. String
project String

getRegistration Result

The following output properties are available:

ContactSettings Pulumi.GoogleNative.Domains.V1Beta1.Outputs.ContactSettingsResponse
Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.
CreateTime string
The creation timestamp of the Registration resource.
DnsSettings Pulumi.GoogleNative.Domains.V1Beta1.Outputs.DnsSettingsResponse
Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.
DomainName string
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
ExpireTime string
The expiration timestamp of the Registration.
Issues List<string>
The set of issues with the Registration that require attention.
Labels Dictionary<string, string>
Set of labels associated with the Registration.
ManagementSettings Pulumi.GoogleNative.Domains.V1Beta1.Outputs.ManagementSettingsResponse
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.
Name string
Name of the Registration resource, in the format projects/*/locations/*/registrations/.
PendingContactSettings Pulumi.GoogleNative.Domains.V1Beta1.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
Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

Deprecated: Output only. Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

ContactSettings ContactSettingsResponse
Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.
CreateTime string
The creation timestamp of the Registration resource.
DnsSettings DnsSettingsResponse
Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.
DomainName string
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
ExpireTime string
The expiration timestamp of the Registration.
Issues []string
The set of issues with the Registration that require attention.
Labels map[string]string
Set of labels associated with the Registration.
ManagementSettings ManagementSettingsResponse
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.
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
Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

Deprecated: Output only. Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

contactSettings ContactSettingsResponse
Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.
createTime String
The creation timestamp of the Registration resource.
dnsSettings DnsSettingsResponse
Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.
domainName String
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
expireTime String
The expiration timestamp of the Registration.
issues List<String>
The set of issues with the Registration that require attention.
labels Map<String,String>
Set of labels associated with the Registration.
managementSettings ManagementSettingsResponse
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.
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
Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

Deprecated: Output only. Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

contactSettings ContactSettingsResponse
Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.
createTime string
The creation timestamp of the Registration resource.
dnsSettings DnsSettingsResponse
Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.
domainName string
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
expireTime string
The expiration timestamp of the Registration.
issues string[]
The set of issues with the Registration that require attention.
labels {[key: string]: string}
Set of labels associated with the Registration.
managementSettings ManagementSettingsResponse
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.
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
Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

Deprecated: Output only. Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

contact_settings ContactSettingsResponse
Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.
create_time str
The creation timestamp of the Registration resource.
dns_settings DnsSettingsResponse
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_name str
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
expire_time str
The expiration timestamp of the Registration.
issues Sequence[str]
The set of issues with the Registration that require attention.
labels Mapping[str, str]
Set of labels associated with the Registration.
management_settings ManagementSettingsResponse
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.
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
Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

Deprecated: Output only. Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

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.
createTime String
The creation timestamp of the Registration resource.
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.
domainName String
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
expireTime String
The expiration timestamp of the Registration.
issues List<String>
The set of issues with the Registration that require attention.
labels Map<String>
Set of labels associated with the Registration.
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.
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
Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

Deprecated: Output only. Deprecated: For more information, see Cloud Domains feature deprecation The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

Supporting Types

ContactResponse

Email This property is required. string
Email address of the contact.
FaxNumber This property is required. string
Fax number of the contact in international format. For example, "+1-800-555-0123".
PhoneNumber This property is required. string
Phone number of the contact in international format. For example, "+1-800-555-0123".
PostalAddress This property is required. Pulumi.GoogleNative.Domains.V1Beta1.Inputs.PostalAddressResponse
Postal address of the contact.
Email This property is required. string
Email address of the contact.
FaxNumber This property is required. string
Fax number of the contact in international format. For example, "+1-800-555-0123".
PhoneNumber This property is required. string
Phone number of the contact in international format. For example, "+1-800-555-0123".
PostalAddress This property is required. PostalAddressResponse
Postal address of the contact.
email This property is required. String
Email address of the contact.
faxNumber This property is required. String
Fax number of the contact in international format. For example, "+1-800-555-0123".
phoneNumber This property is required. String
Phone number of the contact in international format. For example, "+1-800-555-0123".
postalAddress This property is required. PostalAddressResponse
Postal address of the contact.
email This property is required. string
Email address of the contact.
faxNumber This property is required. string
Fax number of the contact in international format. For example, "+1-800-555-0123".
phoneNumber This property is required. string
Phone number of the contact in international format. For example, "+1-800-555-0123".
postalAddress This property is required. PostalAddressResponse
Postal address of the contact.
email This property is required. str
Email address of the contact.
fax_number This property is required. str
Fax number of the contact in international format. For example, "+1-800-555-0123".
phone_number This property is required. str
Phone number of the contact in international format. For example, "+1-800-555-0123".
postal_address This property is required. PostalAddressResponse
Postal address of the contact.
email This property is required. String
Email address of the contact.
faxNumber This property is required. String
Fax number of the contact in international format. For example, "+1-800-555-0123".
phoneNumber This property is required. String
Phone number of the contact in international format. For example, "+1-800-555-0123".
postalAddress This property is required. Property Map
Postal address of the contact.

ContactSettingsResponse

AdminContact This property is required. Pulumi.GoogleNative.Domains.V1Beta1.Inputs.ContactResponse
The administrative contact for the Registration.
Privacy This property is required. string
Privacy setting for the contacts associated with the Registration.
RegistrantContact This property is required. Pulumi.GoogleNative.Domains.V1Beta1.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 This property is required. Pulumi.GoogleNative.Domains.V1Beta1.Inputs.ContactResponse
The technical contact for the Registration.
AdminContact This property is required. ContactResponse
The administrative contact for the Registration.
Privacy This property is required. string
Privacy setting for the contacts associated with the Registration.
RegistrantContact This property is required. 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 This property is required. ContactResponse
The technical contact for the Registration.
adminContact This property is required. ContactResponse
The administrative contact for the Registration.
privacy This property is required. String
Privacy setting for the contacts associated with the Registration.
registrantContact This property is required. 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 This property is required. ContactResponse
The technical contact for the Registration.
adminContact This property is required. ContactResponse
The administrative contact for the Registration.
privacy This property is required. string
Privacy setting for the contacts associated with the Registration.
registrantContact This property is required. 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 This property is required. ContactResponse
The technical contact for the Registration.
admin_contact This property is required. ContactResponse
The administrative contact for the Registration.
privacy This property is required. str
Privacy setting for the contacts associated with the Registration.
registrant_contact This property is required. 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 This property is required. ContactResponse
The technical contact for the Registration.
adminContact This property is required. Property Map
The administrative contact for the Registration.
privacy This property is required. String
Privacy setting for the contacts associated with the Registration.
registrantContact This property is required. 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 This property is required. Property Map
The technical contact for the Registration.

CustomDnsResponse

DsRecords This property is required. List<Pulumi.GoogleNative.Domains.V1Beta1.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 This property is required. 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 This property is required. []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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

DnsSettingsResponse

CustomDns This property is required. Pulumi.GoogleNative.Domains.V1Beta1.Inputs.CustomDnsResponse
An arbitrary DNS provider identified by its name servers.
GlueRecords This property is required. List<Pulumi.GoogleNative.Domains.V1Beta1.Inputs.GlueRecordResponse>
The list of glue records for this Registration. Commonly empty.
GoogleDomainsDns This property is required. Pulumi.GoogleNative.Domains.V1Beta1.Inputs.GoogleDomainsDnsResponse
Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

Deprecated: Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

CustomDns This property is required. CustomDnsResponse
An arbitrary DNS provider identified by its name servers.
GlueRecords This property is required. []GlueRecordResponse
The list of glue records for this Registration. Commonly empty.
GoogleDomainsDns This property is required. GoogleDomainsDnsResponse
Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

Deprecated: Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

customDns This property is required. CustomDnsResponse
An arbitrary DNS provider identified by its name servers.
glueRecords This property is required. List<GlueRecordResponse>
The list of glue records for this Registration. Commonly empty.
googleDomainsDns This property is required. GoogleDomainsDnsResponse
Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

Deprecated: Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

customDns This property is required. CustomDnsResponse
An arbitrary DNS provider identified by its name servers.
glueRecords This property is required. GlueRecordResponse[]
The list of glue records for this Registration. Commonly empty.
googleDomainsDns This property is required. GoogleDomainsDnsResponse
Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

Deprecated: Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

custom_dns This property is required. CustomDnsResponse
An arbitrary DNS provider identified by its name servers.
glue_records This property is required. Sequence[GlueRecordResponse]
The list of glue records for this Registration. Commonly empty.
google_domains_dns This property is required. GoogleDomainsDnsResponse
Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

Deprecated: Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

customDns This property is required. Property Map
An arbitrary DNS provider identified by its name servers.
glueRecords This property is required. List<Property Map>
The list of glue records for this Registration. Commonly empty.
googleDomainsDns This property is required. Property Map
Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

Deprecated: Deprecated: For more information, see Cloud Domains feature deprecation The free DNS zone provided by Google Domains.

DsRecordResponse

Algorithm This property is required. string
The algorithm used to generate the referenced DNSKEY.
Digest This property is required. string
The digest generated from the referenced DNSKEY.
DigestType This property is required. string
The hash function used to generate the digest of the referenced DNSKEY.
KeyTag This property is required. int
The key tag of the record. Must be set in range 0 -- 65535.
Algorithm This property is required. string
The algorithm used to generate the referenced DNSKEY.
Digest This property is required. string
The digest generated from the referenced DNSKEY.
DigestType This property is required. string
The hash function used to generate the digest of the referenced DNSKEY.
KeyTag This property is required. int
The key tag of the record. Must be set in range 0 -- 65535.
algorithm This property is required. String
The algorithm used to generate the referenced DNSKEY.
digest This property is required. String
The digest generated from the referenced DNSKEY.
digestType This property is required. String
The hash function used to generate the digest of the referenced DNSKEY.
keyTag This property is required. Integer
The key tag of the record. Must be set in range 0 -- 65535.
algorithm This property is required. string
The algorithm used to generate the referenced DNSKEY.
digest This property is required. string
The digest generated from the referenced DNSKEY.
digestType This property is required. string
The hash function used to generate the digest of the referenced DNSKEY.
keyTag This property is required. number
The key tag of the record. Must be set in range 0 -- 65535.
algorithm This property is required. str
The algorithm used to generate the referenced DNSKEY.
digest This property is required. str
The digest generated from the referenced DNSKEY.
digest_type This property is required. str
The hash function used to generate the digest of the referenced DNSKEY.
key_tag This property is required. int
The key tag of the record. Must be set in range 0 -- 65535.
algorithm This property is required. String
The algorithm used to generate the referenced DNSKEY.
digest This property is required. String
The digest generated from the referenced DNSKEY.
digestType This property is required. String
The hash function used to generate the digest of the referenced DNSKEY.
keyTag This property is required. Number
The key tag of the record. Must be set in range 0 -- 65535.

GlueRecordResponse

HostName This property is required. string
Domain name of the host in Punycode format.
Ipv4Addresses This property is required. 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 This property is required. 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 This property is required. string
Domain name of the host in Punycode format.
Ipv4Addresses This property is required. []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 This property is required. []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 This property is required. String
Domain name of the host in Punycode format.
ipv4Addresses This property is required. 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 This property is required. 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 This property is required. string
Domain name of the host in Punycode format.
ipv4Addresses This property is required. 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 This property is required. 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 This property is required. str
Domain name of the host in Punycode format.
ipv4_addresses This property is required. 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 This property is required. 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 This property is required. String
Domain name of the host in Punycode format.
ipv4Addresses This property is required. 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 This property is required. 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.

GoogleDomainsDnsResponse

DsRecords This property is required. List<Pulumi.GoogleNative.Domains.V1Beta1.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 This property is required. string
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
NameServers This property is required. 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 This property is required. []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 This property is required. string
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
NameServers This property is required. []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 This property is required. 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 This property is required. String
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
nameServers This property is required. 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 This property is required. 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 This property is required. string
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
nameServers This property is required. 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 This property is required. 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 This property is required. str
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
name_servers This property is required. 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 This property is required. 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 This property is required. String
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
nameServers This property is required. 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.

ManagementSettingsResponse

PreferredRenewalMethod This property is required. string
Optional. The desired renewal method for this Registration. The actual renewal_method is automatically updated to reflect this choice. If unset or equal to RENEWAL_METHOD_UNSPECIFIED, it will be treated as if it were set to AUTOMATIC_RENEWAL. Can't be set to RENEWAL_DISABLED during resource creation and can only be updated when the Registration resource has state ACTIVE or SUSPENDED. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be set to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
RenewalMethod This property is required. string
The actual renewal method for this Registration. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be equal to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
TransferLockState This property is required. string
Controls whether the domain can be transferred to another registrar.
PreferredRenewalMethod This property is required. string
Optional. The desired renewal method for this Registration. The actual renewal_method is automatically updated to reflect this choice. If unset or equal to RENEWAL_METHOD_UNSPECIFIED, it will be treated as if it were set to AUTOMATIC_RENEWAL. Can't be set to RENEWAL_DISABLED during resource creation and can only be updated when the Registration resource has state ACTIVE or SUSPENDED. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be set to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
RenewalMethod This property is required. string
The actual renewal method for this Registration. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be equal to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
TransferLockState This property is required. string
Controls whether the domain can be transferred to another registrar.
preferredRenewalMethod This property is required. String
Optional. The desired renewal method for this Registration. The actual renewal_method is automatically updated to reflect this choice. If unset or equal to RENEWAL_METHOD_UNSPECIFIED, it will be treated as if it were set to AUTOMATIC_RENEWAL. Can't be set to RENEWAL_DISABLED during resource creation and can only be updated when the Registration resource has state ACTIVE or SUSPENDED. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be set to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
renewalMethod This property is required. String
The actual renewal method for this Registration. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be equal to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
transferLockState This property is required. String
Controls whether the domain can be transferred to another registrar.
preferredRenewalMethod This property is required. string
Optional. The desired renewal method for this Registration. The actual renewal_method is automatically updated to reflect this choice. If unset or equal to RENEWAL_METHOD_UNSPECIFIED, it will be treated as if it were set to AUTOMATIC_RENEWAL. Can't be set to RENEWAL_DISABLED during resource creation and can only be updated when the Registration resource has state ACTIVE or SUSPENDED. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be set to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
renewalMethod This property is required. string
The actual renewal method for this Registration. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be equal to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
transferLockState This property is required. string
Controls whether the domain can be transferred to another registrar.
preferred_renewal_method This property is required. str
Optional. The desired renewal method for this Registration. The actual renewal_method is automatically updated to reflect this choice. If unset or equal to RENEWAL_METHOD_UNSPECIFIED, it will be treated as if it were set to AUTOMATIC_RENEWAL. Can't be set to RENEWAL_DISABLED during resource creation and can only be updated when the Registration resource has state ACTIVE or SUSPENDED. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be set to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
renewal_method This property is required. str
The actual renewal method for this Registration. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be equal to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
transfer_lock_state This property is required. str
Controls whether the domain can be transferred to another registrar.
preferredRenewalMethod This property is required. String
Optional. The desired renewal method for this Registration. The actual renewal_method is automatically updated to reflect this choice. If unset or equal to RENEWAL_METHOD_UNSPECIFIED, it will be treated as if it were set to AUTOMATIC_RENEWAL. Can't be set to RENEWAL_DISABLED during resource creation and can only be updated when the Registration resource has state ACTIVE or SUSPENDED. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be set to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
renewalMethod This property is required. String
The actual renewal method for this Registration. When preferred_renewal_method is set to AUTOMATIC_RENEWAL the actual renewal_method can be equal to RENEWAL_DISABLED in case of e.g. problems with the Billing Account or reported domain abuse. In such cases check the issues field on the Registration. After the problem is resolved the renewal_method will be automatically updated to preferred_renewal_method in a few hours.
transferLockState This property is required. String
Controls whether the domain can be transferred to another registrar.

PostalAddressResponse

AddressLines This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Optional. The name of the organization at the address.
PostalCode This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
AddressLines This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Optional. The name of the organization at the address.
PostalCode This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
addressLines This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
Optional. The name of the organization at the address.
postalCode This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
addressLines This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Optional. The name of the organization at the address.
postalCode This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
address_lines This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. str
Optional. The name of the organization at the address.
postal_code This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. str
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
addressLines This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
Optional. The name of the organization at the address.
postalCode This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi