private_connectivity_configs

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

Overview

Name	private_connectivity_configs
Type	Resource
Id	aws.outposts.private_connectivity_configs

Fields

The following fields are returned by SELECT queries:

get_private_connectivity_config

Name	Datatype	Description
private_connectivity_status	string	The status of private connectivity for the Outpost. Valid values are ENABLED and DISABLED. (ENABLED, DISABLED)
provisioning_role_arn	string	The Amazon Resource Name (ARN) of the provisioning role in your account that Amazon Web Services Outposts uses to establish the service link connection during Outpost installation. This field is present only when VPC endpoint-based provisioning is configured. (pattern: <code>^arn:aws([a-z-]+)?:iam::\d{12}:role/[a-zA-Z_0-9+=,.@-_/]+</code>)
role_arn	string	The Amazon Resource Name (ARN) of the service-linked role that Amazon Web Services Outposts creates and uses to provision and attach the network interfaces for private connectivity in your VPC. The role's permissions are scoped to the specific Outpost and VPC. (pattern: <code>^arn:aws([a-z-]+)?:iam::\d{12}:role/[a-zA-Z_0-9+=,.@-_/]+</code>)
vpc_information_list	array	Information about the VPC used for private connectivity.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_private_connectivity_config	select	outpost_id, region		Gets the private connectivity configuration for the specified Outpost.
create_private_connectivity_config	insert	outpost_id, region, VpcInformationList		Creates the private connectivity configuration for the specified Outpost. Private connectivity establishes a service link VPN connection between the Outpost and its home Amazon Web Services Region using a VPC and subnet that you specify, which allows the service link traffic to flow through your VPC and minimizes public internet exposure.

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
outpost_id	string	The ID or ARN of the Outpost.
region	string	AWS region (default: us-east-1)

SELECT examples

get_private_connectivity_config

Gets the private connectivity configuration for the specified Outpost.

SELECT
private_connectivity_status,
provisioning_role_arn,
role_arn,
vpc_information_list
FROM aws.outposts.private_connectivity_configs
WHERE outpost_id = '{{ outpost_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_private_connectivity_config

Creates the private connectivity configuration for the specified Outpost. Private connectivity establishes a service link VPN connection between the Outpost and its home Amazon Web Services Region using a VPC and subnet that you specify, which allows the service link traffic to flow through your VPC and minimizes public internet exposure.

INSERT INTO aws.outposts.private_connectivity_configs (
VpcInformationList,
outpost_id,
region
)
SELECT 
'{{ VpcInformationList }}' /* required */,
'{{ outpost_id }}',
'{{ region }}'
RETURNING
outpost_id,
private_connectivity_config
;

Manifest

# Description fields are for documentation purposes
- name: private_connectivity_configs
props:
  - name: outpost_id
    value: "{{ outpost_id }}"
    description: Required parameter for the private_connectivity_configs resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the private_connectivity_configs resource.
  - name: VpcInformationList
    value:
      - VpcId: "{{ VpcId }}"
        SubnetIds: "{{ SubnetIds }}"
        VpcEndpointId: "{{ VpcEndpointId }}"