Group class

The NetworkConnectivity Group resource

To get more information about Group, see:

Example Usage

Network Connectivity Group Basic

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

const basicHub = new gcp.networkconnectivity.Hub("basic_hub", {
    name: "network-connectivity-hub1",
    description: "A sample hub",
    labels: {
        "label-one": "value-one",
    },
});
const primary = new gcp.networkconnectivity.Group("primary", {
    hub: basicHub.id,
    name: "default",
    labels: {
        "label-one": "value-one",
    },
    description: "A sample hub group",
    autoAccept: {
        autoAcceptProjects: [
            "foo",
            "bar",
        ],
    },
});

import pulumi
import pulumi_gcp as gcp

basic_hub = gcp.networkconnectivity.Hub("basic_hub",
    name="network-connectivity-hub1",
    description="A sample hub",
    labels={
        "label-one": "value-one",
    })
primary = gcp.networkconnectivity.Group("primary",
    hub=basic_hub.id,
    name="default",
    labels={
        "label-one": "value-one",
    },
    description="A sample hub group",
    auto_accept={
        "auto_accept_projects": [
            "foo",
            "bar",
        ],
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var basicHub = new Gcp.NetworkConnectivity.Hub("basic_hub", new()
    {
        Name = "network-connectivity-hub1",
        Description = "A sample hub",
        Labels =
        {
            { "label-one", "value-one" },
        },
    });

    var primary = new Gcp.NetworkConnectivity.Group("primary", new()
    {
        Hub = basicHub.Id,
        Name = "default",
        Labels =
        {
            { "label-one", "value-one" },
        },
        Description = "A sample hub group",
        AutoAccept = new Gcp.NetworkConnectivity.Inputs.GroupAutoAcceptArgs
        {
            AutoAcceptProjects = new[]
            {
                "foo",
                "bar",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/networkconnectivity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		basicHub, err := networkconnectivity.NewHub(ctx, "basic_hub", &networkconnectivity.HubArgs{
			Name:        pulumi.String("network-connectivity-hub1"),
			Description: pulumi.String("A sample hub"),
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
		})
		if err != nil {
			return err
		}
		_, err = networkconnectivity.NewGroup(ctx, "primary", &networkconnectivity.GroupArgs{
			Hub:  basicHub.ID().ToIDOutput().ToStringOutput(),
			Name: pulumi.String("default"),
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
			Description: pulumi.String("A sample hub group"),
			AutoAccept: &networkconnectivity.GroupAutoAcceptArgs{
				AutoAcceptProjects: pulumi.StringArray{
					pulumi.String("foo"),
					pulumi.String("bar"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_networkconnectivity_hub" "basic_hub" {
  name        = "network-connectivity-hub1"
  description = "A sample hub"
  labels = {
    "label-one" = "value-one"
  }
}
resource "gcp_networkconnectivity_group" "primary" {
  hub  = gcp_networkconnectivity_hub.basic_hub.id
  name = "default"
  labels = {
    "label-one" = "value-one"
  }
  description = "A sample hub group"
  auto_accept = {
    auto_accept_projects = ["foo", "bar"]
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networkconnectivity.Hub;
import com.pulumi.gcp.networkconnectivity.HubArgs;
import com.pulumi.gcp.networkconnectivity.Group;
import com.pulumi.gcp.networkconnectivity.GroupArgs;
import com.pulumi.gcp.networkconnectivity.inputs.GroupAutoAcceptArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 basicHub = new Hub("basicHub", HubArgs.builder()
            .name("network-connectivity-hub1")
            .description("A sample hub")
            .labels(Map.of("label-one", "value-one"))
            .build());

        var primary = new Group("primary", GroupArgs.builder()
            .hub(basicHub.id())
            .name("default")
            .labels(Map.of("label-one", "value-one"))
            .description("A sample hub group")
            .autoAccept(GroupAutoAcceptArgs.builder()
                .autoAcceptProjects(
                    "foo",
                    "bar")
                .build())
            .build());

    }
}

resources:
  basicHub:
    type: gcp:networkconnectivity:Hub
    name: basic_hub
    properties:
      name: network-connectivity-hub1
      description: A sample hub
      labels:
        label-one: value-one
  primary:
    type: gcp:networkconnectivity:Group
    properties:
      hub: ${basicHub.id}
      name: default
      labels:
        label-one: value-one
      description: A sample hub group
      autoAccept:
        autoAcceptProjects:
          - foo
          - bar

Import

Group can be imported using any of these accepted formats:

projects/{{project}}/locations/global/hubs/{{hub}}/groups/{{name}}
{{project}}/{{hub}}/{{name}}
{{hub}}/{{name}}

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

$ pulumi import gcp:networkconnectivity/group:Group default projects/{{project}}/locations/global/hubs/{{hub}}/groups/{{name}}
$ pulumi import gcp:networkconnectivity/group:Group default {{project}}/{{hub}}/{{name}}
$ pulumi import gcp:networkconnectivity/group:Group default {{hub}}/{{name}}

Constructors

Group(String name, {GroupArgs? args, CustomResourceOptions? options}): Creates a new Group. name The Pulumi resource name. args Arguments used to configure this Group. The set of arguments for Group. options Resource options controlling this resource's behavior.
Group.reference(String urn): Creates a typed reference to an existing Group resource.

Properties

autoAccept ↔ Output<GroupAutoAccept?>: Optional. The auto-accept setting for this group. Structure is documented below.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: Output only. The time the hub was created.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
description ↔ Output<String?>: An optional description of the group.
latefinal
effectiveLabels ↔ Output<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.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
hub ↔ Output<String>: The name of the hub. Hub names must be unique. They use the following form: projects/{projectNumber}/locations/global/hubs/{hubId}
latefinal
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
labels ↔ Output<Map<String, String>?>: Optional labels in key:value format. For more information about labels, see Requirements for labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
latefinal
name ↔ Output<String>: The name of the group. Group names must be unique. Possible values are: default, center, edge.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
pulumiLabels ↔ Output<Map<String, String>>: The combination of labels configured directly on the resource and default labels configured on the provider.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
routeTable ↔ Output<String>: Output only. The name of the route table that corresponds to this group. They use the following form: projects/{projectNumber}/locations/global/hubs/{hubId}/routeTables/{route_table_id}
latefinal
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
state ↔ Output<String>: Output only. The current lifecycle state of this hub.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
uid ↔ Output<String>: Output only. The Google-generated UUID for the group. This value is unique across all group resources. If a group is deleted and another with the same name is created, the new route table is assigned a different uniqueId.
latefinal
updateTime ↔ Output<String>: Output only. The time the hub was last updated.
latefinal
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {GroupState? state, CustomResourceOptions? options}) → Group: Gets an existing Group resource's state with the given name and id.