BucketObjectArgs class
The set of arguments for BucketObject. The set of arguments for BucketObject.
Constructors
-
BucketObjectArgs({Input<
String?> ? acl, required Input bucket, Input<bool?> ? bucketKeyEnabled, Input<String?> ? cacheControl, Input<String?> ? content, Input<String?> ? contentBase64, Input<String?> ? contentDisposition, Input<String?> ? contentEncoding, Input<String?> ? contentLanguage, Input<String?> ? contentType, Input<String?> ? etag, Input<bool?> ? forceDestroy, Input<String?> ? key, Input<String?> ? kmsKeyId, Input<Map< ? metadata, Input<String, String> ?>String?> ? objectLockLegalHoldStatus, Input<String?> ? objectLockMode, Input<String?> ? objectLockRetainUntilDate, Input<String?> ? region, Input<String?> ? serverSideEncryption, Input? source, Input<String?> ? sourceHash, Input<String?> ? storageClass, Input<Map< ? tags, Input<String, String> ?>String?> ? websiteRedirect}) -
Creates a new BucketObjectArgs.
acl Canned ACL to apply. Valid values are
private,public-read,public-read-write,aws-exec-read,authenticated-read,bucket-owner-read, andbucket-owner-full-control. Defaults toprivate.bucketName of the bucket to put the file in. Alternatively, an S3 access point ARN can be specified. Use theaws.s3.BucketObjectv2resource instead.bucketKeyEnabledWhether or not to use Amazon S3 Bucket Keys for SSE-KMS.cacheControlCaching behavior along the request/reply chain Read w3c cacheControl for further details.contentLiteral string value to use as the object content, which will be uploaded as UTF-8-encoded text.contentBase64Base64-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 thegzipbase64function with small text strings. For larger objects, usesourceto stream the content from a disk file.contentDispositionPresentational information for the object. Read w3c contentDisposition for further information.contentEncodingContent 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.contentLanguageLanguage the content is in e.g., en-US or en-GB.contentTypeStandard MIME type describing the format of the object data, e.g., application/octet-stream. All Valid MIME Types are valid for this input.etagTriggers updates when the value changes. This attribute is not compatible with KMS encryption,kmsKeyIdorserverSideEncryption = "aws:kms"(seesourceHashinstead).forceDestroyWhether to allow the object to be deleted by removing any legal hold on any object version. Default isfalse. This value should be set totrueonly if the bucket has S3 object lock enabled.keyName of the object once it is in the bucket. Use theaws.s3.BucketObjectv2resource instead.kmsKeyIdARN 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 theaws.kms.Keyresource, use thearnattribute. If referencing theaws.kms.Aliasdata source or resource, use thetargetKeyArnattribute. The provider will only perform drift detection if a configuration value is provided.metadataMap of keys/values to provision metadata (will be automatically prefixed byx-amz-meta-, note that only lowercase label are currently supported by the AWS Go API). objectLockLegalHoldStatus Legal hold status that you want to apply to the specified object. Valid values areONandOFF.objectLockModeObject lock retention mode that you want to apply to this object. Valid values areGOVERNANCEandCOMPLIANCE.objectLockRetainUntilDateDate and time, in RFC3339 format, when this object's object lock will expire.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.serverSideEncryptionServer-side encryption of the object in S3. Valid values are "AES256" and "aws:kms".sourcePath to a file that will be read and uploaded as raw bytes for the object content.sourceHashTriggers updates likeetagbut useful to addressetagencryption limitations. storageClass Storage Class for the object. Defaults to "STANDARD".tagsMap of tags to assign to the object. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.websiteRedirectTarget URL for website redirect.const -
BucketObjectArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
acl
→ Input<
String?> ? -
Canned ACL to apply. Valid values are
private,public-read,public-read-write,aws-exec-read,authenticated-read,bucket-owner-read, andbucket-owner-full-control. Defaults toprivate.final - bucket → Input
-
Name of the bucket to put the file in. Alternatively, an S3 access point ARN can be specified. Use the
aws.s3.BucketObjectv2resource instead.final -
bucketKeyEnabled
→ Input<
bool?> ? -
Whether or not to use Amazon S3 Bucket Keys for SSE-KMS.
final
-
cacheControl
→ Input<
String?> ? -
Caching behavior along the request/reply chain Read w3c cacheControl for further details.
final
-
content
→ Input<
String?> ? -
Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
final
-
contentBase64
→ Input<
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
gzipbase64function with small text strings. For larger objects, usesourceto stream the content from a disk file.final -
contentDisposition
→ Input<
String?> ? -
Presentational information for the object. Read w3c contentDisposition for further information.
final
-
contentEncoding
→ Input<
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.
final
-
contentLanguage
→ Input<
String?> ? -
Language the content is in e.g., en-US or en-GB.
final
-
contentType
→ Input<
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.
final
-
etag
→ Input<
String?> ? -
Triggers updates when the value changes. This attribute is not compatible with KMS encryption,
kmsKeyIdorserverSideEncryption = "aws:kms"(seesourceHashinstead).final -
forceDestroy
→ Input<
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 totrueonly if the bucket has S3 object lock enabled.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
key
→ Input<
String?> ? -
Name of the object once it is in the bucket. Use the
aws.s3.BucketObjectv2resource instead.final -
kmsKeyId
→ Input<
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.Keyresource, use thearnattribute. If referencing theaws.kms.Aliasdata source or resource, use thetargetKeyArnattribute. The provider will only perform drift detection if a configuration value is provided.final -
metadata
→ Input<
Map< ?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).final -
objectLockLegalHoldStatus
→ Input<
String?> ? -
Legal hold status that you want to apply to the specified object. Valid values are
ONandOFF.final -
objectLockMode
→ Input<
String?> ? -
Object lock retention mode that you want to apply to this object. Valid values are
GOVERNANCEandCOMPLIANCE.final -
objectLockRetainUntilDate
→ Input<
String?> ? -
Date and time, in RFC3339 format, when this object's object lock will expire.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serverSideEncryption
→ Input<
String?> ? -
Server-side encryption of the object in S3. Valid values are "
AES256" and "aws:kms".final - source → Input?
-
Path to a file that will be read and uploaded as raw bytes for the object content.
final
-
sourceHash
→ Input<
String?> ? -
Triggers updates like
etagbut useful to addressetagencryption limitations.final -
storageClass
→ Input<
String?> ? -
Storage Class for the object. Defaults to "
STANDARD".final -
Map of tags to assign to the object. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
websiteRedirect
→ Input<
String?> ? -
Target URL for website redirect.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited