kms_external_key.md

permalink
/kms_external_key/

kms_external_key

kms_external_key represents the aws_kms_external_key Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withBypassPolicyLockoutSafetyCheck()
• fn withDeletionWindowInDays()
• fn withDescription()
• fn withEnabled()
• fn withKeyMaterialBase64()
• fn withMultiRegion()
• fn withPolicy()
• fn withTags()
• fn withTagsAll()
• fn withValidTo()

Fields

fn new

new()

aws.kms_external_key.new injects a new aws_kms_external_key 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_external_key.new('some_id')

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

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

This is the same as directly entering "${ aws_kms_external_key.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.
• bypass_policy_lockout_safety_check (bool): Set the bypass_policy_lockout_safety_check field on the resulting resource block. When null, the bypass_policy_lockout_safety_check field will be omitted from the resulting object.
• deletion_window_in_days (number): Set the deletion_window_in_days field on the resulting resource block. When null, the deletion_window_in_days field will be omitted from the resulting object.
• description (string): Set the description field on the resulting resource block. When null, the description field will be omitted from the resulting object.
• enabled (bool): Set the enabled field on the resulting resource block. When null, the enabled field will be omitted from the resulting object.
• key_material_base64 (string): Set the key_material_base64 field on the resulting resource block. When null, the key_material_base64 field will be omitted from the resulting object.
• multi_region (bool): Set the multi_region field on the resulting resource block. When null, the multi_region field will be omitted from the resulting object.
• policy (string): Set the policy field on the resulting resource block. When null, the policy 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.
• valid_to (string): Set the valid_to field on the resulting resource block. When null, the valid_to field will be omitted from the resulting object.

Returns:

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

fn newAttrs

newAttrs()

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

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

• bypass_policy_lockout_safety_check (bool): Set the bypass_policy_lockout_safety_check field on the resulting object. When null, the bypass_policy_lockout_safety_check field will be omitted from the resulting object.
• deletion_window_in_days (number): Set the deletion_window_in_days field on the resulting object. When null, the deletion_window_in_days field will be omitted from the resulting object.
• description (string): Set the description field on the resulting object. When null, the description field will be omitted from the resulting object.
• enabled (bool): Set the enabled field on the resulting object. When null, the enabled field will be omitted from the resulting object.
• key_material_base64 (string): Set the key_material_base64 field on the resulting object. When null, the key_material_base64 field will be omitted from the resulting object.
• multi_region (bool): Set the multi_region field on the resulting object. When null, the multi_region field will be omitted from the resulting object.
• policy (string): Set the policy field on the resulting object. When null, the policy 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.
• valid_to (string): Set the valid_to field on the resulting object. When null, the valid_to field will be omitted from the resulting object.

Returns:

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

fn withBypassPolicyLockoutSafetyCheck

withBypassPolicyLockoutSafetyCheck()

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

Args:

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

fn withDeletionWindowInDays

withDeletionWindowInDays()

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

Args:

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

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 withEnabled

withEnabled()

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

Args:

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

fn withKeyMaterialBase64

withKeyMaterialBase64()

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

Args:

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

fn withMultiRegion

withMultiRegion()

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

Args:

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

withValidTo()

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

Args:

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