UNPKG

@pulumi/gcp

Version:

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

163 lines 6.88 kB
"use strict"; // *** WARNING: this file was generated by pulumi-language-nodejs. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); __setModuleDefault(result, mod); return result; }; Object.defineProperty(exports, "__esModule", { value: true }); exports.Environment = void 0; const pulumi = __importStar(require("@pulumi/pulumi")); const utilities = __importStar(require("../utilities")); /** * An `Environment` in Apigee. * * To get more information about Environment, see: * * * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments/create) * * How-to Guides * * [Creating an environment](https://cloud.google.com/apigee/docs/api-platform/get-started/create-environment) * * ## Example Usage * * ### Apigee Environment Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const current = gcp.organizations.getClientConfig({}); * const apigeeNetwork = new gcp.compute.Network("apigee_network", {name: "apigee-network"}); * const apigeeRange = new gcp.compute.GlobalAddress("apigee_range", { * name: "apigee-range", * purpose: "VPC_PEERING", * addressType: "INTERNAL", * prefixLength: 16, * network: apigeeNetwork.id, * }); * const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", { * network: apigeeNetwork.id, * service: "servicenetworking.googleapis.com", * reservedPeeringRanges: [apigeeRange.name], * }); * const apigeeOrg = new gcp.apigee.Organization("apigee_org", { * analyticsRegion: "us-central1", * projectId: current.then(current => current.project), * authorizedNetwork: apigeeNetwork.id, * }, { * dependsOn: [apigeeVpcConnection], * }); * const env = new gcp.apigee.Environment("env", { * name: "my-environment", * description: "Apigee Environment", * displayName: "environment-1", * orgId: apigeeOrg.id, * clientIpResolutionConfig: { * headerIndexAlgorithm: { * ipHeaderName: "X-Forwarded-For", * ipHeaderIndex: 1, * }, * }, * }); * ``` * * ## Import * * Environment can be imported using any of these accepted formats: * * * `{{org_id}}/environments/{{name}}` * * `{{org_id}}/{{name}}` * * When using the `pulumi import` command, Environment can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:apigee/environment:Environment default {{org_id}}/environments/{{name}} * $ pulumi import gcp:apigee/environment:Environment default {{org_id}}/{{name}} * ``` */ class Environment extends pulumi.CustomResource { /** * Get an existing Environment 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 Environment(name, state, { ...opts, id: id }); } /** @internal */ static __pulumiType = 'gcp:apigee/environment:Environment'; /** * Returns true if the given object is an instance of Environment. 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'] === Environment.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["apiProxyType"] = state?.apiProxyType; resourceInputs["clientIpResolutionConfig"] = state?.clientIpResolutionConfig; resourceInputs["deletionPolicy"] = state?.deletionPolicy; resourceInputs["deploymentType"] = state?.deploymentType; resourceInputs["description"] = state?.description; resourceInputs["displayName"] = state?.displayName; resourceInputs["forwardProxyUri"] = state?.forwardProxyUri; resourceInputs["name"] = state?.name; resourceInputs["nodeConfig"] = state?.nodeConfig; resourceInputs["orgId"] = state?.orgId; resourceInputs["properties"] = state?.properties; resourceInputs["type"] = state?.type; } else { const args = argsOrState; if (args?.orgId === undefined && !opts.urn) { throw new Error("Missing required property 'orgId'"); } resourceInputs["apiProxyType"] = args?.apiProxyType; resourceInputs["clientIpResolutionConfig"] = args?.clientIpResolutionConfig; resourceInputs["deletionPolicy"] = args?.deletionPolicy; resourceInputs["deploymentType"] = args?.deploymentType; resourceInputs["description"] = args?.description; resourceInputs["displayName"] = args?.displayName; resourceInputs["forwardProxyUri"] = args?.forwardProxyUri; resourceInputs["name"] = args?.name; resourceInputs["nodeConfig"] = args?.nodeConfig; resourceInputs["orgId"] = args?.orgId; resourceInputs["properties"] = args?.properties; resourceInputs["type"] = args?.type; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(Environment.__pulumiType, name, resourceInputs, opts); } } exports.Environment = Environment; //# sourceMappingURL=environment.js.map