Skip to main content

connections

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

Overview

Nameconnections
TypeResource
Idaws.outposts.connections

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
connection_detailsobjectInformation about the connection.
connection_idstringThe ID of the connection. (pattern: <code>^[a-zA-Z0-9+/=]{1,1024}$</code>)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_connectionselectconnection_id, regionAmazon Web Services uses this action to install Outpost servers. Gets information about the specified connection. Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

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.

NameDatatypeDescription
connection_idstringThe ID of the connection.
regionstringAWS region (default: us-east-1)

SELECT examples

Amazon Web Services uses this action to install Outpost servers. Gets information about the specified connection. Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

SELECT
connection_details,
connection_id
FROM aws.outposts.connections
WHERE connection_id = '{{ connection_id }}' -- required
AND region = '{{ region }}' -- required
;