Skip to content

Commit

Permalink
provider/aws: Add docs for EFS resources
Browse files Browse the repository at this point in the history
  • Loading branch information
Radek Simko committed Oct 3, 2015
1 parent 2f72eb4 commit f1189ad
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 0 deletions.
35 changes: 35 additions & 0 deletions website/source/docs/providers/aws/r/efs_file_system.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
layout: "aws"
page_title: "AWS: aws_efs_file_system"
sidebar_current: "docs-aws-resource-efs-file-system"
description: |-
Provides an EFS file system.
---

# aws\_efs\_file\_system

Provides an EFS file system.

## Example Usage

```
resource "aws_efs_file_system" "foo" {
reference_name = "my-product"
tags {
Name = "MyProduct"
}
}
```

## Argument Reference

The following arguments are supported:

* `reference_name` - (Optional) A reference name used in Creation Token
* `tags` - (Optional) A mapping of tags to assign to the file system

## Attributes Reference

The following attributes are exported:

* `id` - The ID that identifies the file system
47 changes: 47 additions & 0 deletions website/source/docs/providers/aws/r/efs_mount_target.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: "aws"
page_title: "AWS: aws_efs_mount_target"
sidebar_current: "docs-aws-resource-efs-mount-target"
description: |-
Provides an EFS mount target.
---

# aws\_efs\_file\_system

Provides an EFS file system. Per [documentation](http://docs.aws.amazon.com/efs/latest/ug/limits.html)
the limit is 1 mount target per AZ.

## Example Usage

```
resource "aws_efs_mount_target" "alpha" {
file_system_id = "${aws_efs_file_system.foo.id}"
subnet_id = "${aws_subnet.alpha.id}"
}
resource "aws_vpc" "foo" {
cidr_block = "10.0.0.0/16"
}
resource "aws_subnet" "alpha" {
vpc_id = "${aws_vpc.foo.id}"
availability_zone = "us-west-2a"
cidr_block = "10.0.1.0/24"
}
```

## Argument Reference

The following arguments are supported:

* `file_system_id` - (Required) The ID of the file system for which the mount target is intended.
* `subnet_id` - (Required) The ID of the subnet that the mount target is in.
* `ip_address` - (Optional) The address at which the file system may be mounted via the mount target.
* `security_groups` - (Optional) A list of up to 5 VPC security group IDs in effect for the mount target.

## Attributes Reference

The following attributes are exported:

* `id` - The ID of the mount target
* `network_interface_id` - The ID of the network interface that Amazon EFS created when it created the mount target.
16 changes: 16 additions & 0 deletions website/source/layouts/aws.erb
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,22 @@
</li>


<li<%= sidebar_current(/^docs-aws-resource-efs/) %>>
<a href="#">EFS Resources</a>
<ul class="nav nav-visible">

<li<%= sidebar_current("docs-aws-resource-efs-file-system") %>>
<a href="/docs/providers/aws/r/efs_file_system.html">aws_efs_file_system</a>
</li>

<li<%= sidebar_current("docs-aws-resource-efs-mount-target") %>>
<a href="/docs/providers/aws/r/efs_mount_target.html">aws_efs_mount_target</a>
</li>

</ul>
</li>


<li<%= sidebar_current(/^docs-aws-resource-elasticache/) %>>
<a href="#">ElastiCache Resources</a>
<ul class="nav nav-visible">
Expand Down

0 comments on commit f1189ad

Please sign in to comment.