Skip to content

Latest commit

 

History

History
214 lines (131 loc) · 7.45 KB

public_ips.md

File metadata and controls

214 lines (131 loc) · 7.45 KB
Raw
permalink
/data/public_ips/

data.public_ips

public_ips represents the azurerm_public_ips Terraform data source.

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

Index

Fields

fn new

new()

azurerm.data.public_ips.new injects a new data_azurerm_public_ips 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
azurerm.data.public_ips.new('some_id')

You can get the reference to the id field of the created azurerm.data.public_ips using the reference:

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

This is the same as directly entering "${ data_azurerm_public_ips.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.
  • allocation_type (string): Set the allocation_type field on the resulting data source block. When null, the allocation_type field will be omitted from the resulting object.
  • attachment_status (string): Set the attachment_status field on the resulting data source block. When null, the attachment_status field will be omitted from the resulting object.
  • name_prefix (string): Set the name_prefix field on the resulting data source block. When null, the name_prefix field will be omitted from the resulting object.
  • resource_group_name (string): Set the resource_group_name field on the resulting data source block.
  • 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 azurerm.data.public_ips.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike azurerm.data.public_ips.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:

  • allocation_type (string): Set the allocation_type field on the resulting object. When null, the allocation_type field will be omitted from the resulting object.
  • attachment_status (string): Set the attachment_status field on the resulting object. When null, the attachment_status field will be omitted from the resulting object.
  • name_prefix (string): Set the name_prefix field on the resulting object. When null, the name_prefix field will be omitted from the resulting object.
  • resource_group_name (string): Set the resource_group_name field on 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 azurerm.data.public_ips.timeouts.new constructor.

Returns:

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

fn withAllocationType

withAllocationType()

azurerm.string.withAllocationType constructs a mixin object that can be merged into the string Terraform data source block to set or update the allocation_type field.

Args:

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

fn withAttachmentStatus

withAttachmentStatus()

azurerm.string.withAttachmentStatus constructs a mixin object that can be merged into the string Terraform data source block to set or update the attachment_status field.

Args:

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

fn withNamePrefix

withNamePrefix()

azurerm.string.withNamePrefix constructs a mixin object that can be merged into the string Terraform data source block to set or update the name_prefix field.

Args:

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

fn withResourceGroupName

withResourceGroupName()

azurerm.string.withResourceGroupName constructs a mixin object that can be merged into the string Terraform data source block to set or update the resource_group_name field.

Args:

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

fn withTimeouts

withTimeouts()

azurerm.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 azurerm.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()

azurerm.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 azurerm.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 timeouts

fn timeouts.new

new()

azurerm.public_ips.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.