Class: Aws::S3::Types::PutObjectRequest

Inherits:

Struct

Object
Struct
Aws::S3::Types::PutObjectRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-s3/types.rb

Overview

Note:

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

{
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
  body: source_file,
  bucket: "BucketName", # required
  cache_control: "CacheControl",
  content_disposition: "ContentDisposition",
  content_encoding: "ContentEncoding",
  content_language: "ContentLanguage",
  content_length: 1,
  content_md5: "ContentMD5",
  content_type: "ContentType",
  expires: Time.now,
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write_acp: "GrantWriteACP",
  key: "ObjectKey", # required
  metadata: {
    "MetadataKey" => "MetadataValue",
  },
  server_side_encryption: "AES256", # accepts AES256, aws:kms
  storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
  website_redirect_location: "WebsiteRedirectLocation",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  ssekms_key_id: "SSEKMSKeyId",
  ssekms_encryption_context: "SSEKMSEncryptionContext",
  request_payer: "requester", # accepts requester
  tagging: "TaggingHeader",
  object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
  object_lock_retain_until_date: Time.now,
  object_lock_legal_hold_status: "ON", # accepts ON, OFF
}

Instance Attribute Summary collapse

#acl ⇒ String

The canned ACL to apply to the object.
#body ⇒ IO

Object data.
#bucket ⇒ String

Name of the bucket to which the PUT operation was initiated.
#cache_control ⇒ String

Specifies caching behavior along the request/reply chain.
#content_disposition ⇒ String

Specifies presentational information for the object.
#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.
#content_language ⇒ String

The language the content is in.
#content_length ⇒ Integer

Size of the body in bytes.
#content_md5 ⇒ String

The base64-encoded 128-bit MD5 digest of the part data.
#content_type ⇒ String

A standard MIME type describing the format of the object data.
#expires ⇒ Time

The date and time at which the object is no longer cacheable.
#grant_full_control ⇒ String

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
#grant_read ⇒ String

Allows grantee to read the object data and its metadata.
#grant_read_acp ⇒ String

Allows grantee to read the object ACL.
#grant_write_acp ⇒ String

Allows grantee to write the ACL for the applicable object.
#key ⇒ String

Object key for which the PUT operation was initiated.
#metadata ⇒ Hash<String,String>

A map of metadata to store with the object in S3.
#object_lock_legal_hold_status ⇒ String

The Legal Hold status that you want to apply to the specified object.
#object_lock_mode ⇒ String

The object lock mode that you want to apply to this object.
#object_lock_retain_until_date ⇒ Time

The date and time when you want this object’s object lock to expire.
#request_payer ⇒ String

Confirms that the requester knows that she or he will be charged for the request.
#server_side_encryption ⇒ String

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
#sse_customer_algorithm ⇒ String

Specifies the algorithm to use to when encrypting the object (e.g., AES256).
#sse_customer_key ⇒ String

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
#sse_customer_key_md5 ⇒ String

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
#ssekms_encryption_context ⇒ String

Specifies the AWS KMS Encryption Context to use for object encryption.
#ssekms_key_id ⇒ String

Specifies the AWS KMS key ID to use for object encryption.
#storage_class ⇒ String

The type of storage to use for the object.
#tagging ⇒ String

The tag-set for the object.
#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.

Instance Attribute Details

#acl ⇒ `String`

The canned ACL to apply to the object.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#body ⇒ `IO`

Object data.

Returns:

(IO)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#bucket ⇒ `String`

Name of the bucket to which the PUT operation was initiated.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#cache_control ⇒ `String`

Specifies caching behavior along the request/reply chain.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#content_disposition ⇒ `String`

Specifies presentational information for the object.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

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

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#content_language ⇒ `String`

The language the content is in.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#content_length ⇒ `Integer`

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

Returns:

(Integer)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#content_md5 ⇒ `String`

The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameted is required if object lock parameters are specified.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#content_type ⇒ `String`

A standard MIME type describing the format of the object data.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#expires ⇒ `Time`

The date and time at which the object is no longer cacheable.

Returns:

(Time)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#grant_full_control ⇒ `String`

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

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#grant_read ⇒ `String`

Allows grantee to read the object data and its metadata.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#grant_read_acp ⇒ `String`

Allows grantee to read the object ACL.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#grant_write_acp ⇒ `String`

Allows grantee to write the ACL for the applicable object.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#key ⇒ `String`

Object key for which the PUT operation was initiated.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#metadata ⇒ `Hash<String,String>`

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

Returns:

(Hash<String,String>)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#object_lock_legal_hold_status ⇒ `String`

The Legal Hold status that you want to apply to the specified object.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#object_lock_mode ⇒ `String`

The object lock mode that you want to apply to this object.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#object_lock_retain_until_date ⇒ `Time`

The date and time when you want this object’s object lock to expire.

Returns:

(Time)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#request_payer ⇒ `String`

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#server_side_encryption ⇒ `String`

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#sse_customer_algorithm ⇒ `String`

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

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

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#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 the encryption key was transmitted without error.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#ssekms_encryption_context ⇒ `String`

Specifies the AWS 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.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#ssekms_key_id ⇒ `String`

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#storage_class ⇒ `String`

The type of storage to use for the object. Defaults to ‘STANDARD’.

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

#tagging ⇒ `String`

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

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

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

Returns:

(String)

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

class PutObjectRequest < Struct.new(
  :acl,
  :body,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_length,
  :content_md5,
  :content_type,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  include Aws::Structure
end

Class: Aws::S3::Types::PutObjectRequest

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#acl ⇒ String

#body ⇒ IO

#bucket ⇒ String

#cache_control ⇒ String

#content_disposition ⇒ String

#content_encoding ⇒ String

#content_language ⇒ String

#content_length ⇒ Integer

#content_md5 ⇒ String

#content_type ⇒ String

#expires ⇒ Time

#grant_full_control ⇒ String

#grant_read ⇒ String

#grant_read_acp ⇒ String

#grant_write_acp ⇒ String

#key ⇒ String

#metadata ⇒ Hash<String,String>

#object_lock_legal_hold_status ⇒ String

#object_lock_mode ⇒ String

#object_lock_retain_until_date ⇒ Time

#request_payer ⇒ String

#server_side_encryption ⇒ String

#sse_customer_algorithm ⇒ String

#sse_customer_key ⇒ String

#sse_customer_key_md5 ⇒ String

#ssekms_encryption_context ⇒ String

#ssekms_key_id ⇒ String

#storage_class ⇒ String

#tagging ⇒ String

#website_redirect_location ⇒ String

#acl ⇒ `String`

#body ⇒ `IO`

#bucket ⇒ `String`

#cache_control ⇒ `String`

#content_disposition ⇒ `String`

#content_encoding ⇒ `String`

#content_language ⇒ `String`

#content_length ⇒ `Integer`

#content_md5 ⇒ `String`

#content_type ⇒ `String`

#expires ⇒ `Time`

#grant_full_control ⇒ `String`

#grant_read ⇒ `String`

#grant_read_acp ⇒ `String`

#grant_write_acp ⇒ `String`

#key ⇒ `String`

#metadata ⇒ `Hash<String,String>`

#object_lock_legal_hold_status ⇒ `String`

#object_lock_mode ⇒ `String`

#object_lock_retain_until_date ⇒ `Time`

#request_payer ⇒ `String`

#server_side_encryption ⇒ `String`

#sse_customer_algorithm ⇒ `String`

#sse_customer_key ⇒ `String`

#sse_customer_key_md5 ⇒ `String`

#ssekms_encryption_context ⇒ `String`

#ssekms_key_id ⇒ `String`

#storage_class ⇒ `String`

#tagging ⇒ `String`

#website_redirect_location ⇒ `String`