Skip to content

Latest commit

 

History

History
187 lines (115 loc) · 6.46 KB

route53_zone.md

File metadata and controls

187 lines (115 loc) · 6.46 KB
Raw
permalink
/data/route53_zone/

data.route53_zone

route53_zone represents the aws_route53_zone Terraform data source.

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

Index

Fields

fn new

new()

aws.data.route53_zone.new injects a new data_aws_route53_zone 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.route53_zone.new('some_id')

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

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

This is the same as directly entering "${ data_aws_route53_zone.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.
  • name (string): Set the name field on the resulting data source block. When null, the name field will be omitted from the resulting object.
  • private_zone (bool): Set the private_zone field on the resulting data source block. When null, the private_zone field will be omitted from the resulting object.
  • resource_record_set_count (number): Set the resource_record_set_count field on the resulting data source block. When null, the resource_record_set_count field will be omitted from the resulting object.
  • tags (obj): Set the tags field on the resulting data source block. When null, the tags field will be omitted from the resulting object.
  • vpc_id (string): Set the vpc_id field on the resulting data source block. When null, the vpc_id field will be omitted from the resulting object.
  • zone_id (string): Set the zone_id field on the resulting data source block. When null, the zone_id field will be omitted from the resulting object.

Returns:

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

fn newAttrs

newAttrs()

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

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

  • name (string): Set the name field on the resulting object. When null, the name field will be omitted from the resulting object.
  • private_zone (bool): Set the private_zone field on the resulting object. When null, the private_zone field will be omitted from the resulting object.
  • resource_record_set_count (number): Set the resource_record_set_count field on the resulting object. When null, the resource_record_set_count 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.
  • vpc_id (string): Set the vpc_id field on the resulting object. When null, the vpc_id field will be omitted from the resulting object.
  • zone_id (string): Set the zone_id field on the resulting object. When null, the zone_id field will be omitted from the resulting object.

Returns:

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

fn withName

withName()

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

Args:

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

fn withPrivateZone

withPrivateZone()

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

Args:

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

fn withResourceRecordSetCount

withResourceRecordSetCount()

aws.number.withResourceRecordSetCount constructs a mixin object that can be merged into the number Terraform data source block to set or update the resource_record_set_count field.

Args:

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

fn withTags

withTags()

aws.obj.withTags constructs a mixin object that can be merged into the obj Terraform data source block to set or update the tags field.

Args:

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

fn withVpcId

withVpcId()

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

Args:

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

fn withZoneId

withZoneId()

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

Args:

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