Specifying a cloud network to host an API gateway

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

1. View the description of the CLI command for updating an API gateway:

   yc serverless api-gateway update --help
   

2. Get a list of API gateways in the default folder:

   yc serverless api-gateway list
   

3. Specify a cloud network for the API gateway:

   yc serverless api-gateway update \
     --id <API_gateway_ID> \
     --network-name <cloud_network_name>
   

   Where:

   • --id: API gateway ID.
   • --network-name: Name of the cloud network. You can specify the --network-id parameter instead of the network name.

   To associate the API gateway with certain subnets, specify them in the --subnet-id or --subnet-name parameters instead of specifying a network.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the guides on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.

1. Open the Terraform configuration file and add the connectivity section to the yandex_api_gateway resource description:

   resource "yandex_api_gateway" "test-api-gateway" {
     name = "<API_gateway_name>"
     ...
     connectivity {
       network_id = "<cloud_network_ID>"
     }
   }
   

   Where network_id is the ID of the cloud network to host the API gateway.

   For more information about the properties of the yandex_api_gateway resource, see this provider guide.

2. Apply the changes:

   1. In the terminal, navigate to the configuration file directory.

   2. Make sure the configuration is correct using this command:

      terraform validate
      

      If the configuration is valid, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.

   4. Apply the configuration changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   You can check the result using the management console or this CLI command:

   yc serverless api-gateway get <API_gateway_ID>
   

To specify a cloud network to host an API gateway, use the update REST API method for the ApiGateway resource or the ApiGatewayService/Update gRPC API call.

Set updateMask to connectivity, and connectivity.networkId, to the cloud network ID.