Transit Gateways

Update Transit Gateway

Updates a transit gateway by ID. Supports updating CIDR blocks on an AWS Transit Gateway, or updating the resource endpoint configuration on an AWS Resource Endpoint gateway.

patch/v2/cloud-gateways/networks/{networkId}/transit-gateways/{transitGatewayId}

Path parameters

networkIdstring uuid required

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

transitGatewayIdstring uuid required
Example:0850820b-d153-4a2a-b9be-7d2204779139

The ID of the transit gateway to operate on.

Request body

OR

Example request

{
  "cidr_blocks": [
    "10.0.0.0/8",
    "100.64.0.0/10",
    "172.16.0.0/12"
  ]
}

Response

Response format for updating a transit gateway.

OR

Example response

{
  "name": "us-east-2 transit gateway",
  "dns_config": [
    {
      "remote_dns_server_ip_addresses": [
        "10.0.0.2"
      ],
      "domain_proxy_list": [
        "foobar.com"
      ]
    }
  ],
  "id": "0850820b-d153-4a2a-b9be-7d2204779139",
  "state_metadata": {
    "reported_status": "ERROR",
    "reason": "Transit Gateway Attachment configuration could not find a resource with the provided ram share arn.\n"
  },
  "entity_version": 1,
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 6 of the 75 revisions of this API.133

    • added the optional property oneOf[subschema #2: AWS Transit Gateway]/transit_gateway_attachment_config/attachment_id to the response with the 200 status

      response-optional-property-added

    • added the new error enum value to the oneOf[subschema #1: AWS Resource Endpoint Gateway]/state response property for the response status 200

      response-property-enum-value-added

    • added the new error enum value to the oneOf[subschema #2: AWS Transit Gateway]/state response property for the response status 200

      response-property-enum-value-added

    • added PatchAwsTransitGateway to the request body oneOf list

      request-body-one-of-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added AwsTransitGatewayResponse to the response body oneOf list for the response status 200

      response-body-one-of-added

    • added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    • endpoint added

      endpoint-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog