pulumi_wasm_providers_aws_mini::s3::bucket_object

Struct BucketObjectArgsBuilder

source 
pub struct BucketObjectArgsBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build_struct().

Implementations§

source§

impl<S: State> BucketObjectArgsBuilder<S>

source

pub fn build_struct(self) -> BucketObjectArgs
where S: IsComplete,

Finish building and return the requested object

source

pub fn acl( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetAcl<S>>
where S::Acl: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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.

source

pub fn maybe_acl( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetAcl<S>>
where S::Acl: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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.

source

pub fn bucket( self, value: impl Into<Output<String>>, ) -> BucketObjectArgsBuilder<SetBucket<S>>
where S::Bucket: IsUnset,

Required.

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

source

pub fn bucket_key_enabled( self, value: impl Into<Output<Option<bool>>>, ) -> BucketObjectArgsBuilder<SetBucketKeyEnabled<S>>
where S::BucketKeyEnabled: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<bool>> as Default>::default().

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

source

pub fn maybe_bucket_key_enabled( self, value: Option<impl Into<Output<Option<bool>>>>, ) -> BucketObjectArgsBuilder<SetBucketKeyEnabled<S>>
where S::BucketKeyEnabled: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<bool>> as Default>::default().

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

source

pub fn cache_control( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetCacheControl<S>>
where S::CacheControl: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn maybe_cache_control( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetCacheControl<S>>
where S::CacheControl: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn content( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetContent<S>>
where S::Content: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn maybe_content( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetContent<S>>
where S::Content: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn content_base64( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetContentBase64<S>>
where S::ContentBase64: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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.

source

pub fn maybe_content_base64( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetContentBase64<S>>
where S::ContentBase64: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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.

source

pub fn content_disposition( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetContentDisposition<S>>
where S::ContentDisposition: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn maybe_content_disposition( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetContentDisposition<S>>
where S::ContentDisposition: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn content_encoding( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetContentEncoding<S>>
where S::ContentEncoding: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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.

source

pub fn maybe_content_encoding( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetContentEncoding<S>>
where S::ContentEncoding: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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.

source

pub fn content_language( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetContentLanguage<S>>
where S::ContentLanguage: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn maybe_content_language( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetContentLanguage<S>>
where S::ContentLanguage: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn content_type( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetContentType<S>>
where S::ContentType: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

Standard MIME type describing the format of the object data, e.g., application/octet-stream. All Valid MIME Types are valid for this input.

source

pub fn maybe_content_type( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetContentType<S>>
where S::ContentType: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

Standard MIME type describing the format of the object data, e.g., application/octet-stream. All Valid MIME Types are valid for this input.

source

pub fn etag( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetEtag<S>>
where S::Etag: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn maybe_etag( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetEtag<S>>
where S::Etag: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn force_destroy( self, value: impl Into<Output<Option<bool>>>, ) -> BucketObjectArgsBuilder<SetForceDestroy<S>>
where S::ForceDestroy: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<bool>> as Default>::default().

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.

source

pub fn maybe_force_destroy( self, value: Option<impl Into<Output<Option<bool>>>>, ) -> BucketObjectArgsBuilder<SetForceDestroy<S>>
where S::ForceDestroy: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<bool>> as Default>::default().

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.

source

pub fn key( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetKey<S>>
where S::Key: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

Name of the object once it is in the bucket.

The following arguments are optional:

source

pub fn maybe_key( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetKey<S>>
where S::Key: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

Name of the object once it is in the bucket.

The following arguments are optional:

source

pub fn kms_key_id( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetKmsKeyId<S>>
where S::KmsKeyId: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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.

source

pub fn maybe_kms_key_id( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetKmsKeyId<S>>
where S::KmsKeyId: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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.

source

pub fn metadata( self, value: impl Into<Output<Option<HashMap<String, String>>>>, ) -> BucketObjectArgsBuilder<SetMetadata<S>>
where S::Metadata: IsUnset,

Optional (Some / Option setters). Default:

ⓘ
<pulumi_wasm_rust::Output<
    Option<std::collections::HashMap<String, String>>,
> as Default>::default()

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

source

pub fn maybe_metadata( self, value: Option<impl Into<Output<Option<HashMap<String, String>>>>>, ) -> BucketObjectArgsBuilder<SetMetadata<S>>
where S::Metadata: IsUnset,

Optional (Some / Option setters). Default:

ⓘ
<pulumi_wasm_rust::Output<
    Option<std::collections::HashMap<String, String>>,
> as Default>::default()

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

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn object_lock_mode( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetObjectLockMode<S>>
where S::ObjectLockMode: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn maybe_object_lock_mode( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetObjectLockMode<S>>
where S::ObjectLockMode: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn object_lock_retain_until_date( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetObjectLockRetainUntilDate<S>>
where S::ObjectLockRetainUntilDate: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn maybe_object_lock_retain_until_date( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetObjectLockRetainUntilDate<S>>
where S::ObjectLockRetainUntilDate: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn server_side_encryption( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetServerSideEncryption<S>>
where S::ServerSideEncryption: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn maybe_server_side_encryption( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetServerSideEncryption<S>>
where S::ServerSideEncryption: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn source( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetSource<S>>
where S::Source: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn maybe_source( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetSource<S>>
where S::Source: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn source_hash( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetSourceHash<S>>
where S::SourceHash: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn maybe_source_hash( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetSourceHash<S>>
where S::SourceHash: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn storage_class( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetStorageClass<S>>
where S::StorageClass: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn maybe_storage_class( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetStorageClass<S>>
where S::StorageClass: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

source

pub fn tags( self, value: impl Into<Output<Option<HashMap<String, String>>>>, ) -> BucketObjectArgsBuilder<SetTags<S>>
where S::Tags: IsUnset,

Optional (Some / Option setters). Default:

ⓘ
<pulumi_wasm_rust::Output<
    Option<std::collections::HashMap<String, String>>,
> as Default>::default()

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.

source

pub fn maybe_tags( self, value: Option<impl Into<Output<Option<HashMap<String, String>>>>>, ) -> BucketObjectArgsBuilder<SetTags<S>>
where S::Tags: IsUnset,

Optional (Some / Option setters). Default:

ⓘ
<pulumi_wasm_rust::Output<
    Option<std::collections::HashMap<String, String>>,
> as Default>::default()

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.

source

pub fn website_redirect( self, value: impl Into<Output<Option<String>>>, ) -> BucketObjectArgsBuilder<SetWebsiteRedirect<S>>
where S::WebsiteRedirect: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

Target URL for website redirect.

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

source

pub fn maybe_website_redirect( self, value: Option<impl Into<Output<Option<String>>>>, ) -> BucketObjectArgsBuilder<SetWebsiteRedirect<S>>
where S::WebsiteRedirect: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

Target URL for website redirect.

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

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.