Package com.pulumi.aws.s3

Class BucketObjectArgs.Builder

  • Enclosing class:
    BucketObjectArgs
    public static final class BucketObjectArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • acl

        public BucketObjectArgs.Builder acl​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> acl)
        Parameters:
        acl - [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`, `aws-exec-read`, `authenticated-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Defaults to `private`.
        Returns:
        builder

      • acl

        public BucketObjectArgs.Builder acl​(java.lang.String acl)
        Parameters:
        acl - [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`, `aws-exec-read`, `authenticated-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Defaults to `private`.
        Returns:
        builder

      • bucket

        public BucketObjectArgs.Builder bucket​(com.pulumi.core.Output<java.lang.String> bucket)
        Parameters:
        bucket - Name of the bucket to put the file in. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified. Use the `aws.s3.BucketObjectv2` resource instead.
        Returns:
        builder

      • bucket

        public BucketObjectArgs.Builder bucket​(java.lang.String bucket)
        Parameters:
        bucket - Name of the bucket to put the file in. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified. Use the `aws.s3.BucketObjectv2` resource instead.
        Returns:
        builder

      • bucketKeyEnabled

        public BucketObjectArgs.Builder bucketKeyEnabled​(@Nullable
                                                 com.pulumi.core.Output<java.lang.Boolean> bucketKeyEnabled)
        Parameters:
        bucketKeyEnabled - Whether or not to use [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) for SSE-KMS.
        Returns:
        builder

      • bucketKeyEnabled

        public BucketObjectArgs.Builder bucketKeyEnabled​(java.lang.Boolean bucketKeyEnabled)
        Parameters:
        bucketKeyEnabled - Whether or not to use [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) for SSE-KMS.
        Returns:
        builder

      • cacheControl

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

      • cacheControl

        public BucketObjectArgs.Builder cacheControl​(java.lang.String cacheControl)
        Parameters:
        cacheControl - Caching behavior along the request/reply chain Read [w3c cacheControl](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) for further details.
        Returns:
        builder

      • content

        public BucketObjectArgs.Builder content​(@Nullable
                                        com.pulumi.core.Output<java.lang.String> content)
        Parameters:
        content - Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
        Returns:
        builder

      • content

        public BucketObjectArgs.Builder content​(java.lang.String content)
        Parameters:
        content - Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
        Returns:
        builder

      • contentBase64

        public BucketObjectArgs.Builder contentBase64​(@Nullable
                                              com.pulumi.core.Output<java.lang.String> contentBase64)
        Parameters:
        contentBase64 - Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the `gzipbase64` function with small text strings. For larger objects, use `source` to stream the content from a disk file.
        Returns:
        builder

      • contentBase64

        public BucketObjectArgs.Builder contentBase64​(java.lang.String contentBase64)
        Parameters:
        contentBase64 - Base64-encoded data that will be decoded and uploaded as raw bytes for the object content. This allows safely uploading non-UTF8 binary data, but is recommended only for small content such as the result of the `gzipbase64` function with small text strings. For larger objects, use `source` to stream the content from a disk file.
        Returns:
        builder

      • contentDisposition

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

      • contentDisposition

        public BucketObjectArgs.Builder contentDisposition​(java.lang.String contentDisposition)
        Parameters:
        contentDisposition - Presentational information for the object. Read [w3c contentDisposition](http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1) for further information.
        Returns:
        builder

      • contentEncoding

        public BucketObjectArgs.Builder contentEncoding​(@Nullable
                                                com.pulumi.core.Output<java.lang.String> contentEncoding)
        Parameters:
        contentEncoding - 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.
        Returns:
        builder

      • contentEncoding

        public BucketObjectArgs.Builder contentEncoding​(java.lang.String contentEncoding)
        Parameters:
        contentEncoding - 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.
        Returns:
        builder

      • contentLanguage

        public BucketObjectArgs.Builder contentLanguage​(@Nullable
                                                com.pulumi.core.Output<java.lang.String> contentLanguage)
        Parameters:
        contentLanguage - Language the content is in e.g., en-US or en-GB.
        Returns:
        builder

      • contentLanguage

        public BucketObjectArgs.Builder contentLanguage​(java.lang.String contentLanguage)
        Parameters:
        contentLanguage - Language the content is in e.g., en-US or en-GB.
        Returns:
        builder

      • contentType

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

      • contentType

        public BucketObjectArgs.Builder contentType​(java.lang.String contentType)
        Parameters:
        contentType - Standard MIME type describing the format of the object data, e.g., application/octet-stream. All Valid MIME Types are valid for this input.
        Returns:
        builder

      • etag

        public BucketObjectArgs.Builder etag​(@Nullable
                                     com.pulumi.core.Output<java.lang.String> etag)
        Parameters:
        etag - Triggers updates when the value changes. This attribute is not compatible with KMS encryption, `kmsKeyId` or `serverSideEncryption = "aws:kms"` (see `sourceHash` instead).
        Returns:
        builder

      • etag

        public BucketObjectArgs.Builder etag​(java.lang.String etag)
        Parameters:
        etag - Triggers updates when the value changes. This attribute is not compatible with KMS encryption, `kmsKeyId` or `serverSideEncryption = "aws:kms"` (see `sourceHash` instead).
        Returns:
        builder

      • forceDestroy

        public BucketObjectArgs.Builder forceDestroy​(@Nullable
                                             com.pulumi.core.Output<java.lang.Boolean> forceDestroy)
        Parameters:
        forceDestroy - Whether to 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.
        Returns:
        builder

      • forceDestroy

        public BucketObjectArgs.Builder forceDestroy​(java.lang.Boolean forceDestroy)
        Parameters:
        forceDestroy - Whether to 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.
        Returns:
        builder

      • key

        public BucketObjectArgs.Builder key​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> key)
        Parameters:
        key - Name of the object once it is in the bucket. Use the `aws.s3.BucketObjectv2` resource instead. The following arguments are optional:
        Returns:
        builder

      • key

        public BucketObjectArgs.Builder key​(java.lang.String key)
        Parameters:
        key - Name of the object once it is in the bucket. Use the `aws.s3.BucketObjectv2` resource instead. The following arguments are optional:
        Returns:
        builder

      • kmsKeyId

        public BucketObjectArgs.Builder kmsKeyId​(@Nullable
                                         com.pulumi.core.Output<java.lang.String> kmsKeyId)
        Parameters:
        kmsKeyId - ARN of the KMS Key to use for object encryption. If the S3 Bucket has server-side encryption enabled, that value will automatically be used. If referencing the `aws.kms.Key` resource, use the `arn` attribute. If referencing the `aws.kms.Alias` data source or resource, use the `targetKeyArn` attribute. The provider will only perform drift detection if a configuration value is provided.
        Returns:
        builder

      • kmsKeyId

        public BucketObjectArgs.Builder kmsKeyId​(java.lang.String kmsKeyId)
        Parameters:
        kmsKeyId - ARN of the KMS Key to use for object encryption. If the S3 Bucket has server-side encryption enabled, that value will automatically be used. If referencing the `aws.kms.Key` resource, use the `arn` attribute. If referencing the `aws.kms.Alias` data source or resource, use the `targetKeyArn` attribute. The provider will only perform drift detection if a configuration value is provided.
        Returns:
        builder

      • metadata

        public BucketObjectArgs.Builder metadata​(@Nullable
                                         com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> metadata)
        Parameters:
        metadata - 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).
        Returns:
        builder

      • metadata

        public BucketObjectArgs.Builder metadata​(java.util.Map<java.lang.String,​java.lang.String> metadata)
        Parameters:
        metadata - 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).
        Returns:
        builder

      • objectLockLegalHoldStatus

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

      • objectLockLegalHoldStatus

        public BucketObjectArgs.Builder objectLockLegalHoldStatus​(java.lang.String objectLockLegalHoldStatus)
        Parameters:
        objectLockLegalHoldStatus - [Legal hold](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-legal-holds) status that you want to apply to the specified object. Valid values are `ON` and `OFF`.
        Returns:
        builder

      • objectLockMode

        public BucketObjectArgs.Builder objectLockMode​(@Nullable
                                               com.pulumi.core.Output<java.lang.String> objectLockMode)
        Parameters:
        objectLockMode - 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`.
        Returns:
        builder

      • objectLockMode

        public BucketObjectArgs.Builder objectLockMode​(java.lang.String objectLockMode)
        Parameters:
        objectLockMode - 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`.
        Returns:
        builder

      • objectLockRetainUntilDate

        public BucketObjectArgs.Builder objectLockRetainUntilDate​(@Nullable
                                                          com.pulumi.core.Output<java.lang.String> objectLockRetainUntilDate)
        Parameters:
        objectLockRetainUntilDate - 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).
        Returns:
        builder

      • objectLockRetainUntilDate

        public BucketObjectArgs.Builder objectLockRetainUntilDate​(java.lang.String objectLockRetainUntilDate)
        Parameters:
        objectLockRetainUntilDate - 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).
        Returns:
        builder

      • region

        public BucketObjectArgs.Builder region​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - 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.
        Returns:
        builder

      • region

        public BucketObjectArgs.Builder region​(java.lang.String region)
        Parameters:
        region - 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.
        Returns:
        builder

      • serverSideEncryption

        public BucketObjectArgs.Builder serverSideEncryption​(@Nullable
                                                     com.pulumi.core.Output<java.lang.String> serverSideEncryption)
        Parameters:
        serverSideEncryption - Server-side encryption of the object in S3. Valid values are "`AES256`" and "`aws:kms`".
        Returns:
        builder

      • serverSideEncryption

        public BucketObjectArgs.Builder serverSideEncryption​(java.lang.String serverSideEncryption)
        Parameters:
        serverSideEncryption - Server-side encryption of the object in S3. Valid values are "`AES256`" and "`aws:kms`".
        Returns:
        builder

      • source

        public BucketObjectArgs.Builder source​(@Nullable
                                       com.pulumi.core.Output<com.pulumi.asset.AssetOrArchive> source)
        Parameters:
        source - Path to a file that will be read and uploaded as raw bytes for the object content.
        Returns:
        builder

      • source

        public BucketObjectArgs.Builder source​(com.pulumi.asset.AssetOrArchive source)
        Parameters:
        source - Path to a file that will be read and uploaded as raw bytes for the object content.
        Returns:
        builder

      • sourceHash

        public BucketObjectArgs.Builder sourceHash​(@Nullable
                                           com.pulumi.core.Output<java.lang.String> sourceHash)
        Parameters:
        sourceHash - Triggers updates like `etag` but useful to address `etag` encryption limitations.
        Returns:
        builder

      • sourceHash

        public BucketObjectArgs.Builder sourceHash​(java.lang.String sourceHash)
        Parameters:
        sourceHash - Triggers updates like `etag` but useful to address `etag` encryption limitations.
        Returns:
        builder

      • storageClass

        public BucketObjectArgs.Builder storageClass​(@Nullable
                                             com.pulumi.core.Output<java.lang.String> storageClass)
        Parameters:
        storageClass - [Storage Class](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html#AmazonS3-PutObject-request-header-StorageClass) for the object. Defaults to "`STANDARD`".
        Returns:
        builder

      • storageClass

        public BucketObjectArgs.Builder storageClass​(java.lang.String storageClass)
        Parameters:
        storageClass - [Storage Class](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html#AmazonS3-PutObject-request-header-StorageClass) for the object. Defaults to "`STANDARD`".
        Returns:
        builder

      • tags

        public BucketObjectArgs.Builder tags​(@Nullable
                                     com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tags

        public BucketObjectArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • websiteRedirect

        public BucketObjectArgs.Builder websiteRedirect​(@Nullable
                                                com.pulumi.core.Output<java.lang.String> websiteRedirect)
        Parameters:
        websiteRedirect - Target URL for [website redirect](http://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html). > **Note:** If you specify `contentEncoding` you are responsible for encoding the body appropriately. `source`, `content`, and `contentBase64` all expect already encoded/compressed bytes.
        Returns:
        builder

      • websiteRedirect

        public BucketObjectArgs.Builder websiteRedirect​(java.lang.String websiteRedirect)
        Parameters:
        websiteRedirect - Target URL for [website redirect](http://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html). > **Note:** If you specify `contentEncoding` you are responsible for encoding the body appropriately. `source`, `content`, and `contentBase64` all expect already encoded/compressed bytes.
        Returns:
        builder