--- title: "Update a Transit Gateway Attachment" method: PATCH path: "/networking/v1/transit-gateway-attachments/{id}" tags: ["Transit Gateway Attachments (networking/v1)"] --- # Update a Transit Gateway Attachment `PATCH /networking/v1/transit-gateway-attachments/{id}` [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Make a request to update a transit gateway attachment. ## Path parameters - `id` string, required ## Request body - object — AWS Transit Gateway Attachments Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). ## The Transit Gateway Attachments Model ## Quotas and Limits This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): | Quota | Description | | --- | --- | | `tgw_attachments_per_network` | Number of TGW attachments per network | - `api_version` 'networking/v1' — APIVersion defines the schema version of this representation of a resource. - `kind` 'TransitGatewayAttachment' — Kind defines the object this REST resource represents. - `id` string — 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"). - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. - `spec` object, required — The desired state of the Transit Gateway Attachment - `display_name` string — The name of the TGW attachment - `cloud` object — AWS Transit Gateway Attachment. - `kind` 'AwsTransitGatewayAttachment', required — AWS Transit Gateway Attachment kind type. - `ram_share_arn` string, required — The full AWS Resource Name (ARN) for the AWS Resource Access Manager (RAM) Share of the Transit Gateways that you want Confluent Cloud to be attached to. - `transit_gateway_id` string, required — The ID of the AWS Transit Gateway that you want Confluent CLoud to be attached to. - `routes` NetworkingV1Cidr[], required — List of destination routes. - `environment` object, required — The environment to which this belongs. - `id` string, required — ID of the referred resource - `environment` string — Environment of the referred resource, if env-scoped - `related` string, uri, required — API URL for accessing or modifying the referred object - `resource_name` string, uri, required — CRN reference to the referred resource - `api_version` string — API group and version of the referred resource - `kind` string — Kind of the referred resource - `network` ObjectReference — ObjectReference provides information for you to locate the referred object - `id` string, required — ID of the referred resource - `environment` string — Environment of the referred resource, if env-scoped - `related` string, uri, required — API URL for accessing or modifying the referred object - `resource_name` string, uri, required — CRN reference to the referred resource - `api_version` string — API group and version of the referred resource - `kind` string — Kind of the referred resource - `status` NetworkingV1TransitGatewayAttachmentStatus — The status of the Transit Gateway Attachment - `phase` string, required — The lifecycle phase of the TGW attachment: PROVISIONING: attachment provisioning is in progress; PENDING_ACCEPT: attachment request is pending acceptance by the customer; READY: attachment is ready; FAILED: attachment is in a failed state; DEPROVISIONING: attachment deprovisioning is in progress; DISCONNECTED: attachment was manually deleted directly in the cloud provider by the customer; ERROR: invalid customer input during attachment creation. - `error_code` string — Error code if TGW attachment is in a failed state. May be used for programmatic error checking. - `error_message` string — Displayable error message if TGW attachment is in a failed state - `cloud` object — AWS Transit Gateway Attachment details generated by AWS. - `kind` 'AwsTransitGatewayAttachmentStatus' — AWS Transit Gateway Attachment Status kind type. - `transit_gateway_attachment_id` string, required — The ID of the AWS Transit Gateway VPC Attachment that attaches Confluent VPC to Transit Gateway. ## Response `200` Transit Gateway Attachment. - object — AWS Transit Gateway Attachments Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-gateway.html). ## The Transit Gateway Attachments Model ## Quotas and Limits This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): | Quota | Description | | --- | --- | | `tgw_attachments_per_network` | Number of TGW attachments per network | - `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. - `id` string, 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"). - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. - `spec` object, required — The desired state of the Transit Gateway Attachment - `display_name` string — The name of the TGW attachment - `cloud` object, required — AWS Transit Gateway Attachment. - `kind` 'AwsTransitGatewayAttachment', required — AWS Transit Gateway Attachment kind type. - `ram_share_arn` string, required — The full AWS Resource Name (ARN) for the AWS Resource Access Manager (RAM) Share of the Transit Gateways that you want Confluent Cloud to be attached to. - `transit_gateway_id` string, required — The ID of the AWS Transit Gateway that you want Confluent CLoud to be attached to. - `routes` NetworkingV1Cidr[], required — List of destination routes. - `environment` object, required — The environment to which this belongs. - `id` string, required — ID of the referred resource - `environment` string — Environment of the referred resource, if env-scoped - `related` string, uri, required — API URL for accessing or modifying the referred object - `resource_name` string, uri, required — CRN reference to the referred resource - `api_version` string — API group and version of the referred resource - `kind` string — Kind of the referred resource - `network` object, required — The network to which this belongs. - `id` string, required — ID of the referred resource - `environment` string — Environment of the referred resource, if env-scoped - `related` string, uri, required — API URL for accessing or modifying the referred object - `resource_name` string, uri, required — CRN reference to the referred resource - `api_version` string — API group and version of the referred resource - `kind` string — Kind of the referred resource - `status` NetworkingV1TransitGatewayAttachmentStatus, required — The status of the Transit Gateway Attachment - `phase` string, required — The lifecycle phase of the TGW attachment: PROVISIONING: attachment provisioning is in progress; PENDING_ACCEPT: attachment request is pending acceptance by the customer; READY: attachment is ready; FAILED: attachment is in a failed state; DEPROVISIONING: attachment deprovisioning is in progress; DISCONNECTED: attachment was manually deleted directly in the cloud provider by the customer; ERROR: invalid customer input during attachment creation. - `error_code` string — Error code if TGW attachment is in a failed state. May be used for programmatic error checking. - `error_message` string — Displayable error message if TGW attachment is in a failed state - `cloud` object — AWS Transit Gateway Attachment details generated by AWS. - `kind` 'AwsTransitGatewayAttachmentStatus' — AWS Transit Gateway Attachment Status kind type. - `transit_gateway_attachment_id` string, required — The ID of the AWS Transit Gateway VPC Attachment that attaches Confluent VPC to Transit Gateway. ## Other responses - `400` — Bad Request - `401` — The request lacks valid authentication credentials for this resource. - `402` — The request would exceed one or more quotas. - `403` — The access credentials were considered insufficient to grant access - `404` — Not Found - `409` — The request is in conflict with the current server state - `422` — Validation Failed - `429` — Rate Limit Exceeded - `500` — Oops, something went wrong! --- [API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)