EntryGroup class

An Entry Group represents a logical grouping of one or more Entries.

Example Usage

Dataplex Entry Group Basic

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

const testEntryGroupBasic = new gcp.dataplex.EntryGroup("test_entry_group_basic", {
    entryGroupId: "entry-group-basic",
    project: "my-project-name",
    location: "us-central1",
});

import pulumi
import pulumi_gcp as gcp

test_entry_group_basic = gcp.dataplex.EntryGroup("test_entry_group_basic",
    entry_group_id="entry-group-basic",
    project="my-project-name",
    location="us-central1")

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

return await Deployment.RunAsync(() =>
{
    var testEntryGroupBasic = new Gcp.DataPlex.EntryGroup("test_entry_group_basic", new()
    {
        EntryGroupId = "entry-group-basic",
        Project = "my-project-name",
        Location = "us-central1",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataplex.NewEntryGroup(ctx, "test_entry_group_basic", &dataplex.EntryGroupArgs{
			EntryGroupId: pulumi.String("entry-group-basic"),
			Project:      pulumi.String("my-project-name"),
			Location:     pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_dataplex_entrygroup" "test_entry_group_basic" {
  entry_group_id = "entry-group-basic"
  project        = "my-project-name"
  location       = "us-central1"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataplex.EntryGroup;
import com.pulumi.gcp.dataplex.EntryGroupArgs;
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 testEntryGroupBasic = new EntryGroup("testEntryGroupBasic", EntryGroupArgs.builder()
            .entryGroupId("entry-group-basic")
            .project("my-project-name")
            .location("us-central1")
            .build());

    }
}

resources:
  testEntryGroupBasic:
    type: gcp:dataplex:EntryGroup
    name: test_entry_group_basic
    properties:
      entryGroupId: entry-group-basic
      project: my-project-name
      location: us-central1

Dataplex Entry Group Full

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

const testEntryGroupFull = new gcp.dataplex.EntryGroup("test_entry_group_full", {
    entryGroupId: "entry-group-full",
    project: "my-project-name",
    location: "us-central1",
    labels: {
        tag: "test-tf",
    },
    displayName: "terraform entry group",
    description: "entry group created by Terraform",
});

import pulumi
import pulumi_gcp as gcp

test_entry_group_full = gcp.dataplex.EntryGroup("test_entry_group_full",
    entry_group_id="entry-group-full",
    project="my-project-name",
    location="us-central1",
    labels={
        "tag": "test-tf",
    },
    display_name="terraform entry group",
    description="entry group created by Terraform")

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

return await Deployment.RunAsync(() =>
{
    var testEntryGroupFull = new Gcp.DataPlex.EntryGroup("test_entry_group_full", new()
    {
        EntryGroupId = "entry-group-full",
        Project = "my-project-name",
        Location = "us-central1",
        Labels =
        {
            { "tag", "test-tf" },
        },
        DisplayName = "terraform entry group",
        Description = "entry group created by Terraform",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataplex.NewEntryGroup(ctx, "test_entry_group_full", &dataplex.EntryGroupArgs{
			EntryGroupId: pulumi.String("entry-group-full"),
			Project:      pulumi.String("my-project-name"),
			Location:     pulumi.String("us-central1"),
			Labels: pulumi.StringMap{
				"tag": pulumi.String("test-tf"),
			},
			DisplayName: pulumi.String("terraform entry group"),
			Description: pulumi.String("entry group created by Terraform"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_dataplex_entrygroup" "test_entry_group_full" {
  entry_group_id = "entry-group-full"
  project        = "my-project-name"
  location       = "us-central1"
  labels = {
    "tag" = "test-tf"
  }
  display_name = "terraform entry group"
  description  = "entry group created by Terraform"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataplex.EntryGroup;
import com.pulumi.gcp.dataplex.EntryGroupArgs;
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 testEntryGroupFull = new EntryGroup("testEntryGroupFull", EntryGroupArgs.builder()
            .entryGroupId("entry-group-full")
            .project("my-project-name")
            .location("us-central1")
            .labels(Map.of("tag", "test-tf"))
            .displayName("terraform entry group")
            .description("entry group created by Terraform")
            .build());

    }
}

resources:
  testEntryGroupFull:
    type: gcp:dataplex:EntryGroup
    name: test_entry_group_full
    properties:
      entryGroupId: entry-group-full
      project: my-project-name
      location: us-central1
      labels:
        tag: test-tf
      displayName: terraform entry group
      description: entry group created by Terraform

Import

EntryGroup can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/entryGroups/{{entry_group_id}}
• {{project}}/{{location}}/{{entry_group_id}}
• {{location}}/{{entry_group_id}}

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

$ pulumi import gcp:dataplex/entryGroup:EntryGroup default projects/{{project}}/locations/{{location}}/entryGroups/{{entry_group_id}}
$ pulumi import gcp:dataplex/entryGroup:EntryGroup default {{project}}/{{location}}/{{entry_group_id}}
$ pulumi import gcp:dataplex/entryGroup:EntryGroup default {{location}}/{{entry_group_id}}

Constructors

EntryGroup(String name, {EntryGroupArgs? args, CustomResourceOptions? options})

Creates a new EntryGroup. name The Pulumi resource name. args Arguments used to configure this EntryGroup. The set of arguments for EntryGroup. options Resource options controlling this resource's behavior.

EntryGroup.reference(String urn)

Creates a typed reference to an existing EntryGroup resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The time when the EntryGroup 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?>

Description of the EntryGroup.

late, final

displayName ↔ Output<String?>

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

entryGroupId ↔ Output<String?>

The entry group id of the entry group.

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

User-defined labels for the EntryGroup.

late, final

location ↔ Output<String?>

The location where entry group will be created in.

late, final

name ↔ Output<String>

The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}

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

transferStatus ↔ Output<String>

Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

System generated globally unique ID for the EntryGroup. This ID will be different if the EntryGroup is deleted and re-created with the same name.

late, final

updateTime ↔ Output<String>

The time when the EntryGroup 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, {EntryGroupState? state, CustomResourceOptions? options}) → EntryGroup

Gets an existing EntryGroup resource's state with the given name and id.