Show / Hide Table of Contents

Class GlobalAddress

Represents a Global Address resource. Global addresses are used for HTTP(S) load balancing.

To get more information about GlobalAddress, see:

  • API documentation
  • How-to Guides
  • Reserving a Static External IP Address

Example Usage - Global Address Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var @default = new Gcp.Compute.GlobalAddress("default", new Gcp.Compute.GlobalAddressArgs
    {
    });
}

}
Inheritance
System.Object
Resource
CustomResource
GlobalAddress
Inherited Members
CustomResource.Id
Resource.GetResourceType()
Resource.GetResourceName()
Resource.Urn
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Gcp.Compute
Assembly: Pulumi.Gcp.dll
Syntax
public class GlobalAddress : CustomResource

Constructors

View Source

GlobalAddress(String, GlobalAddressArgs, CustomResourceOptions)

Create a GlobalAddress resource with the given unique name, arguments, and options.

Declaration
public GlobalAddress(string name, GlobalAddressArgs args = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource

GlobalAddressArgs args

The arguments used to populate this resource's properties

CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

Address

The IP address or beginning of the address range represented by this resource. This can be supplied as an input to reserve a specific address or omitted to allow GCP to choose a valid one for you.

Declaration
public Output<string> Address { get; }
Property Value
Type Description
Output<System.String>
View Source

AddressType

The type of the address to reserve.

  • EXTERNAL indicates public/external single IP address.
  • INTERNAL indicates internal IP ranges belonging to some network.
Declaration
public Output<string> AddressType { get; }
Property Value
Type Description
Output<System.String>
View Source

CreationTimestamp

Creation timestamp in RFC3339 text format.

Declaration
public Output<string> CreationTimestamp { get; }
Property Value
Type Description
Output<System.String>
View Source

Description

An optional description of this resource.

Declaration
public Output<string> Description { get; }
Property Value
Type Description
Output<System.String>
View Source

IpVersion

The IP Version that will be used by this address. The default value is IPV4.

Declaration
public Output<string> IpVersion { get; }
Property Value
Type Description
Output<System.String>
View Source

LabelFingerprint

The fingerprint used for optimistic locking of this resource. Used internally during updates.

Declaration
public Output<string> LabelFingerprint { get; }
Property Value
Type Description
Output<System.String>
View Source

Labels

Labels to apply to this address. A list of key->value pairs.

Declaration
public Output<ImmutableDictionary<string, string>> Labels { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>
View Source

Name

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

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

Network

The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address.

Declaration
public Output<string> Network { get; }
Property Value
Type Description
Output<System.String>
View Source

PrefixLength

The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=EXTERNAL.

Declaration
public Output<int?> PrefixLength { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>
View Source

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration
public Output<string> Project { get; }
Property Value
Type Description
Output<System.String>
View Source

Purpose

The purpose of the resource. For global internal addresses it can be

  • VPC_PEERING - for peer networks This should only be set when using an Internal address.
Declaration
public Output<string> Purpose { get; }
Property Value
Type Description
Output<System.String>
View Source

SelfLink

The URI of the created resource.

Declaration
public Output<string> SelfLink { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, GlobalAddressState, CustomResourceOptions)

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

Declaration
public static GlobalAddress Get(string name, Input<string> id, GlobalAddressState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.

Input<System.String> id

The unique provider ID of the resource to lookup.

GlobalAddressState state

Any extra arguments used during the lookup.

CustomResourceOptions options

A bag of options that control this resource's behavior

Returns
Type Description
GlobalAddress
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.