@pulumiverse/scaleway/objectBucketLockConfiguration.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * The `scaleway.object.BucketLockConfiguration` resource allows you to create and manage an object lock configuration for [Scaleway Object storage](https://www.scaleway.com/en/docs/object-storage/).
 *
 * Refer to the [dedicated documentation](https://www.scaleway.com/en/docs/object-storage/api-cli/object-lock/) for more information on object lock.
 *
 * ## Example Usage
 *
 * ### Configure an Object Lock for a new bucket
 *
 * > **Note:** `objectLockEnabled` must be set to `true` before configuring the lock.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * const main = new scaleway.object.Bucket("main", {
 *     name: "MyBucket",
 *     acl: "public-read",
 *     objectLockEnabled: true,
 * });
 * const mainBucketLockConfiguration = new scaleway.object.BucketLockConfiguration("main", {
 *     bucket: main.name,
 *     rule: {
 *         defaultRetention: {
 *             mode: "GOVERNANCE",
 *             days: 1,
 *         },
 *     },
 * });
 * ```
 *
 * ### Configure an object Lock for an existing bucket
 *
 * [Contact Scaleway support](https://console.scaleway.com/support/tickets/create) to enable object lock on an existing bucket.
 *
 * ## Import
 *
 * Bucket lock configurations can be imported using the `{region}/{bucketName}` identifier, as shown below:
 *
 * bash
 *
 * ```sh
 * $ pulumi import scaleway:index/objectBucketLockConfiguration:ObjectBucketLockConfiguration some_bucket fr-par/some-bucket
 * ```
 *
 * ~> **Important:** The `project_id` attribute has a particular behavior with s3 products because the s3 API is scoped by project.
 *
 * If you are using a project different from the default one, you have to specify the project ID at the end of the import command.
 *
 * bash
 *
 * ```sh
 * $ pulumi import scaleway:index/objectBucketLockConfiguration:ObjectBucketLockConfiguration some_bucket fr-par/some-bucket@xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
 * ```
 *
 * @deprecated scaleway.index/objectbucketlockconfiguration.ObjectBucketLockConfiguration has been deprecated in favor of scaleway.object/bucketlockconfiguration.BucketLockConfiguration
 */
export declare class ObjectBucketLockConfiguration extends pulumi.CustomResource {
    /**
     * Get an existing ObjectBucketLockConfiguration 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?: ObjectBucketLockConfigurationState, opts?: pulumi.CustomResourceOptions): ObjectBucketLockConfiguration;
    /**
     * Returns true if the given object is an instance of ObjectBucketLockConfiguration.  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 ObjectBucketLockConfiguration;
    /**
     * The bucket's name or regional ID.
     */
    readonly bucket: pulumi.Output<string>;
    /**
     * The projectId you want to attach the resource to
     */
    readonly projectId: pulumi.Output<string>;
    /**
     * The region you want to attach the resource to
     */
    readonly region: pulumi.Output<string>;
    /**
     * Specifies the object lock rule for the specified object.
     */
    readonly rule: pulumi.Output<outputs.ObjectBucketLockConfigurationRule>;
    /**
     * Create a ObjectBucketLockConfiguration 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.
     */
    /** @deprecated scaleway.index/objectbucketlockconfiguration.ObjectBucketLockConfiguration has been deprecated in favor of scaleway.object/bucketlockconfiguration.BucketLockConfiguration */
    constructor(name: string, args: ObjectBucketLockConfigurationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ObjectBucketLockConfiguration resources.
 */
export interface ObjectBucketLockConfigurationState {
    /**
     * The bucket's name or regional ID.
     */
    bucket?: pulumi.Input<string>;
    /**
     * The projectId you want to attach the resource to
     */
    projectId?: pulumi.Input<string>;
    /**
     * The region you want to attach the resource to
     */
    region?: pulumi.Input<string>;
    /**
     * Specifies the object lock rule for the specified object.
     */
    rule?: pulumi.Input<inputs.ObjectBucketLockConfigurationRule>;
}
/**
 * The set of arguments for constructing a ObjectBucketLockConfiguration resource.
 */
export interface ObjectBucketLockConfigurationArgs {
    /**
     * The bucket's name or regional ID.
     */
    bucket: pulumi.Input<string>;
    /**
     * The projectId you want to attach the resource to
     */
    projectId?: pulumi.Input<string>;
    /**
     * The region you want to attach the resource to
     */
    region?: pulumi.Input<string>;
    /**
     * Specifies the object lock rule for the specified object.
     */
    rule: pulumi.Input<inputs.ObjectBucketLockConfigurationRule>;
}