Group class

A resource that represents an asset group. The purpose of an asset group is to bundle a set of assets that have something in common, while allowing users to add annotations to the group.

Example Usage

Migration Group Basic

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

const _default = new gcp.migrationcenter.Group("default", {
    location: "us-central1",
    groupId: "group-test",
    description: "Terraform integration test description",
    displayName: "Terraform integration test display",
    labels: {
        key: "value",
    },
});

import pulumi
import pulumi_gcp as gcp

default = gcp.migrationcenter.Group("default",
    location="us-central1",
    group_id="group-test",
    description="Terraform integration test description",
    display_name="Terraform integration test display",
    labels={
        "key": "value",
    })

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

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.MigrationCenter.Group("default", new()
    {
        Location = "us-central1",
        GroupId = "group-test",
        Description = "Terraform integration test description",
        DisplayName = "Terraform integration test display",
        Labels =
        {
            { "key", "value" },
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := migrationcenter.NewGroup(ctx, "default", &migrationcenter.GroupArgs{
			Location:    pulumi.String("us-central1"),
			GroupId:     pulumi.String("group-test"),
			Description: pulumi.String("Terraform integration test description"),
			DisplayName: pulumi.String("Terraform integration test display"),
			Labels: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_migrationcenter_group" "default" {
  location     = "us-central1"
  group_id     = "group-test"
  description  = "Terraform integration test description"
  display_name = "Terraform integration test display"
  labels = {
    "key" = "value"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.migrationcenter.Group;
import com.pulumi.gcp.migrationcenter.GroupArgs;
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 default_ = new Group("default", GroupArgs.builder()
            .location("us-central1")
            .groupId("group-test")
            .description("Terraform integration test description")
            .displayName("Terraform integration test display")
            .labels(Map.of("key", "value"))
            .build());

    }
}

resources:
  default:
    type: gcp:migrationcenter:Group
    properties:
      location: us-central1
      groupId: group-test
      description: Terraform integration test description
      displayName: Terraform integration test display
      labels:
        key: value

Import

Group can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/groups/{{group_id}}
• {{project}}/{{location}}/{{group_id}}
• {{location}}/{{group_id}}

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

$ pulumi import gcp:migrationcenter/group:Group default projects/{{project}}/locations/{{location}}/groups/{{group_id}}
$ pulumi import gcp:migrationcenter/group:Group default {{project}}/{{location}}/{{group_id}}
$ pulumi import gcp:migrationcenter/group:Group default {{location}}/{{group_id}}

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

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Output only. The timestamp when the group was created.

late, final

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.

late, final

description ↔ Output<String?>

Optional. The description of the group.

late, final

displayName ↔ Output<String?>

Optional. User-friendly display name.

late, final

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.

late, final

groupId ↔ Output<String>

Required. User specified ID for the group. It will become the last component of the group name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: a-z?.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>?>

Labels as key value pairs. 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.

late, final

location ↔ Output<String>

The location of the group.

late, final

name ↔ Output<String>

Output only. The name of the group.

late, final

project ↔ Output<String>

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

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

Output only. The timestamp when the group was last updated.

late, final

urn ↔ Output<String>

late, final, inherited

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.