@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * A config defined for a single managed instance that belongs to an instance group manager. It preserves the instance name * across instance group manager operations and can define stateful disks or metadata that are unique to the instance. * This resource works with regional instance group managers. * * To get more information about RegionPerInstanceConfig, see: * * * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers) * * How-to Guides * * [Official Documentation](https://cloud.google.com/compute/docs/instance-groups/stateful-migs#per-instance_configs) * * ## Example Usage * * ### Stateful Rigm * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const myImage = gcp.compute.getImage({ * family: "debian-11", * project: "debian-cloud", * }); * const igm_basic = new gcp.compute.InstanceTemplate("igm-basic", { * name: "my-template", * machineType: "e2-medium", * canIpForward: false, * tags: [ * "foo", * "bar", * ], * disks: [{ * sourceImage: myImage.then(myImage => myImage.selfLink), * autoDelete: true, * boot: true, * }], * networkInterfaces: [{ * network: "default", * }], * serviceAccount: { * scopes: [ * "userinfo-email", * "compute-ro", * "storage-ro", * ], * }, * }); * const rigm = new gcp.compute.RegionInstanceGroupManager("rigm", { * description: "Demo test instance group manager", * name: "my-rigm", * versions: [{ * name: "prod", * instanceTemplate: igm_basic.selfLink, * }], * updatePolicy: { * type: "OPPORTUNISTIC", * instanceRedistributionType: "NONE", * minimalAction: "RESTART", * }, * baseInstanceName: "rigm", * region: "us-central1", * targetSize: 2, * }); * const _default = new gcp.compute.Disk("default", { * name: "my-disk-name", * type: "pd-ssd", * zone: "us-central1-a", * image: "debian-11-bullseye-v20220719", * physicalBlockSizeBytes: 4096, * }); * const withDisk = new gcp.compute.RegionPerInstanceConfig("with_disk", { * region: igm.region, * regionInstanceGroupManager: rigm.name, * name: "instance-1", * preservedState: { * metadata: { * foo: "bar", * instance_template: igm_basic.selfLink, * }, * disks: [{ * deviceName: "my-stateful-disk", * source: _default.id, * mode: "READ_ONLY", * }], * }, * }); * ``` * * ## Import * * RegionPerInstanceConfig can be imported using any of these accepted formats: * * * `projects/{{project}}/regions/{{region}}/instanceGroupManagers/{{region_instance_group_manager}}/{{name}}` * * * `{{project}}/{{region}}/{{region_instance_group_manager}}/{{name}}` * * * `{{region}}/{{region_instance_group_manager}}/{{name}}` * * * `{{region_instance_group_manager}}/{{name}}` * * When using the `pulumi import` command, RegionPerInstanceConfig can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/regionPerInstanceConfig:RegionPerInstanceConfig default projects/{{project}}/regions/{{region}}/instanceGroupManagers/{{region_instance_group_manager}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/regionPerInstanceConfig:RegionPerInstanceConfig default {{project}}/{{region}}/{{region_instance_group_manager}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/regionPerInstanceConfig:RegionPerInstanceConfig default {{region}}/{{region_instance_group_manager}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:compute/regionPerInstanceConfig:RegionPerInstanceConfig default {{region_instance_group_manager}}/{{name}} * ``` */ export declare class RegionPerInstanceConfig extends pulumi.CustomResource { /** * Get an existing RegionPerInstanceConfig 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?: RegionPerInstanceConfigState, opts?: pulumi.CustomResourceOptions): RegionPerInstanceConfig; /** * Returns true if the given object is an instance of RegionPerInstanceConfig. 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 RegionPerInstanceConfig; /** * The minimal action to perform on the instance during an update. * Default is `NONE`. Possible values are: * * REPLACE * * RESTART * * REFRESH * * NONE */ readonly minimalAction: pulumi.Output<string | undefined>; /** * The most disruptive action to perform on the instance during an update. * Default is `REPLACE`. Possible values are: * * REPLACE * * RESTART * * REFRESH * * NONE */ readonly mostDisruptiveAllowedAction: pulumi.Output<string | undefined>; /** * The name for this per-instance config and its corresponding instance. */ readonly name: pulumi.Output<string>; /** * The preserved state for this instance. * Structure is documented below. */ readonly preservedState: pulumi.Output<outputs.compute.RegionPerInstanceConfigPreservedState | undefined>; /** * 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>; /** * Region where the containing instance group manager is located */ readonly region: pulumi.Output<string>; /** * The region instance group manager this instance config is part of. */ readonly regionInstanceGroupManager: pulumi.Output<string>; /** * When true, deleting this config will immediately remove the underlying instance. * When false, deleting this config will use the behavior as determined by remove_instance_on_destroy. */ readonly removeInstanceOnDestroy: pulumi.Output<boolean | undefined>; /** * When true, deleting this config will immediately remove any specified state from the underlying instance. * When false, deleting this config will *not* immediately remove any state from the underlying instance. * State will be removed on the next instance recreation or update. */ readonly removeInstanceStateOnDestroy: pulumi.Output<boolean | undefined>; /** * Create a RegionPerInstanceConfig 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: RegionPerInstanceConfigArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering RegionPerInstanceConfig resources. */ export interface RegionPerInstanceConfigState { /** * The minimal action to perform on the instance during an update. * Default is `NONE`. Possible values are: * * REPLACE * * RESTART * * REFRESH * * NONE */ minimalAction?: pulumi.Input<string>; /** * The most disruptive action to perform on the instance during an update. * Default is `REPLACE`. Possible values are: * * REPLACE * * RESTART * * REFRESH * * NONE */ mostDisruptiveAllowedAction?: pulumi.Input<string>; /** * The name for this per-instance config and its corresponding instance. */ name?: pulumi.Input<string>; /** * The preserved state for this instance. * Structure is documented below. */ preservedState?: pulumi.Input<inputs.compute.RegionPerInstanceConfigPreservedState>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string>; /** * Region where the containing instance group manager is located */ region?: pulumi.Input<string>; /** * The region instance group manager this instance config is part of. */ regionInstanceGroupManager?: pulumi.Input<string>; /** * When true, deleting this config will immediately remove the underlying instance. * When false, deleting this config will use the behavior as determined by remove_instance_on_destroy. */ removeInstanceOnDestroy?: pulumi.Input<boolean>; /** * When true, deleting this config will immediately remove any specified state from the underlying instance. * When false, deleting this config will *not* immediately remove any state from the underlying instance. * State will be removed on the next instance recreation or update. */ removeInstanceStateOnDestroy?: pulumi.Input<boolean>; } /** * The set of arguments for constructing a RegionPerInstanceConfig resource. */ export interface RegionPerInstanceConfigArgs { /** * The minimal action to perform on the instance during an update. * Default is `NONE`. Possible values are: * * REPLACE * * RESTART * * REFRESH * * NONE */ minimalAction?: pulumi.Input<string>; /** * The most disruptive action to perform on the instance during an update. * Default is `REPLACE`. Possible values are: * * REPLACE * * RESTART * * REFRESH * * NONE */ mostDisruptiveAllowedAction?: pulumi.Input<string>; /** * The name for this per-instance config and its corresponding instance. */ name?: pulumi.Input<string>; /** * The preserved state for this instance. * Structure is documented below. */ preservedState?: pulumi.Input<inputs.compute.RegionPerInstanceConfigPreservedState>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string>; /** * Region where the containing instance group manager is located */ region?: pulumi.Input<string>; /** * The region instance group manager this instance config is part of. */ regionInstanceGroupManager: pulumi.Input<string>; /** * When true, deleting this config will immediately remove the underlying instance. * When false, deleting this config will use the behavior as determined by remove_instance_on_destroy. */ removeInstanceOnDestroy?: pulumi.Input<boolean>; /** * When true, deleting this config will immediately remove any specified state from the underlying instance. * When false, deleting this config will *not* immediately remove any state from the underlying instance. * State will be removed on the next instance recreation or update. */ removeInstanceStateOnDestroy?: pulumi.Input<boolean>; }