LinkedDataset class

Describes a BigQuery linked dataset

To get more information about LinkedDataset, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Logging Linked Dataset Basic

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

const loggingLinkedDataset = new gcp.logging.ProjectBucketConfig("logging_linked_dataset", {
    location: "global",
    project: "my-project-name",
    enableAnalytics: true,
    bucketId: "my-bucket",
});
const loggingLinkedDatasetLinkedDataset = new gcp.logging.LinkedDataset("logging_linked_dataset", {
    linkId: "mylink",
    bucket: loggingLinkedDataset.id,
    description: "Linked dataset test",
});

import pulumi
import pulumi_gcp as gcp

logging_linked_dataset = gcp.logging.ProjectBucketConfig("logging_linked_dataset",
    location="global",
    project="my-project-name",
    enable_analytics=True,
    bucket_id="my-bucket")
logging_linked_dataset_linked_dataset = gcp.logging.LinkedDataset("logging_linked_dataset",
    link_id="mylink",
    bucket=logging_linked_dataset.id,
    description="Linked dataset test")

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

return await Deployment.RunAsync(() =>
{
    var loggingLinkedDataset = new Gcp.Logging.ProjectBucketConfig("logging_linked_dataset", new()
    {
        Location = "global",
        Project = "my-project-name",
        EnableAnalytics = true,
        BucketId = "my-bucket",
    });

    var loggingLinkedDatasetLinkedDataset = new Gcp.Logging.LinkedDataset("logging_linked_dataset", new()
    {
        LinkId = "mylink",
        Bucket = loggingLinkedDataset.Id,
        Description = "Linked dataset test",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		loggingLinkedDataset, err := logging.NewProjectBucketConfig(ctx, "logging_linked_dataset", &logging.ProjectBucketConfigArgs{
			Location:        pulumi.String("global"),
			Project:         pulumi.String("my-project-name"),
			EnableAnalytics: pulumi.Bool(true),
			BucketId:        pulumi.String("my-bucket"),
		})
		if err != nil {
			return err
		}
		_, err = logging.NewLinkedDataset(ctx, "logging_linked_dataset", &logging.LinkedDatasetArgs{
			LinkId:      pulumi.String("mylink"),
			Bucket:      loggingLinkedDataset.ID().ToIDOutput().ToStringOutput(),
			Description: pulumi.String("Linked dataset test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_logging_projectbucketconfig" "logging_linked_dataset" {
  location         = "global"
  project          = "my-project-name"
  enable_analytics = true
  bucket_id        = "my-bucket"
}
resource "gcp_logging_linkeddataset" "logging_linked_dataset" {
  link_id     = "mylink"
  bucket      = gcp_logging_projectbucketconfig.logging_linked_dataset.id
  description = "Linked dataset test"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.logging.ProjectBucketConfig;
import com.pulumi.gcp.logging.ProjectBucketConfigArgs;
import com.pulumi.gcp.logging.LinkedDataset;
import com.pulumi.gcp.logging.LinkedDatasetArgs;
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 loggingLinkedDataset = new ProjectBucketConfig("loggingLinkedDataset", ProjectBucketConfigArgs.builder()
            .location("global")
            .project("my-project-name")
            .enableAnalytics(true)
            .bucketId("my-bucket")
            .build());

        var loggingLinkedDatasetLinkedDataset = new LinkedDataset("loggingLinkedDatasetLinkedDataset", LinkedDatasetArgs.builder()
            .linkId("mylink")
            .bucket(loggingLinkedDataset.id())
            .description("Linked dataset test")
            .build());

    }
}

resources:
  loggingLinkedDataset:
    type: gcp:logging:ProjectBucketConfig
    name: logging_linked_dataset
    properties:
      location: global
      project: my-project-name
      enableAnalytics: true
      bucketId: my-bucket
  loggingLinkedDatasetLinkedDataset:
    type: gcp:logging:LinkedDataset
    name: logging_linked_dataset
    properties:
      linkId: mylink
      bucket: ${loggingLinkedDataset.id}
      description: Linked dataset test

Logging Linked Dataset All Params

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

const loggingLinkedDataset = new gcp.logging.ProjectBucketConfig("logging_linked_dataset", {
    location: "global",
    project: "my-project-name",
    enableAnalytics: true,
    bucketId: "my-bucket",
});
const loggingLinkedDatasetLinkedDataset = new gcp.logging.LinkedDataset("logging_linked_dataset", {
    linkId: "mylink",
    bucket: "my-bucket",
    parent: "projects/my-project-name",
    location: "global",
    description: "Linked dataset test",
}, {
    dependsOn: [loggingLinkedDataset],
});

import pulumi
import pulumi_gcp as gcp

logging_linked_dataset = gcp.logging.ProjectBucketConfig("logging_linked_dataset",
    location="global",
    project="my-project-name",
    enable_analytics=True,
    bucket_id="my-bucket")
logging_linked_dataset_linked_dataset = gcp.logging.LinkedDataset("logging_linked_dataset",
    link_id="mylink",
    bucket="my-bucket",
    parent="projects/my-project-name",
    location="global",
    description="Linked dataset test",
    opts = pulumi.ResourceOptions(depends_on=[logging_linked_dataset]))

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

return await Deployment.RunAsync(() =>
{
    var loggingLinkedDataset = new Gcp.Logging.ProjectBucketConfig("logging_linked_dataset", new()
    {
        Location = "global",
        Project = "my-project-name",
        EnableAnalytics = true,
        BucketId = "my-bucket",
    });

    var loggingLinkedDatasetLinkedDataset = new Gcp.Logging.LinkedDataset("logging_linked_dataset", new()
    {
        LinkId = "mylink",
        Bucket = "my-bucket",
        Parent = "projects/my-project-name",
        Location = "global",
        Description = "Linked dataset test",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            loggingLinkedDataset,
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		loggingLinkedDataset, err := logging.NewProjectBucketConfig(ctx, "logging_linked_dataset", &logging.ProjectBucketConfigArgs{
			Location:        pulumi.String("global"),
			Project:         pulumi.String("my-project-name"),
			EnableAnalytics: pulumi.Bool(true),
			BucketId:        pulumi.String("my-bucket"),
		})
		if err != nil {
			return err
		}
		_, err = logging.NewLinkedDataset(ctx, "logging_linked_dataset", &logging.LinkedDatasetArgs{
			LinkId:      pulumi.String("mylink"),
			Bucket:      pulumi.String("my-bucket"),
			Parent:      pulumi.String("projects/my-project-name"),
			Location:    pulumi.String("global"),
			Description: pulumi.String("Linked dataset test"),
		}, pulumi.DependsOn([]pulumi.Resource{
			loggingLinkedDataset,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_logging_projectbucketconfig" "logging_linked_dataset" {
  location         = "global"
  project          = "my-project-name"
  enable_analytics = true
  bucket_id        = "my-bucket"
}
resource "gcp_logging_linkeddataset" "logging_linked_dataset" {
  depends_on  = [gcp_logging_projectbucketconfig.logging_linked_dataset]
  link_id     = "mylink"
  bucket      = "my-bucket"
  parent      = "projects/my-project-name"
  location    = "global"
  description = "Linked dataset test"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.logging.ProjectBucketConfig;
import com.pulumi.gcp.logging.ProjectBucketConfigArgs;
import com.pulumi.gcp.logging.LinkedDataset;
import com.pulumi.gcp.logging.LinkedDatasetArgs;
import com.pulumi.resources.CustomResourceOptions;
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 loggingLinkedDataset = new ProjectBucketConfig("loggingLinkedDataset", ProjectBucketConfigArgs.builder()
            .location("global")
            .project("my-project-name")
            .enableAnalytics(true)
            .bucketId("my-bucket")
            .build());

        var loggingLinkedDatasetLinkedDataset = new LinkedDataset("loggingLinkedDatasetLinkedDataset", LinkedDatasetArgs.builder()
            .linkId("mylink")
            .bucket("my-bucket")
            .parent("projects/my-project-name")
            .location("global")
            .description("Linked dataset test")
            .build(), CustomResourceOptions.builder()
                .dependsOn(loggingLinkedDataset)
                .build());

    }
}

resources:
  loggingLinkedDataset:
    type: gcp:logging:ProjectBucketConfig
    name: logging_linked_dataset
    properties:
      location: global
      project: my-project-name
      enableAnalytics: true
      bucketId: my-bucket
  loggingLinkedDatasetLinkedDataset:
    type: gcp:logging:LinkedDataset
    name: logging_linked_dataset
    properties:
      linkId: mylink
      bucket: my-bucket
      parent: projects/my-project-name
      location: global
      description: Linked dataset test
    options:
      dependsOn:
        - ${loggingLinkedDataset}

Import

LinkedDataset can be imported using any of these accepted formats:

• {{parent}}/locations/{{location}}/buckets/{{bucket}}/links/{{link_id}}

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

$ pulumi import gcp:logging/linkedDataset:LinkedDataset default {{parent}}/locations/{{location}}/buckets/{{bucket}}/links/{{link_id}}

Constructors

LinkedDataset(String name, {LinkedDatasetArgs? args, CustomResourceOptions? options})

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

LinkedDataset.reference(String urn)

Creates a typed reference to an existing LinkedDataset resource.

Properties

bigqueryDatasets ↔ Output<List<LinkedDatasetBigqueryDataset>>

The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket. Structure is documented below.

late, final

bucket ↔ Output<String>

The bucket to which the linked dataset is attached.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Output only. The creation timestamp of the link. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

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

Describes this link. The maximum length of the description is 8000 characters.

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

lifecycleState ↔ Output<String>

Output only. The linked dataset lifecycle state.

late, final

linkId ↔ Output<String>

The id of the linked dataset.

late, final

location ↔ Output<String>

The location of the linked dataset.

late, final

name ↔ Output<String>

The resource name of the linked dataset. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it.

late, final

parent ↔ Output<String>

The parent of the linked dataset.

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

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

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, {LinkedDatasetState? state, CustomResourceOptions? options}) → LinkedDataset

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