1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. lustre
  5. Instance
Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi

gcp.lustre.Instance

Explore with Pulumi AI

gcp logo
Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi

    A Managed Lustre instance

    Example Usage

    Lustre Instance Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    // This example assumes this network already exists.
    // The API creates a tenant network per network authorized for a
    // Lustre instance and that network is not deleted when the user-created
    // network (authorized_network) is deleted, so this prevents issues
    // with tenant network quota.
    // If this network hasn't been created and you are using this example in your
    // config, add an additional network resource or change
    // this from "data"to "resource"
    const lustre_network = gcp.compute.getNetwork({
        name: "my-network",
    });
    const instance = new gcp.lustre.Instance("instance", {
        instanceId: "my-instance",
        location: "us-central1-a",
        description: "test lustre instance",
        filesystem: "testfs",
        capacityGib: "18000",
        network: lustre_network.then(lustre_network => lustre_network.id),
        labels: {
            test: "value",
        },
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    # This example assumes this network already exists.
    # The API creates a tenant network per network authorized for a
    # Lustre instance and that network is not deleted when the user-created
    # network (authorized_network) is deleted, so this prevents issues
    # with tenant network quota.
    # If this network hasn't been created and you are using this example in your
    # config, add an additional network resource or change
    # this from "data"to "resource"
    lustre_network = gcp.compute.get_network(name="my-network")
    instance = gcp.lustre.Instance("instance",
        instance_id="my-instance",
        location="us-central1-a",
        description="test lustre instance",
        filesystem="testfs",
        capacity_gib="18000",
        network=lustre_network.id,
        labels={
            "test": "value",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/lustre"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// This example assumes this network already exists.
    		// The API creates a tenant network per network authorized for a
    		// Lustre instance and that network is not deleted when the user-created
    		// network (authorized_network) is deleted, so this prevents issues
    		// with tenant network quota.
    		// If this network hasn't been created and you are using this example in your
    		// config, add an additional network resource or change
    		// this from "data"to "resource"
    		lustre_network, err := compute.LookupNetwork(ctx, &compute.LookupNetworkArgs{
    			Name: "my-network",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = lustre.NewInstance(ctx, "instance", &lustre.InstanceArgs{
    			InstanceId:  pulumi.String("my-instance"),
    			Location:    pulumi.String("us-central1-a"),
    			Description: pulumi.String("test lustre instance"),
    			Filesystem:  pulumi.String("testfs"),
    			CapacityGib: pulumi.String("18000"),
    			Network:     pulumi.String(lustre_network.Id),
    			Labels: pulumi.StringMap{
    				"test": pulumi.String("value"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        // This example assumes this network already exists.
        // The API creates a tenant network per network authorized for a
        // Lustre instance and that network is not deleted when the user-created
        // network (authorized_network) is deleted, so this prevents issues
        // with tenant network quota.
        // If this network hasn't been created and you are using this example in your
        // config, add an additional network resource or change
        // this from "data"to "resource"
        var lustre_network = Gcp.Compute.GetNetwork.Invoke(new()
        {
            Name = "my-network",
        });
    
        var instance = new Gcp.Lustre.Instance("instance", new()
        {
            InstanceId = "my-instance",
            Location = "us-central1-a",
            Description = "test lustre instance",
            Filesystem = "testfs",
            CapacityGib = "18000",
            Network = lustre_network.Apply(lustre_network => lustre_network.Apply(getNetworkResult => getNetworkResult.Id)),
            Labels = 
            {
                { "test", "value" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.compute.ComputeFunctions;
    import com.pulumi.gcp.compute.inputs.GetNetworkArgs;
    import com.pulumi.gcp.lustre.Instance;
    import com.pulumi.gcp.lustre.InstanceArgs;
    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) {
            // This example assumes this network already exists.
            // The API creates a tenant network per network authorized for a
            // Lustre instance and that network is not deleted when the user-created
            // network (authorized_network) is deleted, so this prevents issues
            // with tenant network quota.
            // If this network hasn't been created and you are using this example in your
            // config, add an additional network resource or change
            // this from "data"to "resource"
            final var lustre-network = ComputeFunctions.getNetwork(GetNetworkArgs.builder()
                .name("my-network")
                .build());
    
            var instance = new Instance("instance", InstanceArgs.builder()
                .instanceId("my-instance")
                .location("us-central1-a")
                .description("test lustre instance")
                .filesystem("testfs")
                .capacityGib("18000")
                .network(lustre_network.id())
                .labels(Map.of("test", "value"))
                .build());
    
        }
    }
    
    resources:
      instance:
        type: gcp:lustre:Instance
        properties:
          instanceId: my-instance
          location: us-central1-a
          description: test lustre instance
          filesystem: testfs
          capacityGib: 18000
          network: ${["lustre-network"].id}
          labels:
            test: value
    variables:
      # This example assumes this network already exists.
      # // The API creates a tenant network per network authorized for a
      # // Lustre instance and that network is not deleted when the user-created
      # // network (authorized_network) is deleted, so this prevents issues
      # // with tenant network quota.
      # // If this network hasn't been created and you are using this example in your
      # // config, add an additional network resource or change
      # // this from "data"to "resource"
      lustre-network:
        fn::invoke:
          function: gcp:compute:getNetwork
          arguments:
            name: my-network
    

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
    def Instance(resource_name: str,
                 args: InstanceArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Instance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 capacity_gib: Optional[str] = None,
                 filesystem: Optional[str] = None,
                 instance_id: Optional[str] = None,
                 location: Optional[str] = None,
                 network: Optional[str] = None,
                 description: Optional[str] = None,
                 gke_support_enabled: Optional[bool] = None,
                 labels: Optional[Mapping[str, str]] = None,
                 project: Optional[str] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
    public Instance(String name, InstanceArgs args, CustomResourceOptions options)
    
    type: gcp:lustre:Instance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleinstanceResourceResourceFromLustreinstance = new Gcp.Lustre.Instance("exampleinstanceResourceResourceFromLustreinstance", new()
    {
        CapacityGib = "string",
        Filesystem = "string",
        InstanceId = "string",
        Location = "string",
        Network = "string",
        Description = "string",
        GkeSupportEnabled = false,
        Labels = 
        {
            { "string", "string" },
        },
        Project = "string",
    });
    
    example, err := lustre.NewInstance(ctx, "exampleinstanceResourceResourceFromLustreinstance", &lustre.InstanceArgs{
    	CapacityGib:       pulumi.String("string"),
    	Filesystem:        pulumi.String("string"),
    	InstanceId:        pulumi.String("string"),
    	Location:          pulumi.String("string"),
    	Network:           pulumi.String("string"),
    	Description:       pulumi.String("string"),
    	GkeSupportEnabled: pulumi.Bool(false),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Project: pulumi.String("string"),
    })
    
    var exampleinstanceResourceResourceFromLustreinstance = new com.pulumi.gcp.lustre.Instance("exampleinstanceResourceResourceFromLustreinstance", com.pulumi.gcp.lustre.InstanceArgs.builder()
        .capacityGib("string")
        .filesystem("string")
        .instanceId("string")
        .location("string")
        .network("string")
        .description("string")
        .gkeSupportEnabled(false)
        .labels(Map.of("string", "string"))
        .project("string")
        .build());
    
    exampleinstance_resource_resource_from_lustreinstance = gcp.lustre.Instance("exampleinstanceResourceResourceFromLustreinstance",
        capacity_gib="string",
        filesystem="string",
        instance_id="string",
        location="string",
        network="string",
        description="string",
        gke_support_enabled=False,
        labels={
            "string": "string",
        },
        project="string")
    
    const exampleinstanceResourceResourceFromLustreinstance = new gcp.lustre.Instance("exampleinstanceResourceResourceFromLustreinstance", {
        capacityGib: "string",
        filesystem: "string",
        instanceId: "string",
        location: "string",
        network: "string",
        description: "string",
        gkeSupportEnabled: false,
        labels: {
            string: "string",
        },
        project: "string",
    });
    
    type: gcp:lustre:Instance
    properties:
        capacityGib: string
        description: string
        filesystem: string
        gkeSupportEnabled: false
        instanceId: string
        labels:
            string: string
        location: string
        network: string
        project: string
    

    Instance Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Instance resource accepts the following input properties:

    CapacityGib string
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    Filesystem string
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    InstanceId string
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Network string
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    Description string
    Optional. A user-readable description of the instance.
    GkeSupportEnabled bool
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    Labels Dictionary<string, string>
    Optional. Labels as key value pairs. 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    CapacityGib string
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    Filesystem string
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    InstanceId string
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    Network string
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    Description string
    Optional. A user-readable description of the instance.
    GkeSupportEnabled bool
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    Labels map[string]string
    Optional. Labels as key value pairs. 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    capacityGib String
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    filesystem String
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    instanceId String
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    network String
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    description String
    Optional. A user-readable description of the instance.
    gkeSupportEnabled Boolean
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    labels Map<String,String>
    Optional. Labels as key value pairs. 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    capacityGib string
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    filesystem string
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    instanceId string
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    network string
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    description string
    Optional. A user-readable description of the instance.
    gkeSupportEnabled boolean
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    labels {[key: string]: string}
    Optional. Labels as key value pairs. 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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    capacity_gib str
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    filesystem str
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    instance_id str
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    network str
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    description str
    Optional. A user-readable description of the instance.
    gke_support_enabled bool
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    labels Mapping[str, str]
    Optional. Labels as key value pairs. 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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    capacityGib String
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    filesystem String
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    instanceId String
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    network String
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    description String
    Optional. A user-readable description of the instance.
    gkeSupportEnabled Boolean
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    labels Map<String>
    Optional. Labels as key value pairs. 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

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

    CreateTime string
    Output only. Timestamp when the instance was created.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    MountPoint string
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    Name string
    Identifier. The name of the instance.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    State string
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    UpdateTime string
    Output only. Timestamp when the instance was last updated.
    CreateTime string
    Output only. Timestamp when the instance was created.
    EffectiveLabels 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    MountPoint string
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    Name string
    Identifier. The name of the instance.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    State string
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    UpdateTime string
    Output only. Timestamp when the instance was last updated.
    createTime String
    Output only. Timestamp when the instance was created.
    effectiveLabels 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.
    id String
    The provider-assigned unique ID for this managed resource.
    mountPoint String
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    name String
    Identifier. The name of the instance.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state String
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    updateTime String
    Output only. Timestamp when the instance was last updated.
    createTime string
    Output only. Timestamp when the instance was created.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    mountPoint string
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    name string
    Identifier. The name of the instance.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state string
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    updateTime string
    Output only. Timestamp when the instance was last updated.
    create_time str
    Output only. Timestamp when the instance was created.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id str
    The provider-assigned unique ID for this managed resource.
    mount_point str
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    name str
    Identifier. The name of the instance.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state str
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    update_time str
    Output only. Timestamp when the instance was last updated.
    createTime String
    Output only. Timestamp when the instance was created.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    mountPoint String
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    name String
    Identifier. The name of the instance.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state String
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    updateTime String
    Output only. Timestamp when the instance was last updated.

    Look up Existing Instance Resource

    Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            capacity_gib: Optional[str] = None,
            create_time: Optional[str] = None,
            description: Optional[str] = None,
            effective_labels: Optional[Mapping[str, str]] = None,
            filesystem: Optional[str] = None,
            gke_support_enabled: Optional[bool] = None,
            instance_id: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            location: Optional[str] = None,
            mount_point: Optional[str] = None,
            name: Optional[str] = None,
            network: Optional[str] = None,
            project: Optional[str] = None,
            pulumi_labels: Optional[Mapping[str, str]] = None,
            state: Optional[str] = None,
            update_time: Optional[str] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    resources:  _:    type: gcp:lustre:Instance    get:      id: ${id}
    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.
    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:
    CapacityGib string
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    CreateTime string
    Output only. Timestamp when the instance was created.
    Description string
    Optional. A user-readable description of the instance.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Filesystem string
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    GkeSupportEnabled bool
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    InstanceId string
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    Labels Dictionary<string, string>
    Optional. Labels as key value pairs. 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.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    MountPoint string
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    Name string
    Identifier. The name of the instance.
    Network string
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    State string
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    UpdateTime string
    Output only. Timestamp when the instance was last updated.
    CapacityGib string
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    CreateTime string
    Output only. Timestamp when the instance was created.
    Description string
    Optional. A user-readable description of the instance.
    EffectiveLabels 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.
    Filesystem string
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    GkeSupportEnabled bool
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    InstanceId string
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    Labels map[string]string
    Optional. Labels as key value pairs. 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.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    MountPoint string
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    Name string
    Identifier. The name of the instance.
    Network string
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    State string
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    UpdateTime string
    Output only. Timestamp when the instance was last updated.
    capacityGib String
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    createTime String
    Output only. Timestamp when the instance was created.
    description String
    Optional. A user-readable description of the instance.
    effectiveLabels 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.
    filesystem String
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    gkeSupportEnabled Boolean
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    instanceId String
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    labels Map<String,String>
    Optional. Labels as key value pairs. 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.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    mountPoint String
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    name String
    Identifier. The name of the instance.
    network String
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state String
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    updateTime String
    Output only. Timestamp when the instance was last updated.
    capacityGib string
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    createTime string
    Output only. Timestamp when the instance was created.
    description string
    Optional. A user-readable description of the instance.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    filesystem string
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    gkeSupportEnabled boolean
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    instanceId string
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    labels {[key: string]: string}
    Optional. Labels as key value pairs. 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.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    mountPoint string
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    name string
    Identifier. The name of the instance.
    network string
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state string
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    updateTime string
    Output only. Timestamp when the instance was last updated.
    capacity_gib str
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    create_time str
    Output only. Timestamp when the instance was created.
    description str
    Optional. A user-readable description of the instance.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    filesystem str
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    gke_support_enabled bool
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    instance_id str
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    labels Mapping[str, str]
    Optional. Labels as key value pairs. 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.
    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    mount_point str
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    name str
    Identifier. The name of the instance.
    network str
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state str
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    update_time str
    Output only. Timestamp when the instance was last updated.
    capacityGib String
    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 954000, in increments of 9000.
    createTime String
    Output only. Timestamp when the instance was created.
    description String
    Optional. A user-readable description of the instance.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    filesystem String
    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and may only contain letters and numbers.
    gkeSupportEnabled Boolean
    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
    instanceId String
    Required. The name of the Managed Lustre instance.

    • Must contain only lowercase letters, numbers, and hyphens.
    • Must start with a letter.
    • Must be between 1-63 characters.
    • Must end with a number or a letter.

    labels Map<String>
    Optional. Labels as key value pairs. 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.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    mountPoint String
    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.
    name String
    Identifier. The name of the instance.
    network String
    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{project_id}/global/networks/{network_name}.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    state String
    Output only. The state of the instance. Possible values: STATE_UNSPECIFIED ACTIVE CREATING DELETING UPGRADING REPAIRING STOPPED
    updateTime String
    Output only. Timestamp when the instance was last updated.

    Import

    Instance can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/instances/{{instance_id}}

    • {{project}}/{{location}}/{{instance_id}}

    • {{location}}/{{instance_id}}

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

    $ pulumi import gcp:lustre/instance:Instance default projects/{{project}}/locations/{{location}}/instances/{{instance_id}}
    
    $ pulumi import gcp:lustre/instance:Instance default {{project}}/{{location}}/{{instance_id}}
    
    $ pulumi import gcp:lustre/instance:Instance default {{location}}/{{instance_id}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi