Skip to content

Commit c352f80

Browse files
lyu571lyu571
committed
support example and update example json
1 parent 56c8e69 commit c352f80

File tree

6 files changed

+40330
-62
lines changed

6 files changed

+40330
-62
lines changed

‎config/snippets/tiat-examples.json‎

Lines changed: 2771 additions & 0 deletions
Large diffs are not rendered by default.

‎config/tips/tiat-resources.json‎

Lines changed: 103 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -16412,16 +16412,15 @@
1641216412
"args": [
1641316413
{
1641416414
"name": "availability_zone",
16415-
"description": "- (Required, String, ForceNew) The available zone for the CVM instance."
16415+
"description": "- (Required, String) The available zone for the CVM instance."
1641616416
},
1641716417
{
1641816418
"name": "image_id",
1641916419
"description": "- (Required, String) The image to use for the instance. Changing image_id will cause the instance reset."
1642016420
},
1642116421
{
1642216422
"name": "allocate_public_ip",
16423-
"description": "- (Optional, Bool, ForceNew) Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.",
16424-
"default": false,
16423+
"description": "- (Optional, Bool) Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false.",
1642516424
"options": [
1642616425
true,
1642716426
false
@@ -16433,28 +16432,73 @@
1643316432
},
1643416433
{
1643516434
"name": "cam_role_name",
16436-
"description": "- (Optional, String, ForceNew) CAM role name authorized to access."
16435+
"description": "- (Optional, String) CAM role name authorized to access."
1643716436
},
1643816437
{
1643916438
"name": "cdh_host_id",
16440-
"description": "- (Optional, String, ForceNew) Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID."
16439+
"description": "- (Optional, String) Id of cdh instance. Note: it only works when instance_charge_type is set to CDHPAID."
1644116440
},
1644216441
{
1644316442
"name": "cdh_instance_type",
1644416443
"description": "- (Optional, String) Type of instance created on cdh, the value of this parameter is in the format of CDH_XCXG based on the number of CPU cores and memory capacity. Note: it only works when instance_charge_type is set to CDHPAID."
1644516444
},
1644616445
{
1644716446
"name": "data_disks",
16448-
"description": "- (Optional, List, ForceNew) Settings for data disks."
16447+
"description": "- (Optional, Maplist) Settings for data disks.",
16448+
"detail": [
16449+
{
16450+
"name": "data_disk_type",
16451+
"description": "- (Required, String) Data disk type. For more information about limits on different data disk types, see [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952). Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, LOCAL_NVME: local NVME disk, specified in the InstanceType, LOCAL_PRO: local HDD disk, specified in the InstanceType, CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD, CLOUD_BSSD: Balanced SSD.",
16452+
"options": [
16453+
"LOCAL_BASIC",
16454+
"LOCAL_SSD",
16455+
"LOCAL_NVME",
16456+
"LOCAL_PRO",
16457+
"CLOUD_BASIC",
16458+
"CLOUD_PREMIUM",
16459+
"CLOUD_SSD",
16460+
"CLOUD_HSSD",
16461+
"CLOUD_TSSD",
16462+
"CLOUD_BSSD"
16463+
]
16464+
},
16465+
{
16466+
"name": "data_disk_size",
16467+
"description": "- (Required, Int) Size of the data disk, and unit is GB."
16468+
},
16469+
{
16470+
"name": "data_disk_snapshot_id",
16471+
"description": "- (Optional, String) Snapshot ID of the data disk. The selected data disk snapshot size must be smaller than the data disk size."
16472+
},
16473+
{
16474+
"name": "data_disk_id",
16475+
"description": "- (Optional, String) Data disk ID used to initialize the data disk. When data disk type is `LOCAL_BASIC` and `LOCAL_SSD`, disk id is not supported."
16476+
},
16477+
{
16478+
"name": "delete_with_instance",
16479+
"description": "- (Optional, Bool) Decides whether the disk is deleted with instance(only applied to `CLOUD_BASIC`, `CLOUD_SSD` and `CLOUD_PREMIUM` disk with `POSTPAID_BY_HOUR` instance), default is true.",
16480+
"options": [
16481+
true,
16482+
false
16483+
]
16484+
},
16485+
{
16486+
"name": "encrypt",
16487+
"description": "- (Optional, Bool) Decides whether the disk is encrypted. Default is `false`.",
16488+
"options": [
16489+
true,
16490+
false
16491+
]
16492+
},
16493+
{
16494+
"name": "throughput_performance",
16495+
"description": "- (Optional, Int) Add extra performance to the data disk. Only works when disk type is `CLOUD_TSSD` or `CLOUD_HSSD`."
16496+
}
16497+
]
1644916498
},
1645016499
{
1645116500
"name": "disable_api_termination",
16452-
"description": "- (Optional, Bool) Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action.",
16453-
"default": false,
16454-
"options": [
16455-
true,
16456-
false
16457-
]
16501+
"description": "- (Optional, Bool) Whether the termination protection is enabled. Default is false. If set true, which means that this instance can not be deleted by an API action."
1645816502
},
1645916503
{
1646016504
"name": "disable_monitor_service",
@@ -16466,20 +16510,39 @@
1646616510
},
1646716511
{
1646816512
"name": "force_delete",
16469-
"description": "- (Optional, Bool) Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance."
16513+
"description": "- (Optional, Bool) Indicate whether to force delete the instance. Default is false. If set true, the instance will be permanently deleted instead of being moved into the recycle bin. Note: only works for PREPAID instance.",
16514+
"options": [
16515+
true,
16516+
false
16517+
]
1647016518
},
1647116519
{
1647216520
"name": "hostname",
16473-
"description": "- (Optional, String) The hostname of the instance. Windows instance: The name should be a combination of 2 to 15 characters comprised of letters (case insensitive), numbers, and hyphens (-). Period (.) is not supported, and the name cannot be a string of pure numbers. Other types (such as Linux) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifying will cause the instance reset."
16521+
"description": "- (Optional, String) of instances: The name should be a combination of 2 to 60 characters, supporting multiple periods (.). The piece between two periods is composed of letters (case insensitive), numbers, and hyphens (-). Modifying will cause the instance reset."
1647416522
},
1647516523
{
1647616524
"name": "instance_charge_type_prepaid_period",
16477-
"description": "- (Optional, Int) The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36."
16525+
"description": "- (Optional, Int) of the prepaid instance, NOTE: it only works when instance_charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.",
16526+
"options": [
16527+
1,
16528+
2,
16529+
3,
16530+
4,
16531+
5,
16532+
6,
16533+
7,
16534+
8,
16535+
9,
16536+
10,
16537+
11,
16538+
12,
16539+
24,
16540+
36
16541+
]
1647816542
},
1647916543
{
1648016544
"name": "instance_charge_type_prepaid_renew_flag",
1648116545
"description": "- (Optional, String) Auto renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to PREPAID.",
16482-
"default": "NOTIFY_AND_MANUAL_RENEW",
1648316546
"options": [
1648416547
"NOTIFY_AND_AUTO_RENEW",
1648516548
"NOTIFY_AND_MANUAL_RENEW",
@@ -16489,7 +16552,6 @@
1648916552
{
1649016553
"name": "instance_charge_type",
1649116554
"description": "- (Optional, String) The charge type of instance. Valid values are PREPAID, POSTPAID_BY_HOUR, SPOTPAID and CDHPAID. The default is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR and CDHPAID. PREPAID instance may not allow to delete before expired. SPOTPAID instance must set spot_instance_type and spot_max_price at the same time. CDHPAID instance must set cdh_instance_type and cdh_host_id.",
16492-
"default": "POSTPAID_BY_HOUR",
1649316555
"options": [
1649416556
"PREPAID",
1649516557
"POSTPAID_BY_HOUR",
@@ -16499,7 +16561,7 @@
1649916561
},
1650016562
{
1650116563
"name": "instance_count",
16502-
"description": "- (Optional, Int, Deprecated) It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1."
16564+
"description": "- (Optional, Int) It has been deprecated from version 1.59.18. Use built-in count instead. The number of instances to be purchased. Value range:[1,100]; default value: 1."
1650316565
},
1650416566
{
1650516567
"name": "instance_name",
@@ -16512,12 +16574,11 @@
1651216574
{
1651316575
"name": "internet_charge_type",
1651416576
"description": "- (Optional, String) Internet charge type of the instance, Valid values are BANDWIDTH_PREPAID, TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_POSTPAID_BY_HOUR and BANDWIDTH_PACKAGE. If not set, internet charge type are consistent with the cvm charge type by default. This value takes NO Effect when changing and does not need to be set when allocate_public_ip is false.",
16515-
"default": "",
1651616577
"options": [
1651716578
"BANDWIDTH_PREPAID",
16518-
"TRAFFIC_POSTPAID_BY_HOUR",
1651916579
"BANDWIDTH_POSTPAID_BY_HOUR",
16520-
"BANDWIDTH_PACKAGE"
16580+
"BANDWIDTH_PACKAGE",
16581+
"TRAFFIC_POSTPAID_BY_HOUR"
1652116582
]
1652216583
},
1652316584
{
@@ -16530,23 +16591,23 @@
1653016591
},
1653116592
{
1653216593
"name": "key_ids",
16533-
"description": "- (Optional, Set: [String]) The key pair to use for the instance, it looks like skey-16jig7tx. Modifying will cause the instance reset."
16594+
"description": "- (Optional, String) The key pair to use for the instance, it looks like skey-16jig7tx. Modifying will cause the instance reset."
1653416595
},
1653516596
{
1653616597
"name": "key_name",
16537-
"description": "- (Optional, String, Deprecated) Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifying will cause the instance reset."
16598+
"description": "- (Optional, String) Please use key_ids instead. The key pair to use for the instance, it looks like skey-16jig7tx. Modifying will cause the instance reset."
1653816599
},
1653916600
{
1654016601
"name": "orderly_security_groups",
16541-
"description": "- (Optional, List: [String]) A list of orderly security group IDs to associate with."
16602+
"description": "- (Optional, String) A list of orderly security group IDs to associate with."
1654216603
},
1654316604
{
1654416605
"name": "password",
1654516606
"description": "- (Optional, String) Password for the instance. In order for the new password to take effect, the instance will be restarted after the password change. Modifying will cause the instance reset."
1654616607
},
1654716608
{
1654816609
"name": "placement_group_id",
16549-
"description": "- (Optional, String, ForceNew) The ID of a placement group."
16610+
"description": "- (Optional, String) The ID of a placement group."
1655016611
},
1655116612
{
1655216613
"name": "private_ip",
@@ -16558,24 +16619,26 @@
1655816619
},
1655916620
{
1656016621
"name": "running_flag",
16561-
"description": "- (Optional, Bool) Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false."
16562-
},
16563-
{
16564-
"name": "security_groups",
16565-
"description": "- (Optional, Set: [String], Deprecated) It will be deprecated. Use orderly_security_groups instead. A list of security group IDs to associate with."
16622+
"description": "- (Optional, Bool) Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false.",
16623+
"options": [
16624+
true,
16625+
false
16626+
]
1656616627
},
1656716628
{
1656816629
"name": "spot_instance_type",
16569-
"description": "- (Optional, String) Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID."
16630+
"description": "- (Optional, String) Type of spot instance, only support ONE-TIME now. Note: it only works when instance_charge_type is set to SPOTPAID.",
16631+
"options": [
16632+
"ONE-TIME"
16633+
]
1657016634
},
1657116635
{
1657216636
"name": "spot_max_price",
16573-
"description": "- (Optional, String, ForceNew) Max price of a spot instance, is the format of decimal string, for example \"0.50\". Note: it only works when instance_charge_type is set to SPOTPAID."
16637+
"description": "- (Optional, String) Max price of a spot instance, is the format of decimal string, for example \"0.50\". Note: it only works when instance_charge_type is set to SPOTPAID."
1657416638
},
1657516639
{
1657616640
"name": "stopped_mode",
1657716641
"description": "- (Optional, String) Billing method of a pay-as-you-go instance after shutdown. Available values: KEEP_CHARGING,STOP_CHARGING. Default KEEP_CHARGING.",
16578-
"default": "KEEP_CHARGING",
1657916642
"options": [
1658016643
"KEEP_CHARGING",
1658116644
"STOP_CHARGING"
@@ -16596,7 +16659,6 @@
1659616659
{
1659716660
"name": "system_disk_type",
1659816661
"description": "- (Optional, String) System disk type. For more information on limits of system disk types, see Storage Overview. Valid values: LOCAL_BASIC: local disk, LOCAL_SSD: local SSD disk, CLOUD_BASIC: cloud disk, CLOUD_SSD: cloud SSD disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: Basic SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. NOTE: If modified, the instance may force stop.",
16599-
"default": "",
1660016662
"options": [
1660116663
"LOCAL_BASIC",
1660216664
"LOCAL_SSD",
@@ -16614,40 +16676,36 @@
1661416676
},
1661516677
{
1661616678
"name": "user_data_raw",
16617-
"description": "- (Optional, String, ForceNew) The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded."
16679+
"description": "- (Optional, String) The user data to be injected into this instance, in plain text. Conflicts with user_data. Up to 16 KB after base64 encoded."
1661816680
},
1661916681
{
1662016682
"name": "user_data",
16621-
"description": "- (Optional, String, ForceNew) The user data to be injected into this instance. Must be base64 encoded and up to 16 KB."
16683+
"description": "- (Optional, String) The user data to be injected into this instance. Must be base64 encoded and up to 16 KB."
1662216684
},
1662316685
{
1662416686
"name": "vpc_id",
1662516687
"description": "- (Optional, String) The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set."
1662616688
}
1662716689
],
1662816690
"attrs": [
16629-
{
16630-
"name": "id",
16631-
"description": "- ID of the resource."
16632-
},
1663316691
{
1663416692
"name": "create_time",
16635-
"description": "- Create time of the instance."
16693+
"description": "- (Readonly, String) Create time of the instance."
1663616694
},
1663716695
{
1663816696
"name": "expired_time",
16639-
"description": "- Expired time of the instance."
16697+
"description": "- (Readonly, String) Expired time of the instance."
1664016698
},
1664116699
{
1664216700
"name": "instance_status",
16643-
"description": "- Current status of the instance."
16701+
"description": "- (Readonly, String) Current status of the instance."
1664416702
},
1664516703
{
1664616704
"name": "public_ip",
16647-
"description": "- Public IP of the instance."
16705+
"description": "- (Readonly, String) Public ip of the instance."
1664816706
}
1664916707
],
16650-
"url": "/docs/providers/tencentcloud/r/instance.html"
16708+
"url": "/docs/providers/tencentcloud/r/tencentcloud_cvm_instance.html"
1665116709
},
1665216710
"tencentcloud_instance_set": {
1665316711
"args": [

0 commit comments

Comments
 (0)