@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
217 lines • 8.46 kB
JavaScript
;
// *** 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.NatAddress = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Apigee NAT (network address translation) address. A NAT address is a static external IP address used for Internet egress traffic. This is not avaible for Apigee hybrid.
*
* To get more information about NatAddress, see:
*
* * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.instances.natAddresses)
* * How-to Guides
* * [Provisioning NAT IPs](https://cloud.google.com/apigee/docs/api-platform/security/nat-provisioning)
*
* ## Example Usage
*
* ### Apigee Nat Address 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: 21,
* network: apigeeNetwork.id,
* });
* const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", {
* network: apigeeNetwork.id,
* service: "servicenetworking.googleapis.com",
* reservedPeeringRanges: [apigeeRange.name],
* });
* const apigeeKeyring = new gcp.kms.KeyRing("apigee_keyring", {
* name: "apigee-keyring",
* location: "us-central1",
* });
* const apigeeKey = new gcp.kms.CryptoKey("apigee_key", {
* name: "apigee-key",
* keyRing: apigeeKeyring.id,
* });
* const apigeeSa = new gcp.projects.ServiceIdentity("apigee_sa", {
* project: project.projectId,
* service: apigee.service,
* });
* const apigeeSaKeyuser = new gcp.kms.CryptoKeyIAMMember("apigee_sa_keyuser", {
* cryptoKeyId: apigeeKey.id,
* role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
* member: apigeeSa.member,
* });
* const apigeeOrg = new gcp.apigee.Organization("apigee_org", {
* analyticsRegion: "us-central1",
* displayName: "apigee-org",
* description: "Terraform-provisioned Apigee Org.",
* projectId: current.then(current => current.project),
* authorizedNetwork: apigeeNetwork.id,
* runtimeDatabaseEncryptionKeyName: apigeeKey.id,
* }, {
* dependsOn: [
* apigeeVpcConnection,
* apigeeSaKeyuser,
* ],
* });
* const apigeeInstance = new gcp.apigee.Instance("apigee_instance", {
* name: "apigee-instance",
* location: "us-central1",
* description: "Terraform-managed Apigee Runtime Instance",
* displayName: "apigee-instance",
* orgId: apigeeOrg.id,
* diskEncryptionKeyName: apigeeKey.id,
* });
* const apigee_nat = new gcp.apigee.NatAddress("apigee-nat", {
* name: "my-nat-address",
* instanceId: apigeeInstance.id,
* });
* ```
* ### Apigee Nat Address With Activate
*
* ```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: 21,
* network: apigeeNetwork.id,
* });
* const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", {
* network: apigeeNetwork.id,
* service: "servicenetworking.googleapis.com",
* reservedPeeringRanges: [apigeeRange.name],
* });
* const apigeeKeyring = new gcp.kms.KeyRing("apigee_keyring", {
* name: "apigee-keyring",
* location: "us-central1",
* });
* const apigeeKey = new gcp.kms.CryptoKey("apigee_key", {
* name: "apigee-key",
* keyRing: apigeeKeyring.id,
* });
* const apigeeSa = new gcp.projects.ServiceIdentity("apigee_sa", {
* project: project.projectId,
* service: apigee.service,
* });
* const apigeeSaKeyuser = new gcp.kms.CryptoKeyIAMMember("apigee_sa_keyuser", {
* cryptoKeyId: apigeeKey.id,
* role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
* member: apigeeSa.member,
* });
* const apigeeOrg = new gcp.apigee.Organization("apigee_org", {
* analyticsRegion: "us-central1",
* displayName: "apigee-org",
* description: "Terraform-provisioned Apigee Org.",
* projectId: current.then(current => current.project),
* authorizedNetwork: apigeeNetwork.id,
* runtimeDatabaseEncryptionKeyName: apigeeKey.id,
* }, {
* dependsOn: [
* apigeeVpcConnection,
* apigeeSaKeyuser,
* ],
* });
* const apigeeInstance = new gcp.apigee.Instance("apigee_instance", {
* name: "apigee-instance",
* location: "us-central1",
* description: "Terraform-managed Apigee Runtime Instance",
* displayName: "apigee-instance",
* orgId: apigeeOrg.id,
* diskEncryptionKeyName: apigeeKey.id,
* });
* const apigee_nat = new gcp.apigee.NatAddress("apigee-nat", {
* name: "my-nat-address",
* activate: true,
* instanceId: apigeeInstance.id,
* });
* ```
*
* ## Import
*
* NatAddress can be imported using any of these accepted formats:
*
* * `{{instance_id}}/natAddresses/{{name}}`
*
* * `{{instance_id}}/{{name}}`
*
* When using the `pulumi import` command, NatAddress can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:apigee/natAddress:NatAddress default {{instance_id}}/natAddresses/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:apigee/natAddress:NatAddress default {{instance_id}}/{{name}}
* ```
*/
class NatAddress extends pulumi.CustomResource {
/**
* Get an existing NatAddress 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 NatAddress(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of NatAddress. 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'] === NatAddress.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["activate"] = state ? state.activate : undefined;
resourceInputs["instanceId"] = state ? state.instanceId : undefined;
resourceInputs["ipAddress"] = state ? state.ipAddress : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["state"] = state ? state.state : undefined;
}
else {
const args = argsOrState;
if ((!args || args.instanceId === undefined) && !opts.urn) {
throw new Error("Missing required property 'instanceId'");
}
resourceInputs["activate"] = args ? args.activate : undefined;
resourceInputs["instanceId"] = args ? args.instanceId : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["ipAddress"] = undefined /*out*/;
resourceInputs["state"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(NatAddress.__pulumiType, name, resourceInputs, opts);
}
}
exports.NatAddress = NatAddress;
/** @internal */
NatAddress.__pulumiType = 'gcp:apigee/natAddress:NatAddress';
//# sourceMappingURL=natAddress.js.map