volcenginecc.tos.BucketInventory

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  tOSBucketInventoryDemo:
    type: volcenginecc:tos:BucketInventory
    name: TOSBucketInventoryDemo
    properties:
      bucketName: ccapi-test
      destination:
        tos_bucket_destination:
          accountId: 21xxxxxxxxx
          bucket: ccapi-test
          format: CSV
          prefix: tos_bucket_inventory
          role: TosArchiveTOSxxxxxx
      filter:
        prefix: sdfsaf
      includedObjectVersions: Current
      inventoryId: test
      isEnabled: true
      isUnCompressed: false
      optionalFields:
        field:
          - StorageClass
          - IntelligentTieringAccessTier
      schedule:
        frequency: Weekly

Create BucketInventory Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BucketInventory(name: string, args: BucketInventoryArgs, opts?: CustomResourceOptions);

@overload
def BucketInventory(resource_name: str,
                    args: BucketInventoryArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def BucketInventory(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    bucket_name: Optional[str] = None,
                    destination: Optional[BucketInventoryDestinationArgs] = None,
                    included_object_versions: Optional[str] = None,
                    inventory_id: Optional[str] = None,
                    is_enabled: Optional[bool] = None,
                    is_un_compressed: Optional[bool] = None,
                    schedule: Optional[BucketInventoryScheduleArgs] = None,
                    filter: Optional[BucketInventoryFilterArgs] = None,
                    optional_fields: Optional[BucketInventoryOptionalFieldsArgs] = None)

func NewBucketInventory(ctx *Context, name string, args BucketInventoryArgs, opts ...ResourceOption) (*BucketInventory, error)

public BucketInventory(string name, BucketInventoryArgs args, CustomResourceOptions? opts = null)

public BucketInventory(String name, BucketInventoryArgs args)
public BucketInventory(String name, BucketInventoryArgs args, CustomResourceOptions options)

type: volcenginecc:tos:BucketInventory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args BucketInventoryArgs: 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 BucketInventoryArgs: 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 BucketInventoryArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BucketInventoryArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BucketInventoryArgs: 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 bucketInventoryResource = new Volcenginecc.Tos.BucketInventory("bucketInventoryResource", new()
{
    BucketName = "string",
    Destination = new Volcenginecc.Tos.Inputs.BucketInventoryDestinationArgs
    {
        TosBucketDestination = new Volcenginecc.Tos.Inputs.BucketInventoryDestinationTosBucketDestinationArgs
        {
            AccountId = "string",
            Bucket = "string",
            Format = "string",
            Prefix = "string",
            Role = "string",
        },
    },
    IncludedObjectVersions = "string",
    InventoryId = "string",
    IsEnabled = false,
    IsUnCompressed = false,
    Schedule = new Volcenginecc.Tos.Inputs.BucketInventoryScheduleArgs
    {
        Frequency = "string",
    },
    Filter = new Volcenginecc.Tos.Inputs.BucketInventoryFilterArgs
    {
        Prefix = "string",
    },
    OptionalFields = new Volcenginecc.Tos.Inputs.BucketInventoryOptionalFieldsArgs
    {
        Fields = new[]
        {
            "string",
        },
    },
});

example, err := tos.NewBucketInventory(ctx, "bucketInventoryResource", &tos.BucketInventoryArgs{
	BucketName: pulumi.String("string"),
	Destination: &tos.BucketInventoryDestinationArgs{
		TosBucketDestination: &tos.BucketInventoryDestinationTosBucketDestinationArgs{
			AccountId: pulumi.String("string"),
			Bucket:    pulumi.String("string"),
			Format:    pulumi.String("string"),
			Prefix:    pulumi.String("string"),
			Role:      pulumi.String("string"),
		},
	},
	IncludedObjectVersions: pulumi.String("string"),
	InventoryId:            pulumi.String("string"),
	IsEnabled:              pulumi.Bool(false),
	IsUnCompressed:         pulumi.Bool(false),
	Schedule: &tos.BucketInventoryScheduleArgs{
		Frequency: pulumi.String("string"),
	},
	Filter: &tos.BucketInventoryFilterArgs{
		Prefix: pulumi.String("string"),
	},
	OptionalFields: &tos.BucketInventoryOptionalFieldsArgs{
		Fields: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

var bucketInventoryResource = new BucketInventory("bucketInventoryResource", BucketInventoryArgs.builder()
    .bucketName("string")
    .destination(BucketInventoryDestinationArgs.builder()
        .tosBucketDestination(BucketInventoryDestinationTosBucketDestinationArgs.builder()
            .accountId("string")
            .bucket("string")
            .format("string")
            .prefix("string")
            .role("string")
            .build())
        .build())
    .includedObjectVersions("string")
    .inventoryId("string")
    .isEnabled(false)
    .isUnCompressed(false)
    .schedule(BucketInventoryScheduleArgs.builder()
        .frequency("string")
        .build())
    .filter(BucketInventoryFilterArgs.builder()
        .prefix("string")
        .build())
    .optionalFields(BucketInventoryOptionalFieldsArgs.builder()
        .fields("string")
        .build())
    .build());

bucket_inventory_resource = volcenginecc.tos.BucketInventory("bucketInventoryResource",
    bucket_name="string",
    destination={
        "tos_bucket_destination": {
            "account_id": "string",
            "bucket": "string",
            "format": "string",
            "prefix": "string",
            "role": "string",
        },
    },
    included_object_versions="string",
    inventory_id="string",
    is_enabled=False,
    is_un_compressed=False,
    schedule={
        "frequency": "string",
    },
    filter={
        "prefix": "string",
    },
    optional_fields={
        "fields": ["string"],
    })

const bucketInventoryResource = new volcenginecc.tos.BucketInventory("bucketInventoryResource", {
    bucketName: "string",
    destination: {
        tosBucketDestination: {
            accountId: "string",
            bucket: "string",
            format: "string",
            prefix: "string",
            role: "string",
        },
    },
    includedObjectVersions: "string",
    inventoryId: "string",
    isEnabled: false,
    isUnCompressed: false,
    schedule: {
        frequency: "string",
    },
    filter: {
        prefix: "string",
    },
    optionalFields: {
        fields: ["string"],
    },
});

type: volcenginecc:tos:BucketInventory
properties:
    bucketName: string
    destination:
        tosBucketDestination:
            accountId: string
            bucket: string
            format: string
            prefix: string
            role: string
    filter:
        prefix: string
    includedObjectVersions: string
    inventoryId: string
    isEnabled: false
    isUnCompressed: false
    optionalFields:
        fields:
            - string
    schedule:
        frequency: string

BucketInventory 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 BucketInventory resource accepts the following input properties:

BucketName string: Bucket name.
Destination Volcengine.BucketInventoryDestination: Information related to inventory files.
IncludedObjectVersions string: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
InventoryId string: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
IsEnabled bool: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
IsUnCompressed bool: Whether it is uncompressed.
Schedule Volcengine.BucketInventorySchedule: Bucket inventory export frequency information.
Filter Volcengine.BucketInventoryFilter: Prefix for filtering bucket inventory.
OptionalFields Volcengine.BucketInventoryOptionalFields: Information about exported inventory files.

BucketName string: Bucket name.
Destination BucketInventoryDestinationArgs: Information related to inventory files.
IncludedObjectVersions string: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
InventoryId string: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
IsEnabled bool: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
IsUnCompressed bool: Whether it is uncompressed.
Schedule BucketInventoryScheduleArgs: Bucket inventory export frequency information.
Filter BucketInventoryFilterArgs: Prefix for filtering bucket inventory.
OptionalFields BucketInventoryOptionalFieldsArgs: Information about exported inventory files.

bucketName String: Bucket name.
destination BucketInventoryDestination: Information related to inventory files.
includedObjectVersions String: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventoryId String: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
isEnabled Boolean: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
isUnCompressed Boolean: Whether it is uncompressed.
schedule BucketInventorySchedule: Bucket inventory export frequency information.
filter BucketInventoryFilter: Prefix for filtering bucket inventory.
optionalFields BucketInventoryOptionalFields: Information about exported inventory files.

bucketName string: Bucket name.
destination BucketInventoryDestination: Information related to inventory files.
includedObjectVersions string: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventoryId string: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
isEnabled boolean: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
isUnCompressed boolean: Whether it is uncompressed.
schedule BucketInventorySchedule: Bucket inventory export frequency information.
filter BucketInventoryFilter: Prefix for filtering bucket inventory.
optionalFields BucketInventoryOptionalFields: Information about exported inventory files.

bucket_name str: Bucket name.
destination BucketInventoryDestinationArgs: Information related to inventory files.
included_object_versions str: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventory_id str: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
is_enabled bool: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
is_un_compressed bool: Whether it is uncompressed.
schedule BucketInventoryScheduleArgs: Bucket inventory export frequency information.
filter BucketInventoryFilterArgs: Prefix for filtering bucket inventory.
optional_fields BucketInventoryOptionalFieldsArgs: Information about exported inventory files.

bucketName String: Bucket name.
destination Property Map: Information related to inventory files.
includedObjectVersions String: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventoryId String: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
isEnabled Boolean: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
isUnCompressed Boolean: Whether it is uncompressed.
schedule Property Map: Bucket inventory export frequency information.
filter Property Map: Prefix for filtering bucket inventory.
optionalFields Property Map: Information about exported inventory files.

Outputs

All input properties are implicitly available as output properties. Additionally, the BucketInventory resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing BucketInventory Resource

Get an existing BucketInventory 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?: BucketInventoryState, opts?: CustomResourceOptions): BucketInventory

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket_name: Optional[str] = None,
        destination: Optional[BucketInventoryDestinationArgs] = None,
        filter: Optional[BucketInventoryFilterArgs] = None,
        included_object_versions: Optional[str] = None,
        inventory_id: Optional[str] = None,
        is_enabled: Optional[bool] = None,
        is_un_compressed: Optional[bool] = None,
        optional_fields: Optional[BucketInventoryOptionalFieldsArgs] = None,
        schedule: Optional[BucketInventoryScheduleArgs] = None) -> BucketInventory

func GetBucketInventory(ctx *Context, name string, id IDInput, state *BucketInventoryState, opts ...ResourceOption) (*BucketInventory, error)

public static BucketInventory Get(string name, Input<string> id, BucketInventoryState? state, CustomResourceOptions? opts = null)

public static BucketInventory get(String name, Output<String> id, BucketInventoryState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:tos:BucketInventory    get:      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.

The following state arguments are supported:

BucketName string: Bucket name.
Destination Volcengine.BucketInventoryDestination: Information related to inventory files.
Filter Volcengine.BucketInventoryFilter: Prefix for filtering bucket inventory.
IncludedObjectVersions string: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
InventoryId string: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
IsEnabled bool: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
IsUnCompressed bool: Whether it is uncompressed.
OptionalFields Volcengine.BucketInventoryOptionalFields: Information about exported inventory files.
Schedule Volcengine.BucketInventorySchedule: Bucket inventory export frequency information.

BucketName string: Bucket name.
Destination BucketInventoryDestinationArgs: Information related to inventory files.
Filter BucketInventoryFilterArgs: Prefix for filtering bucket inventory.
IncludedObjectVersions string: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
InventoryId string: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
IsEnabled bool: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
IsUnCompressed bool: Whether it is uncompressed.
OptionalFields BucketInventoryOptionalFieldsArgs: Information about exported inventory files.
Schedule BucketInventoryScheduleArgs: Bucket inventory export frequency information.

bucketName String: Bucket name.
destination BucketInventoryDestination: Information related to inventory files.
filter BucketInventoryFilter: Prefix for filtering bucket inventory.
includedObjectVersions String: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventoryId String: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
isEnabled Boolean: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
isUnCompressed Boolean: Whether it is uncompressed.
optionalFields BucketInventoryOptionalFields: Information about exported inventory files.
schedule BucketInventorySchedule: Bucket inventory export frequency information.

bucketName string: Bucket name.
destination BucketInventoryDestination: Information related to inventory files.
filter BucketInventoryFilter: Prefix for filtering bucket inventory.
includedObjectVersions string: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventoryId string: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
isEnabled boolean: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
isUnCompressed boolean: Whether it is uncompressed.
optionalFields BucketInventoryOptionalFields: Information about exported inventory files.
schedule BucketInventorySchedule: Bucket inventory export frequency information.

bucket_name str: Bucket name.
destination BucketInventoryDestinationArgs: Information related to inventory files.
filter BucketInventoryFilterArgs: Prefix for filtering bucket inventory.
included_object_versions str: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventory_id str: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
is_enabled bool: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
is_un_compressed bool: Whether it is uncompressed.
optional_fields BucketInventoryOptionalFieldsArgs: Information about exported inventory files.
schedule BucketInventoryScheduleArgs: Bucket inventory export frequency information.

bucketName String: Bucket name.
destination Property Map: Information related to inventory files.
filter Property Map: Prefix for filtering bucket inventory.
includedObjectVersions String: Object version to export. Options: All: export information for all object versions. Current: export information for the current object version.
inventoryId String: Bucket inventory name, which must be globally unique within the current bucket. Details: Length must be 0–64 characters. Only lowercase letters a–z, uppercase letters A–Z, digits 0–9, hyphens (-), underscores (_), and periods (.) are allowed. The name must start and end with a lowercase letter a–z, uppercase letter A–Z, or digit 0–9.
isEnabled Boolean: Whether to enable the bucket inventory feature. Options: true: enable; false: disable.
isUnCompressed Boolean: Whether it is uncompressed.
optionalFields Property Map: Information about exported inventory files.
schedule Property Map: Bucket inventory export frequency information.

Supporting Types

BucketInventoryDestination, BucketInventoryDestinationArgs

TosBucketDestination Volcengine.BucketInventoryDestinationTosBucketDestination: Bucket information related to the inventory files.

TosBucketDestination BucketInventoryDestinationTosBucketDestination: Bucket information related to the inventory files.

tosBucketDestination BucketInventoryDestinationTosBucketDestination: Bucket information related to the inventory files.

tosBucketDestination BucketInventoryDestinationTosBucketDestination: Bucket information related to the inventory files.

tos_bucket_destination BucketInventoryDestinationTosBucketDestination: Bucket information related to the inventory files.

tosBucketDestination Property Map: Bucket information related to the inventory files.

BucketInventoryDestinationTosBucketDestination, BucketInventoryDestinationTosBucketDestinationArgs

AccountId string: Account ID of the bucket owner.
Bucket string: Specify the bucket to store the inventory files.
Format string: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
Prefix string: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
Role string: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

AccountId string: Account ID of the bucket owner.
Bucket string: Specify the bucket to store the inventory files.
Format string: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
Prefix string: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
Role string: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

accountId String: Account ID of the bucket owner.
bucket String: Specify the bucket to store the inventory files.
format String: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
prefix String: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
role String: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

accountId string: Account ID of the bucket owner.
bucket string: Specify the bucket to store the inventory files.
format string: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
prefix string: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
role string: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

account_id str: Account ID of the bucket owner.
bucket str: Specify the bucket to store the inventory files.
format str: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
prefix str: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
role str: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

accountId String: Account ID of the bucket owner.
bucket String: Specify the bucket to store the inventory files.
format String: Inventory file format. Value is CSV, meaning the inventory file is in CSV format compressed with GZIP.
prefix String: Prefix for the storage path of inventory files. By default, files are saved under tosbucketinventory/sourceBucketName/inventoryId/YYYY-MM-DDTHH-MMZ/files in the target bucket.
role String: Role name used to grant permission to read all files from the source bucket and write files to the target bucket. The role must have TOS read/write and service access permissions. You can also use the default TOS role TosArchiveTOSInventory.

BucketInventoryFilter, BucketInventoryFilterArgs

Prefix string: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

Prefix string: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

prefix String: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

prefix string: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

prefix str: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

prefix String: Prefix matching information for exported files. If not set, an inventory of all objects in the bucket is generated by default.

BucketInventoryOptionalFields, BucketInventoryOptionalFieldsArgs

Fields List<string>: Information about exported inventory files.

Fields []string: Information about exported inventory files.

fields List<String>: Information about exported inventory files.

fields string[]: Information about exported inventory files.

fields Sequence[str]: Information about exported inventory files.

fields List<String>: Information about exported inventory files.

BucketInventorySchedule, BucketInventoryScheduleArgs

Frequency string: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.

Frequency string: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.

frequency String: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.

frequency string: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.

frequency str: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.

frequency String: Export frequency for inventory files. Options: Daily: export inventory files daily. Weekly: export inventory files weekly. Once: export inventory files once.

Import

$ pulumi import volcenginecc:tos/bucketInventory:BucketInventory example "bucket_name|inventory_id"

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 volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.tos.BucketInventory

On this page

On this page

Example Usage

Create BucketInventory Resource

Constructor syntax

Parameters

Constructor example

BucketInventory Resource Properties

Inputs

Outputs

Look up Existing BucketInventory Resource

Supporting Types

BucketInventoryDestination, BucketInventoryDestinationArgs

BucketInventoryDestinationTosBucketDestination, BucketInventoryDestinationTosBucketDestinationArgs

BucketInventoryFilter, BucketInventoryFilterArgs

BucketInventoryOptionalFields, BucketInventoryOptionalFieldsArgs

BucketInventorySchedule, BucketInventoryScheduleArgs

Import

Package Details

On this page

On this page