Interface Inventory

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.685Z") @Stability(Stable) public interface Inventory extends
Specifies the inventory configuration of an S3 Bucket.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Bucket bucket;
 Inventory inventory = Inventory.builder()
                 // the properties below are optional
         // the properties below are optional

See Also:
  • Method Details

    • getDestination

      @Stability(Stable) @NotNull InventoryDestination getDestination()
      The destination of the inventory.
    • getEnabled

      @Stability(Stable) @Nullable default Boolean getEnabled()
      Whether the inventory is enabled or disabled.

      Default: true

    • getFormat

      @Stability(Stable) @Nullable default InventoryFormat getFormat()
      The format of the inventory.

      Default: InventoryFormat.CSV

    • getFrequency

      @Stability(Stable) @Nullable default InventoryFrequency getFrequency()
      Frequency at which the inventory should be generated.

      Default: InventoryFrequency.WEEKLY

    • getIncludeObjectVersions

      @Stability(Stable) @Nullable default InventoryObjectVersion getIncludeObjectVersions()
      If the inventory should contain all the object versions or only the current one.

      Default: InventoryObjectVersion.ALL

    • getInventoryId

      @Stability(Stable) @Nullable default String getInventoryId()
      The inventory configuration ID.

      Default: - generated ID.

    • getObjectsPrefix

      @Stability(Stable) @Nullable default String getObjectsPrefix()
      The inventory will only include objects that meet the prefix filter criteria.

      Default: - No objects prefix

    • getOptionalFields

      @Stability(Stable) @Nullable default List<String> getOptionalFields()
      A list of optional fields to be included in the inventory result.

      Default: - No optional fields.

    • builder

      @Stability(Stable) static Inventory.Builder builder()
      a Inventory.Builder of Inventory