PerInstanceConfig

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.

To get more information about PerInstanceConfig, see:

API documentation
How-to Guides
- Official Documentation

Create a PerInstanceConfig Resource

new PerInstanceConfig(name: string, args: PerInstanceConfigArgs, opts?: CustomResourceOptions);

def PerInstanceConfig(resource_name, opts=None, instance_group_manager=None, minimal_action=None, most_disruptive_allowed_action=None, name=None, preserved_state=None, project=None, remove_instance_state_on_destroy=None, zone=None, __props__=None);

func NewPerInstanceConfig(ctx *Context, name string, args PerInstanceConfigArgs, opts ...ResourceOption) (*PerInstanceConfig, error)

public PerInstanceConfig(string name, PerInstanceConfigArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args PerInstanceConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PerInstanceConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PerInstanceConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

PerInstanceConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The PerInstanceConfig resource accepts the following input properties:

InstanceGroupManager string: The instance group manager this instance config is part of.
Zone string: Zone where the containing instance group manager is located
MinimalAction string: The minimal action to perform on the instance during an update. Default is NONE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
MostDisruptiveAllowedAction string: The most disruptive action to perform on the instance during an update. Default is REPLACE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
Name string: The name for this per-instance config and its corresponding instance.
PreservedState PerInstanceConfigPreservedStateArgs: The preserved state for this instance. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RemoveInstanceStateOnDestroy bool: 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.

InstanceGroupManager string: The instance group manager this instance config is part of.
Zone string: Zone where the containing instance group manager is located
MinimalAction string: The minimal action to perform on the instance during an update. Default is NONE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
MostDisruptiveAllowedAction string: The most disruptive action to perform on the instance during an update. Default is REPLACE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
Name string: The name for this per-instance config and its corresponding instance.
PreservedState PerInstanceConfigPreservedState: The preserved state for this instance. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RemoveInstanceStateOnDestroy bool: 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.

instanceGroupManager string: The instance group manager this instance config is part of.
zone string: Zone where the containing instance group manager is located
minimalAction string: The minimal action to perform on the instance during an update. Default is NONE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
mostDisruptiveAllowedAction string: The most disruptive action to perform on the instance during an update. Default is REPLACE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
name string: The name for this per-instance config and its corresponding instance.
preservedState PerInstanceConfigPreservedState: The preserved state for this instance. Structure is documented below.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
removeInstanceStateOnDestroy 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.

instance_group_manager str: The instance group manager this instance config is part of.
zone str: Zone where the containing instance group manager is located
minimal_action str: The minimal action to perform on the instance during an update. Default is NONE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
most_disruptive_allowed_action str: The most disruptive action to perform on the instance during an update. Default is REPLACE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
name str: The name for this per-instance config and its corresponding instance.
preserved_state Dict[PerInstanceConfigPreservedState]: The preserved state for this instance. Structure is documented below.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
remove_instance_state_on_destroy bool: 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the PerInstanceConfig resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing PerInstanceConfig Resource

Get an existing PerInstanceConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PerInstanceConfigState, opts?: CustomResourceOptions): PerInstanceConfig

static get(resource_name, id, opts=None, instance_group_manager=None, minimal_action=None, most_disruptive_allowed_action=None, name=None, preserved_state=None, project=None, remove_instance_state_on_destroy=None, zone=None, __props__=None);

func GetPerInstanceConfig(ctx *Context, name string, id IDInput, state *PerInstanceConfigState, opts ...ResourceOption) (*PerInstanceConfig, error)

public static PerInstanceConfig Get(string name, Input<string> id, PerInstanceConfigState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

InstanceGroupManager string: The instance group manager this instance config is part of.
MinimalAction string: The minimal action to perform on the instance during an update. Default is NONE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
MostDisruptiveAllowedAction string: The most disruptive action to perform on the instance during an update. Default is REPLACE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
Name string: The name for this per-instance config and its corresponding instance.
PreservedState PerInstanceConfigPreservedStateArgs: The preserved state for this instance. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RemoveInstanceStateOnDestroy bool: 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.
Zone string: Zone where the containing instance group manager is located

InstanceGroupManager string: The instance group manager this instance config is part of.
MinimalAction string: The minimal action to perform on the instance during an update. Default is NONE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
MostDisruptiveAllowedAction string: The most disruptive action to perform on the instance during an update. Default is REPLACE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
Name string: The name for this per-instance config and its corresponding instance.
PreservedState PerInstanceConfigPreservedState: The preserved state for this instance. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RemoveInstanceStateOnDestroy bool: 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.
Zone string: Zone where the containing instance group manager is located

instanceGroupManager string: The instance group manager this instance config is part of.
minimalAction string: The minimal action to perform on the instance during an update. Default is NONE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
mostDisruptiveAllowedAction string: The most disruptive action to perform on the instance during an update. Default is REPLACE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
name string: The name for this per-instance config and its corresponding instance.
preservedState PerInstanceConfigPreservedState: The preserved state for this instance. Structure is documented below.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
removeInstanceStateOnDestroy 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.
zone string: Zone where the containing instance group manager is located

instance_group_manager str: The instance group manager this instance config is part of.
minimal_action str: The minimal action to perform on the instance during an update. Default is NONE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
most_disruptive_allowed_action str: The most disruptive action to perform on the instance during an update. Default is REPLACE. Possible values are: * REPLACE * RESTART * REFRESH * NONE
name str: The name for this per-instance config and its corresponding instance.
preserved_state Dict[PerInstanceConfigPreservedState]: The preserved state for this instance. Structure is documented below.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
remove_instance_state_on_destroy bool: 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.
zone str: Zone where the containing instance group manager is located

Supporting Types

PerInstanceConfigPreservedState

See the input and output API doc for this type.

Disks List<PerInstanceConfigPreservedStateDiskArgs>: Stateful disks for the instance. Structure is documented below.
Metadata Dictionary<string, string>: Preserved metadata defined for this instance. This is a list of key->value pairs.

Disks []PerInstanceConfigPreservedStateDisk: Stateful disks for the instance. Structure is documented below.
Metadata map[string]string: Preserved metadata defined for this instance. This is a list of key->value pairs.

disks PerInstanceConfigPreservedStateDisk[]: Stateful disks for the instance. Structure is documented below.
metadata {[key: string]: string}: Preserved metadata defined for this instance. This is a list of key->value pairs.

disks List[PerInstanceConfigPreservedStateDisk]: Stateful disks for the instance. Structure is documented below.
metadata Dict[str, str]: Preserved metadata defined for this instance. This is a list of key->value pairs.

PerInstanceConfigPreservedStateDisk

See the input and output API doc for this type.

DeviceName string: A unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance.
Source string: The URI of an existing persistent disk to attach under the specified device-name in the format projects/project-id/zones/zone/disks/disk-name.
DeleteRule string: A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group.
Mode string: The mode of the disk.

DeviceName string: A unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance.
Source string: The URI of an existing persistent disk to attach under the specified device-name in the format projects/project-id/zones/zone/disks/disk-name.
DeleteRule string: A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group.
Mode string: The mode of the disk.

deviceName string: A unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance.
source string: The URI of an existing persistent disk to attach under the specified device-name in the format projects/project-id/zones/zone/disks/disk-name.
deleteRule string: A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group.
mode string: The mode of the disk.

device_name str: A unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance.
source str: The URI of an existing persistent disk to attach under the specified device-name in the format projects/project-id/zones/zone/disks/disk-name.
deleteRule str: A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group.
mode str: The mode of the disk.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud