@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
219 lines • 8.4 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.SavedQuery = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* Describes a query that has been saved by a user.
*
* To get more information about SavedQuery, see:
*
* * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.locations.savedQueries)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/logging/docs/apis)
* * [Save and share SQL queries](https://docs.cloud.google.com/logging/docs/analyze/save-share-query)
* * [Save and share queries](https://docs.cloud.google.com/logging/docs/view/building-queries#saved-queries)
*
* ## Example Usage
*
* ### Logging Saved Query Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const savedQuery = new gcp.logging.SavedQuery("saved_query", {
* name: "my-saved-query",
* displayName: "My Saved Query",
* parent: "projects/my-project-name",
* location: "global",
* description: "A saved query",
* loggingQuery: {
* filter: "resource.type=gce_instance",
* },
* visibility: "SHARED",
* });
* ```
* ### Logging Saved Query Private
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const savedQuery = new gcp.logging.SavedQuery("saved_query", {
* name: "my-saved-query-private",
* displayName: "My Saved Query",
* parent: "projects/my-project-name",
* location: "global",
* description: "A saved query",
* loggingQuery: {
* filter: "resource.type=gce_instance",
* },
* visibility: "PRIVATE",
* });
* ```
* ### Logging Saved Query Summary Fields
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const savedQuery = new gcp.logging.SavedQuery("saved_query", {
* name: "my-saved-query-summary-fields",
* displayName: "My Saved Query",
* parent: "projects/my-project-name",
* location: "global",
* description: "A saved query",
* loggingQuery: {
* filter: "resource.type=gce_instance",
* summaryFields: [
* {
* field: "jsonPayload.paymentId",
* },
* {
* field: "jsonPayload.errorMessage",
* },
* ],
* summaryFieldStart: 100,
* },
* visibility: "SHARED",
* });
* ```
* ### Logging Saved Query Sql Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const savedQuery = new gcp.logging.SavedQuery("saved_query", {
* name: "my-saved-query-sql",
* displayName: "My Saved Query",
* parent: "projects/my-project-name",
* location: "global",
* description: "A saved query",
* opsAnalyticsQuery: {
* sqlQueryText: `SELECT
* timestamp, log_name, severity, json_payload, resource, labels
* FROM
* VIEW
* WHERE
* timestamp > TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR)
* ORDER BY timestamp ASC
* LIMIT 100
* `,
* },
* visibility: "SHARED",
* });
* ```
*
* ## Import
*
* SavedQuery can be imported using any of these accepted formats:
*
* * `{{parent}}/locations/{{location}}/savedQueries/{{name}}`
*
* When using the `pulumi import` command, SavedQuery can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:logging/savedQuery:SavedQuery default {{parent}}/locations/{{location}}/savedQueries/{{name}}
* ```
*/
class SavedQuery extends pulumi.CustomResource {
/**
* Get an existing SavedQuery 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, id, state, opts) {
return new SavedQuery(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:logging/savedQuery:SavedQuery';
/**
* Returns true if the given object is an instance of SavedQuery. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === SavedQuery.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["description"] = state?.description;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["location"] = state?.location;
resourceInputs["loggingQuery"] = state?.loggingQuery;
resourceInputs["name"] = state?.name;
resourceInputs["opsAnalyticsQuery"] = state?.opsAnalyticsQuery;
resourceInputs["parent"] = state?.parent;
resourceInputs["updateTime"] = state?.updateTime;
resourceInputs["visibility"] = state?.visibility;
}
else {
const args = argsOrState;
if (args?.displayName === undefined && !opts.urn) {
throw new Error("Missing required property 'displayName'");
}
if (args?.location === undefined && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if (args?.parent === undefined && !opts.urn) {
throw new Error("Missing required property 'parent'");
}
if (args?.visibility === undefined && !opts.urn) {
throw new Error("Missing required property 'visibility'");
}
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["description"] = args?.description;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["location"] = args?.location;
resourceInputs["loggingQuery"] = args?.loggingQuery;
resourceInputs["name"] = args?.name;
resourceInputs["opsAnalyticsQuery"] = args?.opsAnalyticsQuery;
resourceInputs["parent"] = args?.parent;
resourceInputs["visibility"] = args?.visibility;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(SavedQuery.__pulumiType, name, resourceInputs, opts);
}
}
exports.SavedQuery = SavedQuery;
//# sourceMappingURL=savedQuery.js.map