Package software.amazon.awscdk.services.s3

Class Inventory.Builder

java.lang.Object

software.amazon.awscdk.services.s3.Inventory.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Inventory>

Enclosing interface:

Inventory

@Stability(Stable)
public static final class Inventory.Builder
extends Object
implements software.amazon.jsii.Builder<Inventory>

A builder for Inventory

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Inventory	build()	Builds the configured instance.
Inventory.Builder	destination(InventoryDestination destination)	Sets the value of Inventory.getDestination()
Inventory.Builder	enabled(Boolean enabled)	Sets the value of Inventory.getEnabled()
Inventory.Builder	format(InventoryFormat format)	Sets the value of Inventory.getFormat()
Inventory.Builder	frequency(InventoryFrequency frequency)	Sets the value of Inventory.getFrequency()
Inventory.Builder	includeObjectVersions(InventoryObjectVersion includeObjectVersions)	Sets the value of Inventory.getIncludeObjectVersions()
Inventory.Builder	inventoryId(String inventoryId)	Sets the value of Inventory.getInventoryId()
Inventory.Builder	objectsPrefix(String objectsPrefix)	Sets the value of Inventory.getObjectsPrefix()
Inventory.Builder	optionalFields(List<String> optionalFields)	Sets the value of Inventory.getOptionalFields()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

destination

@Stability(Stable)
public Inventory.Builder destination(InventoryDestination destination)

Sets the value of Inventory.getDestination()

Parameters:

destination - The destination of the inventory. This parameter is required.

Returns:

this

enabled

@Stability(Stable)
public Inventory.Builder enabled(Boolean enabled)

Sets the value of Inventory.getEnabled()

Parameters:

enabled - Whether the inventory is enabled or disabled.

Returns:

this

format

@Stability(Stable)
public Inventory.Builder format(InventoryFormat format)

Sets the value of Inventory.getFormat()

Parameters:

format - The format of the inventory.

Returns:

this

frequency

@Stability(Stable)
public Inventory.Builder frequency(InventoryFrequency frequency)

Sets the value of Inventory.getFrequency()

Parameters:

frequency - Frequency at which the inventory should be generated.

Returns:

this

includeObjectVersions

@Stability(Stable)
public Inventory.Builder includeObjectVersions(InventoryObjectVersion includeObjectVersions)

Sets the value of Inventory.getIncludeObjectVersions()

Parameters:

includeObjectVersions - If the inventory should contain all the object versions or only the current one.

Returns:

this

inventoryId

@Stability(Stable)
public Inventory.Builder inventoryId(String inventoryId)

Sets the value of Inventory.getInventoryId()

Parameters:

inventoryId - The inventory configuration ID. Should be limited to 64 characters and can only contain letters, numbers, periods, dashes, and underscores.

Returns:

this

objectsPrefix

@Stability(Stable)
public Inventory.Builder objectsPrefix(String objectsPrefix)

Sets the value of Inventory.getObjectsPrefix()

Parameters:

objectsPrefix - The inventory will only include objects that meet the prefix filter criteria.

Returns:

this

optionalFields

@Stability(Stable)
public Inventory.Builder optionalFields(List<String> optionalFields)

Sets the value of Inventory.getOptionalFields()

Parameters:

optionalFields - A list of optional fields to be included in the inventory result.

Returns:

this

build

@Stability(Stable)
public Inventory build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<Inventory>

Returns:

a new instance of Inventory

Throws:

NullPointerException - if any required attribute was not provided