software.amazon.awscdk.services.s3

Interface InventoryDestination

All Known Implementing Classes:

InventoryDestination.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.698Z")
public interface InventoryDestination

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 and Description
static class	InventoryDestination.Builder A builder for InventoryDestination
static class	InventoryDestination.Jsii$Proxy An implementation for InventoryDestination

Method Summary

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

Method Detail

getBucket

IBucket getBucket()

Bucket where all inventories will be saved in.

getBucketOwner

default java.lang.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

default java.lang.String getPrefix()

The prefix to be used when saving the inventory.

Default: - No prefix.

builder

static InventoryDestination.Builder builder()

Returns:

a InventoryDestination.Builder of InventoryDestination