canonical_user_id.md

permalink
/data/canonical_user_id/

data.canonical_user_id

canonical_user_id represents the aws_canonical_user_id Terraform data source.

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

Index

• fn new()
• fn newAttrs()

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ data_aws_canonical_user_id.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.

Returns:

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

fn newAttrs

newAttrs()

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

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

Returns:

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