bucketAccessControl.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package storage

import (
	"context"
	"reflect"

	"errors"
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumix"
)

// Bucket ACLs can be managed authoritatively using the
// `storageBucketAcl` 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](https://cloud.google.com/storage/docs/json_api/v1/bucketAccessControls)
// * How-to Guides
//   - [Official Documentation](https://cloud.google.com/storage/docs/access-control/lists)
//
// ## Example Usage
// ### Storage Bucket Access Control Public Bucket
//
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-gcp/sdk/v6/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{
//				Location: pulumi.String("US"),
//			})
//			if err != nil {
//				return err
//			}
//			_, err = storage.NewBucketAccessControl(ctx, "publicRule", &storage.BucketAccessControlArgs{
//				Bucket: bucket.Name,
//				Role:   pulumi.String("READER"),
//				Entity: pulumi.String("allUsers"),
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
//
// ## Import
//
// BucketAccessControl can be imported using any of these accepted formats:
//
// ```sh
//
//	$ pulumi import gcp:storage/bucketAccessControl:BucketAccessControl default {{bucket}}/{{entity}}
//
// ```
type BucketAccessControl struct {
	pulumi.CustomResourceState

	// The name of the bucket.
	Bucket pulumi.StringOutput `pulumi:"bucket"`
	// The domain associated with the entity.
	Domain pulumi.StringOutput `pulumi:"domain"`
	// The email address associated with the entity.
	Email pulumi.StringOutput `pulumi:"email"`
	// 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.
	//
	// ***
	Entity pulumi.StringOutput `pulumi:"entity"`
	// The access permission for the entity.
	// Possible values are: `OWNER`, `READER`, `WRITER`.
	Role pulumi.StringPtrOutput `pulumi:"role"`
}

// NewBucketAccessControl registers a new resource with the given unique name, arguments, and options.
func NewBucketAccessControl(ctx *pulumi.Context,
	name string, args *BucketAccessControlArgs, opts ...pulumi.ResourceOption) (*BucketAccessControl, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.Bucket == nil {
		return nil, errors.New("invalid value for required argument 'Bucket'")
	}
	if args.Entity == nil {
		return nil, errors.New("invalid value for required argument 'Entity'")
	}
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource BucketAccessControl
	err := ctx.RegisterResource("gcp:storage/bucketAccessControl:BucketAccessControl", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetBucketAccessControl gets an existing BucketAccessControl resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetBucketAccessControl(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *BucketAccessControlState, opts ...pulumi.ResourceOption) (*BucketAccessControl, error) {
	var resource BucketAccessControl
	err := ctx.ReadResource("gcp:storage/bucketAccessControl:BucketAccessControl", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering BucketAccessControl resources.
type bucketAccessControlState struct {
	// The name of the bucket.
	Bucket *string `pulumi:"bucket"`
	// The domain associated with the entity.
	Domain *string `pulumi:"domain"`
	// The email address associated with the entity.
	Email *string `pulumi:"email"`
	// 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.
	//
	// ***
	Entity *string `pulumi:"entity"`
	// The access permission for the entity.
	// Possible values are: `OWNER`, `READER`, `WRITER`.
	Role *string `pulumi:"role"`
}

type BucketAccessControlState struct {
	// The name of the bucket.
	Bucket pulumi.StringPtrInput
	// The domain associated with the entity.
	Domain pulumi.StringPtrInput
	// The email address associated with the entity.
	Email pulumi.StringPtrInput
	// 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.
	//
	// ***
	Entity pulumi.StringPtrInput
	// The access permission for the entity.
	// Possible values are: `OWNER`, `READER`, `WRITER`.
	Role pulumi.StringPtrInput
}

func (BucketAccessControlState) ElementType() reflect.Type {
	return reflect.TypeOf((*bucketAccessControlState)(nil)).Elem()
}

type bucketAccessControlArgs struct {
	// The name of the bucket.
	Bucket string `pulumi:"bucket"`
	// 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.
	//
	// ***
	Entity string `pulumi:"entity"`
	// The access permission for the entity.
	// Possible values are: `OWNER`, `READER`, `WRITER`.
	Role *string `pulumi:"role"`
}

// The set of arguments for constructing a BucketAccessControl resource.
type BucketAccessControlArgs struct {
	// The name of the bucket.
	Bucket pulumi.StringInput
	// 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.
	//
	// ***
	Entity pulumi.StringInput
	// The access permission for the entity.
	// Possible values are: `OWNER`, `READER`, `WRITER`.
	Role pulumi.StringPtrInput
}

func (BucketAccessControlArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*bucketAccessControlArgs)(nil)).Elem()
}

type BucketAccessControlInput interface {
	pulumi.Input

	ToBucketAccessControlOutput() BucketAccessControlOutput
	ToBucketAccessControlOutputWithContext(ctx context.Context) BucketAccessControlOutput
}

func (*BucketAccessControl) ElementType() reflect.Type {
	return reflect.TypeOf((**BucketAccessControl)(nil)).Elem()
}

func (i *BucketAccessControl) ToBucketAccessControlOutput() BucketAccessControlOutput {
	return i.ToBucketAccessControlOutputWithContext(context.Background())
}

func (i *BucketAccessControl) ToBucketAccessControlOutputWithContext(ctx context.Context) BucketAccessControlOutput {
	return pulumi.ToOutputWithContext(ctx, i).(BucketAccessControlOutput)
}

func (i *BucketAccessControl) ToOutput(ctx context.Context) pulumix.Output[*BucketAccessControl] {
	return pulumix.Output[*BucketAccessControl]{
		OutputState: i.ToBucketAccessControlOutputWithContext(ctx).OutputState,
	}
}

// BucketAccessControlArrayInput is an input type that accepts BucketAccessControlArray and BucketAccessControlArrayOutput values.
// You can construct a concrete instance of `BucketAccessControlArrayInput` via:
//
//	BucketAccessControlArray{ BucketAccessControlArgs{...} }
type BucketAccessControlArrayInput interface {
	pulumi.Input

	ToBucketAccessControlArrayOutput() BucketAccessControlArrayOutput
	ToBucketAccessControlArrayOutputWithContext(context.Context) BucketAccessControlArrayOutput
}

type BucketAccessControlArray []BucketAccessControlInput

func (BucketAccessControlArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*BucketAccessControl)(nil)).Elem()
}

func (i BucketAccessControlArray) ToBucketAccessControlArrayOutput() BucketAccessControlArrayOutput {
	return i.ToBucketAccessControlArrayOutputWithContext(context.Background())
}

func (i BucketAccessControlArray) ToBucketAccessControlArrayOutputWithContext(ctx context.Context) BucketAccessControlArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(BucketAccessControlArrayOutput)
}

func (i BucketAccessControlArray) ToOutput(ctx context.Context) pulumix.Output[[]*BucketAccessControl] {
	return pulumix.Output[[]*BucketAccessControl]{
		OutputState: i.ToBucketAccessControlArrayOutputWithContext(ctx).OutputState,
	}
}

// BucketAccessControlMapInput is an input type that accepts BucketAccessControlMap and BucketAccessControlMapOutput values.
// You can construct a concrete instance of `BucketAccessControlMapInput` via:
//
//	BucketAccessControlMap{ "key": BucketAccessControlArgs{...} }
type BucketAccessControlMapInput interface {
	pulumi.Input

	ToBucketAccessControlMapOutput() BucketAccessControlMapOutput
	ToBucketAccessControlMapOutputWithContext(context.Context) BucketAccessControlMapOutput
}

type BucketAccessControlMap map[string]BucketAccessControlInput

func (BucketAccessControlMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*BucketAccessControl)(nil)).Elem()
}

func (i BucketAccessControlMap) ToBucketAccessControlMapOutput() BucketAccessControlMapOutput {
	return i.ToBucketAccessControlMapOutputWithContext(context.Background())
}

func (i BucketAccessControlMap) ToBucketAccessControlMapOutputWithContext(ctx context.Context) BucketAccessControlMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(BucketAccessControlMapOutput)
}

func (i BucketAccessControlMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*BucketAccessControl] {
	return pulumix.Output[map[string]*BucketAccessControl]{
		OutputState: i.ToBucketAccessControlMapOutputWithContext(ctx).OutputState,
	}
}

type BucketAccessControlOutput struct{ *pulumi.OutputState }

func (BucketAccessControlOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**BucketAccessControl)(nil)).Elem()
}

func (o BucketAccessControlOutput) ToBucketAccessControlOutput() BucketAccessControlOutput {
	return o
}

func (o BucketAccessControlOutput) ToBucketAccessControlOutputWithContext(ctx context.Context) BucketAccessControlOutput {
	return o
}

func (o BucketAccessControlOutput) ToOutput(ctx context.Context) pulumix.Output[*BucketAccessControl] {
	return pulumix.Output[*BucketAccessControl]{
		OutputState: o.OutputState,
	}
}

// The name of the bucket.
func (o BucketAccessControlOutput) Bucket() pulumi.StringOutput {
	return o.ApplyT(func(v *BucketAccessControl) pulumi.StringOutput { return v.Bucket }).(pulumi.StringOutput)
}

// The domain associated with the entity.
func (o BucketAccessControlOutput) Domain() pulumi.StringOutput {
	return o.ApplyT(func(v *BucketAccessControl) pulumi.StringOutput { return v.Domain }).(pulumi.StringOutput)
}

// The email address associated with the entity.
func (o BucketAccessControlOutput) Email() pulumi.StringOutput {
	return o.ApplyT(func(v *BucketAccessControl) pulumi.StringOutput { return v.Email }).(pulumi.StringOutput)
}

// 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.
//
// ***
func (o BucketAccessControlOutput) Entity() pulumi.StringOutput {
	return o.ApplyT(func(v *BucketAccessControl) pulumi.StringOutput { return v.Entity }).(pulumi.StringOutput)
}

// The access permission for the entity.
// Possible values are: `OWNER`, `READER`, `WRITER`.
func (o BucketAccessControlOutput) Role() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *BucketAccessControl) pulumi.StringPtrOutput { return v.Role }).(pulumi.StringPtrOutput)
}

type BucketAccessControlArrayOutput struct{ *pulumi.OutputState }

func (BucketAccessControlArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*BucketAccessControl)(nil)).Elem()
}

func (o BucketAccessControlArrayOutput) ToBucketAccessControlArrayOutput() BucketAccessControlArrayOutput {
	return o
}

func (o BucketAccessControlArrayOutput) ToBucketAccessControlArrayOutputWithContext(ctx context.Context) BucketAccessControlArrayOutput {
	return o
}

func (o BucketAccessControlArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*BucketAccessControl] {
	return pulumix.Output[[]*BucketAccessControl]{
		OutputState: o.OutputState,
	}
}

func (o BucketAccessControlArrayOutput) Index(i pulumi.IntInput) BucketAccessControlOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *BucketAccessControl {
		return vs[0].([]*BucketAccessControl)[vs[1].(int)]
	}).(BucketAccessControlOutput)
}

type BucketAccessControlMapOutput struct{ *pulumi.OutputState }

func (BucketAccessControlMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*BucketAccessControl)(nil)).Elem()
}

func (o BucketAccessControlMapOutput) ToBucketAccessControlMapOutput() BucketAccessControlMapOutput {
	return o
}

func (o BucketAccessControlMapOutput) ToBucketAccessControlMapOutputWithContext(ctx context.Context) BucketAccessControlMapOutput {
	return o
}

func (o BucketAccessControlMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*BucketAccessControl] {
	return pulumix.Output[map[string]*BucketAccessControl]{
		OutputState: o.OutputState,
	}
}

func (o BucketAccessControlMapOutput) MapIndex(k pulumi.StringInput) BucketAccessControlOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *BucketAccessControl {
		return vs[0].(map[string]*BucketAccessControl)[vs[1].(string)]
	}).(BucketAccessControlOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*BucketAccessControlInput)(nil)).Elem(), &BucketAccessControl{})
	pulumi.RegisterInputType(reflect.TypeOf((*BucketAccessControlArrayInput)(nil)).Elem(), BucketAccessControlArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*BucketAccessControlMapInput)(nil)).Elem(), BucketAccessControlMap{})
	pulumi.RegisterOutputType(BucketAccessControlOutput{})
	pulumi.RegisterOutputType(BucketAccessControlArrayOutput{})
	pulumi.RegisterOutputType(BucketAccessControlMapOutput{})
}