You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::Types::Rule

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass Rule data as a hash:

{
  expiration: {
    date: Time.now,
    days: 1,
    expired_object_delete_marker: false,
  },
  id: "ID",
  prefix: "Prefix", # required
  status: "Enabled", # required, accepts Enabled, Disabled
  transition: {
    date: Time.now,
    days: 1,
    storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA
  },
  noncurrent_version_transition: {
    noncurrent_days: 1,
    storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA
  },
  noncurrent_version_expiration: {
    noncurrent_days: 1,
  },
  abort_incomplete_multipart_upload: {
    days_after_initiation: 1,
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#abort_incomplete_multipart_uploadTypes::AbortIncompleteMultipartUpload

Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload.



6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6986

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#expirationTypes::LifecycleExpiration



6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6986

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#idString

Unique identifier for the rule. The value cannot be longer than 255 characters.

Returns:

  • (String)


6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6986

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#noncurrent_version_expirationTypes::NoncurrentVersionExpiration

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.



6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6986

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#noncurrent_version_transitionTypes::NoncurrentVersionTransition

Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA or GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA or GLACIER storage class at a specific period in the object's lifetime.



6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6986

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#prefixString

Prefix identifying one or more objects to which the rule applies.

Returns:

  • (String)


6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6986

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#statusString

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

Returns:

  • (String)


6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6986

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#transitionTypes::Transition

Returns:



6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6986

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end