public static interface CfnBucket.InventoryConfigurationProperty
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnBucket.InventoryConfigurationProperty.Builder
A builder for
CfnBucket.InventoryConfigurationProperty |
static class |
CfnBucket.InventoryConfigurationProperty.Jsii$Proxy
An implementation for
CfnBucket.InventoryConfigurationProperty |
Modifier and Type | Method and Description |
---|---|
static CfnBucket.InventoryConfigurationProperty.Builder |
builder() |
java.lang.Object |
getDestination()
Contains information about where to publish the inventory results.
|
java.lang.Object |
getEnabled()
Specifies whether the inventory is enabled or disabled.
|
java.lang.String |
getId()
The ID used to identify the inventory configuration.
|
java.lang.String |
getIncludedObjectVersions()
Object versions to include in the inventory list.
|
default java.util.List<java.lang.String> |
getOptionalFields()
Contains the optional fields that are included in the inventory results.
|
default java.lang.String |
getPrefix()
Specifies the inventory filter prefix.
|
java.lang.String |
getScheduleFrequency()
Specifies the schedule for generating inventory results.
|
java.lang.Object getDestination()
java.lang.Object getEnabled()
If set to True
, an inventory list is generated. If set to False
, no inventory list is generated.
java.lang.String getId()
java.lang.String getIncludedObjectVersions()
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.
java.lang.String getScheduleFrequency()
Allowed values : Daily
| Weekly
default java.util.List<java.lang.String> getOptionalFields()
Valid values : Size | LastModifiedDate | StorageClass | ETag | IsMultipartUploaded | ReplicationStatus | EncryptionStatus | ObjectLockRetainUntilDate | ObjectLockMode | ObjectLockLegalHoldStatus | IntelligentTieringAccessTier | BucketKeyStatus
default java.lang.String getPrefix()
static CfnBucket.InventoryConfigurationProperty.Builder builder()