Skip to content

Latest commit

 

History

History
130 lines (79 loc) · 4.07 KB

kms_alias.md

File metadata and controls

130 lines (79 loc) · 4.07 KB
Raw
permalink
/kms_alias/

kms_alias

kms_alias represents the aws_kms_alias Terraform resource.

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

Index

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_kms_alias.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.
  • name (string): Set the name field on the resulting resource block. When null, the name field will be omitted from the resulting object.
  • name_prefix (string): Set the name_prefix field on the resulting resource block. When null, the name_prefix field will be omitted from the resulting object.
  • target_key_id (string): Set the target_key_id field on the resulting resource block.

Returns:

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

fn newAttrs

newAttrs()

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

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

  • name (string): Set the name field on the resulting object. When null, the name field will be omitted from the resulting object.
  • name_prefix (string): Set the name_prefix field on the resulting object. When null, the name_prefix field will be omitted from the resulting object.
  • target_key_id (string): Set the target_key_id field on the resulting object.

Returns:

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

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 withNamePrefix

withNamePrefix()

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

Args:

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

fn withTargetKeyId

withTargetKeyId()

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

Args:

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