Skip to main content
Sponsor @cloudposse

private-link-service

This component provisions AWS VPC Endpoint Services (provider side) to expose YOUR services to external consumers via AWS PrivateLink.

What This Component Does​

You are the PROVIDER - This component creates the infrastructure to expose your services (EKS pods, RDS databases, APIs) to other AWS accounts or VPCs.

Your AWS Account (PROVIDER)              Consumer's AWS Account
┌─────────────────────────────┐         ┌──────────────────────────┐
│ Your Services               │         │ Their Applications       │
│ - EKS pods                  │         │ - Airflow (Astronomer)   │
│ - RDS databases             │         │ - External systems       │
│ - Internal APIs             │         │ - Partner services       │
│         ↓                   │         │         ↑                │
│ Network Load Balancer ──────┼─────────┼─────────┘                │
│         ↓                   │  AWS    │                          │
│ VPC Endpoint Service        │ Private │ VPC Endpoint             │
│ (this component)            │  Link   │ (they create)            │
│ com.amazonaws.vpce...       │         │                          │
└─────────────────────────────┘         └──────────────────────────┘

Key Point: The consumer (e.g., Astronomer) creates a VPC Endpoint in their account that connects to YOUR VPC Endpoint Service. Traffic flows privately over AWS's network, never touching the internet.

Astronomer Integration​

This example shows the full workflow for exposing your EKS services to Astronomer's Airflow cluster via PrivateLink.

Architecture​

Astronomer's AWS Account                    YOUR AWS Account
┌──────────────────────────┐               ┌─────────────────────────────────┐
│ Airflow Workers          │               │ EKS Cluster                     │
│ (run DAGs)               │               │                                 │
│        ↓                 │               │ Pods labeled:                   │
│ VPC Endpoint ────────────┼───Private─────┼→ astronomer: enabled            │
│ (Astronomer creates)     │    Link       │         ↓                       │
│                          │               │ NLB (eks/nlb component)         │
│                          │               │         ↓                       │
│                          │               │ VPC Endpoint Service            │
│                          │               │ (this component)                │
└──────────────────────────┘               └─────────────────────────────────┘

Step 1: Label Your EKS Pods​

First, tag the pods you want to expose to Astronomer:

components:
  terraform:
    eks/echo-server:
      vars:
        # ...
        chart_values:
          labels:
            astronomer: enabled  # ← This label exposes pods to Astronomer

Step 2: Create NLB via AWS Load Balancer Controller​

Deploy an NLB that targets your labeled pods:

components:
  terraform:
    eks/nlb/astronomer:
      metadata:
        component: eks/nlb
      vars:
        enabled: true
        name: "nlb"
        attributes: ["astronomer"]
        # Target pods with the astronomer label
        nlb_selector:
          astronomer: enabled

Step 3: Create VPC Endpoint Service​

Now expose the NLB via PrivateLink:

components:
  terraform:
    private-link-service/astronomer:
      metadata:
        component: private-link-service
      vars:
        enabled: true
        name: "private-link-service"
        attributes: ["astronomer"]

        # Reference the NLB created in Step 2
        vpc_endpoint_service_network_load_balancer_arns:
          - !terraform.output eks/nlb/astronomer nlb_arn

        # Allow Astronomer's AWS account (get from their support)
        vpc_endpoint_service_allowed_principals:
          - "arn:aws:iam::ASTRONOMER-ACCOUNT-ID:role/astronomer-remote-management"

Step 4: Share Service Name with Astronomer​

Get the VPC Endpoint Service name:

vpc_endpoint_service_name = "com.amazonaws.vpce.us-west-2.vpce-svc-0abc123def456789"

Usage​

Stack Level: Regional

Here's an example snippet for how to use this component.

components:
  terraform:
    private-link-service:
      vars:
        enabled: true
        name: "private-link-service"

        vpc_endpoint_service_network_load_balancer_arns:
          - !terraform.output eks/nlb nlb_arn

        # Get customer AWS account ID or role ARN from their support team
        # Example (get from Astronomer support):
        vpc_endpoint_service_allowed_principals:
          - "arn:aws:iam::ASTRONOMER-ACCOUNT-ID:role/astronomer-remote-management"

Variables​

Required Variables​

region (string) required

AWS Region

Optional Variables​

vpc_endpoint_service_acceptance_required (bool) optional

Whether or not VPC endpoint connection requests to the service must be accepted by the service owner


Default value: true

vpc_endpoint_service_allowed_principals (list(string)) optional

List of ARNs of principals allowed to discover the VPC endpoint service


Default value: [ ]

vpc_endpoint_service_gateway_load_balancer_arns (list(string)) optional

List of Gateway Load Balancer ARNs to associate with the VPC endpoint service


Default value: [ ]

vpc_endpoint_service_network_load_balancer_arns (list(string)) optional

List of Network Load Balancer ARNs to associate with the VPC endpoint service


Default value: [ ]

vpc_endpoint_service_private_dns_name (string) optional

Private DNS name for the VPC endpoint service


Default value: null

vpc_endpoint_service_supported_ip_address_types (list(string)) optional

The supported IP address types. Valid values: ipv4, ipv6


Default value:

[
  "ipv4"
]

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​

endpoint_events_sns_topic_arn

The ARN of the SNS topic for endpoint connection events

vpc_endpoint_service_arn

The ARN of the VPC endpoint service

vpc_endpoint_service_id

The ID of the VPC endpoint service

vpc_endpoint_service_name

The service name that consumers use to connect

vpc_endpoint_service_state

The state of the VPC endpoint service

Dependencies​

Requirements​

  • terraform, version: >= 1.0.0
  • aws, version: >= 4.0

Providers​

  • aws, version: >= 4.0

Modules​

NameVersionSourceDescription
iam_roleslatest../account-map/modules/iam-rolesn/a
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: