@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
307 lines • 12.7 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.AiPersistentResource = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* Represents long-lasting resources that are dedicated to users to runs custom
* workloads. A PersistentResource can have multiple node pools and each node
* pool can have its own machine spec.
*
* To get more information about PersistentResource, see:
*
* * [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.persistentResources)
*
* ## Example Usage
*
* ### Vertex Ai Persistent Resource
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const persistentResource = new gcp.vertex.AiPersistentResource("persistent_resource", {
* name: "example-persistent-resource",
* location: "us-central1",
* displayName: "Example persistent resource",
* resourcePools: [{
* machineSpec: {
* machineType: "n1-standard-4",
* },
* replicaCount: "1",
* }],
* });
* ```
* ### Vertex Ai Persistent Resource Autoscaling
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const persistentResource = new gcp.vertex.AiPersistentResource("persistent_resource", {
* name: "example-persistent-resource",
* location: "us-central1",
* displayName: "Example persistent resource",
* resourcePools: [{
* machineSpec: {
* machineType: "n1-standard-4",
* },
* replicaCount: "1",
* autoscalingSpec: {
* minReplicaCount: "1",
* maxReplicaCount: "2",
* },
* }],
* });
* ```
* ### Vertex Ai Persistent Resource Machine Spec
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const persistentResource = new gcp.vertex.AiPersistentResource("persistent_resource", {
* name: "example-persistent-resource",
* location: "us-central1",
* resourcePools: [{
* machineSpec: {
* machineType: "a3-highgpu-8g",
* acceleratorCount: 8,
* acceleratorType: "NVIDIA_H100_80GB",
* },
* replicaCount: "1",
* diskSpec: {
* bootDiskSizeGb: 200,
* bootDiskType: "pd-ssd",
* },
* }],
* });
* ```
* ### Vertex Ai Persistent Resource Network
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as time from "@pulumiverse/time";
*
* // VPC network for Vertex AI peering
* const vertexNetwork = new gcp.compute.Network("vertex_network", {
* name: "vertex-network",
* autoCreateSubnetworks: false,
* });
* // Reserved IP range for Vertex AI peering
* const vertexRange = new gcp.compute.GlobalAddress("vertex_range", {
* name: "vertex-ip-range",
* purpose: "VPC_PEERING",
* addressType: "INTERNAL",
* prefixLength: 24,
* network: vertexNetwork.id,
* });
* // Service networking connection for Vertex AI
* const vertexVpcConnection = new gcp.servicenetworking.Connection("vertex_vpc_connection", {
* network: vertexNetwork.id,
* service: "servicenetworking.googleapis.com",
* reservedPeeringRanges: [vertexRange.name],
* });
* // Subnetwork for the network attachment
* const pscSubnetwork = new gcp.compute.Subnetwork("psc_subnetwork", {
* name: "psc-subnetwork",
* region: "us-central1",
* ipCidrRange: "10.0.0.0/16",
* network: vertexNetwork.id,
* });
* // Network attachment for PSC-I
* const pscAttachment = new gcp.compute.NetworkAttachment("psc_attachment", {
* name: "psc-attachment",
* region: "us-central1",
* connectionPreference: "ACCEPT_MANUAL",
* subnetworks: [pscSubnetwork.id],
* });
* const waitForDeletion = new time.Sleep("wait_for_deletion", {destroyDuration: "300s"}, {
* dependsOn: [
* pscAttachment,
* vertexVpcConnection,
* ],
* });
* const project = gcp.organizations.getProject({});
* // Grant Vertex AI service agent access to the KMS key
* const cryptoKey = new gcp.kms.CryptoKeyIAMMember("crypto_key", {
* cryptoKeyId: "example-key",
* role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
* member: project.then(project => `serviceAccount:service-${project.number}@gcp-sa-aiplatform.iam.gserviceaccount.com`),
* });
* const persistentResource = new gcp.vertex.AiPersistentResource("persistent_resource", {
* name: "example-persistent-resource",
* location: "us-central1",
* displayName: "test-persistent-resource-full",
* labels: {
* env: "test",
* },
* network: pulumi.all([project, vertexNetwork.name]).apply(([project, name]) => `projects/${project.number}/global/networks/${name}`),
* reservedIpRanges: [vertexRange.name],
* encryptionSpec: {
* kmsKeyName: "example-key",
* },
* pscInterfaceConfig: {
* networkAttachment: pscAttachment.id,
* dnsPeeringConfigs: [{
* domain: "example.com.",
* targetProject: project.then(project => project.projectId),
* targetNetwork: vertexNetwork.name,
* }],
* },
* resourcePools: [{
* id: "vpr-resource-pool",
* replicaCount: "1",
* machineSpec: {
* machineType: "n1-standard-4",
* },
* diskSpec: {
* bootDiskSizeGb: 200,
* bootDiskType: "pd-ssd",
* },
* }],
* resourceRuntimeSpec: {
* serviceAccountSpec: {
* enableCustomServiceAccount: true,
* },
* },
* }, {
* dependsOn: [
* vertexVpcConnection,
* cryptoKey,
* waitForDeletion,
* ],
* });
* ```
*
* ## Import
*
* PersistentResource can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/persistentResources/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, PersistentResource can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:vertex/aiPersistentResource:AiPersistentResource default projects/{{project}}/locations/{{location}}/persistentResources/{{name}}
* $ pulumi import gcp:vertex/aiPersistentResource:AiPersistentResource default {{project}}/{{location}}/{{name}}
* $ pulumi import gcp:vertex/aiPersistentResource:AiPersistentResource default {{location}}/{{name}}
* ```
*/
class AiPersistentResource extends pulumi.CustomResource {
/**
* Get an existing AiPersistentResource 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 AiPersistentResource(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:vertex/aiPersistentResource:AiPersistentResource';
/**
* Returns true if the given object is an instance of AiPersistentResource. 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'] === AiPersistentResource.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["effectiveLabels"] = state?.effectiveLabels;
resourceInputs["encryptionSpec"] = state?.encryptionSpec;
resourceInputs["errors"] = state?.errors;
resourceInputs["labels"] = state?.labels;
resourceInputs["location"] = state?.location;
resourceInputs["name"] = state?.name;
resourceInputs["network"] = state?.network;
resourceInputs["project"] = state?.project;
resourceInputs["pscInterfaceConfig"] = state?.pscInterfaceConfig;
resourceInputs["pulumiLabels"] = state?.pulumiLabels;
resourceInputs["reservedIpRanges"] = state?.reservedIpRanges;
resourceInputs["resourcePools"] = state?.resourcePools;
resourceInputs["resourceRuntimeSpec"] = state?.resourceRuntimeSpec;
resourceInputs["resourceRuntimes"] = state?.resourceRuntimes;
resourceInputs["satisfiesPzi"] = state?.satisfiesPzi;
resourceInputs["satisfiesPzs"] = state?.satisfiesPzs;
resourceInputs["startTime"] = state?.startTime;
resourceInputs["state"] = state?.state;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
if (args?.resourcePools === undefined && !opts.urn) {
throw new Error("Missing required property 'resourcePools'");
}
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["encryptionSpec"] = args?.encryptionSpec;
resourceInputs["labels"] = args?.labels;
resourceInputs["location"] = args?.location;
resourceInputs["name"] = args?.name;
resourceInputs["network"] = args?.network;
resourceInputs["project"] = args?.project;
resourceInputs["pscInterfaceConfig"] = args?.pscInterfaceConfig;
resourceInputs["reservedIpRanges"] = args?.reservedIpRanges;
resourceInputs["resourcePools"] = args?.resourcePools;
resourceInputs["resourceRuntimeSpec"] = args?.resourceRuntimeSpec;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["errors"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
resourceInputs["resourceRuntimes"] = undefined /*out*/;
resourceInputs["satisfiesPzi"] = undefined /*out*/;
resourceInputs["satisfiesPzs"] = undefined /*out*/;
resourceInputs["startTime"] = undefined /*out*/;
resourceInputs["state"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(AiPersistentResource.__pulumiType, name, resourceInputs, opts);
}
}
exports.AiPersistentResource = AiPersistentResource;
//# sourceMappingURL=aiPersistentResource.js.map