Class PutObjectRequest
Container for the parameters to the PutObject operation.
Adds an object to a bucket.
public class PutObjectRequest : PutWithACLRequest- Inheritance
-
PutObjectRequest
- Inherited Members
Constructors
PutObjectRequest()
public PutObjectRequest()Properties
AutoCloseStream
If this value is set to true then the stream used with this request will be closed when all the content
is read from the stream.
Default: true.
public bool AutoCloseStream { get; set; }Property Value
AutoResetStreamPosition
If this value is set to true then the stream will be seeked back to the start before being read for upload. Default: true.
public bool AutoResetStreamPosition { get; set; }Property Value
BucketName
The bucket name to which the PUT operation was initiated.
When using this API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.
When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
public string BucketName { get; set; }Property Value
CannedACL
A canned access control list (CACL) to apply to the object. Please refer to S3CannedACL for information on S3 Canned ACLs.
public S3CannedACL CannedACL { get; set; }Property Value
ContentBody
Text content to be uploaded. Use this property if you want to upload plaintext to S3. The content type will be set to 'text/plain'.
public string ContentBody { get; set; }Property Value
ContentType
This is a convenience property for Headers.ContentType.
public string ContentType { get; set; }Property Value
DisableMD5Stream
WARNING: Setting DisableMD5Stream to true disables the MD5 data integrity check on this request.
When true, MD5Stream will not be used in the upload request. This may increase upload performance under high CPU loads. The default value is null. When null, the AWSConfigsS3.DisableMD5Stream property value will be used.
MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the possibility of data corruption is completely dependant on HTTPS being the only remaining source of data integrity verification.
public bool? DisableMD5Stream { get; set; }Property Value
- bool?
DisablePayloadSigning
WARNING: Setting DisablePayloadSigning to true disables the SigV4 payload signing data integrity check on this request.
If using SigV4, the DisablePayloadSigning flag controls if the payload should be signed on a request by request basis. By default this flag is null which will use the default client behavior. The default client behavior is to sign the payload. When DisablePayloadSigning is true, the request will be signed with an UNSIGNED-PAYLOAD value. Setting DisablePayloadSigning to true requires that the request is sent over a HTTPS connection.
Under certain circumstances, such as uploading to S3 while using MD5 hashing, it may be desireable to use UNSIGNED-PAYLOAD to decrease signing CPU usage. This flag only applies to Amazon S3 PutObject and UploadPart requests.
MD5Stream, SigV4 payload signing, and HTTPS each provide some data integrity verification. If DisableMD5Stream is true and DisablePayloadSigning is true, then the possibility of data corruption is completely dependant on HTTPS being the only remaining source of data integrity verification.
public bool? DisablePayloadSigning { get; set; }Property Value
- bool?
Expect100Continue
Overriden to turn on expect 100 continue.
protected override bool Expect100Continue { get; }Property Value
ExpectedBucketOwner
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.
public string ExpectedBucketOwner { get; set; }Property Value
FilePath
The full path and name to a file to be uploaded. If this is set the request will upload the specified file to S3.
For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt".
public string FilePath { get; set; }Property Value
Headers
The collection of headers for the request.
public HeadersCollection Headers { get; }Property Value
IncludeSHA256Header
Overriden to turn off sending SHA256 header.
protected override bool IncludeSHA256Header { get; }Property Value
InputStream
Input stream for the request; content for the request will be read from the stream.
public Stream InputStream { get; set; }Property Value
Key
Gets and sets Key property. This key is used to identify the object in S3.
public string Key { get; set; }Property Value
MD5Digest
An MD5 digest for the content.
public string MD5Digest { get; set; }Property Value
Remarks
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.
If supplied, after the file has been uploaded to S3, S3 checks to ensure that the MD5 hash of the uploaded file matches the hash supplied.
Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check.
Metadata
The collection of meta data for the request.
public MetadataCollection Metadata { get; }Property Value
ObjectLockLegalHoldStatus
Gets and sets the property ObjectLockLegalHoldStatus.
The Legal Hold status that you want to apply to the specified object.
public ObjectLockLegalHoldStatus ObjectLockLegalHoldStatus { get; set; }Property Value
ObjectLockMode
Gets and sets the property ObjectLockMode.
The Object Lock mode that you want to apply to this object.
public ObjectLockMode ObjectLockMode { get; set; }Property Value
ObjectLockRetainUntilDate
Gets and sets the property ObjectLockRetainUntilDate.
The date and time when you want this object's Object Lock to expire.
public DateTime ObjectLockRetainUntilDate { get; set; }Property Value
RequestPayer
Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.
public RequestPayer RequestPayer { get; set; }Property Value
ServerSideEncryptionCustomerMethod
The Server-side encryption algorithm to be used with the customer provided key.
public ServerSideEncryptionCustomerMethod ServerSideEncryptionCustomerMethod { get; set; }Property Value
ServerSideEncryptionCustomerProvidedKey
The base64-encoded encryption key for Amazon S3 to use to encrypt the object
Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide.
When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you.
Important: Amazon S3 does not store the encryption key you provide.
public string ServerSideEncryptionCustomerProvidedKey { get; set; }Property Value
ServerSideEncryptionCustomerProvidedKeyMD5
The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set.
public string ServerSideEncryptionCustomerProvidedKeyMD5 { get; set; }Property Value
ServerSideEncryptionKeyManagementServiceEncryptionContext
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.
public string ServerSideEncryptionKeyManagementServiceEncryptionContext { get; set; }Property Value
ServerSideEncryptionKeyManagementServiceKeyId
The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. If a key id is not specified, the default key will be used for encryption and decryption.
public string ServerSideEncryptionKeyManagementServiceKeyId { get; set; }Property Value
ServerSideEncryptionMethod
The Server-side encryption algorithm used when storing this object in S3.
public ServerSideEncryptionMethod ServerSideEncryptionMethod { get; set; }Property Value
StorageClass
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 Service Developer Guide.
public S3StorageClass StorageClass { get; set; }Property Value
StreamTransferProgress
Attach a callback that will be called as data is being sent to the AWS Service.
public EventHandler<StreamTransferProgressArgs> StreamTransferProgress { get; set; }Property Value
- EventHandler<StreamTransferProgressArgs>
TagSet
The tag-set for the object. The tag-set must be encoded as URL Query parameters.
public List<Tag> TagSet { get; set; }Property Value
UseChunkEncoding
If this value is set to true then a chunked encoding upload will be used for the request. Default: true.
public bool UseChunkEncoding { get; set; }Property Value
WebsiteRedirectLocation
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.
public string WebsiteRedirectLocation { get; set; }