1. Packages
  2. Google Cloud Native
  3. API Docs
  4. domains
  5. domains/v1
  6. Registration

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/v1.Registration

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

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

Create Registration Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Registration(name: string, args: RegistrationArgs, opts?: CustomResourceOptions);
@overload
def Registration(resource_name: str,
                 args: RegistrationArgs,
                 opts: Optional[ResourceOptions] = None)

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

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var registrationResource = new GoogleNative.Domains.V1.Registration("registrationResource", new()
{
    ContactSettings = new GoogleNative.Domains.V1.Inputs.ContactSettingsArgs
    {
        AdminContact = new GoogleNative.Domains.V1.Inputs.ContactArgs
        {
            Email = "string",
            PhoneNumber = "string",
            PostalAddress = new GoogleNative.Domains.V1.Inputs.PostalAddressArgs
            {
                RegionCode = "string",
                AddressLines = new[]
                {
                    "string",
                },
                AdministrativeArea = "string",
                LanguageCode = "string",
                Locality = "string",
                Organization = "string",
                PostalCode = "string",
                Recipients = new[]
                {
                    "string",
                },
                Revision = 0,
                SortingCode = "string",
                Sublocality = "string",
            },
            FaxNumber = "string",
        },
        Privacy = GoogleNative.Domains.V1.ContactSettingsPrivacy.ContactPrivacyUnspecified,
        RegistrantContact = new GoogleNative.Domains.V1.Inputs.ContactArgs
        {
            Email = "string",
            PhoneNumber = "string",
            PostalAddress = new GoogleNative.Domains.V1.Inputs.PostalAddressArgs
            {
                RegionCode = "string",
                AddressLines = new[]
                {
                    "string",
                },
                AdministrativeArea = "string",
                LanguageCode = "string",
                Locality = "string",
                Organization = "string",
                PostalCode = "string",
                Recipients = new[]
                {
                    "string",
                },
                Revision = 0,
                SortingCode = "string",
                Sublocality = "string",
            },
            FaxNumber = "string",
        },
        TechnicalContact = new GoogleNative.Domains.V1.Inputs.ContactArgs
        {
            Email = "string",
            PhoneNumber = "string",
            PostalAddress = new GoogleNative.Domains.V1.Inputs.PostalAddressArgs
            {
                RegionCode = "string",
                AddressLines = new[]
                {
                    "string",
                },
                AdministrativeArea = "string",
                LanguageCode = "string",
                Locality = "string",
                Organization = "string",
                PostalCode = "string",
                Recipients = new[]
                {
                    "string",
                },
                Revision = 0,
                SortingCode = "string",
                Sublocality = "string",
            },
            FaxNumber = "string",
        },
    },
    DomainName = "string",
    YearlyPrice = new GoogleNative.Domains.V1.Inputs.MoneyArgs
    {
        CurrencyCode = "string",
        Nanos = 0,
        Units = "string",
    },
    ContactNotices = new[]
    {
        GoogleNative.Domains.V1.RegistrationContactNoticesItem.ContactNoticeUnspecified,
    },
    DnsSettings = new GoogleNative.Domains.V1.Inputs.DnsSettingsArgs
    {
        CustomDns = new GoogleNative.Domains.V1.Inputs.CustomDnsArgs
        {
            NameServers = new[]
            {
                "string",
            },
            DsRecords = new[]
            {
                new GoogleNative.Domains.V1.Inputs.DsRecordArgs
                {
                    Algorithm = GoogleNative.Domains.V1.DsRecordAlgorithm.AlgorithmUnspecified,
                    Digest = "string",
                    DigestType = GoogleNative.Domains.V1.DsRecordDigestType.DigestTypeUnspecified,
                    KeyTag = 0,
                },
            },
        },
        GlueRecords = new[]
        {
            new GoogleNative.Domains.V1.Inputs.GlueRecordArgs
            {
                HostName = "string",
                Ipv4Addresses = new[]
                {
                    "string",
                },
                Ipv6Addresses = new[]
                {
                    "string",
                },
            },
        },
    },
    DomainNotices = new[]
    {
        GoogleNative.Domains.V1.RegistrationDomainNoticesItem.DomainNoticeUnspecified,
    },
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    ManagementSettings = new GoogleNative.Domains.V1.Inputs.ManagementSettingsArgs
    {
        PreferredRenewalMethod = GoogleNative.Domains.V1.ManagementSettingsPreferredRenewalMethod.RenewalMethodUnspecified,
        TransferLockState = GoogleNative.Domains.V1.ManagementSettingsTransferLockState.TransferLockStateUnspecified,
    },
    Project = "string",
    ValidateOnly = false,
});
Copy
example, err := domains.NewRegistration(ctx, "registrationResource", &domains.RegistrationArgs{
	ContactSettings: &domains.ContactSettingsArgs{
		AdminContact: &domains.ContactArgs{
			Email:       pulumi.String("string"),
			PhoneNumber: pulumi.String("string"),
			PostalAddress: &domains.PostalAddressArgs{
				RegionCode: pulumi.String("string"),
				AddressLines: pulumi.StringArray{
					pulumi.String("string"),
				},
				AdministrativeArea: pulumi.String("string"),
				LanguageCode:       pulumi.String("string"),
				Locality:           pulumi.String("string"),
				Organization:       pulumi.String("string"),
				PostalCode:         pulumi.String("string"),
				Recipients: pulumi.StringArray{
					pulumi.String("string"),
				},
				Revision:    pulumi.Int(0),
				SortingCode: pulumi.String("string"),
				Sublocality: pulumi.String("string"),
			},
			FaxNumber: pulumi.String("string"),
		},
		Privacy: domains.ContactSettingsPrivacyContactPrivacyUnspecified,
		RegistrantContact: &domains.ContactArgs{
			Email:       pulumi.String("string"),
			PhoneNumber: pulumi.String("string"),
			PostalAddress: &domains.PostalAddressArgs{
				RegionCode: pulumi.String("string"),
				AddressLines: pulumi.StringArray{
					pulumi.String("string"),
				},
				AdministrativeArea: pulumi.String("string"),
				LanguageCode:       pulumi.String("string"),
				Locality:           pulumi.String("string"),
				Organization:       pulumi.String("string"),
				PostalCode:         pulumi.String("string"),
				Recipients: pulumi.StringArray{
					pulumi.String("string"),
				},
				Revision:    pulumi.Int(0),
				SortingCode: pulumi.String("string"),
				Sublocality: pulumi.String("string"),
			},
			FaxNumber: pulumi.String("string"),
		},
		TechnicalContact: &domains.ContactArgs{
			Email:       pulumi.String("string"),
			PhoneNumber: pulumi.String("string"),
			PostalAddress: &domains.PostalAddressArgs{
				RegionCode: pulumi.String("string"),
				AddressLines: pulumi.StringArray{
					pulumi.String("string"),
				},
				AdministrativeArea: pulumi.String("string"),
				LanguageCode:       pulumi.String("string"),
				Locality:           pulumi.String("string"),
				Organization:       pulumi.String("string"),
				PostalCode:         pulumi.String("string"),
				Recipients: pulumi.StringArray{
					pulumi.String("string"),
				},
				Revision:    pulumi.Int(0),
				SortingCode: pulumi.String("string"),
				Sublocality: pulumi.String("string"),
			},
			FaxNumber: pulumi.String("string"),
		},
	},
	DomainName: pulumi.String("string"),
	YearlyPrice: &domains.MoneyArgs{
		CurrencyCode: pulumi.String("string"),
		Nanos:        pulumi.Int(0),
		Units:        pulumi.String("string"),
	},
	ContactNotices: domains.RegistrationContactNoticesItemArray{
		domains.RegistrationContactNoticesItemContactNoticeUnspecified,
	},
	DnsSettings: &domains.DnsSettingsArgs{
		CustomDns: &domains.CustomDnsArgs{
			NameServers: pulumi.StringArray{
				pulumi.String("string"),
			},
			DsRecords: domains.DsRecordArray{
				&domains.DsRecordArgs{
					Algorithm:  domains.DsRecordAlgorithmAlgorithmUnspecified,
					Digest:     pulumi.String("string"),
					DigestType: domains.DsRecordDigestTypeDigestTypeUnspecified,
					KeyTag:     pulumi.Int(0),
				},
			},
		},
		GlueRecords: domains.GlueRecordArray{
			&domains.GlueRecordArgs{
				HostName: pulumi.String("string"),
				Ipv4Addresses: pulumi.StringArray{
					pulumi.String("string"),
				},
				Ipv6Addresses: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
	},
	DomainNotices: domains.RegistrationDomainNoticesItemArray{
		domains.RegistrationDomainNoticesItemDomainNoticeUnspecified,
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	ManagementSettings: &domains.ManagementSettingsArgs{
		PreferredRenewalMethod: domains.ManagementSettingsPreferredRenewalMethodRenewalMethodUnspecified,
		TransferLockState:      domains.ManagementSettingsTransferLockStateTransferLockStateUnspecified,
	},
	Project:      pulumi.String("string"),
	ValidateOnly: pulumi.Bool(false),
})
Copy
var registrationResource = new com.pulumi.googlenative.domains_v1.Registration("registrationResource", com.pulumi.googlenative.domains_v1.RegistrationArgs.builder()
    .contactSettings(ContactSettingsArgs.builder()
        .adminContact(ContactArgs.builder()
            .email("string")
            .phoneNumber("string")
            .postalAddress(PostalAddressArgs.builder()
                .regionCode("string")
                .addressLines("string")
                .administrativeArea("string")
                .languageCode("string")
                .locality("string")
                .organization("string")
                .postalCode("string")
                .recipients("string")
                .revision(0)
                .sortingCode("string")
                .sublocality("string")
                .build())
            .faxNumber("string")
            .build())
        .privacy("CONTACT_PRIVACY_UNSPECIFIED")
        .registrantContact(ContactArgs.builder()
            .email("string")
            .phoneNumber("string")
            .postalAddress(PostalAddressArgs.builder()
                .regionCode("string")
                .addressLines("string")
                .administrativeArea("string")
                .languageCode("string")
                .locality("string")
                .organization("string")
                .postalCode("string")
                .recipients("string")
                .revision(0)
                .sortingCode("string")
                .sublocality("string")
                .build())
            .faxNumber("string")
            .build())
        .technicalContact(ContactArgs.builder()
            .email("string")
            .phoneNumber("string")
            .postalAddress(PostalAddressArgs.builder()
                .regionCode("string")
                .addressLines("string")
                .administrativeArea("string")
                .languageCode("string")
                .locality("string")
                .organization("string")
                .postalCode("string")
                .recipients("string")
                .revision(0)
                .sortingCode("string")
                .sublocality("string")
                .build())
            .faxNumber("string")
            .build())
        .build())
    .domainName("string")
    .yearlyPrice(MoneyArgs.builder()
        .currencyCode("string")
        .nanos(0)
        .units("string")
        .build())
    .contactNotices("CONTACT_NOTICE_UNSPECIFIED")
    .dnsSettings(DnsSettingsArgs.builder()
        .customDns(CustomDnsArgs.builder()
            .nameServers("string")
            .dsRecords(DsRecordArgs.builder()
                .algorithm("ALGORITHM_UNSPECIFIED")
                .digest("string")
                .digestType("DIGEST_TYPE_UNSPECIFIED")
                .keyTag(0)
                .build())
            .build())
        .glueRecords(GlueRecordArgs.builder()
            .hostName("string")
            .ipv4Addresses("string")
            .ipv6Addresses("string")
            .build())
        .build())
    .domainNotices("DOMAIN_NOTICE_UNSPECIFIED")
    .labels(Map.of("string", "string"))
    .location("string")
    .managementSettings(ManagementSettingsArgs.builder()
        .preferredRenewalMethod("RENEWAL_METHOD_UNSPECIFIED")
        .transferLockState("TRANSFER_LOCK_STATE_UNSPECIFIED")
        .build())
    .project("string")
    .validateOnly(false)
    .build());
Copy
registration_resource = google_native.domains.v1.Registration("registrationResource",
    contact_settings={
        "admin_contact": {
            "email": "string",
            "phone_number": "string",
            "postal_address": {
                "region_code": "string",
                "address_lines": ["string"],
                "administrative_area": "string",
                "language_code": "string",
                "locality": "string",
                "organization": "string",
                "postal_code": "string",
                "recipients": ["string"],
                "revision": 0,
                "sorting_code": "string",
                "sublocality": "string",
            },
            "fax_number": "string",
        },
        "privacy": google_native.domains.v1.ContactSettingsPrivacy.CONTACT_PRIVACY_UNSPECIFIED,
        "registrant_contact": {
            "email": "string",
            "phone_number": "string",
            "postal_address": {
                "region_code": "string",
                "address_lines": ["string"],
                "administrative_area": "string",
                "language_code": "string",
                "locality": "string",
                "organization": "string",
                "postal_code": "string",
                "recipients": ["string"],
                "revision": 0,
                "sorting_code": "string",
                "sublocality": "string",
            },
            "fax_number": "string",
        },
        "technical_contact": {
            "email": "string",
            "phone_number": "string",
            "postal_address": {
                "region_code": "string",
                "address_lines": ["string"],
                "administrative_area": "string",
                "language_code": "string",
                "locality": "string",
                "organization": "string",
                "postal_code": "string",
                "recipients": ["string"],
                "revision": 0,
                "sorting_code": "string",
                "sublocality": "string",
            },
            "fax_number": "string",
        },
    },
    domain_name="string",
    yearly_price={
        "currency_code": "string",
        "nanos": 0,
        "units": "string",
    },
    contact_notices=[google_native.domains.v1.RegistrationContactNoticesItem.CONTACT_NOTICE_UNSPECIFIED],
    dns_settings={
        "custom_dns": {
            "name_servers": ["string"],
            "ds_records": [{
                "algorithm": google_native.domains.v1.DsRecordAlgorithm.ALGORITHM_UNSPECIFIED,
                "digest": "string",
                "digest_type": google_native.domains.v1.DsRecordDigestType.DIGEST_TYPE_UNSPECIFIED,
                "key_tag": 0,
            }],
        },
        "glue_records": [{
            "host_name": "string",
            "ipv4_addresses": ["string"],
            "ipv6_addresses": ["string"],
        }],
    },
    domain_notices=[google_native.domains.v1.RegistrationDomainNoticesItem.DOMAIN_NOTICE_UNSPECIFIED],
    labels={
        "string": "string",
    },
    location="string",
    management_settings={
        "preferred_renewal_method": google_native.domains.v1.ManagementSettingsPreferredRenewalMethod.RENEWAL_METHOD_UNSPECIFIED,
        "transfer_lock_state": google_native.domains.v1.ManagementSettingsTransferLockState.TRANSFER_LOCK_STATE_UNSPECIFIED,
    },
    project="string",
    validate_only=False)
Copy
const registrationResource = new google_native.domains.v1.Registration("registrationResource", {
    contactSettings: {
        adminContact: {
            email: "string",
            phoneNumber: "string",
            postalAddress: {
                regionCode: "string",
                addressLines: ["string"],
                administrativeArea: "string",
                languageCode: "string",
                locality: "string",
                organization: "string",
                postalCode: "string",
                recipients: ["string"],
                revision: 0,
                sortingCode: "string",
                sublocality: "string",
            },
            faxNumber: "string",
        },
        privacy: google_native.domains.v1.ContactSettingsPrivacy.ContactPrivacyUnspecified,
        registrantContact: {
            email: "string",
            phoneNumber: "string",
            postalAddress: {
                regionCode: "string",
                addressLines: ["string"],
                administrativeArea: "string",
                languageCode: "string",
                locality: "string",
                organization: "string",
                postalCode: "string",
                recipients: ["string"],
                revision: 0,
                sortingCode: "string",
                sublocality: "string",
            },
            faxNumber: "string",
        },
        technicalContact: {
            email: "string",
            phoneNumber: "string",
            postalAddress: {
                regionCode: "string",
                addressLines: ["string"],
                administrativeArea: "string",
                languageCode: "string",
                locality: "string",
                organization: "string",
                postalCode: "string",
                recipients: ["string"],
                revision: 0,
                sortingCode: "string",
                sublocality: "string",
            },
            faxNumber: "string",
        },
    },
    domainName: "string",
    yearlyPrice: {
        currencyCode: "string",
        nanos: 0,
        units: "string",
    },
    contactNotices: [google_native.domains.v1.RegistrationContactNoticesItem.ContactNoticeUnspecified],
    dnsSettings: {
        customDns: {
            nameServers: ["string"],
            dsRecords: [{
                algorithm: google_native.domains.v1.DsRecordAlgorithm.AlgorithmUnspecified,
                digest: "string",
                digestType: google_native.domains.v1.DsRecordDigestType.DigestTypeUnspecified,
                keyTag: 0,
            }],
        },
        glueRecords: [{
            hostName: "string",
            ipv4Addresses: ["string"],
            ipv6Addresses: ["string"],
        }],
    },
    domainNotices: [google_native.domains.v1.RegistrationDomainNoticesItem.DomainNoticeUnspecified],
    labels: {
        string: "string",
    },
    location: "string",
    managementSettings: {
        preferredRenewalMethod: google_native.domains.v1.ManagementSettingsPreferredRenewalMethod.RenewalMethodUnspecified,
        transferLockState: google_native.domains.v1.ManagementSettingsTransferLockState.TransferLockStateUnspecified,
    },
    project: "string",
    validateOnly: false,
});
Copy
type: google-native:domains/v1:Registration
properties:
    contactNotices:
        - CONTACT_NOTICE_UNSPECIFIED
    contactSettings:
        adminContact:
            email: string
            faxNumber: string
            phoneNumber: string
            postalAddress:
                addressLines:
                    - string
                administrativeArea: string
                languageCode: string
                locality: string
                organization: string
                postalCode: string
                recipients:
                    - string
                regionCode: string
                revision: 0
                sortingCode: string
                sublocality: string
        privacy: CONTACT_PRIVACY_UNSPECIFIED
        registrantContact:
            email: string
            faxNumber: string
            phoneNumber: string
            postalAddress:
                addressLines:
                    - string
                administrativeArea: string
                languageCode: string
                locality: string
                organization: string
                postalCode: string
                recipients:
                    - string
                regionCode: string
                revision: 0
                sortingCode: string
                sublocality: string
        technicalContact:
            email: string
            faxNumber: string
            phoneNumber: string
            postalAddress:
                addressLines:
                    - string
                administrativeArea: string
                languageCode: string
                locality: string
                organization: string
                postalCode: string
                recipients:
                    - string
                regionCode: string
                revision: 0
                sortingCode: string
                sublocality: string
    dnsSettings:
        customDns:
            dsRecords:
                - algorithm: ALGORITHM_UNSPECIFIED
                  digest: string
                  digestType: DIGEST_TYPE_UNSPECIFIED
                  keyTag: 0
            nameServers:
                - string
        glueRecords:
            - hostName: string
              ipv4Addresses:
                - string
              ipv6Addresses:
                - string
    domainName: string
    domainNotices:
        - DOMAIN_NOTICE_UNSPECIFIED
    labels:
        string: string
    location: string
    managementSettings:
        preferredRenewalMethod: RENEWAL_METHOD_UNSPECIFIED
        transferLockState: TRANSFER_LOCK_STATE_UNSPECIFIED
    project: string
    validateOnly: false
    yearlyPrice:
        currencyCode: string
        nanos: 0
        units: string
Copy

Registration Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Registration resource accepts the following input properties:

ContactSettings This property is required. Pulumi.GoogleNative.Domains.V1.Inputs.ContactSettings
Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.
DomainName This property is required. string
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
YearlyPrice This property is required. Pulumi.GoogleNative.Domains.V1.Inputs.Money
Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.
ContactNotices List<Pulumi.GoogleNative.Domains.V1.RegistrationContactNoticesItem>
The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.
DnsSettings Pulumi.GoogleNative.Domains.V1.Inputs.DnsSettings
Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.
DomainNotices List<Pulumi.GoogleNative.Domains.V1.RegistrationDomainNoticesItem>
The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.
Labels Dictionary<string, string>
Set of labels associated with the Registration.
Location Changes to this property will trigger replacement. string
ManagementSettings Pulumi.GoogleNative.Domains.V1.Inputs.ManagementSettings
Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.
Project Changes to this property will trigger replacement. string
ValidateOnly bool
When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation
ContactSettings This property is required. ContactSettingsArgs
Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.
DomainName This property is required. string
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
YearlyPrice This property is required. MoneyArgs
Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.
ContactNotices []RegistrationContactNoticesItem
The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.
DnsSettings DnsSettingsArgs
Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.
DomainNotices []RegistrationDomainNoticesItem
The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.
Labels map[string]string
Set of labels associated with the Registration.
Location Changes to this property will trigger replacement. string
ManagementSettings ManagementSettingsArgs
Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.
Project Changes to this property will trigger replacement. string
ValidateOnly bool
When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation
contactSettings This property is required. ContactSettings
Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.
domainName This property is required. String
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
yearlyPrice This property is required. Money
Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.
contactNotices List<RegistrationContactNoticesItem>
The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.
dnsSettings DnsSettings
Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.
domainNotices List<RegistrationDomainNoticesItem>
The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.
labels Map<String,String>
Set of labels associated with the Registration.
location Changes to this property will trigger replacement. String
managementSettings ManagementSettings
Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.
project Changes to this property will trigger replacement. String
validateOnly Boolean
When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation
contactSettings This property is required. ContactSettings
Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.
domainName This property is required. string
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
yearlyPrice This property is required. Money
Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.
contactNotices RegistrationContactNoticesItem[]
The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.
dnsSettings DnsSettings
Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.
domainNotices RegistrationDomainNoticesItem[]
The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.
labels {[key: string]: string}
Set of labels associated with the Registration.
location Changes to this property will trigger replacement. string
managementSettings ManagementSettings
Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.
project Changes to this property will trigger replacement. string
validateOnly boolean
When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation
contact_settings This property is required. ContactSettingsArgs
Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.
domain_name This property is required. str
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
yearly_price This property is required. MoneyArgs
Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.
contact_notices Sequence[RegistrationContactNoticesItem]
The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.
dns_settings DnsSettingsArgs
Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.
domain_notices Sequence[RegistrationDomainNoticesItem]
The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.
labels Mapping[str, str]
Set of labels associated with the Registration.
location Changes to this property will trigger replacement. str
management_settings ManagementSettingsArgs
Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.
project Changes to this property will trigger replacement. str
validate_only bool
When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation
contactSettings This property is required. Property Map
Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method.
domainName This property is required. String
Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
yearlyPrice This property is required. Property Map
Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls.
contactNotices List<"CONTACT_NOTICE_UNSPECIFIED" | "PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT">
The list of contact notices that the caller acknowledges. The notices needed here depend on the values specified in registration.contact_settings.
dnsSettings Property Map
Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method.
domainNotices List<"DOMAIN_NOTICE_UNSPECIFIED" | "HSTS_PRELOADED">
The list of domain notices that you acknowledge. Call RetrieveRegisterParameters to see the notices that need acknowledgement.
labels Map<String>
Set of labels associated with the Registration.
location Changes to this property will trigger replacement. String
managementSettings Property Map
Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method.
project Changes to this property will trigger replacement. String
validateOnly Boolean
When true, only validation is performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation

Outputs

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

CreateTime string
The creation timestamp of the Registration resource.
ExpireTime string
The expiration timestamp of the Registration.
Id string
The provider-assigned unique ID for this managed resource.
Issues List<string>
The set of issues with the Registration that require attention.
Name string
Name of the Registration resource, in the format projects/*/locations/*/registrations/.
PendingContactSettings Pulumi.GoogleNative.Domains.V1.Outputs.ContactSettingsResponse
Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.
RegisterFailureReason string
The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.
State string
The state of the Registration
SupportedPrivacy List<string>
Set of options for the contact_settings.privacy field that this Registration supports.
TransferFailureReason string
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.

CreateTime string
The creation timestamp of the Registration resource.
ExpireTime string
The expiration timestamp of the Registration.
Id string
The provider-assigned unique ID for this managed resource.
Issues []string
The set of issues with the Registration that require attention.
Name string
Name of the Registration resource, in the format projects/*/locations/*/registrations/.
PendingContactSettings ContactSettingsResponse
Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.
RegisterFailureReason string
The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.
State string
The state of the Registration
SupportedPrivacy []string
Set of options for the contact_settings.privacy field that this Registration supports.
TransferFailureReason string
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.

createTime String
The creation timestamp of the Registration resource.
expireTime String
The expiration timestamp of the Registration.
id String
The provider-assigned unique ID for this managed resource.
issues List<String>
The set of issues with the Registration that require attention.
name String
Name of the Registration resource, in the format projects/*/locations/*/registrations/.
pendingContactSettings ContactSettingsResponse
Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.
registerFailureReason String
The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.
state String
The state of the Registration
supportedPrivacy List<String>
Set of options for the contact_settings.privacy field that this Registration supports.
transferFailureReason String
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.

createTime string
The creation timestamp of the Registration resource.
expireTime string
The expiration timestamp of the Registration.
id string
The provider-assigned unique ID for this managed resource.
issues string[]
The set of issues with the Registration that require attention.
name string
Name of the Registration resource, in the format projects/*/locations/*/registrations/.
pendingContactSettings ContactSettingsResponse
Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.
registerFailureReason string
The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.
state string
The state of the Registration
supportedPrivacy string[]
Set of options for the contact_settings.privacy field that this Registration supports.
transferFailureReason string
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.

create_time str
The creation timestamp of the Registration resource.
expire_time str
The expiration timestamp of the Registration.
id str
The provider-assigned unique ID for this managed resource.
issues Sequence[str]
The set of issues with the Registration that require attention.
name str
Name of the Registration resource, in the format projects/*/locations/*/registrations/.
pending_contact_settings ContactSettingsResponse
Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.
register_failure_reason str
The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.
state str
The state of the Registration
supported_privacy Sequence[str]
Set of options for the contact_settings.privacy field that this Registration supports.
transfer_failure_reason str
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.

createTime String
The creation timestamp of the Registration resource.
expireTime String
The expiration timestamp of the Registration.
id String
The provider-assigned unique ID for this managed resource.
issues List<String>
The set of issues with the Registration that require attention.
name String
Name of the Registration resource, in the format projects/*/locations/*/registrations/.
pendingContactSettings Property Map
Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive.
registerFailureReason String
The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.
state String
The state of the Registration
supportedPrivacy List<String>
Set of options for the contact_settings.privacy field that this Registration supports.
transferFailureReason String
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

Contact
, ContactArgs

Email This property is required. string
Email address of the contact.
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.V1.Inputs.PostalAddress
Postal address of the contact.
FaxNumber string
Fax number of the contact in international format. For example, "+1-800-555-0123".
Email This property is required. string
Email address of the contact.
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. PostalAddress
Postal address of the contact.
FaxNumber string
Fax number of the contact in international format. For example, "+1-800-555-0123".
email This property is required. String
Email address of the contact.
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. PostalAddress
Postal address of the contact.
faxNumber String
Fax number of the contact in international format. For example, "+1-800-555-0123".
email This property is required. string
Email address of the contact.
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. PostalAddress
Postal address of the contact.
faxNumber string
Fax number of the contact in international format. For example, "+1-800-555-0123".
email This property is required. str
Email address of the contact.
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. PostalAddress
Postal address of the contact.
fax_number str
Fax number of the contact in international format. For example, "+1-800-555-0123".
email This property is required. String
Email address of the contact.
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.
faxNumber String
Fax number of the contact in international format. For example, "+1-800-555-0123".

ContactResponse
, ContactResponseArgs

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

ContactSettings
, ContactSettingsArgs

AdminContact This property is required. Pulumi.GoogleNative.Domains.V1.Inputs.Contact
The administrative contact for the Registration.
Privacy This property is required. Pulumi.GoogleNative.Domains.V1.ContactSettingsPrivacy
Privacy setting for the contacts associated with the Registration.
RegistrantContact This property is required. Pulumi.GoogleNative.Domains.V1.Inputs.Contact
The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.
TechnicalContact This property is required. Pulumi.GoogleNative.Domains.V1.Inputs.Contact
The technical contact for the Registration.
AdminContact This property is required. Contact
The administrative contact for the Registration.
Privacy This property is required. ContactSettingsPrivacy
Privacy setting for the contacts associated with the Registration.
RegistrantContact This property is required. Contact
The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.
TechnicalContact This property is required. Contact
The technical contact for the Registration.
adminContact This property is required. Contact
The administrative contact for the Registration.
privacy This property is required. ContactSettingsPrivacy
Privacy setting for the contacts associated with the Registration.
registrantContact This property is required. Contact
The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.
technicalContact This property is required. Contact
The technical contact for the Registration.
adminContact This property is required. Contact
The administrative contact for the Registration.
privacy This property is required. ContactSettingsPrivacy
Privacy setting for the contacts associated with the Registration.
registrantContact This property is required. Contact
The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.
technicalContact This property is required. Contact
The technical contact for the Registration.
admin_contact This property is required. Contact
The administrative contact for the Registration.
privacy This property is required. ContactSettingsPrivacy
Privacy setting for the contacts associated with the Registration.
registrant_contact This property is required. Contact
The registrant contact for the Registration. Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain. Warning: For new Registrations, the registrant receives an email confirmation that they must complete within 15 days to avoid domain suspension.
technical_contact This property is required. Contact
The technical contact for the Registration.
adminContact This property is required. Property Map
The administrative contact for the Registration.
privacy This property is required. "CONTACT_PRIVACY_UNSPECIFIED" | "PUBLIC_CONTACT_DATA" | "PRIVATE_CONTACT_DATA" | "REDACTED_CONTACT_DATA"
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.

ContactSettingsPrivacy
, ContactSettingsPrivacyArgs

ContactPrivacyUnspecified
CONTACT_PRIVACY_UNSPECIFIEDThe contact privacy settings are undefined.
PublicContactData
PUBLIC_CONTACT_DATAAll the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.
PrivateContactData
PRIVATE_CONTACT_DATADeprecated: For more information, see Cloud Domains feature deprecation None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.
RedactedContactData
REDACTED_CONTACT_DATAThe organization name (if provided) and limited non-identifying data from ContactSettings is available to the public (e.g. country and state). The remaining data is marked as REDACTED FOR PRIVACY in the WHOIS database. The actual information redacted depends on the domain. For details, see the registration privacy article.
ContactSettingsPrivacyContactPrivacyUnspecified
CONTACT_PRIVACY_UNSPECIFIEDThe contact privacy settings are undefined.
ContactSettingsPrivacyPublicContactData
PUBLIC_CONTACT_DATAAll the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.
ContactSettingsPrivacyPrivateContactData
PRIVATE_CONTACT_DATADeprecated: For more information, see Cloud Domains feature deprecation None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.
ContactSettingsPrivacyRedactedContactData
REDACTED_CONTACT_DATAThe organization name (if provided) and limited non-identifying data from ContactSettings is available to the public (e.g. country and state). The remaining data is marked as REDACTED FOR PRIVACY in the WHOIS database. The actual information redacted depends on the domain. For details, see the registration privacy article.
ContactPrivacyUnspecified
CONTACT_PRIVACY_UNSPECIFIEDThe contact privacy settings are undefined.
PublicContactData
PUBLIC_CONTACT_DATAAll the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.
PrivateContactData
PRIVATE_CONTACT_DATADeprecated: For more information, see Cloud Domains feature deprecation None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.
RedactedContactData
REDACTED_CONTACT_DATAThe organization name (if provided) and limited non-identifying data from ContactSettings is available to the public (e.g. country and state). The remaining data is marked as REDACTED FOR PRIVACY in the WHOIS database. The actual information redacted depends on the domain. For details, see the registration privacy article.
ContactPrivacyUnspecified
CONTACT_PRIVACY_UNSPECIFIEDThe contact privacy settings are undefined.
PublicContactData
PUBLIC_CONTACT_DATAAll the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.
PrivateContactData
PRIVATE_CONTACT_DATADeprecated: For more information, see Cloud Domains feature deprecation None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.
RedactedContactData
REDACTED_CONTACT_DATAThe organization name (if provided) and limited non-identifying data from ContactSettings is available to the public (e.g. country and state). The remaining data is marked as REDACTED FOR PRIVACY in the WHOIS database. The actual information redacted depends on the domain. For details, see the registration privacy article.
CONTACT_PRIVACY_UNSPECIFIED
CONTACT_PRIVACY_UNSPECIFIEDThe contact privacy settings are undefined.
PUBLIC_CONTACT_DATA
PUBLIC_CONTACT_DATAAll the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.
PRIVATE_CONTACT_DATA
PRIVATE_CONTACT_DATADeprecated: For more information, see Cloud Domains feature deprecation None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.
REDACTED_CONTACT_DATA
REDACTED_CONTACT_DATAThe organization name (if provided) and limited non-identifying data from ContactSettings is available to the public (e.g. country and state). The remaining data is marked as REDACTED FOR PRIVACY in the WHOIS database. The actual information redacted depends on the domain. For details, see the registration privacy article.
"CONTACT_PRIVACY_UNSPECIFIED"
CONTACT_PRIVACY_UNSPECIFIEDThe contact privacy settings are undefined.
"PUBLIC_CONTACT_DATA"
PUBLIC_CONTACT_DATAAll the data from ContactSettings is publicly available. When setting this option, you must also provide a PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT in the contact_notices field of the request.
"PRIVATE_CONTACT_DATA"
PRIVATE_CONTACT_DATADeprecated: For more information, see Cloud Domains feature deprecation None of the data from ContactSettings is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.
"REDACTED_CONTACT_DATA"
REDACTED_CONTACT_DATAThe organization name (if provided) and limited non-identifying data from ContactSettings is available to the public (e.g. country and state). The remaining data is marked as REDACTED FOR PRIVACY in the WHOIS database. The actual information redacted depends on the domain. For details, see the registration privacy article.

ContactSettingsResponse
, ContactSettingsResponseArgs

AdminContact This property is required. Pulumi.GoogleNative.Domains.V1.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.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 This property is required. Pulumi.GoogleNative.Domains.V1.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.

CustomDns
, CustomDnsArgs

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 List<Pulumi.GoogleNative.Domains.V1.Inputs.DsRecord>
The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.
NameServers 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 []DsRecord
The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.
nameServers 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 List<DsRecord>
The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.
nameServers 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 DsRecord[]
The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.
name_servers 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.
ds_records Sequence[DsRecord]
The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.
nameServers 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 List<Property Map>
The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.

CustomDnsResponse
, CustomDnsResponseArgs

DsRecords This property is required. 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 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.

DnsSettings
, DnsSettingsArgs

CustomDns Pulumi.GoogleNative.Domains.V1.Inputs.CustomDns
An arbitrary DNS provider identified by its name servers.
GlueRecords List<Pulumi.GoogleNative.Domains.V1.Inputs.GlueRecord>
The list of glue records for this Registration. Commonly empty.
GoogleDomainsDns Pulumi.GoogleNative.Domains.V1.Inputs.GoogleDomainsDns
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 CustomDns
An arbitrary DNS provider identified by its name servers.
GlueRecords []GlueRecord
The list of glue records for this Registration. Commonly empty.
GoogleDomainsDns GoogleDomainsDns
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 CustomDns
An arbitrary DNS provider identified by its name servers.
glueRecords List<GlueRecord>
The list of glue records for this Registration. Commonly empty.
googleDomainsDns GoogleDomainsDns
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 CustomDns
An arbitrary DNS provider identified by its name servers.
glueRecords GlueRecord[]
The list of glue records for this Registration. Commonly empty.
googleDomainsDns GoogleDomainsDns
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 CustomDns
An arbitrary DNS provider identified by its name servers.
glue_records Sequence[GlueRecord]
The list of glue records for this Registration. Commonly empty.
google_domains_dns GoogleDomainsDns
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.

DnsSettingsResponse
, DnsSettingsResponseArgs

CustomDns This property is required. Pulumi.GoogleNative.Domains.V1.Inputs.CustomDnsResponse
An arbitrary DNS provider identified by its name servers.
GlueRecords This property is required. List<Pulumi.GoogleNative.Domains.V1.Inputs.GlueRecordResponse>
The list of glue records for this Registration. Commonly empty.
GoogleDomainsDns This property is required. 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 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.

DsRecord
, DsRecordArgs

Algorithm Pulumi.GoogleNative.Domains.V1.DsRecordAlgorithm
The algorithm used to generate the referenced DNSKEY.
Digest string
The digest generated from the referenced DNSKEY.
DigestType Pulumi.GoogleNative.Domains.V1.DsRecordDigestType
The hash function used to generate the digest of the referenced DNSKEY.
KeyTag int
The key tag of the record. Must be set in range 0 -- 65535.
Algorithm DsRecordAlgorithm
The algorithm used to generate the referenced DNSKEY.
Digest string
The digest generated from the referenced DNSKEY.
DigestType DsRecordDigestType
The hash function used to generate the digest of the referenced DNSKEY.
KeyTag int
The key tag of the record. Must be set in range 0 -- 65535.
algorithm DsRecordAlgorithm
The algorithm used to generate the referenced DNSKEY.
digest String
The digest generated from the referenced DNSKEY.
digestType DsRecordDigestType
The hash function used to generate the digest of the referenced DNSKEY.
keyTag Integer
The key tag of the record. Must be set in range 0 -- 65535.
algorithm DsRecordAlgorithm
The algorithm used to generate the referenced DNSKEY.
digest string
The digest generated from the referenced DNSKEY.
digestType DsRecordDigestType
The hash function used to generate the digest of the referenced DNSKEY.
keyTag number
The key tag of the record. Must be set in range 0 -- 65535.
algorithm DsRecordAlgorithm
The algorithm used to generate the referenced DNSKEY.
digest str
The digest generated from the referenced DNSKEY.
digest_type DsRecordDigestType
The hash function used to generate the digest of the referenced DNSKEY.
key_tag int
The key tag of the record. Must be set in range 0 -- 65535.
algorithm "ALGORITHM_UNSPECIFIED" | "RSAMD5" | "DH" | "DSA" | "ECC" | "RSASHA1" | "DSANSEC3SHA1" | "RSASHA1NSEC3SHA1" | "RSASHA256" | "RSASHA512" | "ECCGOST" | "ECDSAP256SHA256" | "ECDSAP384SHA384" | "ED25519" | "ED448" | "INDIRECT" | "PRIVATEDNS" | "PRIVATEOID"
The algorithm used to generate the referenced DNSKEY.
digest String
The digest generated from the referenced DNSKEY.
digestType "DIGEST_TYPE_UNSPECIFIED" | "SHA1" | "SHA256" | "GOST3411" | "SHA384"
The hash function used to generate the digest of the referenced DNSKEY.
keyTag Number
The key tag of the record. Must be set in range 0 -- 65535.

DsRecordAlgorithm
, DsRecordAlgorithmArgs

AlgorithmUnspecified
ALGORITHM_UNSPECIFIEDThe algorithm is unspecified.
Rsamd5
RSAMD5RSA/MD5. Cannot be used for new deployments.
Dh
DHDiffie-Hellman. Cannot be used for new deployments.
Dsa
DSADSA/SHA1. Not recommended for new deployments.
Ecc
ECCECC. Not recommended for new deployments.
Rsasha1
RSASHA1RSA/SHA-1. Not recommended for new deployments.
Dsansec3sha1
DSANSEC3SHA1DSA-NSEC3-SHA1. Not recommended for new deployments.
Rsasha1nsec3sha1
RSASHA1NSEC3SHA1RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.
Rsasha256
RSASHA256RSA/SHA-256.
Rsasha512
RSASHA512RSA/SHA-512.
Eccgost
ECCGOSTGOST R 34.10-2001.
Ecdsap256sha256
ECDSAP256SHA256ECDSA Curve P-256 with SHA-256.
Ecdsap384sha384
ECDSAP384SHA384ECDSA Curve P-384 with SHA-384.
Ed25519
ED25519Ed25519.
Ed448
ED448Ed448.
Indirect
INDIRECTReserved for Indirect Keys. Cannot be used for new deployments.
Privatedns
PRIVATEDNSPrivate algorithm. Cannot be used for new deployments.
Privateoid
PRIVATEOIDPrivate algorithm OID. Cannot be used for new deployments.
DsRecordAlgorithmAlgorithmUnspecified
ALGORITHM_UNSPECIFIEDThe algorithm is unspecified.
DsRecordAlgorithmRsamd5
RSAMD5RSA/MD5. Cannot be used for new deployments.
DsRecordAlgorithmDh
DHDiffie-Hellman. Cannot be used for new deployments.
DsRecordAlgorithmDsa
DSADSA/SHA1. Not recommended for new deployments.
DsRecordAlgorithmEcc
ECCECC. Not recommended for new deployments.
DsRecordAlgorithmRsasha1
RSASHA1RSA/SHA-1. Not recommended for new deployments.
DsRecordAlgorithmDsansec3sha1
DSANSEC3SHA1DSA-NSEC3-SHA1. Not recommended for new deployments.
DsRecordAlgorithmRsasha1nsec3sha1
RSASHA1NSEC3SHA1RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.
DsRecordAlgorithmRsasha256
RSASHA256RSA/SHA-256.
DsRecordAlgorithmRsasha512
RSASHA512RSA/SHA-512.
DsRecordAlgorithmEccgost
ECCGOSTGOST R 34.10-2001.
DsRecordAlgorithmEcdsap256sha256
ECDSAP256SHA256ECDSA Curve P-256 with SHA-256.
DsRecordAlgorithmEcdsap384sha384
ECDSAP384SHA384ECDSA Curve P-384 with SHA-384.
DsRecordAlgorithmEd25519
ED25519Ed25519.
DsRecordAlgorithmEd448
ED448Ed448.
DsRecordAlgorithmIndirect
INDIRECTReserved for Indirect Keys. Cannot be used for new deployments.
DsRecordAlgorithmPrivatedns
PRIVATEDNSPrivate algorithm. Cannot be used for new deployments.
DsRecordAlgorithmPrivateoid
PRIVATEOIDPrivate algorithm OID. Cannot be used for new deployments.
AlgorithmUnspecified
ALGORITHM_UNSPECIFIEDThe algorithm is unspecified.
Rsamd5
RSAMD5RSA/MD5. Cannot be used for new deployments.
Dh
DHDiffie-Hellman. Cannot be used for new deployments.
Dsa
DSADSA/SHA1. Not recommended for new deployments.
Ecc
ECCECC. Not recommended for new deployments.
Rsasha1
RSASHA1RSA/SHA-1. Not recommended for new deployments.
Dsansec3sha1
DSANSEC3SHA1DSA-NSEC3-SHA1. Not recommended for new deployments.
Rsasha1nsec3sha1
RSASHA1NSEC3SHA1RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.
Rsasha256
RSASHA256RSA/SHA-256.
Rsasha512
RSASHA512RSA/SHA-512.
Eccgost
ECCGOSTGOST R 34.10-2001.
Ecdsap256sha256
ECDSAP256SHA256ECDSA Curve P-256 with SHA-256.
Ecdsap384sha384
ECDSAP384SHA384ECDSA Curve P-384 with SHA-384.
Ed25519
ED25519Ed25519.
Ed448
ED448Ed448.
Indirect
INDIRECTReserved for Indirect Keys. Cannot be used for new deployments.
Privatedns
PRIVATEDNSPrivate algorithm. Cannot be used for new deployments.
Privateoid
PRIVATEOIDPrivate algorithm OID. Cannot be used for new deployments.
AlgorithmUnspecified
ALGORITHM_UNSPECIFIEDThe algorithm is unspecified.
Rsamd5
RSAMD5RSA/MD5. Cannot be used for new deployments.
Dh
DHDiffie-Hellman. Cannot be used for new deployments.
Dsa
DSADSA/SHA1. Not recommended for new deployments.
Ecc
ECCECC. Not recommended for new deployments.
Rsasha1
RSASHA1RSA/SHA-1. Not recommended for new deployments.
Dsansec3sha1
DSANSEC3SHA1DSA-NSEC3-SHA1. Not recommended for new deployments.
Rsasha1nsec3sha1
RSASHA1NSEC3SHA1RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.
Rsasha256
RSASHA256RSA/SHA-256.
Rsasha512
RSASHA512RSA/SHA-512.
Eccgost
ECCGOSTGOST R 34.10-2001.
Ecdsap256sha256
ECDSAP256SHA256ECDSA Curve P-256 with SHA-256.
Ecdsap384sha384
ECDSAP384SHA384ECDSA Curve P-384 with SHA-384.
Ed25519
ED25519Ed25519.
Ed448
ED448Ed448.
Indirect
INDIRECTReserved for Indirect Keys. Cannot be used for new deployments.
Privatedns
PRIVATEDNSPrivate algorithm. Cannot be used for new deployments.
Privateoid
PRIVATEOIDPrivate algorithm OID. Cannot be used for new deployments.
ALGORITHM_UNSPECIFIED
ALGORITHM_UNSPECIFIEDThe algorithm is unspecified.
RSAMD5
RSAMD5RSA/MD5. Cannot be used for new deployments.
DH
DHDiffie-Hellman. Cannot be used for new deployments.
DSA
DSADSA/SHA1. Not recommended for new deployments.
ECC
ECCECC. Not recommended for new deployments.
RSASHA1
RSASHA1RSA/SHA-1. Not recommended for new deployments.
DSANSEC3SHA1
DSANSEC3SHA1DSA-NSEC3-SHA1. Not recommended for new deployments.
RSASHA1NSEC3SHA1
RSASHA1NSEC3SHA1RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.
RSASHA256
RSASHA256RSA/SHA-256.
RSASHA512
RSASHA512RSA/SHA-512.
ECCGOST
ECCGOSTGOST R 34.10-2001.
ECDSAP256SHA256
ECDSAP256SHA256ECDSA Curve P-256 with SHA-256.
ECDSAP384SHA384
ECDSAP384SHA384ECDSA Curve P-384 with SHA-384.
ED25519
ED25519Ed25519.
ED448
ED448Ed448.
INDIRECT
INDIRECTReserved for Indirect Keys. Cannot be used for new deployments.
PRIVATEDNS
PRIVATEDNSPrivate algorithm. Cannot be used for new deployments.
PRIVATEOID
PRIVATEOIDPrivate algorithm OID. Cannot be used for new deployments.
"ALGORITHM_UNSPECIFIED"
ALGORITHM_UNSPECIFIEDThe algorithm is unspecified.
"RSAMD5"
RSAMD5RSA/MD5. Cannot be used for new deployments.
"DH"
DHDiffie-Hellman. Cannot be used for new deployments.
"DSA"
DSADSA/SHA1. Not recommended for new deployments.
"ECC"
ECCECC. Not recommended for new deployments.
"RSASHA1"
RSASHA1RSA/SHA-1. Not recommended for new deployments.
"DSANSEC3SHA1"
DSANSEC3SHA1DSA-NSEC3-SHA1. Not recommended for new deployments.
"RSASHA1NSEC3SHA1"
RSASHA1NSEC3SHA1RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.
"RSASHA256"
RSASHA256RSA/SHA-256.
"RSASHA512"
RSASHA512RSA/SHA-512.
"ECCGOST"
ECCGOSTGOST R 34.10-2001.
"ECDSAP256SHA256"
ECDSAP256SHA256ECDSA Curve P-256 with SHA-256.
"ECDSAP384SHA384"
ECDSAP384SHA384ECDSA Curve P-384 with SHA-384.
"ED25519"
ED25519Ed25519.
"ED448"
ED448Ed448.
"INDIRECT"
INDIRECTReserved for Indirect Keys. Cannot be used for new deployments.
"PRIVATEDNS"
PRIVATEDNSPrivate algorithm. Cannot be used for new deployments.
"PRIVATEOID"
PRIVATEOIDPrivate algorithm OID. Cannot be used for new deployments.

DsRecordDigestType
, DsRecordDigestTypeArgs

DigestTypeUnspecified
DIGEST_TYPE_UNSPECIFIEDThe DigestType is unspecified.
Sha1
SHA1SHA-1. Not recommended for new deployments.
Sha256
SHA256SHA-256.
Gost3411
GOST3411GOST R 34.11-94.
Sha384
SHA384SHA-384.
DsRecordDigestTypeDigestTypeUnspecified
DIGEST_TYPE_UNSPECIFIEDThe DigestType is unspecified.
DsRecordDigestTypeSha1
SHA1SHA-1. Not recommended for new deployments.
DsRecordDigestTypeSha256
SHA256SHA-256.
DsRecordDigestTypeGost3411
GOST3411GOST R 34.11-94.
DsRecordDigestTypeSha384
SHA384SHA-384.
DigestTypeUnspecified
DIGEST_TYPE_UNSPECIFIEDThe DigestType is unspecified.
Sha1
SHA1SHA-1. Not recommended for new deployments.
Sha256
SHA256SHA-256.
Gost3411
GOST3411GOST R 34.11-94.
Sha384
SHA384SHA-384.
DigestTypeUnspecified
DIGEST_TYPE_UNSPECIFIEDThe DigestType is unspecified.
Sha1
SHA1SHA-1. Not recommended for new deployments.
Sha256
SHA256SHA-256.
Gost3411
GOST3411GOST R 34.11-94.
Sha384
SHA384SHA-384.
DIGEST_TYPE_UNSPECIFIED
DIGEST_TYPE_UNSPECIFIEDThe DigestType is unspecified.
SHA1
SHA1SHA-1. Not recommended for new deployments.
SHA256
SHA256SHA-256.
GOST3411
GOST3411GOST R 34.11-94.
SHA384
SHA384SHA-384.
"DIGEST_TYPE_UNSPECIFIED"
DIGEST_TYPE_UNSPECIFIEDThe DigestType is unspecified.
"SHA1"
SHA1SHA-1. Not recommended for new deployments.
"SHA256"
SHA256SHA-256.
"GOST3411"
GOST3411GOST R 34.11-94.
"SHA384"
SHA384SHA-384.

DsRecordResponse
, DsRecordResponseArgs

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.

GlueRecord
, GlueRecordArgs

HostName This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
Domain name of the host in Punycode format.
ipv4Addresses List<String>
List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. 198.51.100.1). At least one of ipv4_address and ipv6_address must be set.
ipv6Addresses List<String>
List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. 2001:db8::). At least one of ipv4_address and ipv6_address must be set.

GlueRecordResponse
, GlueRecordResponseArgs

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.

GoogleDomainsDns
, GoogleDomainsDnsArgs

DsState This property is required. Pulumi.GoogleNative.Domains.V1.GoogleDomainsDnsDsState
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
DsState This property is required. GoogleDomainsDnsDsState
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
dsState This property is required. GoogleDomainsDnsDsState
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
dsState This property is required. GoogleDomainsDnsDsState
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
ds_state This property is required. GoogleDomainsDnsDsState
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
dsState This property is required. "DS_STATE_UNSPECIFIED" | "DS_RECORDS_UNPUBLISHED" | "DS_RECORDS_PUBLISHED"
The state of DS records for this domain. Used to enable or disable automatic DNSSEC.

GoogleDomainsDnsDsState
, GoogleDomainsDnsDsStateArgs

DsStateUnspecified
DS_STATE_UNSPECIFIEDDS state is unspecified.
DsRecordsUnpublished
DS_RECORDS_UNPUBLISHEDDNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.
DsRecordsPublished
DS_RECORDS_PUBLISHEDDNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.
GoogleDomainsDnsDsStateDsStateUnspecified
DS_STATE_UNSPECIFIEDDS state is unspecified.
GoogleDomainsDnsDsStateDsRecordsUnpublished
DS_RECORDS_UNPUBLISHEDDNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.
GoogleDomainsDnsDsStateDsRecordsPublished
DS_RECORDS_PUBLISHEDDNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.
DsStateUnspecified
DS_STATE_UNSPECIFIEDDS state is unspecified.
DsRecordsUnpublished
DS_RECORDS_UNPUBLISHEDDNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.
DsRecordsPublished
DS_RECORDS_PUBLISHEDDNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.
DsStateUnspecified
DS_STATE_UNSPECIFIEDDS state is unspecified.
DsRecordsUnpublished
DS_RECORDS_UNPUBLISHEDDNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.
DsRecordsPublished
DS_RECORDS_PUBLISHEDDNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.
DS_STATE_UNSPECIFIED
DS_STATE_UNSPECIFIEDDS state is unspecified.
DS_RECORDS_UNPUBLISHED
DS_RECORDS_UNPUBLISHEDDNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.
DS_RECORDS_PUBLISHED
DS_RECORDS_PUBLISHEDDNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.
"DS_STATE_UNSPECIFIED"
DS_STATE_UNSPECIFIEDDS state is unspecified.
"DS_RECORDS_UNPUBLISHED"
DS_RECORDS_UNPUBLISHEDDNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.
"DS_RECORDS_PUBLISHED"
DS_RECORDS_PUBLISHEDDNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the Registration's dns_provider field is already DNSSEC-signed.

GoogleDomainsDnsResponse
, GoogleDomainsDnsResponseArgs

DsRecords This property is required. 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 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.

ManagementSettings
, ManagementSettingsArgs

PreferredRenewalMethod Pulumi.GoogleNative.Domains.V1.ManagementSettingsPreferredRenewalMethod
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.
TransferLockState Pulumi.GoogleNative.Domains.V1.ManagementSettingsTransferLockState
Controls whether the domain can be transferred to another registrar.
PreferredRenewalMethod ManagementSettingsPreferredRenewalMethod
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.
TransferLockState ManagementSettingsTransferLockState
Controls whether the domain can be transferred to another registrar.
preferredRenewalMethod ManagementSettingsPreferredRenewalMethod
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.
transferLockState ManagementSettingsTransferLockState
Controls whether the domain can be transferred to another registrar.
preferredRenewalMethod ManagementSettingsPreferredRenewalMethod
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.
transferLockState ManagementSettingsTransferLockState
Controls whether the domain can be transferred to another registrar.
preferred_renewal_method ManagementSettingsPreferredRenewalMethod
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.
transfer_lock_state ManagementSettingsTransferLockState
Controls whether the domain can be transferred to another registrar.
preferredRenewalMethod "RENEWAL_METHOD_UNSPECIFIED" | "AUTOMATIC_RENEWAL" | "MANUAL_RENEWAL" | "RENEWAL_DISABLED"
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.
transferLockState "TRANSFER_LOCK_STATE_UNSPECIFIED" | "UNLOCKED" | "LOCKED"
Controls whether the domain can be transferred to another registrar.

ManagementSettingsPreferredRenewalMethod
, ManagementSettingsPreferredRenewalMethodArgs

RenewalMethodUnspecified
RENEWAL_METHOD_UNSPECIFIEDThe renewal method is undefined.
AutomaticRenewal
AUTOMATIC_RENEWALThe domain is automatically renewed each year.
ManualRenewal
MANUAL_RENEWALDeprecated: For more information, see Cloud Domains feature deprecation This option was never used. Use RENEWAL_DISABLED instead.
RenewalDisabled
RENEWAL_DISABLEDThe domain won't be renewed and will expire at its expiration time.
ManagementSettingsPreferredRenewalMethodRenewalMethodUnspecified
RENEWAL_METHOD_UNSPECIFIEDThe renewal method is undefined.
ManagementSettingsPreferredRenewalMethodAutomaticRenewal
AUTOMATIC_RENEWALThe domain is automatically renewed each year.
ManagementSettingsPreferredRenewalMethodManualRenewal
MANUAL_RENEWALDeprecated: For more information, see Cloud Domains feature deprecation This option was never used. Use RENEWAL_DISABLED instead.
ManagementSettingsPreferredRenewalMethodRenewalDisabled
RENEWAL_DISABLEDThe domain won't be renewed and will expire at its expiration time.
RenewalMethodUnspecified
RENEWAL_METHOD_UNSPECIFIEDThe renewal method is undefined.
AutomaticRenewal
AUTOMATIC_RENEWALThe domain is automatically renewed each year.
ManualRenewal
MANUAL_RENEWALDeprecated: For more information, see Cloud Domains feature deprecation This option was never used. Use RENEWAL_DISABLED instead.
RenewalDisabled
RENEWAL_DISABLEDThe domain won't be renewed and will expire at its expiration time.
RenewalMethodUnspecified
RENEWAL_METHOD_UNSPECIFIEDThe renewal method is undefined.
AutomaticRenewal
AUTOMATIC_RENEWALThe domain is automatically renewed each year.
ManualRenewal
MANUAL_RENEWALDeprecated: For more information, see Cloud Domains feature deprecation This option was never used. Use RENEWAL_DISABLED instead.
RenewalDisabled
RENEWAL_DISABLEDThe domain won't be renewed and will expire at its expiration time.
RENEWAL_METHOD_UNSPECIFIED
RENEWAL_METHOD_UNSPECIFIEDThe renewal method is undefined.
AUTOMATIC_RENEWAL
AUTOMATIC_RENEWALThe domain is automatically renewed each year.
MANUAL_RENEWAL
MANUAL_RENEWALDeprecated: For more information, see Cloud Domains feature deprecation This option was never used. Use RENEWAL_DISABLED instead.
RENEWAL_DISABLED
RENEWAL_DISABLEDThe domain won't be renewed and will expire at its expiration time.
"RENEWAL_METHOD_UNSPECIFIED"
RENEWAL_METHOD_UNSPECIFIEDThe renewal method is undefined.
"AUTOMATIC_RENEWAL"
AUTOMATIC_RENEWALThe domain is automatically renewed each year.
"MANUAL_RENEWAL"
MANUAL_RENEWALDeprecated: For more information, see Cloud Domains feature deprecation This option was never used. Use RENEWAL_DISABLED instead.
"RENEWAL_DISABLED"
RENEWAL_DISABLEDThe domain won't be renewed and will expire at its expiration time.

ManagementSettingsResponse
, ManagementSettingsResponseArgs

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.

ManagementSettingsTransferLockState
, ManagementSettingsTransferLockStateArgs

TransferLockStateUnspecified
TRANSFER_LOCK_STATE_UNSPECIFIEDThe state is unspecified.
Unlocked
UNLOCKEDThe domain is unlocked and can be transferred to another registrar.
Locked
LOCKEDThe domain is locked and cannot be transferred to another registrar.
ManagementSettingsTransferLockStateTransferLockStateUnspecified
TRANSFER_LOCK_STATE_UNSPECIFIEDThe state is unspecified.
ManagementSettingsTransferLockStateUnlocked
UNLOCKEDThe domain is unlocked and can be transferred to another registrar.
ManagementSettingsTransferLockStateLocked
LOCKEDThe domain is locked and cannot be transferred to another registrar.
TransferLockStateUnspecified
TRANSFER_LOCK_STATE_UNSPECIFIEDThe state is unspecified.
Unlocked
UNLOCKEDThe domain is unlocked and can be transferred to another registrar.
Locked
LOCKEDThe domain is locked and cannot be transferred to another registrar.
TransferLockStateUnspecified
TRANSFER_LOCK_STATE_UNSPECIFIEDThe state is unspecified.
Unlocked
UNLOCKEDThe domain is unlocked and can be transferred to another registrar.
Locked
LOCKEDThe domain is locked and cannot be transferred to another registrar.
TRANSFER_LOCK_STATE_UNSPECIFIED
TRANSFER_LOCK_STATE_UNSPECIFIEDThe state is unspecified.
UNLOCKED
UNLOCKEDThe domain is unlocked and can be transferred to another registrar.
LOCKED
LOCKEDThe domain is locked and cannot be transferred to another registrar.
"TRANSFER_LOCK_STATE_UNSPECIFIED"
TRANSFER_LOCK_STATE_UNSPECIFIEDThe state is unspecified.
"UNLOCKED"
UNLOCKEDThe domain is unlocked and can be transferred to another registrar.
"LOCKED"
LOCKEDThe domain is locked and cannot be transferred to another registrar.

Money
, MoneyArgs

CurrencyCode string
The three-letter currency code defined in ISO 4217.
Nanos int
Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
Units string
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
CurrencyCode string
The three-letter currency code defined in ISO 4217.
Nanos int
Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
Units string
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
currencyCode String
The three-letter currency code defined in ISO 4217.
nanos Integer
Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
units String
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
currencyCode string
The three-letter currency code defined in ISO 4217.
nanos number
Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
units string
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
currency_code str
The three-letter currency code defined in ISO 4217.
nanos int
Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
units str
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
currencyCode String
The three-letter currency code defined in ISO 4217.
nanos Number
Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
units String
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

PostalAddress
, PostalAddressArgs

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.
AddressLines List<string>
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
AdministrativeArea string
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
LanguageCode string
Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
Locality string
Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
Organization string
Optional. The name of the organization at the address.
PostalCode string
Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
Recipients List<string>
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
Revision int
The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.
SortingCode string
Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
Sublocality string
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
RegionCode 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.
AddressLines []string
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
AdministrativeArea string
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
LanguageCode string
Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
Locality string
Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
Organization string
Optional. The name of the organization at the address.
PostalCode string
Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
Recipients []string
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
Revision int
The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.
SortingCode string
Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
Sublocality string
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
regionCode 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.
addressLines List<String>
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
administrativeArea String
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
languageCode String
Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
locality String
Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
organization String
Optional. The name of the organization at the address.
postalCode String
Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
recipients List<String>
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
revision Integer
The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.
sortingCode String
Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
sublocality String
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
regionCode 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.
addressLines string[]
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
administrativeArea string
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
languageCode string
Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
locality string
Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
organization string
Optional. The name of the organization at the address.
postalCode string
Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
recipients string[]
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
revision number
The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.
sortingCode string
Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
sublocality string
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
region_code 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.
address_lines Sequence[str]
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
administrative_area str
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
language_code str
Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
locality str
Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
organization str
Optional. The name of the organization at the address.
postal_code str
Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
recipients Sequence[str]
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
revision int
The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.
sorting_code str
Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
sublocality str
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
regionCode 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.
addressLines List<String>
Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
administrativeArea String
Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
languageCode String
Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
locality String
Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
organization String
Optional. The name of the organization at the address.
postalCode String
Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
recipients List<String>
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
revision Number
The schema revision of the PostalAddress. This must be set to 0, which is the latest revision. All new revisions must be backward compatible with old revisions.
sortingCode String
Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
sublocality String
Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

PostalAddressResponse
, PostalAddressResponseArgs

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.

RegistrationContactNoticesItem
, RegistrationContactNoticesItemArgs

ContactNoticeUnspecified
CONTACT_NOTICE_UNSPECIFIEDThe notice is undefined.
PublicContactDataAcknowledgement
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENTRequired when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.
RegistrationContactNoticesItemContactNoticeUnspecified
CONTACT_NOTICE_UNSPECIFIEDThe notice is undefined.
RegistrationContactNoticesItemPublicContactDataAcknowledgement
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENTRequired when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.
ContactNoticeUnspecified
CONTACT_NOTICE_UNSPECIFIEDThe notice is undefined.
PublicContactDataAcknowledgement
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENTRequired when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.
ContactNoticeUnspecified
CONTACT_NOTICE_UNSPECIFIEDThe notice is undefined.
PublicContactDataAcknowledgement
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENTRequired when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.
CONTACT_NOTICE_UNSPECIFIED
CONTACT_NOTICE_UNSPECIFIEDThe notice is undefined.
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENTRequired when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.
"CONTACT_NOTICE_UNSPECIFIED"
CONTACT_NOTICE_UNSPECIFIEDThe notice is undefined.
"PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT"
PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENTRequired when setting the privacy field of ContactSettings to PUBLIC_CONTACT_DATA, which exposes contact data publicly.

RegistrationDomainNoticesItem
, RegistrationDomainNoticesItemArgs

DomainNoticeUnspecified
DOMAIN_NOTICE_UNSPECIFIEDThe notice is undefined.
HstsPreloaded
HSTS_PRELOADEDIndicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.
RegistrationDomainNoticesItemDomainNoticeUnspecified
DOMAIN_NOTICE_UNSPECIFIEDThe notice is undefined.
RegistrationDomainNoticesItemHstsPreloaded
HSTS_PRELOADEDIndicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.
DomainNoticeUnspecified
DOMAIN_NOTICE_UNSPECIFIEDThe notice is undefined.
HstsPreloaded
HSTS_PRELOADEDIndicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.
DomainNoticeUnspecified
DOMAIN_NOTICE_UNSPECIFIEDThe notice is undefined.
HstsPreloaded
HSTS_PRELOADEDIndicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.
DOMAIN_NOTICE_UNSPECIFIED
DOMAIN_NOTICE_UNSPECIFIEDThe notice is undefined.
HSTS_PRELOADED
HSTS_PRELOADEDIndicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.
"DOMAIN_NOTICE_UNSPECIFIED"
DOMAIN_NOTICE_UNSPECIFIEDThe notice is undefined.
"HSTS_PRELOADED"
HSTS_PRELOADEDIndicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see how to get an SSL certificate.

Package Details

Repository
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