@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
223 lines (222 loc) • 8.14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Describes a BigQuery linked dataset
*
* To get more information about LinkedDataset, see:
*
* * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/locations.buckets.links)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/logging/docs/apis)
*
* ## Example Usage
*
* ### Logging Linked Dataset Basic
*
* ```typescript
* 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",
* });
* ```
* ### Logging Linked Dataset All Params
*
* ```typescript
* 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
*
* 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:
*
* ```sh
* $ pulumi import gcp:logging/linkedDataset:LinkedDataset default {{parent}}/locations/{{location}}/buckets/{{bucket}}/links/{{link_id}}
* ```
*/
export declare class LinkedDataset extends pulumi.CustomResource {
/**
* Get an existing LinkedDataset resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LinkedDatasetState, opts?: pulumi.CustomResourceOptions): LinkedDataset;
/**
* Returns true if the given object is an instance of LinkedDataset. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is LinkedDataset;
/**
* 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.
*/
readonly bigqueryDatasets: pulumi.Output<outputs.logging.LinkedDatasetBigqueryDataset[]>;
/**
* The bucket to which the linked dataset is attached.
*
*
* - - -
*/
readonly bucket: pulumi.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".
*/
readonly createTime: pulumi.Output<string>;
/**
* Describes this link. The maximum length of the description is 8000 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Output only. The linked dataset lifecycle state.
*/
readonly lifecycleState: pulumi.Output<string>;
/**
* The id of the linked dataset.
*/
readonly linkId: pulumi.Output<string>;
/**
* The location of the linked dataset.
*/
readonly location: pulumi.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.
*/
readonly name: pulumi.Output<string>;
/**
* The parent of the linked dataset.
*/
readonly parent: pulumi.Output<string>;
/**
* Create a LinkedDataset resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: LinkedDatasetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LinkedDataset resources.
*/
export interface LinkedDatasetState {
/**
* 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.
*/
bigqueryDatasets?: pulumi.Input<pulumi.Input<inputs.logging.LinkedDatasetBigqueryDataset>[]>;
/**
* The bucket to which the linked dataset is attached.
*
*
* - - -
*/
bucket?: pulumi.Input<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".
*/
createTime?: pulumi.Input<string>;
/**
* Describes this link. The maximum length of the description is 8000 characters.
*/
description?: pulumi.Input<string>;
/**
* Output only. The linked dataset lifecycle state.
*/
lifecycleState?: pulumi.Input<string>;
/**
* The id of the linked dataset.
*/
linkId?: pulumi.Input<string>;
/**
* The location of the linked dataset.
*/
location?: pulumi.Input<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.
*/
name?: pulumi.Input<string>;
/**
* The parent of the linked dataset.
*/
parent?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a LinkedDataset resource.
*/
export interface LinkedDatasetArgs {
/**
* 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.
*/
bigqueryDatasets?: pulumi.Input<pulumi.Input<inputs.logging.LinkedDatasetBigqueryDataset>[]>;
/**
* The bucket to which the linked dataset is attached.
*
*
* - - -
*/
bucket: pulumi.Input<string>;
/**
* Describes this link. The maximum length of the description is 8000 characters.
*/
description?: pulumi.Input<string>;
/**
* The id of the linked dataset.
*/
linkId: pulumi.Input<string>;
/**
* The location of the linked dataset.
*/
location?: pulumi.Input<string>;
/**
* The parent of the linked dataset.
*/
parent?: pulumi.Input<string>;
}