glue_connection.md

permalink
/glue_connection/

glue_connection

glue_connection represents the aws_glue_connection Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withCatalogId()
• fn withConnectionProperties()
• fn withConnectionType()
• fn withDescription()
• fn withMatchCriteria()
• fn withName()
• fn withPhysicalConnectionRequirements()
• fn withPhysicalConnectionRequirementsMixin()
• fn withTags()
• fn withTagsAll()
• obj physical_connection_requirements
  • fn new()

Fields

fn new

new()

aws.glue_connection.new injects a new aws_glue_connection Terraform resource 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.glue_connection.new('some_id')

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

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

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

• resourceLabel (string): The name label of the block.
• catalog_id (string): Set the catalog_id field on the resulting resource block. When null, the catalog_id field will be omitted from the resulting object.
• connection_properties (obj): Set the connection_properties field on the resulting resource block. When null, the connection_properties field will be omitted from the resulting object.
• connection_type (string): Set the connection_type field on the resulting resource block. When null, the connection_type field will be omitted from the resulting object.
• description (string): Set the description field on the resulting resource block. When null, the description field will be omitted from the resulting object.
• match_criteria (list): Set the match_criteria field on the resulting resource block. When null, the match_criteria field will be omitted from the resulting object.
• name (string): Set the name field on the resulting resource block.
• tags (obj): Set the tags field on the resulting resource block. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting resource block. When null, the tags_all field will be omitted from the resulting object.
• physical_connection_requirements (list[obj]): Set the physical_connection_requirements field on the resulting resource block. When null, the physical_connection_requirements 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_connection.physical_connection_requirements.new constructor.

Returns:

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

fn newAttrs

newAttrs()

aws.glue_connection.newAttrs constructs a new object with attributes and blocks configured for the glue_connection Terraform resource.

Unlike aws.glue_connection.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource 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:

• catalog_id (string): Set the catalog_id field on the resulting object. When null, the catalog_id field will be omitted from the resulting object.
• connection_properties (obj): Set the connection_properties field on the resulting object. When null, the connection_properties field will be omitted from the resulting object.
• connection_type (string): Set the connection_type field on the resulting object. When null, the connection_type field will be omitted from the resulting object.
• description (string): Set the description field on the resulting object. When null, the description field will be omitted from the resulting object.
• match_criteria (list): Set the match_criteria field on the resulting object. When null, the match_criteria field will be omitted from the resulting object.
• name (string): Set the name field on 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.
• tags_all (obj): Set the tags_all field on the resulting object. When null, the tags_all field will be omitted from the resulting object.
• physical_connection_requirements (list[obj]): Set the physical_connection_requirements field on the resulting object. When null, the physical_connection_requirements 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_connection.physical_connection_requirements.new constructor.

Returns:

• An attribute object that can be used with tf.withResource to construct a new glue_connection resource into the root Terraform configuration.

fn withCatalogId

withCatalogId()

aws.string.withCatalogId constructs a mixin object that can be merged into the string Terraform resource block to set or update the catalog_id field.

Args:

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

fn withConnectionProperties

withConnectionProperties()

aws.obj.withConnectionProperties constructs a mixin object that can be merged into the obj Terraform resource block to set or update the connection_properties field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the connection_properties field.

fn withConnectionType

withConnectionType()

aws.string.withConnectionType constructs a mixin object that can be merged into the string Terraform resource block to set or update the connection_type field.

Args:

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

fn withDescription

withDescription()

aws.string.withDescription constructs a mixin object that can be merged into the string Terraform resource block to set or update the description field.

Args:

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

fn withMatchCriteria

withMatchCriteria()

aws.list.withMatchCriteria constructs a mixin object that can be merged into the list Terraform resource block to set or update the match_criteria field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list): The value to set for the match_criteria field.

fn withName

withName()

aws.string.withName constructs a mixin object that can be merged into the string Terraform resource block to set or update the name field.

Args:

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

fn withPhysicalConnectionRequirements

withPhysicalConnectionRequirements()

aws.list[obj].withPhysicalConnectionRequirements constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the physical_connection_requirements 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].withPhysicalConnectionRequirementsMixin function.

Args:

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

fn withPhysicalConnectionRequirementsMixin

withPhysicalConnectionRequirementsMixin()

aws.list[obj].withPhysicalConnectionRequirementsMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the physical_connection_requirements 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].withPhysicalConnectionRequirements function.

Args:

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

fn withTags

withTags()

aws.obj.withTags constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags field.

fn withTagsAll

withTagsAll()

aws.obj.withTagsAll constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags_all field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags_all field.

obj physical_connection_requirements

fn physical_connection_requirements.new

new()

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

Args:

• availability_zone (string): Set the availability_zone field on the resulting object. When null, the availability_zone field will be omitted from the resulting object.
• security_group_id_list (list): Set the security_group_id_list field on the resulting object. When null, the security_group_id_list field will be omitted from the resulting object.
• subnet_id (string): Set the subnet_id field on the resulting object. When null, the subnet_id field will be omitted from the resulting object.

Returns:

• An attribute object that represents the physical_connection_requirements sub block.