CfnBucket.RuleProperty

All Known Implementing Classes:: CfnBucket.RuleProperty.Jsii$Proxy

Enclosing class:: CfnBucket

public static interface CfnBucket.RuleProperty

Specifies lifecycle rules for an Amazon S3 bucket.

For more information, see Put Bucket Lifecycle Configuration in the Amazon S3 API Reference .

You must specify at least one of the following properties: AbortIncompleteMultipartUpload , ExpirationDate , ExpirationInDays , NoncurrentVersionExpirationInDays , NoncurrentVersionTransition , NoncurrentVersionTransitions , Transition , or Transitions .

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.*;
 RuleProperty ruleProperty = RuleProperty.builder()
         .status("status")
         // the properties below are optional
         .abortIncompleteMultipartUpload(AbortIncompleteMultipartUploadProperty.builder()
                 .daysAfterInitiation(123)
                 .build())
         .expirationDate(new Date())
         .expirationInDays(123)
         .expiredObjectDeleteMarker(false)
         .id("id")
         .noncurrentVersionExpiration(NoncurrentVersionExpirationProperty.builder()
                 .noncurrentDays(123)
                 // the properties below are optional
                 .newerNoncurrentVersions(123)
                 .build())
         .noncurrentVersionExpirationInDays(123)
         .noncurrentVersionTransition(NoncurrentVersionTransitionProperty.builder()
                 .storageClass("storageClass")
                 .transitionInDays(123)
                 // the properties below are optional
                 .newerNoncurrentVersions(123)
                 .build())
         .noncurrentVersionTransitions(List.of(NoncurrentVersionTransitionProperty.builder()
                 .storageClass("storageClass")
                 .transitionInDays(123)
                 // the properties below are optional
                 .newerNoncurrentVersions(123)
                 .build()))
         .objectSizeGreaterThan(123)
         .objectSizeLessThan(123)
         .prefix("prefix")
         .tagFilters(List.of(TagFilterProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .transition(TransitionProperty.builder()
                 .storageClass("storageClass")
                 // the properties below are optional
                 .transitionDate(new Date())
                 .transitionInDays(123)
                 .build())
         .transitions(List.of(TransitionProperty.builder()
                 .storageClass("storageClass")
                 // the properties below are optional
                 .transitionDate(new Date())
                 .transitionInDays(123)
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnBucket.RuleProperty.Builder` A builder for `CfnBucket.RuleProperty`
`static class`	`CfnBucket.RuleProperty.Jsii$Proxy` An implementation for `CfnBucket.RuleProperty`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnBucket.RuleProperty.Builder`	`builder()`
`default java.lang.Object`	`getAbortIncompleteMultipartUpload()` Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket.
`default java.lang.Object`	`getExpirationDate()` Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier.
`default java.lang.Number`	`getExpirationInDays()` Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier.
`default java.lang.Object`	`getExpiredObjectDeleteMarker()` Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions.
`default java.lang.String`	`getId()` Unique identifier for the rule.
`default java.lang.Object`	`getNoncurrentVersionExpiration()` Specifies when noncurrent object versions expire.
`default java.lang.Number`	`getNoncurrentVersionExpirationInDays()` (Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire.
`default java.lang.Object`	`getNoncurrentVersionTransition()` (Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class.
`default java.lang.Object`	`getNoncurrentVersionTransitions()` For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class.
`default java.lang.Number`	`getObjectSizeGreaterThan()` Specifies the minimum object size in bytes for this rule to apply to.
`default java.lang.Number`	`getObjectSizeLessThan()` Specifies the maximum object size in bytes for this rule to apply to.
`default java.lang.String`	`getPrefix()` Object key prefix that identifies one or more objects to which this rule applies.
`java.lang.String`	`getStatus()` If `Enabled` , the rule is currently being applied.
`default java.lang.Object`	`getTagFilters()` Tags to use to identify a subset of objects to which the lifecycle rule applies.
`default java.lang.Object`	`getTransition()` (Deprecated.) Specifies when an object transitions to a specified storage class.
`default java.lang.Object`	`getTransitions()` One or more transition rules that specify when an object transitions to a specified storage class.

- Method Detail
  - getStatus
```
java.lang.String getStatus()
```
    If `Enabled` , the rule is currently being applied.
    If Disabled , the rule is not currently being applied.
  - getAbortIncompleteMultipartUpload
```
default java.lang.Object getAbortIncompleteMultipartUpload()
```
    Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket.
  - getExpirationDate
```
default java.lang.Object getExpirationDate()
```
    Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier.
    The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time.
  - getExpirationInDays
```
default java.lang.Number getExpirationInDays()
```
    Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier.
    If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time.
  - getExpiredObjectDeleteMarker
```
default java.lang.Object getExpiredObjectDeleteMarker()
```
    Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions.
    If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ExpirationInDays , ExpirationDate , or TagFilters .
  - getId
```
default java.lang.String getId()
```
    Unique identifier for the rule.
    The value can't be longer than 255 characters.
  - getNoncurrentVersionExpiration
```
default java.lang.Object getNoncurrentVersionExpiration()
```
    Specifies when noncurrent object versions expire.
    Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
  - getNoncurrentVersionExpirationInDays
```
default java.lang.Number getNoncurrentVersionExpirationInDays()
```
    (Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time.
  - getNoncurrentVersionTransition
```
default java.lang.Object getNoncurrentVersionTransition()
```
    (Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the `NoncurrentVersionTransitions` property.
  - getNoncurrentVersionTransitions
```
default java.lang.Object getNoncurrentVersionTransitions()
```
    For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class.
    If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the NoncurrentVersionTransition property.
  - getObjectSizeGreaterThan
```
default java.lang.Number getObjectSizeGreaterThan()
```
    Specifies the minimum object size in bytes for this rule to apply to.
    Objects must be larger than this value in bytes. For more information about size based rules, see Lifecycle configuration using size-based rules in the Amazon S3 User Guide .
  - getObjectSizeLessThan
```
default java.lang.Number getObjectSizeLessThan()
```
    Specifies the maximum object size in bytes for this rule to apply to.
    Objects must be smaller than this value in bytes. For more information about sized based rules, see Lifecycle configuration using size-based rules in the Amazon S3 User Guide .
  - getPrefix
```
default java.lang.String getPrefix()
```
    Object key prefix that identifies one or more objects to which this rule applies.
    
    Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints .
  - getTagFilters
```
default java.lang.Object getTagFilters()
```
    Tags to use to identify a subset of objects to which the lifecycle rule applies.
  - getTransition
```
default java.lang.Object getTransition()
```
    (Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the `Transitions` property.
  - getTransitions
```
default java.lang.Object getTransitions()
```
    One or more transition rules that specify when an object transitions to a specified storage class.
    If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the Transition property.
  - builder
```
static CfnBucket.RuleProperty.Builder builder()
```
    Returns:
    
    a CfnBucket.RuleProperty.Builder of CfnBucket.RuleProperty

Interface CfnBucket.RuleProperty

Nested Class Summary

Method Summary

Method Detail

getStatus

getAbortIncompleteMultipartUpload

getExpirationDate

getExpirationInDays

getExpiredObjectDeleteMarker

getId

getNoncurrentVersionExpiration

getNoncurrentVersionExpirationInDays

getNoncurrentVersionTransition

getNoncurrentVersionTransitions

getObjectSizeGreaterThan

getObjectSizeLessThan

getPrefix

getTagFilters

getTransition

getTransitions

builder