Skip to content

Commit 09e7b2f

Browse files
committed
feat(vpn-gateway): Fix docs
1 parent bc02a51 commit 09e7b2f

File tree

5 files changed

+9
-20
lines changed

5 files changed

+9
-20
lines changed

website/docs/d/is_vpn_gateway.html.markdown

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ In addition to all argument references listed, you can access the following attr
3636

3737
- `id` - The unique identifier of the is_vpn_gateway.
3838
- `access_tags` - (List) Access management tags associated for the vpn gateway.
39+
- `advertised_cidrs` - (Optional, List) The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
3940
- `connections` - (List) Connections for this VPN gateway.
4041
Nested scheme for **connections**:
4142
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
@@ -51,7 +52,7 @@ In addition to all argument references listed, you can access the following attr
5152
- `crn` - (String) The VPN gateway's CRN.
5253

5354
- `href` - (String) The VPN gateway's canonical URL.
54-
55+
- `local_asn` - (Integer) The local autonomous system number (ASN) for this VPN gateway and its connections.
5556
- `members` - (List) Collection of VPN gateway members.
5657
Nested scheme for **members**:
5758

@@ -67,9 +68,6 @@ In addition to all argument references listed, you can access the following attr
6768
- `role` - (String) The high availability role assigned to the VPN gateway member.
6869

6970
- `mode` - (String) Route mode VPN gateway.
70-
- `local_asn` - (Integer) The local autonomous system number (ASN) for this VPN gateway and its connections.
71-
- `advertised_cidrs` - (Optional, List) The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
72-
7371
- `name` - (String) The user-defined name for this VPN gateway.
7472

7573
- `resource_group` - (List) The resource group object, for this VPN gateway.

website/docs/d/is_vpn_gateway_service_connection.html.markdown

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,9 @@ data "ibm_is_vpn_gateway_service_connection" "example" {
1818
vpn_gateway_connection = ibm_is_vpn_gateway_connection.example.gateway_connection
1919
}
2020
data "ibm_is_vpn_gateway_service_connection" "example-1" {
21-
vpn_gateway = ibm_is_vpn_gateway.example.id
22-
vpn_gateway_connection_name = ibm_is_vpn_gateway_connection.example.name
23-
}
24-
data "ibm_is_vpn_gateway_service_connection" "example-2" {
2521
vpn_gateway_name = ibm_is_vpn_gateway.example.name
2622
vpn_gateway_connection = ibm_is_vpn_gateway_connection.example.gateway_connection
2723
}
28-
data "ibm_is_vpn_gateway_service_connection" "example-3" {
29-
vpn_gateway_name = ibm_is_vpn_gateway.example.name
30-
vpn_gateway_connection_name = ibm_is_vpn_gateway_connection.example.name
31-
}
3224
```
3325

3426
## Argument Reference
@@ -38,9 +30,8 @@ Review the argument reference that you can specify for your data source.
3830
- `vpn_gateway` - (Optional, String) The VPN gateway identifier.
3931
- `vpn_gateway_name` - (Optional, String) The VPN gateway name.
4032
- `vpn_gateway_connection` - (Optional, String) The VPN gateway connection identifier.
41-
- `vpn_gateway_connection_name` - (Optional, String) The VPN gateway connection name.
4233

43-
~> **Note** Provide either one of `vpn_gateway`, `vpn_gateway_name` to identifiy vpn gateway and either one of `vpn_gateway_connection`, `vpn_gateway_connection_name` to identify vpn gateway connection.
34+
~> **Note** Provide either one of `vpn_gateway`, `vpn_gateway_name` to identifiy vpn gateway.
4435

4536
## Attribute Reference
4637

website/docs/d/is_vpn_gateways.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ In addition to all argument reference list, you can access the following attribu
4545
- `crn` - (String) The VPN gateway's CRN.
4646
- `created_at`- (Timestamp) The date and time the VPN gateway was created.
4747
- `id` - (String) The ID of the VPN gateway.
48+
- `advertised_cidrs` - (Optional, List) The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
4849
- `name`- (String) The VPN gateway instance name.
4950
- `members` - (List) Collection of VPN gateway members.</n>
5051

@@ -80,6 +81,7 @@ In addition to all argument reference list, you can access the following attribu
8081
- `message` - (String) An explanation of the reason for this lifecycle reason.
8182
- `more_info` - (String) Link to documentation about the reason for this lifecycle reason.
8283
- `lifecycle_state` - (String) The lifecycle state of the VPN gateway.
84+
- `local_asn` - (Integer) The local autonomous system number (ASN) for this VPN gateway and its connections.
8385
- `subnet` - (String) The VPN gateway subnet information.
8486
- `tags`- (Optional, Array of Strings) A list of tags associated with the instance.
8587
- `vpc` - (String) The VPC this VPN server resides in.
@@ -93,6 +95,4 @@ In addition to all argument reference list, you can access the following attribu
9395
- `id` - (String) - The unique identifier for this VPC.
9496
- `name` - (String) - The unique user-defined name for this VPC.
9597
- `resource_group` - (String) The resource group ID.
96-
- `mode` - (String) The VPN gateway mode, supported values are `policy` and `route`.
97-
- `local_asn` - (Integer) The local autonomous system number (ASN) for this VPN gateway and its connections.
98-
- `advertised_cidrs` - (Optional, List) The additional CIDRs advertised through any enabled routing protocol (for example, BGP). The routing protocol will advertise routes with these CIDRs and VPC prefixes as route destinations.
98+
- `mode` - (String) The VPN gateway mode, supported values are `policy` and `route`.

website/docs/r/is_vpn_gateway.html.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ The `ibm_is_vpn_gateway` resource provides the following [Timeouts](https://www.
5656
## Argument reference
5757
Review the argument references that you can specify for your resource.
5858

59+
- `local_asn` - (Optional, Integer) The local autonomous system number (ASN) for this VPN gateway and its connections.
5960
- `mode`- (Optional, String) Mode in VPN gateway. Supported values are `route` or `policy`. The default value is `route`.
6061
- `name` - (Required, String) The name of the VPN gateway.
6162
- `resource_group` - (Optional, Forces new resource, String) The resource group (id), where the VPN gateway to be created.
6263
- `subnet` - (Required, Forces new resource, String) The unique identifier for this subnet.
6364
- `tags`- (Optional, Array of Strings) A list of tags that you want to add to your VPN gateway. Tags can help you find your VPN gateway more easily later.
64-
- `local_asn` - (Optional, Integer) The local autonomous system number (ASN) for this VPN gateway and its connections.
6565

6666

6767
## Attribute reference
@@ -101,6 +101,7 @@ In addition to all argument reference list, you can access the following attribu
101101
- `message` - (String) An explanation of the reason for this lifecycle reason.
102102
- `more_info` - (String) Link to documentation about the reason for this lifecycle reason.
103103
- `lifecycle_state` - (String) The lifecycle state of the VPN gateway.
104+
- `local_asn` - (Integer) The local autonomous system number (ASN) for this VPN gateway and its connections.
104105
- `vpc` - (String) The VPC this VPN server resides in.
105106
Nested scheme for `vpc`:
106107
- `crn` - (String) The CRN for this VPC.
@@ -111,7 +112,6 @@ In addition to all argument reference list, you can access the following attribu
111112
- `id` - (String) - The unique identifier for this VPC.
112113
- `name` - (String) - The unique user-defined name for this VPC.
113114
- `resource_type` - (String) - The resource type.
114-
-`local_asn` - (Integer) The local autonomous system number (ASN) for this VPN gateway and its connections.
115115

116116

117117

website/docs/r/is_vpn_gateway_advertised_cidr.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ The `ibm_is_vpn_gateway_advertised_cidr` resource provides the following [Timeou
6666
## Argument reference
6767
Review the argument references that you can specify for your resource.
6868

69-
- `vpn_gateway` - (Required, Force new resource, String) The unique identifier of the VPN gateway.
7069
- `cidr` - (Required, Force new resource, String) The IP address range in CIDR block notation.
70+
- `vpn_gateway` - (Required, Force new resource, String) The unique identifier of the VPN gateway.
7171

7272
## Import
7373
The `ibm_is_vpn_gateway_advertised_cidr` resource can be imported by using the VPN gateway ID and the Advertised Cidr.

0 commit comments

Comments
 (0)