pulumi-gcp-kotlin/com.pulumi.gcp.storage.kotlin/ObjectAccessControlArgs

ObjectAccessControlArgs

data class ObjectAccessControlArgs(val bucket: Output<String>? = null, val entity: Output<String>? = null, val object: Output<String>? = null, val role: Output<String>? = null) : ConvertibleToJava<ObjectAccessControlArgs>

The ObjectAccessControls resources represent the Access Control Lists (ACLs) for objects within Google Cloud Storage. ACLs let you specify who has access to your data 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 ObjectAccessControl, see:

API documentation
How-to Guides

Official Documentation

Example Usage

Storage Object Access Control Public Object

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 object = new gcp.storage.BucketObject("object", {
    name: "public-object",
    bucket: bucket.name,
    source: new pulumi.asset.FileAsset("../static/img/header-logo.png"),
});
const publicRule = new gcp.storage.ObjectAccessControl("public_rule", {
    object: object.outputName,
    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")
object = gcp.storage.BucketObject("object",
    name="public-object",
    bucket=bucket.name,
    source=pulumi.FileAsset("../static/img/header-logo.png"))
public_rule = gcp.storage.ObjectAccessControl("public_rule",
    object=object.output_name,
    bucket=bucket.name,
    role="READER",
    entity="allUsers")

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 @object = new Gcp.Storage.BucketObject("object", new()
    {
        Name = "public-object",
        Bucket = bucket.Name,
        Source = new FileAsset("../static/img/header-logo.png"),
    });
    var publicRule = new Gcp.Storage.ObjectAccessControl("public_rule", new()
    {
        Object = @object.OutputName,
        Bucket = bucket.Name,
        Role = "READER",
        Entity = "allUsers",
    });
});

package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/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
		}
		object, err := storage.NewBucketObject(ctx, "object", &storage.BucketObjectArgs{
			Name:   pulumi.String("public-object"),
			Bucket: bucket.Name,
			Source: pulumi.NewFileAsset("../static/img/header-logo.png"),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewObjectAccessControl(ctx, "public_rule", &storage.ObjectAccessControlArgs{
			Object: object.OutputName,
			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.BucketObject;
import com.pulumi.gcp.storage.BucketObjectArgs;
import com.pulumi.gcp.storage.ObjectAccessControl;
import com.pulumi.gcp.storage.ObjectAccessControlArgs;
import com.pulumi.asset.FileAsset;
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 object = new BucketObject("object", BucketObjectArgs.builder()
            .name("public-object")
            .bucket(bucket.name())
            .source(new FileAsset("../static/img/header-logo.png"))
            .build());
        var publicRule = new ObjectAccessControl("publicRule", ObjectAccessControlArgs.builder()
            .object(object.outputName())
            .bucket(bucket.name())
            .role("READER")
            .entity("allUsers")
            .build());
    }
}

resources:
  publicRule:
    type: gcp:storage:ObjectAccessControl
    name: public_rule
    properties:
      object: ${object.outputName}
      bucket: ${bucket.name}
      role: READER
      entity: allUsers
  bucket:
    type: gcp:storage:Bucket
    properties:
      name: static-content-bucket
      location: US
  object:
    type: gcp:storage:BucketObject
    properties:
      name: public-object
      bucket: ${bucket.name}
      source:
        fn::FileAsset: ../static/img/header-logo.png

Import

ObjectAccessControl can be imported using any of these accepted formats:

{{bucket}}/{{object}}/{{entity}} When using the pulumi import command, ObjectAccessControl can be imported using one of the formats above. For example:

$ pulumi import gcp:storage/objectAccessControl:ObjectAccessControl default {{bucket}}/{{object}}/{{entity}}

Constructors

ObjectAccessControlArgs

constructor(bucket: Output<String>? = null, entity: Output<String>? = null, object: Output<String>? = null, role: Output<String>? = null)

Properties

bucket

val bucket: Output<String>? = null

The name of the bucket.

entity

val entity: Output<String>? = null

The entity holding the permission, in one of the following forms:

object

val object: Output<String>? = null

The name of the object to apply the access control to.

role

val role: Output<String>? = null

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

Functions

toJava

open override fun toJava(): ObjectAccessControlArgs