@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
181 lines (180 loc) • 5.91 kB
TypeScript
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 inventory
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.tos.BucketInventory("foo", {
* bucketName: "terraform-demo",
* destination: {
* tosBucketDestination: {
* accountId: "21000*****",
* bucket: "terraform-demo",
* format: "CSV",
* prefix: "tf-test-prefix",
* role: "TosArchiveTOSInventory",
* },
* },
* filter: {
* prefix: "test-tf",
* },
* includedObjectVersions: "All",
* inventoryId: "acc-test-inventory",
* isEnabled: true,
* optionalFields: {
* fields: [
* "Size",
* "StorageClass",
* "CRC64",
* ],
* },
* schedule: {
* frequency: "Weekly",
* },
* });
* ```
*
* ## Import
*
* TosBucketInventory can be imported using the bucket_name:inventory_id, e.g.
*
* ```sh
* $ pulumi import volcengine:tos/bucketInventory:BucketInventory default resource_id
* ```
*/
export declare class BucketInventory extends pulumi.CustomResource {
/**
* Get an existing BucketInventory 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?: BucketInventoryState, opts?: pulumi.CustomResourceOptions): BucketInventory;
/**
* Returns true if the given object is an instance of BucketInventory. 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 BucketInventory;
/**
* The name of the bucket.
*/
readonly bucketName: pulumi.Output<string>;
/**
* The destination information of the bucket inventory.
*/
readonly destination: pulumi.Output<outputs.tos.BucketInventoryDestination>;
/**
* The filter of the bucket inventory.
*/
readonly filter: pulumi.Output<outputs.tos.BucketInventoryFilter | undefined>;
/**
* The export version of object. Valid values: `All`, `Current`.
*/
readonly includedObjectVersions: pulumi.Output<string>;
/**
* The name of the bucket inventory.
*/
readonly inventoryId: pulumi.Output<string>;
/**
* Whether to enable the bucket inventory.
*/
readonly isEnabled: pulumi.Output<boolean>;
/**
* The information exported from the bucket inventory.
*/
readonly optionalFields: pulumi.Output<outputs.tos.BucketInventoryOptionalFields | undefined>;
/**
* The export schedule of the bucket inventory.
*/
readonly schedule: pulumi.Output<outputs.tos.BucketInventorySchedule>;
/**
* Create a BucketInventory 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: BucketInventoryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BucketInventory resources.
*/
export interface BucketInventoryState {
/**
* The name of the bucket.
*/
bucketName?: pulumi.Input<string>;
/**
* The destination information of the bucket inventory.
*/
destination?: pulumi.Input<inputs.tos.BucketInventoryDestination>;
/**
* The filter of the bucket inventory.
*/
filter?: pulumi.Input<inputs.tos.BucketInventoryFilter>;
/**
* The export version of object. Valid values: `All`, `Current`.
*/
includedObjectVersions?: pulumi.Input<string>;
/**
* The name of the bucket inventory.
*/
inventoryId?: pulumi.Input<string>;
/**
* Whether to enable the bucket inventory.
*/
isEnabled?: pulumi.Input<boolean>;
/**
* The information exported from the bucket inventory.
*/
optionalFields?: pulumi.Input<inputs.tos.BucketInventoryOptionalFields>;
/**
* The export schedule of the bucket inventory.
*/
schedule?: pulumi.Input<inputs.tos.BucketInventorySchedule>;
}
/**
* The set of arguments for constructing a BucketInventory resource.
*/
export interface BucketInventoryArgs {
/**
* The name of the bucket.
*/
bucketName: pulumi.Input<string>;
/**
* The destination information of the bucket inventory.
*/
destination: pulumi.Input<inputs.tos.BucketInventoryDestination>;
/**
* The filter of the bucket inventory.
*/
filter?: pulumi.Input<inputs.tos.BucketInventoryFilter>;
/**
* The export version of object. Valid values: `All`, `Current`.
*/
includedObjectVersions: pulumi.Input<string>;
/**
* The name of the bucket inventory.
*/
inventoryId: pulumi.Input<string>;
/**
* Whether to enable the bucket inventory.
*/
isEnabled: pulumi.Input<boolean>;
/**
* The information exported from the bucket inventory.
*/
optionalFields?: pulumi.Input<inputs.tos.BucketInventoryOptionalFields>;
/**
* The export schedule of the bucket inventory.
*/
schedule: pulumi.Input<inputs.tos.BucketInventorySchedule>;
}