Class: AWSCDK::S3::CfnBucket::NoncurrentVersionExpirationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::S3::CfnBucket::NoncurrentVersionExpirationProperty

Defined in:

s3/cfn_bucket.rb

Overview

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. For more information about setting a lifecycle rule configuration, see AWS::S3::Bucket Rule .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-noncurrentversionexpiration.html

Instance Attribute Summary

• #newer_noncurrent_versions ⇒ Numeric^? readonly

  Specifies how many noncurrent versions Amazon S3 will retain.

• #noncurrent_days ⇒ Numeric readonly

  Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(noncurrent_days:, newer_noncurrent_versions: nil) ⇒ NoncurrentVersionExpirationProperty constructor

  A new instance of NoncurrentVersionExpirationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(noncurrent_days:, newer_noncurrent_versions: nil) ⇒ NoncurrentVersionExpirationProperty

Returns a new instance of NoncurrentVersionExpirationProperty.

Parameters:

• noncurrent_days (Numeric) —

  Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action.

• newer_noncurrent_versions (Numeric, nil) (defaults to: nil) —

  Specifies how many noncurrent versions Amazon S3 will retain.

# File 's3/cfn_bucket.rb', line 2572

def initialize(noncurrent_days:, newer_noncurrent_versions: nil)
  @noncurrent_days = noncurrent_days
  Jsii::Type.check_type(@noncurrent_days, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "noncurrentDays")
  @newer_noncurrent_versions = newer_noncurrent_versions
  Jsii::Type.check_type(@newer_noncurrent_versions, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "newerNoncurrentVersions") unless @newer_noncurrent_versions.nil?
end

Instance Attribute Details

#newer_noncurrent_versions ⇒ Numeric^? (readonly)

Specifies how many noncurrent versions Amazon S3 will retain.

If there are this many more recent noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide .

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-noncurrentversionexpiration.html#cfn-s3-bucket-noncurrentversionexpiration-newernoncurrentversions

# File 's3/cfn_bucket.rb', line 2592

def newer_noncurrent_versions
  @newer_noncurrent_versions
end

#noncurrent_days ⇒ Numeric (readonly)

Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action.

For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide .

Returns:

• (Numeric)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-noncurrentversionexpiration.html#cfn-s3-bucket-noncurrentversionexpiration-noncurrentdays

# File 's3/cfn_bucket.rb', line 2585

def noncurrent_days
  @noncurrent_days
end

Class Method Details

.jsii_properties ⇒ Object

# File 's3/cfn_bucket.rb', line 2594

def self.jsii_properties
  {
    :noncurrent_days => "noncurrentDays",
    :newer_noncurrent_versions => "newerNoncurrentVersions",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 's3/cfn_bucket.rb', line 2601

def to_jsii
  result = {}
  result.merge!({
    "noncurrentDays" => @noncurrent_days,
    "newerNoncurrentVersions" => @newer_noncurrent_versions,
  })
  result.compact
end