private_connections

Creates, updates, deletes, gets or lists a private_connections resource.

Overview

Name	private_connections
Type	Resource
Id	aws.devops_agent.private_connections

Fields

The following fields are returned by SELECT queries:

describe_private_connection

Name	Datatype	Description
name	string	Unique name for a Private Connection within an account. (pattern: <code>[a-z0-9]([a-z0-9-]*[a-z0-9])?</code>)
certificate_expiry_time	string (date-time)	The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.
dns_resolution	string	DNS resolution mode for the Private Connection's resource gateway. (PUBLIC, IN_VPC)
failure_message	string	Message describing the reason for a failed Private Connection, if applicable.
host_address	string	IP address or DNS name of the target resource. Only present for service-managed Private Connections. (pattern: <code>[a-zA-Z0-9.:-]+</code>)
resource_configuration_id	string	The Resource Configuration ARN. Only present for self-managed Private Connections. (pattern: <code>(arn:[a-z0-9-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}|rcfg-[0-9a-z]{17})</code>)
resource_gateway_id	string	The service-managed Resource Gateway ARN. Only present for service-managed Private Connections. (pattern: <code>arn:[a-z0-9-]+:vpc-lattice:[a-zA-Z0-9-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}</code>)
status	string	The status of the Private Connection. (ACTIVE, CREATE_IN_PROGRESS, CREATE_FAILED, DELETE_IN_PROGRESS, DELETE_FAILED)
tags	object	Tags associated with the Private Connection.
type_	string	The type of the Private Connection. (SELF_MANAGED, SERVICE_MANAGED)
vpc_id	string	VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections. (pattern: <code>vpc-(([0-9a-z]{8})|([0-9a-z]{17}))</code>)

list_private_connections

Name	Datatype	Description
private_connections	array	The list of Private Connections.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_private_connection	select	name, region		Retrieves details of an existing Private Connection.
list_private_connections	select	region		Lists all Private Connections in the caller's account.
create_private_connection	insert	region, name, mode		Creates a Private Connection to a target resource.
update_private_connection_certificate	update	name, region, certificate		Updates the certificate associated with a Private Connection.
delete_private_connection	delete	name, region		Deletes a Private Connection. The deletion is asynchronous and returns DELETE_IN_PROGRESS status.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The name of the Private Connection.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_private_connection

Retrieves details of an existing Private Connection.

SELECT
name,
certificate_expiry_time,
dns_resolution,
failure_message,
host_address,
resource_configuration_id,
resource_gateway_id,
status,
tags,
type_,
vpc_id
FROM aws.devops_agent.private_connections
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_private_connections

Lists all Private Connections in the caller's account.

SELECT
private_connections
FROM aws.devops_agent.private_connections
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_private_connection

Creates a Private Connection to a target resource.

INSERT INTO aws.devops_agent.private_connections (
name,
mode,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ mode }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
name,
certificate_expiry_time,
dns_resolution,
failure_message,
host_address,
resource_configuration_id,
resource_gateway_id,
status,
tags,
type_,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: private_connections
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the private_connections resource.
  - name: name
    value: "{{ name }}"
    description: |
      Unique name for a Private Connection within an account.
  - name: mode
    description: |
      Private Connection mode — either service-managed or self-managed.
    value:
      serviceManaged:
        hostAddress: "{{ hostAddress }}"
        vpcId: "{{ vpcId }}"
        subnetIds:
          - "{{ subnetIds }}"
        securityGroupIds:
          - "{{ securityGroupIds }}"
        ipAddressType: "{{ ipAddressType }}"
        ipv4AddressesPerEni: {{ ipv4AddressesPerEni }}
        portRanges:
          - "{{ portRanges }}"
        certificate: "{{ certificate }}"
        dnsResolution: "{{ dnsResolution }}"
      selfManaged:
        resourceConfigurationId: "{{ resourceConfigurationId }}"
        certificate: "{{ certificate }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Map of tag keys to values.

UPDATE examples

update_private_connection_certificate

Updates the certificate associated with a Private Connection.

UPDATE aws.devops_agent.private_connections
SET 
certificate = '{{ certificate }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
AND certificate = '{{ certificate }}' --required
RETURNING
name,
certificate_expiry_time,
dns_resolution,
failure_message,
host_address,
resource_configuration_id,
resource_gateway_id,
status,
type_,
vpc_id;

DELETE examples

delete_private_connection

Deletes a Private Connection. The deletion is asynchronous and returns DELETE_IN_PROGRESS status.

DELETE FROM aws.devops_agent.private_connections
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
;