connections

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

Overview

Name	connections
Type	Resource
Id	aws.dms.connections

Fields

The following fields are returned by SELECT queries:

describe_connections

Name	Datatype	Description
endpoint_arn	string	The ARN string that uniquely identifies the endpoint.
endpoint_identifier	string	The identifier of the endpoint. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.
last_failure_message	string	The error message when the connection last failed.
replication_instance_arn	string	The ARN of the replication instance.
replication_instance_identifier	string	The replication instance identifier. This parameter is stored as a lowercase string.
status	string	The connection status. This parameter can return one of the following values: "successful" "testing" "failed" "deleting"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_connections	select	region		Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
delete_connection	delete	region		Deletes the connection between a replication instance and an endpoint.

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_connections

Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

SELECT
endpoint_arn,
endpoint_identifier,
last_failure_message,
replication_instance_arn,
replication_instance_identifier,
status
FROM aws.dms.connections
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_connection

Deletes the connection between a replication instance and an endpoint.

DELETE FROM aws.dms.connections
WHERE region = '{{ region }}' --required
;