@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
195 lines • 8.28 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A config defined for multiple managed instances that belong to an instance group manager with target_size_policy.mode=BULK.
*
* To get more information about BulkPerInstanceConfig, 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/bulk-create-instances-in-mig)
*
* ## Example Usage
*
* ### Compute Bulk Per Instance Config
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myImage = gcp.compute.getImage({
* family: "debian-12",
* project: "debian-cloud",
* });
* const bulk_igm = new gcp.compute.InstanceTemplate("bulk-igm", {
* name: "bulk-igm-template",
* machineType: "e2-medium",
* disks: [{
* sourceImage: myImage.then(myImage => myImage.selfLink),
* autoDelete: true,
* boot: true,
* }],
* networkInterfaces: [{
* network: "default",
* }],
* });
* const bulk_igmInstanceGroupManager = new gcp.compute.InstanceGroupManager("bulk-igm", {
* description: "Terraform test bulk instance group manager",
* name: "bulk-igm",
* zone: "us-central1-a",
* baseInstanceName: "bulk-igm",
* versions: [{
* name: "prod",
* instanceTemplate: bulk_igm.selfLink,
* }],
* });
* const bulk_igm_per_instance_config = new gcp.compute.BulkPerInstanceConfig("bulk-igm-per-instance-config", {
* zone: bulk_igmInstanceGroupManager.zone,
* instanceGroupManager: bulk_igmInstanceGroupManager.name,
* instances: [
* {
* name: "per-instance-config-instance-1",
* },
* {
* name: "per-instance-config-instance-2",
* },
* ],
* });
* ```
*
* ## Import
*
* BulkPerInstanceConfig can be imported using any of these accepted formats:
*
* * `projects/{{project}}/zones/{{zone}}/instanceGroupManagers/{{instance_group_manager}}`
* * `{{project}}/{{zone}}/{{instance_group_manager}}`
* * `{{zone}}/{{instance_group_manager}}`
* * `{{instance_group_manager}}`
*
* When using the `pulumi import` command, BulkPerInstanceConfig can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/bulkPerInstanceConfig:BulkPerInstanceConfig default projects/{{project}}/zones/{{zone}}/instanceGroupManagers/{{instance_group_manager}}
* $ pulumi import gcp:compute/bulkPerInstanceConfig:BulkPerInstanceConfig default {{project}}/{{zone}}/{{instance_group_manager}}
* $ pulumi import gcp:compute/bulkPerInstanceConfig:BulkPerInstanceConfig default {{zone}}/{{instance_group_manager}}
* $ pulumi import gcp:compute/bulkPerInstanceConfig:BulkPerInstanceConfig default {{instance_group_manager}}
* ```
*/
export declare class BulkPerInstanceConfig extends pulumi.CustomResource {
/**
* Get an existing BulkPerInstanceConfig 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?: BulkPerInstanceConfigState, opts?: pulumi.CustomResourceOptions): BulkPerInstanceConfig;
/**
* Returns true if the given object is an instance of BulkPerInstanceConfig. 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 BulkPerInstanceConfig;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* The instance group manager this instance config is part of.
*/
readonly instanceGroupManager: pulumi.Output<string>;
/**
* The list of per-instance configs.
* Structure is documented below.
*/
readonly instances: pulumi.Output<outputs.compute.BulkPerInstanceConfigInstance[] | 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>;
/**
* Zone where the containing instance group manager is located
*/
readonly zone: pulumi.Output<string>;
/**
* Create a BulkPerInstanceConfig 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: BulkPerInstanceConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BulkPerInstanceConfig resources.
*/
export interface BulkPerInstanceConfigState {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The instance group manager this instance config is part of.
*/
instanceGroupManager?: pulumi.Input<string | undefined>;
/**
* The list of per-instance configs.
* Structure is documented below.
*/
instances?: pulumi.Input<pulumi.Input<inputs.compute.BulkPerInstanceConfigInstance>[] | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Zone where the containing instance group manager is located
*/
zone?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a BulkPerInstanceConfig resource.
*/
export interface BulkPerInstanceConfigArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The instance group manager this instance config is part of.
*/
instanceGroupManager: pulumi.Input<string>;
/**
* The list of per-instance configs.
* Structure is documented below.
*/
instances?: pulumi.Input<pulumi.Input<inputs.compute.BulkPerInstanceConfigInstance>[] | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Zone where the containing instance group manager is located
*/
zone?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=bulkPerInstanceConfig.d.ts.map