UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

203 lines • 8.98 kB
"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.NetworkPeeringRoutesConfig = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("../utilities"); /** * Manage a network peering's route settings without managing the peering as * a whole. This resource is primarily intended for use with GCP-generated * peerings that shouldn't otherwise be managed by other tools. Deleting this * resource is a no-op and the peering will not be modified. * * To get more information about NetworkPeeringRoutesConfig, see: * * * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/networks/updatePeering) * * How-to Guides * * [Official Documentation](https://cloud.google.com/vpc/docs/vpc-peering) * * ## Example Usage * * ### Network Peering Routes Config Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const networkPrimary = new gcp.compute.Network("network_primary", { * name: "primary-network", * autoCreateSubnetworks: false, * }); * const networkSecondary = new gcp.compute.Network("network_secondary", { * name: "secondary-network", * autoCreateSubnetworks: false, * }); * const peeringPrimary = new gcp.compute.NetworkPeering("peering_primary", { * name: "primary-peering", * network: networkPrimary.id, * peerNetwork: networkSecondary.id, * importCustomRoutes: true, * exportCustomRoutes: true, * importSubnetRoutesWithPublicIp: true, * exportSubnetRoutesWithPublicIp: true, * }); * const peeringPrimaryRoutes = new gcp.compute.NetworkPeeringRoutesConfig("peering_primary_routes", { * peering: peeringPrimary.name, * network: networkPrimary.name, * importCustomRoutes: true, * exportCustomRoutes: true, * importSubnetRoutesWithPublicIp: true, * exportSubnetRoutesWithPublicIp: true, * }); * const peeringSecondary = new gcp.compute.NetworkPeering("peering_secondary", { * name: "secondary-peering", * network: networkSecondary.id, * peerNetwork: networkPrimary.id, * }); * ``` * ### Network Peering Routes Config Gke * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const containerNetwork = new gcp.compute.Network("container_network", { * name: "container-network", * autoCreateSubnetworks: false, * }); * const containerSubnetwork = new gcp.compute.Subnetwork("container_subnetwork", { * name: "container-subnetwork", * region: "us-central1", * network: containerNetwork.name, * ipCidrRange: "10.0.36.0/24", * privateIpGoogleAccess: true, * secondaryIpRanges: [ * { * rangeName: "pod", * ipCidrRange: "10.0.0.0/19", * }, * { * rangeName: "svc", * ipCidrRange: "10.0.32.0/22", * }, * ], * }); * const privateCluster = new gcp.container.Cluster("private_cluster", { * name: "private-cluster", * location: "us-central1-a", * initialNodeCount: 1, * network: containerNetwork.name, * subnetwork: containerSubnetwork.name, * privateClusterConfig: { * enablePrivateEndpoint: true, * enablePrivateNodes: true, * masterIpv4CidrBlock: "10.42.0.0/28", * }, * masterAuthorizedNetworksConfig: {}, * ipAllocationPolicy: { * clusterSecondaryRangeName: containerSubnetwork.secondaryIpRanges.apply(secondaryIpRanges => secondaryIpRanges[0].rangeName), * servicesSecondaryRangeName: containerSubnetwork.secondaryIpRanges.apply(secondaryIpRanges => secondaryIpRanges[1].rangeName), * }, * deletionProtection: true, * }); * const peeringGkeRoutes = new gcp.compute.NetworkPeeringRoutesConfig("peering_gke_routes", { * peering: privateCluster.privateClusterConfig.apply(privateClusterConfig => privateClusterConfig.peeringName), * network: containerNetwork.name, * importCustomRoutes: true, * exportCustomRoutes: true, * importSubnetRoutesWithPublicIp: true, * exportSubnetRoutesWithPublicIp: true, * }); * ``` * * ## Import * * NetworkPeeringRoutesConfig can be imported using any of these accepted formats: * * * `projects/{{project}}/global/networks/{{network}}/networkPeerings/{{peering}}` * * * `{{project}}/{{network}}/{{peering}}` * * * `{{network}}/{{peering}}` * * When using the `pulumi import` command, NetworkPeeringRoutesConfig can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/networkPeeringRoutesConfig:NetworkPeeringRoutesConfig default projects/{{project}}/global/networks/{{network}}/networkPeerings/{{peering}} * ``` * * ```sh * $ pulumi import gcp:compute/networkPeeringRoutesConfig:NetworkPeeringRoutesConfig default {{project}}/{{network}}/{{peering}} * ``` * * ```sh * $ pulumi import gcp:compute/networkPeeringRoutesConfig:NetworkPeeringRoutesConfig default {{network}}/{{peering}} * ``` */ class NetworkPeeringRoutesConfig extends pulumi.CustomResource { /** * Get an existing NetworkPeeringRoutesConfig 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 NetworkPeeringRoutesConfig(name, state, Object.assign(Object.assign({}, opts), { id: id })); } /** * Returns true if the given object is an instance of NetworkPeeringRoutesConfig. 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'] === NetworkPeeringRoutesConfig.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["exportCustomRoutes"] = state ? state.exportCustomRoutes : undefined; resourceInputs["exportSubnetRoutesWithPublicIp"] = state ? state.exportSubnetRoutesWithPublicIp : undefined; resourceInputs["importCustomRoutes"] = state ? state.importCustomRoutes : undefined; resourceInputs["importSubnetRoutesWithPublicIp"] = state ? state.importSubnetRoutesWithPublicIp : undefined; resourceInputs["network"] = state ? state.network : undefined; resourceInputs["peering"] = state ? state.peering : undefined; resourceInputs["project"] = state ? state.project : undefined; } else { const args = argsOrState; if ((!args || args.exportCustomRoutes === undefined) && !opts.urn) { throw new Error("Missing required property 'exportCustomRoutes'"); } if ((!args || args.importCustomRoutes === undefined) && !opts.urn) { throw new Error("Missing required property 'importCustomRoutes'"); } if ((!args || args.network === undefined) && !opts.urn) { throw new Error("Missing required property 'network'"); } if ((!args || args.peering === undefined) && !opts.urn) { throw new Error("Missing required property 'peering'"); } resourceInputs["exportCustomRoutes"] = args ? args.exportCustomRoutes : undefined; resourceInputs["exportSubnetRoutesWithPublicIp"] = args ? args.exportSubnetRoutesWithPublicIp : undefined; resourceInputs["importCustomRoutes"] = args ? args.importCustomRoutes : undefined; resourceInputs["importSubnetRoutesWithPublicIp"] = args ? args.importSubnetRoutesWithPublicIp : undefined; resourceInputs["network"] = args ? args.network : undefined; resourceInputs["peering"] = args ? args.peering : undefined; resourceInputs["project"] = args ? args.project : undefined; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(NetworkPeeringRoutesConfig.__pulumiType, name, resourceInputs, opts); } } exports.NetworkPeeringRoutesConfig = NetworkPeeringRoutesConfig; /** @internal */ NetworkPeeringRoutesConfig.__pulumiType = 'gcp:compute/networkPeeringRoutesConfig:NetworkPeeringRoutesConfig'; //# sourceMappingURL=networkPeeringRoutesConfig.js.map