ObjectACL

Authoritatively manages the access control list (ACL) for an object in a Google Cloud Storage (GCS) bucket. Removing a gcp.storage.ObjectACL sets the acl to the private predefined ACL.

For more information see the official documentation and API.

Want fine-grained control over object ACLs? Use gcp.storage.ObjectAccessControl to control individual role entity pairs.

Create a ObjectACL Resource

new ObjectACL(name: string, args: ObjectACLArgs, opts?: CustomResourceOptions);

def ObjectACL(resource_name, opts=None, bucket=None, object=None, predefined_acl=None, role_entities=None, __props__=None);

func NewObjectACL(ctx *Context, name string, args ObjectACLArgs, opts ...ResourceOption) (*ObjectACL, error)

public ObjectACL(string name, ObjectACLArgs args, CustomResourceOptions? opts = null)

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

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

ObjectACL Resource Properties

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

Inputs

The ObjectACL resource accepts the following input properties:

Bucket string: The name of the bucket the object is stored in.
Object string: The name of the object to apply the acl to.
PredefinedAcl string: The “canned” predefined 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 Object ACL documentation for more details. Must be set if predefined_acl is not.

Bucket string: The name of the bucket the object is stored in.
Object string: The name of the object to apply the acl to.
PredefinedAcl string: The “canned” predefined 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 Object ACL documentation for more details. Must be set if predefined_acl is not.

bucket string: The name of the bucket the object is stored in.
object string: The name of the object to apply the acl to.
predefinedAcl string: The “canned” predefined 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 Object ACL documentation for more details. Must be set if predefined_acl is not.

bucket str: The name of the bucket the object is stored in.
object str: The name of the object to apply the acl to.
predefined_acl str: The “canned” predefined 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 Object 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 ObjectACL 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 ObjectACL Resource

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

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

func GetObjectACL(ctx *Context, name string, id IDInput, state *ObjectACLState, opts ...ResourceOption) (*ObjectACL, error)

public static ObjectACL Get(string name, Input<string> id, ObjectACLState? 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 the object is stored in.
Object string: The name of the object to apply the acl to.
PredefinedAcl string: The “canned” predefined 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 Object ACL documentation for more details. Must be set if predefined_acl is not.

Bucket string: The name of the bucket the object is stored in.
Object string: The name of the object to apply the acl to.
PredefinedAcl string: The “canned” predefined 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 Object ACL documentation for more details. Must be set if predefined_acl is not.

bucket string: The name of the bucket the object is stored in.
object string: The name of the object to apply the acl to.
predefinedAcl string: The “canned” predefined 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 Object ACL documentation for more details. Must be set if predefined_acl is not.

bucket str: The name of the bucket the object is stored in.
object str: The name of the object to apply the acl to.
predefined_acl str: The “canned” predefined 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 Object 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