1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. storage
  5. DefaultObjectAccessControl
Google Cloud Classic v7.26.0 published on Friday, Jun 7, 2024 by Pulumi

gcp.storage.DefaultObjectAccessControl

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.26.0 published on Friday, Jun 7, 2024 by Pulumi

    The DefaultObjectAccessControls resources represent the Access Control Lists (ACLs) applied to a new object within a Google Cloud Storage bucket when no ACL was provided for that object. ACLs let you specify who has access to your bucket contents and to what extent.

    There are two roles that can be assigned to an entity:

    READERs can get an object, though the acl property will not be revealed. OWNERs are READERs, and they can get the acl property, update an object, and call all objectAccessControls methods on the object. The owner of an object is always an OWNER. For more information, see Access Control, with the caveat that this API uses READER and OWNER instead of READ and FULL_CONTROL.

    To get more information about DefaultObjectAccessControl, see:

    Example Usage

    Storage Default Object Access Control Public

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const bucket = new gcp.storage.Bucket("bucket", {
        name: "static-content-bucket",
        location: "US",
    });
    const publicRule = new gcp.storage.DefaultObjectAccessControl("public_rule", {
        bucket: bucket.name,
        role: "READER",
        entity: "allUsers",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    bucket = gcp.storage.Bucket("bucket",
        name="static-content-bucket",
        location="US")
    public_rule = gcp.storage.DefaultObjectAccessControl("public_rule",
        bucket=bucket.name,
        role="READER",
        entity="allUsers")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/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{
    			Name:     pulumi.String("static-content-bucket"),
    			Location: pulumi.String("US"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = storage.NewDefaultObjectAccessControl(ctx, "public_rule", &storage.DefaultObjectAccessControlArgs{
    			Bucket: bucket.Name,
    			Role:   pulumi.String("READER"),
    			Entity: pulumi.String("allUsers"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var bucket = new Gcp.Storage.Bucket("bucket", new()
        {
            Name = "static-content-bucket",
            Location = "US",
        });
    
        var publicRule = new Gcp.Storage.DefaultObjectAccessControl("public_rule", new()
        {
            Bucket = bucket.Name,
            Role = "READER",
            Entity = "allUsers",
        });
    
    });
    
    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.DefaultObjectAccessControl;
    import com.pulumi.gcp.storage.DefaultObjectAccessControlArgs;
    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()
                .name("static-content-bucket")
                .location("US")
                .build());
    
            var publicRule = new DefaultObjectAccessControl("publicRule", DefaultObjectAccessControlArgs.builder()
                .bucket(bucket.name())
                .role("READER")
                .entity("allUsers")
                .build());
    
        }
    }
    
    resources:
      publicRule:
        type: gcp:storage:DefaultObjectAccessControl
        name: public_rule
        properties:
          bucket: ${bucket.name}
          role: READER
          entity: allUsers
      bucket:
        type: gcp:storage:Bucket
        properties:
          name: static-content-bucket
          location: US
    

    Create DefaultObjectAccessControl Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DefaultObjectAccessControl(name: string, args: DefaultObjectAccessControlArgs, opts?: CustomResourceOptions);
    @overload
    def DefaultObjectAccessControl(resource_name: str,
                                   args: DefaultObjectAccessControlArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DefaultObjectAccessControl(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   bucket: Optional[str] = None,
                                   entity: Optional[str] = None,
                                   role: Optional[str] = None,
                                   object: Optional[str] = None)
    func NewDefaultObjectAccessControl(ctx *Context, name string, args DefaultObjectAccessControlArgs, opts ...ResourceOption) (*DefaultObjectAccessControl, error)
    public DefaultObjectAccessControl(string name, DefaultObjectAccessControlArgs args, CustomResourceOptions? opts = null)
    public DefaultObjectAccessControl(String name, DefaultObjectAccessControlArgs args)
    public DefaultObjectAccessControl(String name, DefaultObjectAccessControlArgs args, CustomResourceOptions options)
    
    type: gcp:storage:DefaultObjectAccessControl
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

    The following reference example uses placeholder values for all input properties.

    var defaultObjectAccessControlResource = new Gcp.Storage.DefaultObjectAccessControl("defaultObjectAccessControlResource", new()
    {
        Bucket = "string",
        Entity = "string",
        Role = "string",
        Object = "string",
    });
    
    example, err := storage.NewDefaultObjectAccessControl(ctx, "defaultObjectAccessControlResource", &storage.DefaultObjectAccessControlArgs{
    	Bucket: pulumi.String("string"),
    	Entity: pulumi.String("string"),
    	Role:   pulumi.String("string"),
    	Object: pulumi.String("string"),
    })
    
    var defaultObjectAccessControlResource = new DefaultObjectAccessControl("defaultObjectAccessControlResource", DefaultObjectAccessControlArgs.builder()
        .bucket("string")
        .entity("string")
        .role("string")
        .object("string")
        .build());
    
    default_object_access_control_resource = gcp.storage.DefaultObjectAccessControl("defaultObjectAccessControlResource",
        bucket="string",
        entity="string",
        role="string",
        object="string")
    
    const defaultObjectAccessControlResource = new gcp.storage.DefaultObjectAccessControl("defaultObjectAccessControlResource", {
        bucket: "string",
        entity: "string",
        role: "string",
        object: "string",
    });
    
    type: gcp:storage:DefaultObjectAccessControl
    properties:
        bucket: string
        entity: string
        object: string
        role: string
    

    DefaultObjectAccessControl 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 DefaultObjectAccessControl 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}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    Role string
    The access permission for the entity. Possible values are: OWNER, READER.


    Object string
    The name of the object, if applied to an object.
    Bucket string
    The name of the bucket.
    Entity string
    The entity holding the permission, in one of the following forms:

    • user-{{userId}}
    • user-{{email}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    Role string
    The access permission for the entity. Possible values are: OWNER, READER.


    Object string
    The name of the object, if applied to an object.
    bucket String
    The name of the bucket.
    entity String
    The entity holding the permission, in one of the following forms:

    • user-{{userId}}
    • user-{{email}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    role String
    The access permission for the entity. Possible values are: OWNER, READER.


    object String
    The name of the object, if applied to an object.
    bucket string
    The name of the bucket.
    entity string
    The entity holding the permission, in one of the following forms:

    • user-{{userId}}
    • user-{{email}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    role string
    The access permission for the entity. Possible values are: OWNER, READER.


    object string
    The name of the object, if applied to an object.
    bucket str
    The name of the bucket.
    entity str
    The entity holding the permission, in one of the following forms:

    • user-{{userId}}
    • user-{{email}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    role str
    The access permission for the entity. Possible values are: OWNER, READER.


    object str
    The name of the object, if applied to an object.
    bucket String
    The name of the bucket.
    entity String
    The entity holding the permission, in one of the following forms:

    • user-{{userId}}
    • user-{{email}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    role String
    The access permission for the entity. Possible values are: OWNER, READER.


    object String
    The name of the object, if applied to an object.

    Outputs

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

    Domain string
    The domain associated with the entity.
    Email string
    The email address associated with the entity.
    EntityId string
    The ID for the entity
    Generation int
    The content generation of the object, if applied to an object.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectTeams List<DefaultObjectAccessControlProjectTeam>
    The project team associated with the entity Structure is documented below.
    Domain string
    The domain associated with the entity.
    Email string
    The email address associated with the entity.
    EntityId string
    The ID for the entity
    Generation int
    The content generation of the object, if applied to an object.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectTeams []DefaultObjectAccessControlProjectTeam
    The project team associated with the entity Structure is documented below.
    domain String
    The domain associated with the entity.
    email String
    The email address associated with the entity.
    entityId String
    The ID for the entity
    generation Integer
    The content generation of the object, if applied to an object.
    id String
    The provider-assigned unique ID for this managed resource.
    projectTeams List<DefaultObjectAccessControlProjectTeam>
    The project team associated with the entity Structure is documented below.
    domain string
    The domain associated with the entity.
    email string
    The email address associated with the entity.
    entityId string
    The ID for the entity
    generation number
    The content generation of the object, if applied to an object.
    id string
    The provider-assigned unique ID for this managed resource.
    projectTeams DefaultObjectAccessControlProjectTeam[]
    The project team associated with the entity Structure is documented below.
    domain str
    The domain associated with the entity.
    email str
    The email address associated with the entity.
    entity_id str
    The ID for the entity
    generation int
    The content generation of the object, if applied to an object.
    id str
    The provider-assigned unique ID for this managed resource.
    project_teams Sequence[DefaultObjectAccessControlProjectTeam]
    The project team associated with the entity Structure is documented below.
    domain String
    The domain associated with the entity.
    email String
    The email address associated with the entity.
    entityId String
    The ID for the entity
    generation Number
    The content generation of the object, if applied to an object.
    id String
    The provider-assigned unique ID for this managed resource.
    projectTeams List<Property Map>
    The project team associated with the entity Structure is documented below.

    Look up Existing DefaultObjectAccessControl Resource

    Get an existing DefaultObjectAccessControl 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?: DefaultObjectAccessControlState, opts?: CustomResourceOptions): DefaultObjectAccessControl
    @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,
            entity_id: Optional[str] = None,
            generation: Optional[int] = None,
            object: Optional[str] = None,
            project_teams: Optional[Sequence[DefaultObjectAccessControlProjectTeamArgs]] = None,
            role: Optional[str] = None) -> DefaultObjectAccessControl
    func GetDefaultObjectAccessControl(ctx *Context, name string, id IDInput, state *DefaultObjectAccessControlState, opts ...ResourceOption) (*DefaultObjectAccessControl, error)
    public static DefaultObjectAccessControl Get(string name, Input<string> id, DefaultObjectAccessControlState? state, CustomResourceOptions? opts = null)
    public static DefaultObjectAccessControl get(String name, Output<String> id, DefaultObjectAccessControlState 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}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    EntityId string
    The ID for the entity
    Generation int
    The content generation of the object, if applied to an object.
    Object string
    The name of the object, if applied to an object.
    ProjectTeams List<DefaultObjectAccessControlProjectTeam>
    The project team associated with the entity Structure is documented below.
    Role string
    The access permission for the entity. Possible values are: OWNER, READER.


    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}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    EntityId string
    The ID for the entity
    Generation int
    The content generation of the object, if applied to an object.
    Object string
    The name of the object, if applied to an object.
    ProjectTeams []DefaultObjectAccessControlProjectTeamArgs
    The project team associated with the entity Structure is documented below.
    Role string
    The access permission for the entity. Possible values are: OWNER, READER.


    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}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    entityId String
    The ID for the entity
    generation Integer
    The content generation of the object, if applied to an object.
    object String
    The name of the object, if applied to an object.
    projectTeams List<DefaultObjectAccessControlProjectTeam>
    The project team associated with the entity Structure is documented below.
    role String
    The access permission for the entity. Possible values are: OWNER, READER.


    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}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    entityId string
    The ID for the entity
    generation number
    The content generation of the object, if applied to an object.
    object string
    The name of the object, if applied to an object.
    projectTeams DefaultObjectAccessControlProjectTeam[]
    The project team associated with the entity Structure is documented below.
    role string
    The access permission for the entity. Possible values are: OWNER, READER.


    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}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    entity_id str
    The ID for the entity
    generation int
    The content generation of the object, if applied to an object.
    object str
    The name of the object, if applied to an object.
    project_teams Sequence[DefaultObjectAccessControlProjectTeamArgs]
    The project team associated with the entity Structure is documented below.
    role str
    The access permission for the entity. Possible values are: OWNER, READER.


    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}} (such as "user-liz@example.com")
    • group-{{groupId}}
    • group-{{email}} (such as "group-example@googlegroups.com")
    • domain-{{domain}} (such as "domain-example.com")
    • project-team-{{projectId}}
    • allUsers
    • allAuthenticatedUsers
    entityId String
    The ID for the entity
    generation Number
    The content generation of the object, if applied to an object.
    object String
    The name of the object, if applied to an object.
    projectTeams List<Property Map>
    The project team associated with the entity Structure is documented below.
    role String
    The access permission for the entity. Possible values are: OWNER, READER.


    Supporting Types

    DefaultObjectAccessControlProjectTeam, DefaultObjectAccessControlProjectTeamArgs

    ProjectNumber string
    The project team associated with the entity
    Team string
    The team. Possible values are: editors, owners, viewers.
    ProjectNumber string
    The project team associated with the entity
    Team string
    The team. Possible values are: editors, owners, viewers.
    projectNumber String
    The project team associated with the entity
    team String
    The team. Possible values are: editors, owners, viewers.
    projectNumber string
    The project team associated with the entity
    team string
    The team. Possible values are: editors, owners, viewers.
    project_number str
    The project team associated with the entity
    team str
    The team. Possible values are: editors, owners, viewers.
    projectNumber String
    The project team associated with the entity
    team String
    The team. Possible values are: editors, owners, viewers.

    Import

    DefaultObjectAccessControl can be imported using any of these accepted formats:

    • {{bucket}}/{{entity}}

    When using the pulumi import command, DefaultObjectAccessControl can be imported using one of the formats above. For example:

    $ pulumi import gcp:storage/defaultObjectAccessControl:DefaultObjectAccessControl default {{bucket}}/{{entity}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.
    gcp logo
    Google Cloud Classic v7.26.0 published on Friday, Jun 7, 2024 by Pulumi