Skip to content

Latest commit

 

History

History
149 lines (91 loc) · 4.87 KB

outposts_outpost.md

File metadata and controls

149 lines (91 loc) · 4.87 KB
Raw
permalink
/data/outposts_outpost/

data.outposts_outpost

outposts_outpost represents the aws_outposts_outpost 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.outposts_outpost.new injects a new data_aws_outposts_outpost 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.outposts_outpost.new('some_id')

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

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

This is the same as directly entering "${ data_aws_outposts_outpost.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.
  • arn (string): Set the arn field on the resulting data source block. When null, the arn field will be omitted from the resulting object.
  • name (string): Set the name field on the resulting data source block. When null, the name field will be omitted from the resulting object.
  • owner_id (string): Set the owner_id field on the resulting data source block. When null, the owner_id 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.

Returns:

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

fn newAttrs

newAttrs()

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

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

  • arn (string): Set the arn field on the resulting object. When null, the arn field will be omitted from the resulting object.
  • name (string): Set the name field on the resulting object. When null, the name field will be omitted from the resulting object.
  • owner_id (string): Set the owner_id field on the resulting object. When null, the owner_id 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.

Returns:

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

fn withArn

withArn()

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

Args:

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

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 withOwnerId

withOwnerId()

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

Args:

  • dataSrcLabel (string): The name label of the block to update.
  • value (string): The value to set for the owner_id 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.