SnapshotSettings class

Updates your project's snapshot settings and sets a new default storage location for snapshots.

To get more information about SnapshotSettings, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Snapshot Settings Specific Locations

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

const tf_test_snapshot_settings = new gcp.compute.SnapshotSettings("tf-test-snapshot-settings", {storageLocation: {
    policy: "SPECIFIC_LOCATIONS",
    locations: [{
        name: "us-central1",
        location: "us-central1",
    }],
}});

import pulumi
import pulumi_gcp as gcp

tf_test_snapshot_settings = gcp.compute.SnapshotSettings("tf-test-snapshot-settings", storage_location={
    "policy": "SPECIFIC_LOCATIONS",
    "locations": [{
        "name": "us-central1",
        "location": "us-central1",
    }],
})

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

return await Deployment.RunAsync(() =>
{
    var tf_test_snapshot_settings = new Gcp.Compute.SnapshotSettings("tf-test-snapshot-settings", new()
    {
        StorageLocation = new Gcp.Compute.Inputs.SnapshotSettingsStorageLocationArgs
        {
            Policy = "SPECIFIC_LOCATIONS",
            Locations = new[]
            {
                new Gcp.Compute.Inputs.SnapshotSettingsStorageLocationLocationArgs
                {
                    Name = "us-central1",
                    Location = "us-central1",
                },
            },
        },
    });

});

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.NewSnapshotSettings(ctx, "tf-test-snapshot-settings", &compute.SnapshotSettingsArgs{
			StorageLocation: &compute.SnapshotSettingsStorageLocationArgs{
				Policy: pulumi.String("SPECIFIC_LOCATIONS"),
				Locations: compute.SnapshotSettingsStorageLocationLocationArray{
					&compute.SnapshotSettingsStorageLocationLocationArgs{
						Name:     pulumi.String("us-central1"),
						Location: pulumi.String("us-central1"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_compute_snapshotsettings" "tf-test-snapshot-settings" {
  storage_location = {
    policy = "SPECIFIC_LOCATIONS"
    locations = [{
      "name"     = "us-central1"
      "location" = "us-central1"
    }]
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.SnapshotSettings;
import com.pulumi.gcp.compute.SnapshotSettingsArgs;
import com.pulumi.gcp.compute.inputs.SnapshotSettingsStorageLocationArgs;
import com.pulumi.gcp.compute.inputs.SnapshotSettingsStorageLocationLocationArgs;
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 tf_test_snapshot_settings = new SnapshotSettings("tf-test-snapshot-settings", SnapshotSettingsArgs.builder()
            .storageLocation(SnapshotSettingsStorageLocationArgs.builder()
                .policy("SPECIFIC_LOCATIONS")
                .locations(SnapshotSettingsStorageLocationLocationArgs.builder()
                    .name("us-central1")
                    .location("us-central1")
                    .build())
                .build())
            .build());

    }
}

resources:
  tf-test-snapshot-settings:
    type: gcp:compute:SnapshotSettings
    properties:
      storageLocation:
        policy: SPECIFIC_LOCATIONS
        locations:
          - name: us-central1
            location: us-central1

Import

SnapshotSettings can be imported using any of these accepted formats:

• projects/{{project}}/global/snapshotSettings/
• {{project}}

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

$ pulumi import gcp:compute/snapshotSettings:SnapshotSettings default projects/{{project}}/global/snapshotSettings/
$ pulumi import gcp:compute/snapshotSettings:SnapshotSettings default {{project}}

Constructors

SnapshotSettings(String name, {SnapshotSettingsArgs? args, CustomResourceOptions? options})

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

SnapshotSettings.reference(String urn)

Creates a typed reference to an existing SnapshotSettings resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

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

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

storageLocation ↔ Output<SnapshotSettingsStorageLocation>

Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out Structure is documented below.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

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, {SnapshotSettingsState? state, CustomResourceOptions? options}) → SnapshotSettings

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