@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
177 lines (176 loc) • 6.34 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A materialized view object that can be referenced in SQL queries.
*
* To get more information about MaterializedView, see:
*
* * [API documentation](https://cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.materializedViews)
*
* ## Example Usage
*
* ### Bigtable Materialized View
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const instance = new gcp.bigtable.Instance("instance", {
* name: "bt-instance",
* clusters: [{
* clusterId: "cluster-1",
* zone: "us-east1-b",
* numNodes: 3,
* storageType: "HDD",
* }],
* deletionProtection: true,
* });
* const table = new gcp.bigtable.Table("table", {
* name: "bt-table",
* instanceName: instance.name,
* columnFamilies: [{
* family: "CF",
* }],
* });
* const materializedView = new gcp.bigtable.MaterializedView("materialized_view", {
* materializedViewId: "bt-materialized-view",
* instance: instance.name,
* deletionProtection: false,
* query: `SELECT _key, COUNT(CF['col1']) as Count
* FROM \` + "\`bt-table\`" + \`
* GROUP BY _key
* `,
* }, {
* dependsOn: [table],
* });
* ```
*
* ## Import
*
* MaterializedView can be imported using any of these accepted formats:
*
* * `projects/{{project}}/instances/{{instance}}/materializedViews/{{materialized_view_id}}`
*
* * `{{project}}/{{instance}}/{{materialized_view_id}}`
*
* * `{{instance}}/{{materialized_view_id}}`
*
* When using the `pulumi import` command, MaterializedView can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:bigtable/materializedView:MaterializedView default projects/{{project}}/instances/{{instance}}/materializedViews/{{materialized_view_id}}
* ```
*
* ```sh
* $ pulumi import gcp:bigtable/materializedView:MaterializedView default {{project}}/{{instance}}/{{materialized_view_id}}
* ```
*
* ```sh
* $ pulumi import gcp:bigtable/materializedView:MaterializedView default {{instance}}/{{materialized_view_id}}
* ```
*/
export declare class MaterializedView extends pulumi.CustomResource {
/**
* Get an existing MaterializedView 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?: MaterializedViewState, opts?: pulumi.CustomResourceOptions): MaterializedView;
/**
* Returns true if the given object is an instance of MaterializedView. 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 MaterializedView;
/**
* Set to true to make the MaterializedView protected against deletion.
*/
readonly deletionProtection: pulumi.Output<boolean | undefined>;
/**
* The name of the instance to create the materialized view within.
*/
readonly instance: pulumi.Output<string | undefined>;
/**
* The unique name of the materialized view in the form `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
*/
readonly materializedViewId: pulumi.Output<string>;
/**
* The unique name of the requested materialized view. Values are of the form `projects/<project>/instances/<instance>/materializedViews/<materializedViewId>`.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The materialized view's select query.
*/
readonly query: pulumi.Output<string>;
/**
* Create a MaterializedView 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: MaterializedViewArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MaterializedView resources.
*/
export interface MaterializedViewState {
/**
* Set to true to make the MaterializedView protected against deletion.
*/
deletionProtection?: pulumi.Input<boolean>;
/**
* The name of the instance to create the materialized view within.
*/
instance?: pulumi.Input<string>;
/**
* The unique name of the materialized view in the form `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
*/
materializedViewId?: pulumi.Input<string>;
/**
* The unique name of the requested materialized view. Values are of the form `projects/<project>/instances/<instance>/materializedViews/<materializedViewId>`.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The materialized view's select query.
*/
query?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MaterializedView resource.
*/
export interface MaterializedViewArgs {
/**
* Set to true to make the MaterializedView protected against deletion.
*/
deletionProtection?: pulumi.Input<boolean>;
/**
* The name of the instance to create the materialized view within.
*/
instance?: pulumi.Input<string>;
/**
* The unique name of the materialized view in the form `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
*/
materializedViewId: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The materialized view's select query.
*/
query: pulumi.Input<string>;
}