ebs_snapshot.md

permalink
/ebs_snapshot/

ebs_snapshot

ebs_snapshot represents the aws_ebs_snapshot Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withDescription()
• fn withOutpostArn()
• fn withPermanentRestore()
• fn withStorageTier()
• fn withTags()
• fn withTagsAll()
• fn withTemporaryRestoreDays()
• fn withTimeouts()
• fn withTimeoutsMixin()
• fn withVolumeId()
• obj timeouts
  • fn new()

Fields

fn new

new()

aws.ebs_snapshot.new injects a new aws_ebs_snapshot 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.ebs_snapshot.new('some_id')

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

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

This is the same as directly entering "${ aws_ebs_snapshot.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.
• description (string): Set the description field on the resulting resource block. When null, the description field will be omitted from the resulting object.
• outpost_arn (string): Set the outpost_arn field on the resulting resource block. When null, the outpost_arn field will be omitted from the resulting object.
• permanent_restore (bool): Set the permanent_restore field on the resulting resource block. When null, the permanent_restore field will be omitted from the resulting object.
• storage_tier (string): Set the storage_tier field on the resulting resource block. When null, the storage_tier 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.
• temporary_restore_days (number): Set the temporary_restore_days field on the resulting resource block. When null, the temporary_restore_days field will be omitted from the resulting object.
• volume_id (string): Set the volume_id field on the resulting resource block.
• timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ebs_snapshot.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike aws.ebs_snapshot.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:

• description (string): Set the description field on the resulting object. When null, the description field will be omitted from the resulting object.
• outpost_arn (string): Set the outpost_arn field on the resulting object. When null, the outpost_arn field will be omitted from the resulting object.
• permanent_restore (bool): Set the permanent_restore field on the resulting object. When null, the permanent_restore field will be omitted from the resulting object.
• storage_tier (string): Set the storage_tier field on the resulting object. When null, the storage_tier 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.
• temporary_restore_days (number): Set the temporary_restore_days field on the resulting object. When null, the temporary_restore_days field will be omitted from the resulting object.
• volume_id (string): Set the volume_id field on the resulting object.
• timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ebs_snapshot.timeouts.new constructor.

Returns:

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

fn withDescription

withDescription()

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

Args:

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

fn withOutpostArn

withOutpostArn()

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

Args:

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

fn withPermanentRestore

withPermanentRestore()

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

Args:

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

fn withStorageTier

withStorageTier()

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

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the storage_tier 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 withTemporaryRestoreDays

withTemporaryRestoreDays()

aws.number.withTemporaryRestoreDays constructs a mixin object that can be merged into the number Terraform resource block to set or update the temporary_restore_days field.

Args:

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

fn withTimeouts

withTimeouts()

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

This function will replace the map with the passed in value. If you wish to instead merge the passed in value to the existing map, use the aws.obj.withTimeoutsMixin function.

Args:

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

fn withTimeoutsMixin

withTimeoutsMixin()

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

This function will merge the passed in value to the existing map. If you wish to instead replace the entire map with the passed in value, use the aws.obj.withTimeouts function.

Args:

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

fn withVolumeId

withVolumeId()

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

Args:

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

obj timeouts

fn timeouts.new

new()

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

Args:

• create (string): Set the create field on the resulting object. When null, the create field will be omitted from the resulting object.
• delete (string): Set the delete field on the resulting object. When null, the delete field will be omitted from the resulting object.

Returns:

• An attribute object that represents the timeouts sub block.