From d86c753cf179b0181dfab1148ba8712e263dc60d Mon Sep 17 00:00:00 2001 From: Radek Simko Date: Wed, 16 Sep 2015 12:44:41 +0100 Subject: [PATCH] provider/aws: Add docs for EFS resources --- .../aws/r/efs_file_system.html.markdown | 35 ++++++++++++++ .../aws/r/efs_mount_target.html.markdown | 47 +++++++++++++++++++ website/source/layouts/aws.erb | 16 +++++++ 3 files changed, 98 insertions(+) create mode 100644 website/source/docs/providers/aws/r/efs_file_system.html.markdown create mode 100644 website/source/docs/providers/aws/r/efs_mount_target.html.markdown diff --git a/website/source/docs/providers/aws/r/efs_file_system.html.markdown b/website/source/docs/providers/aws/r/efs_file_system.html.markdown new file mode 100644 index 000000000..ac4cbb0b3 --- /dev/null +++ b/website/source/docs/providers/aws/r/efs_file_system.html.markdown @@ -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 diff --git a/website/source/docs/providers/aws/r/efs_mount_target.html.markdown b/website/source/docs/providers/aws/r/efs_mount_target.html.markdown new file mode 100644 index 000000000..59bd3bee2 --- /dev/null +++ b/website/source/docs/providers/aws/r/efs_mount_target.html.markdown @@ -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. diff --git a/website/source/layouts/aws.erb b/website/source/layouts/aws.erb index 1f5c7dee1..17281a9f8 100644 --- a/website/source/layouts/aws.erb +++ b/website/source/layouts/aws.erb @@ -132,6 +132,22 @@ + > + EFS Resources + + + + > ElastiCache Resources