@pulumi/aws/s3/bucketAbac.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Manages ABAC (Attribute Based Access Control) for an AWS S3 (Simple Storage) Bucket.
 * See the [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html) on enabling ABAC for general purpose buckets for additional information.
 *
 * ## Example Usage
 *
 * ### Basic Usage
 *
 * ```typescript
 * 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", {
 *     bucket: example.bucket,
 *     abacStatus: {
 *         status: "Enabled",
 *     },
 * });
 * ```
 *
 * ## 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 `expected_bucket_owner` separated by a comma (`,`):
 *
 * Using `pulumi import`, import S3 (Simple Storage) Bucket ABAC using the `bucket` or `bucket` and `expected_bucket_owner` 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`:
 *
 * ```sh
 * $ 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 `expected_bucket_owner` separated by a comma (`,`):
 *
 * ```sh
 * $ pulumi import aws:s3/bucketAbac:BucketAbac example bucket-name,123456789012
 * ```
 */
export declare class BucketAbac extends pulumi.CustomResource {
    /**
     * Get an existing BucketAbac resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BucketAbacState, opts?: pulumi.CustomResourceOptions): BucketAbac;
    /**
     * Returns true if the given object is an instance of BucketAbac.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is BucketAbac;
    /**
     * ABAC status configuration. See `abacStatus` Block for details.
     *
     * The following arguments are optional:
     */
    readonly abacStatus: pulumi.Output<outputs.s3.BucketAbacAbacStatus | undefined>;
    /**
     * General purpose bucket that you want to create the metadata configuration for.
     */
    readonly bucket: pulumi.Output<string>;
    /**
     * Account ID of the expected bucket owner.
     */
    readonly expectedBucketOwner: pulumi.Output<string | undefined>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    readonly region: pulumi.Output<string>;
    /**
     * Create a BucketAbac resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: BucketAbacArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering BucketAbac resources.
 */
export interface BucketAbacState {
    /**
     * ABAC status configuration. See `abacStatus` Block for details.
     *
     * The following arguments are optional:
     */
    abacStatus?: pulumi.Input<inputs.s3.BucketAbacAbacStatus>;
    /**
     * General purpose bucket that you want to create the metadata configuration for.
     */
    bucket?: pulumi.Input<string>;
    /**
     * Account ID of the expected bucket owner.
     */
    expectedBucketOwner?: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a BucketAbac resource.
 */
export interface BucketAbacArgs {
    /**
     * ABAC status configuration. See `abacStatus` Block for details.
     *
     * The following arguments are optional:
     */
    abacStatus?: pulumi.Input<inputs.s3.BucketAbacAbacStatus>;
    /**
     * General purpose bucket that you want to create the metadata configuration for.
     */
    bucket: pulumi.Input<string>;
    /**
     * Account ID of the expected bucket owner.
     */
    expectedBucketOwner?: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
}