1. Pulumi Registry
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. storage
  5. BucketAccessControl
gcp logo
Google Cloud Classic v6.52.0, Mar 22 23

gcp.storage.BucketAccessControl

Bucket ACLs can be managed authoritatively using the storage_bucket_acl 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:

Example Usage

Storage Bucket Access Control Public Bucket

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var bucket = new Gcp.Storage.Bucket("bucket", new()
    {
        Location = "US",
    });

    var publicRule = new Gcp.Storage.BucketAccessControl("publicRule", new()
    {
        Bucket = bucket.Name,
        Role = "READER",
        Entity = "allUsers",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		bucket, err := storage.NewBucket(ctx, "bucket", &storage.BucketArgs{
			Location: pulumi.String("US"),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewBucketAccessControl(ctx, "publicRule", &storage.BucketAccessControlArgs{
			Bucket: bucket.Name,
			Role:   pulumi.String("READER"),
			Entity: pulumi.String("allUsers"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.storage.BucketAccessControl;
import com.pulumi.gcp.storage.BucketAccessControlArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var bucket = new Bucket("bucket", BucketArgs.builder()        
            .location("US")
            .build());

        var publicRule = new BucketAccessControl("publicRule", BucketAccessControlArgs.builder()        
            .bucket(bucket.name())
            .role("READER")
            .entity("allUsers")
            .build());

    }
}

import pulumi
import pulumi_gcp as gcp

bucket = gcp.storage.Bucket("bucket", location="US")
public_rule = gcp.storage.BucketAccessControl("publicRule",
    bucket=bucket.name,
    role="READER",
    entity="allUsers")

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const bucket = new gcp.storage.Bucket("bucket", {location: "US"});
const publicRule = new gcp.storage.BucketAccessControl("publicRule", {
    bucket: bucket.name,
    role: "READER",
    entity: "allUsers",
});

resources:
  publicRule:
    type: gcp:storage:BucketAccessControl
    properties:
      bucket: ${bucket.name}
      role: READER
      entity: allUsers
  bucket:
    type: gcp:storage:Bucket
    properties:
      location: US

Create BucketAccessControl Resource

new BucketAccessControl(name: string, args: BucketAccessControlArgs, opts?: CustomResourceOptions);
@overload
def BucketAccessControl(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        bucket: Optional[str] = None,
                        entity: Optional[str] = None,
                        role: Optional[str] = None)
@overload
def BucketAccessControl(resource_name: str,
                        args: BucketAccessControlArgs,
                        opts: Optional[ResourceOptions] = None)
func NewBucketAccessControl(ctx *Context, name string, args BucketAccessControlArgs, opts ...ResourceOption) (*BucketAccessControl, error)
public BucketAccessControl(string name, BucketAccessControlArgs args, CustomResourceOptions? opts = null)
public BucketAccessControl(String name, BucketAccessControlArgs args)
public BucketAccessControl(String name, BucketAccessControlArgs args, CustomResourceOptions options)

type: gcp:storage:BucketAccessControl
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BucketAccessControlArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args BucketAccessControlArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args BucketAccessControlArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BucketAccessControlArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BucketAccessControlArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

BucketAccessControl Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The BucketAccessControl resource accepts the following input properties:

Bucket string

The name of the bucket.

Entity string

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

Role string

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

Bucket string

The name of the bucket.

Entity string

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

Role string

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

bucket String

The name of the bucket.

entity String

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

role String

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

bucket string

The name of the bucket.

entity string

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

role string

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

bucket str

The name of the bucket.

entity str

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

role str

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

bucket String

The name of the bucket.

entity String

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

role String

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

Outputs

All input properties are implicitly available as output properties. Additionally, the BucketAccessControl resource produces the following output properties:

Domain string

The domain associated with the entity.

Email string

The email address associated with the entity.

Id string

The provider-assigned unique ID for this managed resource.

Domain string

The domain associated with the entity.

Email string

The email address associated with the entity.

Id string

The provider-assigned unique ID for this managed resource.

domain String

The domain associated with the entity.

email String

The email address associated with the entity.

id String

The provider-assigned unique ID for this managed resource.

domain string

The domain associated with the entity.

email string

The email address associated with the entity.

id string

The provider-assigned unique ID for this managed resource.

domain str

The domain associated with the entity.

email str

The email address associated with the entity.

id str

The provider-assigned unique ID for this managed resource.

domain String

The domain associated with the entity.

email String

The email address associated with the entity.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing BucketAccessControl Resource

Get an existing BucketAccessControl resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BucketAccessControlState, opts?: CustomResourceOptions): BucketAccessControl
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket: Optional[str] = None,
        domain: Optional[str] = None,
        email: Optional[str] = None,
        entity: Optional[str] = None,
        role: Optional[str] = None) -> BucketAccessControl
func GetBucketAccessControl(ctx *Context, name string, id IDInput, state *BucketAccessControlState, opts ...ResourceOption) (*BucketAccessControl, error)
public static BucketAccessControl Get(string name, Input<string> id, BucketAccessControlState? state, CustomResourceOptions? opts = null)
public static BucketAccessControl get(String name, Output<String> id, BucketAccessControlState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Bucket string

The name of the bucket.

Domain string

The domain associated with the entity.

Email string

The email address associated with the entity.

Entity string

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

Role string

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

Bucket string

The name of the bucket.

Domain string

The domain associated with the entity.

Email string

The email address associated with the entity.

Entity string

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

Role string

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

bucket String

The name of the bucket.

domain String

The domain associated with the entity.

email String

The email address associated with the entity.

entity String

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

role String

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

bucket string

The name of the bucket.

domain string

The domain associated with the entity.

email string

The email address associated with the entity.

entity string

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

role string

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

bucket str

The name of the bucket.

domain str

The domain associated with the entity.

email str

The email address associated with the entity.

entity str

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

role str

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

bucket String

The name of the bucket.

domain String

The domain associated with the entity.

email String

The email address associated with the entity.

entity String

The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user liz@example.com would be user-liz@example.com. The group example@googlegroups.com would be group-example@googlegroups.com. To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

role String

The access permission for the entity. Possible values are OWNER, READER, and WRITER.

Import

BucketAccessControl can be imported using any of these accepted formats

 $ pulumi import gcp:storage/bucketAccessControl:BucketAccessControl default {{bucket}}/{{entity}}

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.