Inventory

class aws_cdk.aws_s3.Inventory(*, destination, enabled=None, format=None, frequency=None, include_object_versions=None, inventory_id=None, objects_prefix=None, optional_fields=None)

Bases: object

Specifies the inventory configuration of an S3 Bucket.

Parameters
  • destination (InventoryDestination) – The destination of the inventory.

  • enabled (Optional[bool]) – Whether the inventory is enabled or disabled. Default: true

  • format (Optional[InventoryFormat]) – The format of the inventory. Default: InventoryFormat.CSV

  • frequency (Optional[InventoryFrequency]) – Frequency at which the inventory should be generated. Default: InventoryFrequency.WEEKLY

  • include_object_versions (Optional[InventoryObjectVersion]) – If the inventory should contain all the object versions or only the current one. Default: InventoryObjectVersion.ALL

  • inventory_id (Optional[str]) – The inventory configuration ID. Default: - generated ID.

  • objects_prefix (Optional[str]) – The inventory will only include objects that meet the prefix filter criteria. Default: - No objects prefix

  • optional_fields (Optional[List[str]]) – A list of optional fields to be included in the inventory result. Default: - No optional fields.

See

https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html

Attributes

destination

The destination of the inventory.

Return type

InventoryDestination

enabled

Whether the inventory is enabled or disabled.

Default

true

Return type

Optional[bool]

format

The format of the inventory.

Default

InventoryFormat.CSV

Return type

Optional[InventoryFormat]

frequency

Frequency at which the inventory should be generated.

Default

InventoryFrequency.WEEKLY

Return type

Optional[InventoryFrequency]

include_object_versions

If the inventory should contain all the object versions or only the current one.

Default

InventoryObjectVersion.ALL

Return type

Optional[InventoryObjectVersion]

inventory_id

The inventory configuration ID.

Default
  • generated ID.

Return type

Optional[str]

objects_prefix

The inventory will only include objects that meet the prefix filter criteria.

Default
  • No objects prefix

Return type

Optional[str]

optional_fields

A list of optional fields to be included in the inventory result.

Default
  • No optional fields.

Return type

Optional[List[str]]