Class: Aws::S3::EncryptionV2::Client

Inherits:

Object

• Object
• Aws::S3::EncryptionV2::Client

Extended by:

Deprecations, Forwardable

Defined in:

lib/aws-sdk-s3/encryptionV2/client.rb

Instance Attribute Summary

• #client ⇒ S3::Client readonly
• #envelope_location ⇒ Symbol<:metadata, :instruction_file> readonly
• #instruction_file_suffix ⇒ String readonly

  When #envelope_location is ‘:instruction_file`, the envelope is stored in the object with the object key suffixed by this string.

• #key_provider ⇒ KeyProvider^? readonly

  Returns ‘nil` if you are using AWS Key Management Service (KMS).

• #kms_allow_decrypt_with_any_cmk ⇒ Boolean readonly

  If true the provided KMS key_id will not be used during decrypt, allowing decryption with the key_id from the object.

• #security_profile ⇒ Symbol readonly

  Determines the support for reading objects written using older key wrap or content encryption schemas.

Instance Method Summary

• #get_object(params = {}, &block) ⇒ Types::GetObjectOutput

  Gets an object from Amazon S3, decrypting data locally.

• #initialize(options = {}) ⇒ Client constructor

  Creates a new encryption client.

• #put_object(params = {}) ⇒ Types::PutObjectOutput

  Uploads an object to Amazon S3, encrypting data client-side.

Constructor Details

#initialize(options = {}) ⇒ Client

Creates a new encryption client. You must configure all of the following:

• a key or key provider - The key provided also determines the key wrapping schema(s) supported for both encryption and decryption.

• ‘key_wrap_schema` - The key wrapping schema. It must match the type of key configured.

• ‘content_encryption_schema` - The only supported value currently is `:aes_gcm_no_padding`

  More options will be added in future releases.
  

• ‘security_profile` - Determines the support for reading objects written

  using older key wrap or content encryption schemas. If you need to read
  legacy objects encrypted by an existing V1 Client, then set this to `:v2_and_legacy`.
  Otherwise, set it to `:v2`
  

To configure the key you must provide one of the following set of options:

• ‘:encryption_key`

• ‘:kms_key_id`

• ‘:key_provider`

You may also pass any other options accepted by ‘Client#initialize`.

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :client (S3::Client) —

  A basic S3 client that is used to make api calls. If a ‘:client` is not provided, a new Client will be constructed.

• :encryption_key (OpenSSL::PKey::RSA, String) —

  The master key to use for encrypting/decrypting all objects.

• :kms_key_id (String) —

  When you provide a ‘:kms_key_id`, then AWS Key Management Service (KMS) will be used to manage the object encryption keys. By default a KMS::Client will be constructed for KMS API calls. Alternatively, you can provide your own via `:kms_client`. To only support decryption/reads, you may provide `:allow_decrypt_with_any_cmk` which will use the implicit CMK associated with the data during reads but will not allow you to encrypt/write objects with this client.

• :key_provider (#key_for) —

  Any object that responds to ‘#key_for`. This method should accept a materials description JSON document string and return return an encryption key.

• :key_wrap_schema (required, Symbol) —

  The Key wrapping schema to be used. It must match the type of key configured. Must be one of the following:

  • :kms_context (Must provide kms_key_id)

  • :aes_gcm (Must provide an AES (string) key)

  • :rsa_oaep_sha1 (Must provide an RSA key)

• :content_encryption_schema (required, Symbol) —

  Must be one of the following:

  • :aes_gcm_no_padding

• :security_profile (Required, Symbol) —

  Determines the support for reading objects written using older key wrap or content encryption schemas. Must be one of the following:

  • :v2 - Reads of legacy (v1) objects are NOT allowed

  • :v2_and_legacy - Enables reading of legacy (V1) schemas.

• :envelope_location (Symbol) — default: :metadata —

  Where to store the envelope encryption keys. By default, the envelope is stored with the encrypted object. If you pass ‘:instruction_file`, then the envelope is stored in a separate object in Amazon S3.

• :instruction_file_suffix (String) — default: '.instruction' —

  When ‘:envelope_location` is `:instruction_file` then the instruction file uses the object key with this suffix appended.

• :kms_client (KMS::Client) —

  A default KMS::Client is constructed when using KMS to manage encryption keys.

# File 'lib/aws-sdk-s3/encryptionV2/client.rb', line 310

def initialize(options = {})
  validate_params(options)
  @client = extract_client(options)
  @cipher_provider = cipher_provider(options)
  @envelope_location = extract_location(options)
  @instruction_file_suffix = extract_suffix(options)
  @kms_allow_decrypt_with_any_cmk =
    options[:kms_key_id] == :kms_allow_decrypt_with_any_cmk
  @security_profile = extract_security_profile(options)
end

Instance Attribute Details

#client ⇒ S3::Client (readonly)

Returns:

• (S3::Client)

# File 'lib/aws-sdk-s3/encryptionV2/client.rb', line 322

def client
  @client
end

#envelope_location ⇒ Symbol<:metadata, :instruction_file> (readonly)

Returns:

• (Symbol<:metadata, :instruction_file>)

# File 'lib/aws-sdk-s3/encryptionV2/client.rb', line 337

def envelope_location
  @envelope_location
end

#instruction_file_suffix ⇒ String (readonly)

Returns When #envelope_location is ‘:instruction_file`, the envelope is stored in the object with the object key suffixed by this string.

Returns:

• (String) —

  When #envelope_location is ‘:instruction_file`, the envelope is stored in the object with the object key suffixed by this string.

# File 'lib/aws-sdk-s3/encryptionV2/client.rb', line 342

def instruction_file_suffix
  @instruction_file_suffix
end

#key_provider ⇒ KeyProvider^? (readonly)

Returns ‘nil` if you are using AWS Key Management Service (KMS).

Returns:

• (KeyProvider, nil) —

  Returns ‘nil` if you are using AWS Key Management Service (KMS).

# File 'lib/aws-sdk-s3/encryptionV2/client.rb', line 326

def key_provider
  @key_provider
end

#kms_allow_decrypt_with_any_cmk ⇒ Boolean (readonly)

Returns If true the provided KMS key_id will not be used during decrypt, allowing decryption with the key_id from the object.

Returns:

• (Boolean) —

  If true the provided KMS key_id will not be used during decrypt, allowing decryption with the key_id from the object.

# File 'lib/aws-sdk-s3/encryptionV2/client.rb', line 334

def kms_allow_decrypt_with_any_cmk
  @kms_allow_decrypt_with_any_cmk
end

#security_profile ⇒ Symbol (readonly)

Returns Determines the support for reading objects written using older key wrap or content encryption schemas.

Returns:

• (Symbol) —

  Determines the support for reading objects written using older key wrap or content encryption schemas.

# File 'lib/aws-sdk-s3/encryptionV2/client.rb', line 330

def security_profile
  @security_profile
end

Instance Method Details

#get_object(params = {}, &block) ⇒ Types::GetObjectOutput

Note:

The ‘:range` request parameter is not supported.

Gets an object from Amazon S3, decrypting data locally. See Client#get_object for documentation on accepted request parameters. Warning: If you provide a block to get_object or set the request parameter :response_target to a Proc, then read the entire object to the end before you start using the decrypted data. This is to verify that the object has not been modified since it was encrypted.

Parameters:

• options (Hash) —

  a customizable set of options

• params (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (params):

• :instruction_file_suffix (String) —

  The suffix used to find the instruction file containing the encryption envelope. You should not set this option when the envelope is stored in the object metadata. Defaults to #instruction_file_suffix.

• :kms_encryption_context (Hash) —

  Additional encryption context to use with KMS. Applies only when KMS is used.

• :response_target (String, IO) —

  Where to write response data, file path, or IO object.

• :bucket (required, String) —

  The bucket name containing the object.

  When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points] in the *Amazon S3 User Guide*.

  When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

  When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

  Using Amazon S3 on Outposts][2

  in the *Amazon S3 User Guide*.

  [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

• :if_match (String) —

  Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

• :if_modified_since (Time, DateTime, Date, Integer, String) —

  Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

• :if_none_match (String) —

  Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

• :if_unmodified_since (Time, DateTime, Date, Integer, String) —

  Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

• :key (required, String) —

  Key of the object to get.

• :range (String) —

  Downloads the specified range bytes of an object. For more information about the HTTP Range header, see [www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35][1].

  <note markdown=“1”> Amazon S3 doesn’t support retrieving multiple ranges of data per ‘GET` request.

  </note>
  

  [1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35

• :response_cache_control (String) —

  Sets the ‘Cache-Control` header of the response.

• :response_content_disposition (String) —

  Sets the ‘Content-Disposition` header of the response

• :response_content_encoding (String) —

  Sets the ‘Content-Encoding` header of the response.

• :response_content_language (String) —

  Sets the ‘Content-Language` header of the response.

• :response_content_type (String) —

  Sets the ‘Content-Type` header of the response.

• :response_expires (Time, DateTime, Date, Integer, String) —

  Sets the ‘Expires` header of the response.

• :version_id (String) —

  VersionId used to reference a specific version of the object.

• :sse_customer_algorithm (String) —

  Specifies the algorithm to use to when decrypting the object (for example, AES256).

• :sse_customer_key (String) —

  Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the ‘x-amz-server-side-encryption-customer-algorithm` header.

• :sse_customer_key_md5 (String) —

  Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

• :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 Requester Pays Buckets] in the *Amazon S3 User Guide*.

  [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

• :part_number (Integer) —

  Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a ‘ranged’ GET request for the part specified. Useful for downloading just a part of an object.

• :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).

• :checksum_mode (String) —

  To retrieve the checksum, this mode must be enabled.

Returns:

• (Types::GetObjectOutput) —

  Returns a response object which responds to the following methods:

  • #body => IO

  • #delete_marker => Boolean

  • #accept_ranges => String

  • #expiration => String

  • #restore => String

  • #last_modified => Time

  • #content_length => Integer

  • #etag => String

  • #checksum_crc32 => String

  • #checksum_crc32c => String

  • #checksum_sha1 => String

  • #checksum_sha256 => String

  • #missing_meta => Integer

  • #version_id => String

  • #cache_control => String

  • #content_disposition => String

  • #content_encoding => String

  • #content_language => String

  • #content_range => String

  • #content_type => String

  • #expires => Time

  • #expires_string => String

  • #website_redirect_location => String

  • #server_side_encryption => String

  • #metadata => Hash&lt;String,String&gt;

  • #sse_customer_algorithm => String

  • #sse_customer_key_md5 => String

  • #ssekms_key_id => String

  • #bucket_key_enabled => Boolean

  • #storage_class => String

  • #request_charged => String

  • #replication_status => String

  • #parts_count => Integer

  • #tag_count => Integer

  • #object_lock_mode => String

  • #object_lock_retain_until_date => Time

  • #object_lock_legal_hold_status => String

See Also:

• Client#get_object

# File 'lib/aws-sdk-s3/encryptionV2/client.rb', line 398

def get_object(params = {}, &block)
  if params[:range]
    raise NotImplementedError, '#get_object with :range not supported'
  end
  envelope_location, instruction_file_suffix = envelope_options(params)
  kms_encryption_context = params.delete(:kms_encryption_context)
  kms_any_cmk_mode = kms_any_cmk_mode(params)
  security_profile = security_profile_from_params(params)

  req = @client.build_request(:get_object, params)
  req.handlers.add(DecryptHandler)
  req.context[:encryption] = {
    cipher_provider: @cipher_provider,
    envelope_location: envelope_location,
    instruction_file_suffix: instruction_file_suffix,
    kms_encryption_context: kms_encryption_context,
    kms_allow_decrypt_with_any_cmk: kms_any_cmk_mode,
    security_profile: security_profile
  }
  req.send_request(target: block)
end

#put_object(params = {}) ⇒ Types::PutObjectOutput

Uploads an object to Amazon S3, encrypting data client-side. See Client#put_object for documentation on accepted request parameters.

Parameters:

• params (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (params):

• :kms_encryption_context (Hash) —

  Additional encryption context to use with KMS. Applies only when KMS is used. In order to decrypt the object you will need to provide the identical :kms_encryption_context to ‘get_object`.

• :acl (String) —

  The canned ACL to apply to the object. For more information, see [Canned ACL].

  This action is not supported by Amazon S3 on Outposts.

  [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL

• :body (String, StringIO, File) —

  Object data.

• :bucket (required, String) —

  The bucket name to which the PUT action was initiated.

  When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see [Using access points] in the *Amazon S3 User Guide*.

  When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form ‘ AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

  Using Amazon S3 on Outposts][2

  in the *Amazon S3 User Guide*.

  [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

• :cache_control (String) —

  Can be used to specify caching behavior along the request/reply chain. For more information, see [www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9][1].

  [1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9

• :content_disposition (String) —

  Specifies presentational information for the object. For more information, see [www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1][1].

  [1]: www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1

• :content_encoding (String) —

  Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see [www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11][1].

  [1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11

• :content_language (String) —

  The language the content is in.

• :content_length (Integer) —

  Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see [www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13][1].

  [1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13

• :content_md5 (String) —

  The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see [REST Authentication].

  [1]: docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html

• :content_type (String) —

  A standard MIME type describing the format of the contents. For more information, see [www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17][1].

  [1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17

• :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.

  [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

• :checksum_crc32 (String) —

  This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

  [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

• :checksum_crc32c (String) —

  This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

  [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

• :checksum_sha1 (String) —

  This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

  [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

• :checksum_sha256 (String) —

  This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

  [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

• :expires (Time, DateTime, Date, Integer, String) —

  The date and time at which the object is no longer cacheable. For more information, see [www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21][1].

  [1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21

• :grant_full_control (String) —

  Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

  This action is not supported by Amazon S3 on Outposts.

• :grant_read (String) —

  Allows grantee to read the object data and its metadata.

  This action is not supported by Amazon S3 on Outposts.

• :grant_read_acp (String) —

  Allows grantee to read the object ACL.

  This action is not supported by Amazon S3 on Outposts.

• :grant_write_acp (String) —

  Allows grantee to write the ACL for the applicable object.

  This action is not supported by Amazon S3 on Outposts.

• :key (required, String) —

  Object key for which the PUT action was initiated.

• :metadata (Hash<String,String>) —

  A map of metadata to store with the object in S3.

• :server_side_encryption (String) —

  The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

• :storage_class (String) —

  By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see [Storage Classes] in the *Amazon S3 User Guide*.

  [1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html

• :website_redirect_location (String) —

  If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see [Object Key and Metadata].

  In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

  ‘x-amz-website-redirect-location: /anotherPage.html`

  In the following example, the request header sets the object redirect to another website:

  ‘x-amz-website-redirect-location: www.example.com/`

  For more information about website hosting in Amazon S3, see [Hosting Websites on Amazon S3] and [How to Configure Website Page Redirects].

  [1]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html [2]: docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html

• :sse_customer_algorithm (String) —

  Specifies the algorithm to use to when encrypting the object (for example, AES256).

• :sse_customer_key (String) —

  Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the ‘x-amz-server-side-encryption-customer-algorithm` header.

• :sse_customer_key_md5 (String) —

  Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

• :ssekms_key_id (String) —

  If ‘x-amz-server-side-encryption` is present and has the value of `aws:kms`, this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical customer managed key that was used for the object. If you specify `x-amz-server-side-encryption:aws:kms`, but do not provide` x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the Amazon Web Services managed key to protect the data. If the KMS key does not exist in the same account issuing the command, you must use the full ARN and not just the ID.

• :ssekms_encryption_context (String) —

  Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

• :bucket_key_enabled (Boolean) —

  Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to ‘true` causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

  Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

• :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 Requester Pays Buckets] in the *Amazon S3 User Guide*.

  [1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

• :tagging (String) —

  The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, “Key1=Value1”)

• :object_lock_mode (String) —

  The Object Lock mode that you want to apply to this object.

• :object_lock_retain_until_date (Time, DateTime, Date, Integer, String) —

  The date and time when you want this object’s Object Lock to expire. Must be formatted as a timestamp parameter.

• :object_lock_legal_hold_status (String) —

  Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see [Object Lock].

  [1]: docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html

• :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:

• (Types::PutObjectOutput) —

  Returns a response object which responds to the following methods:

  • #expiration => String

  • #etag => String

  • #checksum_crc32 => String

  • #checksum_crc32c => String

  • #checksum_sha1 => String

  • #checksum_sha256 => String

  • #server_side_encryption => String

  • #version_id => String

  • #sse_customer_algorithm => String

  • #sse_customer_key_md5 => String

  • #ssekms_key_id => String

  • #ssekms_encryption_context => String

  • #bucket_key_enabled => Boolean

  • #request_charged => String

See Also:

• Client#put_object

# File 'lib/aws-sdk-s3/encryptionV2/client.rb', line 354

def put_object(params = {})
  kms_encryption_context = params.delete(:kms_encryption_context)
  req = @client.build_request(:put_object, params)
  req.handlers.add(EncryptHandler, priority: 95)
  req.context[:encryption] = {
    cipher_provider: @cipher_provider,
    envelope_location: @envelope_location,
    instruction_file_suffix: @instruction_file_suffix,
    kms_encryption_context: kms_encryption_context
  }
  req.send_request
end