Skip to content

Latest commit

 

History

History
130 lines (79 loc) · 4.3 KB

quicksight_group.md

File metadata and controls

130 lines (79 loc) · 4.3 KB
Raw
permalink
/data/quicksight_group/

data.quicksight_group

quicksight_group represents the aws_quicksight_group 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.quicksight_group.new injects a new data_aws_quicksight_group 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.quicksight_group.new('some_id')

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

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

This is the same as directly entering "${ data_aws_quicksight_group.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.
  • aws_account_id (string): Set the aws_account_id field on the resulting data source block. When null, the aws_account_id field will be omitted from the resulting object.
  • group_name (string): Set the group_name field on the resulting data source block.
  • namespace (string): Set the namespace field on the resulting data source block. When null, the namespace 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.quicksight_group.newAttrs constructs a new object with attributes and blocks configured for the quicksight_group Terraform data source.

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

  • aws_account_id (string): Set the aws_account_id field on the resulting object. When null, the aws_account_id field will be omitted from the resulting object.
  • group_name (string): Set the group_name field on the resulting object.
  • namespace (string): Set the namespace field on the resulting object. When null, the namespace field will be omitted from the resulting object.

Returns:

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

fn withAwsAccountId

withAwsAccountId()

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

Args:

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

fn withGroupName

withGroupName()

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

Args:

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

fn withNamespace

withNamespace()

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

Args:

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