published on Thursday, Aug 6, 2026 by Volcengine
published on Thursday, Aug 6, 2026 by Volcengine
TOS objects are the basic data units in a bucket. This resource is used to manage JSON, text, and XML objects via CCAPI; images or other arbitrary binary objects are not supported.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
const example = new volcenginecc.tos.TosObject("Example", {
bucket: "ccapi-test-1",
key: "example-key.xml",
content: "<test>content</test>",
contentType: "application/xml",
metadatas: [{
value: "meta-value1",
key: "meta-key1",
}],
storageClass: "STANDARD",
publicAcl: "private",
serverSideEncryption: "AES256",
tags: [{
value: "tag-value1",
key: "tag-key1",
}],
accountAcls: [
{
acl_type: "CanonicalUser",
account_id: "21xxxxx77",
permission: "READ",
},
{
acl_type: "CanonicalUser",
account_id: "21xxxxx77",
permission: "WRITE",
},
],
});
import pulumi
import pulumi_volcenginecc as volcenginecc
example = volcenginecc.tos.TosObject("Example",
bucket="ccapi-test-1",
key="example-key.xml",
content="<test>content</test>",
content_type="application/xml",
metadatas=[{
"value": "meta-value1",
"key": "meta-key1",
}],
storage_class="STANDARD",
public_acl="private",
server_side_encryption="AES256",
tags=[{
"value": "tag-value1",
"key": "tag-key1",
}],
account_acls=[
{
"acl_type": "CanonicalUser",
"account_id": "21xxxxx77",
"permission": "READ",
},
{
"acl_type": "CanonicalUser",
"account_id": "21xxxxx77",
"permission": "WRITE",
},
])
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/tos"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tos.NewTosObject(ctx, "Example", &tos.TosObjectArgs{
Bucket: pulumi.String("ccapi-test-1"),
Key: pulumi.String("example-key.xml"),
Content: pulumi.String("<test>content</test>"),
ContentType: pulumi.String("application/xml"),
Metadatas: tos.TosObjectMetadataArray{
&tos.TosObjectMetadataArgs{
Value: pulumi.String("meta-value1"),
Key: pulumi.String("meta-key1"),
},
},
StorageClass: pulumi.String("STANDARD"),
PublicAcl: pulumi.String("private"),
ServerSideEncryption: pulumi.String("AES256"),
Tags: tos.TosObjectTagArray{
&tos.TosObjectTagArgs{
Value: pulumi.String("tag-value1"),
Key: pulumi.String("tag-key1"),
},
},
AccountAcls: tos.TosObjectAccountAclArray{
&tos.TosObjectAccountAclArgs{
Acl_type: "CanonicalUser",
Account_id: "21xxxxx77",
Permission: pulumi.String("READ"),
},
&tos.TosObjectAccountAclArgs{
Acl_type: "CanonicalUser",
Account_id: "21xxxxx77",
Permission: pulumi.String("WRITE"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
return await Deployment.RunAsync(() =>
{
var example = new Volcenginecc.Tos.TosObject("Example", new()
{
Bucket = "ccapi-test-1",
Key = "example-key.xml",
Content = "<test>content</test>",
ContentType = "application/xml",
Metadatas = new[]
{
new Volcenginecc.Tos.Inputs.TosObjectMetadataArgs
{
Value = "meta-value1",
Key = "meta-key1",
},
},
StorageClass = "STANDARD",
PublicAcl = "private",
ServerSideEncryption = "AES256",
Tags = new[]
{
new Volcenginecc.Tos.Inputs.TosObjectTagArgs
{
Value = "tag-value1",
Key = "tag-key1",
},
},
AccountAcls = new[]
{
new Volcenginecc.Tos.Inputs.TosObjectAccountAclArgs
{
Acl_type = "CanonicalUser",
Account_id = "21xxxxx77",
Permission = "READ",
},
new Volcenginecc.Tos.Inputs.TosObjectAccountAclArgs
{
Acl_type = "CanonicalUser",
Account_id = "21xxxxx77",
Permission = "WRITE",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.tos.TosObject;
import com.volcengine.volcenginecc.tos.TosObjectArgs;
import com.pulumi.volcenginecc.tos.inputs.TosObjectMetadataArgs;
import com.pulumi.volcenginecc.tos.inputs.TosObjectTagArgs;
import com.pulumi.volcenginecc.tos.inputs.TosObjectAccountAclArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new TosObject("example", TosObjectArgs.builder()
.bucket("ccapi-test-1")
.key("example-key.xml")
.content("<test>content</test>")
.contentType("application/xml")
.metadatas(TosObjectMetadataArgs.builder()
.value("meta-value1")
.key("meta-key1")
.build())
.storageClass("STANDARD")
.publicAcl("private")
.serverSideEncryption("AES256")
.tags(TosObjectTagArgs.builder()
.value("tag-value1")
.key("tag-key1")
.build())
.accountAcls(
TosObjectAccountAclArgs.builder()
.acl_type("CanonicalUser")
.account_id("21xxxxx77")
.permission("READ")
.build(),
TosObjectAccountAclArgs.builder()
.acl_type("CanonicalUser")
.account_id("21xxxxx77")
.permission("WRITE")
.build())
.build());
}
}
resources:
example:
type: volcenginecc:tos:TosObject
name: Example
properties:
bucket: ccapi-test-1
key: example-key.xml
content: <test>content</test>
contentType: application/xml
metadatas:
- value: meta-value1
key: meta-key1
storageClass: STANDARD
publicAcl: private
serverSideEncryption: AES256
tags:
- value: tag-value1
key: tag-key1
accountAcls:
- acl_type: CanonicalUser
account_id: 21xxxxx77
permission: READ
- acl_type: CanonicalUser
account_id: 21xxxxx77
permission: WRITE
pulumi {
required_providers {
volcenginecc = {
source = "pulumi/volcenginecc"
}
}
}
resource "volcenginecc_tos_tosobject" "Example" {
bucket = "ccapi-test-1"
key = "example-key.xml"
content = "<test>content</test>"
content_type = "application/xml"
metadatas {
value = "meta-value1"
key = "meta-key1"
}
storage_class = "STANDARD"
public_acl = "private"
server_side_encryption = "AES256"
tags {
value = "tag-value1"
key = "tag-key1"
}
account_acls {
acl_type = "CanonicalUser"
account_id = "21xxxxx77"
permission = "READ"
}
account_acls {
acl_type = "CanonicalUser"
account_id = "21xxxxx77"
permission = "WRITE"
}
}
Create TosObject Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TosObject(name: string, args: TosObjectArgs, opts?: CustomResourceOptions);@overload
def TosObject(resource_name: str,
args: TosObjectArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TosObject(resource_name: str,
opts: Optional[ResourceOptions] = None,
bucket: Optional[str] = None,
content: Optional[str] = None,
content_type: Optional[str] = None,
key: Optional[str] = None,
account_acls: Optional[Sequence[TosObjectAccountAclArgs]] = None,
metadatas: Optional[Sequence[TosObjectMetadataArgs]] = None,
public_acl: Optional[str] = None,
server_side_encryption: Optional[str] = None,
storage_class: Optional[str] = None,
tags: Optional[Sequence[TosObjectTagArgs]] = None)func NewTosObject(ctx *Context, name string, args TosObjectArgs, opts ...ResourceOption) (*TosObject, error)public TosObject(string name, TosObjectArgs args, CustomResourceOptions? opts = null)
public TosObject(String name, TosObjectArgs args)
public TosObject(String name, TosObjectArgs args, CustomResourceOptions options)
type: volcenginecc:tos:TosObject
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "volcenginecc_tos_tos_object" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args TosObjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TosObjectArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TosObjectArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TosObjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TosObjectArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var tosObjectResource = new Volcenginecc.Tos.TosObject("tosObjectResource", new()
{
Bucket = "string",
Content = "string",
ContentType = "string",
Key = "string",
AccountAcls = new[]
{
new Volcenginecc.Tos.Inputs.TosObjectAccountAclArgs
{
AccountId = "string",
AclType = "string",
Permission = "string",
},
},
Metadatas = new[]
{
new Volcenginecc.Tos.Inputs.TosObjectMetadataArgs
{
Key = "string",
Value = "string",
},
},
PublicAcl = "string",
ServerSideEncryption = "string",
StorageClass = "string",
Tags = new[]
{
new Volcenginecc.Tos.Inputs.TosObjectTagArgs
{
Key = "string",
Value = "string",
},
},
});
example, err := tos.NewTosObject(ctx, "tosObjectResource", &tos.TosObjectArgs{
Bucket: pulumi.String("string"),
Content: pulumi.String("string"),
ContentType: pulumi.String("string"),
Key: pulumi.String("string"),
AccountAcls: tos.TosObjectAccountAclArray{
&tos.TosObjectAccountAclArgs{
AccountId: pulumi.String("string"),
AclType: pulumi.String("string"),
Permission: pulumi.String("string"),
},
},
Metadatas: tos.TosObjectMetadataArray{
&tos.TosObjectMetadataArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
PublicAcl: pulumi.String("string"),
ServerSideEncryption: pulumi.String("string"),
StorageClass: pulumi.String("string"),
Tags: tos.TosObjectTagArray{
&tos.TosObjectTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
})
resource "volcenginecc_tos_tos_object" "tosObjectResource" {
lifecycle {
create_before_destroy = true
}
bucket = "string"
content = "string"
content_type = "string"
key = "string"
account_acls {
account_id = "string"
acl_type = "string"
permission = "string"
}
metadatas {
key = "string"
value = "string"
}
public_acl = "string"
server_side_encryption = "string"
storage_class = "string"
tags {
key = "string"
value = "string"
}
}
var tosObjectResource = new TosObject("tosObjectResource", TosObjectArgs.builder()
.bucket("string")
.content("string")
.contentType("string")
.key("string")
.accountAcls(TosObjectAccountAclArgs.builder()
.accountId("string")
.aclType("string")
.permission("string")
.build())
.metadatas(TosObjectMetadataArgs.builder()
.key("string")
.value("string")
.build())
.publicAcl("string")
.serverSideEncryption("string")
.storageClass("string")
.tags(TosObjectTagArgs.builder()
.key("string")
.value("string")
.build())
.build());
tos_object_resource = volcenginecc.tos.TosObject("tosObjectResource",
bucket="string",
content="string",
content_type="string",
key="string",
account_acls=[{
"account_id": "string",
"acl_type": "string",
"permission": "string",
}],
metadatas=[{
"key": "string",
"value": "string",
}],
public_acl="string",
server_side_encryption="string",
storage_class="string",
tags=[{
"key": "string",
"value": "string",
}])
const tosObjectResource = new volcenginecc.tos.TosObject("tosObjectResource", {
bucket: "string",
content: "string",
contentType: "string",
key: "string",
accountAcls: [{
accountId: "string",
aclType: "string",
permission: "string",
}],
metadatas: [{
key: "string",
value: "string",
}],
publicAcl: "string",
serverSideEncryption: "string",
storageClass: "string",
tags: [{
key: "string",
value: "string",
}],
});
type: volcenginecc:tos:TosObject
properties:
accountAcls:
- accountId: string
aclType: string
permission: string
bucket: string
content: string
contentType: string
key: string
metadatas:
- key: string
value: string
publicAcl: string
serverSideEncryption: string
storageClass: string
tags:
- key: string
value: string
TosObject Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The TosObject resource accepts the following input properties:
- Bucket string
- Name of the bucket to which the object belongs.
- Content string
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- Content
Type string - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- Key string
- Full key name of the object in the bucket.
- Account
Acls List<Volcengine.Tos Object Account Acl> - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Metadatas
List<Volcengine.
Tos Object Metadata> - User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Public
Acl string - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- Server
Side stringEncryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- Storage
Class string - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
-
List<Volcengine.
Tos Object Tag> - Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Bucket string
- Name of the bucket to which the object belongs.
- Content string
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- Content
Type string - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- Key string
- Full key name of the object in the bucket.
- Account
Acls []TosObject Account Acl Args - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Metadatas
[]Tos
Object Metadata Args - User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Public
Acl string - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- Server
Side stringEncryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- Storage
Class string - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
-
[]Tos
Object Tag Args - Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- bucket string
- Name of the bucket to which the object belongs.
- content string
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- content_
type string - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- key string
- Full key name of the object in the bucket.
- account_
acls list(object) - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- metadatas list(object)
- User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- public_
acl string - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- server_
side_ stringencryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- storage_
class string - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
- list(object)
- Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- bucket String
- Name of the bucket to which the object belongs.
- content String
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- content
Type String - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- key String
- Full key name of the object in the bucket.
- account
Acls List<TosObject Account Acl> - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- metadatas
List<Tos
Object Metadata> - User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- public
Acl String - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- server
Side StringEncryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- storage
Class String - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
-
List<Tos
Object Tag> - Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- bucket string
- Name of the bucket to which the object belongs.
- content string
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- content
Type string - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- key string
- Full key name of the object in the bucket.
- account
Acls TosObject Account Acl[] - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- metadatas
Tos
Object Metadata[] - User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- public
Acl string - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- server
Side stringEncryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- storage
Class string - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
-
Tos
Object Tag[] - Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- bucket str
- Name of the bucket to which the object belongs.
- content str
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- content_
type str - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- key str
- Full key name of the object in the bucket.
- account_
acls Sequence[TosObject Account Acl Args] - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- metadatas
Sequence[Tos
Object Metadata Args] - User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- public_
acl str - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- server_
side_ strencryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- storage_
class str - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
-
Sequence[Tos
Object Tag Args] - Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- bucket String
- Name of the bucket to which the object belongs.
- content String
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- content
Type String - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- key String
- Full key name of the object in the bucket.
- account
Acls List<Property Map> - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- metadatas List<Property Map>
- User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- public
Acl String - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- server
Side StringEncryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- storage
Class String - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
- List<Property Map>
- Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
Outputs
All input properties are implicitly available as output properties. Additionally, the TosObject resource produces the following output properties:
- Content
Length int - Object content length, in bytes.
- ETag string
- Object ETag.
- Hash
Crc32C string - Object CRC32C checksum value.
- Hash
Crc64Ecma string - Object CRC64 checksum.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Default bool - Whether the object inherits the bucket ACL by default.
- Last
Modified string - Object last modified time.
- Object
Type string - Object type.
- Url string
- Presigned URL for downloading the object.
- Version
IDs List<string> - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- Version
Id string - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- Content
Length int - Object content length, in bytes.
- ETag string
- Object ETag.
- Hash
Crc32C string - Object CRC32C checksum value.
- Hash
Crc64Ecma string - Object CRC64 checksum.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Default bool - Whether the object inherits the bucket ACL by default.
- Last
Modified string - Object last modified time.
- Object
Type string - Object type.
- Url string
- Presigned URL for downloading the object.
- Version
IDs []string - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- Version
Id string - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- content_
length number - Object content length, in bytes.
- e_
tag string - Object ETag.
- hash_
crc32_ stringc - Object CRC32C checksum value.
- hash_
crc64_ stringecma - Object CRC64 checksum.
- id string
- The provider-assigned unique ID for this managed resource.
- is_
default bool - Whether the object inherits the bucket ACL by default.
- last_
modified string - Object last modified time.
- object_
type string - Object type.
- url string
- Presigned URL for downloading the object.
- version_
i_ list(string)ds - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- version_
id string - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- content
Length Integer - Object content length, in bytes.
- e
Tag String - Object ETag.
- hash
Crc32C String - Object CRC32C checksum value.
- hash
Crc64Ecma String - Object CRC64 checksum.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Default Boolean - Whether the object inherits the bucket ACL by default.
- last
Modified String - Object last modified time.
- object
Type String - Object type.
- url String
- Presigned URL for downloading the object.
- version
IDs List<String> - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- version
Id String - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- content
Length number - Object content length, in bytes.
- e
Tag string - Object ETag.
- hash
Crc32C string - Object CRC32C checksum value.
- hash
Crc64Ecma string - Object CRC64 checksum.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Default boolean - Whether the object inherits the bucket ACL by default.
- last
Modified string - Object last modified time.
- object
Type string - Object type.
- url string
- Presigned URL for downloading the object.
- version
IDs string[] - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- version
Id string - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- content_
length int - Object content length, in bytes.
- e_
tag str - Object ETag.
- hash_
crc32_ strc - Object CRC32C checksum value.
- hash_
crc64_ strecma - Object CRC64 checksum.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
default bool - Whether the object inherits the bucket ACL by default.
- last_
modified str - Object last modified time.
- object_
type str - Object type.
- url str
- Presigned URL for downloading the object.
- version_
id str - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- version_
ids Sequence[str] - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- content
Length Number - Object content length, in bytes.
- e
Tag String - Object ETag.
- hash
Crc32C String - Object CRC32C checksum value.
- hash
Crc64Ecma String - Object CRC64 checksum.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Default Boolean - Whether the object inherits the bucket ACL by default.
- last
Modified String - Object last modified time.
- object
Type String - Object type.
- url String
- Presigned URL for downloading the object.
- version
IDs List<String> - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- version
Id String - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
Look up Existing TosObject Resource
Get an existing TosObject resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TosObjectState, opts?: CustomResourceOptions): TosObject@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_acls: Optional[Sequence[TosObjectAccountAclArgs]] = None,
bucket: Optional[str] = None,
content: Optional[str] = None,
content_length: Optional[int] = None,
content_type: Optional[str] = None,
e_tag: Optional[str] = None,
hash_crc32_c: Optional[str] = None,
hash_crc64_ecma: Optional[str] = None,
is_default: Optional[bool] = None,
key: Optional[str] = None,
last_modified: Optional[str] = None,
metadatas: Optional[Sequence[TosObjectMetadataArgs]] = None,
object_type: Optional[str] = None,
public_acl: Optional[str] = None,
server_side_encryption: Optional[str] = None,
storage_class: Optional[str] = None,
tags: Optional[Sequence[TosObjectTagArgs]] = None,
url: Optional[str] = None,
version_ids: Optional[Sequence[str]] = None,
version_id: Optional[str] = None) -> TosObjectfunc GetTosObject(ctx *Context, name string, id IDInput, state *TosObjectState, opts ...ResourceOption) (*TosObject, error)public static TosObject Get(string name, Input<string> id, TosObjectState? state, CustomResourceOptions? opts = null)public static TosObject get(String name, Output<String> id, TosObjectState state, CustomResourceOptions options)resources: _: type: volcenginecc:tos:TosObject get: id: ${id}import {
to = volcenginecc_tos_tos_object.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Account
Acls List<Volcengine.Tos Object Account Acl> - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Bucket string
- Name of the bucket to which the object belongs.
- Content string
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- Content
Length int - Object content length, in bytes.
- Content
Type string - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- ETag string
- Object ETag.
- Hash
Crc32C string - Object CRC32C checksum value.
- Hash
Crc64Ecma string - Object CRC64 checksum.
- Is
Default bool - Whether the object inherits the bucket ACL by default.
- Key string
- Full key name of the object in the bucket.
- Last
Modified string - Object last modified time.
- Metadatas
List<Volcengine.
Tos Object Metadata> - User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Object
Type string - Object type.
- Public
Acl string - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- Server
Side stringEncryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- Storage
Class string - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
-
List<Volcengine.
Tos Object Tag> - Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Url string
- Presigned URL for downloading the object.
- Version
IDs List<string> - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- Version
Id string - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- Account
Acls []TosObject Account Acl Args - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Bucket string
- Name of the bucket to which the object belongs.
- Content string
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- Content
Length int - Object content length, in bytes.
- Content
Type string - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- ETag string
- Object ETag.
- Hash
Crc32C string - Object CRC32C checksum value.
- Hash
Crc64Ecma string - Object CRC64 checksum.
- Is
Default bool - Whether the object inherits the bucket ACL by default.
- Key string
- Full key name of the object in the bucket.
- Last
Modified string - Object last modified time.
- Metadatas
[]Tos
Object Metadata Args - User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Object
Type string - Object type.
- Public
Acl string - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- Server
Side stringEncryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- Storage
Class string - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
-
[]Tos
Object Tag Args - Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- Url string
- Presigned URL for downloading the object.
- Version
IDs []string - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- Version
Id string - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- account_
acls list(object) - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- bucket string
- Name of the bucket to which the object belongs.
- content string
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- content_
length number - Object content length, in bytes.
- content_
type string - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- e_
tag string - Object ETag.
- hash_
crc32_ stringc - Object CRC32C checksum value.
- hash_
crc64_ stringecma - Object CRC64 checksum.
- is_
default bool - Whether the object inherits the bucket ACL by default.
- key string
- Full key name of the object in the bucket.
- last_
modified string - Object last modified time.
- metadatas list(object)
- User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- object_
type string - Object type.
- public_
acl string - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- server_
side_ stringencryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- storage_
class string - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
- list(object)
- Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- url string
- Presigned URL for downloading the object.
- version_
i_ list(string)ds - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- version_
id string - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- account
Acls List<TosObject Account Acl> - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- bucket String
- Name of the bucket to which the object belongs.
- content String
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- content
Length Integer - Object content length, in bytes.
- content
Type String - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- e
Tag String - Object ETag.
- hash
Crc32C String - Object CRC32C checksum value.
- hash
Crc64Ecma String - Object CRC64 checksum.
- is
Default Boolean - Whether the object inherits the bucket ACL by default.
- key String
- Full key name of the object in the bucket.
- last
Modified String - Object last modified time.
- metadatas
List<Tos
Object Metadata> - User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- object
Type String - Object type.
- public
Acl String - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- server
Side StringEncryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- storage
Class String - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
-
List<Tos
Object Tag> - Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- url String
- Presigned URL for downloading the object.
- version
IDs List<String> - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- version
Id String - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- account
Acls TosObject Account Acl[] - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- bucket string
- Name of the bucket to which the object belongs.
- content string
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- content
Length number - Object content length, in bytes.
- content
Type string - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- e
Tag string - Object ETag.
- hash
Crc32C string - Object CRC32C checksum value.
- hash
Crc64Ecma string - Object CRC64 checksum.
- is
Default boolean - Whether the object inherits the bucket ACL by default.
- key string
- Full key name of the object in the bucket.
- last
Modified string - Object last modified time.
- metadatas
Tos
Object Metadata[] - User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- object
Type string - Object type.
- public
Acl string - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- server
Side stringEncryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- storage
Class string - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
-
Tos
Object Tag[] - Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- url string
- Presigned URL for downloading the object.
- version
IDs string[] - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- version
Id string - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- account_
acls Sequence[TosObject Account Acl Args] - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- bucket str
- Name of the bucket to which the object belongs.
- content str
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- content_
length int - Object content length, in bytes.
- content_
type str - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- e_
tag str - Object ETag.
- hash_
crc32_ strc - Object CRC32C checksum value.
- hash_
crc64_ strecma - Object CRC64 checksum.
- is_
default bool - Whether the object inherits the bucket ACL by default.
- key str
- Full key name of the object in the bucket.
- last_
modified str - Object last modified time.
- metadatas
Sequence[Tos
Object Metadata Args] - User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- object_
type str - Object type.
- public_
acl str - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- server_
side_ strencryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- storage_
class str - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
-
Sequence[Tos
Object Tag Args] - Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- url str
- Presigned URL for downloading the object.
- version_
id str - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
- version_
ids Sequence[str] - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- account
Acls List<Property Map> - Object account-level ACL authorization, aligned with Terraform account*acl. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- bucket String
- Name of the bucket to which the object belongs.
- content String
- Object content. Only JSON, text, or XML strings are supported. Images or other binary content are not supported. If the content exceeds 10 MB, it will not be returned.
- content
Length Number - Object content length, in bytes.
- content
Type String - Object Content-Type. Only JSON, text, or XML types are supported, such as application/json, text/plain, application/xml, text/xml, and may include a charset parameter.
- e
Tag String - Object ETag.
- hash
Crc32C String - Object CRC32C checksum value.
- hash
Crc64Ecma String - Object CRC64 checksum.
- is
Default Boolean - Whether the object inherits the bucket ACL by default.
- key String
- Full key name of the object in the bucket.
- last
Modified String - Object last modified time.
- metadatas List<Property Map>
- User-defined object metadata. Both key and value are strings. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- object
Type String - Object type.
- public
Acl String - Object public access control permissions, aligned with Terraform public_acl. default means the object inherits the bucket ACL by default. private: Private. The object owner has all permissions; other users have no access to the object. public-read: Public read. The object owner has all permissions; other users have read-only access. public-read-write: Public read/write. All users have read access to the object. authenticated-read: The object owner has all permissions; authenticated users have read access. bucket-owner-read: The object owner has all permissions; the bucket owner has read access to the object.
- server
Side StringEncryption - Set the encryption method for the target object. If not set, the object is not encrypted by default. The available options are as follows: AES256: Uses SSE-TOS encryption with the AES256 algorithm. SM4: Uses SSE-TOS encryption with the SM4 algorithm. kms: Uses SSE-KMS encryption. For details about SSE-TOS and SSE-KMS encryption methods, see Server-Side Encryption Overview. Note: Using SSE-KMS for server-side encryption incurs API call fees. Creating a KMS key incurs key management fees, which are charged by KMS. For more information, see KMS Billing.
- storage
Class String - Object storage class. Includes STANDARD, IA, ARCHIVEFR, INTELLIGENTTIERING, ARCHIVE, COLDARCHIVE, and DEEPCOLDARCHIVE. Note: Currently, COLDARCHIVE is only supported in North China 2 (Beijing), East China 2 (Shanghai), and South China 1 (Guangzhou). DEEPCOLDARCHIVE is also only supported in these regions and is in invite-only preview. To use this storage class, contact your account manager.
- List<Property Map>
- Object tag information. Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
- url String
- Presigned URL for downloading the object.
- version
IDs List<String> - List of all object version IDs. In buckets with versioning enabled, deleting a resource will clean up these historical versions. Layered buckets are not supported.
- version
Id String - Object version ID. This field is read-only and not used as a resource key. Layered buckets are not supported.
Supporting Types
TosObjectAccountAcl, TosObjectAccountAclArgs
- Account
Id string - Authorized account ID.
- Acl
Type string - Authorized principal type. Currently, only CanonicalUser is supported.
- Permission string
- Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
- Account
Id string - Authorized account ID.
- Acl
Type string - Authorized principal type. Currently, only CanonicalUser is supported.
- Permission string
- Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
- account_
id string - Authorized account ID.
- acl_
type string - Authorized principal type. Currently, only CanonicalUser is supported.
- permission string
- Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
- account
Id String - Authorized account ID.
- acl
Type String - Authorized principal type. Currently, only CanonicalUser is supported.
- permission String
- Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
- account
Id string - Authorized account ID.
- acl
Type string - Authorized principal type. Currently, only CanonicalUser is supported.
- permission string
- Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
- account_
id str - Authorized account ID.
- acl_
type str - Authorized principal type. Currently, only CanonicalUser is supported.
- permission str
- Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
- account
Id String - Authorized account ID.
- acl
Type String - Authorized principal type. Currently, only CanonicalUser is supported.
- permission String
- Authorization permission type. Includes FULLCONTROL, READ, READACP, WRITE, WRITE_ACP.
TosObjectMetadata, TosObjectMetadataArgs
TosObjectTag, TosObjectTagArgs
Import
$ pulumi import volcenginecc:tos/tosObject:TosObject example "bucket|key"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
published on Thursday, Aug 6, 2026 by Volcengine