private_connections

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

Overview

Name	private_connections
Type	Resource
Id	aws.securityagent.private_connections

Fields

The following fields are returned by SELECT queries:

describe_private_connection

Name	Datatype	Description
name	string	The unique name of a private connection within your account.
certificate_expiry_time	string (date-time)	The date and time the connection's certificate expires, in UTC format.
dns_resolution	string	The DNS resolution mode for the resource gateway. (PUBLIC, IN_VPC)
failure_message	string	A message describing why the private connection entered a failed state, if applicable.
host_address	string	The IP address or DNS name of the target resource.
resource_configuration_id	string	The identifier or ARN of the VPC Lattice resource configuration.
resource_gateway_id	string	The identifier or ARN of the VPC Lattice resource gateway.
status	string	The current status of the private connection. (ACTIVE, CREATE_IN_PROGRESS, CREATE_FAILED, DELETE_IN_PROGRESS, DELETE_FAILED)
tags	object	The tags attached to the private connection.
type_	string	The type of the private connection, indicating whether it is service-managed or self-managed. (SERVICE_MANAGED, SELF_MANAGED)
vpc_id	string	The identifier of the VPC the resource gateway is created in.

list_private_connections

Name	Datatype	Description
name	string	The unique name of a private connection within your account.
certificate_expiry_time	string (date-time)	The date and time the connection's certificate expires, in UTC format.
dns_resolution	string	The DNS resolution mode for the resource gateway. (PUBLIC, IN_VPC)
failure_message	string	A message describing why the private connection entered a failed state, if applicable.
host_address	string	The IP address or DNS name of the target resource.
resource_configuration_id	string	The identifier or ARN of the VPC Lattice resource configuration.
resource_gateway_id	string	The identifier or ARN of the VPC Lattice resource gateway.
status	string	The current status of the private connection. (ACTIVE, CREATE_IN_PROGRESS, CREATE_FAILED, DELETE_IN_PROGRESS, DELETE_FAILED)
tags	object	The tags attached to the private connection.
type_	string	The type of the private connection, indicating whether it is service-managed or self-managed. (SERVICE_MANAGED, SELF_MANAGED)
vpc_id	string	The identifier of the VPC the resource gateway is created in.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_private_connection	select	region		Retrieves the details of a private connection.
list_private_connections	select	region		Lists the private connections in your account.
create_private_connection	insert	region, privateConnectionName, mode		Creates a private connection for reaching a self-hosted provider instance over private networking using Amazon VPC Lattice.
update_private_connection_certificate	update	region, privateConnectionName, certificate		Updates the certificate associated with a private connection. Certificates can be added or replaced but not removed.
delete_private_connection	delete	region		Deletes a private connection.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_private_connection

Retrieves the details of a 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.securityagent.private_connections
WHERE region = '{{ region }}' -- required
;

list_private_connections

Lists the private connections in your account.

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

INSERT examples

create_private_connection

Creates a private connection for reaching a self-hosted provider instance over private networking using Amazon VPC Lattice.

INSERT INTO aws.securityagent.private_connections (
privateConnectionName,
mode,
tags,
region
)
SELECT 
'{{ privateConnectionName }}' /* 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: privateConnectionName
    value: "{{ privateConnectionName }}"
    description: |
      The unique name of a private connection within your account.
  - name: mode
    description: |
      The configuration for a private connection. Specify either a service-managed or a self-managed mode.
    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 tags for a resource.

UPDATE examples

update_private_connection_certificate

Updates the certificate associated with a private connection. Certificates can be added or replaced but not removed.

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

DELETE examples

delete_private_connection

Deletes a private connection.

DELETE FROM aws.securityagent.private_connections
WHERE region = '{{ region }}' --required
;