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

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 PutObjectLockConfigurationRequest data as a 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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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

Returns:

  • (String)


10008
10009
10010
10011
10012
10013
10014
10015
10016
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10008

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end

#content_md5String

The MD5 hash for the request body.

Returns:

  • (String)


10008
10009
10010
10011
10012
10013
10014
10015
10016
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10008

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end

#object_lock_configurationTypes::ObjectLockConfiguration

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



10008
10009
10010
10011
10012
10013
10014
10015
10016
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10008

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end

#request_payerString

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.

Returns:

  • (String)


10008
10009
10010
10011
10012
10013
10014
10015
10016
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10008

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end

#tokenString

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

Returns:

  • (String)


10008
10009
10010
10011
10012
10013
10014
10015
10016
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10008

class PutObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :object_lock_configuration,
  :request_payer,
  :token,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end