InstanceSettings class

Represents an Instance Settings resource. Instance settings are centralized configuration parameters that allow users to configure the default values for specific VM parameters that are normally set using GCE instance API methods.

To get more information about InstanceSettings, see:

• API documentation
• How-to Guides
• Update Instance Settings

Example Usage

Instance Settings Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const gceInstanceSettings = new gcp.compute.InstanceSettings("gce_instance_settings", {
    zone: "us-east7-b",
    metadata: {
        items: {
            foo: "baz",
        },
    },
});

import pulumi
import pulumi_gcp as gcp

gce_instance_settings = gcp.compute.InstanceSettings("gce_instance_settings",
    zone="us-east7-b",
    metadata={
        "items": {
            "foo": "baz",
        },
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var gceInstanceSettings = new Gcp.Compute.InstanceSettings("gce_instance_settings", new()
    {
        Zone = "us-east7-b",
        Metadata = new Gcp.Compute.Inputs.InstanceSettingsMetadataArgs
        {
            Items =
            {
                { "foo", "baz" },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewInstanceSettings(ctx, "gce_instance_settings", &compute.InstanceSettingsArgs{
			Zone: pulumi.String("us-east7-b"),
			Metadata: &compute.InstanceSettingsMetadataArgs{
				Items: pulumi.StringMap{
					"foo": pulumi.String("baz"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_compute_instancesettings" "gce_instance_settings" {
  zone = "us-east7-b"
  metadata = {
    items = {
      "foo" = "baz"
    }
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.InstanceSettings;
import com.pulumi.gcp.compute.InstanceSettingsArgs;
import com.pulumi.gcp.compute.inputs.InstanceSettingsMetadataArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var gceInstanceSettings = new InstanceSettings("gceInstanceSettings", InstanceSettingsArgs.builder()
            .zone("us-east7-b")
            .metadata(InstanceSettingsMetadataArgs.builder()
                .items(Map.of("foo", "baz"))
                .build())
            .build());

    }
}

resources:
  gceInstanceSettings:
    type: gcp:compute:InstanceSettings
    name: gce_instance_settings
    properties:
      zone: us-east7-b
      metadata:
        items:
          foo: baz

Import

InstanceSettings can be imported using any of these accepted formats:

• projects/{{project}}/zones/{{zone}}/instanceSettings
• {{project}}/{{zone}}
• {{zone}}

When using the pulumi import command, InstanceSettings can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/instanceSettings:InstanceSettings default projects/{{project}}/zones/{{zone}}/instanceSettings
$ pulumi import gcp:compute/instanceSettings:InstanceSettings default {{project}}/{{zone}}
$ pulumi import gcp:compute/instanceSettings:InstanceSettings default {{zone}}

Constructors

InstanceSettings(String name, {InstanceSettingsArgs? args, CustomResourceOptions? options})

Creates a new InstanceSettings. name The Pulumi resource name. args Arguments used to configure this InstanceSettings. The set of arguments for InstanceSettings. options Resource options controlling this resource's behavior.

InstanceSettings.reference(String urn)

Creates a typed reference to an existing InstanceSettings resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

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.

late, final

fingerprint ↔ Output<String>

The fingerprint used for optimistic locking of this resource. Used internally during updates.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

metadata ↔ Output<InstanceSettingsMetadata?>

The metadata key/value pairs assigned to all the instances in the corresponding scope. Structure is documented below.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

zone ↔ Output<String>

A reference to the zone where the machine resides.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {InstanceSettingsState? state, CustomResourceOptions? options}) → InstanceSettings

Gets an existing InstanceSettings resource's state with the given name and id.