interface InventoryConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.S3Express.CfnDirectoryBucket.InventoryConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awss3express#CfnDirectoryBucket_InventoryConfigurationProperty
Java	software.amazon.awscdk.services.s3express.CfnDirectoryBucket.InventoryConfigurationProperty
Python	aws_cdk.aws_s3express.CfnDirectoryBucket.InventoryConfigurationProperty
TypeScript	aws-cdk-lib » aws_s3express » CfnDirectoryBucket » InventoryConfigurationProperty

Specifies an inventory configuration for an Amazon S3 Express bucket.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-inventoryconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3express as s3express } from 'aws-cdk-lib';
const inventoryConfigurationProperty: s3express.CfnDirectoryBucket.InventoryConfigurationProperty = {
  destination: {
    bucketArn: 'bucketArn',
    format: 'format',

    // the properties below are optional
    bucketAccountId: 'bucketAccountId',
    prefix: 'prefix',
  },
  enabled: false,
  id: 'id',
  includedObjectVersions: 'includedObjectVersions',
  scheduleFrequency: 'scheduleFrequency',

  // the properties below are optional
  optionalFields: ['optionalFields'],
  prefix: 'prefix',
};

Properties

Name	Type	Description
destination	IResolvable | DestinationProperty	Specifies information about where to publish inventory reports for an Amazon S3 Express bucket.
enabled	boolean | IResolvable	Specifies whether the inventory is enabled or disabled.
id	string	The ID used to identify the inventory configuration.
includedObjectVersions	string	Object versions to include in the inventory list.
scheduleFrequency	string	Specifies the schedule for generating inventory results.
optionalFields?	string[]	Contains the optional fields that are included in the inventory results.
prefix?	string	The prefix that is prepended to all inventory results.

---

destination

Type: IResolvable | DestinationProperty

Specifies information about where to publish inventory reports for an Amazon S3 Express bucket.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-inventoryconfiguration-destination

---

enabled

Type: boolean | IResolvable

Specifies whether the inventory is enabled or disabled.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-inventoryconfiguration-enabled

---

id

Type: string

The ID used to identify the inventory configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-inventoryconfiguration-id

---

includedObjectVersions

Type: string

Object versions to include in the inventory list.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-inventoryconfiguration-includedobjectversions

---

scheduleFrequency

Type: string

Specifies the schedule for generating inventory results.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-inventoryconfiguration-schedulefrequency

---

optionalFields?

Type: string[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-inventoryconfiguration-optionalfields

---

prefix?

Type: string (optional)

The prefix that is prepended to all inventory results.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3express-directorybucket-inventoryconfiguration.html#cfn-s3express-directorybucket-inventoryconfiguration-prefix