@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
199 lines • 7.72 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* The `scaleway.object.BucketServerSideEncryptionConfiguration` resource allows you to manage server-side encryption configuration for [Scaleway Object Storage](https://www.scaleway.com/en/docs/object-storage/) buckets.
*
* Refer to the [dedicated documentation](https://www.scaleway.com/en/docs/object-storage/api-cli/enable-sse-one/) for more information on server-side encryption.
*
* ## 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",
* region: "fr-par",
* });
* const mykey = new scaleway.keymanager.Key("mykey", {
* name: "my-kms-key",
* description: "This key is used to encrypt bucket objects",
* usage: "asymmetric_encryption",
* algorithm: "rsa_oaep_4096_sha256",
* unprotected: true,
* });
* const testBucketServerSideEncryptionConfiguration = new scaleway.object.BucketServerSideEncryptionConfiguration("test", {
* bucket: test.name,
* region: "fr-par",
* rules: [{
* applyServerSideEncryptionByDefault: {
* kmsMasterKeyId: mykey.name,
* sseAlgorithm: "aws:kms",
* },
* bucketKeyEnabled: true,
* }],
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const test = new scaleway.object.Bucket("test", {
* name: "my-bucket",
* region: "fr-par",
* });
* const testBucketServerSideEncryptionConfiguration = new scaleway.object.BucketServerSideEncryptionConfiguration("test", {
* bucket: test.name,
* region: "fr-par",
* rules: [{
* applyServerSideEncryptionByDefault: {
* kmsMasterKeyId: "my-key-id",
* sseAlgorithm: "aws:kms",
* },
* bucketKeyEnabled: true,
* }],
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const test = new scaleway.object.Bucket("test", {
* name: "my-unique-bucket-name",
* region: "fr-par",
* });
* const testBucketServerSideEncryptionConfiguration = new scaleway.object.BucketServerSideEncryptionConfiguration("test", {
* bucket: test.name,
* region: "fr-par",
* rules: [{
* applyServerSideEncryptionByDefault: {
* sseAlgorithm: "AES256",
* },
* }],
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const test = new scaleway.object.Bucket("test", {name: "my-unique-bucket-name"});
* const testBucketServerSideEncryptionConfiguration = new scaleway.object.BucketServerSideEncryptionConfiguration("test", {
* bucket: test.name,
* rules: [{
* applyServerSideEncryptionByDefault: {
* sseAlgorithm: "AES256",
* },
* }],
* });
* ```
*
* ## Import
*
* Server-side encryption configurations can be imported using the `{region}/{bucketName}` identifier, as shown below:
*
* ```sh
* $ pulumi import scaleway:object/bucketServerSideEncryptionConfiguration:BucketServerSideEncryptionConfiguration test fr-par/my-bucket-name
* ```
*
* > **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:object/bucketServerSideEncryptionConfiguration:BucketServerSideEncryptionConfiguration test fr-par/my-bucket-name@11111111-1111-1111-1111-111111111111
* ```
*
* <!--- Links, invisible in the final document --->
*
* [1]: ../index.md#arguments-reference
*/
export declare class BucketServerSideEncryptionConfiguration extends pulumi.CustomResource {
/**
* Get an existing BucketServerSideEncryptionConfiguration 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?: BucketServerSideEncryptionConfigurationState, opts?: pulumi.CustomResourceOptions): BucketServerSideEncryptionConfiguration;
/**
* Returns true if the given object is an instance of BucketServerSideEncryptionConfiguration. 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 BucketServerSideEncryptionConfiguration;
/**
* The bucket's name or regional ID.
*/
readonly bucket: pulumi.Output<string>;
/**
* The ID of the
* project the bucket is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* The [region](https://www.scaleway.com/en/developers/api/#region-definition) in which the bucket is located.
*/
readonly region: pulumi.Output<string | undefined>;
/**
* Set of server-side encryption configuration rules
*/
readonly rules: pulumi.Output<outputs.object.BucketServerSideEncryptionConfigurationRule[]>;
/**
* Create a BucketServerSideEncryptionConfiguration 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: BucketServerSideEncryptionConfigurationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BucketServerSideEncryptionConfiguration resources.
*/
export interface BucketServerSideEncryptionConfigurationState {
/**
* The bucket's name or regional ID.
*/
bucket?: pulumi.Input<string | undefined>;
/**
* The ID of the
* project the bucket is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The [region](https://www.scaleway.com/en/developers/api/#region-definition) in which the bucket is located.
*/
region?: pulumi.Input<string | undefined>;
/**
* Set of server-side encryption configuration rules
*/
rules?: pulumi.Input<pulumi.Input<inputs.object.BucketServerSideEncryptionConfigurationRule>[] | undefined>;
}
/**
* The set of arguments for constructing a BucketServerSideEncryptionConfiguration resource.
*/
export interface BucketServerSideEncryptionConfigurationArgs {
/**
* The bucket's name or regional ID.
*/
bucket: pulumi.Input<string>;
/**
* The ID of the
* project the bucket is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* The [region](https://www.scaleway.com/en/developers/api/#region-definition) in which the bucket is located.
*/
region?: pulumi.Input<string | undefined>;
/**
* Set of server-side encryption configuration rules
*/
rules: pulumi.Input<pulumi.Input<inputs.object.BucketServerSideEncryptionConfigurationRule>[]>;
}
//# sourceMappingURL=bucketServerSideEncryptionConfiguration.d.ts.map