@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
144 lines • 6.21 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.BucketWebsiteConfiguration = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* The `scaleway.object.BucketWebsiteConfiguration` resource allows you to deploy and manage a bucket website with [Scaleway Object storage](https://www.scaleway.com/en/docs/object-storage/).
*
* Refer to the [dedicated documentation](https://www.scaleway.com/en/docs/object-storage/how-to/use-bucket-website/) for more information on bucket websites.
*
* ## Example Usage
*
* ```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",
* });
* const mainBucketWebsiteConfiguration = new scaleway.object.BucketWebsiteConfiguration("main", {
* bucket: main.id,
* indexDocument: {
* suffix: "index.html",
* },
* });
* ```
*
* ### With A Bucket Policy
*
* ```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",
* });
* const mainBucketPolicy = new scaleway.object.BucketPolicy("main", {
* bucket: main.id,
* policy: JSON.stringify({
* Version: "2012-10-17",
* Id: "MyPolicy",
* Statement: [{
* Sid: "GrantToEveryone",
* Effect: "Allow",
* Principal: "*",
* Action: ["s3:GetObject"],
* Resource: ["<bucket-name>/*"],
* }],
* }),
* });
* const mainBucketWebsiteConfiguration = new scaleway.object.BucketWebsiteConfiguration("main", {
* bucket: main.id,
* indexDocument: {
* suffix: "index.html",
* },
* });
* ```
*
* ## Import
*
* Bucket website configurations can be imported using the `{region}/{bucketName}` identifier, as shown below:
*
* bash
*
* ```sh
* $ pulumi import scaleway:object/bucketWebsiteConfiguration:BucketWebsiteConfiguration 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/bucketWebsiteConfiguration:BucketWebsiteConfiguration some_bucket fr-par/some-bucket@xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
* ```
*/
class BucketWebsiteConfiguration extends pulumi.CustomResource {
/**
* Get an existing BucketWebsiteConfiguration 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 BucketWebsiteConfiguration(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of BucketWebsiteConfiguration. 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'] === BucketWebsiteConfiguration.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["bucket"] = state ? state.bucket : undefined;
resourceInputs["errorDocument"] = state ? state.errorDocument : undefined;
resourceInputs["indexDocument"] = state ? state.indexDocument : undefined;
resourceInputs["projectId"] = state ? state.projectId : undefined;
resourceInputs["region"] = state ? state.region : undefined;
resourceInputs["websiteDomain"] = state ? state.websiteDomain : undefined;
resourceInputs["websiteEndpoint"] = state ? state.websiteEndpoint : undefined;
}
else {
const args = argsOrState;
if ((!args || args.bucket === undefined) && !opts.urn) {
throw new Error("Missing required property 'bucket'");
}
if ((!args || args.indexDocument === undefined) && !opts.urn) {
throw new Error("Missing required property 'indexDocument'");
}
resourceInputs["bucket"] = args ? args.bucket : undefined;
resourceInputs["errorDocument"] = args ? args.errorDocument : undefined;
resourceInputs["indexDocument"] = args ? args.indexDocument : undefined;
resourceInputs["projectId"] = args ? args.projectId : undefined;
resourceInputs["region"] = args ? args.region : undefined;
resourceInputs["websiteDomain"] = undefined /*out*/;
resourceInputs["websiteEndpoint"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "scaleway:index/objectBucketWebsiteConfiguration:ObjectBucketWebsiteConfiguration" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(BucketWebsiteConfiguration.__pulumiType, name, resourceInputs, opts);
}
}
exports.BucketWebsiteConfiguration = BucketWebsiteConfiguration;
/** @internal */
BucketWebsiteConfiguration.__pulumiType = 'scaleway:object/bucketWebsiteConfiguration:BucketWebsiteConfiguration';
//# sourceMappingURL=bucketWebsiteConfiguration.js.map