terraform-provider-google/website/docs/r/filestore_instance.html.markdown
The Magician 63216b0c90 Mark Filestore as GA (#3522)
Signed-off-by: Modular Magician <magic-modules@google.com>
2019-05-02 10:29:08 -07:00

167 lines
4.6 KiB
Markdown

---
# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file in
# .github/CONTRIBUTING.md.
#
# ----------------------------------------------------------------------------
layout: "google"
page_title: "Google: google_filestore_instance"
sidebar_current: "docs-google-filestore-instance"
description: |-
A Google Cloud Filestore instance.
---
# google\_filestore\_instance
A Google Cloud Filestore instance.
To get more information about Instance, see:
* [API documentation](https://cloud.google.com/filestore/docs/reference/rest/v1beta1/projects.locations.instances/create)
* How-to Guides
* [Official Documentation](https://cloud.google.com/filestore/docs/creating-instances)
* [Use with Kubernetes](https://cloud.google.com/filestore/docs/accessing-fileshares)
* [Copying Data In/Out](https://cloud.google.com/filestore/docs/copying-data)
<div class = "oics-button" style="float: right; margin: 0 0 -15px">
<a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=filestore_instance_basic&cloudshell_image=gcr.io%2Fgraphite-cloud-shell-images%2Fterraform%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank">
<img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
</a>
</div>
## Example Usage - Filestore Instance Basic
```hcl
resource "google_filestore_instance" "instance" {
name = "test-instance"
zone = "us-central1-b"
tier = "PREMIUM"
file_shares {
capacity_gb = 2660
name = "share1"
}
networks {
network = "default"
modes = ["MODE_IPV4"]
}
}
```
## Argument Reference
The following arguments are supported:
* `name` -
(Required)
The resource name of the instance.
* `tier` -
(Required)
The service tier of the instance.
* `file_shares` -
(Required)
File system shares on the instance. For this version, only a
single file share is supported. Structure is documented below.
* `networks` -
(Required)
VPC networks to which the instance is connected. For this version,
only a single network is supported. Structure is documented below.
* `zone` -
(Required)
The name of the Filestore zone of the instance.
The `file_shares` block supports:
* `name` -
(Required)
The name of the fileshare (16 characters or less)
* `capacity_gb` -
(Required)
File share capacity in GB.
The `networks` block supports:
* `network` -
(Required)
The name of the GCE VPC network to which the
instance is connected.
* `modes` -
(Required)
IP versions for which the instance has
IP addresses assigned.
* `reserved_ip_range` -
(Optional)
A /29 CIDR block that identifies the range of IP
addresses reserved for this instance.
* `ip_addresses` -
A list of IPv4 or IPv6 addresses.
- - -
* `description` -
(Optional)
A description of the instance.
* `labels` -
(Optional)
Resource labels to represent user-provided metadata.
* `project` - (Optional) The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
## Attributes Reference
In addition to the arguments listed above, the following computed attributes are exported:
* `create_time` -
Creation timestamp in RFC3339 text format.
* `etag` -
Server-specified ETag for the instance resource to prevent
simultaneous updates from overwriting each other.
## Timeouts
This resource provides the following
[Timeouts](/docs/configuration/resources.html#timeouts) configuration options:
- `create` - Default is 6 minutes.
- `update` - Default is 6 minutes.
- `delete` - Default is 6 minutes.
## Import
Instance can be imported using any of these accepted formats:
```
$ terraform import google_filestore_instance.default projects/{{project}}/locations/{{zone}}/instances/{{name}}
$ terraform import google_filestore_instance.default {{project}}/{{zone}}/{{name}}
$ terraform import google_filestore_instance.default {{name}}
```
-> If you're importing a resource with beta features, make sure to include `-provider=google-beta`
as an argument so that Terraform uses the correct provider to import your resource.