1. Registry
  2. Packages
  3. Google Cloud (GCP)
  4. API Docs
  5. observability
  6. Link
Viewing docs for Google Cloud v10.2.0
published on Tuesday, Oct 20, 2026 by Pulumi
gcp logo
Viewing docs for Google Cloud v10.2.0
published on Tuesday, Oct 20, 2026 by Pulumi

    Link configuration for exposing observability dataset data.

    Example Usage

    Create Link Resource

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

    Constructor syntax

    new Link(name: string, args: LinkArgs, opts?: CustomResourceOptions);
    @overload
    def Link(resource_name: str,
             args: LinkArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Link(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             bucket: Optional[str] = None,
             dataset: Optional[str] = None,
             link_id: Optional[str] = None,
             location: Optional[str] = None,
             deletion_policy: Optional[str] = None,
             description: Optional[str] = None,
             display_name: Optional[str] = None,
             project: Optional[str] = None)
    func NewLink(ctx *Context, name string, args LinkArgs, opts ...ResourceOption) (*Link, error)
    public Link(string name, LinkArgs args, CustomResourceOptions? opts = null)
    public Link(String name, LinkArgs args)
    public Link(String name, LinkArgs args, CustomResourceOptions options)
    
    type: gcp:observability:Link
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "gcp_observability_link" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args LinkArgs
    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 LinkArgs
    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 LinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkArgs
    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 linkResource = new Gcp.Observability.Link("linkResource", new()
    {
        Bucket = "string",
        Dataset = "string",
        LinkId = "string",
        Location = "string",
        DeletionPolicy = "string",
        Description = "string",
        DisplayName = "string",
        Project = "string",
    });
    
    example, err := observability.NewLink(ctx, "linkResource", &observability.LinkArgs{
    	Bucket:         pulumi.String("string"),
    	Dataset:        pulumi.String("string"),
    	LinkId:         pulumi.String("string"),
    	Location:       pulumi.String("string"),
    	DeletionPolicy: pulumi.String("string"),
    	Description:    pulumi.String("string"),
    	DisplayName:    pulumi.String("string"),
    	Project:        pulumi.String("string"),
    })
    
    resource "gcp_observability_link" "linkResource" {
      lifecycle {
        create_before_destroy = true
      }
      bucket          = "string"
      dataset         = "string"
      link_id         = "string"
      location        = "string"
      deletion_policy = "string"
      description     = "string"
      display_name    = "string"
      project         = "string"
    }
    
    var linkResource = new Link("linkResource", LinkArgs.builder()
        .bucket("string")
        .dataset("string")
        .linkId("string")
        .location("string")
        .deletionPolicy("string")
        .description("string")
        .displayName("string")
        .project("string")
        .build());
    
    link_resource = gcp.observability.Link("linkResource",
        bucket="string",
        dataset="string",
        link_id="string",
        location="string",
        deletion_policy="string",
        description="string",
        display_name="string",
        project="string")
    
    const linkResource = new gcp.observability.Link("linkResource", {
        bucket: "string",
        dataset: "string",
        linkId: "string",
        location: "string",
        deletionPolicy: "string",
        description: "string",
        displayName: "string",
        project: "string",
    });
    
    type: gcp:observability:Link
    properties:
        bucket: string
        dataset: string
        deletionPolicy: string
        description: string
        displayName: string
        linkId: string
        location: string
        project: string
    

    Link Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Link resource accepts the following input properties:

    Bucket string
    The bucket of the link.
    Dataset string
    The dataset of the link.
    LinkId string
    The client-assigned identifier for the link.
    Location string
    The location of the link.
    DeletionPolicy 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.
    Description string
    Description of the link.
    DisplayName string
    User friendly display name.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Bucket string
    The bucket of the link.
    Dataset string
    The dataset of the link.
    LinkId string
    The client-assigned identifier for the link.
    Location string
    The location of the link.
    DeletionPolicy 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.
    Description string
    Description of the link.
    DisplayName string
    User friendly display name.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    bucket string
    The bucket of the link.
    dataset string
    The dataset of the link.
    link_id string
    The client-assigned identifier for the link.
    location string
    The location of the link.
    deletion_policy 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.
    description string
    Description of the link.
    display_name string
    User friendly display name.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    bucket String
    The bucket of the link.
    dataset String
    The dataset of the link.
    linkId String
    The client-assigned identifier for the link.
    location String
    The location of the link.
    deletionPolicy 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.
    description String
    Description of the link.
    displayName String
    User friendly display name.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    bucket string
    The bucket of the link.
    dataset string
    The dataset of the link.
    linkId string
    The client-assigned identifier for the link.
    location string
    The location of the link.
    deletionPolicy 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.
    description string
    Description of the link.
    displayName string
    User friendly display name.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    bucket str
    The bucket of the link.
    dataset str
    The dataset of the link.
    link_id str
    The client-assigned identifier for the link.
    location str
    The location of the link.
    deletion_policy str
    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.
    description str
    Description of the link.
    display_name str
    User friendly display name.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    bucket String
    The bucket of the link.
    dataset String
    The dataset of the link.
    linkId String
    The client-assigned identifier for the link.
    location String
    The location of the link.
    deletionPolicy 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.
    description String
    Description of the link.
    displayName String
    User friendly display name.
    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 Link resource produces the following output properties:

    CreateTime string
    Output only. Create timestamp.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    CreateTime string
    Output only. Create timestamp.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    create_time string
    Output only. Create timestamp.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    createTime String
    Output only. Create timestamp.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    createTime string
    Output only. Create timestamp.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    create_time str
    Output only. Create timestamp.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    createTime String
    Output only. Create timestamp.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

    Look up Existing Link Resource

    Get an existing Link 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?: LinkState, opts?: CustomResourceOptions): Link
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bucket: Optional[str] = None,
            create_time: Optional[str] = None,
            dataset: Optional[str] = None,
            deletion_policy: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            link_id: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None) -> Link
    func GetLink(ctx *Context, name string, id IDInput, state *LinkState, opts ...ResourceOption) (*Link, error)
    public static Link Get(string name, Input<string> id, LinkState? state, CustomResourceOptions? opts = null)
    public static Link get(String name, Output<String> id, LinkState state, CustomResourceOptions options)
    resources:  _:    type: gcp:observability:Link    get:      id: ${id}
    import {
      to = gcp_observability_link.example
      id = "${id}"
    }
    
    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:
    Bucket string
    The bucket of the link.
    CreateTime string
    Output only. Create timestamp.
    Dataset string
    The dataset of the link.
    DeletionPolicy 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.
    Description string
    Description of the link.
    DisplayName string
    User friendly display name.
    LinkId string
    The client-assigned identifier for the link.
    Location string
    The location of the link.
    Name string
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Bucket string
    The bucket of the link.
    CreateTime string
    Output only. Create timestamp.
    Dataset string
    The dataset of the link.
    DeletionPolicy 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.
    Description string
    Description of the link.
    DisplayName string
    User friendly display name.
    LinkId string
    The client-assigned identifier for the link.
    Location string
    The location of the link.
    Name string
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    bucket string
    The bucket of the link.
    create_time string
    Output only. Create timestamp.
    dataset string
    The dataset of the link.
    deletion_policy 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.
    description string
    Description of the link.
    display_name string
    User friendly display name.
    link_id string
    The client-assigned identifier for the link.
    location string
    The location of the link.
    name string
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    bucket String
    The bucket of the link.
    createTime String
    Output only. Create timestamp.
    dataset String
    The dataset of the link.
    deletionPolicy 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.
    description String
    Description of the link.
    displayName String
    User friendly display name.
    linkId String
    The client-assigned identifier for the link.
    location String
    The location of the link.
    name String
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    bucket string
    The bucket of the link.
    createTime string
    Output only. Create timestamp.
    dataset string
    The dataset of the link.
    deletionPolicy 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.
    description string
    Description of the link.
    displayName string
    User friendly display name.
    linkId string
    The client-assigned identifier for the link.
    location string
    The location of the link.
    name string
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    bucket str
    The bucket of the link.
    create_time str
    Output only. Create timestamp.
    dataset str
    The dataset of the link.
    deletion_policy str
    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.
    description str
    Description of the link.
    display_name str
    User friendly display name.
    link_id str
    The client-assigned identifier for the link.
    location str
    The location of the link.
    name str
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    bucket String
    The bucket of the link.
    createTime String
    Output only. Create timestamp.
    dataset String
    The dataset of the link.
    deletionPolicy 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.
    description String
    Description of the link.
    displayName String
    User friendly display name.
    linkId String
    The client-assigned identifier for the link.
    location String
    The location of the link.
    name String
    Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Import

    Link can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/buckets/{{bucket}}/datasets/{{dataset}}/links/{{link_id}}
    • {{project}}/{{location}}/{{bucket}}/{{dataset}}/{{link_id}}
    • {{location}}/{{bucket}}/{{dataset}}/{{link_id}}

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

    $ pulumi import gcp:observability/link:Link default projects/{{project}}/locations/{{location}}/buckets/{{bucket}}/datasets/{{dataset}}/links/{{link_id}}
    $ pulumi import gcp:observability/link:Link default {{project}}/{{location}}/{{bucket}}/{{dataset}}/{{link_id}}
    $ pulumi import gcp:observability/link:Link default {{location}}/{{bucket}}/{{dataset}}/{{link_id}}
    

    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
    Viewing docs for Google Cloud v10.2.0
    published on Tuesday, Oct 20, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial