Skip to content

Latest commit

 

History

History
168 lines (103 loc) · 5.82 KB

service.md

File metadata and controls

168 lines (103 loc) · 5.82 KB
Raw
permalink
/data/service/

data.service

service represents the aws_service 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.service.new injects a new data_aws_service 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.service.new('some_id')

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

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

This is the same as directly entering "${ data_aws_service.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.
  • dns_name (string): Set the dns_name field on the resulting data source block. When null, the dns_name field will be omitted from the resulting object.
  • region (string): Set the region field on the resulting data source block. When null, the region field will be omitted from the resulting object.
  • reverse_dns_name (string): Set the reverse_dns_name field on the resulting data source block. When null, the reverse_dns_name field will be omitted from the resulting object.
  • reverse_dns_prefix (string): Set the reverse_dns_prefix field on the resulting data source block. When null, the reverse_dns_prefix field will be omitted from the resulting object.
  • service_id (string): Set the service_id field on the resulting data source block. When null, the service_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.service.newAttrs constructs a new object with attributes and blocks configured for the service Terraform data source.

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

  • dns_name (string): Set the dns_name field on the resulting object. When null, the dns_name field will be omitted from the resulting object.
  • region (string): Set the region field on the resulting object. When null, the region field will be omitted from the resulting object.
  • reverse_dns_name (string): Set the reverse_dns_name field on the resulting object. When null, the reverse_dns_name field will be omitted from the resulting object.
  • reverse_dns_prefix (string): Set the reverse_dns_prefix field on the resulting object. When null, the reverse_dns_prefix field will be omitted from the resulting object.
  • service_id (string): Set the service_id field on the resulting object. When null, the service_id field will be omitted from the resulting object.

Returns:

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

fn withDnsName

withDnsName()

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

Args:

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

fn withRegion

withRegion()

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

Args:

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

fn withReverseDnsName

withReverseDnsName()

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

Args:

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

fn withReverseDnsPrefix

withReverseDnsPrefix()

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

Args:

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

fn withServiceId

withServiceId()

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

Args:

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