@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
296 lines • 12.6 kB
JavaScript
"use strict";
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.RouterNat = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* A NAT service created in a router.
*
* > **Note:** Recreating a `gcp.compute.Address` that is being used by `gcp.compute.RouterNat` will give a `resourceInUseByAnotherResource` error.
* Use `lifecycle.create_before_destroy` on this address resource to avoid this type of error as shown in the Manual Ips example.
*
* To get more information about RouterNat, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/routers)
* * How-to Guides
* * [Google Cloud Router](https://cloud.google.com/router/docs/)
*
* ## Example Usage
*
* ### Router Nat Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const net = new gcp.compute.Network("net", {name: "my-network"});
* const subnet = new gcp.compute.Subnetwork("subnet", {
* name: "my-subnetwork",
* network: net.id,
* ipCidrRange: "10.0.0.0/16",
* region: "us-central1",
* });
* const router = new gcp.compute.Router("router", {
* name: "my-router",
* region: subnet.region,
* network: net.id,
* bgp: {
* asn: 64514,
* },
* });
* const nat = new gcp.compute.RouterNat("nat", {
* name: "my-router-nat",
* router: router.name,
* region: router.region,
* natIpAllocateOption: "AUTO_ONLY",
* sourceSubnetworkIpRangesToNat: "ALL_SUBNETWORKS_ALL_IP_RANGES",
* logConfig: {
* enable: true,
* filter: "ERRORS_ONLY",
* },
* });
* ```
* ### Router Nat Rules
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const net = new gcp.compute.Network("net", {
* name: "my-network",
* autoCreateSubnetworks: false,
* });
* const subnet = new gcp.compute.Subnetwork("subnet", {
* name: "my-subnetwork",
* network: net.id,
* ipCidrRange: "10.0.0.0/16",
* region: "us-central1",
* });
* const router = new gcp.compute.Router("router", {
* name: "my-router",
* region: subnet.region,
* network: net.id,
* });
* const addr1 = new gcp.compute.Address("addr1", {
* name: "nat-address1",
* region: subnet.region,
* });
* const addr2 = new gcp.compute.Address("addr2", {
* name: "nat-address2",
* region: subnet.region,
* });
* const addr3 = new gcp.compute.Address("addr3", {
* name: "nat-address3",
* region: subnet.region,
* });
* const natRules = new gcp.compute.RouterNat("nat_rules", {
* name: "my-router-nat",
* router: router.name,
* region: router.region,
* natIpAllocateOption: "MANUAL_ONLY",
* natIps: [addr1.selfLink],
* sourceSubnetworkIpRangesToNat: "LIST_OF_SUBNETWORKS",
* subnetworks: [{
* name: subnet.id,
* sourceIpRangesToNats: ["ALL_IP_RANGES"],
* }],
* rules: [{
* ruleNumber: 100,
* description: "nat rules example",
* match: "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')",
* action: {
* sourceNatActiveIps: [
* addr2.selfLink,
* addr3.selfLink,
* ],
* },
* }],
* enableEndpointIndependentMapping: false,
* });
* ```
* ### Router Nat Private
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const net = new gcp.compute.Network("net", {name: "my-network"});
* const subnet = new gcp.compute.Subnetwork("subnet", {
* name: "my-subnetwork",
* network: net.id,
* ipCidrRange: "10.0.0.0/16",
* region: "us-central1",
* purpose: "PRIVATE_NAT",
* });
* const router = new gcp.compute.Router("router", {
* name: "my-router",
* region: subnet.region,
* network: net.id,
* });
* const hub = new gcp.networkconnectivity.Hub("hub", {
* name: "my-hub",
* description: "vpc hub for inter vpc nat",
* });
* const spoke = new gcp.networkconnectivity.Spoke("spoke", {
* name: "my-spoke",
* location: "global",
* description: "vpc spoke for inter vpc nat",
* hub: hub.id,
* linkedVpcNetwork: {
* excludeExportRanges: [
* "198.51.100.0/24",
* "10.10.0.0/16",
* ],
* uri: net.selfLink,
* },
* });
* const natType = new gcp.compute.RouterNat("nat_type", {
* name: "my-router-nat",
* router: router.name,
* region: router.region,
* sourceSubnetworkIpRangesToNat: "LIST_OF_SUBNETWORKS",
* enableDynamicPortAllocation: false,
* enableEndpointIndependentMapping: false,
* minPortsPerVm: 32,
* type: "PRIVATE",
* subnetworks: [{
* name: subnet.id,
* sourceIpRangesToNats: ["ALL_IP_RANGES"],
* }],
* rules: [{
* ruleNumber: 100,
* description: "rule for private nat",
* match: "nexthop.hub == \"//networkconnectivity.googleapis.com/projects/acm-test-proj-123/locations/global/hubs/my-hub\"",
* action: {
* sourceNatActiveRanges: [subnet.selfLink],
* },
* }],
* });
* ```
*
* ## Import
*
* RouterNat can be imported using any of these accepted formats:
*
* * `projects/{{project}}/regions/{{region}}/routers/{{router}}/{{name}}`
*
* * `{{project}}/{{region}}/{{router}}/{{name}}`
*
* * `{{region}}/{{router}}/{{name}}`
*
* * `{{router}}/{{name}}`
*
* When using the `pulumi import` command, RouterNat can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/routerNat:RouterNat default projects/{{project}}/regions/{{region}}/routers/{{router}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/routerNat:RouterNat default {{project}}/{{region}}/{{router}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/routerNat:RouterNat default {{region}}/{{router}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/routerNat:RouterNat default {{router}}/{{name}}
* ```
*/
class RouterNat extends pulumi.CustomResource {
/**
* Get an existing RouterNat resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new RouterNat(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of RouterNat. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === RouterNat.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["autoNetworkTier"] = state ? state.autoNetworkTier : undefined;
resourceInputs["drainNatIps"] = state ? state.drainNatIps : undefined;
resourceInputs["enableDynamicPortAllocation"] = state ? state.enableDynamicPortAllocation : undefined;
resourceInputs["enableEndpointIndependentMapping"] = state ? state.enableEndpointIndependentMapping : undefined;
resourceInputs["endpointTypes"] = state ? state.endpointTypes : undefined;
resourceInputs["icmpIdleTimeoutSec"] = state ? state.icmpIdleTimeoutSec : undefined;
resourceInputs["initialNatIps"] = state ? state.initialNatIps : undefined;
resourceInputs["logConfig"] = state ? state.logConfig : undefined;
resourceInputs["maxPortsPerVm"] = state ? state.maxPortsPerVm : undefined;
resourceInputs["minPortsPerVm"] = state ? state.minPortsPerVm : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["natIpAllocateOption"] = state ? state.natIpAllocateOption : undefined;
resourceInputs["natIps"] = state ? state.natIps : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["region"] = state ? state.region : undefined;
resourceInputs["router"] = state ? state.router : undefined;
resourceInputs["rules"] = state ? state.rules : undefined;
resourceInputs["sourceSubnetworkIpRangesToNat"] = state ? state.sourceSubnetworkIpRangesToNat : undefined;
resourceInputs["subnetworks"] = state ? state.subnetworks : undefined;
resourceInputs["tcpEstablishedIdleTimeoutSec"] = state ? state.tcpEstablishedIdleTimeoutSec : undefined;
resourceInputs["tcpTimeWaitTimeoutSec"] = state ? state.tcpTimeWaitTimeoutSec : undefined;
resourceInputs["tcpTransitoryIdleTimeoutSec"] = state ? state.tcpTransitoryIdleTimeoutSec : undefined;
resourceInputs["type"] = state ? state.type : undefined;
resourceInputs["udpIdleTimeoutSec"] = state ? state.udpIdleTimeoutSec : undefined;
}
else {
const args = argsOrState;
if ((!args || args.router === undefined) && !opts.urn) {
throw new Error("Missing required property 'router'");
}
if ((!args || args.sourceSubnetworkIpRangesToNat === undefined) && !opts.urn) {
throw new Error("Missing required property 'sourceSubnetworkIpRangesToNat'");
}
resourceInputs["autoNetworkTier"] = args ? args.autoNetworkTier : undefined;
resourceInputs["drainNatIps"] = args ? args.drainNatIps : undefined;
resourceInputs["enableDynamicPortAllocation"] = args ? args.enableDynamicPortAllocation : undefined;
resourceInputs["enableEndpointIndependentMapping"] = args ? args.enableEndpointIndependentMapping : undefined;
resourceInputs["endpointTypes"] = args ? args.endpointTypes : undefined;
resourceInputs["icmpIdleTimeoutSec"] = args ? args.icmpIdleTimeoutSec : undefined;
resourceInputs["initialNatIps"] = args ? args.initialNatIps : undefined;
resourceInputs["logConfig"] = args ? args.logConfig : undefined;
resourceInputs["maxPortsPerVm"] = args ? args.maxPortsPerVm : undefined;
resourceInputs["minPortsPerVm"] = args ? args.minPortsPerVm : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["natIpAllocateOption"] = args ? args.natIpAllocateOption : undefined;
resourceInputs["natIps"] = args ? args.natIps : undefined;
resourceInputs["project"] = args ? args.project : undefined;
resourceInputs["region"] = args ? args.region : undefined;
resourceInputs["router"] = args ? args.router : undefined;
resourceInputs["rules"] = args ? args.rules : undefined;
resourceInputs["sourceSubnetworkIpRangesToNat"] = args ? args.sourceSubnetworkIpRangesToNat : undefined;
resourceInputs["subnetworks"] = args ? args.subnetworks : undefined;
resourceInputs["tcpEstablishedIdleTimeoutSec"] = args ? args.tcpEstablishedIdleTimeoutSec : undefined;
resourceInputs["tcpTimeWaitTimeoutSec"] = args ? args.tcpTimeWaitTimeoutSec : undefined;
resourceInputs["tcpTransitoryIdleTimeoutSec"] = args ? args.tcpTransitoryIdleTimeoutSec : undefined;
resourceInputs["type"] = args ? args.type : undefined;
resourceInputs["udpIdleTimeoutSec"] = args ? args.udpIdleTimeoutSec : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(RouterNat.__pulumiType, name, resourceInputs, opts);
}
}
exports.RouterNat = RouterNat;
/** @internal */
RouterNat.__pulumiType = 'gcp:compute/routerNat:RouterNat';
//# sourceMappingURL=routerNat.js.map