@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-28T21:34:20.858Z")
public interface Inventory
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();
Modifier and Type | Interface and Description |
---|---|
static class |
Inventory.Builder
A builder for
Inventory |
static class |
Inventory.Jsii$Proxy
An implementation for
Inventory |
Modifier and Type | Method and Description |
---|---|
static Inventory.Builder |
builder() |
InventoryDestination |
getDestination()
The destination of the inventory.
|
default java.lang.Boolean |
getEnabled()
Whether the inventory is enabled or disabled.
|
default InventoryFormat |
getFormat()
The format of the inventory.
|
default InventoryFrequency |
getFrequency()
Frequency at which the inventory should be generated.
|
default InventoryObjectVersion |
getIncludeObjectVersions()
If the inventory should contain all the object versions or only the current one.
|
default java.lang.String |
getInventoryId()
The inventory configuration ID.
|
default java.lang.String |
getObjectsPrefix()
The inventory will only include objects that meet the prefix filter criteria.
|
default java.util.List<java.lang.String> |
getOptionalFields()
A list of optional fields to be included in the inventory result.
|
InventoryDestination getDestination()
default java.lang.Boolean getEnabled()
Default: true
default InventoryFormat getFormat()
Default: InventoryFormat.CSV
default InventoryFrequency getFrequency()
Default: InventoryFrequency.WEEKLY
default InventoryObjectVersion getIncludeObjectVersions()
Default: InventoryObjectVersion.ALL
default java.lang.String getInventoryId()
Default: - generated ID.
default java.lang.String getObjectsPrefix()
Default: - No objects prefix
default java.util.List<java.lang.String> getOptionalFields()
Default: - No optional fields.
static Inventory.Builder builder()
Inventory.Builder
of Inventory