UNPKG

@pulumi/gcp

Version:

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

151 lines 6.64 kB
"use strict"; // *** 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.DefaultObjectAccessControl = void 0; const pulumi = __importStar(require("@pulumi/pulumi")); const utilities = __importStar(require("../utilities")); /** * The DefaultObjectAccessControls resources represent the Access Control * Lists (ACLs) applied to a new object within a Google Cloud Storage bucket * when no ACL was provided for that object. ACLs let you specify who has * access to your bucket contents and to what extent. * * There are two roles that can be assigned to an entity: * * READERs can get an object, though the acl property will not be revealed. * OWNERs are READERs, and they can get the acl property, update an object, * and call all objectAccessControls methods on the object. The owner of an * object is always an OWNER. * For more information, see Access Control, with the caveat that this API * uses READER and OWNER instead of READ and FULL_CONTROL. * * To get more information about DefaultObjectAccessControl, see: * * * [API documentation](https://cloud.google.com/storage/docs/json_api/v1/defaultObjectAccessControls) * * How-to Guides * * [Official Documentation](https://cloud.google.com/storage/docs/access-control/create-manage-lists) * * ## Example Usage * * ### Storage Default Object Access Control Public * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const bucket = new gcp.storage.Bucket("bucket", { * name: "static-content-bucket", * location: "US", * }); * const publicRule = new gcp.storage.DefaultObjectAccessControl("public_rule", { * bucket: bucket.name, * role: "READER", * entity: "allUsers", * }); * ``` * * ## Import * * DefaultObjectAccessControl can be imported using any of these accepted formats: * * * `{{bucket}}/{{entity}}` * * When using the `pulumi import` command, DefaultObjectAccessControl can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:storage/defaultObjectAccessControl:DefaultObjectAccessControl default {{bucket}}/{{entity}} * ``` */ class DefaultObjectAccessControl extends pulumi.CustomResource { /** * Get an existing DefaultObjectAccessControl 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 DefaultObjectAccessControl(name, state, { ...opts, id: id }); } /** @internal */ static __pulumiType = 'gcp:storage/defaultObjectAccessControl:DefaultObjectAccessControl'; /** * Returns true if the given object is an instance of DefaultObjectAccessControl. 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'] === DefaultObjectAccessControl.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["bucket"] = state?.bucket; resourceInputs["deletionPolicy"] = state?.deletionPolicy; resourceInputs["domain"] = state?.domain; resourceInputs["email"] = state?.email; resourceInputs["entity"] = state?.entity; resourceInputs["entityId"] = state?.entityId; resourceInputs["generation"] = state?.generation; resourceInputs["object"] = state?.object; resourceInputs["projectTeams"] = state?.projectTeams; resourceInputs["role"] = state?.role; } else { const args = argsOrState; if (args?.bucket === undefined && !opts.urn) { throw new Error("Missing required property 'bucket'"); } if (args?.entity === undefined && !opts.urn) { throw new Error("Missing required property 'entity'"); } if (args?.role === undefined && !opts.urn) { throw new Error("Missing required property 'role'"); } resourceInputs["bucket"] = args?.bucket; resourceInputs["deletionPolicy"] = args?.deletionPolicy; resourceInputs["entity"] = args?.entity; resourceInputs["object"] = args?.object; resourceInputs["role"] = args?.role; resourceInputs["domain"] = undefined /*out*/; resourceInputs["email"] = undefined /*out*/; resourceInputs["entityId"] = undefined /*out*/; resourceInputs["generation"] = undefined /*out*/; resourceInputs["projectTeams"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(DefaultObjectAccessControl.__pulumiType, name, resourceInputs, opts); } } exports.DefaultObjectAccessControl = DefaultObjectAccessControl; //# sourceMappingURL=defaultObjectAccessControl.js.map