pulumi-gcp-kotlin/com.pulumi.gcp.filestore.kotlin/Snapshot

Snapshot

class Snapshot : KotlinCustomResource

A Google Cloud Filestore snapshot. To get more information about Snapshot, see:

Example Usage

Filestore Snapshot Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const instance = new gcp.filestore.Instance("instance", {
    name: "test-instance-for-snapshot",
    location: "us-east1",
    tier: "ENTERPRISE",
    fileShares: {
        capacityGb: 1024,
        name: "share1",
    },
    networks: [{
        network: "default",
        modes: ["MODE_IPV4"],
    }],
});
const snapshot = new gcp.filestore.Snapshot("snapshot", {
    name: "test-snapshot",
    instance: instance.name,
    location: "us-east1",
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
instance = gcp.filestore.Instance("instance",
    name="test-instance-for-snapshot",
    location="us-east1",
    tier="ENTERPRISE",
    file_shares={
        "capacity_gb": 1024,
        "name": "share1",
    },
    networks=[{
        "network": "default",
        "modes": ["MODE_IPV4"],
    }])
snapshot = gcp.filestore.Snapshot("snapshot",
    name="test-snapshot",
    instance=instance.name,
    location="us-east1")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var instance = new Gcp.Filestore.Instance("instance", new()
    {
        Name = "test-instance-for-snapshot",
        Location = "us-east1",
        Tier = "ENTERPRISE",
        FileShares = new Gcp.Filestore.Inputs.InstanceFileSharesArgs
        {
            CapacityGb = 1024,
            Name = "share1",
        },
        Networks = new[]
        {
            new Gcp.Filestore.Inputs.InstanceNetworkArgs
            {
                Network = "default",
                Modes = new[]
                {
                    "MODE_IPV4",
                },
            },
        },
    });
    var snapshot = new Gcp.Filestore.Snapshot("snapshot", new()
    {
        Name = "test-snapshot",
        Instance = instance.Name,
        Location = "us-east1",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/filestore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := filestore.NewInstance(ctx, "instance", &filestore.InstanceArgs{
			Name:     pulumi.String("test-instance-for-snapshot"),
			Location: pulumi.String("us-east1"),
			Tier:     pulumi.String("ENTERPRISE"),
			FileShares: &filestore.InstanceFileSharesArgs{
				CapacityGb: pulumi.Int(1024),
				Name:       pulumi.String("share1"),
			},
			Networks: filestore.InstanceNetworkArray{
				&filestore.InstanceNetworkArgs{
					Network: pulumi.String("default"),
					Modes: pulumi.StringArray{
						pulumi.String("MODE_IPV4"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = filestore.NewSnapshot(ctx, "snapshot", &filestore.SnapshotArgs{
			Name:     pulumi.String("test-snapshot"),
			Instance: instance.Name,
			Location: pulumi.String("us-east1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.filestore.Instance;
import com.pulumi.gcp.filestore.InstanceArgs;
import com.pulumi.gcp.filestore.inputs.InstanceFileSharesArgs;
import com.pulumi.gcp.filestore.inputs.InstanceNetworkArgs;
import com.pulumi.gcp.filestore.Snapshot;
import com.pulumi.gcp.filestore.SnapshotArgs;
import java.util.List;
import java.util.ArrayList;
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 instance = new Instance("instance", InstanceArgs.builder()
            .name("test-instance-for-snapshot")
            .location("us-east1")
            .tier("ENTERPRISE")
            .fileShares(InstanceFileSharesArgs.builder()
                .capacityGb(1024)
                .name("share1")
                .build())
            .networks(InstanceNetworkArgs.builder()
                .network("default")
                .modes("MODE_IPV4")
                .build())
            .build());
        var snapshot = new Snapshot("snapshot", SnapshotArgs.builder()
            .name("test-snapshot")
            .instance(instance.name())
            .location("us-east1")
            .build());
    }
}
Content copied to clipboard
resources:
  snapshot:
    type: gcp:filestore:Snapshot
    properties:
      name: test-snapshot
      instance: ${instance.name}
      location: us-east1
  instance:
    type: gcp:filestore:Instance
    properties:
      name: test-instance-for-snapshot
      location: us-east1
      tier: ENTERPRISE
      fileShares:
        capacityGb: 1024
        name: share1
      networks:
        - network: default
          modes:
            - MODE_IPV4
Content copied to clipboard

Filestore Snapshot Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const instance = new gcp.filestore.Instance("instance", {
    name: "test-instance-for-snapshot",
    location: "us-west1",
    tier: "ENTERPRISE",
    fileShares: {
        capacityGb: 1024,
        name: "share1",
    },
    networks: [{
        network: "default",
        modes: ["MODE_IPV4"],
    }],
});
const snapshot = new gcp.filestore.Snapshot("snapshot", {
    name: "test-snapshot",
    instance: instance.name,
    location: "us-west1",
    description: "Snapshot of test-instance-for-snapshot",
    labels: {
        my_label: "value",
    },
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
instance = gcp.filestore.Instance("instance",
    name="test-instance-for-snapshot",
    location="us-west1",
    tier="ENTERPRISE",
    file_shares={
        "capacity_gb": 1024,
        "name": "share1",
    },
    networks=[{
        "network": "default",
        "modes": ["MODE_IPV4"],
    }])
snapshot = gcp.filestore.Snapshot("snapshot",
    name="test-snapshot",
    instance=instance.name,
    location="us-west1",
    description="Snapshot of test-instance-for-snapshot",
    labels={
        "my_label": "value",
    })
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var instance = new Gcp.Filestore.Instance("instance", new()
    {
        Name = "test-instance-for-snapshot",
        Location = "us-west1",
        Tier = "ENTERPRISE",
        FileShares = new Gcp.Filestore.Inputs.InstanceFileSharesArgs
        {
            CapacityGb = 1024,
            Name = "share1",
        },
        Networks = new[]
        {
            new Gcp.Filestore.Inputs.InstanceNetworkArgs
            {
                Network = "default",
                Modes = new[]
                {
                    "MODE_IPV4",
                },
            },
        },
    });
    var snapshot = new Gcp.Filestore.Snapshot("snapshot", new()
    {
        Name = "test-snapshot",
        Instance = instance.Name,
        Location = "us-west1",
        Description = "Snapshot of test-instance-for-snapshot",
        Labels =
        {
            { "my_label", "value" },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/filestore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instance, err := filestore.NewInstance(ctx, "instance", &filestore.InstanceArgs{
			Name:     pulumi.String("test-instance-for-snapshot"),
			Location: pulumi.String("us-west1"),
			Tier:     pulumi.String("ENTERPRISE"),
			FileShares: &filestore.InstanceFileSharesArgs{
				CapacityGb: pulumi.Int(1024),
				Name:       pulumi.String("share1"),
			},
			Networks: filestore.InstanceNetworkArray{
				&filestore.InstanceNetworkArgs{
					Network: pulumi.String("default"),
					Modes: pulumi.StringArray{
						pulumi.String("MODE_IPV4"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = filestore.NewSnapshot(ctx, "snapshot", &filestore.SnapshotArgs{
			Name:        pulumi.String("test-snapshot"),
			Instance:    instance.Name,
			Location:    pulumi.String("us-west1"),
			Description: pulumi.String("Snapshot of test-instance-for-snapshot"),
			Labels: pulumi.StringMap{
				"my_label": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.filestore.Instance;
import com.pulumi.gcp.filestore.InstanceArgs;
import com.pulumi.gcp.filestore.inputs.InstanceFileSharesArgs;
import com.pulumi.gcp.filestore.inputs.InstanceNetworkArgs;
import com.pulumi.gcp.filestore.Snapshot;
import com.pulumi.gcp.filestore.SnapshotArgs;
import java.util.List;
import java.util.ArrayList;
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 instance = new Instance("instance", InstanceArgs.builder()
            .name("test-instance-for-snapshot")
            .location("us-west1")
            .tier("ENTERPRISE")
            .fileShares(InstanceFileSharesArgs.builder()
                .capacityGb(1024)
                .name("share1")
                .build())
            .networks(InstanceNetworkArgs.builder()
                .network("default")
                .modes("MODE_IPV4")
                .build())
            .build());
        var snapshot = new Snapshot("snapshot", SnapshotArgs.builder()
            .name("test-snapshot")
            .instance(instance.name())
            .location("us-west1")
            .description("Snapshot of test-instance-for-snapshot")
            .labels(Map.of("my_label", "value"))
            .build());
    }
}
Content copied to clipboard
resources:
  snapshot:
    type: gcp:filestore:Snapshot
    properties:
      name: test-snapshot
      instance: ${instance.name}
      location: us-west1
      description: Snapshot of test-instance-for-snapshot
      labels:
        my_label: value
  instance:
    type: gcp:filestore:Instance
    properties:
      name: test-instance-for-snapshot
      location: us-west1
      tier: ENTERPRISE
      fileShares:
        capacityGb: 1024
        name: share1
      networks:
        - network: default
          modes:
            - MODE_IPV4
Content copied to clipboard

Import

Snapshot can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/instances/{{instance}}/snapshots/{{name}}

  • {{project}}/{{location}}/{{instance}}/{{name}}

  • {{location}}/{{instance}}/{{name}} When using the pulumi import command, Snapshot can be imported using one of the formats above. For example:

$ pulumi import gcp:filestore/snapshot:Snapshot default projects/{{project}}/locations/{{location}}/instances/{{instance}}/snapshots/{{name}}
Content copied to clipboard
$ pulumi import gcp:filestore/snapshot:Snapshot default {{project}}/{{location}}/{{instance}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:filestore/snapshot:Snapshot default {{location}}/{{instance}}/{{name}}
Content copied to clipboard

Properties

Link copied to clipboard
val createTime: Output<String>

The time when the snapshot was created in RFC3339 text format.

Link copied to clipboard
val description: Output<String>?

A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.

Link copied to clipboard
val effectiveLabels: Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

Link copied to clipboard
val filesystemUsedBytes: Output<String>

The amount of bytes needed to allocate a full copy of the snapshot content.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val instance: Output<String>

The resource name of the filestore instance.

Link copied to clipboard
val labels: Output<Map<String, String>>?

Resource labels to represent user-provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Link copied to clipboard
val location: Output<String>

The name of the location of the instance. This can be a region for ENTERPRISE tier instances.

Link copied to clipboard
val name: Output<String>

The resource name of the snapshot. The name must be unique within the specified instance. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Link copied to clipboard
val project: Output<String>

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
val pulumiLabels: Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val state: Output<String>

The snapshot state.

Link copied to clipboard
val urn: Output<String>