connection

This component provisions Glue connections.

Usage

Stack Level: Regional

components:
  terraform:
    glue/connection/example/redshift:
      metadata:
        component: glue/connection
      vars:
        connection_name: "jdbc-redshift"
        connection_description: "Glue Connection for Redshift"
        connection_type: "JDBC"
        db_type: "redshift"
        connection_db_name: "analytics"
        ssm_path_username: "/glue/redshift/admin_user"
        ssm_path_password: "/glue/redshift/admin_password"
        ssm_path_endpoint: "/glue/redshift/endpoint"
        physical_connection_enabled: true
        vpc_component_name: "vpc"

Variables

Required Variables

connection_type (string) required: The type of the connection. Supported are: JDBC, MONGODB, KAFKA, and NETWORK. Defaults to JDBC
region (string) required: AWS Region
vpc_component_name (string) required: VPC component name

Optional Variables

catalog_id (string) optional

The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default

Default value: null

connection_db_name (string) optional

Database name that the Glue connector will reference

Default value: null

connection_description (string) optional

Connection description

Default value: null

connection_name (string) optional

Connection name. If not provided, the name will be generated from the context

Default value: null

connection_properties (map(string)) optional

A map of key-value pairs used as parameters for this connection

Default value: null

db_type (string) optional

Database type for the connection URL: postgres or redshift

Default value: "redshift"

match_criteria (list(string)) optional

A list of criteria that can be used in selecting this connection

Default value: null

physical_connection_enabled (bool) optional

Flag to enable/disable physical connection

Default value: false

security_group_allow_all_egress (bool) optional

A convenience that adds to the rules a rule that allows all egress.
If this is false and no egress rules are specified via rules or rule-matrix, then no egress will be allowed.

Default value: true

security_group_create_before_destroy (bool) optional

Set true to enable terraform create_before_destroy behavior on the created security group.
We only recommend setting this false if you are importing an existing security group
that you do not want replaced and therefore need full control over its name.
Note that changing this value will always cause the security group to be replaced.

Default value: true

security_group_ingress_cidr_blocks (list(string)) optional

A list of CIDR blocks for the the cluster Security Group to allow ingress to the cluster security group

Default value: [ ]

security_group_ingress_from_port (number) optional

Start port on which the Glue connection accepts incoming connections

Default value: 0

security_group_ingress_to_port (number) optional

End port on which the Glue connection accepts incoming connections

Default value: 0

ssm_path_endpoint (string) optional

Database endpoint SSM path

Default value: null

ssm_path_password (string) optional

Database password SSM path

Default value: null

ssm_path_username (string) optional

Database username SSM path

Default value: null

target_security_group_rules (list(any)) optional

Additional Security Group rules that allow Glue to communicate with the target database

Default value: [ ]

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

connection_arn: Glue connection ARN
connection_id: Glue connection ID
connection_name: Glue connection name
security_group_arn: The ARN of the Security Group associated with the Glue connection
security_group_id: The ID of the Security Group associated with the Glue connection
security_group_name: The name of the Security Group and associated with the Glue connection

Dependencies

Requirements

terraform, version: >= 1.3.0
aws, version: >= 4.0
utils, version: >= 1.15.0

Providers

aws, version: >= 4.0

Modules

Name	Version	Source	Description
`glue_connection`	0.4.0	`cloudposse/glue/aws//modules/glue-connection`	n/a
`iam_roles`	latest	`../../account-map/modules/iam-roles`	n/a
`security_group`	2.2.0	`cloudposse/security-group/aws`	n/a
`target_security_group`	2.2.0	`cloudposse/security-group/aws`	This allows adding the necessary Security Group rules for Glue to communicate with Redshift
`this`	0.25.0	`cloudposse/label/null`	n/a
`vpc`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a

Resources

The following resources are used by this module:

Data Sources

The following data sources are used by this module:

aws_ssm_parameter.endpoint (data source)
aws_ssm_parameter.password (data source)
aws_ssm_parameter.user (data source)
aws_subnet.selected (data source)

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

References​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

References