Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. networksecurity
  5. AddressGroup
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.networksecurity.AddressGroup

Explore with Pulumi AI

Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp

AddressGroup is a resource that specifies how a collection of IP/DNS used in Firewall Policy.

To get more information about AddressGroup, see:

Example Usage

Network Security Address Groups Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.networksecurity.AddressGroup("default", {
    name: "my-address-groups",
    parent: "projects/my-project-name",
    location: "us-central1",
    type: "IPV4",
    capacity: 100,
    items: ["208.80.154.224/32"],
});
Copy
import pulumi
import pulumi_gcp as gcp

default = gcp.networksecurity.AddressGroup("default",
    name="my-address-groups",
    parent="projects/my-project-name",
    location="us-central1",
    type="IPV4",
    capacity=100,
    items=["208.80.154.224/32"])
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/networksecurity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networksecurity.NewAddressGroup(ctx, "default", &networksecurity.AddressGroupArgs{
			Name:     pulumi.String("my-address-groups"),
			Parent:   pulumi.String("projects/my-project-name"),
			Location: pulumi.String("us-central1"),
			Type:     pulumi.String("IPV4"),
			Capacity: pulumi.Int(100),
			Items: pulumi.StringArray{
				pulumi.String("208.80.154.224/32"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.NetworkSecurity.AddressGroup("default", new()
    {
        Name = "my-address-groups",
        Parent = "projects/my-project-name",
        Location = "us-central1",
        Type = "IPV4",
        Capacity = 100,
        Items = new[]
        {
            "208.80.154.224/32",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networksecurity.AddressGroup;
import com.pulumi.gcp.networksecurity.AddressGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new AddressGroup("default", AddressGroupArgs.builder()
            .name("my-address-groups")
            .parent("projects/my-project-name")
            .location("us-central1")
            .type("IPV4")
            .capacity(100)
            .items("208.80.154.224/32")
            .build());

    }
}
Copy
resources:
  default:
    type: gcp:networksecurity:AddressGroup
    properties:
      name: my-address-groups
      parent: projects/my-project-name
      location: us-central1
      type: IPV4
      capacity: '100'
      items:
        - 208.80.154.224/32
Copy

Network Security Address Groups Organization Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.networksecurity.AddressGroup("default", {
    name: "my-address-groups",
    parent: "organizations/123456789",
    location: "us-central1",
    type: "IPV4",
    capacity: 100,
    items: ["208.80.154.224/32"],
});
Copy
import pulumi
import pulumi_gcp as gcp

default = gcp.networksecurity.AddressGroup("default",
    name="my-address-groups",
    parent="organizations/123456789",
    location="us-central1",
    type="IPV4",
    capacity=100,
    items=["208.80.154.224/32"])
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/networksecurity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networksecurity.NewAddressGroup(ctx, "default", &networksecurity.AddressGroupArgs{
			Name:     pulumi.String("my-address-groups"),
			Parent:   pulumi.String("organizations/123456789"),
			Location: pulumi.String("us-central1"),
			Type:     pulumi.String("IPV4"),
			Capacity: pulumi.Int(100),
			Items: pulumi.StringArray{
				pulumi.String("208.80.154.224/32"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.NetworkSecurity.AddressGroup("default", new()
    {
        Name = "my-address-groups",
        Parent = "organizations/123456789",
        Location = "us-central1",
        Type = "IPV4",
        Capacity = 100,
        Items = new[]
        {
            "208.80.154.224/32",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networksecurity.AddressGroup;
import com.pulumi.gcp.networksecurity.AddressGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new AddressGroup("default", AddressGroupArgs.builder()
            .name("my-address-groups")
            .parent("organizations/123456789")
            .location("us-central1")
            .type("IPV4")
            .capacity(100)
            .items("208.80.154.224/32")
            .build());

    }
}
Copy
resources:
  default:
    type: gcp:networksecurity:AddressGroup
    properties:
      name: my-address-groups
      parent: organizations/123456789
      location: us-central1
      type: IPV4
      capacity: '100'
      items:
        - 208.80.154.224/32
Copy

Network Security Address Groups Advanced

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.networksecurity.AddressGroup("default", {
    name: "my-address-groups",
    parent: "projects/my-project-name",
    location: "us-central1",
    description: "my description",
    type: "IPV4",
    capacity: 100,
    items: ["208.80.154.224/32"],
});
Copy
import pulumi
import pulumi_gcp as gcp

default = gcp.networksecurity.AddressGroup("default",
    name="my-address-groups",
    parent="projects/my-project-name",
    location="us-central1",
    description="my description",
    type="IPV4",
    capacity=100,
    items=["208.80.154.224/32"])
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/networksecurity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networksecurity.NewAddressGroup(ctx, "default", &networksecurity.AddressGroupArgs{
			Name:        pulumi.String("my-address-groups"),
			Parent:      pulumi.String("projects/my-project-name"),
			Location:    pulumi.String("us-central1"),
			Description: pulumi.String("my description"),
			Type:        pulumi.String("IPV4"),
			Capacity:    pulumi.Int(100),
			Items: pulumi.StringArray{
				pulumi.String("208.80.154.224/32"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.NetworkSecurity.AddressGroup("default", new()
    {
        Name = "my-address-groups",
        Parent = "projects/my-project-name",
        Location = "us-central1",
        Description = "my description",
        Type = "IPV4",
        Capacity = 100,
        Items = new[]
        {
            "208.80.154.224/32",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networksecurity.AddressGroup;
import com.pulumi.gcp.networksecurity.AddressGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new AddressGroup("default", AddressGroupArgs.builder()
            .name("my-address-groups")
            .parent("projects/my-project-name")
            .location("us-central1")
            .description("my description")
            .type("IPV4")
            .capacity(100)
            .items("208.80.154.224/32")
            .build());

    }
}
Copy
resources:
  default:
    type: gcp:networksecurity:AddressGroup
    properties:
      name: my-address-groups
      parent: projects/my-project-name
      location: us-central1
      description: my description
      type: IPV4
      capacity: '100'
      items:
        - 208.80.154.224/32
Copy

Network Security Address Groups Cloud Armor

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.networksecurity.AddressGroup("default", {
    name: "my-address-groups",
    parent: "projects/my-project-name",
    location: "global",
    type: "IPV4",
    capacity: 100,
    purposes: ["CLOUD_ARMOR"],
    items: ["208.80.154.224/32"],
});
Copy
import pulumi
import pulumi_gcp as gcp

default = gcp.networksecurity.AddressGroup("default",
    name="my-address-groups",
    parent="projects/my-project-name",
    location="global",
    type="IPV4",
    capacity=100,
    purposes=["CLOUD_ARMOR"],
    items=["208.80.154.224/32"])
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/networksecurity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networksecurity.NewAddressGroup(ctx, "default", &networksecurity.AddressGroupArgs{
			Name:     pulumi.String("my-address-groups"),
			Parent:   pulumi.String("projects/my-project-name"),
			Location: pulumi.String("global"),
			Type:     pulumi.String("IPV4"),
			Capacity: pulumi.Int(100),
			Purposes: pulumi.StringArray{
				pulumi.String("CLOUD_ARMOR"),
			},
			Items: pulumi.StringArray{
				pulumi.String("208.80.154.224/32"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @default = new Gcp.NetworkSecurity.AddressGroup("default", new()
    {
        Name = "my-address-groups",
        Parent = "projects/my-project-name",
        Location = "global",
        Type = "IPV4",
        Capacity = 100,
        Purposes = new[]
        {
            "CLOUD_ARMOR",
        },
        Items = new[]
        {
            "208.80.154.224/32",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networksecurity.AddressGroup;
import com.pulumi.gcp.networksecurity.AddressGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new AddressGroup("default", AddressGroupArgs.builder()
            .name("my-address-groups")
            .parent("projects/my-project-name")
            .location("global")
            .type("IPV4")
            .capacity(100)
            .purposes("CLOUD_ARMOR")
            .items("208.80.154.224/32")
            .build());

    }
}
Copy
resources:
  default:
    type: gcp:networksecurity:AddressGroup
    properties:
      name: my-address-groups
      parent: projects/my-project-name
      location: global
      type: IPV4
      capacity: '100'
      purposes:
        - CLOUD_ARMOR
      items:
        - 208.80.154.224/32
Copy

Create AddressGroup Resource

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

Constructor syntax

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

@overload
def AddressGroup(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 capacity: Optional[int] = None,
                 location: Optional[str] = None,
                 type: Optional[str] = None,
                 description: Optional[str] = None,
                 items: Optional[Sequence[str]] = None,
                 labels: Optional[Mapping[str, str]] = None,
                 name: Optional[str] = None,
                 parent: Optional[str] = None,
                 purposes: Optional[Sequence[str]] = None)
func NewAddressGroup(ctx *Context, name string, args AddressGroupArgs, opts ...ResourceOption) (*AddressGroup, error)
public AddressGroup(string name, AddressGroupArgs args, CustomResourceOptions? opts = null)
public AddressGroup(String name, AddressGroupArgs args)
public AddressGroup(String name, AddressGroupArgs args, CustomResourceOptions options)

type: gcp:networksecurity:AddressGroup
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. AddressGroupArgs
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. AddressGroupArgs
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. AddressGroupArgs
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. AddressGroupArgs
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. AddressGroupArgs
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 addressGroupResource = new Gcp.NetworkSecurity.AddressGroup("addressGroupResource", new()
{
    Capacity = 0,
    Location = "string",
    Type = "string",
    Description = "string",
    Items = new[]
    {
        "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Parent = "string",
    Purposes = new[]
    {
        "string",
    },
});
Copy
example, err := networksecurity.NewAddressGroup(ctx, "addressGroupResource", &networksecurity.AddressGroupArgs{
	Capacity:    pulumi.Int(0),
	Location:    pulumi.String("string"),
	Type:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Items: pulumi.StringArray{
		pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:   pulumi.String("string"),
	Parent: pulumi.String("string"),
	Purposes: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var addressGroupResource = new AddressGroup("addressGroupResource", AddressGroupArgs.builder()
    .capacity(0)
    .location("string")
    .type("string")
    .description("string")
    .items("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .parent("string")
    .purposes("string")
    .build());
Copy
address_group_resource = gcp.networksecurity.AddressGroup("addressGroupResource",
    capacity=0,
    location="string",
    type="string",
    description="string",
    items=["string"],
    labels={
        "string": "string",
    },
    name="string",
    parent="string",
    purposes=["string"])
Copy
const addressGroupResource = new gcp.networksecurity.AddressGroup("addressGroupResource", {
    capacity: 0,
    location: "string",
    type: "string",
    description: "string",
    items: ["string"],
    labels: {
        string: "string",
    },
    name: "string",
    parent: "string",
    purposes: ["string"],
});
Copy
type: gcp:networksecurity:AddressGroup
properties:
    capacity: 0
    description: string
    items:
        - string
    labels:
        string: string
    location: string
    name: string
    parent: string
    purposes:
        - string
    type: string
Copy

AddressGroup 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 AddressGroup resource accepts the following input properties:

Capacity This property is required. int
Capacity of the Address Group.
Location This property is required. string
The location of the gateway security policy. The default value is global.

Type This property is required. string
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
Description string
Free-text description of the resource.
Items List<string>
List of items.
Labels Dictionary<string, string>

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Name string
Name of the AddressGroup resource.
Parent Changes to this property will trigger replacement. string
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
Purposes List<string>
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.
Capacity This property is required. int
Capacity of the Address Group.
Location This property is required. string
The location of the gateway security policy. The default value is global.

Type This property is required. string
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
Description string
Free-text description of the resource.
Items []string
List of items.
Labels map[string]string

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Name string
Name of the AddressGroup resource.
Parent Changes to this property will trigger replacement. string
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
Purposes []string
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.
capacity This property is required. Integer
Capacity of the Address Group.
location This property is required. String
The location of the gateway security policy. The default value is global.

type This property is required. String
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
description String
Free-text description of the resource.
items List<String>
List of items.
labels Map<String,String>

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name String
Name of the AddressGroup resource.
parent Changes to this property will trigger replacement. String
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
purposes List<String>
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.
capacity This property is required. number
Capacity of the Address Group.
location This property is required. string
The location of the gateway security policy. The default value is global.

type This property is required. string
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
description string
Free-text description of the resource.
items string[]
List of items.
labels {[key: string]: string}

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name string
Name of the AddressGroup resource.
parent Changes to this property will trigger replacement. string
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
purposes string[]
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.
capacity This property is required. int
Capacity of the Address Group.
location This property is required. str
The location of the gateway security policy. The default value is global.

type This property is required. str
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
description str
Free-text description of the resource.
items Sequence[str]
List of items.
labels Mapping[str, str]

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name str
Name of the AddressGroup resource.
parent Changes to this property will trigger replacement. str
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
purposes Sequence[str]
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.
capacity This property is required. Number
Capacity of the Address Group.
location This property is required. String
The location of the gateway security policy. The default value is global.

type This property is required. String
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
description String
Free-text description of the resource.
items List<String>
List of items.
labels Map<String>

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name String
Name of the AddressGroup resource.
parent Changes to this property will trigger replacement. String
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
purposes List<String>
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.

Outputs

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

CreateTime string
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Id string
The provider-assigned unique ID for this managed resource.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
UpdateTime string
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
CreateTime string
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
EffectiveLabels map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Id string
The provider-assigned unique ID for this managed resource.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
UpdateTime string
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
createTime String
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
effectiveLabels Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id String
The provider-assigned unique ID for this managed resource.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
updateTime String
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
createTime string
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id string
The provider-assigned unique ID for this managed resource.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
updateTime string
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
create_time str
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id str
The provider-assigned unique ID for this managed resource.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
update_time str
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
createTime String
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id String
The provider-assigned unique ID for this managed resource.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
updateTime String
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Look up Existing AddressGroup Resource

Get an existing AddressGroup 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?: AddressGroupState, opts?: CustomResourceOptions): AddressGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capacity: Optional[int] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        items: Optional[Sequence[str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        parent: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        purposes: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        update_time: Optional[str] = None) -> AddressGroup
func GetAddressGroup(ctx *Context, name string, id IDInput, state *AddressGroupState, opts ...ResourceOption) (*AddressGroup, error)
public static AddressGroup Get(string name, Input<string> id, AddressGroupState? state, CustomResourceOptions? opts = null)
public static AddressGroup get(String name, Output<String> id, AddressGroupState state, CustomResourceOptions options)
resources:  _:    type: gcp:networksecurity:AddressGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Capacity int
Capacity of the Address Group.
CreateTime string
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
Description string
Free-text description of the resource.
EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Items List<string>
List of items.
Labels Dictionary<string, string>

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Location string
The location of the gateway security policy. The default value is global.

Name string
Name of the AddressGroup resource.
Parent Changes to this property will trigger replacement. string
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
Purposes List<string>
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.
Type string
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
UpdateTime string
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
Capacity int
Capacity of the Address Group.
CreateTime string
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
Description string
Free-text description of the resource.
EffectiveLabels map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Items []string
List of items.
Labels map[string]string

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Location string
The location of the gateway security policy. The default value is global.

Name string
Name of the AddressGroup resource.
Parent Changes to this property will trigger replacement. string
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
Purposes []string
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.
Type string
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
UpdateTime string
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
capacity Integer
Capacity of the Address Group.
createTime String
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
description String
Free-text description of the resource.
effectiveLabels Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
items List<String>
List of items.
labels Map<String,String>

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location String
The location of the gateway security policy. The default value is global.

name String
Name of the AddressGroup resource.
parent Changes to this property will trigger replacement. String
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
purposes List<String>
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.
type String
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
updateTime String
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
capacity number
Capacity of the Address Group.
createTime string
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
description string
Free-text description of the resource.
effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
items string[]
List of items.
labels {[key: string]: string}

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location string
The location of the gateway security policy. The default value is global.

name string
Name of the AddressGroup resource.
parent Changes to this property will trigger replacement. string
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
purposes string[]
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.
type string
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
updateTime string
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
capacity int
Capacity of the Address Group.
create_time str
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
description str
Free-text description of the resource.
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
items Sequence[str]
List of items.
labels Mapping[str, str]

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location str
The location of the gateway security policy. The default value is global.

name str
Name of the AddressGroup resource.
parent Changes to this property will trigger replacement. str
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
purposes Sequence[str]
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.
type str
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
update_time str
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
capacity Number
Capacity of the Address Group.
createTime String
The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
description String
Free-text description of the resource.
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
items List<String>
List of items.
labels Map<String>

Set of label tags associated with the AddressGroup resource. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location String
The location of the gateway security policy. The default value is global.

name String
Name of the AddressGroup resource.
parent Changes to this property will trigger replacement. String
The name of the parent this address group belongs to. Format: organizations/{organization_id} or projects/{project_id}.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
purposes List<String>
List of supported purposes of the Address Group. Each value may be one of: DEFAULT, CLOUD_ARMOR.
type String
The type of the Address Group. Possible values are "IPV4" or "IPV6". Possible values are: IPV4, IPV6.
updateTime String
The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Import

AddressGroup can be imported using any of these accepted formats:

  • {{parent}}/locations/{{location}}/addressGroups/{{name}}

When using the pulumi import command, AddressGroup can be imported using one of the formats above. For example:

$ pulumi import gcp:networksecurity/addressGroup:AddressGroup default {{parent}}/locations/{{location}}/addressGroups/{{name}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp