Package com.pulumi.aws.s3

Class ObjectCopyArgs

  • public final class ObjectCopyArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ObjectCopyArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> acl()  
      com.pulumi.core.Output<java.lang.String> bucket()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> bucketKeyEnabled()  
      static ObjectCopyArgs.Builder builder()  
      static ObjectCopyArgs.Builder builder​(ObjectCopyArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> cacheControl()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> checksumAlgorithm()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> contentDisposition()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> contentEncoding()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> contentLanguage()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> contentType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> copyIfMatch()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> copyIfModifiedSince()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> copyIfNoneMatch()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> copyIfUnmodifiedSince()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> customerAlgorithm()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> customerKey()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> customerKeyMd5()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> expectedBucketOwner()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> expectedSourceBucketOwner()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> expires()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDestroy()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<ObjectCopyGrantArgs>>> grants()  
      com.pulumi.core.Output<java.lang.String> key()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsEncryptionContext()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> metadata()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> metadataDirective()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> objectLockLegalHoldStatus()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> objectLockMode()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> objectLockRetainUntilDate()  
      java.util.Optional<com.pulumi.core.Output<ObjectCopyOverrideProviderArgs>> overrideProvider()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> requestPayer()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> serverSideEncryption()  
      com.pulumi.core.Output<java.lang.String> source()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceCustomerAlgorithm()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceCustomerKey()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceCustomerKeyMd5()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> storageClass()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> taggingDirective()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> websiteRedirect()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • acl

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> acl()
        Returns:
        [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Valid values are `private`, `public-read`, `public-read-write`, `authenticated-read`, `aws-exec-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Conflicts with `grant`.

      • bucket

        public com.pulumi.core.Output<java.lang.String> bucket()
        Returns:
        Name of the bucket to put the file in.

      • bucketKeyEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> bucketKeyEnabled()
        Returns:
        Whether to use an S3 Bucket Key for object encryption with server-side encryption using KMS (SSE-KMS).

      • cacheControl

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> cacheControl()
        Returns:
        Caching behavior along the request/reply chain. Read [w3c cacheControl](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) for further details.

      • checksumAlgorithm

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> checksumAlgorithm()
        Returns:
        Algorithm used to create the checksum for the object. If a value is specified and the object is encrypted with KMS, you must have permission to use the `kms:Decrypt` action. Valid values: `CRC32`, `CRC32C`, `CRC64NVME` `SHA1`, `SHA256`.

      • contentDisposition

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> contentDisposition()
        Returns:
        Presentational information for the object. Read [w3c contentDisposition](http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1) for further information.

      • contentEncoding

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> contentEncoding()
        Returns:
        Content encodings that 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. Read [w3c content encoding](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11) for further information.

      • contentLanguage

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> contentLanguage()
        Returns:
        Language the content is in e.g., en-US or en-GB.

      • contentType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> contentType()
        Returns:
        Standard MIME type describing the format of the object data, e.g., `application/octet-stream`. All Valid MIME Types are valid for this input.

      • copyIfMatch

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> copyIfMatch()
        Returns:
        Copies the object if its entity tag (ETag) matches the specified tag.

      • copyIfModifiedSince

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> copyIfModifiedSince()
        Returns:
        Copies the object if it has been modified since the specified time, in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).

      • copyIfNoneMatch

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> copyIfNoneMatch()
        Returns:
        Copies the object if its entity tag (ETag) is different than the specified ETag.

      • copyIfUnmodifiedSince

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> copyIfUnmodifiedSince()
        Returns:
        Copies the object if it hasn't been modified since the specified time, in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).

      • customerAlgorithm

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> customerAlgorithm()
        Returns:
        Algorithm to use when encrypting the object (for example, AES256).

      • customerKey

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> customerKey()
        Returns:
        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.

      • customerKeyMd5

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> customerKeyMd5()
        Returns:
        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.

      • expectedBucketOwner

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> expectedBucketOwner()
        Returns:
        Account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

      • expectedSourceBucketOwner

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> expectedSourceBucketOwner()
        Returns:
        Account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

      • expires

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> expires()
        Returns:
        Date and time at which the object is no longer cacheable, in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).

      • forceDestroy

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDestroy()
        Returns:
        Allow the object to be deleted by removing any legal hold on any object version. Default is `false`. This value should be set to `true` only if the bucket has S3 object lock enabled.

      • grants

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ObjectCopyGrantArgs>>> grants()
        Returns:
        Configuration block for header grants. Documented below. Conflicts with `acl`.

      • key

        public com.pulumi.core.Output<java.lang.String> key()
        Returns:
        Name of the object once it is in the bucket.

      • kmsEncryptionContext

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsEncryptionContext()
        Returns:
        AWS KMS Encryption Context to use for object encryption. The value is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

      • kmsKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
        Returns:
        AWS KMS Key ARN to use for object encryption. This value is a fully qualified **ARN** of the KMS Key. If using `aws.kms.Key`, use the exported `arn` attribute: `kmsKeyId = aws_kms_key.foo.arn`

      • metadata

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> metadata()
        Returns:
        Map of keys/values to provision metadata (will be automatically prefixed by `x-amz-meta-`, note that only lowercase label are currently supported by the AWS Go API).

      • metadataDirective

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> metadataDirective()
        Returns:
        Whether the metadata is copied from the source object or replaced with metadata provided in the request. Valid values are `COPY` and `REPLACE`.

      • objectLockLegalHoldStatus

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> objectLockLegalHoldStatus()
        Returns:
        [Legal hold](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-legal-holds) status to apply to the specified object. Valid values are `ON` and `OFF`.

      • objectLockMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> objectLockMode()
        Returns:
        Object lock [retention mode](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-retention-modes) that you want to apply to this object. Valid values are `GOVERNANCE` and `COMPLIANCE`.

      • objectLockRetainUntilDate

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> objectLockRetainUntilDate()
        Returns:
        Date and time, in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8), when this object's object lock will [expire](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-retention-periods).

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • requestPayer

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> requestPayer()
        Returns:
        Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html) in the Amazon S3 Developer Guide. If included, the only valid value is `requester`.

      • serverSideEncryption

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> serverSideEncryption()
        Returns:
        Server-side encryption of the object in S3. Valid values are `AES256` and `aws:kms`.

      • source

        public com.pulumi.core.Output<java.lang.String> source()
        Returns:
        Source object for the copy operation. You specify the value in one of two formats. For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (`/`). For example, `testbucket/test1.json`. For objects accessed through access points, specify the ARN of the object as accessed through the access point, in the format `arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>`. For example, `arn:aws:s3:us-west-2:9999912999:accesspoint/my-access-point/object/testbucket/test1.json`. The following arguments are optional:

      • sourceCustomerAlgorithm

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceCustomerAlgorithm()
        Returns:
        Algorithm to use when decrypting the source object (for example, AES256).

      • sourceCustomerKey

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceCustomerKey()
        Returns:
        Customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

      • sourceCustomerKeyMd5

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceCustomerKeyMd5()
        Returns:
        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.

      • storageClass

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> storageClass()
        Returns:
        Desired [storage class](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html#AmazonS3-CopyObject-request-header-StorageClass) for the object. Defaults to `STANDARD`.

      • taggingDirective

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> taggingDirective()
        Returns:
        Whether the object tag-set is copied from the source object or replaced with tag-set provided in the request. Valid values are `COPY` and `REPLACE`.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the object. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • websiteRedirect

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> websiteRedirect()
        Returns:
        Target URL for [website redirect](http://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html).