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.
filestore¶
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.
- class
pulumi_gcp.filestore.Instance(resource_name, opts=None, description=None, file_shares=None, labels=None, name=None, networks=None, project=None, tier=None, zone=None, __props__=None, __name__=None, __opts__=None)¶ A Google Cloud Filestore instance.
To get more information about Instance, see:
import pulumi import pulumi_gcp as gcp instance = gcp.filestore.Instance("instance", file_shares={ "capacityGb": 2660, "name": "share1", }, networks=[{ "modes": ["MODE_IPV4"], "network": "default", }], tier="PREMIUM", zone="us-central1-b")
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description of the instance.
file_shares (pulumi.Input[dict]) – File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
labels (pulumi.Input[dict]) – Resource labels to represent user-provided metadata.
name (pulumi.Input[str]) – The name of the fileshare (16 characters or less)
networks (pulumi.Input[list]) – VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tier (pulumi.Input[str]) – The service tier of the instance.
zone (pulumi.Input[str]) – The name of the Filestore zone of the instance.
The file_shares object supports the following:
capacityGb(pulumi.Input[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(pulumi.Input[str]) - The name of the fileshare (16 characters or less)
The networks object supports the following:
ip_addresses(pulumi.Input[list]) - - A list of IPv4 or IPv6 addresses.modes(pulumi.Input[list]) - IP versions for which the instance has IP addresses assigned.network(pulumi.Input[str]) - The name of the GCE VPC network to which the instance is connected.reserved_ip_range(pulumi.Input[str]) - A /29 CIDR block that identifies the range of IP addresses reserved for this instance.
create_time: pulumi.Output[str] = None¶Creation timestamp in RFC3339 text format.
description: pulumi.Output[str] = None¶A description of the instance.
etag: pulumi.Output[str] = None¶Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
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)
labels: pulumi.Output[dict] = None¶Resource labels to represent user-provided metadata.
name: pulumi.Output[str] = None¶The name of the fileshare (16 characters or less)
networks: pulumi.Output[list] = None¶VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
ip_addresses(list) - - A list of IPv4 or IPv6 addresses.modes(list) - 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.reserved_ip_range(str) - A /29 CIDR block that identifies the range of IP addresses reserved for this instance.
project: pulumi.Output[str] = None¶The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tier: pulumi.Output[str] = None¶The service tier of the instance.
zone: pulumi.Output[str] = None¶The name of the Filestore zone of the 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)¶ Get an existing Instance resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
create_time (pulumi.Input[str]) – Creation timestamp in RFC3339 text format.
description (pulumi.Input[str]) – A description of the instance.
etag (pulumi.Input[str]) – Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
file_shares (pulumi.Input[dict]) – File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
labels (pulumi.Input[dict]) – Resource labels to represent user-provided metadata.
name (pulumi.Input[str]) – The name of the fileshare (16 characters or less)
networks (pulumi.Input[list]) – VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
tier (pulumi.Input[str]) – The service tier of the instance.
zone (pulumi.Input[str]) – The name of the Filestore zone of the instance.
The file_shares object supports the following:
capacityGb(pulumi.Input[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(pulumi.Input[str]) - The name of the fileshare (16 characters or less)
The networks object supports the following:
ip_addresses(pulumi.Input[list]) - - A list of IPv4 or IPv6 addresses.modes(pulumi.Input[list]) - IP versions for which the instance has IP addresses assigned.network(pulumi.Input[str]) - The name of the GCE VPC network to which the instance is connected.reserved_ip_range(pulumi.Input[str]) - A /29 CIDR block that identifies the range of IP addresses reserved for this instance.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str