Skip to content

Commit

Permalink
docs: Improves the arguments and attributes description and notes
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaozhu36 committed Jan 8, 2025
1 parent 5642205 commit a708bc1
Show file tree
Hide file tree
Showing 8 changed files with 87 additions and 70 deletions.
13 changes: 7 additions & 6 deletions alicloud/data_source_alicloud_oss_buckets.go
Original file line number Diff line number Diff line change
Expand Up @@ -189,11 +189,11 @@ func dataSourceAlicloudOssBuckets() *schema.Resource {
Schema: map[string]*schema.Schema{
"date": {
Type: schema.TypeString,
Optional: true,
Computed: true,
},
"days": {
Type: schema.TypeInt,
Optional: true,
Computed: true,
},
},
},
Expand All @@ -205,7 +205,7 @@ func dataSourceAlicloudOssBuckets() *schema.Resource {

"policy": {
Type: schema.TypeString,
Optional: true,
Computed: true,
},

"server_side_encryption_rule": {
Expand All @@ -225,9 +225,10 @@ func dataSourceAlicloudOssBuckets() *schema.Resource {
},
MaxItems: 1,
},

"tags": tagsSchemaComputed(),

"tags": {
Type: schema.TypeMap,
Computed: true,
},
"versioning": {
Type: schema.TypeList,
Computed: true,
Expand Down
5 changes: 3 additions & 2 deletions website/docs/d/alidns_domains.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ description: |-
Provides a list of domains available to the user.
---

# alicloud\_alidns\_domains
# alicloud_alidns_domains

This data source provides a list of Alidns Domains in an Alibaba Cloud account according to the specified filters.

-> **NOTE:** Available in 1.95.0+.
-> **NOTE:** Available since v1.95.0.

## Example Usage

Expand Down Expand Up @@ -73,6 +73,7 @@ The following attributes are exported in addition to the arguments listed above:
* `remark` - The Id of resource group which the dns belongs.
* `slave_dns` - Whether to allow auxiliary dns.
* `available_ttls` - List of available TTLs.
* `tags` - Tags of the domain.
* `record_lines` - Parse the line data list.
* `father_code` - The code of the parent line, or empty if there is none.
* `line_display_name` - Parent line display name.
Expand Down
9 changes: 6 additions & 3 deletions website/docs/d/oss_buckets.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ description: |-
Provides a list of OSS buckets to the user.
---

# alicloud\_oss_buckets
# alicloud_oss_buckets

This data source provides the OSS buckets of the current Alibaba Cloud user.

-> **NOTE:** Available since v1.17.0.

## Example Usage

```
```terraform
data "alicloud_oss_buckets" "oss_buckets_ds" {
name_regex = "sample_oss_bucket"
}
Expand All @@ -27,7 +29,7 @@ output "first_oss_bucket_name" {

The following arguments are supported:

* `name_regex` - (Optional) A regex string to filter results by bucket name.
* `name_regex` - (Optional, ForceNew) A regex string to filter results by bucket name.
* `output_file` - (Optional) File name where to save data source results (after running `terraform plan`).

## Attributes Reference
Expand All @@ -45,6 +47,7 @@ The following attributes are exported in addition to the arguments listed above:
* `storage_class` - Object storage type. Possible values: `Standard`, `IA`, `Archive` and `ColdArchive`.
* `redundancy_type` - Redundancy type. Possible values: `LRS`, and `ZRS`.
* `creation_date` - Bucket creation date.
* `policy` - The policies configured for a specified bucket.
* `cors_rules` - A list of CORS rule configurations. Each element contains the following attributes:
* `allowed_origins` - The origins allowed for cross-domain requests. Multiple elements can be used to specify multiple allowed origins. Each rule allows up to one wildcard "\*". If "\*" is specified, cross-domain requests of all origins are allowed.
* `allowed_methods` - Specify the allowed methods for cross-domain requests. Possible values: `GET`, `PUT`, `DELETE`, `POST` and `HEAD`.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/adb_db_cluster.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: |-

Provides a AnalyticDB for MySQL (ADB) DBCluster resource.

For information about AnalyticDB for MySQL (ADB) DBCluster and how to use it, see [What is DBCluster](https://www.alibabacloud.com/help/en/analyticdb-for-mysql/developer-reference/api-adb-2021-12-01-createdbcluster).
For information about AnalyticDB for MySQL (ADB) DBCluster and how to use it, see [What is DBCluster](https://www.alibabacloud.com/help/en/analyticdb/analyticdb-for-mysql/product-overview/what-is-analyticdb-for-mysql).

-> **NOTE:** Available since v1.121.0.

Expand Down
26 changes: 17 additions & 9 deletions website/docs/r/log_resource_record.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -60,25 +60,33 @@ resource "alicloud_log_resource" "example" {
resource "alicloud_log_resource_record" "example" {
resource_name = alicloud_log_resource.example.id
record_id = "user_tf_resource_1"
tag = "resource tag"
record_id = "tf_user_example"
tag = "tf example"
value = <<EOF
{
"col1": "this is col1 value",
"col2": "col2 value"
}
EOF
{
"user_name": "tf example",
"sms_enabled": true,
"phone": "18888888889",
"voice_enabled": false,
"email": [
"[email protected]"
],
"enabled": true,
"user_id": "tf_user",
"country_code": "86"
}
EOF
}
```

## Argument Reference

The following arguments are supported:

* `resource_name` - (Required) The name defined in log_resource, log service have some internal resource, like sls.common.user, sls.common.user_group.
* `resource_name` - (Required) The name defined in log_resource, log service have some internal resource, like sls.common.user, sls.common.user_group. More detail see [Resource Data Structure](https://www.alibabacloud.com/help/en/sls/developer-reference/data-structure-of-alert-resource-data).
* `record_id` - (Required, ForceNew) The record's id, should be unique.
* `tag` - (Required) The record's tag, can be used for search.
* `value` - (Required) The json value of record.
* `value` - (Required) The json value of record. More detail see [Resource Data Structure](https://www.alibabacloud.com/help/en/sls/developer-reference/data-structure-of-alert-resource-data).

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/nas_mount_target.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The following arguments are supported:

The following attributes are exported:

*`id` - This ID of this resource. It is formatted to `<file_system_id>:<mount_target_domain>`. Before version 1.95.0, the value is `<mount_target_domain>`.
* `id` - This ID of this resource. It is formatted to `<file_system_id>:<mount_target_domain>`. Before version 1.95.0, the value is `<mount_target_domain>`.
* `mount_target_domain` - The IPv4 domain name of the mount target. **NOTE:** Available since v1.161.0.

## Timeouts
Expand Down
9 changes: 1 addition & 8 deletions website/docs/r/nat_gateway.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -97,13 +97,6 @@ resource "alicloud_nat_gateway" "default" {
}
```

### Deleting `alicloud_nat_gateway` or removing it from your configuration

The `alicloud_nat_gateway` resource allows you to manage `payment_type = "Subscription"` or `instance_charge_type = "Prepaid"` nat gateway, but Terraform cannot destroy it.
Deleting the subscription resource or removing it from your configuration
will remove it from your statefile and management, but will not destroy the Nat Gateway.
You can resume managing the subscription nat gateway via the AlibabaCloud Console.

## Argument Reference

The following arguments are supported:
Expand All @@ -114,7 +107,7 @@ The following arguments are supported:
* `description` - (Optional) Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
* `dry_run` - (Optional) Specifies whether to only precheck this request. Default value: `false`.
* `force` - (Optional) Specifies whether to forcefully delete the NAT gateway.
* `payment_type` - (Optional, ForceNew, Available since v1.121.0) The billing method of the NAT gateway. Valid values are `PayAsYouGo` and `Subscription`. Default to `PayAsYouGo`.
* `payment_type` - (Optional, ForceNew, Available since v1.121.0) The billing method of the NAT gateway. Valid values are `PayAsYouGo`. Default to `PayAsYouGo`.
* `period` - (Optional, Available since v1.45.0) The duration that you will buy the resource, in month. It is valid when `payment_type` is `Subscription`. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. **NOTE:** International station only supports `Subscription`.
-> **NOTE:** The attribute `period` is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running `terraform apply` will not effect the resource.
* `nat_type` - (Optional, Available since v1.102.0) The type of NAT gateway. Valid values: `Enhanced`. **NOTE:** From version 1.137.0, `nat_type` cannot be set to `Normal`.
Expand Down
91 changes: 51 additions & 40 deletions website/docs/r/vpn_connection.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -185,47 +185,51 @@ The following arguments are supported:
* `tunnel_options_specification` - (Optional) The tunnel options of IPsec. See [`tunnel_options_specification`](#tunnel_options_specification) below.
* `vpn_connection_name` - (Optional) The name of the IPsec-VPN connection.
* `vpn_gateway_id` - (Required, ForceNew) The ID of the VPN gateway.

The following arguments will be discarded. Please use new fields as soon as possible:
* `name` - (Deprecated since v1.216.0). Field 'name' has been deprecated from provider version 1.216.0. New field 'vpn_connection_name' instead.

### `bgp_config`

The bgp_config supports the following:
* `enable` - (Optional, Computed) Bgp enable.
* `local_asn` - (Optional, Computed) Local asn.
* `local_bgp_ip` - (Optional, Computed) Local bgp IP.
* `tunnel_cidr` - (Optional, Computed) IPSec tunnel Cidr.
* `enable` - (Optional, Computed) specifies whether to enable BGP. Valid values: true and false (default).
* `local_asn` - (Optional, Computed) the autonomous system number (ASN) on the Alibaba Cloud side.
Valid values: 1 to 4294967295. Default value: 45104. You can enter a value in two segments separated by a period (.).
Each segment is 16 bits in length. Enter the number in each segment in decimal format.
For example, if you enter 123.456, the ASN is 8061384. The ASN is calculated by using the following formula: 123 × 65536 + 456 = 8061384.
* `local_bgp_ip` - (Optional, Computed) the BGP address on the Alibaba Cloud side. It must be an IP address that falls within the CIDR block of the IPsec tunnel.
* `tunnel_cidr` - (Optional, Computed) The CIDR block of the IPsec tunnel. The CIDR block must belong to 169.254.0.0/16 and the subnet mask is 30 bits in length.

### `health_check_config`

The health_check_config supports the following:
* `dip` - (Optional, Computed) Destination IP.
* `enable` - (Optional, Computed) Specifies whether to enable healthcheck.
* `interval` - (Optional, Computed) Retry interval.
* `retry` - (Optional, Computed) retry times.
* `sip` - (Optional, Computed) Source IP.
* `dip` - (Optional, Computed) the destination IP address configured for health checks.
* `enable` - (Optional, Computed) specifies whether to enable health checks. Valid values: true and false. Default value: false.
* `interval` - (Optional, Computed) the time interval of health check retries. Unit: seconds. Default value: 3.
* `retry` - (Optional, Computed) the maximum number of health check retries. Default value: 3.
* `sip` - (Optional, Computed) the source IP address that is used for health checks.

### `ike_config`

The ike_config supports the following:
* `ike_auth_alg` - (Optional, Computed) IKE auth Algorithm.
* `ike_enc_alg` - (Optional, Computed) IKE encript algorithm.
* `ike_lifetime` - (Optional, Computed) IKE lifetime.
* `ike_local_id` - (Optional, Computed) The local ID, which supports the FQDN and IP formats, and defaults to the IP address of the selected VPN gateway.
* `ike_mode` - (Optional, Computed) IKE mode, supports main and aggressive mode. The main mode is highly secure. If NAT traversal is enabled, we recommend that you use the aggressive mode.
* `ike_pfs` - (Optional, Computed) DH group.
* `ike_remote_id` - (Optional, Computed) The peer ID. The FQDN and IP address formats are supported. The default value is the IP address of the selected customer gateway.
* `ike_version` - (Optional, Computed) IKE version.
* `psk` - (Optional, Computed) Preshared secret key.
* `ike_auth_alg` - (Optional, Computed) the authentication algorithm that is used in Phase 1 negotiations. Valid values: md5, sha1, sha2
* `ike_enc_alg` - (Optional, Computed) the encryption algorithm that is used in Phase 1 negotiations. Valid values: aes, aes192, aes256, des, and 3des. Default value: aes.
* `ike_lifetime` - (Optional, Computed) the SA lifetime as a result of Phase 1 negotiations. Unit: seconds. Valid values: 0 to 86400. Default value: 86400.
* `ike_local_id` - (Optional, Computed) the identifier of the VPN gateway. It can contain at most 100 characters. The default value is the IP address of the VPN gateway.
* `ike_mode` - (Optional, Computed) the negotiation mode of IKE. Valid values: main and aggressive. Default value: main.
- main: This mode offers higher security during negotiations.
- aggressive: This mode supports faster negotiations and a higher success rate.
* `ike_pfs` - (Optional, Computed) the Diffie-Hellman key exchange algorithm that is used in Phase 1 negotiations. Valid values: group1, group2, group5, and group14. Default value: group2.
* `ike_remote_id` - (Optional, Computed) the identifier of the customer gateway. It can contain at most 100 characters. The default value is the IP address of the customer gateway.
* `ike_version` - (Optional, Computed) the version of the Internet Key Exchange (IKE) protocol. Valid values: ikev1 and ikev2. Default value: ikev1.
Compared with IKEv1, IKEv2 simplifies the security association (SA) negotiation process and provides better support for scenarios with multiple CIDR blocks.
* `psk` - (Optional, Computed) the pre-shared key that is used for identity authentication between the VPN gateway and the on-premises data center. The key must be 1 to 100 characters in length and can contain digits, letters, and the following special characters: ~!\`@#$%^&*()_-+={}[]|;:',.<>/? If you do not specify a pre-shared key, the system randomly generates a 16-bit string as the pre-shared key. You can call the DescribeVpnConnection operation to query the pre-shared key that is automatically generated by the system.

### `ipsec_config`

The ipsec_config supports the following:
* `ipsec_auth_alg` - (Optional, Computed) IPsec authentication algorithm. sha1 and md5 are supported.
* `ipsec_enc_alg` - (Optional, Computed) IPsec Encript algorithm.
* `ipsec_lifetime` - (Optional, Computed) IPsec lifetime.
* `ipsec_pfs` - (Optional, Computed) DH Group.
* `ipsec_auth_alg` - (Optional, Computed) the authentication algorithm that is used in Phase 2 negotiations. Valid values: md5, sha1, sha256, sha384, and sha512. Default value: md5.
* `ipsec_enc_alg` - (Optional, Computed) the encryption algorithm that is used in Phase 2 negotiations. Valid values: aes, aes192, aes256, des, and 3des. Default value: aes.
* `ipsec_lifetime` - (Optional, Computed) the SA lifetime that is determined by Phase 2 negotiations. Unit: seconds. Valid values: 0 to 86400. Default value: 86400.
* `ipsec_pfs` - (Optional, Computed) the DH key exchange algorithm that is used in Phase 2 negotiations. Valid values: disabled, group1, group2, group5, and group14. Default value: group2.

### `tunnel_options_specification`

Expand All @@ -241,30 +245,37 @@ The tunnel_options_specification supports the following:
### `tunnel_options_specification-tunnel_bgp_config`

The tunnel_options_specification-tunnel_bgp_config supports the following:
* `local_asn` - (Optional) Local asn.
* `local_bgp_ip` - (Optional) Local bgp IP.
* `tunnel_cidr` - (Optional) BGP Tunnel CIDR.
* `local_asn` - (Optional) The autonomous system number (ASN) of the tunnel on the Alibaba Cloud side. Valid values: 1 to 4294967295. Default value: 45104.
* `local_bgp_ip` - (Optional) The BGP IP address of the tunnel on the Alibaba Cloud side. The address is an IP address that falls within the BGP CIDR block.
* `tunnel_cidr` - (Optional) The BGP CIDR block of the tunnel. The CIDR block must fall within the 169.254.0.0/16 range. The subnet mask of the CIDR block must be 30 bits in length.

### `tunnel_options_specification-tunnel_ike_config`

The tunnel_options_specification-tunnel_ike_config supports the following:
* `ike_auth_alg` - (Optional) IKE auth Algorithm.
* `ike_enc_alg` - (Optional) IKE encript algorithm.
* `ike_lifetime` - (Optional) IKE lifetime.
* `ike_mode` - (Optional) IKE Mode.
* `ike_pfs` - (Optional) DH Group.
* `ike_version` - (Optional) IKE Version.
* `local_id` - (Optional) The local Id.
* `psk` - (Optional) Preshared secret key.
* `remote_id` - (Optional) Remote ID.
* `ike_auth_alg` - (Optional) The authentication algorithm that is used in Phase 1 negotiations. Valid values: md5, sha1, sha256, sha384, and sha512. Default value: md5.
* `ike_enc_alg` - (Optional) The encryption algorithm that is used in Phase 1 negotiations. Valid values: aes, aes192, aes256, des, and 3des. Default value: aes.
* `ike_lifetime` - (Optional) The SA lifetime as a result of Phase 1 negotiations. Unit: seconds. Valid values: 0 to 86400. Default value: 86400.
* `ike_mode` - (Optional) The negotiation mode of IKE. Valid values: main and aggressive. Default value: main.
- main: This mode offers higher security during negotiations.
- aggressive: This mode supports faster negotiations and a higher success rate.
* `ike_pfs` - (Optional) The Diffie-Hellman key exchange algorithm that is used in Phase 1 negotiations. Default value: group2.
* `ike_version` - (Optional) The version of the IKE protocol. Valid values: ikev1 and ikev2. Default value: ikev1.
Compared with IKEv1, IKEv2 simplifies the SA negotiation process and provides better support for scenarios with multiple CIDR blocks.
* `local_id` - (Optional) The identifier of the tunnel on the Alibaba Cloud side, which is used in Phase 1 negotiations. It can contain at most 100 characters. The default value is the IP address of the tunnel.
LocalId supports fully qualified domain names (FQDNs). If you use an FQDN, we recommend that you set the negotiation mode to aggressive.
* `psk` - (Optional) The pre-shared key that is used for identity authentication between the tunnel and the tunnel peer.
The key must be 1 to 100 characters in length and can contain digits, letters, and the following special characters: ~!\`@#$%^&*()_-+={}[]|;:',.<>/?
If you do not specify a pre-shared key, the system randomly generates a 16-bit string as the pre-shared key. You can call the DescribeVpnConnection operation to query the pre-shared key that is automatically generated by the system.
* `remote_id` - (Optional) The identifier of the tunnel peer, which is used in Phase 1 negotiations. It can contain at most 100 characters. The default value is the IP address of the customer gateway that is associated with the tunnel.
RemoteId supports FQDNs. If you use an FQDN, we recommend that you set the negotiation mode to aggressive.

### `tunnel_options_specification-tunnel_ipsec_config`

The tunnel_options_specification-tunnel_ipsec_config supports the following:
* `ipsec_auth_alg` - (Optional) IPsec Auth algorithm.
* `ipsec_enc_alg` - (Optional) IPsec Encript algorithm.
* `ipsec_lifetime` - (Optional) IPsec lifetime.
* `ipsec_pfs` - (Optional) DH Group.
* `ipsec_auth_alg` - (Optional) The authentication algorithm that is used in Phase 2 negotiations. Valid values: md5, sha1, sha256, sha384, and sha512. Default value: md5.
* `ipsec_enc_alg` - (Optional) The encryption algorithm that is used in Phase 2 negotiations. Valid values: aes, aes192, aes256, des, and 3des. Default value: aes.
* `ipsec_lifetime` - (Optional) The SA lifetime as a result of Phase 2 negotiations. Unit: seconds. Valid values: 0 to 86400. Default value: 86400.
* `ipsec_pfs` - (Optional) The Diffie-Hellman key exchange algorithm that is used in Phase 2 negotiations. Default value: group2. Valid values: disabled, group1, group2, group5, and group14.

## Attributes Reference

Expand Down

0 comments on commit a708bc1

Please sign in to comment.