Viewing docs for volcenginecc v0.0.54
published on Thursday, Aug 6, 2026 by Volcengine
published on Thursday, Aug 6, 2026 by Volcengine
Viewing docs for volcenginecc v0.0.54
published on Thursday, Aug 6, 2026 by Volcengine
published on Thursday, Aug 6, 2026 by Volcengine
Data Source schema for Volcengine::TOS::Object
Using getObject
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getObject(args: GetObjectArgs, opts?: InvokeOptions): Promise<GetObjectResult>
function getObjectOutput(args: GetObjectOutputArgs, opts?: InvokeOptions): Output<GetObjectResult>def get_object(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetObjectResult
def get_object_output(id: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetObjectResult]func GetObject(ctx *Context, args *GetObjectArgs, opts ...InvokeOption) (*GetObjectResult, error)
func GetObjectOutput(ctx *Context, args *GetObjectOutputArgs, opts ...InvokeOption) GetObjectResultOutput> Note: This function is named GetObject in the Go SDK.
public static class GetObject
{
public static Task<GetObjectResult> InvokeAsync(GetObjectArgs args, InvokeOptions? opts = null)
public static Output<GetObjectResult> Invoke(GetObjectInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetObjectResult> getObject(GetObjectArgs args, InvokeOptions options)
public static Output<GetObjectResult> getObject(GetObjectArgs args, InvokeOptions options)
fn::invoke:
function: volcenginecc:tos/getObject:getObject
arguments:
# arguments dictionarydata "volcenginecc_tos_get_object" "name" {
# arguments
}The following arguments are supported:
- Id string
- Uniquely identifies the resource.
- Id string
- Uniquely identifies the resource.
- id string
- Uniquely identifies the resource.
- id String
- Uniquely identifies the resource.
- id string
- Uniquely identifies the resource.
- id str
- Uniquely identifies the resource.
- id String
- Uniquely identifies the resource.
getObject Result
The following output properties are available:
- Account
Acls List<Volcengine.Get Object Account Acl> - Object account-level ACL authorization, aligned with Terraform account*acl.
- 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.
- Id string
- Uniquely identifies the resource.
- 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.
Get Object Metadata> - User-defined object metadata. Both key and value are strings.
- 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.
Get Object Tag> - Object tag information.
- 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 []GetObject Account Acl - Object account-level ACL authorization, aligned with Terraform account*acl.
- 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.
- Id string
- Uniquely identifies the resource.
- 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
[]Get
Object Metadata - User-defined object metadata. Both key and value are strings.
- 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.
-
[]Get
Object Tag - Object tag information.
- 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.
- 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.
- id string
- Uniquely identifies the resource.
- 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.
- 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.
- 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<GetObject Account Acl> - Object account-level ACL authorization, aligned with Terraform account*acl.
- 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.
- id String
- Uniquely identifies the resource.
- 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<Get
Object Metadata> - User-defined object metadata. Both key and value are strings.
- 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<Get
Object Tag> - Object tag information.
- 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 GetObject Account Acl[] - Object account-level ACL authorization, aligned with Terraform account*acl.
- 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.
- id string
- Uniquely identifies the resource.
- 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
Get
Object Metadata[] - User-defined object metadata. Both key and value are strings.
- 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.
-
Get
Object Tag[] - Object tag information.
- 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[GetObject Account Acl] - Object account-level ACL authorization, aligned with Terraform account*acl.
- 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.
- id str
- Uniquely identifies the resource.
- 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[Get
Object Metadata] - User-defined object metadata. Both key and value are strings.
- 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[Get
Object Tag] - Object tag information.
- 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.
- 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.
- id String
- Uniquely identifies the resource.
- 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.
- 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.
- 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
GetObjectAccountAcl
- 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.
GetObjectMetadata
GetObjectTag
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
Viewing docs for volcenginecc v0.0.54
published on Thursday, Aug 6, 2026 by Volcengine
published on Thursday, Aug 6, 2026 by Volcengine