Interface Inventory
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
Inventory.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-25T14:21:22.977Z")
@Stability(Stable)
public interface Inventory
extends software.amazon.jsii.JsiiSerializable
Specifies the inventory configuration of an S3 Bucket.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.s3.*; Bucket bucket; Inventory inventory = Inventory.builder() .destination(InventoryDestination.builder() .bucket(bucket) // the properties below are optional .bucketOwner("bucketOwner") .prefix("prefix") .build()) // the properties below are optional .enabled(false) .format(InventoryFormat.CSV) .frequency(InventoryFrequency.DAILY) .includeObjectVersions(InventoryObjectVersion.ALL) .inventoryId("inventoryId") .objectsPrefix("objectsPrefix") .optionalFields(List.of("optionalFields")) .build();
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Inventory.Builder
builder()
The destination of the inventory.default Boolean
Whether the inventory is enabled or disabled.default InventoryFormat
The format of the inventory.default InventoryFrequency
Frequency at which the inventory should be generated.default InventoryObjectVersion
If the inventory should contain all the object versions or only the current one.default String
The inventory configuration ID.default String
The inventory will only include objects that meet the prefix filter criteria.A list of optional fields to be included in the inventory result.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDestination
The destination of the inventory. -
getEnabled
Whether the inventory is enabled or disabled.Default: true
-
getFormat
The format of the inventory.Default: InventoryFormat.CSV
-
getFrequency
Frequency at which the inventory should be generated.Default: InventoryFrequency.WEEKLY
-
getIncludeObjectVersions
If the inventory should contain all the object versions or only the current one.Default: InventoryObjectVersion.ALL
-
getInventoryId
The inventory configuration ID.Should be limited to 64 characters and can only contain letters, numbers, periods, dashes, and underscores.
Default: - generated ID.
-
getObjectsPrefix
The inventory will only include objects that meet the prefix filter criteria.Default: - No objects prefix
-
getOptionalFields
A list of optional fields to be included in the inventory result.Default: - No optional fields.
-
builder
- Returns:
- a
Inventory.Builder
ofInventory
-