@pulumi/gcp/storage/objectAccessControl.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * 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}}
 * ```
 */
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: ObjectAccessControlState, opts?: pulumi.CustomResourceOptions): ObjectAccessControl;
    /**
     * 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: any): obj is ObjectAccessControl;
    /**
     * The name of the bucket.
     */
    readonly bucket: pulumi.Output<string>;
    /**
     * The domain associated with the entity.
     */
    readonly domain: pulumi.Output<string>;
    /**
     * The email address associated with the entity.
     */
    readonly email: pulumi.Output<string>;
    /**
     * The entity holding the permission, in one of the following forms:
     * * user-{{userId}}
     * * user-{{email}} (such as "user-liz@example.com")
     * * group-{{groupId}}
     * * group-{{email}} (such as "group-example@googlegroups.com")
     * * domain-{{domain}} (such as "domain-example.com")
     * * project-team-{{projectId}}
     * * allUsers
     * * allAuthenticatedUsers
     */
    readonly entity: pulumi.Output<string>;
    /**
     * The ID for the entity
     */
    readonly entityId: pulumi.Output<string>;
    /**
     * The content generation of the object, if applied to an object.
     */
    readonly generation: pulumi.Output<number>;
    /**
     * The name of the object to apply the access control to.
     */
    readonly object: pulumi.Output<string>;
    /**
     * The project team associated with the entity
     * Structure is documented below.
     */
    readonly projectTeams: pulumi.Output<outputs.storage.ObjectAccessControlProjectTeam[]>;
    /**
     * The access permission for the entity.
     * Possible values are: `OWNER`, `READER`.
     */
    readonly role: pulumi.Output<string>;
    /**
     * Create a ObjectAccessControl resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: ObjectAccessControlArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ObjectAccessControl resources.
 */
export interface ObjectAccessControlState {
    /**
     * The name of the bucket.
     */
    bucket?: pulumi.Input<string>;
    /**
     * The domain associated with the entity.
     */
    domain?: pulumi.Input<string>;
    /**
     * The email address associated with the entity.
     */
    email?: pulumi.Input<string>;
    /**
     * The entity holding the permission, in one of the following forms:
     * * user-{{userId}}
     * * user-{{email}} (such as "user-liz@example.com")
     * * group-{{groupId}}
     * * group-{{email}} (such as "group-example@googlegroups.com")
     * * domain-{{domain}} (such as "domain-example.com")
     * * project-team-{{projectId}}
     * * allUsers
     * * allAuthenticatedUsers
     */
    entity?: pulumi.Input<string>;
    /**
     * The ID for the entity
     */
    entityId?: pulumi.Input<string>;
    /**
     * The content generation of the object, if applied to an object.
     */
    generation?: pulumi.Input<number>;
    /**
     * The name of the object to apply the access control to.
     */
    object?: pulumi.Input<string>;
    /**
     * The project team associated with the entity
     * Structure is documented below.
     */
    projectTeams?: pulumi.Input<pulumi.Input<inputs.storage.ObjectAccessControlProjectTeam>[]>;
    /**
     * The access permission for the entity.
     * Possible values are: `OWNER`, `READER`.
     */
    role?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a ObjectAccessControl resource.
 */
export interface ObjectAccessControlArgs {
    /**
     * The name of the bucket.
     */
    bucket: pulumi.Input<string>;
    /**
     * The entity holding the permission, in one of the following forms:
     * * user-{{userId}}
     * * user-{{email}} (such as "user-liz@example.com")
     * * group-{{groupId}}
     * * group-{{email}} (such as "group-example@googlegroups.com")
     * * domain-{{domain}} (such as "domain-example.com")
     * * project-team-{{projectId}}
     * * allUsers
     * * allAuthenticatedUsers
     */
    entity: pulumi.Input<string>;
    /**
     * The name of the object to apply the access control to.
     */
    object: pulumi.Input<string>;
    /**
     * The access permission for the entity.
     * Possible values are: `OWNER`, `READER`.
     */
    role: pulumi.Input<string>;
}