Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. compute
  5. compute/v1
  6. Address

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.compute/v1.Address

Explore with Pulumi AI

google-native logo

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates an address resource in the specified project by using the data included in the request.

    Create Address Resource

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

    Constructor syntax

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

@overload
def Address(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            region: Optional[str] = None,
            name: Optional[str] = None,
            network_tier: Optional[AddressNetworkTier] = None,
            ip_version: Optional[AddressIpVersion] = None,
            ipv6_endpoint_type: Optional[AddressIpv6EndpointType] = None,
            labels: Optional[Mapping[str, str]] = None,
            address: Optional[str] = None,
            network: Optional[str] = None,
            description: Optional[str] = None,
            prefix_length: Optional[int] = None,
            project: Optional[str] = None,
            purpose: Optional[AddressPurpose] = None,
            address_type: Optional[AddressAddressType] = None,
            request_id: Optional[str] = None,
            subnetwork: Optional[str] = None)
    func NewAddress(ctx *Context, name string, args AddressArgs, opts ...ResourceOption) (*Address, error)
    public Address(string name, AddressArgs args, CustomResourceOptions? opts = null)
    public Address(String name, AddressArgs args)
public Address(String name, AddressArgs args, CustomResourceOptions options)

    type: google-native:compute/v1:Address
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AddressArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AddressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AddressArgs
    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 exampleaddressResourceResourceFromComputev1 = new GoogleNative.Compute.V1.Address("exampleaddressResourceResourceFromComputev1", new()
{
    Region = "string",
    Name = "string",
    NetworkTier = GoogleNative.Compute.V1.AddressNetworkTier.FixedStandard,
    IpVersion = GoogleNative.Compute.V1.AddressIpVersion.Ipv4,
    Ipv6EndpointType = GoogleNative.Compute.V1.AddressIpv6EndpointType.Netlb,
    Labels = 
    {
        { "string", "string" },
    },
    Address = "string",
    Network = "string",
    Description = "string",
    PrefixLength = 0,
    Project = "string",
    Purpose = GoogleNative.Compute.V1.AddressPurpose.DnsResolver,
    AddressType = GoogleNative.Compute.V1.AddressAddressType.External,
    RequestId = "string",
    Subnetwork = "string",
});

    example, err := computev1.NewAddress(ctx, "exampleaddressResourceResourceFromComputev1", &computev1.AddressArgs{
Region: pulumi.String("string"),
Name: pulumi.String("string"),
NetworkTier: computev1.AddressNetworkTierFixedStandard,
IpVersion: computev1.AddressIpVersionIpv4,
Ipv6EndpointType: computev1.AddressIpv6EndpointTypeNetlb,
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Address: pulumi.String("string"),
Network: pulumi.String("string"),
Description: pulumi.String("string"),
PrefixLength: pulumi.Int(0),
Project: pulumi.String("string"),
Purpose: computev1.AddressPurposeDnsResolver,
AddressType: computev1.AddressAddressTypeExternal,
RequestId: pulumi.String("string"),
Subnetwork: pulumi.String("string"),
})

    var exampleaddressResourceResourceFromComputev1 = new Address("exampleaddressResourceResourceFromComputev1", AddressArgs.builder()
    .region("string")
    .name("string")
    .networkTier("FIXED_STANDARD")
    .ipVersion("IPV4")
    .ipv6EndpointType("NETLB")
    .labels(Map.of("string", "string"))
    .address("string")
    .network("string")
    .description("string")
    .prefixLength(0)
    .project("string")
    .purpose("DNS_RESOLVER")
    .addressType("EXTERNAL")
    .requestId("string")
    .subnetwork("string")
    .build());

    exampleaddress_resource_resource_from_computev1 = google_native.compute.v1.Address("exampleaddressResourceResourceFromComputev1",
    region="string",
    name="string",
    network_tier=google_native.compute.v1.AddressNetworkTier.FIXED_STANDARD,
    ip_version=google_native.compute.v1.AddressIpVersion.IPV4,
    ipv6_endpoint_type=google_native.compute.v1.AddressIpv6EndpointType.NETLB,
    labels={
        "string": "string",
    },
    address="string",
    network="string",
    description="string",
    prefix_length=0,
    project="string",
    purpose=google_native.compute.v1.AddressPurpose.DNS_RESOLVER,
    address_type=google_native.compute.v1.AddressAddressType.EXTERNAL,
    request_id="string",
    subnetwork="string")

    const exampleaddressResourceResourceFromComputev1 = new google_native.compute.v1.Address("exampleaddressResourceResourceFromComputev1", {
    region: "string",
    name: "string",
    networkTier: google_native.compute.v1.AddressNetworkTier.FixedStandard,
    ipVersion: google_native.compute.v1.AddressIpVersion.Ipv4,
    ipv6EndpointType: google_native.compute.v1.AddressIpv6EndpointType.Netlb,
    labels: {
        string: "string",
    },
    address: "string",
    network: "string",
    description: "string",
    prefixLength: 0,
    project: "string",
    purpose: google_native.compute.v1.AddressPurpose.DnsResolver,
    addressType: google_native.compute.v1.AddressAddressType.External,
    requestId: "string",
    subnetwork: "string",
});

    type: google-native:compute/v1:Address
properties:
    address: string
    addressType: EXTERNAL
    description: string
    ipVersion: IPV4
    ipv6EndpointType: NETLB
    labels:
        string: string
    name: string
    network: string
    networkTier: FIXED_STANDARD
    prefixLength: 0
    project: string
    purpose: DNS_RESOLVER
    region: string
    requestId: string
    subnetwork: string

    Address Resource Properties

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

    Inputs

    The Address resource accepts the following input properties:

    Region string
    Address string
    The static IP address represented by this resource.
    AddressType Pulumi.GoogleNative.Compute.V1.AddressAddressType
    The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
    Description string
    An optional description of this resource. Provide this field when you create the resource.
    IpVersion Pulumi.GoogleNative.Compute.V1.AddressIpVersion
    The IP version that will be used by this address. Valid options are IPV4 or IPV6.
    Ipv6EndpointType Pulumi.GoogleNative.Compute.V1.AddressIpv6EndpointType
    The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
    Labels Dictionary<string, string>
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    Name string
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
    Network string
    The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
    NetworkTier Pulumi.GoogleNative.Compute.V1.AddressNetworkTier
    This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
    PrefixLength int
    The prefix length if the resource represents an IP range.
    Project string
    Purpose Pulumi.GoogleNative.Compute.V1.AddressPurpose
    The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
    RequestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    Subnetwork string
    The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
    Region string
    Address string
    The static IP address represented by this resource.
    AddressType AddressAddressType
    The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
    Description string
    An optional description of this resource. Provide this field when you create the resource.
    IpVersion AddressIpVersion
    The IP version that will be used by this address. Valid options are IPV4 or IPV6.
    Ipv6EndpointType AddressIpv6EndpointType
    The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
    Labels map[string]string
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    Name string
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
    Network string
    The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
    NetworkTier AddressNetworkTier
    This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
    PrefixLength int
    The prefix length if the resource represents an IP range.
    Project string
    Purpose AddressPurpose
    The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
    RequestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    Subnetwork string
    The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
    region String
    address String
    The static IP address represented by this resource.
    addressType AddressAddressType
    The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
    description String
    An optional description of this resource. Provide this field when you create the resource.
    ipVersion AddressIpVersion
    The IP version that will be used by this address. Valid options are IPV4 or IPV6.
    ipv6EndpointType AddressIpv6EndpointType
    The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
    labels Map<String,String>
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    name String
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
    network String
    The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
    networkTier AddressNetworkTier
    This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
    prefixLength Integer
    The prefix length if the resource represents an IP range.
    project String
    purpose AddressPurpose
    The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
    requestId String
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    subnetwork String
    The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
    region string
    address string
    The static IP address represented by this resource.
    addressType AddressAddressType
    The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
    description string
    An optional description of this resource. Provide this field when you create the resource.
    ipVersion AddressIpVersion
    The IP version that will be used by this address. Valid options are IPV4 or IPV6.
    ipv6EndpointType AddressIpv6EndpointType
    The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
    labels {[key: string]: string}
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    name string
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
    network string
    The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
    networkTier AddressNetworkTier
    This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
    prefixLength number
    The prefix length if the resource represents an IP range.
    project string
    purpose AddressPurpose
    The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
    requestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    subnetwork string
    The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
    region str
    address str
    The static IP address represented by this resource.
    address_type AddressAddressType
    The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
    description str
    An optional description of this resource. Provide this field when you create the resource.
    ip_version AddressIpVersion
    The IP version that will be used by this address. Valid options are IPV4 or IPV6.
    ipv6_endpoint_type AddressIpv6EndpointType
    The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
    labels Mapping[str, str]
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    name str
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
    network str
    The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
    network_tier AddressNetworkTier
    This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
    prefix_length int
    The prefix length if the resource represents an IP range.
    project str
    purpose AddressPurpose
    The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
    request_id str
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    subnetwork str
    The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
    region String
    address String
    The static IP address represented by this resource.
    addressType "EXTERNAL" | "INTERNAL" | "UNSPECIFIED_TYPE"
    The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
    description String
    An optional description of this resource. Provide this field when you create the resource.
    ipVersion "IPV4" | "IPV6" | "UNSPECIFIED_VERSION"
    The IP version that will be used by this address. Valid options are IPV4 or IPV6.
    ipv6EndpointType "NETLB" | "VM"
    The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
    labels Map<String>
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    name String
    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
    network String
    The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
    networkTier "FIXED_STANDARD" | "PREMIUM" | "STANDARD" | "STANDARD_OVERRIDES_FIXED_STANDARD"
    This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.
    prefixLength Number
    The prefix length if the resource represents an IP range.
    project String
    purpose "DNS_RESOLVER" | "GCE_ENDPOINT" | "IPSEC_INTERCONNECT" | "NAT_AUTO" | "PRIVATE_SERVICE_CONNECT" | "SERVERLESS" | "SHARED_LOADBALANCER_VIP" | "VPC_PEERING"
    The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources. - SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules. - PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
    requestId String
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    subnetwork String
    The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

    Outputs

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

    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    Type of the resource. Always compute#address for addresses.
    LabelFingerprint string
    A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
    SelfLink string
    Server-defined URL for the resource.
    Status string
    The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    Users List<string>
    The URLs of the resources that are using this address.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    Type of the resource. Always compute#address for addresses.
    LabelFingerprint string
    A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
    SelfLink string
    Server-defined URL for the resource.
    Status string
    The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    Users []string
    The URLs of the resources that are using this address.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    Type of the resource. Always compute#address for addresses.
    labelFingerprint String
    A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
    selfLink String
    Server-defined URL for the resource.
    status String
    The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    users List<String>
    The URLs of the resources that are using this address.
    creationTimestamp string
    Creation timestamp in RFC3339 text format.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    Type of the resource. Always compute#address for addresses.
    labelFingerprint string
    A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
    selfLink string
    Server-defined URL for the resource.
    status string
    The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    users string[]
    The URLs of the resources that are using this address.
    creation_timestamp str
    Creation timestamp in RFC3339 text format.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    Type of the resource. Always compute#address for addresses.
    label_fingerprint str
    A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
    self_link str
    Server-defined URL for the resource.
    status str
    The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    users Sequence[str]
    The URLs of the resources that are using this address.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    Type of the resource. Always compute#address for addresses.
    labelFingerprint String
    A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.
    selfLink String
    Server-defined URL for the resource.
    status String
    The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
    users List<String>
    The URLs of the resources that are using this address.

    Supporting Types

    AddressAddressType, AddressAddressTypeArgs

    External
    EXTERNALA publicly visible external IP address.
    Internal
    INTERNALA private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.
    UnspecifiedType
    UNSPECIFIED_TYPE
    AddressAddressTypeExternal
    EXTERNALA publicly visible external IP address.
    AddressAddressTypeInternal
    INTERNALA private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.
    AddressAddressTypeUnspecifiedType
    UNSPECIFIED_TYPE
    External
    EXTERNALA publicly visible external IP address.
    Internal
    INTERNALA private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.
    UnspecifiedType
    UNSPECIFIED_TYPE
    External
    EXTERNALA publicly visible external IP address.
    Internal
    INTERNALA private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.
    UnspecifiedType
    UNSPECIFIED_TYPE
    EXTERNAL
    EXTERNALA publicly visible external IP address.
    INTERNAL
    INTERNALA private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.
    UNSPECIFIED_TYPE
    UNSPECIFIED_TYPE
    "EXTERNAL"
    EXTERNALA publicly visible external IP address.
    "INTERNAL"
    INTERNALA private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.
    "UNSPECIFIED_TYPE"
    UNSPECIFIED_TYPE

    AddressIpVersion, AddressIpVersionArgs

    Ipv4
    IPV4
    Ipv6
    IPV6
    UnspecifiedVersion
    UNSPECIFIED_VERSION
    AddressIpVersionIpv4
    IPV4
    AddressIpVersionIpv6
    IPV6
    AddressIpVersionUnspecifiedVersion
    UNSPECIFIED_VERSION
    Ipv4
    IPV4
    Ipv6
    IPV6
    UnspecifiedVersion
    UNSPECIFIED_VERSION
    Ipv4
    IPV4
    Ipv6
    IPV6
    UnspecifiedVersion
    UNSPECIFIED_VERSION
    IPV4
    IPV4
    IPV6
    IPV6
    UNSPECIFIED_VERSION
    UNSPECIFIED_VERSION
    "IPV4"
    IPV4
    "IPV6"
    IPV6
    "UNSPECIFIED_VERSION"
    UNSPECIFIED_VERSION

    AddressIpv6EndpointType, AddressIpv6EndpointTypeArgs

    Netlb
    NETLBReserved IPv6 address can be used on network load balancer.
    Vm
    VMReserved IPv6 address can be used on VM.
    AddressIpv6EndpointTypeNetlb
    NETLBReserved IPv6 address can be used on network load balancer.
    AddressIpv6EndpointTypeVm
    VMReserved IPv6 address can be used on VM.
    Netlb
    NETLBReserved IPv6 address can be used on network load balancer.
    Vm
    VMReserved IPv6 address can be used on VM.
    Netlb
    NETLBReserved IPv6 address can be used on network load balancer.
    Vm
    VMReserved IPv6 address can be used on VM.
    NETLB
    NETLBReserved IPv6 address can be used on network load balancer.
    VM
    VMReserved IPv6 address can be used on VM.
    "NETLB"
    NETLBReserved IPv6 address can be used on network load balancer.
    "VM"
    VMReserved IPv6 address can be used on VM.

    AddressNetworkTier, AddressNetworkTierArgs

    FixedStandard
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    Premium
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    Standard
    STANDARDPublic internet quality, only limited support for other networking products.
    StandardOverridesFixedStandard
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
    AddressNetworkTierFixedStandard
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    AddressNetworkTierPremium
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    AddressNetworkTierStandard
    STANDARDPublic internet quality, only limited support for other networking products.
    AddressNetworkTierStandardOverridesFixedStandard
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
    FixedStandard
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    Premium
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    Standard
    STANDARDPublic internet quality, only limited support for other networking products.
    StandardOverridesFixedStandard
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
    FixedStandard
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    Premium
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    Standard
    STANDARDPublic internet quality, only limited support for other networking products.
    StandardOverridesFixedStandard
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
    FIXED_STANDARD
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    PREMIUM
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    STANDARD
    STANDARDPublic internet quality, only limited support for other networking products.
    STANDARD_OVERRIDES_FIXED_STANDARD
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
    "FIXED_STANDARD"
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    "PREMIUM"
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    "STANDARD"
    STANDARDPublic internet quality, only limited support for other networking products.
    "STANDARD_OVERRIDES_FIXED_STANDARD"
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.

    AddressPurpose, AddressPurposeArgs

    DnsResolver
    DNS_RESOLVERDNS resolver address in the subnetwork.
    GceEndpoint
    GCE_ENDPOINTVM internal/alias IP, Internal LB service IP, etc.
    IpsecInterconnect
    IPSEC_INTERCONNECTA regional internal IP address range reserved for the VLAN attachment that is used in HA VPN over Cloud Interconnect. This regional internal IP address range must not overlap with any IP address range of subnet/route in the VPC network and its peering networks. After the VLAN attachment is created with the reserved IP address range, when creating a new VPN gateway, its interface IP address is allocated from the associated VLAN attachment’s IP address range.
    NatAuto
    NAT_AUTOExternal IP automatically reserved for Cloud NAT.
    PrivateServiceConnect
    PRIVATE_SERVICE_CONNECTA private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL
    Serverless
    SERVERLESSA regional internal IP address range reserved for Serverless.
    SharedLoadbalancerVip
    SHARED_LOADBALANCER_VIPA private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.
    VpcPeering
    VPC_PEERINGIP range for peer networks.
    AddressPurposeDnsResolver
    DNS_RESOLVERDNS resolver address in the subnetwork.
    AddressPurposeGceEndpoint
    GCE_ENDPOINTVM internal/alias IP, Internal LB service IP, etc.
    AddressPurposeIpsecInterconnect
    IPSEC_INTERCONNECTA regional internal IP address range reserved for the VLAN attachment that is used in HA VPN over Cloud Interconnect. This regional internal IP address range must not overlap with any IP address range of subnet/route in the VPC network and its peering networks. After the VLAN attachment is created with the reserved IP address range, when creating a new VPN gateway, its interface IP address is allocated from the associated VLAN attachment’s IP address range.
    AddressPurposeNatAuto
    NAT_AUTOExternal IP automatically reserved for Cloud NAT.
    AddressPurposePrivateServiceConnect
    PRIVATE_SERVICE_CONNECTA private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL
    AddressPurposeServerless
    SERVERLESSA regional internal IP address range reserved for Serverless.
    AddressPurposeSharedLoadbalancerVip
    SHARED_LOADBALANCER_VIPA private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.
    AddressPurposeVpcPeering
    VPC_PEERINGIP range for peer networks.
    DnsResolver
    DNS_RESOLVERDNS resolver address in the subnetwork.
    GceEndpoint
    GCE_ENDPOINTVM internal/alias IP, Internal LB service IP, etc.
    IpsecInterconnect
    IPSEC_INTERCONNECTA regional internal IP address range reserved for the VLAN attachment that is used in HA VPN over Cloud Interconnect. This regional internal IP address range must not overlap with any IP address range of subnet/route in the VPC network and its peering networks. After the VLAN attachment is created with the reserved IP address range, when creating a new VPN gateway, its interface IP address is allocated from the associated VLAN attachment’s IP address range.
    NatAuto
    NAT_AUTOExternal IP automatically reserved for Cloud NAT.
    PrivateServiceConnect
    PRIVATE_SERVICE_CONNECTA private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL
    Serverless
    SERVERLESSA regional internal IP address range reserved for Serverless.
    SharedLoadbalancerVip
    SHARED_LOADBALANCER_VIPA private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.
    VpcPeering
    VPC_PEERINGIP range for peer networks.
    DnsResolver
    DNS_RESOLVERDNS resolver address in the subnetwork.
    GceEndpoint
    GCE_ENDPOINTVM internal/alias IP, Internal LB service IP, etc.
    IpsecInterconnect
    IPSEC_INTERCONNECTA regional internal IP address range reserved for the VLAN attachment that is used in HA VPN over Cloud Interconnect. This regional internal IP address range must not overlap with any IP address range of subnet/route in the VPC network and its peering networks. After the VLAN attachment is created with the reserved IP address range, when creating a new VPN gateway, its interface IP address is allocated from the associated VLAN attachment’s IP address range.
    NatAuto
    NAT_AUTOExternal IP automatically reserved for Cloud NAT.
    PrivateServiceConnect
    PRIVATE_SERVICE_CONNECTA private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL
    Serverless
    SERVERLESSA regional internal IP address range reserved for Serverless.
    SharedLoadbalancerVip
    SHARED_LOADBALANCER_VIPA private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.
    VpcPeering
    VPC_PEERINGIP range for peer networks.
    DNS_RESOLVER
    DNS_RESOLVERDNS resolver address in the subnetwork.
    GCE_ENDPOINT
    GCE_ENDPOINTVM internal/alias IP, Internal LB service IP, etc.
    IPSEC_INTERCONNECT
    IPSEC_INTERCONNECTA regional internal IP address range reserved for the VLAN attachment that is used in HA VPN over Cloud Interconnect. This regional internal IP address range must not overlap with any IP address range of subnet/route in the VPC network and its peering networks. After the VLAN attachment is created with the reserved IP address range, when creating a new VPN gateway, its interface IP address is allocated from the associated VLAN attachment’s IP address range.
    NAT_AUTO
    NAT_AUTOExternal IP automatically reserved for Cloud NAT.
    PRIVATE_SERVICE_CONNECT
    PRIVATE_SERVICE_CONNECTA private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL
    SERVERLESS
    SERVERLESSA regional internal IP address range reserved for Serverless.
    SHARED_LOADBALANCER_VIP
    SHARED_LOADBALANCER_VIPA private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.
    VPC_PEERING
    VPC_PEERINGIP range for peer networks.
    "DNS_RESOLVER"
    DNS_RESOLVERDNS resolver address in the subnetwork.
    "GCE_ENDPOINT"
    GCE_ENDPOINTVM internal/alias IP, Internal LB service IP, etc.
    "IPSEC_INTERCONNECT"
    IPSEC_INTERCONNECTA regional internal IP address range reserved for the VLAN attachment that is used in HA VPN over Cloud Interconnect. This regional internal IP address range must not overlap with any IP address range of subnet/route in the VPC network and its peering networks. After the VLAN attachment is created with the reserved IP address range, when creating a new VPN gateway, its interface IP address is allocated from the associated VLAN attachment’s IP address range.
    "NAT_AUTO"
    NAT_AUTOExternal IP automatically reserved for Cloud NAT.
    "PRIVATE_SERVICE_CONNECT"
    PRIVATE_SERVICE_CONNECTA private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL
    "SERVERLESS"
    SERVERLESSA regional internal IP address range reserved for Serverless.
    "SHARED_LOADBALANCER_VIP"
    SHARED_LOADBALANCER_VIPA private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.
    "VPC_PEERING"
    VPC_PEERINGIP range for peer networks.

    Package Details

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

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

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native