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

Class: Aws::S3::Types::PutObjectLockConfigurationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutObjectLockConfigurationRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  bucket: "BucketName", # required
  object_lock_configuration: {
    object_lock_enabled: "Enabled", # accepts Enabled
    rule: {
      default_retention: {
        mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
        days: 1,
        years: 1,
      },
    },
  },
  request_payer: "requester", # accepts requester
  token: "ObjectLockToken",
  content_md5: "ContentMD5",
  expected_bucket_owner: "AccountId",
  use_accelerate_endpoint: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The bucket whose Object Lock configuration you want to create or replace.

Returns:

  • (String) —

    The bucket whose Object Lock configuration you want to create or replace.

#content_md5 ⇒ String

The MD5 hash for the request body.

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

Returns:

  • (String) —

    The MD5 hash for the request body.

#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.

Returns:

  • (String) —

    The account id of the expected bucket owner.

#object_lock_configuration ⇒ Types::ObjectLockConfiguration

The Object Lock configuration that you want to apply to the specified bucket.

Returns:

#request_payer ⇒ String

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.

Possible values:

  • requester

Returns:

  • (String) —

    Confirms that the requester knows that they will be charged for the request.

#token ⇒ String

A token to allow Object Lock to be enabled for an existing bucket.

Returns:

  • (String) —

    A token to allow Object Lock to be enabled for an existing bucket.

#use_accelerate_endpoint ⇒ Boolean

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

Returns: