ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/source/docs/providers/aws/r/vpn_connection.html.markdown

72 lines
2.5 KiB
Markdown
Raw Normal View History

aws: Add docs for aws_vpn_connection resources.
2015-05-01 18:23:39 +02:00
---
layout: "aws"
page_title: "AWS: aws_vpn_connection"
aws: fix VPN connection acceptance test. This corrects syntactical errors and uses distinct IP addresses for each configuration.
2015-05-04 00:40:10 +02:00
sidebar_current: "docs-aws-resource-vpn-connection"
aws: Add docs for aws_vpn_connection resources.
2015-05-01 18:23:39 +02:00
description: |-
Provides a VPN connection connected to a VPC. These objects can be connected to customer gateways, and allow you to establish tunnels between your network and the VPC.
---
# aws\_vpn\_connection
Provides a VPN connection connected to a VPC. These objects can be connected to customer gateways, and allow you to establish tunnels between your network and the VPC.
## Example Usage
```
resource "aws_vpc" "vpc" {
website/docs: Run `terraform fmt` on code examples (#12075) * docs/vsphere: Fix code block * docs: Convert `...` to `# ...` to allow `terraform fmt`ing * docs: Trim trailing whitespace * docs: First-pass run of `terraform fmt` on code examples
2017-02-18 23:48:50 +01:00
cidr_block = "10.0.0.0/16"
aws: Add docs for aws_vpn_connection resources.
2015-05-01 18:23:39 +02:00
}
resource "aws_vpn_gateway" "vpn_gateway" {
website/docs: Run `terraform fmt` on code examples (#12075) * docs/vsphere: Fix code block * docs: Convert `...` to `# ...` to allow `terraform fmt`ing * docs: Trim trailing whitespace * docs: First-pass run of `terraform fmt` on code examples
2017-02-18 23:48:50 +01:00
vpc_id = "${aws_vpc.vpc.id}"
aws: Add docs for aws_vpn_connection resources.
2015-05-01 18:23:39 +02:00
}
resource "aws_customer_gateway" "customer_gateway" {
website/docs: Run `terraform fmt` on code examples (#12075) * docs/vsphere: Fix code block * docs: Convert `...` to `# ...` to allow `terraform fmt`ing * docs: Trim trailing whitespace * docs: First-pass run of `terraform fmt` on code examples
2017-02-18 23:48:50 +01:00
bgp_asn = 65000
ip_address = "172.0.0.1"
type = "ipsec.1"
aws: Add docs for aws_vpn_connection resources.
2015-05-01 18:23:39 +02:00
}
resource "aws_vpn_connection" "main" {
website/docs: Run `terraform fmt` on code examples (#12075) * docs/vsphere: Fix code block * docs: Convert `...` to `# ...` to allow `terraform fmt`ing * docs: Trim trailing whitespace * docs: First-pass run of `terraform fmt` on code examples
2017-02-18 23:48:50 +01:00
vpn_gateway_id = "${aws_vpn_gateway.vpn_gateway.id}"
customer_gateway_id = "${aws_customer_gateway.customer_gateway.id}"
type = "ipsec.1"
static_routes_only = true
aws: Add docs for aws_vpn_connection resources.
2015-05-01 18:23:39 +02:00
}
```
## Argument Reference
The following arguments are supported:
* `customer_gateway_id` - (Required) The ID of the customer gateway.
provider/aws: Setting static_routes_only on import of vpn_connection (#9802) fixes #9110 An error was found where, static_routes_only was not set on a vpn connection import. This commit introduces setting the static_routes_only to false when no Options are found. This follows the AWS convention as follows: ``` - options (structure) Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true . Default: false ``` So we take it that `static_options_only` is false by default ``` % make testacc TEST=./builtin/providers/aws TESTARGS='-run=TestAccAWSVpnConnection_' ==> Checking that code complies with gofmt requirements... go generate $(go list ./... | grep -v /terraform/vendor/) 2016/11/02 10:38:18 Generated command/internal_plugin_list.go TF_ACC=1 go test ./builtin/providers/aws -v -run=TestAccAWSVpnConnection_ -timeout 120m === RUN TestAccAWSVpnConnection_importBasic --- PASS: TestAccAWSVpnConnection_importBasic (178.29s) === RUN TestAccAWSVpnConnection_basic --- PASS: TestAccAWSVpnConnection_basic (336.81s) === RUN TestAccAWSVpnConnection_withoutStaticRoutes --- PASS: TestAccAWSVpnConnection_withoutStaticRoutes (195.45s) PASS ok github.com/hashicorp/terraform/builtin/providers/aws 710.572s ```
2016-11-07 17:12:41 +01:00
* `static_routes_only` - (Optional, Default `false`) Whether the VPN connection uses static routes exclusively. Static routes must be used for devices that don't support BGP.
docs: fix newline
2015-05-02 02:39:42 +02:00
* `tags` - (Optional) Tags to apply to the connection.
aws: Add docs for aws_vpn_connection resources.
2015-05-01 18:23:39 +02:00
* `type` - (Required) The type of VPN connection. The only type AWS supports at this time is "ipsec.1".
* `vpn_gateway_id` - (Required) The ID of the virtual private gateway.
Correct misspellings
2015-05-29 03:00:44 +02:00
## Attribute Reference
aws: Add docs for aws_vpn_connection resources.
2015-05-01 18:23:39 +02:00
The following attributes are exported:
* `id` - The amazon-assigned ID of the VPN connection.
* `customer_gateway_configuration` - The configuration information for the VPN connection's customer gateway (in the native XML format).
* `customer_gateway_id` - The ID of the customer gateway to which the connection is attached.
* `static_routes_only` - Whether the VPN connection uses static routes exclusively.
* `tags` - Tags applied to the connection.
Add docs for new aws_vpn_connection attributes.
2016-02-06 21:49:55 +01:00
* `tunnel1_address` - The public IP address of the first VPN tunnel.
* `tunnel1_preshared_key` - The preshared key of the first VPN tunnel.
* `tunnel2_address` - The public IP address of the second VPN tunnel.
* `tunnel2_preshared_key` - The preshared key of the second VPN tunnel.
aws: Add docs for aws_vpn_connection resources.
2015-05-01 18:23:39 +02:00
* `type` - The type of VPN connection.
* `vpn_gateway_id` - The ID of the virtual private gateway to which the connection is attached.
Website: Adding an import section to the bottom of the page of importable resources (#7703) * docs/digitalocean: Adding an import section to the bottom of the DO importable resources * docs/azurerm: Adding the Import sections for the AzureRM Importable resources * docs/aws: Adding the import sections to the AWS provider pages
2016-07-19 18:22:30 +02:00
## Import
website/docs: Run `terraform fmt` on code examples (#12075) * docs/vsphere: Fix code block * docs: Convert `...` to `# ...` to allow `terraform fmt`ing * docs: Trim trailing whitespace * docs: First-pass run of `terraform fmt` on code examples
2017-02-18 23:48:50 +01:00
VPN Connections can be imported using the `vpn connection id`, e.g.
Website: Adding an import section to the bottom of the page of importable resources (#7703) * docs/digitalocean: Adding an import section to the bottom of the DO importable resources * docs/azurerm: Adding the Import sections for the AzureRM Importable resources * docs/aws: Adding the import sections to the AWS provider pages
2016-07-19 18:22:30 +02:00
```
documentation/aws: More additions of Import documention to the AWS (#7729) resources
2016-07-21 00:28:59 +02:00
$ terraform import aws_vpn_connection.testvpnconnection vpn-40f41529
Website: Adding an import section to the bottom of the page of importable resources (#7703) * docs/digitalocean: Adding an import section to the bottom of the DO importable resources * docs/azurerm: Adding the Import sections for the AzureRM Importable resources * docs/aws: Adding the import sections to the AWS provider pages
2016-07-19 18:22:30 +02:00
```