1. Packages
  2. Google Cloud Native
  3. API Docs
  4. datacatalog
  5. datacatalog/v1
  6. EntryGroup

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.datacatalog/v1.EntryGroup

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Creates an entry group. An entry group contains logically related entries together with Cloud Identity and Access Management policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources: * BigQuery entries (@bigquery) * Pub/Sub topics (@pubsub) * Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH}) You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can’t contain the @ symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

    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,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   project: 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: google-native:datacatalog/v1: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.

    Constructor example

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

    var entryGroupResource = new GoogleNative.DataCatalog.V1.EntryGroup("entryGroupResource", new()
    {
        EntryGroupId = "string",
        Description = "string",
        DisplayName = "string",
        Location = "string",
        Name = "string",
        Project = "string",
    });
    
    example, err := datacatalog.NewEntryGroup(ctx, "entryGroupResource", &datacatalog.EntryGroupArgs{
    EntryGroupId: pulumi.String("string"),
    Description: pulumi.String("string"),
    DisplayName: pulumi.String("string"),
    Location: pulumi.String("string"),
    Name: pulumi.String("string"),
    Project: pulumi.String("string"),
    })
    
    var entryGroupResource = new EntryGroup("entryGroupResource", EntryGroupArgs.builder()
        .entryGroupId("string")
        .description("string")
        .displayName("string")
        .location("string")
        .name("string")
        .project("string")
        .build());
    
    entry_group_resource = google_native.datacatalog.v1.EntryGroup("entryGroupResource",
        entry_group_id="string",
        description="string",
        display_name="string",
        location="string",
        name="string",
        project="string")
    
    const entryGroupResource = new google_native.datacatalog.v1.EntryGroup("entryGroupResource", {
        entryGroupId: "string",
        description: "string",
        displayName: "string",
        location: "string",
        name: "string",
        project: "string",
    });
    
    type: google-native:datacatalog/v1:EntryGroup
    properties:
        description: string
        displayName: string
        entryGroupId: string
        location: string
        name: string
        project: 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
    Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    Description string
    Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
    DisplayName string
    A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
    Location string
    Name string
    The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
    Project string
    EntryGroupId string
    Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    Description string
    Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
    DisplayName string
    A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
    Location string
    Name string
    The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
    Project string
    entryGroupId String
    Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    description String
    Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
    displayName String
    A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
    location String
    name String
    The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
    project String
    entryGroupId string
    Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    description string
    Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
    displayName string
    A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
    location string
    name string
    The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
    project string
    entry_group_id str
    Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    description str
    Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
    display_name str
    A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
    location str
    name str
    The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
    project str
    entryGroupId String
    Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
    description String
    Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.
    displayName String
    A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
    location String
    name String
    The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
    project String

    Outputs

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

    DataCatalogTimestamps Pulumi.GoogleNative.DataCatalog.V1.Outputs.GoogleCloudDatacatalogV1SystemTimestampsResponse
    Timestamps of the entry group. Default value is empty.
    Id string
    The provider-assigned unique ID for this managed resource.
    DataCatalogTimestamps GoogleCloudDatacatalogV1SystemTimestampsResponse
    Timestamps of the entry group. Default value is empty.
    Id string
    The provider-assigned unique ID for this managed resource.
    dataCatalogTimestamps GoogleCloudDatacatalogV1SystemTimestampsResponse
    Timestamps of the entry group. Default value is empty.
    id String
    The provider-assigned unique ID for this managed resource.
    dataCatalogTimestamps GoogleCloudDatacatalogV1SystemTimestampsResponse
    Timestamps of the entry group. Default value is empty.
    id string
    The provider-assigned unique ID for this managed resource.
    data_catalog_timestamps GoogleCloudDatacatalogV1SystemTimestampsResponse
    Timestamps of the entry group. Default value is empty.
    id str
    The provider-assigned unique ID for this managed resource.
    dataCatalogTimestamps Property Map
    Timestamps of the entry group. Default value is empty.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GoogleCloudDatacatalogV1SystemTimestampsResponse, GoogleCloudDatacatalogV1SystemTimestampsResponseArgs

    CreateTime string
    Creation timestamp of the resource within the given system.
    ExpireTime string
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    UpdateTime string
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    CreateTime string
    Creation timestamp of the resource within the given system.
    ExpireTime string
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    UpdateTime string
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    createTime String
    Creation timestamp of the resource within the given system.
    expireTime String
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    updateTime String
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    createTime string
    Creation timestamp of the resource within the given system.
    expireTime string
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    updateTime string
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    create_time str
    Creation timestamp of the resource within the given system.
    expire_time str
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    update_time str
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    createTime String
    Creation timestamp of the resource within the given system.
    expireTime String
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    updateTime String
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi