|null */ private $metadata; /** * The server-side encryption algorithm used when storing this object in Amazon S3 (for example, `AES256`, `aws:kms`). * * @var ServerSideEncryption::*|null */ private $serverSideEncryption; /** * 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 [^1] in * the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html * * @var StorageClass::*|null */ private $storageClass; /** * 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. * * @var string|null */ private $websiteRedirectLocation; /** * Specifies the algorithm to use to when encrypting the object (for example, AES256). * * @var string|null */ private $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. * * @var string|null */ private $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. * * @var string|null */ private $sseCustomerKeyMd5; /** * Specifies the ID of the symmetric encryption customer managed key to use for object encryption. All GET and PUT * requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about * configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the * Signature Version in Request Authentication [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version * * @var string|null */ private $sseKmsKeyId; /** * 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. * * @var string|null */ private $sseKmsEncryptionContext; /** * 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 an object action doesn’t affect bucket-level settings for S3 Bucket Key. * * @var bool|null */ private $bucketKeyEnabled; /** * @var RequestPayer::*|null */ private $requestPayer; /** * The tag-set for the object. The tag-set must be encoded as URL Query parameters. * * @var string|null */ private $tagging; /** * Specifies the Object Lock mode that you want to apply to the uploaded object. * * @var ObjectLockMode::*|null */ private $objectLockMode; /** * Specifies the date and time when you want the Object Lock to expire. * * @var \DateTimeImmutable|null */ private $objectLockRetainUntilDate; /** * Specifies whether you want to apply a legal hold to the uploaded object. * * @var ObjectLockLegalHoldStatus::*|null */ private $objectLockLegalHoldStatus; /** * The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with * the HTTP status code `403 Forbidden` (access denied). * * @var string|null */ private $expectedBucketOwner; /** * Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see * Checking object integrity [^1] in the *Amazon S3 User Guide*. * * [^1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html * * @var ChecksumAlgorithm::*|null */ private $checksumAlgorithm; /** * @param array{ * ACL?: ObjectCannedACL::*, * Bucket?: string, * CacheControl?: string, * ContentDisposition?: string, * ContentEncoding?: string, * ContentLanguage?: string, * ContentType?: string, * Expires?: \DateTimeImmutable|string, * GrantFullControl?: string, * GrantRead?: string, * GrantReadACP?: string, * GrantWriteACP?: string, * Key?: string, * Metadata?: array, * ServerSideEncryption?: ServerSideEncryption::*, * StorageClass?: StorageClass::*, * WebsiteRedirectLocation?: string, * SSECustomerAlgorithm?: string, * SSECustomerKey?: string, * SSECustomerKeyMD5?: string, * SSEKMSKeyId?: string, * SSEKMSEncryptionContext?: string, * BucketKeyEnabled?: bool, * RequestPayer?: RequestPayer::*, * Tagging?: string, * ObjectLockMode?: ObjectLockMode::*, * ObjectLockRetainUntilDate?: \DateTimeImmutable|string, * ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus::*, * ExpectedBucketOwner?: string, * ChecksumAlgorithm?: ChecksumAlgorithm::*, * * @region?: string, * } $input */ public function __construct(array $input = []) { $this->acl = $input['ACL'] ?? null; $this->bucket = $input['Bucket'] ?? null; $this->cacheControl = $input['CacheControl'] ?? null; $this->contentDisposition = $input['ContentDisposition'] ?? null; $this->contentEncoding = $input['ContentEncoding'] ?? null; $this->contentLanguage = $input['ContentLanguage'] ?? null; $this->contentType = $input['ContentType'] ?? null; $this->expires = !isset($input['Expires']) ? null : ($input['Expires'] instanceof \DateTimeImmutable ? $input['Expires'] : new \DateTimeImmutable($input['Expires'])); $this->grantFullControl = $input['GrantFullControl'] ?? null; $this->grantRead = $input['GrantRead'] ?? null; $this->grantReadAcp = $input['GrantReadACP'] ?? null; $this->grantWriteAcp = $input['GrantWriteACP'] ?? null; $this->key = $input['Key'] ?? null; $this->metadata = $input['Metadata'] ?? null; $this->serverSideEncryption = $input['ServerSideEncryption'] ?? null; $this->storageClass = $input['StorageClass'] ?? null; $this->websiteRedirectLocation = $input['WebsiteRedirectLocation'] ?? null; $this->sseCustomerAlgorithm = $input['SSECustomerAlgorithm'] ?? null; $this->sseCustomerKey = $input['SSECustomerKey'] ?? null; $this->sseCustomerKeyMd5 = $input['SSECustomerKeyMD5'] ?? null; $this->sseKmsKeyId = $input['SSEKMSKeyId'] ?? null; $this->sseKmsEncryptionContext = $input['SSEKMSEncryptionContext'] ?? null; $this->bucketKeyEnabled = $input['BucketKeyEnabled'] ?? null; $this->requestPayer = $input['RequestPayer'] ?? null; $this->tagging = $input['Tagging'] ?? null; $this->objectLockMode = $input['ObjectLockMode'] ?? null; $this->objectLockRetainUntilDate = !isset($input['ObjectLockRetainUntilDate']) ? null : ($input['ObjectLockRetainUntilDate'] instanceof \DateTimeImmutable ? $input['ObjectLockRetainUntilDate'] : new \DateTimeImmutable($input['ObjectLockRetainUntilDate'])); $this->objectLockLegalHoldStatus = $input['ObjectLockLegalHoldStatus'] ?? null; $this->expectedBucketOwner = $input['ExpectedBucketOwner'] ?? null; $this->checksumAlgorithm = $input['ChecksumAlgorithm'] ?? null; parent::__construct($input); } public static function create($input): self { return $input instanceof self ? $input : new self($input); } /** * @return ObjectCannedACL::*|null */ public function getAcl(): ?string { return $this->acl; } public function getBucket(): ?string { return $this->bucket; } public function getBucketKeyEnabled(): ?bool { return $this->bucketKeyEnabled; } public function getCacheControl(): ?string { return $this->cacheControl; } /** * @return ChecksumAlgorithm::*|null */ public function getChecksumAlgorithm(): ?string { return $this->checksumAlgorithm; } public function getContentDisposition(): ?string { return $this->contentDisposition; } public function getContentEncoding(): ?string { return $this->contentEncoding; } public function getContentLanguage(): ?string { return $this->contentLanguage; } public function getContentType(): ?string { return $this->contentType; } public function getExpectedBucketOwner(): ?string { return $this->expectedBucketOwner; } public function getExpires(): ?\DateTimeImmutable { return $this->expires; } public function getGrantFullControl(): ?string { return $this->grantFullControl; } public function getGrantRead(): ?string { return $this->grantRead; } public function getGrantReadAcp(): ?string { return $this->grantReadAcp; } public function getGrantWriteAcp(): ?string { return $this->grantWriteAcp; } public function getKey(): ?string { return $this->key; } /** * @return array */ public function getMetadata(): array { return $this->metadata ?? []; } /** * @return ObjectLockLegalHoldStatus::*|null */ public function getObjectLockLegalHoldStatus(): ?string { return $this->objectLockLegalHoldStatus; } /** * @return ObjectLockMode::*|null */ public function getObjectLockMode(): ?string { return $this->objectLockMode; } public function getObjectLockRetainUntilDate(): ?\DateTimeImmutable { return $this->objectLockRetainUntilDate; } /** * @return RequestPayer::*|null */ public function getRequestPayer(): ?string { return $this->requestPayer; } /** * @return ServerSideEncryption::*|null */ public function getServerSideEncryption(): ?string { return $this->serverSideEncryption; } public function getSseCustomerAlgorithm(): ?string { return $this->sseCustomerAlgorithm; } public function getSseCustomerKey(): ?string { return $this->sseCustomerKey; } public function getSseCustomerKeyMd5(): ?string { return $this->sseCustomerKeyMd5; } public function getSseKmsEncryptionContext(): ?string { return $this->sseKmsEncryptionContext; } public function getSseKmsKeyId(): ?string { return $this->sseKmsKeyId; } /** * @return StorageClass::*|null */ public function getStorageClass(): ?string { return $this->storageClass; } public function getTagging(): ?string { return $this->tagging; } public function getWebsiteRedirectLocation(): ?string { return $this->websiteRedirectLocation; } /** * @internal */ public function request(): Request { // Prepare headers $headers = ['content-type' => 'application/xml']; if (null !== $this->acl) { if (!ObjectCannedACL::exists($this->acl)) { throw new InvalidArgument(sprintf('Invalid parameter "ACL" for "%s". The value "%s" is not a valid "ObjectCannedACL".', __CLASS__, $this->acl)); } $headers['x-amz-acl'] = $this->acl; } if (null !== $this->cacheControl) { $headers['Cache-Control'] = $this->cacheControl; } if (null !== $this->contentDisposition) { $headers['Content-Disposition'] = $this->contentDisposition; } if (null !== $this->contentEncoding) { $headers['Content-Encoding'] = $this->contentEncoding; } if (null !== $this->contentLanguage) { $headers['Content-Language'] = $this->contentLanguage; } if (null !== $this->contentType) { $headers['Content-Type'] = $this->contentType; } if (null !== $this->expires) { $headers['Expires'] = $this->expires->setTimezone(new \DateTimeZone('GMT'))->format(\DateTimeInterface::RFC7231); } if (null !== $this->grantFullControl) { $headers['x-amz-grant-full-control'] = $this->grantFullControl; } if (null !== $this->grantRead) { $headers['x-amz-grant-read'] = $this->grantRead; } if (null !== $this->grantReadAcp) { $headers['x-amz-grant-read-acp'] = $this->grantReadAcp; } if (null !== $this->grantWriteAcp) { $headers['x-amz-grant-write-acp'] = $this->grantWriteAcp; } if (null !== $this->serverSideEncryption) { if (!ServerSideEncryption::exists($this->serverSideEncryption)) { throw new InvalidArgument(sprintf('Invalid parameter "ServerSideEncryption" for "%s". The value "%s" is not a valid "ServerSideEncryption".', __CLASS__, $this->serverSideEncryption)); } $headers['x-amz-server-side-encryption'] = $this->serverSideEncryption; } if (null !== $this->storageClass) { if (!StorageClass::exists($this->storageClass)) { throw new InvalidArgument(sprintf('Invalid parameter "StorageClass" for "%s". The value "%s" is not a valid "StorageClass".', __CLASS__, $this->storageClass)); } $headers['x-amz-storage-class'] = $this->storageClass; } if (null !== $this->websiteRedirectLocation) { $headers['x-amz-website-redirect-location'] = $this->websiteRedirectLocation; } if (null !== $this->sseCustomerAlgorithm) { $headers['x-amz-server-side-encryption-customer-algorithm'] = $this->sseCustomerAlgorithm; } if (null !== $this->sseCustomerKey) { $headers['x-amz-server-side-encryption-customer-key'] = $this->sseCustomerKey; } if (null !== $this->sseCustomerKeyMd5) { $headers['x-amz-server-side-encryption-customer-key-MD5'] = $this->sseCustomerKeyMd5; } if (null !== $this->sseKmsKeyId) { $headers['x-amz-server-side-encryption-aws-kms-key-id'] = $this->sseKmsKeyId; } if (null !== $this->sseKmsEncryptionContext) { $headers['x-amz-server-side-encryption-context'] = $this->sseKmsEncryptionContext; } if (null !== $this->bucketKeyEnabled) { $headers['x-amz-server-side-encryption-bucket-key-enabled'] = $this->bucketKeyEnabled ? 'true' : 'false'; } if (null !== $this->requestPayer) { if (!RequestPayer::exists($this->requestPayer)) { throw new InvalidArgument(sprintf('Invalid parameter "RequestPayer" for "%s". The value "%s" is not a valid "RequestPayer".', __CLASS__, $this->requestPayer)); } $headers['x-amz-request-payer'] = $this->requestPayer; } if (null !== $this->tagging) { $headers['x-amz-tagging'] = $this->tagging; } if (null !== $this->objectLockMode) { if (!ObjectLockMode::exists($this->objectLockMode)) { throw new InvalidArgument(sprintf('Invalid parameter "ObjectLockMode" for "%s". The value "%s" is not a valid "ObjectLockMode".', __CLASS__, $this->objectLockMode)); } $headers['x-amz-object-lock-mode'] = $this->objectLockMode; } if (null !== $this->objectLockRetainUntilDate) { $headers['x-amz-object-lock-retain-until-date'] = $this->objectLockRetainUntilDate->format(\DateTimeInterface::ISO8601); } if (null !== $this->objectLockLegalHoldStatus) { if (!ObjectLockLegalHoldStatus::exists($this->objectLockLegalHoldStatus)) { throw new InvalidArgument(sprintf('Invalid parameter "ObjectLockLegalHoldStatus" for "%s". The value "%s" is not a valid "ObjectLockLegalHoldStatus".', __CLASS__, $this->objectLockLegalHoldStatus)); } $headers['x-amz-object-lock-legal-hold'] = $this->objectLockLegalHoldStatus; } if (null !== $this->expectedBucketOwner) { $headers['x-amz-expected-bucket-owner'] = $this->expectedBucketOwner; } if (null !== $this->checksumAlgorithm) { if (!ChecksumAlgorithm::exists($this->checksumAlgorithm)) { throw new InvalidArgument(sprintf('Invalid parameter "ChecksumAlgorithm" for "%s". The value "%s" is not a valid "ChecksumAlgorithm".', __CLASS__, $this->checksumAlgorithm)); } $headers['x-amz-checksum-algorithm'] = $this->checksumAlgorithm; } if (null !== $this->metadata) { foreach ($this->metadata as $key => $value) { $headers["x-amz-meta-$key"] = $value; } } // Prepare query $query = []; // Prepare URI $uri = []; if (null === $v = $this->bucket) { throw new InvalidArgument(sprintf('Missing parameter "Bucket" for "%s". The value cannot be null.', __CLASS__)); } $uri['Bucket'] = $v; if (null === $v = $this->key) { throw new InvalidArgument(sprintf('Missing parameter "Key" for "%s". The value cannot be null.', __CLASS__)); } $uri['Key'] = $v; $uriString = '/' . rawurlencode($uri['Bucket']) . '/' . str_replace('%2F', '/', rawurlencode($uri['Key'])) . '?uploads'; // Prepare Body $body = ''; // Return the Request return new Request('POST', $uriString, $query, $headers, StreamFactory::create($body)); } /** * @param ObjectCannedACL::*|null $value */ public function setAcl(?string $value): self { $this->acl = $value; return $this; } public function setBucket(?string $value): self { $this->bucket = $value; return $this; } public function setBucketKeyEnabled(?bool $value): self { $this->bucketKeyEnabled = $value; return $this; } public function setCacheControl(?string $value): self { $this->cacheControl = $value; return $this; } /** * @param ChecksumAlgorithm::*|null $value */ public function setChecksumAlgorithm(?string $value): self { $this->checksumAlgorithm = $value; return $this; } public function setContentDisposition(?string $value): self { $this->contentDisposition = $value; return $this; } public function setContentEncoding(?string $value): self { $this->contentEncoding = $value; return $this; } public function setContentLanguage(?string $value): self { $this->contentLanguage = $value; return $this; } public function setContentType(?string $value): self { $this->contentType = $value; return $this; } public function setExpectedBucketOwner(?string $value): self { $this->expectedBucketOwner = $value; return $this; } public function setExpires(?\DateTimeImmutable $value): self { $this->expires = $value; return $this; } public function setGrantFullControl(?string $value): self { $this->grantFullControl = $value; return $this; } public function setGrantRead(?string $value): self { $this->grantRead = $value; return $this; } public function setGrantReadAcp(?string $value): self { $this->grantReadAcp = $value; return $this; } public function setGrantWriteAcp(?string $value): self { $this->grantWriteAcp = $value; return $this; } public function setKey(?string $value): self { $this->key = $value; return $this; } /** * @param array $value */ public function setMetadata(array $value): self { $this->metadata = $value; return $this; } /** * @param ObjectLockLegalHoldStatus::*|null $value */ public function setObjectLockLegalHoldStatus(?string $value): self { $this->objectLockLegalHoldStatus = $value; return $this; } /** * @param ObjectLockMode::*|null $value */ public function setObjectLockMode(?string $value): self { $this->objectLockMode = $value; return $this; } public function setObjectLockRetainUntilDate(?\DateTimeImmutable $value): self { $this->objectLockRetainUntilDate = $value; return $this; } /** * @param RequestPayer::*|null $value */ public function setRequestPayer(?string $value): self { $this->requestPayer = $value; return $this; } /** * @param ServerSideEncryption::*|null $value */ public function setServerSideEncryption(?string $value): self { $this->serverSideEncryption = $value; return $this; } public function setSseCustomerAlgorithm(?string $value): self { $this->sseCustomerAlgorithm = $value; return $this; } public function setSseCustomerKey(?string $value): self { $this->sseCustomerKey = $value; return $this; } public function setSseCustomerKeyMd5(?string $value): self { $this->sseCustomerKeyMd5 = $value; return $this; } public function setSseKmsEncryptionContext(?string $value): self { $this->sseKmsEncryptionContext = $value; return $this; } public function setSseKmsKeyId(?string $value): self { $this->sseKmsKeyId = $value; return $this; } /** * @param StorageClass::*|null $value */ public function setStorageClass(?string $value): self { $this->storageClass = $value; return $this; } public function setTagging(?string $value): self { $this->tagging = $value; return $this; } public function setWebsiteRedirectLocation(?string $value): self { $this->websiteRedirectLocation = $value; return $this; } }