availability_zones.md

permalink
/data/availability_zones/

data.availability_zones

availability_zones represents the aws_availability_zones Terraform data source.

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

Index

• fn new()
• fn newAttrs()
• fn withAllAvailabilityZones()
• fn withExcludeNames()
• fn withExcludeZoneIds()
• fn withFilter()
• fn withFilterMixin()
• fn withState()
• fn withTimeouts()
• fn withTimeoutsMixin()
• obj filter
  • fn new()
• obj timeouts
  • fn new()

Fields

fn new

new()

aws.data.availability_zones.new injects a new data_aws_availability_zones Terraform data source 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.data.availability_zones.new('some_id')

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

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

This is the same as directly entering "${ data_aws_availability_zones.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:

• dataSrcLabel (string): The name label of the block.
• all_availability_zones (bool): Set the all_availability_zones field on the resulting data source block. When null, the all_availability_zones field will be omitted from the resulting object.
• exclude_names (list): Set the exclude_names field on the resulting data source block. When null, the exclude_names field will be omitted from the resulting object.
• exclude_zone_ids (list): Set the exclude_zone_ids field on the resulting data source block. When null, the exclude_zone_ids field will be omitted from the resulting object.
• state (string): Set the state field on the resulting data source block. When null, the state field will be omitted from the resulting object.
• filter (list[obj]): Set the filter field on the resulting data source block. When null, the filter sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.data.availability_zones.filter.new constructor.
• timeouts (obj): Set the timeouts field on the resulting data source 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.data.availability_zones.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

aws.data.availability_zones.newAttrs constructs a new object with attributes and blocks configured for the availability_zones Terraform data source.

Unlike aws.data.availability_zones.new, this function will not inject the data source block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withData 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:

• all_availability_zones (bool): Set the all_availability_zones field on the resulting object. When null, the all_availability_zones field will be omitted from the resulting object.
• exclude_names (list): Set the exclude_names field on the resulting object. When null, the exclude_names field will be omitted from the resulting object.
• exclude_zone_ids (list): Set the exclude_zone_ids field on the resulting object. When null, the exclude_zone_ids field will be omitted from the resulting object.
• state (string): Set the state field on the resulting object. When null, the state field will be omitted from the resulting object.
• filter (list[obj]): Set the filter field on the resulting object. When null, the filter sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.data.availability_zones.filter.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.data.availability_zones.timeouts.new constructor.

Returns:

• An attribute object that can be used with tf.withData to construct a new availability_zones data source into the root Terraform configuration.

fn withAllAvailabilityZones

withAllAvailabilityZones()

aws.bool.withAllAvailabilityZones constructs a mixin object that can be merged into the bool Terraform data source block to set or update the all_availability_zones field.

Args:

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

fn withExcludeNames

withExcludeNames()

aws.list.withExcludeNames constructs a mixin object that can be merged into the list Terraform data source block to set or update the exclude_names field.

Args:

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

fn withExcludeZoneIds

withExcludeZoneIds()

aws.list.withExcludeZoneIds constructs a mixin object that can be merged into the list Terraform data source block to set or update the exclude_zone_ids field.

Args:

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

fn withFilter

withFilter()

aws.list[obj].withFilter constructs a mixin object that can be merged into the list[obj] Terraform data source block to set or update the filter 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].withFilterMixin function.

Args:

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

fn withFilterMixin

withFilterMixin()

aws.list[obj].withFilterMixin constructs a mixin object that can be merged into the list[obj] Terraform data source block to set or update the filter 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].withFilter function.

Args:

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

fn withState

withState()

aws.string.withState constructs a mixin object that can be merged into the string Terraform data source block to set or update the state field.

Args:

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

fn withTimeouts

withTimeouts()

aws.obj.withTimeouts constructs a mixin object that can be merged into the obj Terraform data source 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:

• dataSrcLabel (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 data source 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:

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

obj filter

fn filter.new

new()

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

Args:

• name (string): Set the name field on the resulting object.
• values (list): Set the values field on the resulting object.

Returns:

• An attribute object that represents the filter sub block.

obj timeouts

fn timeouts.new

new()

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

Args:

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

Returns:

• An attribute object that represents the timeouts sub block.