Instance

A Google Cloud Filestore instance.

To get more information about Instance, see:

API documentation
How-to Guides

Create a Instance Resource

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

def Instance(resource_name, opts=None, description=None, file_shares=None, labels=None, name=None, networks=None, project=None, tier=None, zone=None, __props__=None);

func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Instance Resource Properties

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

Inputs

The Instance resource accepts the following input properties:

FileShares InstanceFileSharesArgs: File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
Networks List<InstanceNetworkArgs>: VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
Tier string: The service tier of the instance.
Zone string: The name of the Filestore zone of the instance.
Description string: A description of the instance.
Labels Dictionary<string, string>: Resource labels to represent user-provided metadata.
Name string: The name of the fileshare (16 characters or less)
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

FileShares InstanceFileShares: File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
Networks []InstanceNetwork: VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
Tier string: The service tier of the instance.
Zone string: The name of the Filestore zone of the instance.
Description string: A description of the instance.
Labels map[string]string: Resource labels to represent user-provided metadata.
Name string: The name of the fileshare (16 characters or less)
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

fileShares InstanceFileShares: File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
networks InstanceNetwork[]: VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
tier string: The service tier of the instance.
zone string: The name of the Filestore zone of the instance.
description string: A description of the instance.
labels {[key: string]: string}: Resource labels to represent user-provided metadata.
name string: The name of the fileshare (16 characters or less)
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

file_shares Dict[InstanceFileShares]: File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
networks List[InstanceNetwork]: VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
tier str: The service tier of the instance.
zone str: The name of the Filestore zone of the instance.
description str: A description of the instance.
labels Dict[str, str]: Resource labels to represent user-provided metadata.
name str: The name of the fileshare (16 characters or less)
project str: 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: Creation timestamp in RFC3339 text format.
Etag string: Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
Id string: The provider-assigned unique ID for this managed resource.

CreateTime string: Creation timestamp in RFC3339 text format.
Etag string: Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
Id string: The provider-assigned unique ID for this managed resource.

createTime string: Creation timestamp in RFC3339 text format.
etag string: Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
id string: The provider-assigned unique ID for this managed resource.

create_time str: Creation timestamp in RFC3339 text format.
etag str: Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, create_time=None, description=None, etag=None, file_shares=None, labels=None, name=None, networks=None, project=None, tier=None, zone=None, __props__=None);

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)

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.

The following state arguments are supported:

CreateTime string: Creation timestamp in RFC3339 text format.
Description string: A description of the instance.
Etag string: Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
FileShares InstanceFileSharesArgs: File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
Labels Dictionary<string, string>: Resource labels to represent user-provided metadata.
Name string: The name of the fileshare (16 characters or less)
Networks List<InstanceNetworkArgs>: VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Tier string: The service tier of the instance.
Zone string: The name of the Filestore zone of the instance.

CreateTime string: Creation timestamp in RFC3339 text format.
Description string: A description of the instance.
Etag string: Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
FileShares InstanceFileShares: File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
Labels map[string]string: Resource labels to represent user-provided metadata.
Name string: The name of the fileshare (16 characters or less)
Networks []InstanceNetwork: VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Tier string: The service tier of the instance.
Zone string: The name of the Filestore zone of the instance.

createTime string: Creation timestamp in RFC3339 text format.
description string: A description of the instance.
etag string: Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
fileShares InstanceFileShares: File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
labels {[key: string]: string}: Resource labels to represent user-provided metadata.
name string: The name of the fileshare (16 characters or less)
networks InstanceNetwork[]: VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tier string: The service tier of the instance.
zone string: The name of the Filestore zone of the instance.

create_time str: Creation timestamp in RFC3339 text format.
description str: A description of the instance.
etag str: Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
file_shares Dict[InstanceFileShares]: File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
labels Dict[str, str]: Resource labels to represent user-provided metadata.
name str: The name of the fileshare (16 characters or less)
networks List[InstanceNetwork]: VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tier str: The service tier of the instance.
zone str: The name of the Filestore zone of the instance.

Supporting Types

InstanceFileShares

See the input and output API doc for this type.

CapacityGb int: File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
Name string: The name of the fileshare (16 characters or less)

CapacityGb int: File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
Name string: The name of the fileshare (16 characters or less)

capacityGb number: File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
name string: The name of the fileshare (16 characters or less)

capacityGb float: File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
name str: The name of the fileshare (16 characters or less)

InstanceNetwork

See the input and output API doc for this type.

Modes List<string>: IP versions for which the instance has IP addresses assigned.
Network string: The name of the GCE VPC network to which the instance is connected.
IpAddresses List<string>: - A list of IPv4 or IPv6 addresses.
ReservedIpRange string: A /29 CIDR block that identifies the range of IP addresses reserved for this instance.

Modes []string: IP versions for which the instance has IP addresses assigned.
Network string: The name of the GCE VPC network to which the instance is connected.
IpAddresses []string: - A list of IPv4 or IPv6 addresses.
ReservedIpRange string: A /29 CIDR block that identifies the range of IP addresses reserved for this instance.

modes string[]: IP versions for which the instance has IP addresses assigned.
network string: The name of the GCE VPC network to which the instance is connected.
ipAddresses string[]: - A list of IPv4 or IPv6 addresses.
reservedIpRange string: A /29 CIDR block that identifies the range of IP addresses reserved for this instance.

modes List[str]: IP versions for which the instance has IP addresses assigned.
network str: The name of the GCE VPC network to which the instance is connected.
ip_addresses List[str]: - A list of IPv4 or IPv6 addresses.
reserved_ip_range str: A /29 CIDR block that identifies the range of IP addresses reserved for this instance.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud