Package software.amazon.awscdk.services.s3

Interface Inventory

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Inventory.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:24.125Z")
@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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Inventory.Builder	A builder for Inventory
static final class	Inventory.Jsii$Proxy	An implementation for Inventory

Method Summary

Modifier and Type	Method	Description
static Inventory.Builder	builder()
InventoryDestination	getDestination()	The destination of the inventory.
default 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 String	getInventoryId()	The inventory configuration ID.
default String	getObjectsPrefix()	The inventory will only include objects that meet the prefix filter criteria.
default List<String>	getOptionalFields()	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

@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.

Should be limited to 64 characters and can only contain letters, numbers, periods, dashes, and underscores.

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()

Returns:

a Inventory.Builder of Inventory