Struct BucketObjectArgs

pub struct BucketObjectArgs {

    pub acl: Output<Option<String>>,
    pub bucket: Output<String>,
    pub bucket_key_enabled: Output<Option<bool>>,
    pub cache_control: Output<Option<String>>,
    pub content: Output<Option<String>>,
    pub content_base64: Output<Option<String>>,
    pub content_disposition: Output<Option<String>>,
    pub content_encoding: Output<Option<String>>,
    pub content_language: Output<Option<String>>,
    pub content_type: Output<Option<String>>,
    pub etag: Output<Option<String>>,
    pub force_destroy: Output<Option<bool>>,
    pub key: Output<Option<String>>,
    pub kms_key_id: Output<Option<String>>,
    pub metadata: Output<Option<HashMap<String, String>>>,
    pub object_lock_legal_hold_status: Output<Option<String>>,
    pub object_lock_mode: Output<Option<String>>,
    pub object_lock_retain_until_date: Output<Option<String>>,
    pub server_side_encryption: Output<Option<String>>,
    pub source: Output<Option<String>>,
    pub source_hash: Output<Option<String>>,
    pub storage_class: Output<Option<String>>,
    pub tags: Output<Option<HashMap<String, String>>>,
    pub website_redirect: Output<Option<String>>,
}

Fields

acl: Output<Option<String>>

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.

bucket: Output<String>

Name of the bucket to put the file in. Alternatively, an S3 access point ARN can be specified.

bucket_key_enabled: Output<Option<bool>>

Whether or not to use Amazon S3 Bucket Keys for SSE-KMS.

cache_control: Output<Option<String>>

Caching behavior along the request/reply chain Read w3c cache_control for further details.

content: Output<Option<String>>

Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.

content_base64: Output<Option<String>>

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.

content_disposition: Output<Option<String>>

Presentational information for the object. Read w3c content_disposition for further information.

content_encoding: Output<Option<String>>

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 for further information.

content_language: Output<Option<String>>

Language the content is in e.g., en-US or en-GB.

content_type: Output<Option<String>>

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: Output<Option<String>>

Triggers updates when the value changes. This attribute is not compatible with KMS encryption, kms_key_id or server_side_encryption = "aws:kms" (see source_hash instead).

force_destroy: Output<Option<bool>>

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: Output<Option<String>>

Name of the object once it is in the bucket.

The following arguments are optional:

kms_key_id: Output<Option<String>>

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 target_key_arn attribute. The provider will only perform drift detection if a configuration value is provided.

metadata: Output<Option<HashMap<String, String>>>

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

object_lock_legal_hold_status: Output<Option<String>>

Legal hold status that you want to apply to the specified object. Valid values are ON and OFF.

object_lock_mode: Output<Option<String>>

Object lock retention mode that you want to apply to this object. Valid values are GOVERNANCE and COMPLIANCE.

object_lock_retain_until_date: Output<Option<String>>

Date and time, in RFC3339 format, when this object’s object lock will expire.

server_side_encryption: Output<Option<String>>

Server-side encryption of the object in S3. Valid values are “AES256” and “aws:kms”.

source: Output<Option<String>>

Path to a file that will be read and uploaded as raw bytes for the object content.

source_hash: Output<Option<String>>

Triggers updates like etag but useful to address etag encryption limitations.

storage_class: Output<Option<String>>

Storage Class for the object. Defaults to “STANDARD”.

tags: Output<Option<HashMap<String, String>>>

Map of tags to assign to the object. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

website_redirect: Output<Option<String>>

Target URL for website redirect.

If no content is provided through source, content or content_base64, then the object will be empty.

Implementations

impl BucketObjectArgs

pub fn builder() -> BucketObjectArgsBuilder

Create an instance of BucketObjectArgs using the builder syntax

Trait Implementations

impl Clone for BucketObjectArgs

fn clone(&self) -> BucketObjectArgs

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.