Class: Aws::S3::Types::PutBucketLifecycleRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::PutBucketLifecycleRequest

Defined in:

gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

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

{
  bucket: "BucketName", # required
  content_md5: "ContentMD5",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  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, GLACIER_IR
        },
        noncurrent_version_transition: {
          noncurrent_days: 1,
          storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR
          newer_noncurrent_versions: 1,
        },
        noncurrent_version_expiration: {
          noncurrent_days: 1,
          newer_noncurrent_versions: 1,
        },
        abort_incomplete_multipart_upload: {
          days_after_initiation: 1,
        },
      },
    ],
  },
  expected_bucket_owner: "AccountId",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String
• #checksum_algorithm ⇒ String

  Indicates the algorithm used to create the checksum for the object when using the SDK.

• #content_md5 ⇒ String

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

• #expected_bucket_owner ⇒ String

  The account ID of the expected bucket owner.

• #lifecycle_configuration ⇒ Types::LifecycleConfiguration

Instance Attribute Details

#bucket ⇒ String

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11963

class PutBucketLifecycleRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :lifecycle_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#checksum_algorithm ⇒ String

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11963

class PutBucketLifecycleRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :lifecycle_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#content_md5 ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11963

class PutBucketLifecycleRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :lifecycle_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11963

class PutBucketLifecycleRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :lifecycle_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_configuration ⇒ Types::LifecycleConfiguration

Returns:

• (Types::LifecycleConfiguration)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11963

class PutBucketLifecycleRequest < Struct.new(
  :bucket,
  :content_md5,
  :checksum_algorithm,
  :lifecycle_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end