github.com/danp/terraform@v0.9.5-0.20170426144147-39d740081351/website/source/docs/providers/aws/d/vpn_gateway.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_vpn_gateway"
     4  sidebar_current: "docs-aws-datasource-vpn-gateway"
     5  description: |-
     6      Provides details about a specific VPN gateway.
     7  ---
     8  
     9  # aws\_vpn\_gateway
    10  
    11  The VPN Gateway data source provides details about
    12  a specific VPN gateway.
    13  
    14  ## Example Usage
    15  
    16  ```hcl
    17  data "aws_vpn_gateway" "selected" {
    18    filter {
    19      name = "tag:Name"
    20      values = ["vpn-gw"]
    21    }
    22  }
    23  
    24  output "vpn_gateway_id" {
    25    value = "${data.aws_vpn_gateway.selected.id}"
    26  }
    27  ```
    28  
    29  ## Argument Reference
    30  
    31  The arguments of this data source act as filters for querying the available VPN gateways.
    32  The given filters must match exactly one VPN gateway whose data will be exported as attributes.
    33  
    34  * `id` - (Optional) The ID of the specific VPN Gateway to retrieve.
    35  
    36  * `state` - (Optional) The state of the specific VPN Gateway to retrieve.
    37  
    38  * `availability_zone` - (Optional) The Availability Zone of the specific VPN Gateway to retrieve.
    39  
    40  * `attached_vpc_id` - (Optional) The ID of a VPC attached to the specific VPN Gateway to retrieve.
    41  
    42  * `filter` - (Optional) Custom filter block as described below.
    43  
    44  * `tags` - (Optional) A mapping of tags, each pair of which must exactly match
    45    a pair on the desired VPN Gateway.
    46  
    47  More complex filters can be expressed using one or more `filter` sub-blocks,
    48  which take the following arguments:
    49  
    50  * `name` - (Required) The name of the field to filter by, as defined by
    51    [the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnGateways.html).
    52  
    53  * `values` - (Required) Set of values that are accepted for the given field.
    54    A VPN Gateway will be selected if any one of the given values matches.
    55  
    56  ## Attributes Reference
    57  
    58  All of the argument attributes are also exported as result attributes.