Package software.amazon.awscdk.services.s3

Enum InventoryFrequency

java.lang.Object

java.lang.Enum<InventoryFrequency>

software.amazon.awscdk.services.s3.InventoryFrequency

All Implemented Interfaces:

Serializable, Comparable<InventoryFrequency>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:08.920Z")
@Stability(Stable)
public enum InventoryFrequency
extends Enum<InventoryFrequency>

All supported inventory frequencies.

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/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAILY	A report is generated every day.
WEEKLY	A report is generated every Sunday (UTC timezone) after the initial report.

Method Summary

Modifier and Type	Method	Description
static InventoryFrequency	valueOf(String name)	Returns the enum constant of this type with the specified name.
static InventoryFrequency[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DAILY

@Stability(Stable)
public static final InventoryFrequency DAILY

A report is generated every day.

WEEKLY

@Stability(Stable)
public static final InventoryFrequency WEEKLY

A report is generated every Sunday (UTC timezone) after the initial report.

Method Details

values

public static InventoryFrequency[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InventoryFrequency valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null