InventoryConfiguration

configurationId

String

Yes

Explanation:

ID of a bucket inventory rule.

Restrictions:

The rule ID allows letters (a–z, A–Z), digits (0–9), hyphens (-), underscores (_), and periods (.).

Value range:

The value can be up to 64 characters long.

Default value:

None

isEnabled

boolean

Yes

Explanation:

Whether the bucket inventory rule is enabled.

Value range:

true: The rule is enabled, and an inventory file is generated.

false: The rule is disabled. No inventory file is generated.

Default value:

true

objectPrefix

String

No

Explanation:

Used to filter objects. Only objects with the specified name prefix are included in the inventory.

Value range:

The value must contain 1 to 1,024 characters.

Default value:

None

frequency

String

Yes

Explanation:

Intervals when inventories are generated. You can set this parameter to Daily or Weekly. An inventory is generated within one hour from when it is configured for the first time. Then it is generated at the specified intervals.

Value range:

Daily: Inventories are generated once a day.

Weekly: Inventories are generated once a week.

Default value:

None

inventoryFormat

String

Yes

Explanation:

Inventory file format. Only the CSV format is supported.

Value range:

CSV

Default value:

None

destinationBucket

String

Yes

Explanation:

Name of the bucket for storing inventories.

Restrictions:

• A bucket name must be unique across all accounts and regions.
• A bucket name:
  • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
  • Cannot be formatted as an IP address.
  • Cannot start or end with a hyphen (-) or period (.).
  • Cannot contain two consecutive periods (..), for example, my..bucket.
  • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket.
• If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request.

Default value:

None

inventoryPrefix

String

No

Explanation:

The prefix of the inventory file name.

Value range:

The value must contain 1 to 1,024 characters.

Default value:

If you do not specify this parameter, BucketInventory is used as the prefix by default.

includedObjectVersions

String

Yes

Explanation:

Whether versions of objects are included in an inventory.

Value range:

• If this parameter is set to All, all the versions of objects are included in the inventory, and version-related fields are added to the inventory, including: VersionId, IsLatest, and DeleteMarker.
• If this parameter is set to Current, the inventory only lists information about the current object version and does not include any version-related fields.

Default value:

None

optionalFields

ArrayList<String>

No

Explanation:

Additional object metadata fields that are contained in an inventory file.

Value range:

Size: Object size.

LastModifiedDate: Last time when the object was modified.

StorageClass: The storage class of the object.

ETag: The ETag value of the object.

IsMultipartUploaded: Whether the object was uploaded in a multipart upload.

ReplicationStatus: The cross-region replication status of the object.

EncryptionStatus: The encryption status of the object.

Default value:

None