Getting information about a NAT gateway

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

1. View the description of the CLI command to get information about a NAT gateway:

   yc vpc gateway get --help
   

2. Get information about your NAT gateway by specifying its name or ID:

   yc vpc gateway get <NAT_gateway_name_or_ID>
   

   Result:

   id: enpkq1v2e7p0********
   folder_id: b1go79qlt1tp********
   created_at: "2024-04-23T16:34:53Z"
   name: test-gateway
   shared_egress_gateway: {}
   

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 relevant documentation on the Terraform website or its mirror.

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

To get information about a NAT gateway using Terraform:

1. Add the data and output sections to the Terraform configuration file:

   data "yandex_vpc_gateway" "default" {
     gateway_id = "<NAT_gateway_ID>"
   }
   
   output "gateway" {
     value = data.yandex_vpc_gateway.default.created_at
   }
   

   Where:

   • data "yandex_vpc_gateway": Description of the NAT gateway as a data source:
     • gateway_id: NAT gateway ID.
   • output "gateway": Output variable containing information about the NAT gateway creation time:
     • value: Returned value.

   You can replace created_at with any other parameter to get the information you need. For more information about the yandex_vpc_gateway data source parameters, see the relevant provider documentation.

2. Create resources:

   1. In the terminal, go to the directory where you edited the configuration file.

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

      terraform validate
      

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

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.

   4. Apply the changes:

      terraform apply
      

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

   Terraform will create all the required resources and display the output variable values in the terminal. To check the results, run this command:

   terraform output
   

   Result:

   gateway = "2024-04-23T16:34:53Z"
   

To get detailed information about a NAT gateway, use the get REST API method for the Gateway resource or the GatewayService/Get gRPC API call and provide the NAT gateway ID in the gatewayId request parameter.

To get the NAT gateway ID, use the list REST API method for the Gateway resource or the GatewayService/List gRPC API call. In your request, provide the folder ID in the folderId parameter.

To learn how to find out the folder ID, see Getting the folder ID.