View a markdown version of this page

AWS::S3Express::DirectoryBucket InventoryConfiguration - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::S3Express::DirectoryBucket InventoryConfiguration

Specifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Destination" : Destination,
  "Enabled" : Boolean,
  "Id" : String,
  "IncludedObjectVersions" : String,
  "OptionalFields" : [ String, ... ],
  "Prefix" : String,
  "ScheduleFrequency" : String
}

YAML

  Destination: 
    Destination
  Enabled: Boolean
  Id: String
  IncludedObjectVersions: String
  OptionalFields: 
    - String
  Prefix: String
  ScheduleFrequency: String

Properties

Destination

Contains information about where to publish the inventory results.

Required: Yes

Type: Destination

Update requires: No interruption

Enabled

Property description not available.

Required: Yes

Type: Boolean

Update requires: No interruption

Id

The ID used to identify 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 fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

Required: Yes

Type: String

Allowed values: All | Current

Update requires: No interruption

OptionalFields

Contains the optional fields that are included in the inventory results.

Note

The following optional fields are supported for directory buckets Size | LastModifiedDate | StorageClass | ETag | IsMultipartUploaded | EncryptionStatus | BucketKeyStatus | ChecksumAlgorithm | LifecycleExpirationDate. Throws MalformedXML error if unsupported optional field is provided.

Required: No

Type: Array of String

Allowed values: Size | LastModifiedDate | StorageClass | ETag | IsMultipartUploaded | EncryptionStatus | BucketKeyStatus | ChecksumAlgorithm | LifecycleExpirationDate

Update requires: No interruption

Prefix

Property description not available.

Required: No

Type: String

Update requires: No interruption

ScheduleFrequency

Property description not available.

Required: Yes

Type: String

Allowed values: Daily | Weekly

Update requires: No interruption