import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * 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 test = new scaleway.object.Bucket("test", { * name: "my-bucket", * acl: "public-read", * }); * const someFile = new scaleway.object.Item("some_file", { * bucket: test.name, * key: "index.html", * file: "index.html", * visibility: "public-read", * contentType: "text/html", * }); * const testBucketWebsiteConfiguration = new scaleway.object.BucketWebsiteConfiguration("test", { * bucket: test.name, * indexDocument: { * suffix: "index.html", * }, * errorDocument: { * key: "error.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: ["/*"], * }], * }), * }); * 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: * * ```sh * $ pulumi import scaleway:index/objectBucketWebsiteConfiguration:ObjectBucketWebsiteConfiguration some_bucket fr-par/some-bucket * ``` * * > **Important:** The `projectId` 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. * * ```sh * $ pulumi import scaleway:index/objectBucketWebsiteConfiguration:ObjectBucketWebsiteConfiguration some_bucket fr-par/some-bucket@xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx * ``` * * @deprecated scaleway.index/objectbucketwebsiteconfiguration.ObjectBucketWebsiteConfiguration has been deprecated in favor of scaleway.object/bucketwebsiteconfiguration.BucketWebsiteConfiguration */ export declare class ObjectBucketWebsiteConfiguration extends pulumi.CustomResource { /** * Get an existing ObjectBucketWebsiteConfiguration 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, state?: ObjectBucketWebsiteConfigurationState, opts?: pulumi.CustomResourceOptions): ObjectBucketWebsiteConfiguration; /** * Returns true if the given object is an instance of ObjectBucketWebsiteConfiguration. 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 ObjectBucketWebsiteConfiguration; /** * The name of the bucket. */ readonly bucket: pulumi.Output; /** * The name of the error file for the website detailed below. */ readonly errorDocument: pulumi.Output; /** * The name of the index file for the website detailed below. */ readonly indexDocument: pulumi.Output; /** * `projectId`) The ID of the project the bucket is associated with. * * > **Important:** The `projectId` 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 `projectId` for every child resource of the bucket, * like bucket website configurations. Otherwise, Terraform will try to create the child resource with the default project ID and you will get a 403 error. */ readonly projectId: pulumi.Output; /** * The region you want to attach the resource to */ readonly region: pulumi.Output; /** * The domain of the website endpoint. This is used to create DNS alias [records](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/). */ readonly websiteDomain: pulumi.Output; /** * The website endpoint. */ readonly websiteEndpoint: pulumi.Output; /** * Create a ObjectBucketWebsiteConfiguration 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/objectbucketwebsiteconfiguration.ObjectBucketWebsiteConfiguration has been deprecated in favor of scaleway.object/bucketwebsiteconfiguration.BucketWebsiteConfiguration */ constructor(name: string, args: ObjectBucketWebsiteConfigurationArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ObjectBucketWebsiteConfiguration resources. */ export interface ObjectBucketWebsiteConfigurationState { /** * The name of the bucket. */ bucket?: pulumi.Input; /** * The name of the error file for the website detailed below. */ errorDocument?: pulumi.Input; /** * The name of the index file for the website detailed below. */ indexDocument?: pulumi.Input; /** * `projectId`) The ID of the project the bucket is associated with. * * > **Important:** The `projectId` 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 `projectId` for every child resource of the bucket, * like bucket website configurations. Otherwise, Terraform will try to create the child resource with the default project ID and you will get a 403 error. */ projectId?: pulumi.Input; /** * The region you want to attach the resource to */ region?: pulumi.Input; /** * The domain of the website endpoint. This is used to create DNS alias [records](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/). */ websiteDomain?: pulumi.Input; /** * The website endpoint. */ websiteEndpoint?: pulumi.Input; } /** * The set of arguments for constructing a ObjectBucketWebsiteConfiguration resource. */ export interface ObjectBucketWebsiteConfigurationArgs { /** * The name of the bucket. */ bucket: pulumi.Input; /** * The name of the error file for the website detailed below. */ errorDocument?: pulumi.Input; /** * The name of the index file for the website detailed below. */ indexDocument: pulumi.Input; /** * `projectId`) The ID of the project the bucket is associated with. * * > **Important:** The `projectId` 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 `projectId` for every child resource of the bucket, * like bucket website configurations. Otherwise, Terraform will try to create the child resource with the default project ID and you will get a 403 error. */ projectId?: pulumi.Input; /** * The region you want to attach the resource to */ region?: pulumi.Input; } //# sourceMappingURL=objectBucketWebsiteConfiguration.d.ts.map