Class: Aws::S3::BucketLifecycle

Inherits:

Resources::Resource

• Object
• Resources::Resource
• Aws::S3::BucketLifecycle

Defined in:

(unknown)

Instance Attribute Summary

• #bucket_name ⇒ String readonly
• #rules ⇒ Array<Types::Rule> readonly

  Container for a lifecycle rule.

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary

• #bucket ⇒ Bucket
• #delete(options = {}) ⇒ Struct

  Deletes the lifecycle configuration from the specified bucket.

• #initialize ⇒ Object constructor
• #put(options = {}) ⇒ Struct

  For an updated version of this API, see PutBucketLifecycleConfiguration.

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(bucket_name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

• #initialize(bucket_name, options = {}) ⇒ Object

  Parameters:

  • bucket_name (String)

  Options Hash (options):

  • :client (Client) —

    When `:client is not given, the options hash is used to construct a new Client object.

• #initialize(options = {}) ⇒ Object

  Options Hash (options):

  • :bucket_name (required, String)
  • :client (Client) —

    When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#bucket_name ⇒ String (readonly)

Returns:

• (String)

#rules ⇒ Array<Types::Rule> (readonly)

Container for a lifecycle rule.

Returns:

• (Array<Types::Rule>) —

  Container for a lifecycle rule.

Instance Method Details

#bucket ⇒ Bucket

Returns:

• (Bucket)

#delete(options = {}) ⇒ Struct

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.

There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.

For more information about the object expiration, see Elements to Describe Lifecycle Actions.

Related actions include:

• PutBucketLifecycleConfiguration

• GetBucketLifecycleConfiguration

Examples:

Request syntax example with placeholder values

bucketlifecycle.delete({
  expected_bucket_owner: "AccountId",
  use_accelerate_endpoint: false,
})

Options Hash (options):

• :expected_bucket_owner (String) —

  The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

• :use_accelerate_endpoint (Boolean) —

  When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• Client#delete_bucket_lifecycle

#put(options = {}) ⇒ Struct

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon Simple Storage Service Developer Guide.

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the AWS account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

• s3:DeleteObject

• s3:DeleteObjectVersion

• s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.

Related Resources

• GetBucketLifecycle(Deprecated)

• GetBucketLifecycleConfiguration

• RestoreObject

• By default, a resource owner—in this case, a bucket owner, which is the AWS account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon Simple Storage Service Developer Guide:

  • Specifying Permissions in a Policy

  • Managing Access Permissions to your Amazon S3 Resources

Examples:

Request syntax example with placeholder values

bucketlifecycle.put({
  content_md5: "ContentMD5",
  lifecycle_configuration: {
    rules: [ # required
      {
        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, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE
        },
        noncurrent_version_transition: {
          noncurrent_days: 1,
          storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE
        },
        noncurrent_version_expiration: {
          noncurrent_days: 1,
        },
        abort_incomplete_multipart_upload: {
          days_after_initiation: 1,
        },
      },
    ],
  },
  expected_bucket_owner: "AccountId",
  use_accelerate_endpoint: false,
})

Options Hash (options):

• :content_md5 (String) —

  For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

• :lifecycle_configuration (Types::LifecycleConfiguration)
• :expected_bucket_owner (String) —

  The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

• :use_accelerate_endpoint (Boolean) —

  When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• Client#put_bucket_lifecycle