UNPKG

@volcengine/pulumi

Version:

A Pulumi package for creating and managing volcengine cloud resources.

106 lines (105 loc) 3.55 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Provides a resource to manage tos bucket encryption * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as volcengine from "@volcengine/pulumi"; * * const fooBucket = new volcengine.tos.Bucket("fooBucket", { * bucketName: "tf-acc-test-bucket1", * publicAcl: "private", * azRedundancy: "multi-az", * projectName: "default", * tags: [{ * key: "k1", * value: "v1", * }], * }); * const fooKeyring = new volcengine.kms.Keyring("fooKeyring", { * keyringName: "acc-test-keyring", * description: "acc-test", * projectName: "default", * }); * const fooBucketEncryption = new volcengine.tos.BucketEncryption("fooBucketEncryption", { * bucketName: fooBucket.id, * rule: { * applyServerSideEncryptionByDefault: { * sseAlgorithm: "kms", * kmsDataEncryption: "AES256", * kmsMasterKeyId: fooKeyring.id, * }, * }, * }); * ``` * * ## Import * * TosBucketEncryption can be imported using the id, e.g. * * ```sh * $ pulumi import volcengine:tos/bucketEncryption:BucketEncryption default resource_id * ``` */ export declare class BucketEncryption extends pulumi.CustomResource { /** * Get an existing BucketEncryption 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?: BucketEncryptionState, opts?: pulumi.CustomResourceOptions): BucketEncryption; /** * Returns true if the given object is an instance of BucketEncryption. 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 BucketEncryption; /** * The name of the bucket. */ readonly bucketName: pulumi.Output<string>; /** * The rule of the bucket encryption. */ readonly rule: pulumi.Output<outputs.tos.BucketEncryptionRule>; /** * Create a BucketEncryption 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: BucketEncryptionArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering BucketEncryption resources. */ export interface BucketEncryptionState { /** * The name of the bucket. */ bucketName?: pulumi.Input<string>; /** * The rule of the bucket encryption. */ rule?: pulumi.Input<inputs.tos.BucketEncryptionRule>; } /** * The set of arguments for constructing a BucketEncryption resource. */ export interface BucketEncryptionArgs { /** * The name of the bucket. */ bucketName: pulumi.Input<string>; /** * The rule of the bucket encryption. */ rule: pulumi.Input<inputs.tos.BucketEncryptionRule>; }