@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
274 lines (273 loc) • 10.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Represents a Managed Instance Group Resize Request
*
* Resize Requests are the Managed Instance Group implementation of Dynamic Workload Scheduler Flex Start.
*
* With Dynamic Workload Scheduler in Flex Start mode, you submit a GPU capacity request for your AI/ML jobs by indicating how many you need, a duration, and your preferred zone. Dynamic Workload Scheduler intelligently persists the request; once the capacity becomes available, it automatically provisions your VMs enabling your workloads to run continuously for the entire duration of the capacity allocation.
*
* To get more information about ResizeRequest, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagerResizeRequests)
* * How-to Guides
* * [About resize requests in a MIG](https://cloud.google.com/compute/docs/instance-groups/about-resize-requests-mig)
*
* ## Example Usage
*
* ### Compute Mig Resize Request
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const a3Dws = new gcp.compute.RegionInstanceTemplate("a3_dws", {
* name: "a3-dws",
* region: "us-central1",
* description: "This template is used to create a mig instance that is compatible with DWS resize requests.",
* instanceDescription: "A3 GPU",
* machineType: "a3-highgpu-8g",
* canIpForward: false,
* scheduling: {
* automaticRestart: false,
* onHostMaintenance: "TERMINATE",
* },
* disks: [{
* sourceImage: "cos-cloud/cos-105-lts",
* autoDelete: true,
* boot: true,
* diskType: "pd-ssd",
* diskSizeGb: 960,
* mode: "READ_WRITE",
* }],
* guestAccelerators: [{
* type: "nvidia-h100-80gb",
* count: 8,
* }],
* reservationAffinity: {
* type: "NO_RESERVATION",
* },
* shieldedInstanceConfig: {
* enableVtpm: true,
* enableIntegrityMonitoring: true,
* },
* networkInterfaces: [{
* network: "default",
* }],
* });
* const a3DwsInstanceGroupManager = new gcp.compute.InstanceGroupManager("a3_dws", {
* name: "a3-dws",
* baseInstanceName: "a3-dws",
* zone: "us-central1-a",
* versions: [{
* instanceTemplate: a3Dws.selfLink,
* }],
* instanceLifecyclePolicy: {
* defaultActionOnFailure: "DO_NOTHING",
* },
* waitForInstances: false,
* });
* const a3ResizeRequest = new gcp.compute.ResizeRequest("a3_resize_request", {
* name: "a3-dws",
* instanceGroupManager: a3DwsInstanceGroupManager.name,
* zone: "us-central1-a",
* description: "Test resize request resource",
* resizeBy: 2,
* requestedRunDuration: {
* seconds: "14400",
* nanos: 0,
* },
* });
* ```
*
* ## Import
*
* ResizeRequest can be imported using any of these accepted formats:
*
* * `projects/{{project}}/zones/{{zone}}/instanceGroupManagers/{{instance_group_manager}}/resizeRequests/{{name}}`
*
* * `{{project}}/{{zone}}/{{instance_group_manager}}/{{name}}`
*
* * `{{zone}}/{{instance_group_manager}}/{{name}}`
*
* * `{{instance_group_manager}}/{{name}}`
*
* When using the `pulumi import` command, ResizeRequest can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/resizeRequest:ResizeRequest default projects/{{project}}/zones/{{zone}}/instanceGroupManagers/{{instance_group_manager}}/resizeRequests/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/resizeRequest:ResizeRequest default {{project}}/{{zone}}/{{instance_group_manager}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/resizeRequest:ResizeRequest default {{zone}}/{{instance_group_manager}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/resizeRequest:ResizeRequest default {{instance_group_manager}}/{{name}}
* ```
*/
export declare class ResizeRequest extends pulumi.CustomResource {
/**
* Get an existing ResizeRequest 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: string, id: pulumi.Input<pulumi.ID>, state?: ResizeRequestState, opts?: pulumi.CustomResourceOptions): ResizeRequest;
/**
* Returns true if the given object is an instance of ResizeRequest. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ResizeRequest;
/**
* The creation timestamp for this resize request in RFC3339 text format.
*/
readonly creationTimestamp: pulumi.Output<string>;
/**
* An optional description of this resize-request.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The reference of the instance group manager this ResizeRequest is a part of.
*
*
* - - -
*/
readonly instanceGroupManager: pulumi.Output<string>;
/**
* The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.
* Structure is documented below.
*/
readonly requestedRunDuration: pulumi.Output<outputs.compute.ResizeRequestRequestedRunDuration | undefined>;
/**
* The number of instances to be created by this resize request. The group's target size will be increased by this number.
*/
readonly resizeBy: pulumi.Output<number>;
/**
* Current state of the request.
*/
readonly state: pulumi.Output<string>;
/**
* Status of the request.
* Structure is documented below.
*/
readonly statuses: pulumi.Output<outputs.compute.ResizeRequestStatus[]>;
/**
* The reference of the compute zone scoping this request. If it is not provided, the provider zone is used.
*/
readonly zone: pulumi.Output<string>;
/**
* Create a ResizeRequest resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ResizeRequestArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ResizeRequest resources.
*/
export interface ResizeRequestState {
/**
* The creation timestamp for this resize request in RFC3339 text format.
*/
creationTimestamp?: pulumi.Input<string>;
/**
* An optional description of this resize-request.
*/
description?: pulumi.Input<string>;
/**
* The reference of the instance group manager this ResizeRequest is a part of.
*
*
* - - -
*/
instanceGroupManager?: pulumi.Input<string>;
/**
* The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.
* Structure is documented below.
*/
requestedRunDuration?: pulumi.Input<inputs.compute.ResizeRequestRequestedRunDuration>;
/**
* The number of instances to be created by this resize request. The group's target size will be increased by this number.
*/
resizeBy?: pulumi.Input<number>;
/**
* Current state of the request.
*/
state?: pulumi.Input<string>;
/**
* Status of the request.
* Structure is documented below.
*/
statuses?: pulumi.Input<pulumi.Input<inputs.compute.ResizeRequestStatus>[]>;
/**
* The reference of the compute zone scoping this request. If it is not provided, the provider zone is used.
*/
zone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ResizeRequest resource.
*/
export interface ResizeRequestArgs {
/**
* An optional description of this resize-request.
*/
description?: pulumi.Input<string>;
/**
* The reference of the instance group manager this ResizeRequest is a part of.
*
*
* - - -
*/
instanceGroupManager: pulumi.Input<string>;
/**
* The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.
* Structure is documented below.
*/
requestedRunDuration?: pulumi.Input<inputs.compute.ResizeRequestRequestedRunDuration>;
/**
* The number of instances to be created by this resize request. The group's target size will be increased by this number.
*/
resizeBy: pulumi.Input<number>;
/**
* The reference of the compute zone scoping this request. If it is not provided, the provider zone is used.
*/
zone?: pulumi.Input<string>;
}