@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
121 lines • 5.59 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.FolderSink = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Manages a folder-level logging sink. For more information see:
* * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/folders.sinks)
* * How-to Guides
* * [Exporting Logs](https://cloud.google.com/logging/docs/export)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const log_bucket = new gcp.storage.Bucket("log-bucket", {
* name: "folder-logging-bucket",
* location: "US",
* });
* const my_folder = new gcp.organizations.Folder("my-folder", {
* displayName: "My folder",
* parent: "organizations/123456",
* });
* const my_sink = new gcp.logging.FolderSink("my-sink", {
* name: "my-sink",
* description: "some explanation on what this is",
* folder: my_folder.name,
* destination: pulumi.interpolate`storage.googleapis.com/${log_bucket.name}`,
* filter: "resource.type = gce_instance AND severity >= WARNING",
* });
* const log_writer = new gcp.projects.IAMBinding("log-writer", {
* project: "your-project-id",
* role: "roles/storage.objectCreator",
* members: [my_sink.writerIdentity],
* });
* ```
*
* ## Import
*
* Folder-level logging sinks can be imported using this format:
*
* * `folders/{{folder_id}}/sinks/{{name}}`
*
* When using the `pulumi import` command, folder-level logging sinks can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:logging/folderSink:FolderSink default folders/{{folder_id}}/sinks/{{name}}
* ```
*/
class FolderSink extends pulumi.CustomResource {
/**
* Get an existing FolderSink 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 FolderSink(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of FolderSink. 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'] === FolderSink.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["bigqueryOptions"] = state ? state.bigqueryOptions : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["destination"] = state ? state.destination : undefined;
resourceInputs["disabled"] = state ? state.disabled : undefined;
resourceInputs["exclusions"] = state ? state.exclusions : undefined;
resourceInputs["filter"] = state ? state.filter : undefined;
resourceInputs["folder"] = state ? state.folder : undefined;
resourceInputs["includeChildren"] = state ? state.includeChildren : undefined;
resourceInputs["interceptChildren"] = state ? state.interceptChildren : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["writerIdentity"] = state ? state.writerIdentity : undefined;
}
else {
const args = argsOrState;
if ((!args || args.destination === undefined) && !opts.urn) {
throw new Error("Missing required property 'destination'");
}
if ((!args || args.folder === undefined) && !opts.urn) {
throw new Error("Missing required property 'folder'");
}
resourceInputs["bigqueryOptions"] = args ? args.bigqueryOptions : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["destination"] = args ? args.destination : undefined;
resourceInputs["disabled"] = args ? args.disabled : undefined;
resourceInputs["exclusions"] = args ? args.exclusions : undefined;
resourceInputs["filter"] = args ? args.filter : undefined;
resourceInputs["folder"] = args ? args.folder : undefined;
resourceInputs["includeChildren"] = args ? args.includeChildren : undefined;
resourceInputs["interceptChildren"] = args ? args.interceptChildren : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["writerIdentity"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(FolderSink.__pulumiType, name, resourceInputs, opts);
}
}
exports.FolderSink = FolderSink;
/** @internal */
FolderSink.__pulumiType = 'gcp:logging/folderSink:FolderSink';
//# sourceMappingURL=folderSink.js.map