Skip to content

Latest commit

 

History

History
149 lines (91 loc) · 4.73 KB

glacier_vault_lock.md

File metadata and controls

149 lines (91 loc) · 4.73 KB
Raw
permalink
/glacier_vault_lock/

glacier_vault_lock

glacier_vault_lock represents the aws_glacier_vault_lock Terraform resource.

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

Index

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_glacier_vault_lock.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.
  • complete_lock (bool): Set the complete_lock field on the resulting resource block.
  • ignore_deletion_error (bool): Set the ignore_deletion_error field on the resulting resource block. When null, the ignore_deletion_error field will be omitted from the resulting object.
  • policy (string): Set the policy field on the resulting resource block.
  • vault_name (string): Set the vault_name field on the resulting resource block.

Returns:

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

fn newAttrs

newAttrs()

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

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

  • complete_lock (bool): Set the complete_lock field on the resulting object.
  • ignore_deletion_error (bool): Set the ignore_deletion_error field on the resulting object. When null, the ignore_deletion_error field will be omitted from the resulting object.
  • policy (string): Set the policy field on the resulting object.
  • vault_name (string): Set the vault_name field on the resulting object.

Returns:

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

fn withCompleteLock

withCompleteLock()

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

Args:

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

fn withIgnoreDeletionError

withIgnoreDeletionError()

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

Args:

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

fn withPolicy

withPolicy()

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

Args:

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

fn withVaultName

withVaultName()

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

Args:

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