Skip to content

Latest commit

 

History

History
149 lines (92 loc) · 4.52 KB

dns_record_set.md

File metadata and controls

149 lines (92 loc) · 4.52 KB
Raw
permalink
/data/dns_record_set/

data.dns_record_set

dns_record_set represents the google_dns_record_set Terraform data source.

A DNS record set within Google Cloud DNS

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

Index

Fields

fn new

new()

google.data.dns_record_set.new injects a new data_google_dns_record_set 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
google.data.dns_record_set.new('some_id')

You can get the reference to the id field of the created google.data.dns_record_set using the reference:

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

This is the same as directly entering "${ data_google_dns_record_set.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.
  • managed_zone (string): The Name of the zone.
  • name (string): The DNS name for the resource.
  • project (string): The ID of the project for the Google Cloud. When null, the project field will be omitted from the resulting object.
  • type (string): The identifier of a supported record type. See the list of Supported DNS record types.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike google.data.dns_record_set.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:

  • managed_zone (string): The Name of the zone.
  • name (string): The DNS name for the resource.
  • project (string): The ID of the project for the Google Cloud. When null, the project field will be omitted from the resulting object.
  • type (string): The identifier of a supported record type. See the list of Supported DNS record types.

Returns:

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

fn withManagedZone

withManagedZone()

google.string.withManagedZone constructs a mixin object that can be merged into the string Terraform data source block to set or update the managed_zone field.

Args:

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

fn withName

withName()

google.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 withProject

withProject()

google.string.withProject constructs a mixin object that can be merged into the string Terraform data source block to set or update the project field.

Args:

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

fn withType

withType()

google.string.withType constructs a mixin object that can be merged into the string Terraform data source block to set or update the type field.

Args:

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