1. Docs
  2. Reference
  3. API
  4. @pulumi/gcp
  5. filestore

Module filestore

This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Others

Resources

Resource Instance

class Instance extends CustomResource

A Google Cloud Filestore instance.

To get more information about Instance, see:

Example Usage - Filestore Instance Basic

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

const instance = new gcp.filestore.Instance("instance", {
    fileShares: {
        capacityGb: 2660,
        name: "share1",
    },
    networks: [{
        modes: ["MODE_IPV4"],
        network: "default",
    }],
    tier: "PREMIUM",
    zone: "us-central1-b",
});

constructor

new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property createTime

public createTime: pulumi.Output<string>;

Creation timestamp in RFC3339 text format.

property description

public description: pulumi.Output<string | undefined>;

A description of the instance.

property etag

public etag: pulumi.Output<string>;

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

property fileShares

public fileShares: pulumi.Output<InstanceFileShares>;

File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: string} | undefined>;

Resource labels to represent user-provided metadata.

property name

public name: pulumi.Output<string>;

The name of the fileshare (16 characters or less)

property networks

public networks: pulumi.Output<InstanceNetwork[]>;

VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.

property project

public project: pulumi.Output<string>;

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

property tier

public tier: pulumi.Output<string>;

The service tier of the instance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property zone

public zone: pulumi.Output<string>;

The name of the Filestore zone of the instance.

Others

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property description

description?: pulumi.Input<string>;

A description of the instance.

property fileShares

fileShares: pulumi.Input<InstanceFileShares>;

File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.

property labels

labels?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Resource labels to represent user-provided metadata.

property name

name?: pulumi.Input<string>;

The name of the fileshare (16 characters or less)

property networks

networks: pulumi.Input<pulumi.Input<InstanceNetwork>[]>;

VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.

property project

project?: pulumi.Input<string>;

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

property tier

tier: pulumi.Input<string>;

The service tier of the instance.

property zone

zone: pulumi.Input<string>;

The name of the Filestore zone of the instance.

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property createTime

createTime?: pulumi.Input<string>;

Creation timestamp in RFC3339 text format.

property description

description?: pulumi.Input<string>;

A description of the instance.

property etag

etag?: pulumi.Input<string>;

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

property fileShares

fileShares?: pulumi.Input<InstanceFileShares>;

File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.

property labels

labels?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Resource labels to represent user-provided metadata.

property name

name?: pulumi.Input<string>;

The name of the fileshare (16 characters or less)

property networks

networks?: pulumi.Input<pulumi.Input<InstanceNetwork>[]>;

VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.

property project

project?: pulumi.Input<string>;

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

property tier

tier?: pulumi.Input<string>;

The service tier of the instance.

property zone

zone?: pulumi.Input<string>;

The name of the Filestore zone of the instance.