software.amazon.awscdk.services.s3

Enum InventoryFrequency

java.lang.Object

java.lang.Enum<InventoryFrequency>

software.amazon.awscdk.services.s3.InventoryFrequency

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<InventoryFrequency>

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.699Z")
public enum InventoryFrequency
extends java.lang.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();
 

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static InventoryFrequency	valueOf(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DAILY

public static final InventoryFrequency DAILY

A report is generated every day.

WEEKLY

public static final InventoryFrequency WEEKLY

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

Method Detail

values

public static InventoryFrequency[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InventoryFrequency c : InventoryFrequency.values())
    System.out.println(c);

Returns:

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

valueOf

public static InventoryFrequency valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null