@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
118 lines • 4.88 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.BucketAccessControl = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Bucket ACLs can be managed authoritatively using the
* `storageBucketAcl` resource. Do not use these two resources in conjunction to manage the same bucket.
*
* The BucketAccessControls resource manages the Access Control List
* (ACLs) for a single entity/role pairing on a bucket. ACLs let you specify who
* has access to your data and to what extent.
*
* There are three roles that can be assigned to an entity:
*
* READERs can get the bucket, though no acl property will be returned, and
* list the bucket's objects. WRITERs are READERs, and they can insert
* objects into the bucket and delete the bucket's objects. OWNERs are
* WRITERs, and they can get the acl property of a bucket, update a bucket,
* and call all BucketAccessControls methods on the bucket. For more
* information, see Access Control, with the caveat that this API uses
* READER, WRITER, and OWNER instead of READ, WRITE, and FULL_CONTROL.
*
* To get more information about BucketAccessControl, see:
*
* * [API documentation](https://cloud.google.com/storage/docs/json_api/v1/bucketAccessControls)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/storage/docs/access-control/lists)
*
* ## Example Usage
*
* ### Storage Bucket Access Control Public Bucket
*
* ```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.BucketAccessControl("public_rule", {
* bucket: bucket.name,
* role: "READER",
* entity: "allUsers",
* });
* ```
*
* ## Import
*
* BucketAccessControl can be imported using any of these accepted formats:
*
* * `{{bucket}}/{{entity}}`
*
* When using the `pulumi import` command, BucketAccessControl can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:storage/bucketAccessControl:BucketAccessControl default {{bucket}}/{{entity}}
* ```
*/
class BucketAccessControl extends pulumi.CustomResource {
/**
* Get an existing BucketAccessControl 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 BucketAccessControl(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of BucketAccessControl. 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'] === BucketAccessControl.__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["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'");
}
resourceInputs["bucket"] = args?.bucket;
resourceInputs["entity"] = args?.entity;
resourceInputs["role"] = args?.role;
resourceInputs["domain"] = undefined /*out*/;
resourceInputs["email"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(BucketAccessControl.__pulumiType, name, resourceInputs, opts);
}
}
exports.BucketAccessControl = BucketAccessControl;
/** @internal */
BucketAccessControl.__pulumiType = 'gcp:storage/bucketAccessControl:BucketAccessControl';
//# sourceMappingURL=bucketAccessControl.js.map