Amazon DMS · JSON Structure

Amazon Dms Connection Structure

Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.

Type: object Properties: 6
Data ReplicationDatabaseDatabase MigrationMigration

Amazon Dms Connection Structure is a JSON Structure definition published by Amazon DMS, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ReplicationInstanceArn EndpointArn Status LastFailureMessage EndpointIdentifier ReplicationInstanceIdentifier

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-dms/refs/heads/main/json-structure/amazon-dms-connection-structure.json",
  "title": "Connection",
  "description": "Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.",
  "type": "object",
  "properties": {
    "ReplicationInstanceArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The ARN of the replication instance."
        }
      ]
    },
    "EndpointArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The ARN string that uniquely identifies the endpoint."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "<p>The connection status. This parameter can return one of the following values:</p> <ul> <li> <p> <code>\"successful\"</code> </p> </li> <li> <p> <code>\"testing\"</code> </p> </li> <li> <p> <code>\"failed\"</code> </p> </li> <li> <p> <code>\"deleting\"</code> </p> </li> </ul>"
        }
      ]
    },
    "LastFailureMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The error message when the connection last failed."
        }
      ]
    },
    "EndpointIdentifier": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "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."
        }
      ]
    },
    "ReplicationInstanceIdentifier": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The replication instance identifier. This parameter is stored as a lowercase string."
        }
      ]
    }
  }
}