Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. domains
  5. domains/v1
  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
pulumi/pulumi-google-native

google-native.domains/v1.getRegistration

Explore with Pulumi AI

google-native logo

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
pulumi/pulumi-google-native

    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>
    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]
    func LookupRegistration(ctx *Context, args *LookupRegistrationArgs, opts ...InvokeOption) (*LookupRegistrationResult, error)
func LookupRegistrationOutput(ctx *Context, args *LookupRegistrationOutputArgs, opts ...InvokeOption) LookupRegistrationResultOutput

    > 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)
}
    public static CompletableFuture<GetRegistrationResult> getRegistration(GetRegistrationArgs args, InvokeOptions options)
public static Output<GetRegistrationResult> getRegistration(GetRegistrationArgs args, InvokeOptions options)

    fn::invoke:
  function: google-native:domains/v1:getRegistration
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Location string
    RegistrationId string
    Project string
    Location string
    RegistrationId string
    Project string
    location String
    registrationId String
    project String
    location string
    registrationId string
    project string
    location String
    registrationId String
    project String

    getRegistration Result

    The following output properties are available:

    ContactSettings Pulumi.GoogleNative.Domains.V1.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.V1.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.V1.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.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
    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 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.

    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.

    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.

    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
    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 CustomDnsResponse
    An arbitrary DNS provider identified by its name servers.
    GlueRecords []GlueRecordResponse
    The list of glue records for this Registration. Commonly empty.
    GoogleDomainsDns 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 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
    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 CustomDnsResponse
    An arbitrary DNS provider identified by its name servers.
    glueRecords GlueRecordResponse[]
    The list of glue records for this Registration. Commonly empty.
    googleDomainsDns 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 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
    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 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
    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 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.

    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.

    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.

    ManagementSettingsResponse

    PreferredRenewalMethod 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 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 string
    Controls whether the domain can be transferred to another registrar.
    PreferredRenewalMethod 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 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 string
    Controls whether the domain can be transferred to another registrar.
    preferredRenewalMethod 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 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 String
    Controls whether the domain can be transferred to another registrar.
    preferredRenewalMethod 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 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 string
    Controls whether the domain can be transferred to another registrar.
    preferred_renewal_method 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 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 str
    Controls whether the domain can be transferred to another registrar.
    preferredRenewalMethod 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 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 String
    Controls whether the domain can be transferred to another registrar.

    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.

    Package Details

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

    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
    pulumi/pulumi-google-native