@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
220 lines • 8.24 kB
JavaScript
;
// *** 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.MachineImage = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* Represents a Machine Image resource. Machine images store all the configuration,
* metadata, permissions, and data from one or more disks required to create a
* Virtual machine (VM) instance.
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* To get more information about MachineImage, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/beta/machineImages)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/compute/docs/machine-images)
*
* ## Example Usage
*
* ### Machine Image Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const vm = new gcp.compute.Instance("vm", {
* name: "my-vm",
* machineType: "e2-medium",
* bootDisk: {
* initializeParams: {
* image: "debian-cloud/debian-11",
* },
* },
* networkInterfaces: [{
* network: "default",
* }],
* });
* const image = new gcp.compute.MachineImage("image", {
* name: "my-image",
* sourceInstance: vm.selfLink,
* });
* ```
* ### Compute Machine Image Kms
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const vm = new gcp.compute.Instance("vm", {
* name: "my-vm",
* machineType: "e2-medium",
* bootDisk: {
* initializeParams: {
* image: "debian-cloud/debian-11",
* },
* },
* networkInterfaces: [{
* network: "default",
* }],
* });
* const keyRing = new gcp.kms.KeyRing("key_ring", {
* name: "keyring",
* location: "us",
* });
* const cryptoKey = new gcp.kms.CryptoKey("crypto_key", {
* name: "key",
* keyRing: keyRing.id,
* });
* const image = new gcp.compute.MachineImage("image", {
* name: "my-image",
* sourceInstance: vm.selfLink,
* machineImageEncryptionKey: {
* kmsKeyName: cryptoKey.id,
* },
* });
* ```
* ### Machine Image Resource Manager Tags
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const tagKey1 = new gcp.tags.TagKey("tag_key1", {
* parent: project.then(project => `projects/${project.number}`),
* shortName: "tagkey",
* });
* const tagValue1 = new gcp.tags.TagValue("tag_value1", {
* parent: tagKey1.id,
* shortName: "tagvalue",
* });
* const vm = new gcp.compute.Instance("vm", {
* name: "my-vm",
* machineType: "e2-medium",
* bootDisk: {
* initializeParams: {
* image: "debian-cloud/debian-11",
* },
* },
* networkInterfaces: [{
* network: "default",
* }],
* });
* const image = new gcp.compute.MachineImage("image", {
* name: "my-image",
* sourceInstance: vm.selfLink,
* params: {
* resourceManagerTags: pulumi.all([tagKey1.id, tagValue1.id]).apply(([tagKey1Id, tagValue1Id]) => {
* [tagKey1Id]: tagValue1Id,
* }),
* },
* });
* ```
*
* ## Import
*
* MachineImage can be imported using any of these accepted formats:
*
* * `projects/{{project}}/global/machineImages/{{name}}`
* * `{{project}}/{{name}}`
* * `{{name}}`
*
* When using the `pulumi import` command, MachineImage can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/machineImage:MachineImage default projects/{{project}}/global/machineImages/{{name}}
* $ pulumi import gcp:compute/machineImage:MachineImage default {{project}}/{{name}}
* $ pulumi import gcp:compute/machineImage:MachineImage default {{name}}
* ```
*/
class MachineImage extends pulumi.CustomResource {
/**
* Get an existing MachineImage 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 MachineImage(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:compute/machineImage:MachineImage';
/**
* Returns true if the given object is an instance of MachineImage. 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'] === MachineImage.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["description"] = state?.description;
resourceInputs["guestFlush"] = state?.guestFlush;
resourceInputs["machineImageEncryptionKey"] = state?.machineImageEncryptionKey;
resourceInputs["name"] = state?.name;
resourceInputs["params"] = state?.params;
resourceInputs["project"] = state?.project;
resourceInputs["selfLink"] = state?.selfLink;
resourceInputs["sourceInstance"] = state?.sourceInstance;
resourceInputs["storageLocations"] = state?.storageLocations;
}
else {
const args = argsOrState;
if (args?.sourceInstance === undefined && !opts.urn) {
throw new Error("Missing required property 'sourceInstance'");
}
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["description"] = args?.description;
resourceInputs["guestFlush"] = args?.guestFlush;
resourceInputs["machineImageEncryptionKey"] = args?.machineImageEncryptionKey;
resourceInputs["name"] = args?.name;
resourceInputs["params"] = args?.params;
resourceInputs["project"] = args?.project;
resourceInputs["sourceInstance"] = args?.sourceInstance;
resourceInputs["selfLink"] = undefined /*out*/;
resourceInputs["storageLocations"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(MachineImage.__pulumiType, name, resourceInputs, opts);
}
}
exports.MachineImage = MachineImage;
//# sourceMappingURL=machineImage.js.map