interface InventoryConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.S3.CfnBucket.InventoryConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awss3#CfnBucket_InventoryConfigurationProperty
Java	software.amazon.awscdk.services.s3.CfnBucket.InventoryConfigurationProperty
Python	aws_cdk.aws_s3.CfnBucket.InventoryConfigurationProperty
TypeScript	aws-cdk-lib » aws_s3 » CfnBucket » InventoryConfigurationProperty

Specifies the S3 Inventory configuration for an Amazon S3 bucket.

For more information, see GET Bucket inventory in the Amazon S3 API Reference .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3 as s3 } from 'aws-cdk-lib';
const inventoryConfigurationProperty: s3.CfnBucket.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	Contains information about where to publish the inventory results.
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	Specifies the inventory filter prefix.

---

destination

Type: IResolvable | DestinationProperty

Contains information about where to publish the inventory results.

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

---

enabled

Type: boolean | IResolvable

Specifies whether the inventory is enabled or disabled.

If set to True , an inventory list is generated. If set to False , no inventory list is generated.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-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-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-id

---

includedObjectVersions

Type: string

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.

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

---

scheduleFrequency

Type: string

Specifies the schedule for generating inventory results.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-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-s3-bucket-inventoryconfiguration.html#cfn-s3-bucket-inventoryconfiguration-optionalfields

---

prefix?

Type: string (optional)

Specifies the inventory filter prefix.

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