Interface CfnBucket.InventoryConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnBucket.InventoryConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnBucket
@Stability(Stable)
public static interface CfnBucket.InventoryConfigurationProperty
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.s3.*; InventoryConfigurationProperty inventoryConfigurationProperty = InventoryConfigurationProperty.builder() .destination(DestinationProperty.builder() .bucketArn("bucketArn") .format("format") // the properties below are optional .bucketAccountId("bucketAccountId") .prefix("prefix") .build()) .enabled(false) .id("id") .includedObjectVersions("includedObjectVersions") .scheduleFrequency("scheduleFrequency") // the properties below are optional .optionalFields(List.of("optionalFields")) .prefix("prefix") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnBucket.InventoryConfigurationProperty
static final class
An implementation forCfnBucket.InventoryConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Contains information about where to publish the inventory results.Specifies whether the inventory is enabled or disabled.getId()
The ID used to identify the inventory configuration.Object versions to include in the inventory list.Contains the optional fields that are included in the inventory results.default String
Specifies the inventory filter prefix.Specifies the schedule for generating inventory results.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDestination
Contains information about where to publish the inventory results. -
getEnabled
Specifies whether the inventory is enabled or disabled.If set to
True
, an inventory list is generated. If set toFalse
, no inventory list is generated. -
getId
The ID used to identify the inventory configuration. -
getIncludedObjectVersions
Object versions to include in the inventory list.If set to
All
, the list includes all the object versions, which adds the version-related fieldsVersionId
,IsLatest
, andDeleteMarker
to the list. If set toCurrent
, the list does not contain these version-related fields. -
getScheduleFrequency
Specifies the schedule for generating inventory results.Allowed values :
Daily
|Weekly
-
getOptionalFields
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
-
getPrefix
Specifies the inventory filter prefix. -
builder
-