Package software.amazon.awscdk.services.s3

Interface InventoryDestination

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

InventoryDestination.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:49.467Z")
@Stability(Stable)
public interface InventoryDestination
extends software.amazon.jsii.JsiiSerializable

The destination of the inventory.

Example:

 Bucket inventoryBucket = new Bucket(this, "InventoryBucket");
 Bucket dataBucket = Bucket.Builder.create(this, "DataBucket")
         .inventories(List.of(Inventory.builder()
                 .frequency(InventoryFrequency.DAILY)
                 .includeObjectVersions(InventoryObjectVersion.CURRENT)
                 .destination(InventoryDestination.builder()
                         .bucket(inventoryBucket)
                         .build())
                 .build(), Inventory.builder()
                 .frequency(InventoryFrequency.WEEKLY)
                 .includeObjectVersions(InventoryObjectVersion.ALL)
                 .destination(InventoryDestination.builder()
                         .bucket(inventoryBucket)
                         .prefix("with-all-versions")
                         .build())
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InventoryDestination.Builder	builder()
IBucket	getBucket()	Bucket where all inventories will be saved in.
default String	getBucketOwner()	The account ID that owns the destination S3 bucket.
default String	getPrefix()	The prefix to be used when saving the inventory.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
IBucket getBucket()

Bucket where all inventories will be saved in.

getBucketOwner

@Stability(Stable)
@Nullable
default String getBucketOwner()

The account ID that owns the destination S3 bucket.

If no account ID is provided, the owner is not validated before exporting data. It's recommended to set an account ID to prevent problems if the destination bucket ownership changes.

Default: - No account ID.

getPrefix

@Stability(Stable)
@Nullable
default String getPrefix()

The prefix to be used when saving the inventory.

Default: - No prefix.

builder

@Stability(Stable)
static InventoryDestination.Builder builder()

Returns:

a InventoryDestination.Builder of InventoryDestination