1.204.0

interface InventoryConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.S3.CfnBucket.InventoryConfigurationProperty
Javasoftware.amazon.awscdk.services.s3.CfnBucket.InventoryConfigurationProperty
Pythonaws_cdk.aws_s3.CfnBucket.InventoryConfigurationProperty
TypeScript @aws-cdk/aws-s3 » CfnBucket » InventoryConfigurationProperty

Specifies the inventory configuration for an Amazon S3 bucket.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as s3 from '@aws-cdk/aws-s3';
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

NameTypeDescription
destinationIResolvable | DestinationPropertyContains information about where to publish the inventory results.
enabledboolean | IResolvableSpecifies whether the inventory is enabled or disabled.
idstringThe ID used to identify the inventory configuration.
includedObjectVersionsstringObject versions to include in the inventory list.
scheduleFrequencystringSpecifies the schedule for generating inventory results.
optionalFields?string[]Contains the optional fields that are included in the inventory results.
prefix?stringSpecifies the inventory filter prefix.

destination

Type: IResolvable | DestinationProperty

Contains information about where to publish the inventory results.

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.

id

Type: string

The ID used to identify the inventory configuration.

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.

scheduleFrequency

Type: string

Specifies the schedule for generating inventory results.

Allowed values : Daily | Weekly

optionalFields?

Type: string[] (optional)

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

Valid values : Size | LastModifiedDate | StorageClass | ETag | IsMultipartUploaded | ReplicationStatus | EncryptionStatus | ObjectLockRetainUntilDate | ObjectLockMode | ObjectLockLegalHoldStatus | IntelligentTieringAccessTier | BucketKeyStatus

prefix?

Type: string (optional)

Specifies the inventory filter prefix.

← PreviousNext →