Skip to content

Commit

Permalink
data-source/alicloud_oss_buckets: Improves the attribute schema tat; …
Browse files Browse the repository at this point in the history
…docs: Improves the arguments and attributes description and notes
  • Loading branch information
xiaozhu36 committed Jan 8, 2025
1 parent 5642205 commit ce3ffdb
Show file tree
Hide file tree
Showing 8 changed files with 96 additions and 77 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
21 changes: 12 additions & 9 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 All @@ -30,20 +30,21 @@ output "first_domain_id" {

The following arguments are supported:

* `domain_name_regex` - (Optional) A regex string to filter results by the domain name.
* `group_name_regex` - (Optional) A regex string to filter results by the group name.
* `domain_name_regex` - (Optional, ForceNew) A regex string to filter results by the domain name.
* `group_name_regex` - (Optional, ForceNew) A regex string to filter results by the group name.
* `ali_domain` - (Optional, type: bool) Specifies whether the domain is from Alibaba Cloud or not.
* `instance_id` - (Optional) Cloud analysis product ID.
* `version_code` - (Optional) Cloud analysis version code.
* `ids` (Optional) - A list of domain IDs.
* `instance_id` - (Optional, ForceNew) Cloud analysis product ID.
* `version_code` - (Optional, ForceNew) Cloud analysis version code.
* `ids` (Optional, ForceNew) - A list of domain IDs.
* `output_file` - (Optional) File name where to save data source results (after running `terraform plan`).
* `resource_group_id` - (Optional, ForceNew, Available in 1.59.0+) The Id of resource group which the dns belongs.
* `group_id` - (Optional, ForceNew) Domain group ID, if not filled, the default is all groups.
* `key_word` - (Optional, ForceNew) The keywords are searched according to the `%KeyWord%` mode, which is not case sensitive.
* `lang` - (Optional, ForceNew) User language.
* `search_mode` - (Optional) Search mode, `LIKE` fuzzy search, `EXACT` exact search.
* `starmark` - (Optional) Whether to query the domain name star.
* `search_mode` - (Optional, ForceNew) Search mode, `LIKE` fuzzy search, `EXACT` exact search.
* `starmark` - (Optional, ForceNew) Whether to query the domain name star.
* `tags` - (Optional) A mapping of tags to assign to the resource.
* `enable_details` - (Optional) Default to `false`. Set it to `true` can output more details about resource attributes.

## Attributes Reference

Expand All @@ -59,6 +60,7 @@ The following attributes are exported in addition to the arguments listed above:
* `group_name` - Name of group that contains the domain.
* `instance_id` - Cloud analysis product ID of the domain.
* `version_code` - Cloud analysis version code of the domain.
* `version_name` - Cloud analysis version name of the domain.
* `puny_code` - Punycode of the Chinese domain.
* `dns_servers` - DNS list of the domain in the analysis system.
* `resource_group_id` - The Id of resource group which the dns belongs.
Expand All @@ -73,6 +75,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
Loading

0 comments on commit ce3ffdb

Please sign in to comment.