Package com.pulumi.aws.s3.inputs

Class BucketObjectState

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  BucketObjectState.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()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> bucket()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> bucketKeyEnabled()  
      static BucketObjectState.Builder builder()  
      static BucketObjectState.Builder builder​(BucketObjectState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> cacheControl()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> content()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> contentBase64()  
      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>> etag()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDestroy()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> key()  
      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>> 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<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> serverSideEncryption()  
      java.util.Optional<com.pulumi.core.Output<com.pulumi.asset.AssetOrArchive>> source()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceHash()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> storageClass()  
      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.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> versionId()  
      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`, `aws-exec-read`, `authenticated-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Defaults to `private`.

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the object.

      • bucket

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

      • bucketKeyEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> bucketKeyEnabled()
        Returns:
        Whether or not to use [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) for 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.

      • content

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> content()
        Returns:
        Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.

      • contentBase64

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

      • 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.

      • etag

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

      • forceDestroy

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

      • key

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> key()
        Returns:
        Name of the object once it is in the bucket. Use the `aws.s3.BucketObjectv2` resource instead. The following arguments are optional:

      • kmsKeyId

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

      • 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).

      • 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 that you want 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.

      • 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 java.util.Optional<com.pulumi.core.Output<com.pulumi.asset.AssetOrArchive>> source()
        Returns:
        Path to a file that will be read and uploaded as raw bytes for the object content.

      • sourceHash

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sourceHash()
        Returns:
        Triggers updates like `etag` but useful to address `etag` encryption limitations.

      • storageClass

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

      • 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.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • versionId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> versionId()
        Returns:
        Unique version ID value for the object, if bucket versioning is enabled.

      • 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). > **Note:** If you specify `contentEncoding` you are responsible for encoding the body appropriately. `source`, `content`, and `contentBase64` all expect already encoded/compressed bytes.