Address

Represents an Address resource.

Each virtual machine instance has an ephemeral internal IP address and, optionally, an external IP address. To communicate between instances on the same network, you can use an instance’s internal IP address. To communicate with the Internet and instances outside of the same network, you must specify the instance’s external IP address.

Internal IP addresses are ephemeral and only belong to an instance for the lifetime of the instance; if the instance is deleted and recreated, the instance is assigned a new internal IP address, either by Compute Engine or by you. External IP addresses can be either ephemeral or static.

To get more information about Address, see:

Create a Address Resource

new Address(name: string, args?: AddressArgs, opts?: CustomResourceOptions);

def Address(resource_name, opts=None, address=None, address_type=None, description=None, labels=None, name=None, network_tier=None, project=None, purpose=None, region=None, subnetwork=None, __props__=None);

func NewAddress(ctx *Context, name string, args *AddressArgs, opts ...ResourceOption) (*Address, error)

public Address(string name, AddressArgs? args = null, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Address Resource Properties

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

Inputs

The Address resource accepts the following input properties:

AddressType string: The type of address to reserve.
Description string: An optional description of this resource.
IPAddress string: The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any.
Labels Dictionary<string, string>: Labels to apply to this address. A list of key->value pairs.
Name string: Name of the resource. 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? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
NetworkTier string: The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Purpose string: 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, internal load balancers, and similar resources. - SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers This should only be set when using an Internal address.
Region string: The Region in which the created address should reside. If it is not provided, the provider region is used.
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 GCE_ENDPOINT/DNS_RESOLVER purposes.

Address string: The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any.
AddressType string: The type of address to reserve.
Description string: An optional description of this resource.
Labels map[string]string: Labels to apply to this address. A list of key->value pairs.
Name string: Name of the resource. 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? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
NetworkTier string: The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Purpose string: 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, internal load balancers, and similar resources. - SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers This should only be set when using an Internal address.
Region string: The Region in which the created address should reside. If it is not provided, the provider region is used.
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 GCE_ENDPOINT/DNS_RESOLVER purposes.

address string: The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any.
addressType string: The type of address to reserve.
description string: An optional description of this resource.
labels {[key: string]: string}: Labels to apply to this address. A list of key->value pairs.
name string: Name of the resource. 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? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
networkTier string: The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
purpose string: 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, internal load balancers, and similar resources. - SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers This should only be set when using an Internal address.
region string: The Region in which the created address should reside. If it is not provided, the provider region is used.
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 GCE_ENDPOINT/DNS_RESOLVER purposes.

address str: The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any.
address_type str: The type of address to reserve.
description str: An optional description of this resource.
labels Dict[str, str]: Labels to apply to this address. A list of key->value pairs.
name str: Name of the resource. 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? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
network_tier str: The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
purpose str: 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, internal load balancers, and similar resources. - SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers This should only be set when using an Internal address.
region str: The Region in which the created address should reside. If it is not provided, the provider region is used.
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 GCE_ENDPOINT/DNS_RESOLVER purposes.

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.
LabelFingerprint string: The fingerprint used for optimistic locking of this resource. Used internally during updates.
SelfLink string: The URI of the created resource.
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.
LabelFingerprint string: The fingerprint used for optimistic locking of this resource. Used internally during updates.
SelfLink string: The URI of the created resource.
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.
labelFingerprint string: The fingerprint used for optimistic locking of this resource. Used internally during updates.
selfLink string: The URI of the created resource.
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.
label_fingerprint str: The fingerprint used for optimistic locking of this resource. Used internally during updates.
self_link str: The URI of the created resource.
users List[str]: The URLs of the resources that are using this address.

Look up an Existing Address Resource

Get an existing Address resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AddressState, opts?: CustomResourceOptions): Address

static get(resource_name, id, opts=None, address=None, address_type=None, creation_timestamp=None, description=None, label_fingerprint=None, labels=None, name=None, network_tier=None, project=None, purpose=None, region=None, self_link=None, subnetwork=None, users=None, __props__=None);

func GetAddress(ctx *Context, name string, id IDInput, state *AddressState, opts ...ResourceOption) (*Address, error)

public static Address Get(string name, Input<string> id, AddressState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AddressType string: The type of address to reserve.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional description of this resource.
IPAddress string: The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any.
LabelFingerprint string: The fingerprint used for optimistic locking of this resource. Used internally during updates.
Labels Dictionary<string, string>: Labels to apply to this address. A list of key->value pairs.
Name string: Name of the resource. 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? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
NetworkTier string: The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Purpose string: 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, internal load balancers, and similar resources. - SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers This should only be set when using an Internal address.
Region string: The Region in which the created address should reside. If it is not provided, the provider region is used.
SelfLink string: The URI of the created resource.
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 GCE_ENDPOINT/DNS_RESOLVER purposes.
Users List<string>: The URLs of the resources that are using this address.

Address string: The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any.
AddressType string: The type of address to reserve.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional description of this resource.
LabelFingerprint string: The fingerprint used for optimistic locking of this resource. Used internally during updates.
Labels map[string]string: Labels to apply to this address. A list of key->value pairs.
Name string: Name of the resource. 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? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
NetworkTier string: The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Purpose string: 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, internal load balancers, and similar resources. - SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers This should only be set when using an Internal address.
Region string: The Region in which the created address should reside. If it is not provided, the provider region is used.
SelfLink string: The URI of the created resource.
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 GCE_ENDPOINT/DNS_RESOLVER purposes.
Users []string: The URLs of the resources that are using this address.

address string: The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any.
addressType string: The type of address to reserve.
creationTimestamp string: Creation timestamp in RFC3339 text format.
description string: An optional description of this resource.
labelFingerprint string: The fingerprint used for optimistic locking of this resource. Used internally during updates.
labels {[key: string]: string}: Labels to apply to this address. A list of key->value pairs.
name string: Name of the resource. 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? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
networkTier string: The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
purpose string: 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, internal load balancers, and similar resources. - SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers This should only be set when using an Internal address.
region string: The Region in which the created address should reside. If it is not provided, the provider region is used.
selfLink string: The URI of the created resource.
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 GCE_ENDPOINT/DNS_RESOLVER purposes.
users string[]: The URLs of the resources that are using this address.

address str: The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any.
address_type str: The type of address to reserve.
creation_timestamp str: Creation timestamp in RFC3339 text format.
description str: An optional description of this resource.
label_fingerprint str: The fingerprint used for optimistic locking of this resource. Used internally during updates.
labels Dict[str, str]: Labels to apply to this address. A list of key->value pairs.
name str: Name of the resource. 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? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
network_tier str: The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
purpose str: 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, internal load balancers, and similar resources. - SHARED_LOADBALANCER_VIP for an address that can be used by multiple internal load balancers This should only be set when using an Internal address.
region str: The Region in which the created address should reside. If it is not provided, the provider region is used.
self_link str: The URI of the created resource.
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 GCE_ENDPOINT/DNS_RESOLVER purposes.
users List[str]: The URLs of the resources that are using this address.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud