Skip to content

Latest commit

 

History

History
216 lines (132 loc) · 7.14 KB

glacier_vault.md

File metadata and controls

216 lines (132 loc) · 7.14 KB
Raw
permalink
/glacier_vault/

glacier_vault

glacier_vault represents the aws_glacier_vault Terraform resource.

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

Index

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_glacier_vault.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.
  • access_policy (string): Set the access_policy field on the resulting resource block. When null, the access_policy field will be omitted from the resulting object.
  • name (string): Set the name field on the resulting resource block.
  • 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.
  • notification (list[obj]): Set the notification field on the resulting resource block. When null, the notification sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.glacier_vault.notification.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

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

  • access_policy (string): Set the access_policy field on the resulting object. When null, the access_policy field will be omitted from the resulting object.
  • name (string): Set the name field on 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.
  • notification (list[obj]): Set the notification field on the resulting object. When null, the notification sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.glacier_vault.notification.new constructor.

Returns:

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

fn withAccessPolicy

withAccessPolicy()

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

Args:

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

fn withName

withName()

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

Args:

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

fn withNotification

withNotification()

aws.list[obj].withNotification constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the notification 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].withNotificationMixin function.

Args:

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

fn withNotificationMixin

withNotificationMixin()

aws.list[obj].withNotificationMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the notification 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].withNotification function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the notification 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.

obj notification

fn notification.new

new()

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

Args:

  • events (list): Set the events field on the resulting object.
  • sns_topic (string): Set the sns_topic field on the resulting object.

Returns:

  • An attribute object that represents the notification sub block.