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:

API documentation
How-to Guides
- Official Documentation

Create a BucketAccessControl Resource

new BucketAccessControl(name: string, args: BucketAccessControlArgs, opts?: CustomResourceOptions);

def BucketAccessControl(resource_name, opts=None, bucket=None, entity=None, role=None, __props__=None);

func NewBucketAccessControl(ctx *Context, name string, args BucketAccessControlArgs, opts ...ResourceOption) (*BucketAccessControl, error)

public BucketAccessControl(string name, BucketAccessControlArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

BucketAccessControl Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.

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.

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.

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.

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 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.

Look up an 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

static get(resource_name, id, opts=None, bucket=None, domain=None, email=None, entity=None, role=None, __props__=None);

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)

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.

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.

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.

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.

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.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud