AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Adds an object to a bucket.
Namespace: Amazon.S3.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class PutObjectRequest : PutWithACLRequest IRequestEvents
The PutObjectRequest type exposes the following members
Name | Description | |
---|---|---|
PutObjectRequest() |
Name | Type | Description | |
---|---|---|---|
AutoCloseStream | System.Boolean | 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. | |
AutoResetStreamPosition | System.Boolean | If this value is set to true then the stream will be seeked back to the start before being read for upload. Default: true. | |
BucketName | System.String | The name of the bucket to contain the object. | |
CannedACL | Amazon.S3.S3CannedACL | A canned access control list (CACL) to apply to the object. Please refer to S3CannedACL for information on S3 Canned ACLs. | |
ContentBody | System.String | 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'. | |
ContentType | System.String | This is a convenience property for Headers.ContentType. | |
FilePath | System.String |
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". |
|
Grants | System.Collections.Generic.List<Amazon.S3.Model.S3Grant> | Gets the access control lists (ACLs) for this request. Please refer to S3Grant for information on S3 Grants. | |
Headers | Amazon.S3.Model.HeadersCollection | The collection of headers for the request. | |
InputStream | System.IO.Stream | Input stream for the request; content for the request will be read from the stream. | |
Key | System.String | ||
MD5Digest | System.String | An MD5 digest for the content. | |
Metadata | Amazon.S3.Model.MetadataCollection | The collection of meta data for the request. | |
ReadWriteTimeout | System.Nullable<System.TimeSpan> | Overrides the default ReadWriteTimeout value. | |
ServerSideEncryptionCustomerMethod | Amazon.S3.ServerSideEncryptionCustomerMethod | The Server-side encryption algorithm to be used with the customer provided key. | |
ServerSideEncryptionCustomerProvidedKey | System.String |
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. |
|
ServerSideEncryptionCustomerProvidedKeyMD5 | System.String | 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. | |
ServerSideEncryptionKeyManagementServiceKeyId | System.String | 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. | |
ServerSideEncryptionMethod | Amazon.S3.ServerSideEncryptionMethod | The Server-side encryption algorithm used when storing this object in S3. | |
StorageClass | Amazon.S3.S3StorageClass | The type of storage to use for the object. Defaults to 'STANDARD'. | |
StreamTransferProgress | System.EventHandler<Amazon.Runtime.StreamTransferProgressArgs> | Attach a callback that will be called as data is being sent to the AWS Service. | |
Timeout | System.Nullable<System.TimeSpan> | Overrides the default request timeout value. | |
WebsiteRedirectLocation | System.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. |
This following examples show multiple ways of creating an object.
This example shows how to put an object, with its content being passed along as a string.
// Create a client AmazonS3Client client = new AmazonS3Client(); // Create a PutObject request PutObjectRequest request = new PutObjectRequest { BucketName = "SampleBucket", Key = "Item1", ContentBody = "This is sample content..." }; // Put object PutObjectResponse response = client.PutObject(request);
This example shows how to put an object, setting its content to be a file.
// Create a client AmazonS3Client client = new AmazonS3Client(); // Create a PutObject request PutObjectRequest request = new PutObjectRequest { BucketName = "SampleBucket", Key = "Item1", FilePath = "contents.txt" }; // Put object PutObjectResponse response = client.PutObject(request);
This example shows how to put an object using a stream.
// Create a client AmazonS3Client client = new AmazonS3Client(); // Create a PutObject request PutObjectRequest request = new PutObjectRequest { BucketName = "SampleBucket", Key = "Item1", }; using (FileStream stream = new FileStream("contents.txt", FileMode.Open)) { request.InputStream = stream; // Put object PutObjectResponse response = client.PutObject(request); }
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8