Amazon S3 Bucket InventoryConfiguration
The
InventoryConfiguration property type specifies the inventory configuration for an Amazon S3 bucket.
For more information, see GET Bucket inventory in the Amazon Simple Storage Service API Reference
InventoryConfiguration is a property of the AWS::S3::Bucket resource type.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Destination" : Destination, "Enabled" :Boolean, "Id" :String, "IncludedObjectVersions" :String, "OptionalFields" : [String, ... ] "Prefix" :String, "ScheduleFrequency" :String}
YAML
Destination:DestinationEnabled:BooleanId:StringIncludedObjectVersions:StringOptionalFields: -StringPrefix:StringScheduleFrequency:String
Properties
Destination-
Information about where to publish the inventory results.
Required: Yes
Type: Destination
Update requires: No interruption
Enabled-
Specifies whether the inventory is enabled or disabled. If set to
True, an inventory list is generated. If set toFalse, no inventory list is generated.Required: Yes
Type: Boolean
Update requires: No interruption
Id-
The ID that identifies the inventory configuration.
Required: Yes
Type: String
Update requires: No interruption
IncludedObjectVersions-
Object versions to include in the inventory list. If set to
All, the list includes all the object versions, which adds the version related fieldsVersionId,IsLatest, andDeleteMarkerto the list. If set toCurrent, the list does not contain these version related fields.Required: Yes
Type: String
Update requires: No interruption
OptionalFields-
The optional fields that are included in the inventory results.
Required: No
Type: StringList
Update requires: No interruption
Prefix-
The prefix that is prepended to all inventory results.
Required: No
Type: String
Update requires: No interruption
ScheduleFrequency-
The frequency of inventory results generation.
Required: Yes
Type: String
Update requires: No interruption
