@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
234 lines (233 loc) • 7.93 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 object
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const _default = new volcengine.tos.BucketObject("default", {
* accountAcls: [
* {
* accountId: "1",
* permission: "READ",
* },
* {
* accountId: "2001",
* permission: "WRITE_ACP",
* },
* ],
* bucketName: "tf-acc-test-bucket",
* encryption: "AES256",
* filePath: "/Users/bytedance/Work/Go/build/test.txt",
* objectName: "tf-acc-test-object",
* publicAcl: "private",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* ```
*
* ## Import
*
* TOS Object can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:tos/bucketObject:BucketObject default bucketName:objectName
* ```
*/
export declare class BucketObject extends pulumi.CustomResource {
/**
* Get an existing BucketObject 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?: BucketObjectState, opts?: pulumi.CustomResourceOptions): BucketObject;
/**
* Returns true if the given object is an instance of BucketObject. 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 BucketObject;
/**
* The user set of grant full control.
*/
readonly accountAcls: pulumi.Output<outputs.tos.BucketObjectAccountAcl[] | undefined>;
/**
* The name of the bucket.
*/
readonly bucketName: pulumi.Output<string>;
/**
* The content of the TOS Object when content type is json or text and xml. Only one of `file_path,content` can be specified.
*/
readonly content: pulumi.Output<string>;
/**
* The file md5 sum (32-bit hexadecimal string) for upload.
*/
readonly contentMd5: pulumi.Output<string | undefined>;
/**
* The content type of the object.
*/
readonly contentType: pulumi.Output<string>;
/**
* The flag of enable tos version.
*/
readonly enableVersion: pulumi.Output<boolean>;
/**
* The encryption of the object.Valid value is AES256.
*/
readonly encryption: pulumi.Output<string | undefined>;
/**
* The file path for upload. Only one of `file_path,content` can be specified.
*/
readonly filePath: pulumi.Output<string | undefined>;
/**
* Whether to enable the default inheritance bucket ACL function for the object.
*/
readonly isDefault: pulumi.Output<boolean>;
/**
* The name of the object.
*/
readonly objectName: pulumi.Output<string>;
/**
* The public acl control of object. Valid value is private|public-read|public-read-write|authenticated-read|bucket-owner-read|default. `default` means to enable the default inheritance bucket ACL function for the object.
*/
readonly publicAcl: pulumi.Output<string | undefined>;
/**
* The storage type of the object.Valid value is STANDARD|IA.
*/
readonly storageClass: pulumi.Output<string | undefined>;
/**
* Tos Bucket Tags.
*/
readonly tags: pulumi.Output<outputs.tos.BucketObjectTag[] | undefined>;
/**
* The version ids of the object if exist.
*/
readonly versionIds: pulumi.Output<string[]>;
/**
* Create a BucketObject 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: BucketObjectArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BucketObject resources.
*/
export interface BucketObjectState {
/**
* The user set of grant full control.
*/
accountAcls?: pulumi.Input<pulumi.Input<inputs.tos.BucketObjectAccountAcl>[]>;
/**
* The name of the bucket.
*/
bucketName?: pulumi.Input<string>;
/**
* The content of the TOS Object when content type is json or text and xml. Only one of `file_path,content` can be specified.
*/
content?: pulumi.Input<string>;
/**
* The file md5 sum (32-bit hexadecimal string) for upload.
*/
contentMd5?: pulumi.Input<string>;
/**
* The content type of the object.
*/
contentType?: pulumi.Input<string>;
/**
* The flag of enable tos version.
*/
enableVersion?: pulumi.Input<boolean>;
/**
* The encryption of the object.Valid value is AES256.
*/
encryption?: pulumi.Input<string>;
/**
* The file path for upload. Only one of `file_path,content` can be specified.
*/
filePath?: pulumi.Input<string>;
/**
* Whether to enable the default inheritance bucket ACL function for the object.
*/
isDefault?: pulumi.Input<boolean>;
/**
* The name of the object.
*/
objectName?: pulumi.Input<string>;
/**
* The public acl control of object. Valid value is private|public-read|public-read-write|authenticated-read|bucket-owner-read|default. `default` means to enable the default inheritance bucket ACL function for the object.
*/
publicAcl?: pulumi.Input<string>;
/**
* The storage type of the object.Valid value is STANDARD|IA.
*/
storageClass?: pulumi.Input<string>;
/**
* Tos Bucket Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.tos.BucketObjectTag>[]>;
/**
* The version ids of the object if exist.
*/
versionIds?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a BucketObject resource.
*/
export interface BucketObjectArgs {
/**
* The user set of grant full control.
*/
accountAcls?: pulumi.Input<pulumi.Input<inputs.tos.BucketObjectAccountAcl>[]>;
/**
* The name of the bucket.
*/
bucketName: pulumi.Input<string>;
/**
* The content of the TOS Object when content type is json or text and xml. Only one of `file_path,content` can be specified.
*/
content?: pulumi.Input<string>;
/**
* The file md5 sum (32-bit hexadecimal string) for upload.
*/
contentMd5?: pulumi.Input<string>;
/**
* The content type of the object.
*/
contentType?: pulumi.Input<string>;
/**
* The encryption of the object.Valid value is AES256.
*/
encryption?: pulumi.Input<string>;
/**
* The file path for upload. Only one of `file_path,content` can be specified.
*/
filePath?: pulumi.Input<string>;
/**
* The name of the object.
*/
objectName: pulumi.Input<string>;
/**
* The public acl control of object. Valid value is private|public-read|public-read-write|authenticated-read|bucket-owner-read|default. `default` means to enable the default inheritance bucket ACL function for the object.
*/
publicAcl?: pulumi.Input<string>;
/**
* The storage type of the object.Valid value is STANDARD|IA.
*/
storageClass?: pulumi.Input<string>;
/**
* Tos Bucket Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.tos.BucketObjectTag>[]>;
}