elasticache_user.md

permalink
/elasticache_user/

elasticache_user

elasticache_user represents the aws_elasticache_user Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withAccessString()
• fn withAuthenticationMode()
• fn withAuthenticationModeMixin()
• fn withEngine()
• fn withNoPasswordRequired()
• fn withPasswords()
• fn withTags()
• fn withTagsAll()
• fn withTimeouts()
• fn withTimeoutsMixin()
• fn withUserId()
• fn withUserName()
• obj authentication_mode
  • fn new()
• obj timeouts
  • fn new()

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_elasticache_user.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_string (string): Set the access_string field on the resulting resource block.
• engine (string): Set the engine field on the resulting resource block.
• no_password_required (bool): Set the no_password_required field on the resulting resource block. When null, the no_password_required field will be omitted from the resulting object.
• passwords (list): Set the passwords field on the resulting resource block. When null, the passwords 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.
• user_id (string): Set the user_id field on the resulting resource block.
• user_name (string): Set the user_name field on the resulting resource block.
• authentication_mode (list[obj]): Set the authentication_mode field on the resulting resource block. When null, the authentication_mode sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.elasticache_user.authentication_mode.new constructor.
• 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.elasticache_user.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike aws.elasticache_user.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_string (string): Set the access_string field on the resulting object.
• engine (string): Set the engine field on the resulting object.
• no_password_required (bool): Set the no_password_required field on the resulting object. When null, the no_password_required field will be omitted from the resulting object.
• passwords (list): Set the passwords field on the resulting object. When null, the passwords 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.
• user_id (string): Set the user_id field on the resulting object.
• user_name (string): Set the user_name field on the resulting object.
• authentication_mode (list[obj]): Set the authentication_mode field on the resulting object. When null, the authentication_mode sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.elasticache_user.authentication_mode.new constructor.
• 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.elasticache_user.timeouts.new constructor.

Returns:

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

fn withAccessString

withAccessString()

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

Args:

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

fn withAuthenticationMode

withAuthenticationMode()

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

Args:

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

fn withAuthenticationModeMixin

withAuthenticationModeMixin()

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

Args:

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

fn withEngine

withEngine()

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

Args:

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

fn withNoPasswordRequired

withNoPasswordRequired()

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

Args:

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

fn withPasswords

withPasswords()

aws.list.withPasswords constructs a mixin object that can be merged into the list Terraform resource block to set or update the passwords field.

Args:

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

withUserId()

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

Args:

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

fn withUserName

withUserName()

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

Args:

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

obj authentication_mode

fn authentication_mode.new

new()

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

Args:

• passwords (list): Set the passwords field on the resulting object. When null, the passwords field will be omitted from the resulting object.
• type (string): Set the type field on the resulting object.

Returns:

• An attribute object that represents the authentication_mode sub block.

obj timeouts

fn timeouts.new

new()

aws.elasticache_user.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.
• update (string): Set the update field on the resulting object. When null, the update field will be omitted from the resulting object.

Returns:

• An attribute object that represents the timeouts sub block.