s3_object.md

permalink
/s3_object/

s3_object

s3_object represents the aws_s3_object Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withAcl()
• fn withBucket()
• fn withBucketKeyEnabled()
• fn withCacheControl()
• fn withChecksumAlgorithm()
• fn withContent()
• fn withContentBase64()
• fn withContentDisposition()
• fn withContentEncoding()
• fn withContentLanguage()
• fn withContentType()
• fn withEtag()
• fn withForceDestroy()
• fn withKey()
• fn withKmsKeyId()
• fn withMetadata()
• fn withObjectLockLegalHoldStatus()
• fn withObjectLockMode()
• fn withObjectLockRetainUntilDate()
• fn withOverrideProvider()
• fn withOverrideProviderMixin()
• fn withServerSideEncryption()
• fn withSource()
• fn withSourceHash()
• fn withStorageClass()
• fn withTags()
• fn withTagsAll()
• fn withWebsiteRedirect()
• obj override_provider
  • fn new()
  • obj override_provider.default_tags
    • fn new()

Fields

fn new

new()

aws.s3_object.new injects a new aws_s3_object Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
aws.s3_object.new('some_id')

You can get the reference to the id field of the created aws.s3_object using the reference:

$._ref.aws_s3_object.some_id.get('id')

This is the same as directly entering "${ aws_s3_object.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• acl (string): Set the acl field on the resulting resource block. When null, the acl field will be omitted from the resulting object.
• bucket (string): Set the bucket field on the resulting resource block.
• bucket_key_enabled (bool): Set the bucket_key_enabled field on the resulting resource block. When null, the bucket_key_enabled field will be omitted from the resulting object.
• cache_control (string): Set the cache_control field on the resulting resource block. When null, the cache_control field will be omitted from the resulting object.
• checksum_algorithm (string): Set the checksum_algorithm field on the resulting resource block. When null, the checksum_algorithm field will be omitted from the resulting object.
• content (string): Set the content field on the resulting resource block. When null, the content field will be omitted from the resulting object.
• content_base64 (string): Set the content_base64 field on the resulting resource block. When null, the content_base64 field will be omitted from the resulting object.
• content_disposition (string): Set the content_disposition field on the resulting resource block. When null, the content_disposition field will be omitted from the resulting object.
• content_encoding (string): Set the content_encoding field on the resulting resource block. When null, the content_encoding field will be omitted from the resulting object.
• content_language (string): Set the content_language field on the resulting resource block. When null, the content_language field will be omitted from the resulting object.
• content_type (string): Set the content_type field on the resulting resource block. When null, the content_type field will be omitted from the resulting object.
• etag (string): Set the etag field on the resulting resource block. When null, the etag field will be omitted from the resulting object.
• force_destroy (bool): Set the force_destroy field on the resulting resource block. When null, the force_destroy field will be omitted from the resulting object.
• key (string): Set the key field on the resulting resource block.
• kms_key_id (string): Set the kms_key_id field on the resulting resource block. When null, the kms_key_id field will be omitted from the resulting object.
• metadata (obj): Set the metadata field on the resulting resource block. When null, the metadata field will be omitted from the resulting object.
• object_lock_legal_hold_status (string): Set the object_lock_legal_hold_status field on the resulting resource block. When null, the object_lock_legal_hold_status field will be omitted from the resulting object.
• object_lock_mode (string): Set the object_lock_mode field on the resulting resource block. When null, the object_lock_mode field will be omitted from the resulting object.
• object_lock_retain_until_date (string): Set the object_lock_retain_until_date field on the resulting resource block. When null, the object_lock_retain_until_date field will be omitted from the resulting object.
• server_side_encryption (string): Set the server_side_encryption field on the resulting resource block. When null, the server_side_encryption field will be omitted from the resulting object.
• source (string): Set the source field on the resulting resource block. When null, the source field will be omitted from the resulting object.
• source_hash (string): Set the source_hash field on the resulting resource block. When null, the source_hash field will be omitted from the resulting object.
• storage_class (string): Set the storage_class field on the resulting resource block. When null, the storage_class field will be omitted from the resulting object.
• tags (obj): Set the tags field on the resulting resource block. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting resource block. When null, the tags_all field will be omitted from the resulting object.
• website_redirect (string): Set the website_redirect field on the resulting resource block. When null, the website_redirect field will be omitted from the resulting object.
• override_provider (list[obj]): Set the override_provider field on the resulting resource block. When null, the override_provider sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.s3_object.override_provider.new constructor.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

aws.s3_object.newAttrs constructs a new object with attributes and blocks configured for the s3_object Terraform resource.

Unlike aws.s3_object.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• acl (string): Set the acl field on the resulting object. When null, the acl field will be omitted from the resulting object.
• bucket (string): Set the bucket field on the resulting object.
• bucket_key_enabled (bool): Set the bucket_key_enabled field on the resulting object. When null, the bucket_key_enabled field will be omitted from the resulting object.
• cache_control (string): Set the cache_control field on the resulting object. When null, the cache_control field will be omitted from the resulting object.
• checksum_algorithm (string): Set the checksum_algorithm field on the resulting object. When null, the checksum_algorithm field will be omitted from the resulting object.
• content (string): Set the content field on the resulting object. When null, the content field will be omitted from the resulting object.
• content_base64 (string): Set the content_base64 field on the resulting object. When null, the content_base64 field will be omitted from the resulting object.
• content_disposition (string): Set the content_disposition field on the resulting object. When null, the content_disposition field will be omitted from the resulting object.
• content_encoding (string): Set the content_encoding field on the resulting object. When null, the content_encoding field will be omitted from the resulting object.
• content_language (string): Set the content_language field on the resulting object. When null, the content_language field will be omitted from the resulting object.
• content_type (string): Set the content_type field on the resulting object. When null, the content_type field will be omitted from the resulting object.
• etag (string): Set the etag field on the resulting object. When null, the etag field will be omitted from the resulting object.
• force_destroy (bool): Set the force_destroy field on the resulting object. When null, the force_destroy field will be omitted from the resulting object.
• key (string): Set the key field on the resulting object.
• kms_key_id (string): Set the kms_key_id field on the resulting object. When null, the kms_key_id field will be omitted from the resulting object.
• metadata (obj): Set the metadata field on the resulting object. When null, the metadata field will be omitted from the resulting object.
• object_lock_legal_hold_status (string): Set the object_lock_legal_hold_status field on the resulting object. When null, the object_lock_legal_hold_status field will be omitted from the resulting object.
• object_lock_mode (string): Set the object_lock_mode field on the resulting object. When null, the object_lock_mode field will be omitted from the resulting object.
• object_lock_retain_until_date (string): Set the object_lock_retain_until_date field on the resulting object. When null, the object_lock_retain_until_date field will be omitted from the resulting object.
• server_side_encryption (string): Set the server_side_encryption field on the resulting object. When null, the server_side_encryption field will be omitted from the resulting object.
• source (string): Set the source field on the resulting object. When null, the source field will be omitted from the resulting object.
• source_hash (string): Set the source_hash field on the resulting object. When null, the source_hash field will be omitted from the resulting object.
• storage_class (string): Set the storage_class field on the resulting object. When null, the storage_class field will be omitted from the resulting object.
• tags (obj): Set the tags field on the resulting object. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting object. When null, the tags_all field will be omitted from the resulting object.
• website_redirect (string): Set the website_redirect field on the resulting object. When null, the website_redirect field will be omitted from the resulting object.
• override_provider (list[obj]): Set the override_provider field on the resulting object. When null, the override_provider sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.s3_object.override_provider.new constructor.

Returns:

• An attribute object that can be used with tf.withResource to construct a new s3_object resource into the root Terraform configuration.

fn withAcl

withAcl()

aws.string.withAcl constructs a mixin object that can be merged into the string Terraform resource block to set or update the acl field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the acl field.

fn withBucket

withBucket()

aws.string.withBucket constructs a mixin object that can be merged into the string Terraform resource block to set or update the bucket field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the bucket field.

fn withBucketKeyEnabled

withBucketKeyEnabled()

aws.bool.withBucketKeyEnabled constructs a mixin object that can be merged into the bool Terraform resource block to set or update the bucket_key_enabled field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the bucket_key_enabled field.

fn withCacheControl

withCacheControl()

aws.string.withCacheControl constructs a mixin object that can be merged into the string Terraform resource block to set or update the cache_control field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the cache_control field.

fn withChecksumAlgorithm

withChecksumAlgorithm()

aws.string.withChecksumAlgorithm constructs a mixin object that can be merged into the string Terraform resource block to set or update the checksum_algorithm field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the checksum_algorithm field.

fn withContent

withContent()

aws.string.withContent constructs a mixin object that can be merged into the string Terraform resource block to set or update the content field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the content field.

fn withContentBase64

withContentBase64()

aws.string.withContentBase64 constructs a mixin object that can be merged into the string Terraform resource block to set or update the content_base64 field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the content_base64 field.

fn withContentDisposition

withContentDisposition()

aws.string.withContentDisposition constructs a mixin object that can be merged into the string Terraform resource block to set or update the content_disposition field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the content_disposition field.

fn withContentEncoding

withContentEncoding()

aws.string.withContentEncoding constructs a mixin object that can be merged into the string Terraform resource block to set or update the content_encoding field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the content_encoding field.

fn withContentLanguage

withContentLanguage()

aws.string.withContentLanguage constructs a mixin object that can be merged into the string Terraform resource block to set or update the content_language field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the content_language field.

fn withContentType

withContentType()

aws.string.withContentType constructs a mixin object that can be merged into the string Terraform resource block to set or update the content_type field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the content_type field.

fn withEtag

withEtag()

aws.string.withEtag constructs a mixin object that can be merged into the string Terraform resource block to set or update the etag field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the etag field.

fn withForceDestroy

withForceDestroy()

aws.bool.withForceDestroy constructs a mixin object that can be merged into the bool Terraform resource block to set or update the force_destroy field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the force_destroy field.

fn withKey

withKey()

aws.string.withKey constructs a mixin object that can be merged into the string Terraform resource block to set or update the key field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the key field.

fn withKmsKeyId

withKmsKeyId()

aws.string.withKmsKeyId constructs a mixin object that can be merged into the string Terraform resource block to set or update the kms_key_id field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the kms_key_id field.

fn withMetadata

withMetadata()

aws.obj.withMetadata constructs a mixin object that can be merged into the obj Terraform resource block to set or update the metadata field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the metadata field.

fn withObjectLockLegalHoldStatus

withObjectLockLegalHoldStatus()

aws.string.withObjectLockLegalHoldStatus constructs a mixin object that can be merged into the string Terraform resource block to set or update the object_lock_legal_hold_status field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the object_lock_legal_hold_status field.

fn withObjectLockMode

withObjectLockMode()

aws.string.withObjectLockMode constructs a mixin object that can be merged into the string Terraform resource block to set or update the object_lock_mode field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the object_lock_mode field.

fn withObjectLockRetainUntilDate

withObjectLockRetainUntilDate()

aws.string.withObjectLockRetainUntilDate constructs a mixin object that can be merged into the string Terraform resource block to set or update the object_lock_retain_until_date field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the object_lock_retain_until_date field.

fn withOverrideProvider

withOverrideProvider()

aws.list[obj].withOverrideProvider constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the override_provider field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withOverrideProviderMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the override_provider field.

fn withOverrideProviderMixin

withOverrideProviderMixin()

aws.list[obj].withOverrideProviderMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the override_provider field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withOverrideProvider function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the override_provider field.

fn withServerSideEncryption

withServerSideEncryption()

aws.string.withServerSideEncryption constructs a mixin object that can be merged into the string Terraform resource block to set or update the server_side_encryption field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the server_side_encryption field.

fn withSource

withSource()

aws.string.withSource constructs a mixin object that can be merged into the string Terraform resource block to set or update the source field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the source field.

fn withSourceHash

withSourceHash()

aws.string.withSourceHash constructs a mixin object that can be merged into the string Terraform resource block to set or update the source_hash field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the source_hash field.

fn withStorageClass

withStorageClass()

aws.string.withStorageClass constructs a mixin object that can be merged into the string Terraform resource block to set or update the storage_class field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the storage_class field.

fn withTags

withTags()

aws.obj.withTags constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags field.

fn withTagsAll

withTagsAll()

aws.obj.withTagsAll constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags_all field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags_all field.

fn withWebsiteRedirect

withWebsiteRedirect()

aws.string.withWebsiteRedirect constructs a mixin object that can be merged into the string Terraform resource block to set or update the website_redirect field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the website_redirect field.

obj override_provider

fn override_provider.new

new()

aws.s3_object.override_provider.new constructs a new object with attributes and blocks configured for the override_provider Terraform sub block.

Args:

• default_tags (list[obj]): Set the default_tags field on the resulting object. When null, the default_tags sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.s3_object.override_provider.default_tags.new constructor.

Returns:

• An attribute object that represents the override_provider sub block.

obj override_provider.default_tags

fn override_provider.default_tags.new

new()

aws.s3_object.override_provider.default_tags.new constructs a new object with attributes and blocks configured for the default_tags Terraform sub block.

Args:

• tags (obj): Set the tags field on the resulting object. When null, the tags field will be omitted from the resulting object.

Returns:

• An attribute object that represents the default_tags sub block.