interface InventoryDestination

Language	Type name
.NET	Amazon.CDK.AWS.S3.InventoryDestination
Go	github.com/aws/aws-cdk-go/awscdk/v2/awss3#InventoryDestination
Java	software.amazon.awscdk.services.s3.InventoryDestination
Python	aws_cdk.aws_s3.InventoryDestination
TypeScript (source)	aws-cdk-lib » aws_s3 » InventoryDestination

The destination of the inventory.

Example

const inventoryBucket = new s3.Bucket(this, 'InventoryBucket');

const dataBucket = new s3.Bucket(this, 'DataBucket', {
  inventories: [
    {
      frequency: s3.InventoryFrequency.DAILY,
      includeObjectVersions: s3.InventoryObjectVersion.CURRENT,
      destination: {
        bucket: inventoryBucket,
      },
    },
    {
      frequency: s3.InventoryFrequency.WEEKLY,
      includeObjectVersions: s3.InventoryObjectVersion.ALL,
      destination: {
        bucket: inventoryBucket,
        prefix: 'with-all-versions',
      },
    },
  ],
});

Properties

Name	Type	Description
bucket	IBucket	Bucket where all inventories will be saved in.
bucketOwner?	string	The account ID that owns the destination S3 bucket.
prefix?	string	The prefix to be used when saving the inventory.

---

bucket

Type: IBucket

Bucket where all inventories will be saved in.

---

bucketOwner?

Type: string (optional, default: No account ID.)

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.

---

prefix?

Type: string (optional, default: No prefix.)

The prefix to be used when saving the inventory.