UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

116 lines 5.62 kB
"use strict"; // *** 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.BillingAccountSink = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("../utilities"); /** * * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/billingAccounts.sinks) * * How-to Guides * * [Exporting Logs](https://cloud.google.com/logging/docs/export) * * > **Note** You must have the "Logs Configuration Writer" IAM role (`roles/logging.configWriter`) * [granted on the billing account](https://cloud.google.com/billing/reference/rest/v1/billingAccounts/getIamPolicy) to * the credentials used with this provider. [IAM roles granted on a billing account](https://cloud.google.com/billing/docs/how-to/billing-access) are separate from the * typical IAM roles granted on a project. * * ## 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: "billing-logging-bucket", * location: "US", * }); * const my_sink = new gcp.logging.BillingAccountSink("my-sink", { * name: "my-sink", * description: "some explanation on what this is", * billingAccount: "ABCDEF-012345-GHIJKL", * destination: pulumi.interpolate`storage.googleapis.com/${log_bucket.name}`, * }); * const log_writer = new gcp.projects.IAMBinding("log-writer", { * project: "your-project-id", * role: "roles/storage.objectCreator", * members: [my_sink.writerIdentity], * }); * ``` * * ## Import * * Billing account logging sinks can be imported using this format: * * * `billingAccounts/{{billing_account_id}}/sinks/{{sink_id}}` * * When using the `pulumi import` command, billing account logging sinks can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:logging/billingAccountSink:BillingAccountSink default billingAccounts/{{billing_account_id}}/sinks/{{sink_id}} * ``` */ class BillingAccountSink extends pulumi.CustomResource { /** * Get an existing BillingAccountSink 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 BillingAccountSink(name, state, Object.assign(Object.assign({}, opts), { id: id })); } /** * Returns true if the given object is an instance of BillingAccountSink. 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'] === BillingAccountSink.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["bigqueryOptions"] = state ? state.bigqueryOptions : undefined; resourceInputs["billingAccount"] = state ? state.billingAccount : 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["name"] = state ? state.name : undefined; resourceInputs["writerIdentity"] = state ? state.writerIdentity : undefined; } else { const args = argsOrState; if ((!args || args.billingAccount === undefined) && !opts.urn) { throw new Error("Missing required property 'billingAccount'"); } if ((!args || args.destination === undefined) && !opts.urn) { throw new Error("Missing required property 'destination'"); } resourceInputs["bigqueryOptions"] = args ? args.bigqueryOptions : undefined; resourceInputs["billingAccount"] = args ? args.billingAccount : 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["name"] = args ? args.name : undefined; resourceInputs["writerIdentity"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(BillingAccountSink.__pulumiType, name, resourceInputs, opts); } } exports.BillingAccountSink = BillingAccountSink; /** @internal */ BillingAccountSink.__pulumiType = 'gcp:logging/billingAccountSink:BillingAccountSink'; //# sourceMappingURL=billingAccountSink.js.map