2.233.0

interface InventoryConfigurationProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.S3.Mixins.CfnBucketPropsMixin.InventoryConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awss3/mixins#CfnBucketPropsMixin_InventoryConfigurationProperty
Javasoftware.amazon.awscdk.mixins.preview.services.s3.mixins.CfnBucketPropsMixin.InventoryConfigurationProperty
Pythonaws_cdk.mixins_preview.aws_s3.mixins.CfnBucketPropsMixin.InventoryConfigurationProperty
TypeScript @aws-cdk/mixins-preview » aws_s3 » mixins » CfnBucketPropsMixin » 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 { mixins as s3_mixins } from '@aws-cdk/mixins-preview/aws-s3';
const inventoryConfigurationProperty: s3_mixins.CfnBucketPropsMixin.InventoryConfigurationProperty = {
  destination: {
    bucketAccountId: 'bucketAccountId',
    bucketArn: 'bucketArn',
    format: 'format',
    prefix: 'prefix',
  },
  enabled: false,
  id: 'id',
  includedObjectVersions: 'includedObjectVersions',
  optionalFields: ['optionalFields'],
  prefix: 'prefix',
  scheduleFrequency: 'scheduleFrequency',
};

Properties

NameTypeDescription
destination?IResolvable | DestinationPropertyContains information about where to publish the inventory results.
enabled?boolean | IResolvableSpecifies whether the inventory is enabled or disabled.
id?stringThe ID used to identify the inventory configuration.
includedObjectVersions?stringObject versions to include in the inventory list.
optionalFields?string[]Contains the optional fields that are included in the inventory results.
prefix?stringSpecifies the inventory filter prefix.
scheduleFrequency?stringSpecifies the schedule for generating inventory results.

destination?

Type: IResolvable | DestinationProperty (optional)

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 (optional)

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 (optional)

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 (optional)

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

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

scheduleFrequency?

Type: string (optional)

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

← PreviousNext →