@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
134 lines • 5.63 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! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.ObjectAccessControl = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* The ObjectAccessControls resources represent the Access Control Lists
* (ACLs) for objects within Google Cloud Storage. ACLs let you specify
* who has access to your data 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 ObjectAccessControl, see:
*
* * [API documentation](https://cloud.google.com/storage/docs/json_api/v1/objectAccessControls)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/storage/docs/access-control/create-manage-lists)
*
* ## Example Usage
*
* ### Storage Object Access Control Public Object
*
* ```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 object = new gcp.storage.BucketObject("object", {
* name: "public-object",
* bucket: bucket.name,
* source: new pulumi.asset.FileAsset("../static/img/header-logo.png"),
* });
* const publicRule = new gcp.storage.ObjectAccessControl("public_rule", {
* object: object.outputName,
* bucket: bucket.name,
* role: "READER",
* entity: "allUsers",
* });
* ```
*
* ## Import
*
* ObjectAccessControl can be imported using any of these accepted formats:
*
* * `{{bucket}}/{{object}}/{{entity}}`
*
* When using the `pulumi import` command, ObjectAccessControl can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:storage/objectAccessControl:ObjectAccessControl default {{bucket}}/{{object}}/{{entity}}
* ```
*/
class ObjectAccessControl extends pulumi.CustomResource {
/**
* Get an existing ObjectAccessControl 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 ObjectAccessControl(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of ObjectAccessControl. 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'] === ObjectAccessControl.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["bucket"] = state?.bucket;
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?.object === undefined && !opts.urn) {
throw new Error("Missing required property 'object'");
}
if (args?.role === undefined && !opts.urn) {
throw new Error("Missing required property 'role'");
}
resourceInputs["bucket"] = args?.bucket;
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(ObjectAccessControl.__pulumiType, name, resourceInputs, opts);
}
}
exports.ObjectAccessControl = ObjectAccessControl;
/** @internal */
ObjectAccessControl.__pulumiType = 'gcp:storage/objectAccessControl:ObjectAccessControl';
//# sourceMappingURL=objectAccessControl.js.map