aws-cdk-lib.aws_s3.CfnBucket.InventoryConfigurationProperty

InventoryConfigurationProperty Struct

Specifies the S3 Inventory configuration for an Amazon S3 bucket.

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

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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

destinationIResolvable | CfnBucket.DestinationPropertydestinationtyping.Union[IResolvable, DestinationProperty]destinationIResolvableDestinationIResolvableDestinationinterface{}required#

Contains information about where to publish the inventory results.

enabledboolean | IResolvableenabledtyping.Union[bool, IResolvable]enabledBooleanEnabledboolEnabledinterface{}required#

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.

idstringidstridStringIdstringId*stringrequired#

The ID used to identify the inventory configuration.

includedObjectVersionsstringincluded_object_versionsstrincludedObjectVersionsStringIncludedObjectVersionsstringIncludedObjectVersions*stringrequired#

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.

optionalFieldsstring[]optional_fieldstyping.List[str]optionalFieldsList<String>OptionalFieldsstring[]OptionalFields*[]*string#

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

prefixstringprefixstrprefixStringPrefixstringPrefix*string#

Specifies the inventory filter prefix.

scheduleFrequencystringschedule_frequencystrscheduleFrequencyStringScheduleFrequencystringScheduleFrequency*stringrequired#

Specifies the schedule for generating inventory results.