@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
346 lines (345 loc) • 12.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Three different resources help you manage your IAM policy for Cloud Storage Bucket. Each of these resources serves a different use case:
*
* * `gcp.storage.BucketIAMPolicy`: Authoritative. Sets the IAM policy for the bucket and replaces any existing policy already attached.
* * `gcp.storage.BucketIAMBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the bucket are preserved.
* * `gcp.storage.BucketIAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the bucket are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.storage.BucketIAMPolicy`: Retrieves the IAM policy for the bucket
*
* > **Note:** `gcp.storage.BucketIAMPolicy` **cannot** be used in conjunction with `gcp.storage.BucketIAMBinding` and `gcp.storage.BucketIAMMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.storage.BucketIAMBinding` resources **can be** used in conjunction with `gcp.storage.BucketIAMMember` resources **only if** they do not grant privilege to the same role.
*
* > **Note:** This resource supports IAM Conditions but they have some known limitations which can be found [here](https://cloud.google.com/iam/docs/conditions-overview#limitations). Please review this article if you are having issues with IAM Conditions.
*
* ## gcp.storage.BucketIAMPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/storage.admin",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.storage.BucketIAMPolicy("policy", {
* bucket: _default.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/storage.admin",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* }],
* });
* const policy = new gcp.storage.BucketIAMPolicy("policy", {
* bucket: _default.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
* ## gcp.storage.BucketIAMBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.storage.BucketIAMBinding("binding", {
* bucket: _default.name,
* role: "roles/storage.admin",
* members: ["user:jane@example.com"],
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.storage.BucketIAMBinding("binding", {
* bucket: _default.name,
* role: "roles/storage.admin",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
* ## gcp.storage.BucketIAMMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.storage.BucketIAMMember("member", {
* bucket: _default.name,
* role: "roles/storage.admin",
* member: "user:jane@example.com",
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.storage.BucketIAMMember("member", {
* bucket: _default.name,
* role: "roles/storage.admin",
* member: "user:jane@example.com",
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
*
* ## This resource supports User Project Overrides.
*
* -
*
* # IAM policy for Cloud Storage Bucket
* Three different resources help you manage your IAM policy for Cloud Storage Bucket. Each of these resources serves a different use case:
*
* * `gcp.storage.BucketIAMPolicy`: Authoritative. Sets the IAM policy for the bucket and replaces any existing policy already attached.
* * `gcp.storage.BucketIAMBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the bucket are preserved.
* * `gcp.storage.BucketIAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the bucket are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.storage.BucketIAMPolicy`: Retrieves the IAM policy for the bucket
*
* > **Note:** `gcp.storage.BucketIAMPolicy` **cannot** be used in conjunction with `gcp.storage.BucketIAMBinding` and `gcp.storage.BucketIAMMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.storage.BucketIAMBinding` resources **can be** used in conjunction with `gcp.storage.BucketIAMMember` resources **only if** they do not grant privilege to the same role.
*
* > **Note:** This resource supports IAM Conditions but they have some known limitations which can be found [here](https://cloud.google.com/iam/docs/conditions-overview#limitations). Please review this article if you are having issues with IAM Conditions.
*
* ## gcp.storage.BucketIAMPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/storage.admin",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.storage.BucketIAMPolicy("policy", {
* bucket: _default.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/storage.admin",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* }],
* });
* const policy = new gcp.storage.BucketIAMPolicy("policy", {
* bucket: _default.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
* ## gcp.storage.BucketIAMBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.storage.BucketIAMBinding("binding", {
* bucket: _default.name,
* role: "roles/storage.admin",
* members: ["user:jane@example.com"],
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.storage.BucketIAMBinding("binding", {
* bucket: _default.name,
* role: "roles/storage.admin",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
* ## gcp.storage.BucketIAMMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.storage.BucketIAMMember("member", {
* bucket: _default.name,
* role: "roles/storage.admin",
* member: "user:jane@example.com",
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.storage.BucketIAMMember("member", {
* bucket: _default.name,
* role: "roles/storage.admin",
* member: "user:jane@example.com",
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
*
* ## Import
*
* For all import syntaxes, the "resource in question" can take any of the following forms:
*
* * b/{{name}}
*
* * {{name}}
*
* Any variables not passed in the import command will be taken from the provider configuration.
*
* Cloud Storage bucket IAM resources can be imported using the resource identifiers, role, and member.
*
* IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.
*
* ```sh
* $ pulumi import gcp:storage/bucketIAMPolicy:BucketIAMPolicy editor "b/{{bucket}} roles/storage.objectViewer user:jane@example.com"
* ```
*
* IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
*
* ```sh
* $ pulumi import gcp:storage/bucketIAMPolicy:BucketIAMPolicy editor "b/{{bucket}} roles/storage.objectViewer"
* ```
*
* IAM policy imports use the identifier of the resource in question, e.g.
*
* ```sh
* $ pulumi import gcp:storage/bucketIAMPolicy:BucketIAMPolicy editor b/{{bucket}}
* ```
*
* -> **Custom Roles** If you're importing a IAM resource with a custom role, make sure to use the
*
* full name of the custom role, e.g. `[projects/my-project|organizations/my-org]/roles/my-custom-role`.
*/
export declare class BucketIAMPolicy extends pulumi.CustomResource {
/**
* Get an existing BucketIAMPolicy 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?: BucketIAMPolicyState, opts?: pulumi.CustomResourceOptions): BucketIAMPolicy;
/**
* Returns true if the given object is an instance of BucketIAMPolicy. 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 BucketIAMPolicy;
/**
* Used to find the parent resource to bind the IAM policy to
*/
readonly bucket: pulumi.Output<string>;
/**
* (Computed) The etag of the IAM policy.
*/
readonly etag: pulumi.Output<string>;
/**
* The policy data generated by
* a `gcp.organizations.getIAMPolicy` data source.
*/
readonly policyData: pulumi.Output<string>;
/**
* Create a BucketIAMPolicy 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: BucketIAMPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BucketIAMPolicy resources.
*/
export interface BucketIAMPolicyState {
/**
* Used to find the parent resource to bind the IAM policy to
*/
bucket?: pulumi.Input<string>;
/**
* (Computed) The etag of the IAM policy.
*/
etag?: pulumi.Input<string>;
/**
* The policy data generated by
* a `gcp.organizations.getIAMPolicy` data source.
*/
policyData?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a BucketIAMPolicy resource.
*/
export interface BucketIAMPolicyArgs {
/**
* Used to find the parent resource to bind the IAM policy to
*/
bucket: pulumi.Input<string>;
/**
* The policy data generated by
* a `gcp.organizations.getIAMPolicy` data source.
*/
policyData: pulumi.Input<string>;
}