1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. datacatalog
  5. EntryGroup
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

gcp.datacatalog.EntryGroup

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

    An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.

    To get more information about EntryGroup, see:

    Example Usage

    Data Catalog Entry Group Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const basicEntryGroup = new gcp.datacatalog.EntryGroup("basic_entry_group", {entryGroupId: "my_group"});
    
    import pulumi
    import pulumi_gcp as gcp
    
    basic_entry_group = gcp.datacatalog.EntryGroup("basic_entry_group", entry_group_id="my_group")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/datacatalog"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := datacatalog.NewEntryGroup(ctx, "basic_entry_group", &datacatalog.EntryGroupArgs{
    			EntryGroupId: pulumi.String("my_group"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var basicEntryGroup = new Gcp.DataCatalog.EntryGroup("basic_entry_group", new()
        {
            EntryGroupId = "my_group",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.datacatalog.EntryGroup;
    import com.pulumi.gcp.datacatalog.EntryGroupArgs;
    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 basicEntryGroup = new EntryGroup("basicEntryGroup", EntryGroupArgs.builder()        
                .entryGroupId("my_group")
                .build());
    
        }
    }
    
    resources:
      basicEntryGroup:
        type: gcp:datacatalog:EntryGroup
        name: basic_entry_group
        properties:
          entryGroupId: my_group
    

    Data Catalog Entry Group Full

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const basicEntryGroup = new gcp.datacatalog.EntryGroup("basic_entry_group", {
        entryGroupId: "my_group",
        displayName: "entry group",
        description: "example entry group",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    basic_entry_group = gcp.datacatalog.EntryGroup("basic_entry_group",
        entry_group_id="my_group",
        display_name="entry group",
        description="example entry group")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/datacatalog"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := datacatalog.NewEntryGroup(ctx, "basic_entry_group", &datacatalog.EntryGroupArgs{
    			EntryGroupId: pulumi.String("my_group"),
    			DisplayName:  pulumi.String("entry group"),
    			Description:  pulumi.String("example entry group"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var basicEntryGroup = new Gcp.DataCatalog.EntryGroup("basic_entry_group", new()
        {
            EntryGroupId = "my_group",
            DisplayName = "entry group",
            Description = "example entry group",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.datacatalog.EntryGroup;
    import com.pulumi.gcp.datacatalog.EntryGroupArgs;
    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 basicEntryGroup = new EntryGroup("basicEntryGroup", EntryGroupArgs.builder()        
                .entryGroupId("my_group")
                .displayName("entry group")
                .description("example entry group")
                .build());
    
        }
    }
    
    resources:
      basicEntryGroup:
        type: gcp:datacatalog:EntryGroup
        name: basic_entry_group
        properties:
          entryGroupId: my_group
          displayName: entry group
          description: example entry group
    

    Create EntryGroup Resource

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

    Constructor syntax

    new EntryGroup(name: string, args: EntryGroupArgs, opts?: CustomResourceOptions);
    @overload
    def EntryGroup(resource_name: str,
                   args: EntryGroupArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def EntryGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   entry_group_id: Optional[str] = None,
                   description: Optional[str] = None,
                   display_name: Optional[str] = None,
                   project: Optional[str] = None,
                   region: Optional[str] = None)
    func NewEntryGroup(ctx *Context, name string, args EntryGroupArgs, opts ...ResourceOption) (*EntryGroup, error)
    public EntryGroup(string name, EntryGroupArgs args, CustomResourceOptions? opts = null)
    public EntryGroup(String name, EntryGroupArgs args)
    public EntryGroup(String name, EntryGroupArgs args, CustomResourceOptions options)
    
    type: gcp:datacatalog:EntryGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EntryGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EntryGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EntryGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntryGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntryGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var entryGroupResource = new Gcp.DataCatalog.EntryGroup("entryGroupResource", new()
    {
        EntryGroupId = "string",
        Description = "string",
        DisplayName = "string",
        Project = "string",
        Region = "string",
    });
    
    example, err := datacatalog.NewEntryGroup(ctx, "entryGroupResource", &datacatalog.EntryGroupArgs{
    	EntryGroupId: pulumi.String("string"),
    	Description:  pulumi.String("string"),
    	DisplayName:  pulumi.String("string"),
    	Project:      pulumi.String("string"),
    	Region:       pulumi.String("string"),
    })
    
    var entryGroupResource = new EntryGroup("entryGroupResource", EntryGroupArgs.builder()        
        .entryGroupId("string")
        .description("string")
        .displayName("string")
        .project("string")
        .region("string")
        .build());
    
    entry_group_resource = gcp.datacatalog.EntryGroup("entryGroupResource",
        entry_group_id="string",
        description="string",
        display_name="string",
        project="string",
        region="string")
    
    const entryGroupResource = new gcp.datacatalog.EntryGroup("entryGroupResource", {
        entryGroupId: "string",
        description: "string",
        displayName: "string",
        project: "string",
        region: "string",
    });
    
    type: gcp:datacatalog:EntryGroup
    properties:
        description: string
        displayName: string
        entryGroupId: string
        project: string
        region: string
    

    EntryGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EntryGroup resource accepts the following input properties:

    EntryGroupId string
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    Description string
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    DisplayName string
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    EntryGroup location region.
    EntryGroupId string
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    Description string
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    DisplayName string
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    EntryGroup location region.
    entryGroupId String
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    description String
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    displayName String
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    EntryGroup location region.
    entryGroupId string
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    description string
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    displayName string
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region string
    EntryGroup location region.
    entry_group_id str
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    description str
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    display_name str
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region str
    EntryGroup location region.
    entryGroupId String
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    description String
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    displayName String
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    EntryGroup location region.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}

    Look up Existing EntryGroup Resource

    Get an existing EntryGroup 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?: EntryGroupState, opts?: CustomResourceOptions): EntryGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            entry_group_id: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            region: Optional[str] = None) -> EntryGroup
    func GetEntryGroup(ctx *Context, name string, id IDInput, state *EntryGroupState, opts ...ResourceOption) (*EntryGroup, error)
    public static EntryGroup Get(string name, Input<string> id, EntryGroupState? state, CustomResourceOptions? opts = null)
    public static EntryGroup get(String name, Output<String> id, EntryGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Description string
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    DisplayName string
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    EntryGroupId string
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    Name string
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    EntryGroup location region.
    Description string
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    DisplayName string
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    EntryGroupId string
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    Name string
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    EntryGroup location region.
    description String
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    displayName String
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    entryGroupId String
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    name String
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    EntryGroup location region.
    description string
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    displayName string
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    entryGroupId string
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    name string
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region string
    EntryGroup location region.
    description str
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    display_name str
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    entry_group_id str
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    name str
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region str
    EntryGroup location region.
    description String
    Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
    displayName String
    A short name to identify the entry group, for example, "analytics data - jan 2011".
    entryGroupId String
    The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.


    name String
    The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    EntryGroup location region.

    Import

    EntryGroup can be imported using any of these accepted formats:

    • {{name}}

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

    $ pulumi import gcp:datacatalog/entryGroup:EntryGroup default {{name}}
    

    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.
    gcp logo
    Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi