@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
195 lines • 7.74 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A logical view object that can be referenced in SQL queries.
*
* To get more information about LogicalView, see:
*
* * [API documentation](https://cloud.google.com/bigtable/docs/reference/admin/rest/v2/projects.instances.logicalViews)
*
* ## Example Usage
*
* ### Bigtable Logical 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: false,
* });
* const table = new gcp.bigtable.Table("table", {
* name: "bt-table",
* instanceName: instance.name,
* columnFamilies: [{
* family: "CF",
* }],
* });
* const logicalView = new gcp.bigtable.LogicalView("logical_view", {
* logicalViewId: "bt-logical-view",
* instance: instance.name,
* deletionProtection: false,
* query: `SELECT _key, CF
* FROM \` + \\"\`bt-table\`\\" + \`
* `,
* }, {
* dependsOn: [table],
* });
* ```
*
* ## Import
*
* LogicalView can be imported using any of these accepted formats:
*
* * `projects/{{project}}/instances/{{instance}}/logicalViews/{{logical_view_id}}`
* * `{{project}}/{{instance}}/{{logical_view_id}}`
* * `{{instance}}/{{logical_view_id}}`
*
* When using the `pulumi import` command, LogicalView can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:bigtable/logicalView:LogicalView default projects/{{project}}/instances/{{instance}}/logicalViews/{{logical_view_id}}
* $ pulumi import gcp:bigtable/logicalView:LogicalView default {{project}}/{{instance}}/{{logical_view_id}}
* $ pulumi import gcp:bigtable/logicalView:LogicalView default {{instance}}/{{logical_view_id}}
* ```
*/
export declare class LogicalView extends pulumi.CustomResource {
/**
* Get an existing LogicalView 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?: LogicalViewState, opts?: pulumi.CustomResourceOptions): LogicalView;
/**
* Returns true if the given object is an instance of LogicalView. 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 LogicalView;
/**
* 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.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* Set to true to make the logical view protected against deletion.
*/
readonly deletionProtection: pulumi.Output<boolean | undefined>;
/**
* The name of the instance to create the logical view within.
*/
readonly instance: pulumi.Output<string | undefined>;
/**
* The unique name of the logical view in the form `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
*/
readonly logicalViewId: pulumi.Output<string>;
/**
* The unique name of the requested logical view. Values are of the form `projects/<project>/instances/<instance>/logicalViews/<logicalViewId>`.
*/
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 logical view's select query.
*/
readonly query: pulumi.Output<string>;
/**
* Create a LogicalView 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: LogicalViewArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LogicalView resources.
*/
export interface LogicalViewState {
/**
* 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.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Set to true to make the logical view protected against deletion.
*/
deletionProtection?: pulumi.Input<boolean | undefined>;
/**
* The name of the instance to create the logical view within.
*/
instance?: pulumi.Input<string | undefined>;
/**
* The unique name of the logical view in the form `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
*/
logicalViewId?: pulumi.Input<string | undefined>;
/**
* The unique name of the requested logical view. Values are of the form `projects/<project>/instances/<instance>/logicalViews/<logicalViewId>`.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The logical view's select query.
*/
query?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a LogicalView resource.
*/
export interface LogicalViewArgs {
/**
* 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.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Set to true to make the logical view protected against deletion.
*/
deletionProtection?: pulumi.Input<boolean | undefined>;
/**
* The name of the instance to create the logical view within.
*/
instance?: pulumi.Input<string | undefined>;
/**
* The unique name of the logical view in the form `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
*/
logicalViewId: 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 | undefined>;
/**
* The logical view's select query.
*/
query: pulumi.Input<string>;
}
//# sourceMappingURL=logicalView.d.ts.map