1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. biglake
  5. Catalog
Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi

gcp.biglake.Catalog

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi

    Catalogs are top-level containers for Databases and Tables.

    To get more information about Catalog, see:

    Example Usage

    Bigquery Biglake Catalog

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const _default = new gcp.biglake.Catalog("default", {
        name: "my_catalog",
        location: "US",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    default = gcp.biglake.Catalog("default",
        name="my_catalog",
        location="US")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/biglake"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := biglake.NewCatalog(ctx, "default", &biglake.CatalogArgs{
    			Name:     pulumi.String("my_catalog"),
    			Location: pulumi.String("US"),
    		})
    		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 @default = new Gcp.BigLake.Catalog("default", new()
        {
            Name = "my_catalog",
            Location = "US",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.biglake.Catalog;
    import com.pulumi.gcp.biglake.CatalogArgs;
    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 default_ = new Catalog("default", CatalogArgs.builder()
                .name("my_catalog")
                .location("US")
                .build());
    
        }
    }
    
    resources:
      default:
        type: gcp:biglake:Catalog
        properties:
          name: my_catalog
          location: US
    

    Create Catalog Resource

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

    Constructor syntax

    new Catalog(name: string, args: CatalogArgs, opts?: CustomResourceOptions);
    @overload
    def Catalog(resource_name: str,
                args: CatalogArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Catalog(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                location: Optional[str] = None,
                name: Optional[str] = None,
                project: Optional[str] = None)
    func NewCatalog(ctx *Context, name string, args CatalogArgs, opts ...ResourceOption) (*Catalog, error)
    public Catalog(string name, CatalogArgs args, CustomResourceOptions? opts = null)
    public Catalog(String name, CatalogArgs args)
    public Catalog(String name, CatalogArgs args, CustomResourceOptions options)
    
    type: gcp:biglake:Catalog
    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 CatalogArgs
    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 CatalogArgs
    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 CatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogArgs
    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 catalogResource = new Gcp.BigLake.Catalog("catalogResource", new()
    {
        Location = "string",
        Name = "string",
        Project = "string",
    });
    
    example, err := biglake.NewCatalog(ctx, "catalogResource", &biglake.CatalogArgs{
    	Location: pulumi.String("string"),
    	Name:     pulumi.String("string"),
    	Project:  pulumi.String("string"),
    })
    
    var catalogResource = new Catalog("catalogResource", CatalogArgs.builder()
        .location("string")
        .name("string")
        .project("string")
        .build());
    
    catalog_resource = gcp.biglake.Catalog("catalogResource",
        location="string",
        name="string",
        project="string")
    
    const catalogResource = new gcp.biglake.Catalog("catalogResource", {
        location: "string",
        name: "string",
        project: "string",
    });
    
    type: gcp:biglake:Catalog
    properties:
        location: string
        name: string
        project: string
    

    Catalog 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 Catalog resource accepts the following input properties:

    Location string
    The geographic location where the Catalog should reside.
    Name string
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Location string
    The geographic location where the Catalog should reside.
    Name string
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    The geographic location where the Catalog should reside.
    name String
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location string
    The geographic location where the Catalog should reside.
    name string
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location str
    The geographic location where the Catalog should reside.
    name str
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    The geographic location where the Catalog should reside.
    name String
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


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

    Outputs

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

    CreateTime string
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    DeleteTime string
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    ExpireTime string
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    CreateTime string
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    DeleteTime string
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    ExpireTime string
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    deleteTime String
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    expireTime String
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime string
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    deleteTime string
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    expireTime string
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    id string
    The provider-assigned unique ID for this managed resource.
    updateTime string
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    create_time str
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    delete_time str
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    expire_time str
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    id str
    The provider-assigned unique ID for this managed resource.
    update_time str
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    deleteTime String
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    expireTime String
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

    Look up Existing Catalog Resource

    Get an existing Catalog 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?: CatalogState, opts?: CustomResourceOptions): Catalog
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            create_time: Optional[str] = None,
            delete_time: Optional[str] = None,
            expire_time: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            update_time: Optional[str] = None) -> Catalog
    func GetCatalog(ctx *Context, name string, id IDInput, state *CatalogState, opts ...ResourceOption) (*Catalog, error)
    public static Catalog Get(string name, Input<string> id, CatalogState? state, CustomResourceOptions? opts = null)
    public static Catalog get(String name, Output<String> id, CatalogState 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:
    CreateTime string
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    DeleteTime string
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    ExpireTime string
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    Location string
    The geographic location where the Catalog should reside.
    Name string
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UpdateTime string
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    CreateTime string
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    DeleteTime string
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    ExpireTime string
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    Location string
    The geographic location where the Catalog should reside.
    Name string
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UpdateTime string
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    deleteTime String
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    expireTime String
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    location String
    The geographic location where the Catalog should reside.
    name String
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime String
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime string
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    deleteTime string
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    expireTime string
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    location string
    The geographic location where the Catalog should reside.
    name string
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime string
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    create_time str
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    delete_time str
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    expire_time str
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    location str
    The geographic location where the Catalog should reside.
    name str
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    update_time str
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    Output only. The creation time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    deleteTime String
    Output only. The deletion time of the catalog. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    expireTime String
    Output only. The time when this catalog is considered expired. Only set after the catalog is deleted. Only set after the catalog is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    location String
    The geographic location where the Catalog should reside.
    name String
    The name of the Catalog. Format: projects/{project_id_or_number}/locations/{locationId}/catalogs/{catalogId}


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    updateTime String
    Output only. The last modification time of the catalog. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

    Import

    Catalog can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/catalogs/{{name}}

    • {{project}}/{{location}}/{{name}}

    • {{location}}/{{name}}

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

    $ pulumi import gcp:biglake/catalog:Catalog default projects/{{project}}/locations/{{location}}/catalogs/{{name}}
    
    $ pulumi import gcp:biglake/catalog:Catalog default {{project}}/{{location}}/{{name}}
    
    $ pulumi import gcp:biglake/catalog:Catalog default {{location}}/{{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.28.0 published on Friday, Jun 21, 2024 by Pulumi