@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
118 lines • 5.12 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.BucketLockConfiguration = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* 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:object/bucketLockConfiguration:BucketLockConfiguration 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:object/bucketLockConfiguration:BucketLockConfiguration some_bucket fr-par/some-bucket@xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
* ```
*/
class BucketLockConfiguration extends pulumi.CustomResource {
/**
* Get an existing BucketLockConfiguration 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, id, state, opts) {
return new BucketLockConfiguration(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of BucketLockConfiguration. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === BucketLockConfiguration.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["bucket"] = state ? state.bucket : undefined;
resourceInputs["projectId"] = state ? state.projectId : undefined;
resourceInputs["region"] = state ? state.region : undefined;
resourceInputs["rule"] = state ? state.rule : undefined;
}
else {
const args = argsOrState;
if ((!args || args.bucket === undefined) && !opts.urn) {
throw new Error("Missing required property 'bucket'");
}
if ((!args || args.rule === undefined) && !opts.urn) {
throw new Error("Missing required property 'rule'");
}
resourceInputs["bucket"] = args ? args.bucket : undefined;
resourceInputs["projectId"] = args ? args.projectId : undefined;
resourceInputs["region"] = args ? args.region : undefined;
resourceInputs["rule"] = args ? args.rule : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "scaleway:index/objectBucketLockConfiguration:ObjectBucketLockConfiguration" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(BucketLockConfiguration.__pulumiType, name, resourceInputs, opts);
}
}
exports.BucketLockConfiguration = BucketLockConfiguration;
/** @internal */
BucketLockConfiguration.__pulumiType = 'scaleway:object/bucketLockConfiguration:BucketLockConfiguration';
//# sourceMappingURL=bucketLockConfiguration.js.map