commonMain.aws.sdk.kotlin.services.s3.model.PutObjectRequest.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.s3.model
import aws.smithy.kotlin.runtime.content.ByteStream
import aws.smithy.kotlin.runtime.time.Instant
public class PutObjectRequest private constructor(builder: Builder) {
/**
* The canned ACL to apply to the object. For more information, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL) in the *Amazon S3 User Guide*.
*
* When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and [Managing ACLs Using the REST API](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html) in the *Amazon S3 User Guide*.
*
* If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the `bucket-owner-full-control` canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a `400` error with the error code `AccessControlListNotSupported`. For more information, see [ Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public val acl: aws.sdk.kotlin.services.s3.model.ObjectCannedAcl? = builder.acl
/**
* Object data.
*/
public val body: aws.smithy.kotlin.runtime.content.ByteStream? = builder.body
/**
* The bucket name to which the PUT action was initiated.
*
* **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ` Bucket_name.s3express-az_id.region.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format ` bucket_base_name--az-id--x-s3` (for example, ` DOC-EXAMPLE-BUCKET--usw2-az2--x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) in the *Amazon S3 User Guide*.
*
* **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) in the *Amazon S3 User Guide*.
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
* **S3 on Outposts** - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the *Amazon S3 User Guide*.
*/
public val bucket: kotlin.String? = builder.bucket
/**
* Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (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.
*
* This functionality is not supported for directory buckets.
*/
public val bucketKeyEnabled: kotlin.Boolean? = builder.bucketKeyEnabled
/**
* Can be used to specify caching behavior along the request/reply chain. For more information, see [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9).
*/
public val cacheControl: kotlin.String? = builder.cacheControl
/**
* Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding `x-amz-checksum-algorithm ` or `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request with the HTTP status code `400 Bad Request`.
*
* For the `x-amz-checksum-algorithm ` header, replace ` algorithm ` with the supported algorithm from the following list:
* + CRC32
* + CRC32C
* + SHA1
* + SHA256
*
* For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*
* If the individual checksum value you provide through `x-amz-checksum-algorithm ` doesn't match the checksum algorithm you set through `x-amz-sdk-checksum-algorithm`, Amazon S3 ignores any provided `ChecksumAlgorithm` parameter and uses the checksum algorithm that matches the provided value in `x-amz-checksum-algorithm `.
*
* For directory buckets, when you use Amazon Web Services SDKs, `CRC32` is the default checksum algorithm that's used for performance.
*/
public val checksumAlgorithm: aws.sdk.kotlin.services.s3.model.ChecksumAlgorithm? = builder.checksumAlgorithm
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public val checksumCrc32: kotlin.String? = builder.checksumCrc32
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public val checksumCrc32C: kotlin.String? = builder.checksumCrc32C
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public val checksumSha1: kotlin.String? = builder.checksumSha1
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public val checksumSha256: kotlin.String? = builder.checksumSha256
/**
* Specifies presentational information for the object. For more information, see [https://www.rfc-editor.org/rfc/rfc6266#section-4](https://www.rfc-editor.org/rfc/rfc6266#section-4).
*/
public val contentDisposition: kotlin.String? = builder.contentDisposition
/**
* 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 [https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding).
*/
public val contentEncoding: kotlin.String? = builder.contentEncoding
/**
* The language the content is in.
*/
public val contentLanguage: kotlin.String? = builder.contentLanguage
/**
* Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length](https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length).
*/
public val contentLength: kotlin.Long? = builder.contentLength
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).
*
* The `Content-MD5` header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see [Amazon S3 Object Lock Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public val contentMd5: kotlin.String? = builder.contentMd5
/**
* A standard MIME type describing the format of the contents. For more information, see [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type](https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type).
*/
public val contentType: kotlin.String? = builder.contentType
/**
* The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code `403 Forbidden` (access denied).
*/
public val expectedBucketOwner: kotlin.String? = builder.expectedBucketOwner
/**
* The date and time at which the object is no longer cacheable. For more information, see [https://www.rfc-editor.org/rfc/rfc7234#section-5.3](https://www.rfc-editor.org/rfc/rfc7234#section-5.3).
*/
public val expires: aws.smithy.kotlin.runtime.time.Instant? = builder.expires
/**
* Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantFullControl: kotlin.String? = builder.grantFullControl
/**
* Allows grantee to read the object data and its metadata.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantRead: kotlin.String? = builder.grantRead
/**
* Allows grantee to read the object ACL.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantReadAcp: kotlin.String? = builder.grantReadAcp
/**
* Allows grantee to write the ACL for the applicable object.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public val grantWriteAcp: kotlin.String? = builder.grantWriteAcp
/**
* Object key for which the PUT action was initiated.
*/
public val key: kotlin.String? = builder.key
/**
* A map of metadata to store with the object in S3.
*/
public val metadata: Map? = builder.metadata
/**
* Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see [Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public val objectLockLegalHoldStatus: aws.sdk.kotlin.services.s3.model.ObjectLockLegalHoldStatus? = builder.objectLockLegalHoldStatus
/**
* The Object Lock mode that you want to apply to this object.
*
* This functionality is not supported for directory buckets.
*/
public val objectLockMode: aws.sdk.kotlin.services.s3.model.ObjectLockMode? = builder.objectLockMode
/**
* The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
*
* This functionality is not supported for directory buckets.
*/
public val objectLockRetainUntilDate: aws.smithy.kotlin.runtime.time.Instant? = builder.objectLockRetainUntilDate
/**
* Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public val requestPayer: aws.sdk.kotlin.services.s3.model.RequestPayer? = builder.requestPayer
/**
* The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
*
* **General purpose buckets ** - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see [Using Server-Side Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Amazon S3 User Guide*.
*
* **Directory buckets ** - For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) value is supported.
*/
public val serverSideEncryption: aws.sdk.kotlin.services.s3.model.ServerSideEncryption? = builder.serverSideEncryption
/**
* Specifies the algorithm to use when encrypting the object (for example, `AES256`).
*
* This functionality is not supported for directory buckets.
*/
public val sseCustomerAlgorithm: kotlin.String? = builder.sseCustomerAlgorithm
/**
* 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.
*
* This functionality is not supported for directory buckets.
*/
public val sseCustomerKey: kotlin.String? = builder.sseCustomerKey
/**
* 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.
*
* This functionality is not supported for directory buckets.
*/
public val sseCustomerKeyMd5: kotlin.String? = builder.sseCustomerKeyMd5
/**
* 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. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future `GetObject` or `CopyObject` operations on this object. This value must be explicitly added during `CopyObject` operations.
*
* This functionality is not supported for directory buckets.
*/
public val ssekmsEncryptionContext: kotlin.String? = builder.ssekmsEncryptionContext
/**
* If `x-amz-server-side-encryption` has a valid value of `aws:kms` or `aws:kms:dsse`, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object. If you specify `x-amz-server-side-encryption:aws:kms` or `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide` x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the Amazon Web Services managed key (`aws/s3`) to protect the data. If the KMS key does not exist in the same account that's issuing the command, you must use the full ARN and not just the ID.
*
* This functionality is not supported for directory buckets.
*/
public val ssekmsKeyId: kotlin.String? = builder.ssekmsKeyId
/**
* 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. For more information, see [Storage Classes](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in the *Amazon S3 User Guide*.
*
* + For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
* + Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*/
public val storageClass: aws.sdk.kotlin.services.s3.model.StorageClass? = builder.storageClass
/**
* The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
*
* This functionality is not supported for directory buckets.
*/
public val tagging: kotlin.String? = builder.tagging
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html) in the *Amazon S3 User Guide*.
*
* 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: http://www.example.com/`
*
* For more information about website hosting in Amazon S3, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) and [How to Configure Website Page Redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public val websiteRedirectLocation: kotlin.String? = builder.websiteRedirectLocation
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.s3.model.PutObjectRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("PutObjectRequest(")
append("acl=$acl,")
append("body=$body,")
append("bucket=$bucket,")
append("bucketKeyEnabled=$bucketKeyEnabled,")
append("cacheControl=$cacheControl,")
append("checksumAlgorithm=$checksumAlgorithm,")
append("checksumCrc32=$checksumCrc32,")
append("checksumCrc32C=$checksumCrc32C,")
append("checksumSha1=$checksumSha1,")
append("checksumSha256=$checksumSha256,")
append("contentDisposition=$contentDisposition,")
append("contentEncoding=$contentEncoding,")
append("contentLanguage=$contentLanguage,")
append("contentLength=$contentLength,")
append("contentMd5=$contentMd5,")
append("contentType=$contentType,")
append("expectedBucketOwner=$expectedBucketOwner,")
append("expires=$expires,")
append("grantFullControl=$grantFullControl,")
append("grantRead=$grantRead,")
append("grantReadAcp=$grantReadAcp,")
append("grantWriteAcp=$grantWriteAcp,")
append("key=$key,")
append("metadata=$metadata,")
append("objectLockLegalHoldStatus=$objectLockLegalHoldStatus,")
append("objectLockMode=$objectLockMode,")
append("objectLockRetainUntilDate=$objectLockRetainUntilDate,")
append("requestPayer=$requestPayer,")
append("serverSideEncryption=$serverSideEncryption,")
append("sseCustomerAlgorithm=$sseCustomerAlgorithm,")
append("sseCustomerKey=*** Sensitive Data Redacted ***,")
append("sseCustomerKeyMd5=$sseCustomerKeyMd5,")
append("ssekmsEncryptionContext=*** Sensitive Data Redacted ***,")
append("ssekmsKeyId=*** Sensitive Data Redacted ***,")
append("storageClass=$storageClass,")
append("tagging=$tagging,")
append("websiteRedirectLocation=$websiteRedirectLocation")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = acl?.hashCode() ?: 0
result = 31 * result + (body?.hashCode() ?: 0)
result = 31 * result + (bucket?.hashCode() ?: 0)
result = 31 * result + (bucketKeyEnabled?.hashCode() ?: 0)
result = 31 * result + (cacheControl?.hashCode() ?: 0)
result = 31 * result + (checksumAlgorithm?.hashCode() ?: 0)
result = 31 * result + (checksumCrc32?.hashCode() ?: 0)
result = 31 * result + (checksumCrc32C?.hashCode() ?: 0)
result = 31 * result + (checksumSha1?.hashCode() ?: 0)
result = 31 * result + (checksumSha256?.hashCode() ?: 0)
result = 31 * result + (contentDisposition?.hashCode() ?: 0)
result = 31 * result + (contentEncoding?.hashCode() ?: 0)
result = 31 * result + (contentLanguage?.hashCode() ?: 0)
result = 31 * result + (contentLength?.hashCode() ?: 0)
result = 31 * result + (contentMd5?.hashCode() ?: 0)
result = 31 * result + (contentType?.hashCode() ?: 0)
result = 31 * result + (expectedBucketOwner?.hashCode() ?: 0)
result = 31 * result + (expires?.hashCode() ?: 0)
result = 31 * result + (grantFullControl?.hashCode() ?: 0)
result = 31 * result + (grantRead?.hashCode() ?: 0)
result = 31 * result + (grantReadAcp?.hashCode() ?: 0)
result = 31 * result + (grantWriteAcp?.hashCode() ?: 0)
result = 31 * result + (key?.hashCode() ?: 0)
result = 31 * result + (metadata?.hashCode() ?: 0)
result = 31 * result + (objectLockLegalHoldStatus?.hashCode() ?: 0)
result = 31 * result + (objectLockMode?.hashCode() ?: 0)
result = 31 * result + (objectLockRetainUntilDate?.hashCode() ?: 0)
result = 31 * result + (requestPayer?.hashCode() ?: 0)
result = 31 * result + (serverSideEncryption?.hashCode() ?: 0)
result = 31 * result + (sseCustomerAlgorithm?.hashCode() ?: 0)
result = 31 * result + (sseCustomerKey?.hashCode() ?: 0)
result = 31 * result + (sseCustomerKeyMd5?.hashCode() ?: 0)
result = 31 * result + (ssekmsEncryptionContext?.hashCode() ?: 0)
result = 31 * result + (ssekmsKeyId?.hashCode() ?: 0)
result = 31 * result + (storageClass?.hashCode() ?: 0)
result = 31 * result + (tagging?.hashCode() ?: 0)
result = 31 * result + (websiteRedirectLocation?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as PutObjectRequest
if (acl != other.acl) return false
if (body != other.body) return false
if (bucket != other.bucket) return false
if (bucketKeyEnabled != other.bucketKeyEnabled) return false
if (cacheControl != other.cacheControl) return false
if (checksumAlgorithm != other.checksumAlgorithm) return false
if (checksumCrc32 != other.checksumCrc32) return false
if (checksumCrc32C != other.checksumCrc32C) return false
if (checksumSha1 != other.checksumSha1) return false
if (checksumSha256 != other.checksumSha256) return false
if (contentDisposition != other.contentDisposition) return false
if (contentEncoding != other.contentEncoding) return false
if (contentLanguage != other.contentLanguage) return false
if (contentLength != other.contentLength) return false
if (contentMd5 != other.contentMd5) return false
if (contentType != other.contentType) return false
if (expectedBucketOwner != other.expectedBucketOwner) return false
if (expires != other.expires) return false
if (grantFullControl != other.grantFullControl) return false
if (grantRead != other.grantRead) return false
if (grantReadAcp != other.grantReadAcp) return false
if (grantWriteAcp != other.grantWriteAcp) return false
if (key != other.key) return false
if (metadata != other.metadata) return false
if (objectLockLegalHoldStatus != other.objectLockLegalHoldStatus) return false
if (objectLockMode != other.objectLockMode) return false
if (objectLockRetainUntilDate != other.objectLockRetainUntilDate) return false
if (requestPayer != other.requestPayer) return false
if (serverSideEncryption != other.serverSideEncryption) return false
if (sseCustomerAlgorithm != other.sseCustomerAlgorithm) return false
if (sseCustomerKey != other.sseCustomerKey) return false
if (sseCustomerKeyMd5 != other.sseCustomerKeyMd5) return false
if (ssekmsEncryptionContext != other.ssekmsEncryptionContext) return false
if (ssekmsKeyId != other.ssekmsKeyId) return false
if (storageClass != other.storageClass) return false
if (tagging != other.tagging) return false
if (websiteRedirectLocation != other.websiteRedirectLocation) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.s3.model.PutObjectRequest = Builder(this).apply(block).build()
public class Builder {
/**
* The canned ACL to apply to the object. For more information, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL) in the *Amazon S3 User Guide*.
*
* When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see [Access Control List (ACL) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and [Managing ACLs Using the REST API](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html) in the *Amazon S3 User Guide*.
*
* If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the `bucket-owner-full-control` canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a `400` error with the error code `AccessControlListNotSupported`. For more information, see [ Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public var acl: aws.sdk.kotlin.services.s3.model.ObjectCannedAcl? = null
/**
* Object data.
*/
public var body: aws.smithy.kotlin.runtime.content.ByteStream? = null
/**
* The bucket name to which the PUT action was initiated.
*
* **Directory buckets** - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format ` Bucket_name.s3express-az_id.region.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format ` bucket_base_name--az-id--x-s3` (for example, ` DOC-EXAMPLE-BUCKET--usw2-az2--x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html) in the *Amazon S3 User Guide*.
*
* **Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) in the *Amazon S3 User Guide*.
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
* **S3 on Outposts** - When you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see [What is S3 on Outposts?](https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the *Amazon S3 User Guide*.
*/
public var bucket: kotlin.String? = null
/**
* Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (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.
*
* This functionality is not supported for directory buckets.
*/
public var bucketKeyEnabled: kotlin.Boolean? = null
/**
* Can be used to specify caching behavior along the request/reply chain. For more information, see [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9).
*/
public var cacheControl: kotlin.String? = null
/**
* Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding `x-amz-checksum-algorithm ` or `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request with the HTTP status code `400 Bad Request`.
*
* For the `x-amz-checksum-algorithm ` header, replace ` algorithm ` with the supported algorithm from the following list:
* + CRC32
* + CRC32C
* + SHA1
* + SHA256
*
* For more information, see [Checking object integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*
* If the individual checksum value you provide through `x-amz-checksum-algorithm ` doesn't match the checksum algorithm you set through `x-amz-sdk-checksum-algorithm`, Amazon S3 ignores any provided `ChecksumAlgorithm` parameter and uses the checksum algorithm that matches the provided value in `x-amz-checksum-algorithm `.
*
* For directory buckets, when you use Amazon Web Services SDKs, `CRC32` is the default checksum algorithm that's used for performance.
*/
public var checksumAlgorithm: aws.sdk.kotlin.services.s3.model.ChecksumAlgorithm? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public var checksumCrc32: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public var checksumCrc32C: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public var checksumSha1: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) in the *Amazon S3 User Guide*.
*/
public var checksumSha256: kotlin.String? = null
/**
* Specifies presentational information for the object. For more information, see [https://www.rfc-editor.org/rfc/rfc6266#section-4](https://www.rfc-editor.org/rfc/rfc6266#section-4).
*/
public var contentDisposition: kotlin.String? = null
/**
* 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 [https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding).
*/
public var contentEncoding: kotlin.String? = null
/**
* The language the content is in.
*/
public var contentLanguage: kotlin.String? = null
/**
* Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length](https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length).
*/
public var contentLength: kotlin.Long? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).
*
* The `Content-MD5` header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see [Amazon S3 Object Lock Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public var contentMd5: kotlin.String? = null
/**
* A standard MIME type describing the format of the contents. For more information, see [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type](https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type).
*/
public var contentType: kotlin.String? = null
/**
* The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code `403 Forbidden` (access denied).
*/
public var expectedBucketOwner: kotlin.String? = null
/**
* The date and time at which the object is no longer cacheable. For more information, see [https://www.rfc-editor.org/rfc/rfc7234#section-5.3](https://www.rfc-editor.org/rfc/rfc7234#section-5.3).
*/
public var expires: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantFullControl: kotlin.String? = null
/**
* Allows grantee to read the object data and its metadata.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantRead: kotlin.String? = null
/**
* Allows grantee to read the object ACL.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantReadAcp: kotlin.String? = null
/**
* Allows grantee to write the ACL for the applicable object.
*
* + This functionality is not supported for directory buckets.
* + This functionality is not supported for Amazon S3 on Outposts.
*/
public var grantWriteAcp: kotlin.String? = null
/**
* Object key for which the PUT action was initiated.
*/
public var key: kotlin.String? = null
/**
* A map of metadata to store with the object in S3.
*/
public var metadata: Map? = null
/**
* Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see [Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public var objectLockLegalHoldStatus: aws.sdk.kotlin.services.s3.model.ObjectLockLegalHoldStatus? = null
/**
* The Object Lock mode that you want to apply to this object.
*
* This functionality is not supported for directory buckets.
*/
public var objectLockMode: aws.sdk.kotlin.services.s3.model.ObjectLockMode? = null
/**
* The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
*
* This functionality is not supported for directory buckets.
*/
public var objectLockRetainUntilDate: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public var requestPayer: aws.sdk.kotlin.services.s3.model.RequestPayer? = null
/**
* The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
*
* **General purpose buckets ** - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see [Using Server-Side Encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Amazon S3 User Guide*.
*
* **Directory buckets ** - For directory buckets, only the server-side encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) value is supported.
*/
public var serverSideEncryption: aws.sdk.kotlin.services.s3.model.ServerSideEncryption? = null
/**
* Specifies the algorithm to use when encrypting the object (for example, `AES256`).
*
* This functionality is not supported for directory buckets.
*/
public var sseCustomerAlgorithm: kotlin.String? = null
/**
* 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.
*
* This functionality is not supported for directory buckets.
*/
public var sseCustomerKey: kotlin.String? = null
/**
* 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.
*
* This functionality is not supported for directory buckets.
*/
public var sseCustomerKeyMd5: kotlin.String? = null
/**
* 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. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future `GetObject` or `CopyObject` operations on this object. This value must be explicitly added during `CopyObject` operations.
*
* This functionality is not supported for directory buckets.
*/
public var ssekmsEncryptionContext: kotlin.String? = null
/**
* If `x-amz-server-side-encryption` has a valid value of `aws:kms` or `aws:kms:dsse`, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object. If you specify `x-amz-server-side-encryption:aws:kms` or `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide` x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the Amazon Web Services managed key (`aws/s3`) to protect the data. If the KMS key does not exist in the same account that's issuing the command, you must use the full ARN and not just the ID.
*
* This functionality is not supported for directory buckets.
*/
public var ssekmsKeyId: kotlin.String? = null
/**
* 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. For more information, see [Storage Classes](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in the *Amazon S3 User Guide*.
*
* + For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
* + Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*/
public var storageClass: aws.sdk.kotlin.services.s3.model.StorageClass? = null
/**
* The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
*
* This functionality is not supported for directory buckets.
*/
public var tagging: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html) in the *Amazon S3 User Guide*.
*
* 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: http://www.example.com/`
*
* For more information about website hosting in Amazon S3, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) and [How to Configure Website Page Redirects](https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html) in the *Amazon S3 User Guide*.
*
* This functionality is not supported for directory buckets.
*/
public var websiteRedirectLocation: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.s3.model.PutObjectRequest) : this() {
this.acl = x.acl
this.body = x.body
this.bucket = x.bucket
this.bucketKeyEnabled = x.bucketKeyEnabled
this.cacheControl = x.cacheControl
this.checksumAlgorithm = x.checksumAlgorithm
this.checksumCrc32 = x.checksumCrc32
this.checksumCrc32C = x.checksumCrc32C
this.checksumSha1 = x.checksumSha1
this.checksumSha256 = x.checksumSha256
this.contentDisposition = x.contentDisposition
this.contentEncoding = x.contentEncoding
this.contentLanguage = x.contentLanguage
this.contentLength = x.contentLength
this.contentMd5 = x.contentMd5
this.contentType = x.contentType
this.expectedBucketOwner = x.expectedBucketOwner
this.expires = x.expires
this.grantFullControl = x.grantFullControl
this.grantRead = x.grantRead
this.grantReadAcp = x.grantReadAcp
this.grantWriteAcp = x.grantWriteAcp
this.key = x.key
this.metadata = x.metadata
this.objectLockLegalHoldStatus = x.objectLockLegalHoldStatus
this.objectLockMode = x.objectLockMode
this.objectLockRetainUntilDate = x.objectLockRetainUntilDate
this.requestPayer = x.requestPayer
this.serverSideEncryption = x.serverSideEncryption
this.sseCustomerAlgorithm = x.sseCustomerAlgorithm
this.sseCustomerKey = x.sseCustomerKey
this.sseCustomerKeyMd5 = x.sseCustomerKeyMd5
this.ssekmsEncryptionContext = x.ssekmsEncryptionContext
this.ssekmsKeyId = x.ssekmsKeyId
this.storageClass = x.storageClass
this.tagging = x.tagging
this.websiteRedirectLocation = x.websiteRedirectLocation
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.s3.model.PutObjectRequest = PutObjectRequest(this)
internal fun correctErrors(): Builder {
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy