directory_service_region.md

permalink
/directory_service_region/

directory_service_region

directory_service_region represents the aws_directory_service_region Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withDesiredNumberOfDomainControllers()
• fn withDirectoryId()
• fn withRegionName()
• fn withTags()
• fn withTagsAll()
• fn withTimeouts()
• fn withTimeoutsMixin()
• fn withVpcSettings()
• fn withVpcSettingsMixin()
• obj timeouts
  • fn new()
• obj vpc_settings
  • fn new()

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_directory_service_region.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.
• desired_number_of_domain_controllers (number): Set the desired_number_of_domain_controllers field on the resulting resource block. When null, the desired_number_of_domain_controllers field will be omitted from the resulting object.
• directory_id (string): Set the directory_id field on the resulting resource block.
• region_name (string): Set the region_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.
• 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.directory_service_region.timeouts.new constructor.
• vpc_settings (list[obj]): Set the vpc_settings field on the resulting resource block. When null, the vpc_settings sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.directory_service_region.vpc_settings.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

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

• desired_number_of_domain_controllers (number): Set the desired_number_of_domain_controllers field on the resulting object. When null, the desired_number_of_domain_controllers field will be omitted from the resulting object.
• directory_id (string): Set the directory_id field on the resulting object.
• region_name (string): Set the region_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.
• 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.directory_service_region.timeouts.new constructor.
• vpc_settings (list[obj]): Set the vpc_settings field on the resulting object. When null, the vpc_settings sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.directory_service_region.vpc_settings.new constructor.

Returns:

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

fn withDesiredNumberOfDomainControllers

withDesiredNumberOfDomainControllers()

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

Args:

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

fn withDirectoryId

withDirectoryId()

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

Args:

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

fn withRegionName

withRegionName()

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

Args:

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

withVpcSettings()

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

Args:

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

fn withVpcSettingsMixin

withVpcSettingsMixin()

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

Args:

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

obj timeouts

fn timeouts.new

new()

aws.directory_service_region.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.

obj vpc_settings

fn vpc_settings.new

new()

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

Args:

• subnet_ids (list): Set the subnet_ids field on the resulting object.
• vpc_id (string): Set the vpc_id field on the resulting object.

Returns:

• An attribute object that represents the vpc_settings sub block.