From c3d43d1ea45c9968e162f8925976a2675479228d Mon Sep 17 00:00:00 2001 From: Bhavesh Shrivastav <91112322+BShrivastav@users.noreply.github.com> Date: Fri, 16 Sep 2022 11:10:26 +0530 Subject: [PATCH] Doc corrections for resource group to intimate id and subnet floating ip changes (#4025) * resource group and floating ip changes * upd * upd * consistency update --- .../docs/d/is_backup_policies.html.markdown | 2 +- website/docs/d/is_backup_policy.html.markdown | 2 +- website/docs/d/is_floating_ips.html.markdown | 2 +- website/docs/d/is_flow_log.html.markdown | 2 +- website/docs/d/is_flow_logs.html.markdown | 2 +- website/docs/d/is_ike_policies.html.markdown | 2 +- website/docs/d/is_ike_policy.html.markdown | 2 +- website/docs/d/is_instance.html.markdown | 2 +- .../docs/d/is_ipsec_policies.html.markdown | 46 +++++++++---------- website/docs/d/is_ipsec_policy.html.markdown | 2 +- website/docs/d/is_lb.html.markdown | 2 +- website/docs/d/is_lbs.html.markdown | 2 +- website/docs/d/is_network_acl.html.markdown | 2 +- website/docs/d/is_network_acls.html.markdown | 2 +- .../docs/d/is_security_groups.html.markdown | 8 ++-- website/docs/d/is_ssh_keys.html.markdown | 6 +-- .../d/is_subnet_reserved_ip.html.markdown | 2 +- .../d/is_subnet_reserved_ips.html.markdown | 5 +- website/docs/d/is_subnets.html.markdown | 2 +- website/docs/d/is_volumes.html.markdown | 4 +- website/docs/d/is_vpn_gateway.html.markdown | 2 +- website/docs/d/is_vpn_server.html.markdown | 4 +- .../docs/d/is_vpn_server_route.html.markdown | 2 +- .../docs/d/is_vpn_server_routes.html.markdown | 2 +- website/docs/d/is_vpn_servers.html.markdown | 2 +- website/docs/r/is_backup_policy.html.markdown | 2 +- ...ubnet_network_acl_attachment.html.markdown | 2 +- .../r/is_subnet_reserved_ip.html.markdown | 10 ++-- website/docs/r/is_vpn_gateway.html.markdown | 2 +- website/docs/r/is_vpn_server.html.markdown | 4 +- 30 files changed, 65 insertions(+), 66 deletions(-) diff --git a/website/docs/d/is_backup_policies.html.markdown b/website/docs/d/is_backup_policies.html.markdown index 4e83be9abb..3b21acabf4 100644 --- a/website/docs/d/is_backup_policies.html.markdown +++ b/website/docs/d/is_backup_policies.html.markdown @@ -63,7 +63,7 @@ In addition to all argument reference list, you can access the following attribu - `id` - (String) The unique identifier for this backup policy plan. - `name` - (String) The unique user-defined name for this backup policy plan. - `resource_type` - (String) The type of resource referenced. - - `resource_group` - (List) The resource group for this backup policy. + - `resource_group` - (List) The resource group object, for this backup policy. Nested `resource_group` blocks have the following structure: - `href` - (String) The URL for this resource group. diff --git a/website/docs/d/is_backup_policy.html.markdown b/website/docs/d/is_backup_policy.html.markdown index d4c01c6f95..c6e2a1119b 100644 --- a/website/docs/d/is_backup_policy.html.markdown +++ b/website/docs/d/is_backup_policy.html.markdown @@ -59,7 +59,7 @@ In addition to all argument reference list, you can access the following attribu - `id` - (String) The unique identifier for this backup policy plan. - `name` - (String) The unique user-defined name for this backup policy plan. - `resource_type` - (String) The type of resource referenced. -- `resource_group` - (List) The resource group for this backup policy. +- `resource_group` - (List) The resource group object, for this backup policy. Nested `resource_group` blocks have the following structure: - `href` - (String) The URL for this resource group. diff --git a/website/docs/d/is_floating_ips.html.markdown b/website/docs/d/is_floating_ips.html.markdown index 44fa1a8a9e..615712698e 100644 --- a/website/docs/d/is_floating_ips.html.markdown +++ b/website/docs/d/is_floating_ips.html.markdown @@ -49,7 +49,7 @@ In addition to all argument references listed, you can access the following attr - `href` - (String) The URL for this floating IP. - `id` - (String) The unique identifier for this floating IP. - `name` - (String) The unique user-defined name for this floating IP. - - `resource_group` - (List) The resource group for this floating IP. + - `resource_group` - (List) The resource group object, for this floating IP. Nested scheme for **resource_group**: - `href` - (String) The URL for this resource group. diff --git a/website/docs/d/is_flow_log.html.markdown b/website/docs/d/is_flow_log.html.markdown index bd3a40cc63..823c30541b 100644 --- a/website/docs/d/is_flow_log.html.markdown +++ b/website/docs/d/is_flow_log.html.markdown @@ -50,7 +50,7 @@ In addition to all argument references listed, you can access the following attr - `href` - (String) The URL for this flow log collector. - `lifecycle_state` - (String) The lifecycle state of the flow log collector. - `name` - (String) The unique user-defined name for this flow log collector. -- `resource_group` - (List) The resource group for this flow log collector. +- `resource_group` - (List) The resource group object, for this flow log collector. Nested scheme for `resource_group`: - `href` - (Required, String) The URL for this resource group. diff --git a/website/docs/d/is_flow_logs.html.markdown b/website/docs/d/is_flow_logs.html.markdown index a27f39ef50..cb2a3b87af 100644 --- a/website/docs/d/is_flow_logs.html.markdown +++ b/website/docs/d/is_flow_logs.html.markdown @@ -43,7 +43,7 @@ Review the attribute references that you can access after you retrieve your data - `id` - (String) The unique identifier of the flow log collector. - `lifecycle_state` - (String) The lifecycle state of the flow log collector. - `name` - (String) The flow log collector name. - - `resource_group` - (String) The resource group of the flow log. + - `resource_group` - (String) The resource group Id of the flow log. - `storage_bucket` - (String) The IBM Cloud Object Storage bucket name where the flow logs are logged. - `target` - (String) The target ID that the flow log collector collects the flow logs. - `vpc` - (String) The VPC of the flow log collector that are associated. diff --git a/website/docs/d/is_ike_policies.html.markdown b/website/docs/d/is_ike_policies.html.markdown index edf343d4a2..28b052f90d 100644 --- a/website/docs/d/is_ike_policies.html.markdown +++ b/website/docs/d/is_ike_policies.html.markdown @@ -43,7 +43,7 @@ In addition to all argument references listed, you can access the following attr - `key_lifetime` - (Integer) The key lifetime in seconds. - `name` - (String) The user-defined name for this IKE policy. - `negotiation_mode` - (String) The IKE negotiation mode. Only `main` is supported. - - `resource_group` - (List) The resource group for this IKE policy. + - `resource_group` - (List) The resource group object, for this IKE policy. Nested scheme for **resource_group**: - `href` - (String) The URL for this resource group. - `id` - (String) The unique identifier for this resource group. diff --git a/website/docs/d/is_ike_policy.html.markdown b/website/docs/d/is_ike_policy.html.markdown index e88304f9b3..dbfae7362a 100644 --- a/website/docs/d/is_ike_policy.html.markdown +++ b/website/docs/d/is_ike_policy.html.markdown @@ -72,7 +72,7 @@ In addition to all argument references listed, you can access the following attr - `key_lifetime` - (Integer) The key lifetime in seconds. - `name` - (String) The user-defined name for this IKE policy. - `negotiation_mode` - (String) The IKE negotiation mode. Only `main` is supported. -- `resource_group` - (List) The resource group for this IKE policy. +- `resource_group` - (List) The resource group object, for this IKE policy. Nested scheme for **resource_group**: - `href` - (String) The URL for this resource group. - `id` - (String) The unique identifier for this resource group. diff --git a/website/docs/d/is_instance.html.markdown b/website/docs/d/is_instance.html.markdown index d774c9cdeb..1335cbd147 100644 --- a/website/docs/d/is_instance.html.markdown +++ b/website/docs/d/is_instance.html.markdown @@ -172,7 +172,7 @@ In addition to all argument reference list, you can access the following attribu - `subnet` - (String) The ID of the subnet that is used in the primary network interface. - `security_groups` (List)A list of security groups that were created for the interface. - `resource_controller_url` - (String) The URL of the IBM Cloud dashboard that you can use to see details for your instance. -- `resource_group` - (String) The name of the resource group where the instance was created. +- `resource_group` - (String) The resource group id, where the instance was created. - `status` - (String) The status of the instance. - `status_reasons` - (List) Array of reasons for the current status. diff --git a/website/docs/d/is_ipsec_policies.html.markdown b/website/docs/d/is_ipsec_policies.html.markdown index 42c1b12de2..e29ac7c795 100644 --- a/website/docs/d/is_ipsec_policies.html.markdown +++ b/website/docs/d/is_ipsec_policies.html.markdown @@ -22,30 +22,30 @@ data "ibm_is_ipsec_policies" "example" { In addition to all argument references listed, you can access the following attribute references after your data source is created. -- `ipsec_policies` - (Required, List) Collection of IPsec policies. +- `ipsec_policies` - (List) Collection of IPsec policies. Nested scheme for **ipsec_policies**: - - `authentication_algorithm` - (Required, String) The authentication algorithm. - - `connections` - (Required, List) The VPN gateway connections that use this IPsec policy. + - `authentication_algorithm` - (String) The authentication algorithm. + - `connections` - (List) The VPN gateway connections that use this IPsec policy. Nested scheme for **connections**: - - `deleted` - (Optional, List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. + - `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information. Nested scheme for **deleted**: - - `more_info` - (Required, String) Link to documentation about deleted resources. - - `href` - (Required, String) The VPN connection's canonical URL. - - `id` - (Required, String) The unique identifier for this VPN gateway connection. - - `name` - (Required, String) The user-defined name for this VPN connection. - - `resource_type` - (Required, String) The resource type. - - `created_at` - (Required, String) The date and time that this IPsec policy was created. - - `encapsulation_mode` - (Required, String) The encapsulation mode used. Only `tunnel` is supported. - - `encryption_algorithm` - (Required, String) The encryption algorithm. - - `href` - (Required, String) The IPsec policy's canonical URL. - - `id` - (Required, String) The unique identifier for this IPsec policy. - - `key_lifetime` - (Required, Integer) The key lifetime in seconds. - - `name` - (Required, String) The user-defined name for this IPsec policy. - - `pfs` - (Required, String) Perfect Forward Secrecy. - - `resource_group` - (Required, List) The resource group for this IPsec policy. + - `more_info` - (String) Link to documentation about deleted resources. + - `href` - (String) The VPN connection's canonical URL. + - `id` - (String) The unique identifier for this VPN gateway connection. + - `name` - (String) The user-defined name for this VPN connection. + - `resource_type` - (String) The resource type. + - `created_at` - (String) The date and time that this IPsec policy was created. + - `encapsulation_mode` - (String) The encapsulation mode used. Only `tunnel` is supported. + - `encryption_algorithm` - (String) The encryption algorithm. + - `href` - (String) The IPsec policy's canonical URL. + - `id` - (String) The unique identifier for this IPsec policy. + - `key_lifetime` - (Integer) The key lifetime in seconds. + - `name` - (String) The user-defined name for this IPsec policy. + - `pfs` - (String) Perfect Forward Secrecy. + - `resource_group` - (List) The resource group object, for this IPsec policy. Nested scheme for **resource_group**: - - `href` - (Required, String) The URL for this resource group. - - `id` - (Required, String) The unique identifier for this resource group. - - `name` - (Required, String) The user-defined name for this resource group. - - `resource_type` - (Required, String) The resource type. - - `transform_protocol` - (Required, String) The transform protocol used. Only `esp` is supported. + - `href` - (String) The URL for this resource group. + - `id` - (String) The unique identifier for this resource group. + - `name` - (String) The user-defined name for this resource group. + - `resource_type` - (String) The resource type. + - `transform_protocol` - (String) The transform protocol used. Only `esp` is supported. diff --git a/website/docs/d/is_ipsec_policy.html.markdown b/website/docs/d/is_ipsec_policy.html.markdown index bd53bb2830..fe95715bce 100644 --- a/website/docs/d/is_ipsec_policy.html.markdown +++ b/website/docs/d/is_ipsec_policy.html.markdown @@ -68,7 +68,7 @@ In addition to all argument references listed, you can access the following attr - `key_lifetime` - (Integer) The key lifetime in seconds. - `name` - (String) The user-defined name for this IPsec policy. - `pfs` - (String) Perfect Forward Secrecy. -- `resource_group` - (List) The resource group for this IPsec policy. +- `resource_group` - (List) The resource group object, for this IPsec policy. Nested scheme for **resource_group**: - `href` - (String) The URL for this resource group. - `id` - (String) The unique identifier for this resource group. diff --git a/website/docs/d/is_lb.html.markdown b/website/docs/d/is_lb.html.markdown index c01ce76f92..a52f38405d 100644 --- a/website/docs/d/is_lb.html.markdown +++ b/website/docs/d/is_lb.html.markdown @@ -102,7 +102,7 @@ In addition to all argument reference list, you can access the following attribu - `reserved_ip`- (String) The unique identifier for this reserved IP - `resource_type`- (String) The resource type. - `private_ips` - (List) The private IP addresses assigned to this load balancer. Same as `private_ip.[].address` -- `resource_group` - (String) The resource group where the load balancer is created. +- `resource_group` - (String) The resource group id, where the load balancer is created. - `route_mode` - (Bool) Indicates whether route mode is enabled for this load balancer. - `security_groups`- (String) A list of security groups that are used with this load balancer. This option is supported only for application load balancers. - `security_groups_supported`- (Bool) Indicates if this load balancer supports security groups. diff --git a/website/docs/d/is_lbs.html.markdown b/website/docs/d/is_lbs.html.markdown index 75681b9e05..1d8fdd70a5 100644 --- a/website/docs/d/is_lbs.html.markdown +++ b/website/docs/d/is_lbs.html.markdown @@ -75,7 +75,7 @@ Review the attribute references that you can access after you retrieve your data - `private_ips` - (String) The private IP addresses assigned to this load balancer. Same as `private_ip.[].address` - `provisioning_status` - (String) The provisioning status of this load balancer. Possible values are: **active**, **create_pending**, **delete_pending**, **failed**, **maintenance_pending**, **update_pending**- - `public_ips` - (String) The public IP addresses assigned to this load balancer. - - `resource_group` - (String) The resource group where the load balancer is created. + - `resource_group` - (String) The resource group id, where the load balancer is created. - `route_mode` - (Bool) Indicates whether route mode is enabled for this load balancer. - `status` - (String) The status of the load balancers. - `type` - (String) The type of the load balancer. diff --git a/website/docs/d/is_network_acl.html.markdown b/website/docs/d/is_network_acl.html.markdown index 0806ea170c..a4693da305 100644 --- a/website/docs/d/is_network_acl.html.markdown +++ b/website/docs/d/is_network_acl.html.markdown @@ -61,7 +61,7 @@ In addition to all argument references listed, you can access the following attr - `href` - (String) The URL for this network ACL. - `id` - The unique identifier of the NetworkACL. - `name` - (String) The user-defined name for this network ACL. -- `resource_group` - (List) The resource group for this network ACL. +- `resource_group` - (List) The resource group object, for this network ACL. Nested scheme for `resource_group`: - `href` - (String) The URL for this resource group. diff --git a/website/docs/d/is_network_acls.html.markdown b/website/docs/d/is_network_acls.html.markdown index f99720bda5..713dd5ef2d 100644 --- a/website/docs/d/is_network_acls.html.markdown +++ b/website/docs/d/is_network_acls.html.markdown @@ -54,7 +54,7 @@ In addition to all argument references listed, you can access the following attr - `href` - (String) The URL for this network ACL. - `id` - (String) The unique identifier for this network ACL. - `name` - (String) The user-defined name for this network ACL. - - `resource_group` - (List) The resource group for this network ACL. + - `resource_group` - (List) The resource group object, for this network ACL. Nested scheme for `resource_group`: - `href` - (String) The URL for this resource group. diff --git a/website/docs/d/is_security_groups.html.markdown b/website/docs/d/is_security_groups.html.markdown index abbbbe64df..b96c3fe2e1 100644 --- a/website/docs/d/is_security_groups.html.markdown +++ b/website/docs/d/is_security_groups.html.markdown @@ -62,19 +62,19 @@ In addition to all argument references listed, you can access the following attr - `vpc_crn` - Filters the collection to resources in the VPC with the specified CRN - `resource_group` - Filters the collection to resources in the resource group with the specified identifier - `security_groups` - (List) Collection of security groups. -Nested scheme for `security_groups`: + Nested scheme for `security_groups`: - `created_at` - (String) The date and time that this security group was created. - `crn` - (String) The security group's CRN. - `href` - (String) The security group's canonical URL. - `id` - (String) The unique identifier for this security group. - `name` - (String) The user-defined name for this security group. Names must be unique within the VPC the security group resides in. - - `resource_group` - (List) The resource group for this security group. - Nested scheme for `resource_group`: + - `resource_group` - (List) The resource group object, for this security group. + Nested scheme for `resource_group`: - `href` - (String) The URL for this resource group. - `id` - (String) The unique identifier for this resource group. - `name` - (String) The user-defined name for this resource group. - `rules` - (List) The rules for this security group. If no rules exist, all traffic will be denied. - Nested scheme for `rules`: + Nested scheme for `rules`: - `code` - (Integer) The ICMP traffic code to allow. - `direction` - (String) The direction of traffic to enforce, either `inbound` or `outbound`. - `href` - (String) The URL for this security group rule. diff --git a/website/docs/d/is_ssh_keys.html.markdown b/website/docs/d/is_ssh_keys.html.markdown index f3c05abd16..4dae3412c0 100644 --- a/website/docs/d/is_ssh_keys.html.markdown +++ b/website/docs/d/is_ssh_keys.html.markdown @@ -24,7 +24,7 @@ In addition to all argument references listed, you can access the following attr - `id` - The unique identifier of the KeyCollection. - `keys` - (List) Collection of keys. -Nested scheme for **keys**: + Nested scheme for **keys**: - `created_at` - (String) The date and time that the key was created. - `crn` - (String) The CRN for this key. - `fingerprint` - (String) The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm (always `SHA256`). @@ -37,8 +37,8 @@ Nested scheme for **keys**: - `name` - (String) The unique user-defined name for this key. If unspecified, the name will be a hyphenated list of randomly-selected words. - Constraints: The maximum length is `63` characters. The minimum length is `1` character. The value must match regular expression `/^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$/`. - `public_key` - (String) The public SSH key, consisting of two space-separated fields: the algorithm name, and the base64-encoded key. - - `resource_group` - (List) The resource group for this key. - Nested scheme for **resource_group**: + - `resource_group` - (List) The resource group object, for this key. + Nested scheme for **resource_group**: - `href` - (String) The URL for this resource group. - Constraints: The value must match regular expression `/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/`. - `id` - (String) The unique identifier for this resource group. diff --git a/website/docs/d/is_subnet_reserved_ip.html.markdown b/website/docs/d/is_subnet_reserved_ip.html.markdown index 04b9914e9f..5f2c2dd728 100644 --- a/website/docs/d/is_subnet_reserved_ip.html.markdown +++ b/website/docs/d/is_subnet_reserved_ip.html.markdown @@ -42,7 +42,7 @@ In addition to all argument reference list, you can access the following attribu - `created_at` - (String) The creation timestamp for the reserved IP. - `href` - (String) The unique reference for the reserved IP. - `id` - (String) The ID for the reserved IP. -- `lifecycle_state` - (String) TThe lifecycle state of the reserved IP. [ deleting, failed, pending, stable, suspended, updating, waiting ] +- `lifecycle_state` - (String) The lifecycle state of the reserved IP. [ deleting, failed, pending, stable, suspended, updating, waiting ] - `name` - (String) The name for the reserved IP. - `owner` - (String) The owner of the reserved IP. - `reserved_ip` - (String) The ID for the reserved IP. diff --git a/website/docs/d/is_subnet_reserved_ips.html.markdown b/website/docs/d/is_subnet_reserved_ips.html.markdown index f885f016bc..907ca5eda9 100644 --- a/website/docs/d/is_subnet_reserved_ips.html.markdown +++ b/website/docs/d/is_subnet_reserved_ips.html.markdown @@ -36,8 +36,6 @@ Review the argument references that you can specify for your data source. ## Attribute reference In addition to the argument reference list, you can access the following attribute references after your data source is created. -- `id` - (String) The ID for the all the reserved ID in current timestamp format. -- `limit` - (String) The number of reserved IPs to list. - `reserved_ips` - (List) The collection of all the reserved IPs in the subnet. Nested scheme for `reserved_ips`: @@ -45,12 +43,11 @@ In addition to the argument reference list, you can access the following attribu - `auto_delete` - (String) If reserved IP shall be deleted automatically. - `created_at` - (String) The date and time that the reserved IP was created. - `href` - (String) The URL for this reserved IP. - - `lifecycle_state` - (String) TThe lifecycle state of the reserved IP. [ deleting, failed, pending, stable, suspended, updating, waiting ] + - `lifecycle_state` - (String) The lifecycle state of the reserved IP. [ deleting, failed, pending, stable, suspended, updating, waiting ] - `reserved_ip` - (String) The unique identifier for this reserved IP. - `name` - (String) The user defined or system provided name for this reserved IP. - `owner` - (String) The owner of a reserved IP, defining whether it is managed by the user or the provider. - `resource_type` - (String) The resource type. - `sort` - (String) The keyword on which all the reserved IPs are sorted. - `subnet` - (String) The ID for the subnet for the reserved IP. -- `total_count` - (String) The number of reserved IP in the subnet. diff --git a/website/docs/d/is_subnets.html.markdown b/website/docs/d/is_subnets.html.markdown index eae1107087..b85935f8c3 100644 --- a/website/docs/d/is_subnets.html.markdown +++ b/website/docs/d/is_subnets.html.markdown @@ -83,7 +83,7 @@ You can access the following attribute references after your data source is crea - `name` - (String) The name of the subnet. - `network_acl` - (String) The access control list (ACL) that is attached to the subnet. - `public_gateway`- (Bool) If set to **true**, a public gateway is attached to the subnet. If set to **false**, no public gateway for this subnet exists. - - `resource_group` - (String) The resource group that the subnet belongs to. + - `resource_group` - (String) The resource group id, that the subnet belongs to. - `total_ipv4_address_count`- (Integer) The total number of IPv4 addresses in the subnet. - `status` - (String) The status of the subnet. - `routing_table` - (List) The routing table for this subnet. diff --git a/website/docs/d/is_volumes.html.markdown b/website/docs/d/is_volumes.html.markdown index e4eda1a32c..62e35ad229 100644 --- a/website/docs/d/is_volumes.html.markdown +++ b/website/docs/d/is_volumes.html.markdown @@ -56,8 +56,8 @@ In addition to all argument references listed, you can access the following attr - Constraints: The value must match regular expression `/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/`. - `name` - (String) The globally unique name for this volume profile. - Constraints: The maximum length is `63` characters. The minimum length is `1` character. The value must match regular expression `/^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$/`. - - `resource_group` - (List) The resource group for this volume. - Nested scheme for **resource_group**: + - `resource_group` - (List) The resource group object, for this volume. + Nested scheme for **resource_group**: - `href` - (String) The URL for this resource group. - Constraints: The value must match regular expression `/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/`. - `id` - (String) The unique identifier for this resource group. diff --git a/website/docs/d/is_vpn_gateway.html.markdown b/website/docs/d/is_vpn_gateway.html.markdown index 666094a9db..6904251874 100644 --- a/website/docs/d/is_vpn_gateway.html.markdown +++ b/website/docs/d/is_vpn_gateway.html.markdown @@ -70,7 +70,7 @@ In addition to all argument references listed, you can access the following attr - `name` - (String) The user-defined name for this VPN gateway. -- `resource_group` - (List) The resource group for this VPN gateway. +- `resource_group` - (List) The resource group object, for this VPN gateway. Nested scheme for **resource_group**: - `href` - (String) The URL for this resource group. - `id` - (String) The unique identifier for this resource group. diff --git a/website/docs/d/is_vpn_server.html.markdown b/website/docs/d/is_vpn_server.html.markdown index 08fd4ebab8..4c39bef986 100644 --- a/website/docs/d/is_vpn_server.html.markdown +++ b/website/docs/d/is_vpn_server.html.markdown @@ -46,7 +46,7 @@ In addition to all argument references listed, you can access the following attr - `identity_provider` - (List) The type of identity provider to be used by VPN client. Nested scheme for **identity_provider**: - - `provider_type` - (String) The type of identity provider to be used by the VPN client.- `iam`: IBM identity and access managementThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered. + - `provider_type` - (String) The type of identity provider to be used by the VPN client.- `iam`: IBM identity and access management The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered. - Constraints: Allowable values are: iam - `client_ca` - (List) The certificate instance used for the VPN client certificate authority (CA). Nested scheme for **client_ca**: @@ -115,7 +115,7 @@ In addition to all argument references listed, you can access the following attr - `protocol` - (String) The transport protocol used by this VPN server. - Constraints: Allowable values are: udp, tcp -- `resource_group` - (List) The resource group for this VPN server. +- `resource_group` - (List) The resource group object, for this VPN server. Nested scheme for **resource_group**: - `href` - (String) The URL for this resource group. diff --git a/website/docs/d/is_vpn_server_route.html.markdown b/website/docs/d/is_vpn_server_route.html.markdown index 3d25542768..0df8489442 100644 --- a/website/docs/d/is_vpn_server_route.html.markdown +++ b/website/docs/d/is_vpn_server_route.html.markdown @@ -31,7 +31,7 @@ Review the argument reference that you can specify for your data source. In addition to all argument references listed, you can access the following attribute references after your data source is created. - `id` - The unique identifier of the VPNServerRoute. -- `action` - (String) The action to perform with a packet matching the VPN route:- `translate`: translate the source IP address to one of the private IP addresses of the VPN server.- `deliver`: deliver the packet into the VPC.- `drop`: drop the packetThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered. +- `action` - (String) The action to perform with a packet matching the VPN route:- `translate`: translate the source IP address to one of the private IP addresses of the VPN server.- `deliver`: deliver the packet into the VPC.- `drop`: drop the packet The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered. - Constraints: Allowable values are: translate, deliver, drop - `created_at` - (String) The date and time that the VPN route was created. diff --git a/website/docs/d/is_vpn_server_routes.html.markdown b/website/docs/d/is_vpn_server_routes.html.markdown index 5009144326..35c422839c 100644 --- a/website/docs/d/is_vpn_server_routes.html.markdown +++ b/website/docs/d/is_vpn_server_routes.html.markdown @@ -44,7 +44,7 @@ Nested scheme for **next**: * `routes` - (List) Collection of VPN routes. Nested scheme for **routes**: - * `action` - (String) The action to perform with a packet matching the VPN route:- `translate`: translate the source IP address to one of the private IP addresses of the VPN server.- `deliver`: deliver the packet into the VPC.- `drop`: drop the packetThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered. + * `action` - (String) The action to perform with a packet matching the VPN route:- `translate`: translate the source IP address to one of the private IP addresses of the VPN server.- `deliver`: deliver the packet into the VPC.- `drop`: drop the packet The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered. * Constraints: Allowable values are: translate, deliver, drop * `created_at` - (String) The date and time that the VPN route was created. * `destination` - (String) The destination for this VPN route in the VPN server. If an incoming packet does not match any destination, it will be dropped. diff --git a/website/docs/d/is_vpn_servers.html.markdown b/website/docs/d/is_vpn_servers.html.markdown index e96b1e211a..9fe8df5146 100644 --- a/website/docs/d/is_vpn_servers.html.markdown +++ b/website/docs/d/is_vpn_servers.html.markdown @@ -38,7 +38,7 @@ In addition to all argument references listed, you can access the following attr * `identity_provider` - (Optional, List) The type of identity provider to be used by VPN client. Nested scheme for **identity_provider**: - * `provider_type` - (Optional, String) The type of identity provider to be used by the VPN client.- `iam`: IBM identity and access managementThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered. + * `provider_type` - (Optional, String) The type of identity provider to be used by the VPN client.- `iam`: IBM identity and access management The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered. * Constraints: Allowable values are: iam * `client_ca` - (Optional, List) The certificate instance used for the VPN client certificate authority (CA). diff --git a/website/docs/r/is_backup_policy.html.markdown b/website/docs/r/is_backup_policy.html.markdown index af88b8ec66..a6b1a5d179 100644 --- a/website/docs/r/is_backup_policy.html.markdown +++ b/website/docs/r/is_backup_policy.html.markdown @@ -38,7 +38,7 @@ Review the argument reference that you can specify for your resource. - `match_resource_types` - (Optional, List) A resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The default value is `["volume"]`. - `match_user_tags` - (Required, List) The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy. - `name` - (Required, String) The user-defined name for this backup policy. Names must be unique within the region this backup policy resides in. -- `resource_group` - (Optional, List) The resource group to use. If unspecified, the account's [default resource group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. +- `resource_group` - (Optional, List) The resource group id, to use. If unspecified, the account's [default resource group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. Nested scheme for `resource_group`: - `id` - (Optional, String) The unique identifier for this resource group. diff --git a/website/docs/r/is_subnet_network_acl_attachment.html.markdown b/website/docs/r/is_subnet_network_acl_attachment.html.markdown index a27319b08b..ba06e7e50a 100644 --- a/website/docs/r/is_subnet_network_acl_attachment.html.markdown +++ b/website/docs/r/is_subnet_network_acl_attachment.html.markdown @@ -103,7 +103,7 @@ In addition to all argument reference list, you can access the following attribu - `source_port_min` - (String) The inclusive minimum bound of UDP source port range. - `subnets` - (String) The subnets to which this network ACL is attached. - `vpc` - (String) The VPC to which this network ACL is a part of. -- `resource_group` - (String) The resource group of this network ACL. +- `resource_group` - (String) The resource group (Id), of this network ACL. - `rules` - (List) The ordered rules of this network ACL. If rules does not exist, all traffic will be denied. Nested rules blocks has the following structure. Nested scheme for `rules`: diff --git a/website/docs/r/is_subnet_reserved_ip.html.markdown b/website/docs/r/is_subnet_reserved_ip.html.markdown index 8e90bb9deb..8f15fbe04d 100644 --- a/website/docs/r/is_subnet_reserved_ip.html.markdown +++ b/website/docs/r/is_subnet_reserved_ip.html.markdown @@ -37,7 +37,7 @@ resource "ibm_is_subnet" "example" { total_ipv4_address_count = 256 } -// Create the resrved IP in the following ways +// Create the reserved IP in the following ways // Only with Subnet ID resource "ibm_is_subnet_reserved_ip" "example" { @@ -92,7 +92,9 @@ Review the argument references that you can specify for your resource. - `address` - (Optional, Forces new resource, String) The IP address. - `auto_delete`- (Optional, Bool) If reserved IP is auto deleted. -- `name` - (Optional, String) The name of the reserved IP. ~> **NOTE:** raise error if name is given with a prefix `ibm- `. +- `name` - (Optional, String) The name of the reserved IP. + + ~> **NOTE:** raise error if name is given with a prefix `ibm- `. - `subnet` - (Required, Forces new resource, String) The subnet ID for the reserved IP. - `target` - (Optional, string) The ID for the target endpoint gateway for the reserved IP. @@ -101,8 +103,8 @@ In addition to all argument reference list, you can access the following attribu - `created_at` - (Timestamp) The date and time that the reserved IP was created.", - `href` - (String) The URL for this reserved IP. -- `id` - (String) The combination of the subnet ID and reserved IP ID separated by **/**. -- `lifecycle_state` - (String) TThe lifecycle state of the reserved IP. [ deleting, failed, pending, stable, suspended, updating, waiting ] +- `id` - (String) The combination of the subnet ID and reserved IP ID, separated by **/**. +- `lifecycle_state` - (String) The lifecycle state of the reserved IP. [ deleting, failed, pending, stable, suspended, updating, waiting ] - `owner` - (String) The owner of a reserved IP, defining whether it is managed by the user or the provider. - `reserved_ip` - (String) The reserved IP. - `resource_type` - (String) The resource type. diff --git a/website/docs/r/is_vpn_gateway.html.markdown b/website/docs/r/is_vpn_gateway.html.markdown index dcea6a9c1b..d9182e6fae 100644 --- a/website/docs/r/is_vpn_gateway.html.markdown +++ b/website/docs/r/is_vpn_gateway.html.markdown @@ -57,7 +57,7 @@ Review the argument references that you can specify for your resource. - `mode`- (Optional, String) Mode in VPN gateway. Supported values are `route` or `policy`. The default value is `route`. - `name` - (Required, String) The name of the VPN gateway. -- `resource_group` - (Optional, Forces new resource, String) The resource group where the VPN gateway to be created. +- `resource_group` - (Optional, Forces new resource, String) The resource group (id), where the VPN gateway to be created. - `subnet` - (Required, Forces new resource, String) The unique identifier for this subnet. - `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. diff --git a/website/docs/r/is_vpn_server.html.markdown b/website/docs/r/is_vpn_server.html.markdown index 7dc0d71ee0..43152a58b3 100644 --- a/website/docs/r/is_vpn_server.html.markdown +++ b/website/docs/r/is_vpn_server.html.markdown @@ -51,7 +51,7 @@ Review the argument references that you can specify for your resource. -> **NOTE:** `identity_provider` and `client_ca_crn` are mutually exclusive, which means either one must be provided. When `method` has `certificate` as value `client_ca_crn` must be provided and when `method` has `username` as value `identity_provider` must be provided. - - `identity_provider` - (Required, String) The type of identity provider to be used by VPN client.The type of identity provider to be used by the VPN client.- `iam`: IBM identity and access managementThe enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered. + - `identity_provider` - (Required, String) The type of identity provider to be used by VPN client.The type of identity provider to be used by the VPN client.- `iam`: IBM identity and access management The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the route on which the unexpected property value was encountered. - Constraints: Allowable values are: iam - `client_ca_crn` - (Required, String) The CRN of the certificate instance or CRN of the secret from secrets manager to use for the VPN client certificate authority (CA). As the usage of certificate CRN from Certificate Manager is getting deprecated, It is recommended to use Secret manger for same. - `crl` - (Optional, String) The certificate revocation list contents, encoded in PEM format. @@ -70,7 +70,7 @@ Review the argument references that you can specify for your resource. - Constraints: The maximum value is `65535`. The minimum value is `1`. - `protocol` - (Optional, String) The transport protocol to use for this VPN server. - Constraints: The default value is `udp`. Allowable values are: udp, tcp -- `resource_group` - (Optional, Forces new resource, String) The resource group where the VPN gateway to be created. +- `resource_group` - (Optional, Forces new resource, String) The resource group (id), where the VPN gateway to be created. - `security_groups` - (Optional, List) The security groups to use for this VPN server. If unspecified, the VPC's default security group is used. Nested scheme for **security_groups**: