BucketACL

Authoritatively manages a bucket’s ACLs in Google cloud storage service (GCS). For more information see the official documentation and API.

Bucket ACLs can be managed non authoritatively using the storage_bucket_access_control resource. Do not use these two resources in conjunction to manage the same bucket.

Permissions can be granted either by ACLs or Cloud IAM policies. In general, permissions granted by Cloud IAM policies do not appear in ACLs, and permissions granted by ACLs do not appear in Cloud IAM policies. The only exception is for ACLs applied directly on a bucket and certain bucket-level Cloud IAM policies, as described in Cloud IAM relation to ACLs.

NOTE This resource will not remove the project-owners-<project_id> entity from the OWNER role.

Create a BucketACL Resource

new BucketACL(name: string, args: BucketACLArgs, opts?: CustomResourceOptions);

def BucketACL(resource_name, opts=None, bucket=None, default_acl=None, predefined_acl=None, role_entities=None, __props__=None);

func NewBucketACL(ctx *Context, name string, args BucketACLArgs, opts ...ResourceOption) (*BucketACL, error)

public BucketACL(string name, BucketACLArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args BucketACLArgs: 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 BucketACLArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BucketACLArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

BucketACL Resource Properties

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

Inputs

The BucketACL resource accepts the following input properties:

Bucket string: The name of the bucket it applies to.
DefaultAcl string: Configure this ACL to be the default ACL.
PredefinedAcl string: The canned GCS ACL to apply. Must be set if role_entity is not.
RoleEntities List<string>: List of role/entity pairs in the form ROLE:entity. See GCS Bucket ACL documentation for more details. Must be set if predefined_acl is not.

Bucket string: The name of the bucket it applies to.
DefaultAcl string: Configure this ACL to be the default ACL.
PredefinedAcl string: The canned GCS ACL to apply. Must be set if role_entity is not.
RoleEntities []string: List of role/entity pairs in the form ROLE:entity. See GCS Bucket ACL documentation for more details. Must be set if predefined_acl is not.

bucket string: The name of the bucket it applies to.
defaultAcl string: Configure this ACL to be the default ACL.
predefinedAcl string: The canned GCS ACL to apply. Must be set if role_entity is not.
roleEntities string[]: List of role/entity pairs in the form ROLE:entity. See GCS Bucket ACL documentation for more details. Must be set if predefined_acl is not.

bucket str: The name of the bucket it applies to.
default_acl str: Configure this ACL to be the default ACL.
predefined_acl str: The canned GCS ACL to apply. Must be set if role_entity is not.
role_entities List[str]: List of role/entity pairs in the form ROLE:entity. See GCS Bucket ACL documentation for more details. Must be set if predefined_acl is not.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing BucketACL Resource

Get an existing BucketACL 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?: BucketACLState, opts?: CustomResourceOptions): BucketACL

static get(resource_name, id, opts=None, bucket=None, default_acl=None, predefined_acl=None, role_entities=None, __props__=None);

func GetBucketACL(ctx *Context, name string, id IDInput, state *BucketACLState, opts ...ResourceOption) (*BucketACL, error)

public static BucketACL Get(string name, Input<string> id, BucketACLState? 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 it applies to.
DefaultAcl string: Configure this ACL to be the default ACL.
PredefinedAcl string: The canned GCS ACL to apply. Must be set if role_entity is not.
RoleEntities List<string>: List of role/entity pairs in the form ROLE:entity. See GCS Bucket ACL documentation for more details. Must be set if predefined_acl is not.

Bucket string: The name of the bucket it applies to.
DefaultAcl string: Configure this ACL to be the default ACL.
PredefinedAcl string: The canned GCS ACL to apply. Must be set if role_entity is not.
RoleEntities []string: List of role/entity pairs in the form ROLE:entity. See GCS Bucket ACL documentation for more details. Must be set if predefined_acl is not.

bucket string: The name of the bucket it applies to.
defaultAcl string: Configure this ACL to be the default ACL.
predefinedAcl string: The canned GCS ACL to apply. Must be set if role_entity is not.
roleEntities string[]: List of role/entity pairs in the form ROLE:entity. See GCS Bucket ACL documentation for more details. Must be set if predefined_acl is not.

bucket str: The name of the bucket it applies to.
default_acl str: Configure this ACL to be the default ACL.
predefined_acl str: The canned GCS ACL to apply. Must be set if role_entity is not.
role_entities List[str]: List of role/entity pairs in the form ROLE:entity. See GCS Bucket ACL documentation for more details. Must be set if predefined_acl is not.

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