BucketAbac class

Manages ABAC (Attribute Based Access Control) for an AWS S3 (Simple Storage) Bucket. See the AWS documentation on enabling ABAC for general purpose buckets for additional information.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3.Bucket("example", {bucket: "bucket-name"});
const exampleBucketAbac = new aws.s3.BucketAbac("example", {
    abacStatus: {
        status: "Enabled",
    },
    bucket: example.bucket,
});
import pulumi
import pulumi_aws as aws

example = aws.s3.Bucket("example", bucket="bucket-name")
example_bucket_abac = aws.s3.BucketAbac("example",
    abac_status={
        "status": "Enabled",
    },
    bucket=example.bucket)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.S3.Bucket("example", new()
    {
        BucketName = "bucket-name",
    });

    var exampleBucketAbac = new Aws.S3.BucketAbac("example", new()
    {
        AbacStatus = new Aws.S3.Inputs.BucketAbacAbacStatusArgs
        {
            Status = "Enabled",
        },
        Bucket = example.BucketName,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := s3.NewBucket(ctx, "example", &s3.BucketArgs{
			Bucket: pulumi.String("bucket-name"),
		})
		if err != nil {
			return err
		}
		_, err = s3.NewBucketAbac(ctx, "example", &s3.BucketAbacArgs{
			AbacStatus: &s3.BucketAbacAbacStatusArgs{
				Status: pulumi.String("Enabled"),
			},
			Bucket: example.Bucket,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3_bucket" "example" {
  bucket = "bucket-name"
}
resource "aws_s3_bucketabac" "example" {
  abac_status = {
    status = "Enabled"
  }
  bucket = aws_s3_bucket.example.bucket
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.Bucket;
import com.pulumi.aws.s3.BucketArgs;
import com.pulumi.aws.s3.BucketAbac;
import com.pulumi.aws.s3.BucketAbacArgs;
import com.pulumi.aws.s3.inputs.BucketAbacAbacStatusArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = new Bucket("example", BucketArgs.builder()
            .bucket("bucket-name")
            .build());

        var exampleBucketAbac = new BucketAbac("exampleBucketAbac", BucketAbacArgs.builder()
            .abacStatus(BucketAbacAbacStatusArgs.builder()
                .status("Enabled")
                .build())
            .bucket(example.bucket())
            .build());

    }
}
resources:
  example:
    type: aws:s3:Bucket
    properties:
      bucket: bucket-name
  exampleBucketAbac:
    type: aws:s3:BucketAbac
    name: example
    properties:
      abacStatus:
        status: Enabled
      bucket: ${example.bucket}

Import

If the owner (account ID) of the source bucket differs from the account used to configure the Terraform AWS Provider, import using the bucket and expectedBucketOwner separated by a comma (,):

Using pulumi import, import S3 (Simple Storage) Bucket ABAC using the bucket or bucket and expectedBucketOwner separated by a comma (,). For example:

If the owner (account ID) of the source bucket is the same account used to configure the Terraform AWS Provider, import using the bucket:

$ pulumi import aws:s3/bucketAbac:BucketAbac example bucket-name

If the owner (account ID) of the source bucket differs from the account used to configure the Terraform AWS Provider, import using the bucket and expectedBucketOwner separated by a comma (,):

$ pulumi import aws:s3/bucketAbac:BucketAbac example bucket-name,123456789012

Constructors

BucketAbac(String name, {BucketAbacArgs? args, CustomResourceOptions? options})
Creates a new BucketAbac. name The Pulumi resource name. args Arguments used to configure this BucketAbac. The set of arguments for BucketAbac. options Resource options controlling this resource's behavior.
BucketAbac.reference(String urn)
Creates a typed reference to an existing BucketAbac resource.

Properties

abacStatus ↔ Output<BucketAbacAbacStatus>
ABAC status configuration. See abacStatus Block for details.
latefinal
bucket ↔ Output<String>
General purpose bucket that you want to create the metadata configuration for.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
expectedBucketOwner ↔ Output<String?>
Account ID of the expected bucket owner.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {BucketAbacState? state, CustomResourceOptions? options}) → BucketAbac
Gets an existing BucketAbac resource's state with the given name and id.