glue_script.md

permalink
/data/glue_script/

data.glue_script

glue_script represents the aws_glue_script Terraform data source.

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

Index

• fn new()
• fn newAttrs()
• fn withDagEdge()
• fn withDagEdgeMixin()
• fn withDagNode()
• fn withDagNodeMixin()
• fn withLanguage()
• obj dag_edge
  • fn new()
• obj dag_node
  • fn new()
  • obj dag_node.args
    • fn new()

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ data_aws_glue_script.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.
• language (string): Set the language field on the resulting data source block. When null, the language field will be omitted from the resulting object.
• dag_edge (list[obj]): Set the dag_edge field on the resulting data source block. When null, the dag_edge sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.data.glue_script.dag_edge.new constructor.
• dag_node (list[obj]): Set the dag_node field on the resulting data source block. When null, the dag_node sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.data.glue_script.dag_node.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

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

• language (string): Set the language field on the resulting object. When null, the language field will be omitted from the resulting object.
• dag_edge (list[obj]): Set the dag_edge field on the resulting object. When null, the dag_edge sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.data.glue_script.dag_edge.new constructor.
• dag_node (list[obj]): Set the dag_node field on the resulting object. When null, the dag_node sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.data.glue_script.dag_node.new constructor.

Returns:

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

fn withDagEdge

withDagEdge()

aws.list[obj].withDagEdge constructs a mixin object that can be merged into the list[obj] Terraform data source block to set or update the dag_edge field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withDagEdgeMixin function.

Args:

• dataSrcLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the dag_edge field.

fn withDagEdgeMixin

withDagEdgeMixin()

aws.list[obj].withDagEdgeMixin constructs a mixin object that can be merged into the list[obj] Terraform data source block to set or update the dag_edge field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withDagEdge function.

Args:

• dataSrcLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the dag_edge field.

fn withDagNode

withDagNode()

aws.list[obj].withDagNode constructs a mixin object that can be merged into the list[obj] Terraform data source block to set or update the dag_node field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withDagNodeMixin function.

Args:

• dataSrcLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the dag_node field.

fn withDagNodeMixin

withDagNodeMixin()

aws.list[obj].withDagNodeMixin constructs a mixin object that can be merged into the list[obj] Terraform data source block to set or update the dag_node field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withDagNode function.

Args:

• dataSrcLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the dag_node field.

fn withLanguage

withLanguage()

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

Args:

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

obj dag_edge

fn dag_edge.new

new()

aws.glue_script.dag_edge.new constructs a new object with attributes and blocks configured for the dag_edge Terraform sub block.

Args:

• source (string): Set the source field on the resulting object.
• target (string): Set the target field on the resulting object.
• target_parameter (string): Set the target_parameter field on the resulting object. When null, the target_parameter field will be omitted from the resulting object.

Returns:

• An attribute object that represents the dag_edge sub block.

obj dag_node

fn dag_node.new

new()

aws.glue_script.dag_node.new constructs a new object with attributes and blocks configured for the dag_node Terraform sub block.

Args:

• line_number (number): Set the line_number field on the resulting object. When null, the line_number field will be omitted from the resulting object.
• node_type (string): Set the node_type field on the resulting object.
• args (list[obj]): Set the args field on the resulting object. When null, the args sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.glue_script.dag_node.args.new constructor.

Returns:

• An attribute object that represents the dag_node sub block.

obj dag_node.args

fn dag_node.args.new

new()

aws.glue_script.dag_node.args.new constructs a new object with attributes and blocks configured for the args Terraform sub block.

Args:

• name (string): Set the name field on the resulting object.
• param (bool): Set the param field on the resulting object. When null, the param field will be omitted from the resulting object.
• value (string): Set the value field on the resulting object.

Returns:

• An attribute object that represents the args sub block.