Interface CfnBucket.InventoryConfigurationProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnBucket.InventoryConfigurationProperty extends
Specifies the inventory configuration for an Amazon S3 bucket.

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


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 InventoryConfigurationProperty inventoryConfigurationProperty = InventoryConfigurationProperty.builder()
                 // the properties below are optional
         // the properties below are optional
  • Method Details

    • getDestination

      @Stability(Stable) @NotNull Object getDestination()
      Contains information about where to publish the inventory results.
    • getEnabled

      @Stability(Stable) @NotNull Object getEnabled()
      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.

    • getId

      @Stability(Stable) @NotNull String getId()
      The ID used to identify the inventory configuration.
    • getIncludedObjectVersions

      @Stability(Stable) @NotNull String 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 fields VersionId , IsLatest , and DeleteMarker to the list. If set to Current , the list does not contain these version-related fields.

    • getScheduleFrequency

      @Stability(Stable) @NotNull String getScheduleFrequency()
      Specifies the schedule for generating inventory results.

      Allowed values : Daily | Weekly

    • getOptionalFields

      @Stability(Stable) @Nullable default List<String> 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

      @Stability(Stable) @Nullable default String getPrefix()
      Specifies the inventory filter prefix.
    • builder

      @Stability(Stable) static CfnBucket.InventoryConfigurationProperty.Builder builder()
      a CfnBucket.InventoryConfigurationProperty.Builder of CfnBucket.InventoryConfigurationProperty