Interface IInventory

Specifies the inventory configuration of an S3 Bucket.

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IInventory

Syntax (vb)

Public Interface IInventory

Remarks

See: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3;

Bucket bucket;

var inventory = new Inventory {
    Destination = new InventoryDestination {
        Bucket = bucket,

        // the properties below are optional
        BucketOwner = "bucketOwner",
        Prefix = "prefix"
    },

    // the properties below are optional
    Enabled = false,
    Format = InventoryFormat.CSV,
    Frequency = InventoryFrequency.DAILY,
    IncludeObjectVersions = InventoryObjectVersion.ALL,
    InventoryId = "inventoryId",
    ObjectsPrefix = "objectsPrefix",
    OptionalFields = new [] { "optionalFields" }
};

Synopsis

Properties

Destination	The destination of the inventory.
Enabled	Whether the inventory is enabled or disabled.
Format	The format of the inventory.
Frequency	Frequency at which the inventory should be generated.
IncludeObjectVersions	If the inventory should contain all the object versions or only the current one.
InventoryId	The inventory configuration ID.
ObjectsPrefix	The inventory will only include objects that meet the prefix filter criteria.
OptionalFields	A list of optional fields to be included in the inventory result.

Properties

Destination

The destination of the inventory.

IInventoryDestination Destination { get; }

Property Value

IInventoryDestination

Enabled

Whether the inventory is enabled or disabled.

virtual Nullable<bool> Enabled { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: true

Format

The format of the inventory.

virtual Nullable<InventoryFormat> Format { get; }

Property Value

System.Nullable<InventoryFormat>

Remarks

Default: InventoryFormat.CSV

Frequency

Frequency at which the inventory should be generated.

virtual Nullable<InventoryFrequency> Frequency { get; }

Property Value

System.Nullable<InventoryFrequency>

Remarks

Default: InventoryFrequency.WEEKLY

IncludeObjectVersions

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

virtual Nullable<InventoryObjectVersion> IncludeObjectVersions { get; }

Property Value

System.Nullable<InventoryObjectVersion>

Remarks

Default: InventoryObjectVersion.ALL

InventoryId

The inventory configuration ID.

virtual string InventoryId { get; }

Property Value

System.String

Remarks

Should be limited to 64 characters and can only contain letters, numbers, periods, dashes, and underscores.

Default: - generated ID.

ObjectsPrefix

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

virtual string ObjectsPrefix { get; }

Property Value

System.String

Remarks

Default: - No objects prefix

OptionalFields

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

virtual string[] OptionalFields { get; }

Property Value

System.String[]

Remarks

Default: - No optional fields.