Sign in
Transit Gateway Attachments (networking/v1)

Read a Transit Gateway Attachment

General Availability

Make a request to read a transit gateway attachment.

get/networking/v1/transit-gateway-attachments/{id}

Path parameters

idstring required

The unique identifier for the transit gateway attachment.

Query parameters

environmentstring required

Filter a collection by a string search

Scope the operation to the given environment.

Response

Transit Gateway Attachment.

api_version'networking/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'TransitGatewayAttachment' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/networking/v1/transit-gateway-attachments/tga-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-456xyz/transit-gateway-attachment=tga-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "spec": {
    "display_name": "prod-tgw-use1",
    "cloud": {
      "ram_share_arn": "arn:aws:ram:us-west-3:000000000000:resource-share/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
      "transit_gateway_id": "tgw-xxxxxxxxxxxxxxxxx",
      "routes": [
        "100.64.0.0/10",
        "10.0.0.0/8",
        "192.168.0.0/16",
        "172.16.0.0/12"
      ]
    },
    "environment": {
      "id": "env-00000",
      "related": "https://api.confluent.cloud/v2/environments/env-00000",
      "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
    },
    "network": {
      "id": "n-00000",
      "related": "https://api.confluent.cloud/networking/v1/networks/n-00000",
      "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000"
    }
  },
  "status": {
    "phase": "READY",
    "cloud": {
      "transit_gateway_attachment_id": "tgw-attach-xxxxx"
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.