From a781d8b8284fdeabda41624d009c02e5bf6800e9 Mon Sep 17 00:00:00 2001 From: Yin Luo Date: Tue, 12 Dec 2023 14:13:44 +0800 Subject: [PATCH] enable git and doc definition panel (#11) * enable git * enable doc panel * fix doc issue * add css for webview * fix resource tips * 0.0.24 --- .../d/address_template_groups.html.markdown | 39 + config/docs/d/address_templates.html.markdown | 39 + ...antiddos_basic_device_status.html.markdown | 45 + .../d/antiddos_bgp_biz_trend.html.markdown | 47 + .../d/antiddos_list_listener.html.markdown | 67 ++ ...tiddos_overview_attack_trend.html.markdown | 44 + .../antiddos_overview_cc_trend.html.markdown | 44 + ...dos_overview_ddos_event_list.html.markdown | 50 + ...antiddos_overview_ddos_trend.html.markdown | 44 + .../d/antiddos_overview_index.html.markdown | 46 + .../antiddos_pending_risk_info.html.markdown | 37 + .../d/api_gateway_api_app_api.html.markdown | 137 +++ .../api_gateway_api_app_service.html.markdown | 123 ++ .../docs/d/api_gateway_api_apps.html.markdown | 44 + .../docs/d/api_gateway_api_docs.html.markdown | 36 + .../docs/d/api_gateway_api_keys.html.markdown | 50 + .../d/api_gateway_api_plugins.html.markdown | 46 + .../api_gateway_api_usage_plans.html.markdown | 107 ++ config/docs/d/api_gateway_apis.html.markdown | 107 ++ ...gateway_bind_api_apps_status.html.markdown | 56 + ...api_gateway_customer_domains.html.markdown | 54 + .../d/api_gateway_ip_strategies.html.markdown | 83 ++ .../docs/d/api_gateway_plugins.html.markdown | 111 ++ ...way_service_environment_list.html.markdown | 39 + ...way_service_release_versions.html.markdown | 37 + .../docs/d/api_gateway_services.html.markdown | 66 ++ .../api_gateway_throttling_apis.html.markdown | 96 ++ ..._gateway_throttling_services.html.markdown | 53 + .../d/api_gateway_upstreams.html.markdown | 59 + ...eway_usage_plan_environments.html.markdown | 68 ++ .../d/api_gateway_usage_plans.html.markdown | 54 + config/docs/d/as_advices.html.markdown | 41 + config/docs/d/as_instances.html.markdown | 70 ++ config/docs/d/as_last_activity.html.markdown | 72 ++ config/docs/d/as_limits.html.markdown | 35 + .../docs/d/as_scaling_configs.html.markdown | 61 + config/docs/d/as_scaling_groups.html.markdown | 66 ++ .../docs/d/as_scaling_policies.html.markdown | 50 + config/docs/d/audit_cos_regions.html.markdown | 35 + config/docs/d/audit_key_alias.html.markdown | 37 + config/docs/d/audits.html.markdown | 40 + .../docs/d/availability_regions.html.markdown | 39 + .../docs/d/availability_zones.html.markdown | 42 + ...vailability_zones_by_product.html.markdown | 41 + config/docs/d/bi_project.html.markdown | 69 ++ config/docs/d/bi_user_project.html.markdown | 52 + .../docs/d/cam_account_summary.html.markdown | 38 + .../d/cam_group_memberships.html.markdown | 38 + ...cam_group_policy_attachments.html.markdown | 51 + .../d/cam_group_user_account.html.markdown | 42 + config/docs/d/cam_groups.html.markdown | 47 + ...cam_list_entities_for_policy.html.markdown | 43 + config/docs/d/cam_oidc_config.html.markdown | 48 + config/docs/d/cam_policies.html.markdown | 54 + ...licy_granting_service_access.html.markdown | 50 + .../cam_role_policy_attachments.html.markdown | 51 + config/docs/d/cam_roles.html.markdown | 50 + .../docs/d/cam_saml_providers.html.markdown | 40 + .../d/cam_secret_last_used_time.html.markdown | 38 + .../cam_user_policy_attachments.html.markdown | 53 + config/docs/d/cam_users.html.markdown | 61 + config/docs/d/cat_metric_data.html.markdown | 46 + config/docs/d/cat_node.html.markdown | 52 + config/docs/d/cat_probe_data.html.markdown | 65 ++ .../d/cbs_snapshot_policies.html.markdown | 45 + config/docs/d/cbs_snapshots.html.markdown | 51 + config/docs/d/cbs_storages.html.markdown | 78 ++ config/docs/d/cbs_storages_set.html.markdown | 63 ++ .../docs/d/ccn_bandwidth_limits.html.markdown | 54 + .../ccn_cross_border_compliance.html.markdown | 49 + ...cn_cross_border_flow_monitor.html.markdown | 51 + ...rder_region_bandwidth_limits.html.markdown | 65 ++ config/docs/d/ccn_instances.html.markdown | 61 + .../docs/d/ccn_tenant_instances.html.markdown | 32 + config/docs/d/cdh_instances.html.markdown | 63 ++ .../docs/d/cdn_domain_verifier.html.markdown | 54 + config/docs/d/cdn_domains.html.markdown | 86 ++ config/docs/d/cfs_access_groups.html.markdown | 41 + config/docs/d/cfs_access_rules.html.markdown | 42 + .../docs/d/cfs_available_zone.html.markdown | 47 + .../d/cfs_file_system_clients.html.markdown | 41 + config/docs/d/cfs_file_systems.html.markdown | 53 + config/docs/d/cfs_mount_targets.html.markdown | 47 + .../docs/d/cfw_edge_fw_switches.html.markdown | 42 + .../docs/d/cfw_nat_fw_switches.html.markdown | 64 ++ .../docs/d/cfw_vpc_fw_switches.html.markdown | 40 + .../docs/d/chdfs_access_groups.html.markdown | 42 + .../docs/d/chdfs_file_systems.html.markdown | 45 + .../docs/d/chdfs_mount_points.html.markdown | 43 + config/docs/d/ckafka_acls.html.markdown | 47 + .../d/ckafka_connect_resource.html.markdown | 145 +++ ...ckafka_datahub_group_offsets.html.markdown | 44 + .../docs/d/ckafka_datahub_task.html.markdown | 556 +++++++++ .../docs/d/ckafka_datahub_topic.html.markdown | 43 + config/docs/d/ckafka_group.html.markdown | 39 + config/docs/d/ckafka_group_info.html.markdown | 51 + .../docs/d/ckafka_group_offsets.html.markdown | 47 + config/docs/d/ckafka_instances.html.markdown | 80 ++ config/docs/d/ckafka_region.html.markdown | 41 + .../docs/d/ckafka_task_status.html.markdown | 37 + .../d/ckafka_topic_flow_ranking.html.markdown | 58 + ...fka_topic_produce_connection.html.markdown | 40 + ...ckafka_topic_subscribe_group.html.markdown | 51 + .../d/ckafka_topic_sync_replica.html.markdown | 46 + config/docs/d/ckafka_topics.html.markdown | 66 ++ config/docs/d/ckafka_users.html.markdown | 40 + config/docs/d/ckafka_zone.html.markdown | 71 ++ config/docs/d/clb_attachments.html.markdown | 47 + .../d/clb_cluster_resources.html.markdown | 52 + config/docs/d/clb_cross_targets.html.markdown | 51 + .../d/clb_exclusive_clusters.html.markdown | 68 ++ .../docs/d/clb_idle_instances.html.markdown | 43 + .../d/clb_instance_by_cert_id.html.markdown | 128 +++ .../docs/d/clb_instance_detail.html.markdown | 89 ++ .../docs/d/clb_instance_traffic.html.markdown | 41 + config/docs/d/clb_instances.html.markdown | 66 ++ .../docs/d/clb_listener_rules.html.markdown | 62 + config/docs/d/clb_listeners.html.markdown | 67 ++ .../d/clb_listeners_by_targets.html.markdown | 67 ++ config/docs/d/clb_redirections.html.markdown | 49 + config/docs/d/clb_resources.html.markdown | 56 + .../d/clb_target_group_list.html.markdown | 60 + config/docs/d/clb_target_groups.html.markdown | 96 ++ config/docs/d/clb_target_health.html.markdown | 52 + ...clickhouse_backup_job_detail.html.markdown | 44 + .../d/clickhouse_backup_jobs.html.markdown | 44 + .../d/clickhouse_backup_tables.html.markdown | 42 + .../d/cls_machine_group_configs.html.markdown | 86 ++ config/docs/d/cls_machines.html.markdown | 59 + config/docs/d/cls_shipper_tasks.html.markdown | 48 + .../container_cluster_instances.html.markdown | 47 + .../docs/d/container_clusters.html.markdown | 51 + config/docs/d/cos_batchs.html.markdown | 49 + .../d/cos_bucket_inventorys.html.markdown | 52 + ...cos_bucket_multipart_uploads.html.markdown | 48 + config/docs/d/cos_bucket_object.html.markdown | 44 + config/docs/d/cos_buckets.html.markdown | 67 ++ config/docs/d/css_backup_stream.html.markdown | 45 + config/docs/d/css_domains.html.markdown | 53 + .../docs/d/css_monitor_report.html.markdown | 41 + config/docs/d/css_pad_templates.html.markdown | 42 + .../css_pull_stream_task_status.html.markdown | 42 + .../d/css_stream_monitor_list.html.markdown | 64 ++ ...css_time_shift_record_detail.html.markdown | 50 + .../css_time_shift_stream_list.html.markdown | 53 + config/docs/d/css_watermarks.html.markdown | 42 + .../d/css_xp2p_detail_info_list.html.markdown | 50 + .../d/cvm_chc_denied_actions.html.markdown | 38 + config/docs/d/cvm_chc_hosts.html.markdown | 86 ++ ...disaster_recover_group_quota.html.markdown | 37 + config/docs/d/cvm_image_quota.html.markdown | 33 + .../cvm_image_share_permission.html.markdown | 37 + .../docs/d/cvm_import_image_os.html.markdown | 39 + .../docs/d/cvm_instance_vnc_url.html.markdown | 35 + .../cvm_instances_modification.html.markdown | 51 + .../docs/d/cwp_machines_simple.html.markdown | 126 +++ ...account_all_grant_privileges.html.markdown | 53 + config/docs/d/cynosdb_accounts.html.markdown | 44 + .../docs/d/cynosdb_audit_logs.html.markdown | 81 ++ .../cynosdb_binlog_download_url.html.markdown | 37 + config/docs/d/cynosdb_cluster.html.markdown | 43 + ...sdb_cluster_detail_databases.html.markdown | 52 + ...osdb_cluster_instance_groups.html.markdown | 104 ++ .../cynosdb_cluster_param_logs.html.markdown | 49 + .../d/cynosdb_cluster_params.html.markdown | 51 + config/docs/d/cynosdb_clusters.html.markdown | 55 + ...describe_instance_error_logs.html.markdown | 50 + ...scribe_instance_slow_queries.html.markdown | 44 + ...ynosdb_instance_slow_queries.html.markdown | 99 ++ config/docs/d/cynosdb_instances.html.markdown | 47 + .../d/cynosdb_param_templates.html.markdown | 59 + ...osdb_project_security_groups.html.markdown | 60 + .../docs/d/cynosdb_proxy_node.html.markdown | 62 + .../d/cynosdb_proxy_version.html.markdown | 38 + ...ynosdb_resource_package_list.html.markdown | 62 + ..._resource_package_sale_specs.html.markdown | 45 + .../cynosdb_rollback_time_range.html.markdown | 39 + config/docs/d/cynosdb_zone.html.markdown | 53 + .../docs/d/cynosdb_zone_config.html.markdown | 42 + .../d/dayu_cc_http_policies.html.markdown | 55 + .../d/dayu_cc_https_policies.html.markdown | 55 + .../docs/d/dayu_ddos_policies.html.markdown | 91 ++ ...dayu_ddos_policy_attachments.html.markdown | 48 + .../d/dayu_ddos_policy_cases.html.markdown | 61 + config/docs/d/dayu_eip.html.markdown | 38 + config/docs/d/dayu_l4_rules.html.markdown | 59 + config/docs/d/dayu_l4_rules_v2.html.markdown | 51 + config/docs/d/dayu_l7_rules.html.markdown | 62 + config/docs/d/dayu_l7_rules_v2.html.markdown | 65 ++ .../d/dbbrain_db_space_status.html.markdown | 42 + .../d/dbbrain_diag_db_instances.html.markdown | 76 ++ .../docs/d/dbbrain_diag_event.html.markdown | 55 + .../docs/d/dbbrain_diag_events.html.markdown | 51 + .../docs/d/dbbrain_diag_history.html.markdown | 51 + .../d/dbbrain_health_scores.html.markdown | 55 + .../dbbrain_mysql_process_list.html.markdown | 53 + ...bbrain_no_primary_key_tables.html.markdown | 46 + .../dbbrain_redis_top_big_keys.html.markdown | 50 + ...in_redis_top_key_prefix_list.html.markdown | 45 + ...rity_audit_log_download_urls.html.markdown | 47 + ...urity_audit_log_export_tasks.html.markdown | 57 + ...n_slow_log_time_series_stats.html.markdown | 50 + .../d/dbbrain_slow_log_top_sqls.html.markdown | 75 ++ ...ain_slow_log_user_host_stats.html.markdown | 45 + ...ain_slow_log_user_sql_advice.html.markdown | 45 + config/docs/d/dbbrain_slow_logs.html.markdown | 57 + .../docs/d/dbbrain_sql_filters.html.markdown | 61 + .../d/dbbrain_sql_templates.html.markdown | 43 + ...top_space_schema_time_series.html.markdown | 51 + .../d/dbbrain_top_space_schemas.html.markdown | 49 + ..._top_space_table_time_series.html.markdown | 53 + .../d/dbbrain_top_space_tables.html.markdown | 63 ++ config/docs/d/dc_access_points.html.markdown | 48 + .../d/dc_gateway_ccn_routes.html.markdown | 63 ++ .../docs/d/dc_gateway_instances.html.markdown | 63 ++ config/docs/d/dc_instances.html.markdown | 60 + .../d/dc_internet_address_quota.html.markdown | 36 + ..._internet_address_statistics.html.markdown | 34 + ...direct_connect_tunnel_routes.html.markdown | 47 + config/docs/d/dcdb_accounts.html.markdown | 43 + .../d/dcdb_database_objects.html.markdown | 44 + .../docs/d/dcdb_database_tables.html.markdown | 47 + config/docs/d/dcdb_databases.html.markdown | 36 + .../d/dcdb_file_download_url.html.markdown | 39 + .../d/dcdb_instance_node_info.html.markdown | 38 + config/docs/d/dcdb_instances.html.markdown | 107 ++ config/docs/d/dcdb_log_files.html.markdown | 45 + config/docs/d/dcdb_orders.html.markdown | 41 + config/docs/d/dcdb_parameters.html.markdown | 47 + config/docs/d/dcdb_price.html.markdown | 52 + ...dcdb_project_security_groups.html.markdown | 52 + config/docs/d/dcdb_projects.html.markdown | 43 + .../docs/d/dcdb_renewal_price.html.markdown | 40 + config/docs/d/dcdb_sale_info.html.markdown | 52 + .../docs/d/dcdb_security_groups.html.markdown | 49 + config/docs/d/dcdb_shard_spec.html.markdown | 42 + config/docs/d/dcdb_shards.html.markdown | 60 + config/docs/d/dcdb_slow_logs.html.markdown | 71 ++ .../docs/d/dcdb_upgrade_price.html.markdown | 95 ++ config/docs/d/dcx_instances.html.markdown | 57 + ...engine_config_pairs_validity.html.markdown | 43 + ...engine_image_can_be_rollback.html.markdown | 37 + ..._engine_image_can_be_upgrade.html.markdown | 36 + .../d/dlc_describe_data_engine.html.markdown | 107 ++ ...e_data_engine_image_versions.html.markdown | 44 + ...a_engine_python_spark_images.html.markdown | 41 + ...c_describe_engine_usage_info.html.markdown | 36 + ...cribe_updatable_data_engines.html.markdown | 44 + .../d/dlc_describe_user_info.html.markdown | 120 ++ .../d/dlc_describe_user_roles.html.markdown | 49 + .../d/dlc_describe_user_type.html.markdown | 35 + ...dlc_describe_work_group_info.html.markdown | 119 ++ config/docs/d/dnats.html.markdown | 59 + .../d/dnspod_domain_analytics.html.markdown | 63 ++ .../docs/d/dnspod_domain_list.html.markdown | 94 ++ .../d/dnspod_domain_log_list.html.markdown | 37 + .../d/dnspod_record_analytics.html.markdown | 67 ++ .../d/dnspod_record_line_list.html.markdown | 46 + .../docs/d/dnspod_record_list.html.markdown | 95 ++ .../docs/d/dnspod_record_type.html.markdown | 35 + config/docs/d/dnspod_records.html.markdown | 86 ++ config/docs/d/domains.html.markdown | 44 + config/docs/d/dts_compare_tasks.html.markdown | 60 + .../d/dts_migrate_db_instances.html.markdown | 60 + config/docs/d/dts_migrate_jobs.html.markdown | 189 ++++ config/docs/d/dts_sync_jobs.html.markdown | 191 ++++ config/docs/d/eb_bus.html.markdown | 71 ++ config/docs/d/eb_event_rules.html.markdown | 82 ++ .../eb_plateform_event_template.html.markdown | 35 + .../d/eb_platform_event_names.html.markdown | 37 + .../eb_platform_event_patterns.html.markdown | 37 + .../docs/d/eb_platform_products.html.markdown | 35 + config/docs/d/eip.html.markdown | 50 + config/docs/d/eip_address_quota.html.markdown | 35 + .../d/eip_network_account_type.html.markdown | 32 + config/docs/d/eips.html.markdown | 47 + .../d/elasticsearch_diagnose.html.markdown | 71 ++ .../elasticsearch_instance_logs.html.markdown | 51 + ...icsearch_instance_operations.html.markdown | 71 ++ ...csearch_instance_plugin_list.html.markdown | 50 + .../d/elasticsearch_instances.html.markdown | 63 ++ ...earch_logstash_instance_logs.html.markdown | 51 + ...logstash_instance_operations.html.markdown | 71 ++ .../docs/d/elasticsearch_views.html.markdown | 86 ++ config/docs/d/emr.html.markdown | 52 + config/docs/d/emr_cvm_quota.html.markdown | 51 + config/docs/d/emr_nodes.html.markdown | 113 ++ config/docs/d/enis.html.markdown | 59 + .../docs/d/gaap_access_regions.html.markdown | 41 + ...ccess_regions_by_dest_region.html.markdown | 45 + config/docs/d/gaap_black_header.html.markdown | 33 + config/docs/d/gaap_certificates.html.markdown | 51 + .../d/gaap_check_proxy_create.html.markdown | 49 + .../d/gaap_country_area_mapping.html.markdown | 40 + .../docs/d/gaap_custom_header.html.markdown | 37 + config/docs/d/gaap_dest_regions.html.markdown | 41 + ...gaap_domain_error_page_infos.html.markdown | 46 + .../d/gaap_domain_error_pages.html.markdown | 79 ++ ...p_group_and_statistics_proxy.html.markdown | 45 + config/docs/d/gaap_http_domains.html.markdown | 69 ++ config/docs/d/gaap_http_rules.html.markdown | 95 ++ .../d/gaap_layer4_listeners.html.markdown | 83 ++ .../d/gaap_layer7_listeners.html.markdown | 68 ++ .../gaap_listener_real_servers.html.markdown | 48 + .../d/gaap_listener_statistics.html.markdown | 47 + config/docs/d/gaap_proxies.html.markdown | 64 ++ .../docs/d/gaap_proxies_status.html.markdown | 47 + ...oxy_and_statistics_listeners.html.markdown | 42 + config/docs/d/gaap_proxy_detail.html.markdown | 91 ++ .../gaap_proxy_group_statistics.html.markdown | 47 + config/docs/d/gaap_proxy_groups.html.markdown | 73 ++ .../d/gaap_proxy_statistics.html.markdown | 48 + .../d/gaap_real_servers_status.html.markdown | 39 + config/docs/d/gaap_realservers.html.markdown | 50 + .../d/gaap_region_and_price.html.markdown | 48 + .../d/gaap_resources_by_tag.html.markdown | 40 + .../d/gaap_rule_real_servers.html.markdown | 48 + .../d/gaap_security_policies.html.markdown | 50 + .../docs/d/gaap_security_rules.html.markdown | 70 ++ .../d/ha_vip_eip_attachments.html.markdown | 39 + config/docs/d/ha_vips.html.markdown | 53 + config/docs/d/image.html.markdown | 52 + config/docs/d/images.html.markdown | 59 + config/docs/d/instance_types.html.markdown | 69 ++ config/docs/d/instances.html.markdown | 73 ++ config/docs/d/instances_set.html.markdown | 72 ++ config/docs/d/key_pairs.html.markdown | 46 + config/docs/d/kms_describe_keys.html.markdown | 51 + ...ms_get_parameters_for_import.html.markdown | 41 + config/docs/d/kms_keys.html.markdown | 57 + .../docs/d/kms_list_algorithms.html.markdown | 40 + config/docs/d/kms_list_keys.html.markdown | 37 + config/docs/d/kms_public_key.html.markdown | 44 + .../d/kms_white_box_decrypt_key.html.markdown | 35 + ...hite_box_device_fingerprints.html.markdown | 37 + .../d/kms_white_box_key_details.html.markdown | 47 + ...s_available_cluster_versions.html.markdown | 53 + config/docs/d/kubernetes_charts.html.markdown | 38 + ...uster_authentication_options.html.markdown | 44 + ...ernetes_cluster_common_names.html.markdown | 40 + ...kubernetes_cluster_instances.html.markdown | 96 ++ .../d/kubernetes_cluster_levels.html.markdown | 45 + ...ubernetes_cluster_node_pools.html.markdown | 113 ++ .../docs/d/kubernetes_clusters.html.markdown | 86 ++ .../docs/d/lighthouse_all_scene.html.markdown | 41 + config/docs/d/lighthouse_bundle.html.markdown | 68 ++ .../d/lighthouse_disk_config.html.markdown | 49 + config/docs/d/lighthouse_disks.html.markdown | 61 + ...ouse_firewall_rules_template.html.markdown | 39 + ...ighthouse_instance_blueprint.html.markdown | 66 ++ ...lighthouse_instance_disk_num.html.markdown | 38 + ...use_instance_traffic_package.html.markdown | 47 + .../lighthouse_instance_vnc_url.html.markdown | 35 + ...house_modify_instance_bundle.html.markdown | 85 ++ config/docs/d/lighthouse_region.html.markdown | 37 + ...use_reset_instance_blueprint.html.markdown | 68 ++ config/docs/d/lighthouse_scene.html.markdown | 41 + config/docs/d/lighthouse_zone.html.markdown | 46 + config/docs/d/mariadb_accounts.html.markdown | 43 + .../d/mariadb_database_objects.html.markdown | 44 + .../d/mariadb_database_table.html.markdown | 41 + config/docs/d/mariadb_databases.html.markdown | 36 + .../docs/d/mariadb_db_instances.html.markdown | 55 + .../docs/d/mariadb_dcn_detail.html.markdown | 62 + .../d/mariadb_file_download_url.html.markdown | 37 + config/docs/d/mariadb_flow.html.markdown | 35 + .../d/mariadb_instance_specs.html.markdown | 44 + config/docs/d/mariadb_log_files.html.markdown | 43 + config/docs/d/mariadb_orders.html.markdown | 41 + config/docs/d/mariadb_price.html.markdown | 49 + ...iadb_project_security_groups.html.markdown | 52 + .../d/mariadb_renewal_price.html.markdown | 39 + config/docs/d/mariadb_sale_info.html.markdown | 52 + .../d/mariadb_security_groups.html.markdown | 52 + config/docs/d/mariadb_slow_logs.html.markdown | 67 ++ .../d/mariadb_upgrade_price.html.markdown | 44 + .../d/mongodb_instance_backups.html.markdown | 46 + ...mongodb_instance_connections.html.markdown | 38 + .../mongodb_instance_current_op.html.markdown | 53 + .../d/mongodb_instance_params.html.markdown | 71 ++ .../d/mongodb_instance_slow_log.html.markdown | 43 + config/docs/d/mongodb_instances.html.markdown | 59 + .../docs/d/mongodb_zone_config.html.markdown | 46 + ...monitor_alarm_all_namespaces.html.markdown | 77 ++ .../monitor_alarm_basic_alarms.html.markdown | 77 ++ .../monitor_alarm_basic_metric.html.markdown | 54 + ...or_alarm_conditions_template.html.markdown | 103 ++ .../d/monitor_alarm_history.html.markdown | 100 ++ .../docs/d/monitor_alarm_metric.html.markdown | 57 + .../monitor_alarm_monitor_type.html.markdown | 37 + ...nitor_alarm_notice_callbacks.html.markdown | 40 + .../d/monitor_alarm_notices.html.markdown | 80 ++ .../docs/d/monitor_alarm_policy.html.markdown | 253 +++++ .../d/monitor_binding_objects.html.markdown | 43 + config/docs/d/monitor_data.html.markdown | 77 ++ ...tor_grafana_plugin_overviews.html.markdown | 35 + .../d/monitor_policy_conditions.html.markdown | 72 ++ .../d/monitor_policy_groups.html.markdown | 86 ++ .../d/monitor_product_event.html.markdown | 80 ++ .../d/monitor_product_namespace.html.markdown | 38 + .../docs/d/monitor_tmp_regions.html.markdown | 42 + .../docs/d/mps_media_meta_data.html.markdown | 98 ++ ..._stream_process_notification.html.markdown | 29 + .../d/mps_parse_notification.html.markdown | 29 + config/docs/d/mps_schedules.html.markdown | 468 ++++++++ config/docs/d/mps_tasks.html.markdown | 44 + config/docs/d/mysql_backup_list.html.markdown | 46 + .../d/mysql_backup_overview.html.markdown | 41 + .../d/mysql_backup_summaries.html.markdown | 49 + config/docs/d/mysql_bin_log.html.markdown | 54 + ...mysql_binlog_backup_overview.html.markdown | 42 + config/docs/d/mysql_clone_list.html.markdown | 45 + .../mysql_data_backup_overview.html.markdown | 46 + config/docs/d/mysql_databases.html.markdown | 42 + config/docs/d/mysql_db_features.html.markdown | 43 + .../docs/d/mysql_default_params.html.markdown | 44 + config/docs/d/mysql_error_log.html.markdown | 45 + config/docs/d/mysql_inst_tables.html.markdown | 39 + config/docs/d/mysql_instance.html.markdown | 79 ++ .../d/mysql_instance_charset.html.markdown | 35 + .../docs/d/mysql_instance_info.html.markdown | 39 + .../mysql_instance_param_record.html.markdown | 41 + .../mysql_instance_reboot_time.html.markdown | 37 + .../docs/d/mysql_parameter_list.html.markdown | 47 + ...mysql_project_security_group.html.markdown | 54 + .../docs/d/mysql_ro_min_scale.html.markdown | 38 + .../d/mysql_rollback_range_time.html.markdown | 43 + config/docs/d/mysql_slow_log.html.markdown | 41 + .../docs/d/mysql_slow_log_data.html.markdown | 62 + .../mysql_supported_privileges.html.markdown | 38 + .../docs/d/mysql_switch_record.html.markdown | 37 + config/docs/d/mysql_user_task.html.markdown | 55 + config/docs/d/mysql_zone_config.html.markdown | 56 + config/docs/d/nat_dc_route.html.markdown | 42 + config/docs/d/nat_gateway_snats.html.markdown | 45 + config/docs/d/nat_gateways.html.markdown | 48 + config/docs/d/nats.html.markdown | 63 ++ .../d/oceanus_check_savepoint.html.markdown | 43 + config/docs/d/oceanus_clusters.html.markdown | 132 +++ .../oceanus_job_submission_log.html.markdown | 57 + ...oceanus_resource_related_job.html.markdown | 44 + .../d/oceanus_savepoint_list.html.markdown | 51 + .../d/oceanus_system_resource.html.markdown | 55 + config/docs/d/oceanus_tree_jobs.html.markdown | 51 + .../d/oceanus_tree_resources.html.markdown | 49 + .../docs/d/oceanus_work_spaces.html.markdown | 91 ++ .../docs/d/organization_members.html.markdown | 57 + .../organization_org_auth_node.html.markdown | 39 + ...tion_org_financial_by_member.html.markdown | 45 + ...ation_org_financial_by_month.html.markdown | 42 + ...ion_org_financial_by_product.html.markdown | 45 + config/docs/d/placement_groups.html.markdown | 44 + ...tgresql_backup_download_urls.html.markdown | 69 ++ .../d/postgresql_base_backups.html.markdown | 68 ++ ...stgresql_db_instance_classes.html.markdown | 45 + ...tgresql_db_instance_versions.html.markdown | 39 + ...ostgresql_default_parameters.html.markdown | 71 ++ .../docs/d/postgresql_instances.html.markdown | 65 ++ .../d/postgresql_log_backups.html.markdown | 61 + ...stgresql_parameter_templates.html.markdown | 56 + .../postgresql_readonly_groups.html.markdown | 153 +++ .../d/postgresql_recovery_time.html.markdown | 36 + .../docs/d/postgresql_regions.html.markdown | 37 + .../docs/d/postgresql_specinfos.html.markdown | 43 + config/docs/d/postgresql_xlogs.html.markdown | 45 + config/docs/d/postgresql_zones.html.markdown | 38 + .../docs/d/private_dns_records.html.markdown | 58 + config/docs/d/projects.html.markdown | 40 + .../d/protocol_template_groups.html.markdown | 39 + .../docs/d/protocol_templates.html.markdown | 39 + .../d/pts_scenario_with_jobs.html.markdown | 282 +++++ config/docs/d/redis_backup.html.markdown | 58 + .../redis_backup_download_info.html.markdown | 59 + .../d/redis_instance_node_info.html.markdown | 44 + .../d/redis_instance_shards.html.markdown | 46 + .../d/redis_instance_task_list.html.markdown | 60 + .../d/redis_instance_zone_info.html.markdown | 45 + config/docs/d/redis_instances.html.markdown | 64 ++ .../docs/d/redis_param_records.html.markdown | 40 + config/docs/d/redis_zone_config.html.markdown | 45 + .../d/reserved_instance_configs.html.markdown | 48 + .../docs/d/reserved_instances.html.markdown | 45 + config/docs/d/route_table.html.markdown | 56 + config/docs/d/rum_custom_url.html.markdown | 60 + config/docs/d/rum_event_url.html.markdown | 59 + config/docs/d/rum_fetch_url.html.markdown | 63 ++ .../docs/d/rum_fetch_url_info.html.markdown | 60 + config/docs/d/rum_group_log.html.markdown | 45 + config/docs/d/rum_log_export.html.markdown | 44 + .../docs/d/rum_log_export_list.html.markdown | 35 + .../d/rum_log_url_statistics.html.markdown | 58 + .../d/rum_offline_log_config.html.markdown | 36 + .../docs/d/rum_performance_page.html.markdown | 61 + config/docs/d/rum_project.html.markdown | 51 + config/docs/d/rum_pv_url_info.html.markdown | 58 + .../d/rum_pv_url_statistics.html.markdown | 59 + config/docs/d/rum_report_count.html.markdown | 42 + config/docs/d/rum_scores.html.markdown | 55 + .../d/rum_set_url_statistics.html.markdown | 60 + config/docs/d/rum_sign.html.markdown | 41 + .../docs/d/rum_static_project.html.markdown | 60 + .../docs/d/rum_static_resource.html.markdown | 60 + config/docs/d/rum_static_url.html.markdown | 60 + config/docs/d/rum_taw_instance.html.markdown | 57 + .../docs/d/rum_web_vitals_page.html.markdown | 59 + config/docs/d/rum_whitelist.html.markdown | 42 + config/docs/d/scf_account_info.html.markdown | 68 ++ .../scf_async_event_management.html.markdown | 52 + .../d/scf_async_event_status.html.markdown | 38 + .../docs/d/scf_function_address.html.markdown | 40 + .../docs/d/scf_function_aliases.html.markdown | 52 + .../d/scf_function_versions.html.markdown | 44 + config/docs/d/scf_functions.html.markdown | 100 ++ .../docs/d/scf_layer_versions.html.markdown | 44 + config/docs/d/scf_layers.html.markdown | 42 + config/docs/d/scf_logs.html.markdown | 66 ++ config/docs/d/scf_namespaces.html.markdown | 45 + .../docs/d/scf_request_status.html.markdown | 49 + config/docs/d/scf_triggers.html.markdown | 59 + config/docs/d/security_group.html.markdown | 40 + config/docs/d/security_groups.html.markdown | 47 + .../d/ses_black_email_address.html.markdown | 43 + .../docs/d/ses_email_identities.html.markdown | 40 + config/docs/d/ses_receivers.html.markdown | 43 + .../d/ses_send_email_status.html.markdown | 51 + config/docs/d/ses_send_tasks.html.markdown | 61 + .../d/ses_statistics_report.html.markdown | 58 + ...erver_account_db_attachments.html.markdown | 102 ++ .../docs/d/sqlserver_accounts.html.markdown | 53 + .../sqlserver_backup_by_flow_id.html.markdown | 103 ++ .../d/sqlserver_backup_commands.html.markdown | 42 + ...sqlserver_backup_upload_size.html.markdown | 40 + config/docs/d/sqlserver_backups.html.markdown | 51 + .../d/sqlserver_basic_instances.html.markdown | 75 ++ .../sqlserver_cross_region_zone.html.markdown | 36 + ...ver_datasource_ins_attribute.html.markdown | 46 + .../d/sqlserver_db_charsets.html.markdown | 35 + config/docs/d/sqlserver_dbs.html.markdown | 91 ++ .../d/sqlserver_ins_attribute.html.markdown | 46 + ...erver_instance_param_records.html.markdown | 41 + .../docs/d/sqlserver_instances.html.markdown | 76 ++ ...rver_project_security_groups.html.markdown | 52 + ...sqlserver_publish_subscribes.html.markdown | 149 +++ .../d/sqlserver_query_xevent.html.markdown | 50 + .../d/sqlserver_readonly_groups.html.markdown | 45 + config/docs/d/sqlserver_regions.html.markdown | 36 + .../d/sqlserver_rollback_time.html.markdown | 40 + .../docs/d/sqlserver_slowlogs.html.markdown | 47 + ...sqlserver_upload_backup_info.html.markdown | 44 + ...rver_upload_incremental_info.html.markdown | 46 + .../d/sqlserver_zone_config.html.markdown | 45 + config/docs/d/ssl_certificates.html.markdown | 55 + .../d/ssl_describe_certificate.html.markdown | 118 ++ .../d/ssl_describe_companies.html.markdown | 44 + ...st_api_gateway_instance_list.html.markdown | 50 + ...cribe_host_cdn_instance_list.html.markdown | 53 + ...cribe_host_clb_instance_list.html.markdown | 70 ++ ...cribe_host_cos_instance_list.html.markdown | 52 + ...ribe_host_ddos_instance_list.html.markdown | 50 + ..._describe_host_deploy_record.html.markdown | 44 + ...be_host_deploy_record_detail.html.markdown | 59 + ...ost_lighthouse_instance_list.html.markdown | 48 + ...ribe_host_live_instance_list.html.markdown | 48 + ...cribe_host_teo_instance_list.html.markdown | 49 + ...cribe_host_tke_instance_list.html.markdown | 61 + ..._describe_host_update_record.html.markdown | 44 + ...be_host_update_record_detail.html.markdown | 63 ++ ...cribe_host_vod_instance_list.html.markdown | 47 + ...cribe_host_waf_instance_list.html.markdown | 48 + .../ssl_describe_manager_detail.html.markdown | 60 + .../d/ssl_describe_managers.html.markdown | 53 + config/docs/d/ssm_products.html.markdown | 32 + .../docs/d/ssm_rotation_detail.html.markdown | 38 + .../docs/d/ssm_rotation_history.html.markdown | 35 + .../docs/d/ssm_secret_versions.html.markdown | 55 + config/docs/d/ssm_secrets.html.markdown | 82 ++ .../docs/d/ssm_service_status.html.markdown | 34 + .../d/ssm_ssh_key_pair_value.html.markdown | 59 + .../docs/d/sts_caller_identity.html.markdown | 37 + config/docs/d/subnet.html.markdown | 60 + config/docs/d/tat_agent.html.markdown | 51 + config/docs/d/tat_command.html.markdown | 60 + .../docs/d/tat_invocation_task.html.markdown | 74 ++ config/docs/d/tat_invoker.html.markdown | 53 + .../docs/d/tat_invoker_records.html.markdown | 40 + config/docs/d/tcaplus_clusters.html.markdown | 56 + config/docs/d/tcaplus_idls.html.markdown | 36 + .../docs/d/tcaplus_tablegroups.html.markdown | 55 + config/docs/d/tcaplus_tables.html.markdown | 74 ++ config/docs/d/tcm_mesh.html.markdown | 58 + config/docs/d/tcmq_queue.html.markdown | 86 ++ config/docs/d/tcmq_subscribe.html.markdown | 51 + config/docs/d/tcmq_topic.html.markdown | 63 ++ .../docs/d/tcr_image_manifests.html.markdown | 42 + config/docs/d/tcr_images.html.markdown | 51 + config/docs/d/tcr_instances.html.markdown | 43 + config/docs/d/tcr_namespaces.html.markdown | 40 + ...cation_instance_create_tasks.html.markdown | 50 + ...ication_instance_sync_status.html.markdown | 49 + config/docs/d/tcr_repositories.html.markdown | 45 + ...ag_retention_execution_tasks.html.markdown | 47 + ...tcr_tag_retention_executions.html.markdown | 42 + config/docs/d/tcr_tokens.html.markdown | 40 + .../docs/d/tcr_vpc_attachments.html.markdown | 43 + .../d/tcr_webhook_trigger_logs.html.markdown | 51 + config/docs/d/tdcpg_clusters.html.markdown | 76 ++ config/docs/d/tdcpg_instances.html.markdown | 62 + .../tdmq_environment_attributes.html.markdown | 58 + .../d/tdmq_pro_instance_detail.html.markdown | 60 + .../docs/d/tdmq_pro_instances.html.markdown | 59 + .../d/tdmq_publisher_summary.html.markdown | 42 + config/docs/d/tdmq_publishers.html.markdown | 68 ++ .../d/tdmq_rocketmq_cluster.html.markdown | 67 ++ .../docs/d/tdmq_rocketmq_group.html.markdown | 74 ++ .../d/tdmq_rocketmq_messages.html.markdown | 52 + .../d/tdmq_rocketmq_namespace.html.markdown | 54 + .../docs/d/tdmq_rocketmq_role.html.markdown | 53 + .../docs/d/tdmq_rocketmq_topic.html.markdown | 64 ++ .../d/teo_rule_engine_settings.html.markdown | 58 + .../d/teo_zone_available_plans.html.markdown | 41 + .../docs/d/tse_access_address.html.markdown | 57 + .../d/tse_gateway_canary_rules.html.markdown | 56 + .../d/tse_gateway_certificates.html.markdown | 58 + config/docs/d/tse_gateway_nodes.html.markdown | 44 + .../docs/d/tse_gateway_routes.html.markdown | 58 + .../docs/d/tse_gateway_services.html.markdown | 79 ++ config/docs/d/tse_gateways.html.markdown | 78 ++ config/docs/d/tse_groups.html.markdown | 90 ++ .../docs/d/tse_nacos_replicas.html.markdown | 42 + .../tse_nacos_server_interfaces.html.markdown | 36 + .../d/tse_zookeeper_replicas.html.markdown | 43 + ..._zookeeper_server_interfaces.html.markdown | 36 + config/docs/d/tsf_api_detail.html.markdown | 64 ++ config/docs/d/tsf_api_group.html.markdown | 74 ++ config/docs/d/tsf_application.html.markdown | 63 ++ .../d/tsf_application_attribute.html.markdown | 38 + .../d/tsf_application_config.html.markdown | 57 + .../tsf_application_file_config.html.markdown | 61 + ...sf_application_public_config.html.markdown | 55 + .../d/tsf_business_log_configs.html.markdown | 68 ++ config/docs/d/tsf_cluster.html.markdown | 83 ++ .../docs/d/tsf_config_summary.html.markdown | 60 + .../docs/d/tsf_container_group.html.markdown | 64 ++ ..._delivery_config_by_group_id.html.markdown | 37 + .../docs/d/tsf_delivery_configs.html.markdown | 64 ++ .../tsf_gateway_all_group_apis.html.markdown | 52 + .../d/tsf_group_config_release.html.markdown | 81 ++ .../docs/d/tsf_group_gateways.html.markdown | 64 ++ .../docs/d/tsf_group_instances.html.markdown | 82 ++ config/docs/d/tsf_groups.html.markdown | 71 ++ config/docs/d/tsf_microservice.html.markdown | 51 + ...tsf_microservice_api_version.html.markdown | 42 + config/docs/d/tsf_ms_api_list.html.markdown | 43 + config/docs/d/tsf_pod_instances.html.markdown | 53 + .../d/tsf_public_config_summary.html.markdown | 59 + config/docs/d/tsf_repository.html.markdown | 48 + config/docs/d/tsf_unit_rules.html.markdown | 62 + .../tsf_usable_unit_namespaces.html.markdown | 43 + config/docs/d/user_info.html.markdown | 35 + ..._dynamic_streaming_templates.html.markdown | 104 ++ .../vod_image_sprite_templates.html.markdown | 65 ++ .../d/vod_procedure_templates.html.markdown | 95 ++ ...hot_by_time_offset_templates.html.markdown | 59 + .../d/vod_super_player_configs.html.markdown | 73 ++ config/docs/d/vpc.html.markdown | 50 + .../d/vpc_account_attributes.html.markdown | 34 + config/docs/d/vpc_acls.html.markdown | 66 ++ ...bandwidth_package_bill_usage.html.markdown | 36 + .../vpc_bandwidth_package_quota.html.markdown | 36 + .../vpc_classic_link_instances.html.markdown | 45 + config/docs/d/vpc_cvm_instances.html.markdown | 55 + ..._gateway_flow_monitor_detail.html.markdown | 49 + .../docs/d/vpc_gateway_flow_qos.html.markdown | 40 + config/docs/d/vpc_instances.html.markdown | 58 + config/docs/d/vpc_limits.html.markdown | 37 + .../vpc_net_detect_state_check.html.markdown | 51 + .../d/vpc_net_detect_states.html.markdown | 47 + .../vpc_network_interface_limit.html.markdown | 40 + .../d/vpc_private_ip_addresses.html.markdown | 41 + config/docs/d/vpc_product_quota.html.markdown | 40 + .../d/vpc_resource_dashboard.html.markdown | 77 ++ .../docs/d/vpc_route_conflicts.html.markdown | 52 + config/docs/d/vpc_route_tables.html.markdown | 84 ++ .../d/vpc_security_group_limits.html.markdown | 40 + ...pc_security_group_references.html.markdown | 37 + ...vpc_sg_snapshot_file_content.html.markdown | 73 ++ .../docs/d/vpc_snapshot_files.html.markdown | 46 + ...pc_subnet_resource_dashboard.html.markdown | 42 + config/docs/d/vpc_subnets.html.markdown | 83 ++ .../docs/d/vpc_template_limits.html.markdown | 36 + .../docs/d/vpc_used_ip_address.html.markdown | 42 + config/docs/d/vpn_connections.html.markdown | 80 ++ ...vpn_customer_gateway_vendors.html.markdown | 35 + .../d/vpn_customer_gateways.html.markdown | 48 + .../vpn_default_health_check_ip.html.markdown | 36 + .../docs/d/vpn_gateway_routes.html.markdown | 48 + config/docs/d/vpn_gateways.html.markdown | 63 ++ .../d/waf_attack_log_histogram.html.markdown | 58 + .../docs/d/waf_attack_log_list.html.markdown | 67 ++ .../docs/d/waf_attack_overview.html.markdown | 62 + .../d/waf_attack_total_count.html.markdown | 54 + config/docs/d/waf_ciphers.html.markdown | 35 + config/docs/d/waf_domains.html.markdown | 90 ++ config/docs/d/waf_find_domains.html.markdown | 57 + .../d/waf_instance_qps_limit.html.markdown | 41 + config/docs/d/waf_peak_points.html.markdown | 70 ++ config/docs/d/waf_ports.html.markdown | 44 + config/docs/d/waf_tls_versions.html.markdown | 34 + .../docs/d/waf_user_clb_regions.html.markdown | 37 + config/docs/d/waf_user_domains.html.markdown | 41 + ...wedata_data_source_info_list.html.markdown | 67 ++ .../d/wedata_data_source_list.html.markdown | 93 ++ ...ata_data_source_without_info.html.markdown | 85 ++ .../d/wedata_rule_templates.html.markdown | 59 + config/docs/r/address_template.html.markdown | 45 + .../r/address_template_group.html.markdown | 45 + .../r/alb_server_attachment.html.markdown | 63 ++ .../antiddos_cc_black_white_ip.html.markdown | 62 + ...antiddos_cc_precision_policy.html.markdown | 72 ++ ...antiddos_ddos_black_white_ip.html.markdown | 49 + ...dos_ddos_geo_ip_block_config.html.markdown | 55 + ...ddos_ddos_speed_limit_config.html.markdown | 75 ++ ...ddos_default_alarm_threshold.html.markdown | 53 + ...os_ip_alarm_threshold_config.html.markdown | 49 + ...ntiddos_packet_filter_config.html.markdown | 85 ++ .../r/antiddos_port_acl_config.html.markdown | 64 ++ ..._scheduling_domain_user_name.html.markdown | 45 + config/docs/r/api_gateway_api.html.markdown | 222 ++++ .../docs/r/api_gateway_api_app.html.markdown | 65 ++ ...i_gateway_api_app_attachment.html.markdown | 99 ++ .../docs/r/api_gateway_api_doc.html.markdown | 50 + .../docs/r/api_gateway_api_key.html.markdown | 63 ++ ...i_gateway_api_key_attachment.html.markdown | 57 + .../r/api_gateway_custom_domain.html.markdown | 49 + .../api_gateway_import_open_api.html.markdown | 144 +++ .../r/api_gateway_ip_strategy.html.markdown | 58 + .../docs/r/api_gateway_plugin.html.markdown | 52 + ...pi_gateway_plugin_attachment.html.markdown | 110 ++ .../docs/r/api_gateway_service.html.markdown | 114 ++ .../api_gateway_service_release.html.markdown | 90 ++ ..._gateway_strategy_attachment.html.markdown | 104 ++ ...i_gateway_update_api_app_key.html.markdown | 37 + .../docs/r/api_gateway_upstream.html.markdown | 211 ++++ .../r/api_gateway_usage_plan.html.markdown | 61 + ...ateway_usage_plan_attachment.html.markdown | 124 ++ config/docs/r/apm_instance.html.markdown | 53 + config/docs/r/as_attachment.html.markdown | 104 ++ .../r/as_complete_lifecycle.html.markdown | 116 ++ .../r/as_execute_scaling_policy.html.markdown | 101 ++ config/docs/r/as_lifecycle_hook.html.markdown | 119 ++ config/docs/r/as_notification.html.markdown | 85 ++ .../docs/r/as_protect_instances.html.markdown | 123 ++ .../docs/r/as_remove_instances.html.markdown | 111 ++ .../r/as_scale_in_instances.html.markdown | 85 ++ .../r/as_scale_out_instances.html.markdown | 85 ++ config/docs/r/as_scaling_config.html.markdown | 139 +++ config/docs/r/as_scaling_group.html.markdown | 171 +++ .../r/as_scaling_group_status.html.markdown | 95 ++ config/docs/r/as_scaling_policy.html.markdown | 95 ++ config/docs/r/as_schedule.html.markdown | 88 ++ .../docs/r/as_start_instances.html.markdown | 110 ++ config/docs/r/as_stop_instances.html.markdown | 112 ++ config/docs/r/audit.html.markdown | 57 + config/docs/r/audit_track.html.markdown | 69 ++ config/docs/r/bi_datasource.html.markdown | 66 ++ .../docs/r/bi_datasource_cloud.html.markdown | 72 ++ .../r/bi_embed_interval_apply.html.markdown | 41 + .../docs/r/bi_embed_token_apply.html.markdown | 47 + config/docs/r/bi_project.html.markdown | 49 + .../docs/r/bi_project_user_role.html.markdown | 57 + config/docs/r/bi_user_role.html.markdown | 55 + config/docs/r/cam_access_key.html.markdown | 66 ++ config/docs/r/cam_group.html.markdown | 45 + .../docs/r/cam_group_membership.html.markdown | 67 ++ .../cam_group_policy_attachment.html.markdown | 64 ++ config/docs/r/cam_mfa_flag.html.markdown | 69 ++ config/docs/r/cam_oidc_sso.html.markdown | 57 + config/docs/r/cam_policy.html.markdown | 64 ++ .../docs/r/cam_policy_by_name.html.markdown | 64 ++ .../docs/r/cam_policy_version.html.markdown | 91 ++ config/docs/r/cam_role.html.markdown | 122 ++ config/docs/r/cam_role_by_name.html.markdown | 93 ++ ...rmission_boundary_attachment.html.markdown | 46 + .../cam_role_policy_attachment.html.markdown | 64 ++ ...le_policy_attachment_by_name.html.markdown | 63 ++ config/docs/r/cam_role_sso.html.markdown | 51 + config/docs/r/cam_saml_provider.html.markdown | 49 + .../r/cam_service_linked_role.html.markdown | 43 + ...am_set_policy_version_config.html.markdown | 45 + .../r/cam_tag_role_attachment.html.markdown | 54 + config/docs/r/cam_user.html.markdown | 68 ++ ...rmission_boundary_attachment.html.markdown | 45 + .../cam_user_policy_attachment.html.markdown | 77 ++ .../docs/r/cam_user_saml_config.html.markdown | 47 + config/docs/r/cat_task_set.html.markdown | 93 ++ config/docs/r/cbs_disk_backup.html.markdown | 47 + ...sk_backup_rollback_operation.html.markdown | 37 + config/docs/r/cbs_snapshot.html.markdown | 50 + .../docs/r/cbs_snapshot_policy.html.markdown | 49 + ...s_snapshot_policy_attachment.html.markdown | 37 + ...bs_snapshot_share_permission.html.markdown | 45 + config/docs/r/cbs_storage.html.markdown | 67 ++ .../r/cbs_storage_attachment.html.markdown | 45 + config/docs/r/cbs_storage_set.html.markdown | 52 + .../cbs_storage_set_attachment.html.markdown | 37 + config/docs/r/ccn.html.markdown | 80 ++ config/docs/r/ccn_attachment.html.markdown | 79 ++ .../docs/r/ccn_bandwidth_limit.html.markdown | 78 ++ .../ccn_instances_accept_attach.html.markdown | 49 + .../ccn_instances_reject_attach.html.markdown | 49 + .../ccn_instances_reset_attach.html.markdown | 51 + config/docs/r/ccn_routes.html.markdown | 47 + config/docs/r/cdh_instance.html.markdown | 69 ++ config/docs/r/cdn_domain.html.markdown | 522 +++++++++ config/docs/r/cdn_url_purge.html.markdown | 58 + config/docs/r/cdn_url_push.html.markdown | 59 + config/docs/r/cdwpg_instance.html.markdown | 106 ++ config/docs/r/cfs_access_group.html.markdown | 45 + config/docs/r/cfs_access_rule.html.markdown | 43 + .../r/cfs_auto_snapshot_policy.html.markdown | 75 ++ ...o_snapshot_policy_attachment.html.markdown | 45 + config/docs/r/cfs_file_system.html.markdown | 109 ++ .../r/cfs_sign_up_cfs_service.html.markdown | 33 + config/docs/r/cfs_snapshot.html.markdown | 49 + config/docs/r/cfs_user_quota.html.markdown | 51 + .../docs/r/cfw_address_template.html.markdown | 62 + config/docs/r/cfw_block_ignore.html.markdown | 79 ++ .../r/cfw_edge_firewall_switch.html.markdown | 57 + config/docs/r/cfw_edge_policy.html.markdown | 81 ++ .../r/cfw_nat_firewall_switch.html.markdown | 67 ++ config/docs/r/cfw_nat_instance.html.markdown | 89 ++ config/docs/r/cfw_nat_policy.html.markdown | 61 + config/docs/r/cfw_sync_asset.html.markdown | 33 + config/docs/r/cfw_sync_route.html.markdown | 37 + .../r/cfw_vpc_firewall_switch.html.markdown | 67 ++ config/docs/r/cfw_vpc_instance.html.markdown | 109 ++ config/docs/r/cfw_vpc_policy.html.markdown | 63 ++ .../docs/r/chdfs_access_group.html.markdown | 49 + config/docs/r/chdfs_access_rule.html.markdown | 56 + config/docs/r/chdfs_file_system.html.markdown | 61 + .../r/chdfs_life_cycle_rule.html.markdown | 67 ++ config/docs/r/chdfs_mount_point.html.markdown | 47 + ...chdfs_mount_point_attachment.html.markdown | 48 + .../docs/r/ci_bucket_attachment.html.markdown | 43 + .../docs/r/ci_bucket_pic_style.html.markdown | 47 + config/docs/r/ci_guetzli.html.markdown | 45 + config/docs/r/ci_hot_link.html.markdown | 47 + .../ci_media_animation_template.html.markdown | 79 ++ .../r/ci_media_concat_template.html.markdown | 139 +++ ...i_media_pic_process_template.html.markdown | 56 + ...i_media_smart_cover_template.html.markdown | 61 + .../ci_media_snapshot_template.html.markdown | 85 ++ ..._speech_recognition_template.html.markdown | 71 ++ ...ia_super_resolution_template.html.markdown | 51 + ...media_transcode_pro_template.html.markdown | 131 +++ .../ci_media_transcode_template.html.markdown | 189 ++++ .../r/ci_media_tts_template.html.markdown | 55 + ...media_video_montage_template.html.markdown | 124 ++ ...media_video_process_template.html.markdown | 71 ++ ...edia_voice_separate_template.html.markdown | 61 + .../ci_media_watermark_template.html.markdown | 99 ++ ...ci_original_image_protection.html.markdown | 45 + config/docs/r/ciam_user_group.html.markdown | 53 + config/docs/r/ciam_user_store.html.markdown | 47 + config/docs/r/ckafka_acl.html.markdown | 57 + config/docs/r/ckafka_acl_rule.html.markdown | 68 ++ .../r/ckafka_connect_resource.html.markdown | 174 +++ .../r/ckafka_consumer_group.html.markdown | 47 + ...consumer_group_modify_offset.html.markdown | 49 + .../docs/r/ckafka_datahub_task.html.markdown | 681 +++++++++++ .../docs/r/ckafka_datahub_topic.html.markdown | 55 + config/docs/r/ckafka_instance.html.markdown | 201 ++++ .../r/ckafka_renew_instance.html.markdown | 37 + config/docs/r/ckafka_route.html.markdown | 57 + config/docs/r/ckafka_topic.html.markdown | 72 ++ config/docs/r/ckafka_user.html.markdown | 50 + config/docs/r/clb_attachment.html.markdown | 61 + .../r/clb_customized_config.html.markdown | 51 + ..._function_targets_attachment.html.markdown | 74 ++ config/docs/r/clb_instance.html.markdown | 280 +++++ ...nstance_mix_ip_target_config.html.markdown | 45 + .../r/clb_instance_sla_config.html.markdown | 45 + config/docs/r/clb_listener.html.markdown | 220 ++++ config/docs/r/clb_listener_rule.html.markdown | 82 ++ config/docs/r/clb_log_set.html.markdown | 45 + config/docs/r/clb_log_topic.html.markdown | 45 + config/docs/r/clb_redirection.html.markdown | 66 ++ .../r/clb_replace_cert_for_lbs.html.markdown | 99 ++ ...lb_security_group_attachment.html.markdown | 45 + config/docs/r/clb_snat_ip.html.markdown | 64 ++ config/docs/r/clb_target_group.html.markdown | 54 + .../clb_target_group_attachment.html.markdown | 76 ++ ...et_group_instance_attachment.html.markdown | 112 ++ .../docs/r/clickhouse_account.html.markdown | 49 + ...lickhouse_account_permission.html.markdown | 74 ++ config/docs/r/clickhouse_backup.html.markdown | 45 + .../clickhouse_backup_strategy.html.markdown | 90 ++ ...lickhouse_delete_backup_data.html.markdown | 37 + .../docs/r/clickhouse_instance.html.markdown | 112 ++ ...lickhouse_recover_backup_job.html.markdown | 37 + config/docs/r/cls_alarm.html.markdown | 121 ++ config/docs/r/cls_alarm_notice.html.markdown | 83 ++ .../docs/r/cls_ckafka_consumer.html.markdown | 87 ++ config/docs/r/cls_config.html.markdown | 110 ++ .../r/cls_config_attachment.html.markdown | 42 + config/docs/r/cls_config_extra.html.markdown | 178 +++ config/docs/r/cls_cos_recharge.html.markdown | 104 ++ config/docs/r/cls_cos_shipper.html.markdown | 105 ++ .../docs/r/cls_data_transform.html.markdown | 100 ++ config/docs/r/cls_export.html.markdown | 55 + config/docs/r/cls_index.html.markdown | 128 +++ .../docs/r/cls_kafka_recharge.html.markdown | 107 ++ config/docs/r/cls_logset.html.markdown | 48 + config/docs/r/cls_machine_group.html.markdown | 68 ++ config/docs/r/cls_scheduled_sql.html.markdown | 98 ++ config/docs/r/cls_topic.html.markdown | 59 + config/docs/r/container_cluster.html.markdown | 94 ++ .../container_cluster_instance.html.markdown | 80 ++ config/docs/r/cos_batch.html.markdown | 166 +++ config/docs/r/cos_bucket.html.markdown | 343 ++++++ ...omain_certificate_attachment.html.markdown | 61 + ...entory_immediately_operation.html.markdown | 37 + .../docs/r/cos_bucket_inventory.html.markdown | 101 ++ config/docs/r/cos_bucket_object.html.markdown | 65 ++ config/docs/r/cos_bucket_policy.html.markdown | 67 ++ .../docs/r/cos_bucket_referer.html.markdown | 51 + .../docs/r/cos_bucket_version.html.markdown | 45 + ...t_multipart_upload_operation.html.markdown | 39 + .../r/cos_object_copy_operation.html.markdown | 39 + ...os_object_download_operation.html.markdown | 39 + ...cos_object_restore_operation.html.markdown | 48 + ...icate_domain_owner_operation.html.markdown | 48 + config/docs/r/css_backup_stream.html.markdown | 51 + ...css_callback_rule_attachment.html.markdown | 47 + .../r/css_callback_template.html.markdown | 59 + config/docs/r/css_domain.html.markdown | 54 + config/docs/r/css_domain_config.html.markdown | 43 + .../docs/r/css_domain_referer.html.markdown | 51 + ...css_enable_optimal_switching.html.markdown | 49 + ...ve_transcode_rule_attachment.html.markdown | 71 ++ .../css_live_transcode_template.html.markdown | 84 ++ .../r/css_pad_rule_attachment.html.markdown | 49 + config/docs/r/css_pad_template.html.markdown | 53 + .../r/css_play_auth_key_config.html.markdown | 51 + ..._play_domain_cert_attachment.html.markdown | 61 + .../docs/r/css_pull_stream_task.html.markdown | 84 ++ ...css_pull_stream_task_restart.html.markdown | 37 + .../r/css_push_auth_key_config.html.markdown | 51 + .../css_record_rule_attachment.html.markdown | 49 + ...css_snapshot_rule_attachment.html.markdown | 49 + .../r/css_snapshot_template.html.markdown | 61 + .../r/css_start_stream_monitor.html.markdown | 45 + .../docs/r/css_stream_monitor.html.markdown | 105 ++ ...ss_timeshift_rule_attachment.html.markdown | 49 + .../r/css_timeshift_template.html.markdown | 55 + config/docs/r/css_watermark.html.markdown | 52 + ...ss_watermark_rule_attachment.html.markdown | 73 ++ .../docs/r/cvm_chc_assist_vpc.html.markdown | 69 ++ config/docs/r/cvm_chc_attribute.html.markdown | 41 + config/docs/r/cvm_chc_config.html.markdown | 82 ++ .../docs/r/cvm_chc_deploy_vpc.html.markdown | 58 + config/docs/r/cvm_export_images.html.markdown | 43 + config/docs/r/cvm_hpc_cluster.html.markdown | 47 + .../cvm_image_share_permission.html.markdown | 45 + .../docs/r/cvm_launch_template.html.markdown | 180 +++ ...nch_template_default_version.html.markdown | 45 + .../cvm_launch_template_version.html.markdown | 187 +++ .../docs/r/cvm_reboot_instance.html.markdown | 38 + .../docs/r/cvm_renew_instance.html.markdown | 54 + ...vm_security_group_attachment.html.markdown | 45 + config/docs/r/cvm_sync_image.html.markdown | 40 + .../cwp_license_bind_attachment.html.markdown | 78 ++ config/docs/r/cwp_license_order.html.markdown | 56 + config/docs/r/cynosdb_account.html.markdown | 53 + .../cynosdb_account_privileges.html.markdown | 88 ++ .../r/cynosdb_audit_log_file.html.markdown | 65 ++ .../r/cynosdb_binlog_save_days.html.markdown | 45 + config/docs/r/cynosdb_cluster.html.markdown | 143 +++ .../r/cynosdb_cluster_databases.html.markdown | 63 ++ ..._cluster_password_complexity.html.markdown | 58 + ...resource_packages_attachment.html.markdown | 45 + .../cynosdb_cluster_slave_zone.html.markdown | 142 +++ ...b_export_instance_error_logs.html.markdown | 52 + ...export_instance_slow_queries.html.markdown | 47 + .../r/cynosdb_instance_param.html.markdown | 50 + .../r/cynosdb_isolate_instance.html.markdown | 42 + .../r/cynosdb_param_template.html.markdown | 53 + config/docs/r/cynosdb_proxy.html.markdown | 65 ++ .../r/cynosdb_proxy_end_point.html.markdown | 185 +++ ...ly_instance_exclusive_access.html.markdown | 66 ++ .../r/cynosdb_readonly_instance.html.markdown | 69 ++ .../r/cynosdb_reload_proxy_node.html.markdown | 45 + .../r/cynosdb_restart_instance.html.markdown | 35 + .../r/cynosdb_roll_back_cluster.html.markdown | 74 ++ .../r/cynosdb_security_group.html.markdown | 50 + ...ynosdb_upgrade_proxy_version.html.markdown | 37 + config/docs/r/cynosdb_wan.html.markdown | 48 + config/docs/r/dasb_acl.html.markdown | 95 ++ ...bind_device_account_password.html.markdown | 37 + ...d_device_account_private_key.html.markdown | 39 + .../r/dasb_bind_device_resource.html.markdown | 37 + config/docs/r/dasb_cmd_template.html.markdown | 45 + config/docs/r/dasb_device.html.markdown | 52 + .../docs/r/dasb_device_account.html.markdown | 45 + config/docs/r/dasb_device_group.html.markdown | 45 + .../r/dasb_device_group_members.html.markdown | 45 + config/docs/r/dasb_reset_user.html.markdown | 35 + config/docs/r/dasb_resource.html.markdown | 63 ++ config/docs/r/dasb_user.html.markdown | 59 + config/docs/r/dasb_user_group.html.markdown | 53 + .../r/dasb_user_group_members.html.markdown | 45 + .../docs/r/dayu_cc_http_policy.html.markdown | 105 ++ .../docs/r/dayu_cc_https_policy.html.markdown | 64 ++ config/docs/r/dayu_cc_policy_v2.html.markdown | 141 +++ .../dayu_ddos_ip_attachment_v2.html.markdown | 49 + config/docs/r/dayu_ddos_policy.html.markdown | 160 +++ .../dayu_ddos_policy_attachment.html.markdown | 39 + .../r/dayu_ddos_policy_case.html.markdown | 80 ++ .../docs/r/dayu_ddos_policy_v2.html.markdown | 211 ++++ config/docs/r/dayu_eip.html.markdown | 51 + config/docs/r/dayu_l4_rule.html.markdown | 79 ++ config/docs/r/dayu_l7_rule.html.markdown | 68 ++ config/docs/r/dayu_l7_rule_v2.html.markdown | 72 ++ .../dbbrain_db_diag_report_task.html.markdown | 45 + ...y_diag_db_instance_operation.html.markdown | 61 + ...curity_audit_log_export_task.html.markdown | 43 + .../docs/r/dbbrain_sql_filter.html.markdown | 70 ++ .../r/dbbrain_tdsql_audit_log.html.markdown | 57 + config/docs/r/dc_gateway.html.markdown | 56 + .../r/dc_gateway_attachment.html.markdown | 47 + .../docs/r/dc_gateway_ccn_route.html.markdown | 55 + config/docs/r/dc_instance.html.markdown | 66 ++ .../docs/r/dc_internet_address.html.markdown | 47 + .../dc_internet_address_config.html.markdown | 51 + .../docs/r/dc_share_dcx_config.html.markdown | 45 + config/docs/r/dcdb_account.html.markdown | 54 + .../r/dcdb_account_privileges.html.markdown | 93 ++ ...vate_hour_instance_operation.html.markdown | 35 + ...cdb_cancel_dcn_job_operation.html.markdown | 76 ++ config/docs/r/dcdb_db_instance.html.markdown | 102 ++ .../docs/r/dcdb_db_parameters.html.markdown | 53 + .../r/dcdb_db_sync_mode_config.html.markdown | 45 + ...db_encrypt_attributes_config.html.markdown | 112 ++ .../dcdb_flush_binlog_operation.html.markdown | 35 + .../docs/r/dcdb_hourdb_instance.html.markdown | 77 ++ .../docs/r/dcdb_instance_config.html.markdown | 45 + ...late_hour_instance_operation.html.markdown | 35 + ...db_security_group_attachment.html.markdown | 44 + ...tch_db_instance_ha_operation.html.markdown | 37 + config/docs/r/dcx.html.markdown | 85 ++ config/docs/r/dcx_extra_config.html.markdown | 106 ++ ...ers_to_work_group_attachment.html.markdown | 52 + ...rk_groups_to_user_attachment.html.markdown | 51 + config/docs/r/dlc_data_engine.html.markdown | 105 ++ ...engine_description_operation.html.markdown | 45 + ...lc_modify_user_typ_operation.html.markdown | 45 + ..._renew_data_engine_operation.html.markdown | 51 + ...estart_data_engine_operation.html.markdown | 37 + ..._data_engine_image_operation.html.markdown | 50 + .../r/dlc_store_location_config.html.markdown | 45 + ...c_suspend_resume_data_engine.html.markdown | 45 + ..._data_engine_image_operation.html.markdown | 37 + ...data_engine_config_operation.html.markdown | 37 + ..._update_row_filter_operation.html.markdown | 69 ++ ..._data_engine_image_operation.html.markdown | 35 + config/docs/r/dlc_user.html.markdown | 49 + .../dlc_user_data_engine_config.html.markdown | 67 ++ config/docs/r/dlc_work_group.html.markdown | 45 + config/docs/r/dnat.html.markdown | 122 ++ .../docs/r/dnspod_custom_line.html.markdown | 49 + .../docs/r/dnspod_domain_alias.html.markdown | 45 + .../r/dnspod_domain_instance.html.markdown | 48 + .../docs/r/dnspod_domain_lock.html.markdown | 37 + ..._download_snapshot_operation.html.markdown | 37 + ...odify_domain_owner_operation.html.markdown | 39 + ...odify_record_group_operation.html.markdown | 41 + config/docs/r/dnspod_record.html.markdown | 58 + .../docs/r/dnspod_record_group.html.markdown | 45 + .../r/dnspod_snapshot_config.html.markdown | 45 + config/docs/r/dts_compare_task.html.markdown | 80 ++ ..._compare_task_stop_operation.html.markdown | 37 + config/docs/r/dts_migrate_job.html.markdown | 284 +++++ .../r/dts_migrate_job_config.html.markdown | 145 +++ ...migrate_job_resume_operation.html.markdown | 37 + ..._migrate_job_start_operation.html.markdown | 35 + .../docs/r/dts_migrate_service.html.markdown | 62 + ...dts_sync_check_job_operation.html.markdown | 35 + config/docs/r/dts_sync_config.html.markdown | 355 ++++++ config/docs/r/dts_sync_job.html.markdown | 60 + ..._sync_job_continue_operation.html.markdown | 35 + ...s_sync_job_isolate_operation.html.markdown | 35 + ...dts_sync_job_pause_operation.html.markdown | 35 + ...s_sync_job_recover_operation.html.markdown | 35 + ...ts_sync_job_resize_operation.html.markdown | 37 + ...ts_sync_job_resume_operation.html.markdown | 35 + ...dts_sync_job_start_operation.html.markdown | 35 + .../dts_sync_job_stop_operation.html.markdown | 35 + config/docs/r/eb_event_bus.html.markdown | 53 + .../docs/r/eb_event_connector.html.markdown | 166 +++ config/docs/r/eb_event_rule.html.markdown | 72 ++ config/docs/r/eb_event_target.html.markdown | 166 +++ .../docs/r/eb_event_transform.html.markdown | 154 +++ config/docs/r/eb_put_events.html.markdown | 70 ++ config/docs/r/eip.html.markdown | 90 ++ .../r/eip_address_transform.html.markdown | 43 + config/docs/r/eip_association.html.markdown | 143 +++ .../r/eip_normal_address_return.html.markdown | 35 + .../r/eip_public_address_adjust.html.markdown | 37 + .../r/elasticsearch_diagnose.html.markdown | 49 + ...sticsearch_diagnose_instance.html.markdown | 39 + .../docs/r/elasticsearch_index.html.markdown | 49 + .../r/elasticsearch_instance.html.markdown | 219 ++++ .../r/elasticsearch_logstash.html.markdown | 93 ++ ...sticsearch_logstash_pipeline.html.markdown | 79 ++ ...h_restart_instance_operation.html.markdown | 40 + ...rch_restart_kibana_operation.html.markdown | 35 + ..._logstash_instance_operation.html.markdown | 37 + ...arch_restart_nodes_operation.html.markdown | 40 + ...elasticsearch_security_group.html.markdown | 48 + ..._logstash_pipeline_operation.html.markdown | 37 + ..._logstash_pipeline_operation.html.markdown | 37 + ...rch_update_plugins_operation.html.markdown | 43 + config/docs/r/emr_cluster.html.markdown | 157 +++ config/docs/r/emr_user_manager.html.markdown | 56 + config/docs/r/eni.html.markdown | 108 ++ config/docs/r/eni_attachment.html.markdown | 96 ++ config/docs/r/eni_sg_attachment.html.markdown | 95 ++ config/docs/r/gaap_certificate.html.markdown | 52 + .../r/gaap_domain_error_page.html.markdown | 64 ++ .../docs/r/gaap_global_domain.html.markdown | 51 + .../r/gaap_global_domain_dns.html.markdown | 47 + config/docs/r/gaap_http_domain.html.markdown | 73 ++ config/docs/r/gaap_http_rule.html.markdown | 113 ++ .../docs/r/gaap_layer4_listener.html.markdown | 96 ++ .../docs/r/gaap_layer7_listener.html.markdown | 63 ++ config/docs/r/gaap_proxy.html.markdown | 65 ++ config/docs/r/gaap_realserver.html.markdown | 52 + .../docs/r/gaap_security_policy.html.markdown | 54 + .../docs/r/gaap_security_rule.html.markdown | 64 ++ config/docs/r/ha_vip.html.markdown | 53 + .../r/ha_vip_eip_attachment.html.markdown | 45 + config/docs/r/image.html.markdown | 53 + config/docs/r/instance.html.markdown | 181 +++ config/docs/r/instance_set.html.markdown | 121 ++ .../r/ipv6_address_bandwidth.html.markdown | 41 + config/docs/r/key_pair.html.markdown | 51 + ...ms_cloud_resource_attachment.html.markdown | 51 + config/docs/r/kms_external_key.html.markdown | 90 ++ config/docs/r/kms_key.html.markdown | 85 ++ ...hite_box_device_fingerprints.html.markdown | 41 + config/docs/r/kms_white_box_key.html.markdown | 53 + .../kubernetes_addon_attachment.html.markdown | 158 +++ .../kubernetes_auth_attachment.html.markdown | 198 ++++ ...etes_backup_storage_location.html.markdown | 51 + .../docs/r/kubernetes_cluster.html.markdown | 1006 +++++++++++++++++ ...ubernetes_cluster_attachment.html.markdown | 168 +++ .../kubernetes_cluster_endpoint.html.markdown | 69 ++ ...rnetes_encryption_protection.html.markdown | 81 ++ .../docs/r/kubernetes_node_pool.html.markdown | 269 +++++ .../r/kubernetes_scale_worker.html.markdown | 200 ++++ ...ernetes_serverless_node_pool.html.markdown | 151 +++ config/docs/r/lb.html.markdown | 44 + ...lighthouse_apply_disk_backup.html.markdown | 37 + ...ouse_apply_instance_snapshot.html.markdown | 37 + .../docs/r/lighthouse_blueprint.html.markdown | 47 + config/docs/r/lighthouse_disk.html.markdown | 64 ++ .../lighthouse_disk_attachment.html.markdown | 45 + .../r/lighthouse_disk_backup.html.markdown | 45 + .../r/lighthouse_firewall_rule.html.markdown | 68 ++ ...lighthouse_firewall_template.html.markdown | 66 ++ .../docs/r/lighthouse_instance.html.markdown | 146 +++ .../docs/r/lighthouse_key_pair.html.markdown | 45 + ...ghthouse_key_pair_attachment.html.markdown | 45 + .../lighthouse_reboot_instance.html.markdown | 35 + .../r/lighthouse_renew_disk.html.markdown | 50 + .../r/lighthouse_renew_instance.html.markdown | 56 + .../docs/r/lighthouse_snapshot.html.markdown | 37 + .../r/lighthouse_start_instance.html.markdown | 35 + .../r/lighthouse_stop_instance.html.markdown | 35 + config/docs/r/mariadb_account.html.markdown | 52 + .../mariadb_account_privileges.html.markdown | 97 ++ ...db_activate_hour_db_instance.html.markdown | 35 + .../docs/r/mariadb_backup_time.html.markdown | 47 + .../r/mariadb_cancel_dcn_job.html.markdown | 35 + .../r/mariadb_clone_account.html.markdown | 45 + ...adb_close_db_extranet_access.html.markdown | 36 + ...iadb_copy_account_privileges.html.markdown | 45 + .../mariadb_create_tmp_instance.html.markdown | 37 + ...dedicatedcluster_db_instance.html.markdown | 59 + .../docs/r/mariadb_flush_binlog.html.markdown | 35 + ...adb_grant_account_privileges.html.markdown | 46 + .../r/mariadb_hour_db_instance.html.markdown | 66 ++ config/docs/r/mariadb_instance.html.markdown | 134 +++ .../r/mariadb_instance_config.html.markdown | 50 + ...db_log_file_retention_period.html.markdown | 44 + ...adb_operate_hour_db_instance.html.markdown | 37 + .../docs/r/mariadb_parameters.html.markdown | 309 +++++ .../r/mariadb_renew_instance.html.markdown | 37 + .../r/mariadb_restart_instance.html.markdown | 36 + .../r/mariadb_security_groups.html.markdown | 48 + config/docs/r/mariadb_switch_ha.html.markdown | 37 + .../r/mdl_stream_live_input.html.markdown | 62 + config/docs/r/mongodb_instance.html.markdown | 79 ++ .../r/mongodb_instance_account.html.markdown | 53 + .../r/mongodb_instance_backup.html.markdown | 39 + .../r/mongodb_sharding_instance.html.markdown | 85 ++ .../r/mongodb_standby_instance.html.markdown | 96 ++ .../docs/r/monitor_alarm_notice.html.markdown | 132 +++ .../docs/r/monitor_alarm_policy.html.markdown | 337 ++++++ ...tor_alarm_policy_set_default.html.markdown | 37 + .../r/monitor_binding_object.html.markdown | 64 ++ .../r/monitor_binding_receiver.html.markdown | 73 ++ .../monitor_grafana_dns_config.html.markdown | 45 + .../monitor_grafana_env_config.html.markdown | 48 + .../r/monitor_grafana_instance.html.markdown | 78 ++ .../monitor_grafana_integration.html.markdown | 70 ++ ...grafana_notification_channel.html.markdown | 100 ++ .../r/monitor_grafana_plugin.html.markdown | 74 ++ .../monitor_grafana_sso_account.html.markdown | 84 ++ ...nitor_grafana_sso_cam_config.html.markdown | 45 + .../monitor_grafana_sso_config.html.markdown | 45 + ...itor_grafana_version_upgrade.html.markdown | 45 + ...tor_grafana_whitelist_config.html.markdown | 45 + ...onitor_policy_binding_object.html.markdown | 92 ++ .../r/monitor_tmp_alert_rule.html.markdown | 112 ++ .../r/monitor_tmp_cvm_agent.html.markdown | 71 ++ ...tor_tmp_exporter_integration.html.markdown | 80 ++ .../monitor_tmp_grafana_config.html.markdown | 82 ++ .../docs/r/monitor_tmp_instance.html.markdown | 73 ++ ...mp_manage_grafana_attachment.html.markdown | 85 ++ .../monitor_tmp_recording_rule.html.markdown | 82 ++ .../r/monitor_tmp_scrape_job.html.markdown | 83 ++ ...monitor_tmp_tke_alert_policy.html.markdown | 269 +++++ ...monitor_tmp_tke_basic_config.html.markdown | 202 ++++ ...onitor_tmp_tke_cluster_agent.html.markdown | 221 ++++ .../r/monitor_tmp_tke_config.html.markdown | 231 ++++ ..._tmp_tke_global_notification.html.markdown | 238 ++++ ...tor_tmp_tke_record_rule_yaml.html.markdown | 212 ++++ .../r/monitor_tmp_tke_template.html.markdown | 148 +++ ..._tmp_tke_template_attachment.html.markdown | 293 +++++ ...e_dynamic_streaming_template.html.markdown | 125 ++ .../r/mps_ai_analysis_template.html.markdown | 80 ++ .../mps_ai_recognition_template.html.markdown | 105 ++ ...s_animated_graphics_template.html.markdown | 56 + .../mps_content_review_template.html.markdown | 247 ++++ .../r/mps_edit_media_operation.html.markdown | 144 +++ .../mps_enable_schedule_config.html.markdown | 190 ++++ .../mps_enable_workflow_config.html.markdown | 145 +++ config/docs/r/mps_event.html.markdown | 45 + ...s_execute_function_operation.html.markdown | 37 + config/docs/r/mps_flow.html.markdown | 211 ++++ .../r/mps_image_sprite_template.html.markdown | 62 + config/docs/r/mps_input.html.markdown | 126 +++ .../r/mps_manage_task_operation.html.markdown | 37 + config/docs/r/mps_output.html.markdown | 110 ++ config/docs/r/mps_person_sample.html.markdown | 53 + ...rocess_live_stream_operation.html.markdown | 123 ++ .../mps_process_media_operation.html.markdown | 406 +++++++ ...mps_sample_snapshot_template.html.markdown | 58 + config/docs/r/mps_schedule.html.markdown | 539 +++++++++ ...pshot_by_timeoffset_template.html.markdown | 54 + .../r/mps_start_flow_operation.html.markdown | 48 + .../r/mps_transcode_template.html.markdown | 171 +++ .../r/mps_watermark_template.html.markdown | 81 ++ ...ithdraws_watermark_operation.html.markdown | 102 ++ config/docs/r/mps_word_sample.html.markdown | 47 + config/docs/r/mps_workflow.html.markdown | 408 +++++++ config/docs/r/mysql_account.html.markdown | 100 ++ .../r/mysql_account_privilege.html.markdown | 100 ++ .../docs/r/mysql_audit_log_file.html.markdown | 124 ++ ..._backup_download_restriction.html.markdown | 59 + ...sql_backup_encryption_status.html.markdown | 104 ++ .../docs/r/mysql_backup_policy.html.markdown | 97 ++ config/docs/r/mysql_database.html.markdown | 47 + .../docs/r/mysql_deploy_group.html.markdown | 49 + .../mysql_dr_instance_to_mater.html.markdown | 91 ++ config/docs/r/mysql_instance.html.markdown | 191 ++++ ...nstance_encryption_operation.html.markdown | 87 ++ .../r/mysql_isolate_instance.html.markdown | 85 ++ .../r/mysql_local_binlog_config.html.markdown | 95 ++ .../docs/r/mysql_param_template.html.markdown | 118 ++ .../r/mysql_password_complexity.html.markdown | 105 ++ config/docs/r/mysql_privilege.html.markdown | 144 +++ config/docs/r/mysql_proxy.html.markdown | 117 ++ .../r/mysql_readonly_instance.html.markdown | 127 +++ ...ql_reload_balance_proxy_node.html.markdown | 104 ++ .../mysql_remote_backup_config.html.markdown | 99 ++ ..._renew_db_instance_operation.html.markdown | 93 ++ .../r/mysql_reset_root_account.html.markdown | 84 ++ ...start_db_instances_operation.html.markdown | 91 ++ config/docs/r/mysql_ro_group.html.markdown | 67 ++ ...ysql_ro_group_load_operation.html.markdown | 104 ++ .../docs/r/mysql_ro_instance_ip.html.markdown | 57 + .../mysql_ro_start_replication.html.markdown | 102 ++ .../r/mysql_ro_stop_replication.html.markdown | 102 ++ config/docs/r/mysql_rollback.html.markdown | 120 ++ .../docs/r/mysql_rollback_stop.html.markdown | 37 + ...l_security_groups_attachment.html.markdown | 93 ++ .../r/mysql_switch_for_upgrade.html.markdown | 83 ++ ...witch_master_slave_operation.html.markdown | 90 ++ config/docs/r/mysql_time_window.html.markdown | 106 ++ .../r/mysql_verify_root_account.html.markdown | 86 ++ config/docs/r/nat_gateway.html.markdown | 113 ++ config/docs/r/nat_gateway_snat.html.markdown | 162 +++ .../r/nat_refresh_nat_dc_route.html.markdown | 79 ++ config/docs/r/oceanus_job.html.markdown | 51 + .../docs/r/oceanus_job_config.html.markdown | 177 +++ config/docs/r/oceanus_job_copy.html.markdown | 47 + config/docs/r/oceanus_resource.html.markdown | 67 ++ .../r/oceanus_resource_config.html.markdown | 78 ++ config/docs/r/oceanus_run_job.html.markdown | 54 + config/docs/r/oceanus_stop_job.html.markdown | 45 + ...ceanus_trigger_job_savepoint.html.markdown | 39 + .../docs/r/oceanus_work_space.html.markdown | 54 + .../r/organization_instance.html.markdown | 59 + .../r/organization_org_identity.html.markdown | 58 + .../r/organization_org_member.html.markdown | 66 ++ ...ber_auth_identity_attachment.html.markdown | 45 + ...rganization_org_member_email.html.markdown | 54 + ...org_member_policy_attachment.html.markdown | 48 + .../r/organization_org_node.html.markdown | 47 + ...olicy_sub_account_attachment.html.markdown | 52 + ..._quit_organization_operation.html.markdown | 43 + config/docs/r/placement_group.html.markdown | 47 + ..._download_restriction_config.html.markdown | 74 ++ ...ostgresql_backup_plan_config.html.markdown | 51 + .../r/postgresql_base_backup.html.markdown | 40 + ..._clone_db_instance_operation.html.markdown | 87 ++ ..._delete_log_backup_operation.html.markdown | 37 + ...solate_db_instance_operation.html.markdown | 40 + .../docs/r/postgresql_instance.html.markdown | 246 ++++ ...ce_network_access_attachment.html.markdown | 71 ++ ...solate_db_instance_operation.html.markdown | 35 + ...ify_account_remark_operation.html.markdown | 39 + ...stance_charge_type_operation.html.markdown | 43 + ...switch_time_period_operation.html.markdown | 37 + ...ostgresql_parameter_template.html.markdown | 69 ++ ...stgresql_readonly_attachment.html.markdown | 37 + .../r/postgresql_readonly_group.html.markdown | 55 + ...up_network_access_attachment.html.markdown | 104 ++ ...postgresql_readonly_instance.html.markdown | 89 ++ ...nce_readonly_group_operation.html.markdown | 48 + ..._renew_db_instance_operation.html.markdown | 40 + ...estart_db_instance_operation.html.markdown | 35 + ...gresql_security_group_config.html.markdown | 62 + .../docs/r/private_dns_record.html.markdown | 55 + config/docs/r/private_dns_zone.html.markdown | 115 ++ ...vate_dns_zone_vpc_attachment.html.markdown | 96 ++ config/docs/r/project.html.markdown | 49 + config/docs/r/protocol_template.html.markdown | 45 + .../r/protocol_template_group.html.markdown | 45 + config/docs/r/pts_alert_channel.html.markdown | 92 ++ config/docs/r/pts_cron_job.html.markdown | 67 ++ .../docs/r/pts_cron_job_abort.html.markdown | 37 + .../docs/r/pts_cron_job_restart.html.markdown | 37 + config/docs/r/pts_file.html.markdown | 77 ++ config/docs/r/pts_job.html.markdown | 76 ++ config/docs/r/pts_job_abort.html.markdown | 40 + config/docs/r/pts_project.html.markdown | 59 + config/docs/r/pts_scenario.html.markdown | 280 +++++ .../docs/r/pts_tmp_key_generate.html.markdown | 42 + config/docs/r/redis_account.html.markdown | 126 +++ .../docs/r/redis_backup_config.html.markdown | 78 ++ ..._backup_download_restriction.html.markdown | 61 + .../r/redis_backup_operation.html.markdown | 43 + ...dis_clear_instance_operation.html.markdown | 72 ++ .../r/redis_connection_config.html.markdown | 81 ++ config/docs/r/redis_instance.html.markdown | 287 +++++ .../r/redis_maintenance_window.html.markdown | 76 ++ config/docs/r/redis_param.html.markdown | 64 ++ .../docs/r/redis_param_template.html.markdown | 86 ++ config/docs/r/redis_read_only.html.markdown | 97 ++ ...dis_renew_instance_operation.html.markdown | 90 ++ .../r/redis_replica_readonly.html.markdown | 89 ++ .../redis_replicate_attachment.html.markdown | 112 ++ ...is_security_group_attachment.html.markdown | 111 ++ config/docs/r/redis_ssl.html.markdown | 96 ++ ...s_startup_instance_operation.html.markdown | 37 + .../docs/r/redis_switch_master.html.markdown | 97 ++ .../docs/r/redis_switck_master.html.markdown | 37 + ...rade_cache_version_operation.html.markdown | 41 + ...upgrade_multi_zone_operation.html.markdown | 37 + ...rade_proxy_version_operation.html.markdown | 41 + config/docs/r/reserved_instance.html.markdown | 52 + config/docs/r/route_entry.html.markdown | 63 ++ config/docs/r/route_table.html.markdown | 54 + .../r/route_table_association.html.markdown | 45 + config/docs/r/route_table_entry.html.markdown | 74 ++ .../rum_instance_status_config.html.markdown | 45 + ...ffline_log_config_attachment.html.markdown | 44 + config/docs/r/rum_project.html.markdown | 62 + .../r/rum_project_status_config.html.markdown | 45 + config/docs/r/rum_taw_instance.html.markdown | 58 + config/docs/r/rum_whitelist.html.markdown | 51 + config/docs/r/scf_function.html.markdown | 159 +++ .../docs/r/scf_function_alias.html.markdown | 95 ++ ...function_event_invoke_config.html.markdown | 61 + .../docs/r/scf_function_version.html.markdown | 47 + .../docs/r/scf_invoke_function.html.markdown | 43 + config/docs/r/scf_layer.html.markdown | 66 ++ config/docs/r/scf_namespace.html.markdown | 46 + ...ovisioned_concurrency_config.html.markdown | 63 ++ ..._reserved_concurrency_config.html.markdown | 47 + .../r/scf_sync_invoke_function.html.markdown | 42 + .../r/scf_terminate_async_event.html.markdown | 41 + .../docs/r/scf_trigger_config.html.markdown | 59 + config/docs/r/security_group.html.markdown | 63 ++ .../r/security_group_lite_rule.html.markdown | 68 ++ .../docs/r/security_group_rule.html.markdown | 97 ++ .../r/security_group_rule_set.html.markdown | 154 +++ .../docs/r/ses_batch_send_email.html.markdown | 84 ++ config/docs/r/ses_black_list.html.markdown | 37 + .../r/ses_black_list_delete.html.markdown | 37 + config/docs/r/ses_domain.html.markdown | 45 + config/docs/r/ses_email_address.html.markdown | 44 + config/docs/r/ses_receiver.html.markdown | 77 ++ config/docs/r/ses_send_email.html.markdown | 65 ++ config/docs/r/ses_template.html.markdown | 83 ++ config/docs/r/ses_verify_domain.html.markdown | 37 + config/docs/r/sms_sign.html.markdown | 49 + config/docs/r/sms_template.html.markdown | 45 + config/docs/r/sqlserver_account.html.markdown | 95 ++ ...server_account_db_attachment.html.markdown | 106 ++ .../r/sqlserver_basic_instance.html.markdown | 104 ++ ...r_business_intelligence_file.html.markdown | 88 ++ ...siness_intelligence_instance.html.markdown | 97 ++ ...sqlserver_complete_expansion.html.markdown | 104 ++ ...erver_config_backup_strategy.html.markdown | 143 +++ ...qlserver_config_database_cdc.html.markdown | 109 ++ ...sqlserver_config_database_ct.html.markdown | 99 ++ ...qlserver_config_database_mdf.html.markdown | 95 ++ .../sqlserver_config_delete_db.html.markdown | 37 + ...rver_config_instance_network.html.markdown | 49 + ...server_config_instance_param.html.markdown | 96 ++ ...ver_config_instance_ro_group.html.markdown | 121 ++ ...fig_instance_security_groups.html.markdown | 45 + ...config_terminate_db_instance.html.markdown | 86 ++ .../r/sqlserver_database_tde.html.markdown | 109 ++ config/docs/r/sqlserver_db.html.markdown | 93 ++ ...server_full_backup_migration.html.markdown | 114 ++ .../r/sqlserver_general_backup.html.markdown | 98 ++ .../r/sqlserver_general_clone.html.markdown | 97 ++ ...erver_general_cloud_instance.html.markdown | 110 ++ ...er_general_cloud_ro_instance.html.markdown | 171 +++ ...server_general_communication.html.markdown | 86 ++ ...erver_incre_backup_migration.html.markdown | 49 + .../docs/r/sqlserver_instance.html.markdown | 91 ++ .../r/sqlserver_instance_tde.html.markdown | 89 ++ .../docs/r/sqlserver_migration.html.markdown | 199 ++++ .../sqlserver_publish_subscribe.html.markdown | 143 +++ .../sqlserver_readonly_instance.html.markdown | 122 ++ .../sqlserver_recycle_ro_group.html.markdown | 37 + .../sqlserver_renew_db_instance.html.markdown | 88 ++ ...r_renew_postpaid_db_instance.html.markdown | 90 ++ ...qlserver_restart_db_instance.html.markdown | 86 ++ .../sqlserver_restore_instance.html.markdown | 57 + .../sqlserver_rollback_instance.html.markdown | 57 + ..._start_backup_full_migration.html.markdown | 37 + ...backup_incremental_migration.html.markdown | 39 + .../r/sqlserver_start_xevent.html.markdown | 88 ++ config/docs/r/ssl_certificate.html.markdown | 89 ++ ..._certificate_chain_operation.html.markdown | 43 + ...mplete_certificate_operation.html.markdown | 43 + ...rtificate_instance_operation.html.markdown | 48 + ...icate_record_retry_operation.html.markdown | 44 + ...te_record_rollback_operation.html.markdown | 43 + ...wnload_certificate_operation.html.markdown | 45 + .../docs/r/ssl_free_certificate.html.markdown | 81 ++ .../docs/r/ssl_pay_certificate.html.markdown | 119 ++ ...eplace_certificate_operation.html.markdown | 52 + ...revoke_certificate_operation.html.markdown | 44 + ...rtificate_instance_operation.html.markdown | 53 + ...icate_record_retry_operation.html.markdown | 44 + ...te_record_rollback_operation.html.markdown | 43 + ...load_revoke_letter_operation.html.markdown | 45 + .../docs/r/ssm_product_secret.html.markdown | 133 +++ .../r/ssm_rotate_product_secret.html.markdown | 35 + config/docs/r/ssm_secret.html.markdown | 111 ++ .../docs/r/ssm_secret_version.html.markdown | 72 ++ .../r/ssm_ssh_key_pair_secret.html.markdown | 72 ++ config/docs/r/subnet.html.markdown | 62 + config/docs/r/tag.html.markdown | 45 + config/docs/r/tag_attachment.html.markdown | 47 + config/docs/r/tat_command.html.markdown | 71 ++ ...nvocation_command_attachment.html.markdown | 61 + ...invocation_invoke_attachment.html.markdown | 57 + config/docs/r/tat_invoker.html.markdown | 67 ++ .../docs/r/tat_invoker_config.html.markdown | 45 + config/docs/r/tcaplus_cluster.html.markdown | 77 ++ config/docs/r/tcaplus_idl.html.markdown | 110 ++ config/docs/r/tcaplus_table.html.markdown | 123 ++ .../docs/r/tcaplus_tablegroup.html.markdown | 64 ++ .../r/tcm_access_log_config.html.markdown | 94 ++ .../r/tcm_cluster_attachment.html.markdown | 60 + config/docs/r/tcm_mesh.html.markdown | 197 ++++ .../r/tcm_prometheus_attachment.html.markdown | 77 ++ .../docs/r/tcm_tracing_config.html.markdown | 82 ++ config/docs/r/tcmq_queue.html.markdown | 58 + config/docs/r/tcmq_subscribe.html.markdown | 54 + config/docs/r/tcmq_topic.html.markdown | 47 + ...te_image_signature_operation.html.markdown | 77 ++ .../r/tcr_customized_domain.html.markdown | 61 + .../tcr_delete_image_operation.html.markdown | 63 ++ .../r/tcr_immutable_tag_rule.html.markdown | 138 +++ config/docs/r/tcr_instance.html.markdown | 127 +++ ...manage_replication_operation.html.markdown | 163 +++ config/docs/r/tcr_namespace.html.markdown | 71 ++ config/docs/r/tcr_repository.html.markdown | 74 ++ .../docs/r/tcr_service_account.html.markdown | 108 ++ ...g_retention_execution_config.html.markdown | 71 ++ .../r/tcr_tag_retention_rule.html.markdown | 74 ++ config/docs/r/tcr_token.html.markdown | 60 + .../docs/r/tcr_vpc_attachment.html.markdown | 78 ++ .../docs/r/tcr_webhook_trigger.html.markdown | 118 ++ config/docs/r/tdcpg_cluster.html.markdown | 67 ++ config/docs/r/tdcpg_instance.html.markdown | 59 + config/docs/r/tdmq_instance.html.markdown | 50 + config/docs/r/tdmq_namespace.html.markdown | 67 ++ ...mq_namespace_role_attachment.html.markdown | 66 ++ .../docs/r/tdmq_rabbitmq_user.html.markdown | 47 + .../tdmq_rabbitmq_vip_instance.html.markdown | 68 ++ .../tdmq_rabbitmq_virtual_host.html.markdown | 41 + .../r/tdmq_rocketmq_cluster.html.markdown | 54 + ...mq_rocketmq_environment_role.html.markdown | 65 ++ .../docs/r/tdmq_rocketmq_group.html.markdown | 71 ++ .../r/tdmq_rocketmq_namespace.html.markdown | 54 + .../docs/r/tdmq_rocketmq_role.html.markdown | 53 + .../docs/r/tdmq_rocketmq_topic.html.markdown | 63 ++ .../tdmq_rocketmq_vip_instance.html.markdown | 78 ++ config/docs/r/tdmq_role.html.markdown | 55 + .../tdmq_send_rocketmq_message.html.markdown | 45 + config/docs/r/tdmq_topic.html.markdown | 73 ++ config/docs/r/tem_app_config.html.markdown | 58 + config/docs/r/tem_application.html.markdown | 52 + .../r/tem_application_service.html.markdown | 69 ++ config/docs/r/tem_environment.html.markdown | 52 + config/docs/r/tem_gateway.html.markdown | 111 ++ config/docs/r/tem_log_config.html.markdown | 59 + config/docs/r/tem_scale_rule.html.markdown | 113 ++ config/docs/r/tem_workload.html.markdown | 161 +++ .../r/teo_acceleration_domain.html.markdown | 65 ++ .../teo_application_proxy_rule.html.markdown | 64 ++ .../r/teo_certificate_config.html.markdown | 72 ++ config/docs/r/teo_origin_group.html.markdown | 92 ++ .../docs/r/teo_ownership_verify.html.markdown | 36 + config/docs/r/teo_rule_engine.html.markdown | 234 ++++ config/docs/r/teo_zone.html.markdown | 62 + config/docs/r/teo_zone_setting.html.markdown | 269 +++++ ...cket_rocketmq_consumer_group.html.markdown | 66 ++ .../r/trocket_rocketmq_instance.html.markdown | 92 ++ .../r/trocket_rocketmq_role.html.markdown | 75 ++ .../r/trocket_rocketmq_topic.html.markdown | 64 ++ .../docs/r/tse_cngw_canary_rule.html.markdown | 123 ++ .../docs/r/tse_cngw_certificate.html.markdown | 50 + config/docs/r/tse_cngw_gateway.html.markdown | 113 ++ config/docs/r/tse_cngw_group.html.markdown | 108 ++ config/docs/r/tse_cngw_route.html.markdown | 133 +++ .../r/tse_cngw_route_rate_limit.html.markdown | 187 +++ config/docs/r/tse_cngw_service.html.markdown | 137 +++ .../tse_cngw_service_rate_limit.html.markdown | 162 +++ config/docs/r/tse_instance.html.markdown | 161 +++ config/docs/r/tse_waf_domains.html.markdown | 45 + .../docs/r/tse_waf_protection.html.markdown | 41 + config/docs/r/tsf_api_group.html.markdown | 75 ++ .../r/tsf_api_rate_limit_rule.html.markdown | 53 + config/docs/r/tsf_application.html.markdown | 75 ++ .../r/tsf_application_config.html.markdown | 49 + .../tsf_application_file_config.html.markdown | 54 + ...lication_file_config_release.html.markdown | 47 + ...sf_application_public_config.html.markdown | 47 + ...cation_public_config_release.html.markdown | 47 + ...f_application_release_config.html.markdown | 56 + .../docs/r/tsf_bind_api_group.html.markdown | 45 + config/docs/r/tsf_cluster.html.markdown | 97 ++ .../docs/r/tsf_config_template.html.markdown | 50 + config/docs/r/tsf_contain_group.html.markdown | 143 +++ .../tsf_deploy_container_group.html.markdown | 226 ++++ .../docs/r/tsf_deploy_vm_group.html.markdown | 120 ++ .../docs/r/tsf_enable_unit_rule.html.markdown | 45 + config/docs/r/tsf_group.html.markdown | 57 + .../r/tsf_instances_attachment.html.markdown | 65 ++ config/docs/r/tsf_lane.html.markdown | 62 + config/docs/r/tsf_lane_rule.html.markdown | 63 ++ config/docs/r/tsf_microservice.html.markdown | 51 + config/docs/r/tsf_namespace.html.markdown | 56 + .../tsf_operate_container_group.html.markdown | 37 + config/docs/r/tsf_operate_group.html.markdown | 37 + config/docs/r/tsf_path_rewrite.html.markdown | 51 + .../r/tsf_release_api_group.html.markdown | 35 + config/docs/r/tsf_repository.html.markdown | 55 + config/docs/r/tsf_task.html.markdown | 94 ++ .../docs/r/tsf_unit_namespace.html.markdown | 48 + config/docs/r/tsf_unit_rule.html.markdown | 84 ++ ...e_dynamic_streaming_template.html.markdown | 111 ++ .../r/vod_image_sprite_template.html.markdown | 63 ++ .../r/vod_procedure_template.html.markdown | 193 ++++ ...shot_by_time_offset_template.html.markdown | 57 + .../docs/r/vod_sub_application.html.markdown | 47 + .../r/vod_super_player_config.html.markdown | 132 +++ config/docs/r/vpc.html.markdown | 75 ++ config/docs/r/vpc_acl.html.markdown | 61 + .../docs/r/vpc_acl_attachment.html.markdown | 72 ++ .../r/vpc_bandwidth_package.html.markdown | 83 ++ ...bandwidth_package_attachment.html.markdown | 77 ++ config/docs/r/vpc_dhcp_ip.html.markdown | 62 + ...vpc_enable_end_point_connect.html.markdown | 39 + config/docs/r/vpc_end_point.html.markdown | 53 + .../r/vpc_end_point_service.html.markdown | 54 + ...end_point_service_white_list.html.markdown | 48 + config/docs/r/vpc_flow_log.html.markdown | 152 +++ .../docs/r/vpc_flow_log_config.html.markdown | 150 +++ .../docs/r/vpc_ipv6_cidr_block.html.markdown | 48 + .../docs/r/vpc_ipv6_eni_address.html.markdown | 78 ++ .../vpc_ipv6_subnet_cidr_block.html.markdown | 72 ++ config/docs/r/vpc_local_gateway.html.markdown | 52 + config/docs/r/vpc_net_detect.html.markdown | 248 ++++ ...vpc_resume_snapshot_instance.html.markdown | 85 ++ .../docs/r/vpc_snapshot_policy.html.markdown | 79 ++ ...c_snapshot_policy_attachment.html.markdown | 90 ++ .../vpc_snapshot_policy_config.html.markdown | 72 ++ .../docs/r/vpc_traffic_package.html.markdown | 45 + config/docs/r/vpn_connection.html.markdown | 109 ++ .../docs/r/vpn_connection_reset.html.markdown | 37 + .../docs/r/vpn_customer_gateway.html.markdown | 50 + ...teway_configuration_download.html.markdown | 51 + config/docs/r/vpn_gateway.html.markdown | 133 +++ .../r/vpn_gateway_ccn_routes.html.markdown | 49 + config/docs/r/vpn_gateway_route.html.markdown | 56 + .../vpn_gateway_ssl_client_cert.html.markdown | 45 + config/docs/r/vpn_ssl_client.html.markdown | 45 + config/docs/r/vpn_ssl_server.html.markdown | 61 + config/docs/r/waf_anti_fake.html.markdown | 52 + .../docs/r/waf_anti_info_leak.html.markdown | 61 + .../docs/r/waf_auto_deny_rules.html.markdown | 49 + config/docs/r/waf_cc.html.markdown | 61 + .../docs/r/waf_cc_auto_status.html.markdown | 45 + config/docs/r/waf_cc_session.html.markdown | 59 + config/docs/r/waf_clb_domain.html.markdown | 160 +++ config/docs/r/waf_clb_instance.html.markdown | 83 ++ config/docs/r/waf_custom_rule.html.markdown | 71 ++ .../r/waf_custom_white_rule.html.markdown | 69 ++ .../r/waf_ip_access_control.html.markdown | 75 ++ .../r/waf_modify_access_period.html.markdown | 37 + config/docs/r/waf_module_status.html.markdown | 55 + .../docs/r/waf_protection_mode.html.markdown | 41 + config/docs/r/waf_saas_domain.html.markdown | 239 ++++ config/docs/r/waf_saas_instance.html.markdown | 86 ++ config/docs/r/waf_web_shell.html.markdown | 45 + config/docs/r/wedata_baseline.html.markdown | 124 ++ config/docs/r/wedata_datasource.html.markdown | 70 ++ config/docs/r/wedata_dq_rule.html.markdown | 127 +++ .../r/wedata_dq_rule_template.html.markdown | 61 + config/docs/r/wedata_function.html.markdown | 74 ++ ...ata_integration_offline_task.html.markdown | 191 ++++ ...ta_integration_realtime_task.html.markdown | 216 ++++ ...wedata_integration_task_node.html.markdown | 161 +++ config/docs/r/wedata_resource.html.markdown | 53 + .../docs/r/wedata_rule_template.html.markdown | 61 + config/docs/r/wedata_script.html.markdown | 51 + config/snippets/tiat-examples.json | 2 +- package-lock.json | 28 +- package.json | 29 +- src/autocomplete/TerraformResDocProvider.ts | 172 ++- src/autocomplete/TerraformTipsProvider.ts | 3 +- src/extension.ts | 38 +- src/utils/gitUtils.ts | 98 +- src/utils/workspaceUtils.ts | 17 + 1667 files changed, 116680 insertions(+), 81 deletions(-) create mode 100644 config/docs/d/address_template_groups.html.markdown create mode 100644 config/docs/d/address_templates.html.markdown create mode 100644 config/docs/d/antiddos_basic_device_status.html.markdown create mode 100644 config/docs/d/antiddos_bgp_biz_trend.html.markdown create mode 100644 config/docs/d/antiddos_list_listener.html.markdown create mode 100644 config/docs/d/antiddos_overview_attack_trend.html.markdown create mode 100644 config/docs/d/antiddos_overview_cc_trend.html.markdown create mode 100644 config/docs/d/antiddos_overview_ddos_event_list.html.markdown create mode 100644 config/docs/d/antiddos_overview_ddos_trend.html.markdown create mode 100644 config/docs/d/antiddos_overview_index.html.markdown create mode 100644 config/docs/d/antiddos_pending_risk_info.html.markdown create mode 100644 config/docs/d/api_gateway_api_app_api.html.markdown create mode 100644 config/docs/d/api_gateway_api_app_service.html.markdown create mode 100644 config/docs/d/api_gateway_api_apps.html.markdown create mode 100644 config/docs/d/api_gateway_api_docs.html.markdown create mode 100644 config/docs/d/api_gateway_api_keys.html.markdown create mode 100644 config/docs/d/api_gateway_api_plugins.html.markdown create mode 100644 config/docs/d/api_gateway_api_usage_plans.html.markdown create mode 100644 config/docs/d/api_gateway_apis.html.markdown create mode 100644 config/docs/d/api_gateway_bind_api_apps_status.html.markdown create mode 100644 config/docs/d/api_gateway_customer_domains.html.markdown create mode 100644 config/docs/d/api_gateway_ip_strategies.html.markdown create mode 100644 config/docs/d/api_gateway_plugins.html.markdown create mode 100644 config/docs/d/api_gateway_service_environment_list.html.markdown create mode 100644 config/docs/d/api_gateway_service_release_versions.html.markdown create mode 100644 config/docs/d/api_gateway_services.html.markdown create mode 100644 config/docs/d/api_gateway_throttling_apis.html.markdown create mode 100644 config/docs/d/api_gateway_throttling_services.html.markdown create mode 100644 config/docs/d/api_gateway_upstreams.html.markdown create mode 100644 config/docs/d/api_gateway_usage_plan_environments.html.markdown create mode 100644 config/docs/d/api_gateway_usage_plans.html.markdown create mode 100644 config/docs/d/as_advices.html.markdown create mode 100644 config/docs/d/as_instances.html.markdown create mode 100644 config/docs/d/as_last_activity.html.markdown create mode 100644 config/docs/d/as_limits.html.markdown create mode 100644 config/docs/d/as_scaling_configs.html.markdown create mode 100644 config/docs/d/as_scaling_groups.html.markdown create mode 100644 config/docs/d/as_scaling_policies.html.markdown create mode 100644 config/docs/d/audit_cos_regions.html.markdown create mode 100644 config/docs/d/audit_key_alias.html.markdown create mode 100644 config/docs/d/audits.html.markdown create mode 100644 config/docs/d/availability_regions.html.markdown create mode 100644 config/docs/d/availability_zones.html.markdown create mode 100644 config/docs/d/availability_zones_by_product.html.markdown create mode 100644 config/docs/d/bi_project.html.markdown create mode 100644 config/docs/d/bi_user_project.html.markdown create mode 100644 config/docs/d/cam_account_summary.html.markdown create mode 100644 config/docs/d/cam_group_memberships.html.markdown create mode 100644 config/docs/d/cam_group_policy_attachments.html.markdown create mode 100644 config/docs/d/cam_group_user_account.html.markdown create mode 100644 config/docs/d/cam_groups.html.markdown create mode 100644 config/docs/d/cam_list_entities_for_policy.html.markdown create mode 100644 config/docs/d/cam_oidc_config.html.markdown create mode 100644 config/docs/d/cam_policies.html.markdown create mode 100644 config/docs/d/cam_policy_granting_service_access.html.markdown create mode 100644 config/docs/d/cam_role_policy_attachments.html.markdown create mode 100644 config/docs/d/cam_roles.html.markdown create mode 100644 config/docs/d/cam_saml_providers.html.markdown create mode 100644 config/docs/d/cam_secret_last_used_time.html.markdown create mode 100644 config/docs/d/cam_user_policy_attachments.html.markdown create mode 100644 config/docs/d/cam_users.html.markdown create mode 100644 config/docs/d/cat_metric_data.html.markdown create mode 100644 config/docs/d/cat_node.html.markdown create mode 100644 config/docs/d/cat_probe_data.html.markdown create mode 100644 config/docs/d/cbs_snapshot_policies.html.markdown create mode 100644 config/docs/d/cbs_snapshots.html.markdown create mode 100644 config/docs/d/cbs_storages.html.markdown create mode 100644 config/docs/d/cbs_storages_set.html.markdown create mode 100644 config/docs/d/ccn_bandwidth_limits.html.markdown create mode 100644 config/docs/d/ccn_cross_border_compliance.html.markdown create mode 100644 config/docs/d/ccn_cross_border_flow_monitor.html.markdown create mode 100644 config/docs/d/ccn_cross_border_region_bandwidth_limits.html.markdown create mode 100644 config/docs/d/ccn_instances.html.markdown create mode 100644 config/docs/d/ccn_tenant_instances.html.markdown create mode 100644 config/docs/d/cdh_instances.html.markdown create mode 100644 config/docs/d/cdn_domain_verifier.html.markdown create mode 100644 config/docs/d/cdn_domains.html.markdown create mode 100644 config/docs/d/cfs_access_groups.html.markdown create mode 100644 config/docs/d/cfs_access_rules.html.markdown create mode 100644 config/docs/d/cfs_available_zone.html.markdown create mode 100644 config/docs/d/cfs_file_system_clients.html.markdown create mode 100644 config/docs/d/cfs_file_systems.html.markdown create mode 100644 config/docs/d/cfs_mount_targets.html.markdown create mode 100644 config/docs/d/cfw_edge_fw_switches.html.markdown create mode 100644 config/docs/d/cfw_nat_fw_switches.html.markdown create mode 100644 config/docs/d/cfw_vpc_fw_switches.html.markdown create mode 100644 config/docs/d/chdfs_access_groups.html.markdown create mode 100644 config/docs/d/chdfs_file_systems.html.markdown create mode 100644 config/docs/d/chdfs_mount_points.html.markdown create mode 100644 config/docs/d/ckafka_acls.html.markdown create mode 100644 config/docs/d/ckafka_connect_resource.html.markdown create mode 100644 config/docs/d/ckafka_datahub_group_offsets.html.markdown create mode 100644 config/docs/d/ckafka_datahub_task.html.markdown create mode 100644 config/docs/d/ckafka_datahub_topic.html.markdown create mode 100644 config/docs/d/ckafka_group.html.markdown create mode 100644 config/docs/d/ckafka_group_info.html.markdown create mode 100644 config/docs/d/ckafka_group_offsets.html.markdown create mode 100644 config/docs/d/ckafka_instances.html.markdown create mode 100644 config/docs/d/ckafka_region.html.markdown create mode 100644 config/docs/d/ckafka_task_status.html.markdown create mode 100644 config/docs/d/ckafka_topic_flow_ranking.html.markdown create mode 100644 config/docs/d/ckafka_topic_produce_connection.html.markdown create mode 100644 config/docs/d/ckafka_topic_subscribe_group.html.markdown create mode 100644 config/docs/d/ckafka_topic_sync_replica.html.markdown create mode 100644 config/docs/d/ckafka_topics.html.markdown create mode 100644 config/docs/d/ckafka_users.html.markdown create mode 100644 config/docs/d/ckafka_zone.html.markdown create mode 100644 config/docs/d/clb_attachments.html.markdown create mode 100644 config/docs/d/clb_cluster_resources.html.markdown create mode 100644 config/docs/d/clb_cross_targets.html.markdown create mode 100644 config/docs/d/clb_exclusive_clusters.html.markdown create mode 100644 config/docs/d/clb_idle_instances.html.markdown create mode 100644 config/docs/d/clb_instance_by_cert_id.html.markdown create mode 100644 config/docs/d/clb_instance_detail.html.markdown create mode 100644 config/docs/d/clb_instance_traffic.html.markdown create mode 100644 config/docs/d/clb_instances.html.markdown create mode 100644 config/docs/d/clb_listener_rules.html.markdown create mode 100644 config/docs/d/clb_listeners.html.markdown create mode 100644 config/docs/d/clb_listeners_by_targets.html.markdown create mode 100644 config/docs/d/clb_redirections.html.markdown create mode 100644 config/docs/d/clb_resources.html.markdown create mode 100644 config/docs/d/clb_target_group_list.html.markdown create mode 100644 config/docs/d/clb_target_groups.html.markdown create mode 100644 config/docs/d/clb_target_health.html.markdown create mode 100644 config/docs/d/clickhouse_backup_job_detail.html.markdown create mode 100644 config/docs/d/clickhouse_backup_jobs.html.markdown create mode 100644 config/docs/d/clickhouse_backup_tables.html.markdown create mode 100644 config/docs/d/cls_machine_group_configs.html.markdown create mode 100644 config/docs/d/cls_machines.html.markdown create mode 100644 config/docs/d/cls_shipper_tasks.html.markdown create mode 100644 config/docs/d/container_cluster_instances.html.markdown create mode 100644 config/docs/d/container_clusters.html.markdown create mode 100644 config/docs/d/cos_batchs.html.markdown create mode 100644 config/docs/d/cos_bucket_inventorys.html.markdown create mode 100644 config/docs/d/cos_bucket_multipart_uploads.html.markdown create mode 100644 config/docs/d/cos_bucket_object.html.markdown create mode 100644 config/docs/d/cos_buckets.html.markdown create mode 100644 config/docs/d/css_backup_stream.html.markdown create mode 100644 config/docs/d/css_domains.html.markdown create mode 100644 config/docs/d/css_monitor_report.html.markdown create mode 100644 config/docs/d/css_pad_templates.html.markdown create mode 100644 config/docs/d/css_pull_stream_task_status.html.markdown create mode 100644 config/docs/d/css_stream_monitor_list.html.markdown create mode 100644 config/docs/d/css_time_shift_record_detail.html.markdown create mode 100644 config/docs/d/css_time_shift_stream_list.html.markdown create mode 100644 config/docs/d/css_watermarks.html.markdown create mode 100644 config/docs/d/css_xp2p_detail_info_list.html.markdown create mode 100644 config/docs/d/cvm_chc_denied_actions.html.markdown create mode 100644 config/docs/d/cvm_chc_hosts.html.markdown create mode 100644 config/docs/d/cvm_disaster_recover_group_quota.html.markdown create mode 100644 config/docs/d/cvm_image_quota.html.markdown create mode 100644 config/docs/d/cvm_image_share_permission.html.markdown create mode 100644 config/docs/d/cvm_import_image_os.html.markdown create mode 100644 config/docs/d/cvm_instance_vnc_url.html.markdown create mode 100644 config/docs/d/cvm_instances_modification.html.markdown create mode 100644 config/docs/d/cwp_machines_simple.html.markdown create mode 100644 config/docs/d/cynosdb_account_all_grant_privileges.html.markdown create mode 100644 config/docs/d/cynosdb_accounts.html.markdown create mode 100644 config/docs/d/cynosdb_audit_logs.html.markdown create mode 100644 config/docs/d/cynosdb_binlog_download_url.html.markdown create mode 100644 config/docs/d/cynosdb_cluster.html.markdown create mode 100644 config/docs/d/cynosdb_cluster_detail_databases.html.markdown create mode 100644 config/docs/d/cynosdb_cluster_instance_groups.html.markdown create mode 100644 config/docs/d/cynosdb_cluster_param_logs.html.markdown create mode 100644 config/docs/d/cynosdb_cluster_params.html.markdown create mode 100644 config/docs/d/cynosdb_clusters.html.markdown create mode 100644 config/docs/d/cynosdb_describe_instance_error_logs.html.markdown create mode 100644 config/docs/d/cynosdb_describe_instance_slow_queries.html.markdown create mode 100644 config/docs/d/cynosdb_instance_slow_queries.html.markdown create mode 100644 config/docs/d/cynosdb_instances.html.markdown create mode 100644 config/docs/d/cynosdb_param_templates.html.markdown create mode 100644 config/docs/d/cynosdb_project_security_groups.html.markdown create mode 100644 config/docs/d/cynosdb_proxy_node.html.markdown create mode 100644 config/docs/d/cynosdb_proxy_version.html.markdown create mode 100644 config/docs/d/cynosdb_resource_package_list.html.markdown create mode 100644 config/docs/d/cynosdb_resource_package_sale_specs.html.markdown create mode 100644 config/docs/d/cynosdb_rollback_time_range.html.markdown create mode 100644 config/docs/d/cynosdb_zone.html.markdown create mode 100644 config/docs/d/cynosdb_zone_config.html.markdown create mode 100644 config/docs/d/dayu_cc_http_policies.html.markdown create mode 100644 config/docs/d/dayu_cc_https_policies.html.markdown create mode 100644 config/docs/d/dayu_ddos_policies.html.markdown create mode 100644 config/docs/d/dayu_ddos_policy_attachments.html.markdown create mode 100644 config/docs/d/dayu_ddos_policy_cases.html.markdown create mode 100644 config/docs/d/dayu_eip.html.markdown create mode 100644 config/docs/d/dayu_l4_rules.html.markdown create mode 100644 config/docs/d/dayu_l4_rules_v2.html.markdown create mode 100644 config/docs/d/dayu_l7_rules.html.markdown create mode 100644 config/docs/d/dayu_l7_rules_v2.html.markdown create mode 100644 config/docs/d/dbbrain_db_space_status.html.markdown create mode 100644 config/docs/d/dbbrain_diag_db_instances.html.markdown create mode 100644 config/docs/d/dbbrain_diag_event.html.markdown create mode 100644 config/docs/d/dbbrain_diag_events.html.markdown create mode 100644 config/docs/d/dbbrain_diag_history.html.markdown create mode 100644 config/docs/d/dbbrain_health_scores.html.markdown create mode 100644 config/docs/d/dbbrain_mysql_process_list.html.markdown create mode 100644 config/docs/d/dbbrain_no_primary_key_tables.html.markdown create mode 100644 config/docs/d/dbbrain_redis_top_big_keys.html.markdown create mode 100644 config/docs/d/dbbrain_redis_top_key_prefix_list.html.markdown create mode 100644 config/docs/d/dbbrain_security_audit_log_download_urls.html.markdown create mode 100644 config/docs/d/dbbrain_security_audit_log_export_tasks.html.markdown create mode 100644 config/docs/d/dbbrain_slow_log_time_series_stats.html.markdown create mode 100644 config/docs/d/dbbrain_slow_log_top_sqls.html.markdown create mode 100644 config/docs/d/dbbrain_slow_log_user_host_stats.html.markdown create mode 100644 config/docs/d/dbbrain_slow_log_user_sql_advice.html.markdown create mode 100644 config/docs/d/dbbrain_slow_logs.html.markdown create mode 100644 config/docs/d/dbbrain_sql_filters.html.markdown create mode 100644 config/docs/d/dbbrain_sql_templates.html.markdown create mode 100644 config/docs/d/dbbrain_top_space_schema_time_series.html.markdown create mode 100644 config/docs/d/dbbrain_top_space_schemas.html.markdown create mode 100644 config/docs/d/dbbrain_top_space_table_time_series.html.markdown create mode 100644 config/docs/d/dbbrain_top_space_tables.html.markdown create mode 100644 config/docs/d/dc_access_points.html.markdown create mode 100644 config/docs/d/dc_gateway_ccn_routes.html.markdown create mode 100644 config/docs/d/dc_gateway_instances.html.markdown create mode 100644 config/docs/d/dc_instances.html.markdown create mode 100644 config/docs/d/dc_internet_address_quota.html.markdown create mode 100644 config/docs/d/dc_internet_address_statistics.html.markdown create mode 100644 config/docs/d/dc_public_direct_connect_tunnel_routes.html.markdown create mode 100644 config/docs/d/dcdb_accounts.html.markdown create mode 100644 config/docs/d/dcdb_database_objects.html.markdown create mode 100644 config/docs/d/dcdb_database_tables.html.markdown create mode 100644 config/docs/d/dcdb_databases.html.markdown create mode 100644 config/docs/d/dcdb_file_download_url.html.markdown create mode 100644 config/docs/d/dcdb_instance_node_info.html.markdown create mode 100644 config/docs/d/dcdb_instances.html.markdown create mode 100644 config/docs/d/dcdb_log_files.html.markdown create mode 100644 config/docs/d/dcdb_orders.html.markdown create mode 100644 config/docs/d/dcdb_parameters.html.markdown create mode 100644 config/docs/d/dcdb_price.html.markdown create mode 100644 config/docs/d/dcdb_project_security_groups.html.markdown create mode 100644 config/docs/d/dcdb_projects.html.markdown create mode 100644 config/docs/d/dcdb_renewal_price.html.markdown create mode 100644 config/docs/d/dcdb_sale_info.html.markdown create mode 100644 config/docs/d/dcdb_security_groups.html.markdown create mode 100644 config/docs/d/dcdb_shard_spec.html.markdown create mode 100644 config/docs/d/dcdb_shards.html.markdown create mode 100644 config/docs/d/dcdb_slow_logs.html.markdown create mode 100644 config/docs/d/dcdb_upgrade_price.html.markdown create mode 100644 config/docs/d/dcx_instances.html.markdown create mode 100644 config/docs/d/dlc_check_data_engine_config_pairs_validity.html.markdown create mode 100644 config/docs/d/dlc_check_data_engine_image_can_be_rollback.html.markdown create mode 100644 config/docs/d/dlc_check_data_engine_image_can_be_upgrade.html.markdown create mode 100644 config/docs/d/dlc_describe_data_engine.html.markdown create mode 100644 config/docs/d/dlc_describe_data_engine_image_versions.html.markdown create mode 100644 config/docs/d/dlc_describe_data_engine_python_spark_images.html.markdown create mode 100644 config/docs/d/dlc_describe_engine_usage_info.html.markdown create mode 100644 config/docs/d/dlc_describe_updatable_data_engines.html.markdown create mode 100644 config/docs/d/dlc_describe_user_info.html.markdown create mode 100644 config/docs/d/dlc_describe_user_roles.html.markdown create mode 100644 config/docs/d/dlc_describe_user_type.html.markdown create mode 100644 config/docs/d/dlc_describe_work_group_info.html.markdown create mode 100644 config/docs/d/dnats.html.markdown create mode 100644 config/docs/d/dnspod_domain_analytics.html.markdown create mode 100644 config/docs/d/dnspod_domain_list.html.markdown create mode 100644 config/docs/d/dnspod_domain_log_list.html.markdown create mode 100644 config/docs/d/dnspod_record_analytics.html.markdown create mode 100644 config/docs/d/dnspod_record_line_list.html.markdown create mode 100644 config/docs/d/dnspod_record_list.html.markdown create mode 100644 config/docs/d/dnspod_record_type.html.markdown create mode 100644 config/docs/d/dnspod_records.html.markdown create mode 100644 config/docs/d/domains.html.markdown create mode 100644 config/docs/d/dts_compare_tasks.html.markdown create mode 100644 config/docs/d/dts_migrate_db_instances.html.markdown create mode 100644 config/docs/d/dts_migrate_jobs.html.markdown create mode 100644 config/docs/d/dts_sync_jobs.html.markdown create mode 100644 config/docs/d/eb_bus.html.markdown create mode 100644 config/docs/d/eb_event_rules.html.markdown create mode 100644 config/docs/d/eb_plateform_event_template.html.markdown create mode 100644 config/docs/d/eb_platform_event_names.html.markdown create mode 100644 config/docs/d/eb_platform_event_patterns.html.markdown create mode 100644 config/docs/d/eb_platform_products.html.markdown create mode 100644 config/docs/d/eip.html.markdown create mode 100644 config/docs/d/eip_address_quota.html.markdown create mode 100644 config/docs/d/eip_network_account_type.html.markdown create mode 100644 config/docs/d/eips.html.markdown create mode 100644 config/docs/d/elasticsearch_diagnose.html.markdown create mode 100644 config/docs/d/elasticsearch_instance_logs.html.markdown create mode 100644 config/docs/d/elasticsearch_instance_operations.html.markdown create mode 100644 config/docs/d/elasticsearch_instance_plugin_list.html.markdown create mode 100644 config/docs/d/elasticsearch_instances.html.markdown create mode 100644 config/docs/d/elasticsearch_logstash_instance_logs.html.markdown create mode 100644 config/docs/d/elasticsearch_logstash_instance_operations.html.markdown create mode 100644 config/docs/d/elasticsearch_views.html.markdown create mode 100644 config/docs/d/emr.html.markdown create mode 100644 config/docs/d/emr_cvm_quota.html.markdown create mode 100644 config/docs/d/emr_nodes.html.markdown create mode 100644 config/docs/d/enis.html.markdown create mode 100644 config/docs/d/gaap_access_regions.html.markdown create mode 100644 config/docs/d/gaap_access_regions_by_dest_region.html.markdown create mode 100644 config/docs/d/gaap_black_header.html.markdown create mode 100644 config/docs/d/gaap_certificates.html.markdown create mode 100644 config/docs/d/gaap_check_proxy_create.html.markdown create mode 100644 config/docs/d/gaap_country_area_mapping.html.markdown create mode 100644 config/docs/d/gaap_custom_header.html.markdown create mode 100644 config/docs/d/gaap_dest_regions.html.markdown create mode 100644 config/docs/d/gaap_domain_error_page_infos.html.markdown create mode 100644 config/docs/d/gaap_domain_error_pages.html.markdown create mode 100644 config/docs/d/gaap_group_and_statistics_proxy.html.markdown create mode 100644 config/docs/d/gaap_http_domains.html.markdown create mode 100644 config/docs/d/gaap_http_rules.html.markdown create mode 100644 config/docs/d/gaap_layer4_listeners.html.markdown create mode 100644 config/docs/d/gaap_layer7_listeners.html.markdown create mode 100644 config/docs/d/gaap_listener_real_servers.html.markdown create mode 100644 config/docs/d/gaap_listener_statistics.html.markdown create mode 100644 config/docs/d/gaap_proxies.html.markdown create mode 100644 config/docs/d/gaap_proxies_status.html.markdown create mode 100644 config/docs/d/gaap_proxy_and_statistics_listeners.html.markdown create mode 100644 config/docs/d/gaap_proxy_detail.html.markdown create mode 100644 config/docs/d/gaap_proxy_group_statistics.html.markdown create mode 100644 config/docs/d/gaap_proxy_groups.html.markdown create mode 100644 config/docs/d/gaap_proxy_statistics.html.markdown create mode 100644 config/docs/d/gaap_real_servers_status.html.markdown create mode 100644 config/docs/d/gaap_realservers.html.markdown create mode 100644 config/docs/d/gaap_region_and_price.html.markdown create mode 100644 config/docs/d/gaap_resources_by_tag.html.markdown create mode 100644 config/docs/d/gaap_rule_real_servers.html.markdown create mode 100644 config/docs/d/gaap_security_policies.html.markdown create mode 100644 config/docs/d/gaap_security_rules.html.markdown create mode 100644 config/docs/d/ha_vip_eip_attachments.html.markdown create mode 100644 config/docs/d/ha_vips.html.markdown create mode 100644 config/docs/d/image.html.markdown create mode 100644 config/docs/d/images.html.markdown create mode 100644 config/docs/d/instance_types.html.markdown create mode 100644 config/docs/d/instances.html.markdown create mode 100644 config/docs/d/instances_set.html.markdown create mode 100644 config/docs/d/key_pairs.html.markdown create mode 100644 config/docs/d/kms_describe_keys.html.markdown create mode 100644 config/docs/d/kms_get_parameters_for_import.html.markdown create mode 100644 config/docs/d/kms_keys.html.markdown create mode 100644 config/docs/d/kms_list_algorithms.html.markdown create mode 100644 config/docs/d/kms_list_keys.html.markdown create mode 100644 config/docs/d/kms_public_key.html.markdown create mode 100644 config/docs/d/kms_white_box_decrypt_key.html.markdown create mode 100644 config/docs/d/kms_white_box_device_fingerprints.html.markdown create mode 100644 config/docs/d/kms_white_box_key_details.html.markdown create mode 100644 config/docs/d/kubernetes_available_cluster_versions.html.markdown create mode 100644 config/docs/d/kubernetes_charts.html.markdown create mode 100644 config/docs/d/kubernetes_cluster_authentication_options.html.markdown create mode 100644 config/docs/d/kubernetes_cluster_common_names.html.markdown create mode 100644 config/docs/d/kubernetes_cluster_instances.html.markdown create mode 100644 config/docs/d/kubernetes_cluster_levels.html.markdown create mode 100644 config/docs/d/kubernetes_cluster_node_pools.html.markdown create mode 100644 config/docs/d/kubernetes_clusters.html.markdown create mode 100644 config/docs/d/lighthouse_all_scene.html.markdown create mode 100644 config/docs/d/lighthouse_bundle.html.markdown create mode 100644 config/docs/d/lighthouse_disk_config.html.markdown create mode 100644 config/docs/d/lighthouse_disks.html.markdown create mode 100644 config/docs/d/lighthouse_firewall_rules_template.html.markdown create mode 100644 config/docs/d/lighthouse_instance_blueprint.html.markdown create mode 100644 config/docs/d/lighthouse_instance_disk_num.html.markdown create mode 100644 config/docs/d/lighthouse_instance_traffic_package.html.markdown create mode 100644 config/docs/d/lighthouse_instance_vnc_url.html.markdown create mode 100644 config/docs/d/lighthouse_modify_instance_bundle.html.markdown create mode 100644 config/docs/d/lighthouse_region.html.markdown create mode 100644 config/docs/d/lighthouse_reset_instance_blueprint.html.markdown create mode 100644 config/docs/d/lighthouse_scene.html.markdown create mode 100644 config/docs/d/lighthouse_zone.html.markdown create mode 100644 config/docs/d/mariadb_accounts.html.markdown create mode 100644 config/docs/d/mariadb_database_objects.html.markdown create mode 100644 config/docs/d/mariadb_database_table.html.markdown create mode 100644 config/docs/d/mariadb_databases.html.markdown create mode 100644 config/docs/d/mariadb_db_instances.html.markdown create mode 100644 config/docs/d/mariadb_dcn_detail.html.markdown create mode 100644 config/docs/d/mariadb_file_download_url.html.markdown create mode 100644 config/docs/d/mariadb_flow.html.markdown create mode 100644 config/docs/d/mariadb_instance_specs.html.markdown create mode 100644 config/docs/d/mariadb_log_files.html.markdown create mode 100644 config/docs/d/mariadb_orders.html.markdown create mode 100644 config/docs/d/mariadb_price.html.markdown create mode 100644 config/docs/d/mariadb_project_security_groups.html.markdown create mode 100644 config/docs/d/mariadb_renewal_price.html.markdown create mode 100644 config/docs/d/mariadb_sale_info.html.markdown create mode 100644 config/docs/d/mariadb_security_groups.html.markdown create mode 100644 config/docs/d/mariadb_slow_logs.html.markdown create mode 100644 config/docs/d/mariadb_upgrade_price.html.markdown create mode 100644 config/docs/d/mongodb_instance_backups.html.markdown create mode 100644 config/docs/d/mongodb_instance_connections.html.markdown create mode 100644 config/docs/d/mongodb_instance_current_op.html.markdown create mode 100644 config/docs/d/mongodb_instance_params.html.markdown create mode 100644 config/docs/d/mongodb_instance_slow_log.html.markdown create mode 100644 config/docs/d/mongodb_instances.html.markdown create mode 100644 config/docs/d/mongodb_zone_config.html.markdown create mode 100644 config/docs/d/monitor_alarm_all_namespaces.html.markdown create mode 100644 config/docs/d/monitor_alarm_basic_alarms.html.markdown create mode 100644 config/docs/d/monitor_alarm_basic_metric.html.markdown create mode 100644 config/docs/d/monitor_alarm_conditions_template.html.markdown create mode 100644 config/docs/d/monitor_alarm_history.html.markdown create mode 100644 config/docs/d/monitor_alarm_metric.html.markdown create mode 100644 config/docs/d/monitor_alarm_monitor_type.html.markdown create mode 100644 config/docs/d/monitor_alarm_notice_callbacks.html.markdown create mode 100644 config/docs/d/monitor_alarm_notices.html.markdown create mode 100644 config/docs/d/monitor_alarm_policy.html.markdown create mode 100644 config/docs/d/monitor_binding_objects.html.markdown create mode 100644 config/docs/d/monitor_data.html.markdown create mode 100644 config/docs/d/monitor_grafana_plugin_overviews.html.markdown create mode 100644 config/docs/d/monitor_policy_conditions.html.markdown create mode 100644 config/docs/d/monitor_policy_groups.html.markdown create mode 100644 config/docs/d/monitor_product_event.html.markdown create mode 100644 config/docs/d/monitor_product_namespace.html.markdown create mode 100644 config/docs/d/monitor_tmp_regions.html.markdown create mode 100644 config/docs/d/mps_media_meta_data.html.markdown create mode 100644 config/docs/d/mps_parse_live_stream_process_notification.html.markdown create mode 100644 config/docs/d/mps_parse_notification.html.markdown create mode 100644 config/docs/d/mps_schedules.html.markdown create mode 100644 config/docs/d/mps_tasks.html.markdown create mode 100644 config/docs/d/mysql_backup_list.html.markdown create mode 100644 config/docs/d/mysql_backup_overview.html.markdown create mode 100644 config/docs/d/mysql_backup_summaries.html.markdown create mode 100644 config/docs/d/mysql_bin_log.html.markdown create mode 100644 config/docs/d/mysql_binlog_backup_overview.html.markdown create mode 100644 config/docs/d/mysql_clone_list.html.markdown create mode 100644 config/docs/d/mysql_data_backup_overview.html.markdown create mode 100644 config/docs/d/mysql_databases.html.markdown create mode 100644 config/docs/d/mysql_db_features.html.markdown create mode 100644 config/docs/d/mysql_default_params.html.markdown create mode 100644 config/docs/d/mysql_error_log.html.markdown create mode 100644 config/docs/d/mysql_inst_tables.html.markdown create mode 100644 config/docs/d/mysql_instance.html.markdown create mode 100644 config/docs/d/mysql_instance_charset.html.markdown create mode 100644 config/docs/d/mysql_instance_info.html.markdown create mode 100644 config/docs/d/mysql_instance_param_record.html.markdown create mode 100644 config/docs/d/mysql_instance_reboot_time.html.markdown create mode 100644 config/docs/d/mysql_parameter_list.html.markdown create mode 100644 config/docs/d/mysql_project_security_group.html.markdown create mode 100644 config/docs/d/mysql_ro_min_scale.html.markdown create mode 100644 config/docs/d/mysql_rollback_range_time.html.markdown create mode 100644 config/docs/d/mysql_slow_log.html.markdown create mode 100644 config/docs/d/mysql_slow_log_data.html.markdown create mode 100644 config/docs/d/mysql_supported_privileges.html.markdown create mode 100644 config/docs/d/mysql_switch_record.html.markdown create mode 100644 config/docs/d/mysql_user_task.html.markdown create mode 100644 config/docs/d/mysql_zone_config.html.markdown create mode 100644 config/docs/d/nat_dc_route.html.markdown create mode 100644 config/docs/d/nat_gateway_snats.html.markdown create mode 100644 config/docs/d/nat_gateways.html.markdown create mode 100644 config/docs/d/nats.html.markdown create mode 100644 config/docs/d/oceanus_check_savepoint.html.markdown create mode 100644 config/docs/d/oceanus_clusters.html.markdown create mode 100644 config/docs/d/oceanus_job_submission_log.html.markdown create mode 100644 config/docs/d/oceanus_resource_related_job.html.markdown create mode 100644 config/docs/d/oceanus_savepoint_list.html.markdown create mode 100644 config/docs/d/oceanus_system_resource.html.markdown create mode 100644 config/docs/d/oceanus_tree_jobs.html.markdown create mode 100644 config/docs/d/oceanus_tree_resources.html.markdown create mode 100644 config/docs/d/oceanus_work_spaces.html.markdown create mode 100644 config/docs/d/organization_members.html.markdown create mode 100644 config/docs/d/organization_org_auth_node.html.markdown create mode 100644 config/docs/d/organization_org_financial_by_member.html.markdown create mode 100644 config/docs/d/organization_org_financial_by_month.html.markdown create mode 100644 config/docs/d/organization_org_financial_by_product.html.markdown create mode 100644 config/docs/d/placement_groups.html.markdown create mode 100644 config/docs/d/postgresql_backup_download_urls.html.markdown create mode 100644 config/docs/d/postgresql_base_backups.html.markdown create mode 100644 config/docs/d/postgresql_db_instance_classes.html.markdown create mode 100644 config/docs/d/postgresql_db_instance_versions.html.markdown create mode 100644 config/docs/d/postgresql_default_parameters.html.markdown create mode 100644 config/docs/d/postgresql_instances.html.markdown create mode 100644 config/docs/d/postgresql_log_backups.html.markdown create mode 100644 config/docs/d/postgresql_parameter_templates.html.markdown create mode 100644 config/docs/d/postgresql_readonly_groups.html.markdown create mode 100644 config/docs/d/postgresql_recovery_time.html.markdown create mode 100644 config/docs/d/postgresql_regions.html.markdown create mode 100644 config/docs/d/postgresql_specinfos.html.markdown create mode 100644 config/docs/d/postgresql_xlogs.html.markdown create mode 100644 config/docs/d/postgresql_zones.html.markdown create mode 100644 config/docs/d/private_dns_records.html.markdown create mode 100644 config/docs/d/projects.html.markdown create mode 100644 config/docs/d/protocol_template_groups.html.markdown create mode 100644 config/docs/d/protocol_templates.html.markdown create mode 100644 config/docs/d/pts_scenario_with_jobs.html.markdown create mode 100644 config/docs/d/redis_backup.html.markdown create mode 100644 config/docs/d/redis_backup_download_info.html.markdown create mode 100644 config/docs/d/redis_instance_node_info.html.markdown create mode 100644 config/docs/d/redis_instance_shards.html.markdown create mode 100644 config/docs/d/redis_instance_task_list.html.markdown create mode 100644 config/docs/d/redis_instance_zone_info.html.markdown create mode 100644 config/docs/d/redis_instances.html.markdown create mode 100644 config/docs/d/redis_param_records.html.markdown create mode 100644 config/docs/d/redis_zone_config.html.markdown create mode 100644 config/docs/d/reserved_instance_configs.html.markdown create mode 100644 config/docs/d/reserved_instances.html.markdown create mode 100644 config/docs/d/route_table.html.markdown create mode 100644 config/docs/d/rum_custom_url.html.markdown create mode 100644 config/docs/d/rum_event_url.html.markdown create mode 100644 config/docs/d/rum_fetch_url.html.markdown create mode 100644 config/docs/d/rum_fetch_url_info.html.markdown create mode 100644 config/docs/d/rum_group_log.html.markdown create mode 100644 config/docs/d/rum_log_export.html.markdown create mode 100644 config/docs/d/rum_log_export_list.html.markdown create mode 100644 config/docs/d/rum_log_url_statistics.html.markdown create mode 100644 config/docs/d/rum_offline_log_config.html.markdown create mode 100644 config/docs/d/rum_performance_page.html.markdown create mode 100644 config/docs/d/rum_project.html.markdown create mode 100644 config/docs/d/rum_pv_url_info.html.markdown create mode 100644 config/docs/d/rum_pv_url_statistics.html.markdown create mode 100644 config/docs/d/rum_report_count.html.markdown create mode 100644 config/docs/d/rum_scores.html.markdown create mode 100644 config/docs/d/rum_set_url_statistics.html.markdown create mode 100644 config/docs/d/rum_sign.html.markdown create mode 100644 config/docs/d/rum_static_project.html.markdown create mode 100644 config/docs/d/rum_static_resource.html.markdown create mode 100644 config/docs/d/rum_static_url.html.markdown create mode 100644 config/docs/d/rum_taw_instance.html.markdown create mode 100644 config/docs/d/rum_web_vitals_page.html.markdown create mode 100644 config/docs/d/rum_whitelist.html.markdown create mode 100644 config/docs/d/scf_account_info.html.markdown create mode 100644 config/docs/d/scf_async_event_management.html.markdown create mode 100644 config/docs/d/scf_async_event_status.html.markdown create mode 100644 config/docs/d/scf_function_address.html.markdown create mode 100644 config/docs/d/scf_function_aliases.html.markdown create mode 100644 config/docs/d/scf_function_versions.html.markdown create mode 100644 config/docs/d/scf_functions.html.markdown create mode 100644 config/docs/d/scf_layer_versions.html.markdown create mode 100644 config/docs/d/scf_layers.html.markdown create mode 100644 config/docs/d/scf_logs.html.markdown create mode 100644 config/docs/d/scf_namespaces.html.markdown create mode 100644 config/docs/d/scf_request_status.html.markdown create mode 100644 config/docs/d/scf_triggers.html.markdown create mode 100644 config/docs/d/security_group.html.markdown create mode 100644 config/docs/d/security_groups.html.markdown create mode 100644 config/docs/d/ses_black_email_address.html.markdown create mode 100644 config/docs/d/ses_email_identities.html.markdown create mode 100644 config/docs/d/ses_receivers.html.markdown create mode 100644 config/docs/d/ses_send_email_status.html.markdown create mode 100644 config/docs/d/ses_send_tasks.html.markdown create mode 100644 config/docs/d/ses_statistics_report.html.markdown create mode 100644 config/docs/d/sqlserver_account_db_attachments.html.markdown create mode 100644 config/docs/d/sqlserver_accounts.html.markdown create mode 100644 config/docs/d/sqlserver_backup_by_flow_id.html.markdown create mode 100644 config/docs/d/sqlserver_backup_commands.html.markdown create mode 100644 config/docs/d/sqlserver_backup_upload_size.html.markdown create mode 100644 config/docs/d/sqlserver_backups.html.markdown create mode 100644 config/docs/d/sqlserver_basic_instances.html.markdown create mode 100644 config/docs/d/sqlserver_cross_region_zone.html.markdown create mode 100644 config/docs/d/sqlserver_datasource_ins_attribute.html.markdown create mode 100644 config/docs/d/sqlserver_db_charsets.html.markdown create mode 100644 config/docs/d/sqlserver_dbs.html.markdown create mode 100644 config/docs/d/sqlserver_ins_attribute.html.markdown create mode 100644 config/docs/d/sqlserver_instance_param_records.html.markdown create mode 100644 config/docs/d/sqlserver_instances.html.markdown create mode 100644 config/docs/d/sqlserver_project_security_groups.html.markdown create mode 100644 config/docs/d/sqlserver_publish_subscribes.html.markdown create mode 100644 config/docs/d/sqlserver_query_xevent.html.markdown create mode 100644 config/docs/d/sqlserver_readonly_groups.html.markdown create mode 100644 config/docs/d/sqlserver_regions.html.markdown create mode 100644 config/docs/d/sqlserver_rollback_time.html.markdown create mode 100644 config/docs/d/sqlserver_slowlogs.html.markdown create mode 100644 config/docs/d/sqlserver_upload_backup_info.html.markdown create mode 100644 config/docs/d/sqlserver_upload_incremental_info.html.markdown create mode 100644 config/docs/d/sqlserver_zone_config.html.markdown create mode 100644 config/docs/d/ssl_certificates.html.markdown create mode 100644 config/docs/d/ssl_describe_certificate.html.markdown create mode 100644 config/docs/d/ssl_describe_companies.html.markdown create mode 100644 config/docs/d/ssl_describe_host_api_gateway_instance_list.html.markdown create mode 100644 config/docs/d/ssl_describe_host_cdn_instance_list.html.markdown create mode 100644 config/docs/d/ssl_describe_host_clb_instance_list.html.markdown create mode 100644 config/docs/d/ssl_describe_host_cos_instance_list.html.markdown create mode 100644 config/docs/d/ssl_describe_host_ddos_instance_list.html.markdown create mode 100644 config/docs/d/ssl_describe_host_deploy_record.html.markdown create mode 100644 config/docs/d/ssl_describe_host_deploy_record_detail.html.markdown create mode 100644 config/docs/d/ssl_describe_host_lighthouse_instance_list.html.markdown create mode 100644 config/docs/d/ssl_describe_host_live_instance_list.html.markdown create mode 100644 config/docs/d/ssl_describe_host_teo_instance_list.html.markdown create mode 100644 config/docs/d/ssl_describe_host_tke_instance_list.html.markdown create mode 100644 config/docs/d/ssl_describe_host_update_record.html.markdown create mode 100644 config/docs/d/ssl_describe_host_update_record_detail.html.markdown create mode 100644 config/docs/d/ssl_describe_host_vod_instance_list.html.markdown create mode 100644 config/docs/d/ssl_describe_host_waf_instance_list.html.markdown create mode 100644 config/docs/d/ssl_describe_manager_detail.html.markdown create mode 100644 config/docs/d/ssl_describe_managers.html.markdown create mode 100644 config/docs/d/ssm_products.html.markdown create mode 100644 config/docs/d/ssm_rotation_detail.html.markdown create mode 100644 config/docs/d/ssm_rotation_history.html.markdown create mode 100644 config/docs/d/ssm_secret_versions.html.markdown create mode 100644 config/docs/d/ssm_secrets.html.markdown create mode 100644 config/docs/d/ssm_service_status.html.markdown create mode 100644 config/docs/d/ssm_ssh_key_pair_value.html.markdown create mode 100644 config/docs/d/sts_caller_identity.html.markdown create mode 100644 config/docs/d/subnet.html.markdown create mode 100644 config/docs/d/tat_agent.html.markdown create mode 100644 config/docs/d/tat_command.html.markdown create mode 100644 config/docs/d/tat_invocation_task.html.markdown create mode 100644 config/docs/d/tat_invoker.html.markdown create mode 100644 config/docs/d/tat_invoker_records.html.markdown create mode 100644 config/docs/d/tcaplus_clusters.html.markdown create mode 100644 config/docs/d/tcaplus_idls.html.markdown create mode 100644 config/docs/d/tcaplus_tablegroups.html.markdown create mode 100644 config/docs/d/tcaplus_tables.html.markdown create mode 100644 config/docs/d/tcm_mesh.html.markdown create mode 100644 config/docs/d/tcmq_queue.html.markdown create mode 100644 config/docs/d/tcmq_subscribe.html.markdown create mode 100644 config/docs/d/tcmq_topic.html.markdown create mode 100644 config/docs/d/tcr_image_manifests.html.markdown create mode 100644 config/docs/d/tcr_images.html.markdown create mode 100644 config/docs/d/tcr_instances.html.markdown create mode 100644 config/docs/d/tcr_namespaces.html.markdown create mode 100644 config/docs/d/tcr_replication_instance_create_tasks.html.markdown create mode 100644 config/docs/d/tcr_replication_instance_sync_status.html.markdown create mode 100644 config/docs/d/tcr_repositories.html.markdown create mode 100644 config/docs/d/tcr_tag_retention_execution_tasks.html.markdown create mode 100644 config/docs/d/tcr_tag_retention_executions.html.markdown create mode 100644 config/docs/d/tcr_tokens.html.markdown create mode 100644 config/docs/d/tcr_vpc_attachments.html.markdown create mode 100644 config/docs/d/tcr_webhook_trigger_logs.html.markdown create mode 100644 config/docs/d/tdcpg_clusters.html.markdown create mode 100644 config/docs/d/tdcpg_instances.html.markdown create mode 100644 config/docs/d/tdmq_environment_attributes.html.markdown create mode 100644 config/docs/d/tdmq_pro_instance_detail.html.markdown create mode 100644 config/docs/d/tdmq_pro_instances.html.markdown create mode 100644 config/docs/d/tdmq_publisher_summary.html.markdown create mode 100644 config/docs/d/tdmq_publishers.html.markdown create mode 100644 config/docs/d/tdmq_rocketmq_cluster.html.markdown create mode 100644 config/docs/d/tdmq_rocketmq_group.html.markdown create mode 100644 config/docs/d/tdmq_rocketmq_messages.html.markdown create mode 100644 config/docs/d/tdmq_rocketmq_namespace.html.markdown create mode 100644 config/docs/d/tdmq_rocketmq_role.html.markdown create mode 100644 config/docs/d/tdmq_rocketmq_topic.html.markdown create mode 100644 config/docs/d/teo_rule_engine_settings.html.markdown create mode 100644 config/docs/d/teo_zone_available_plans.html.markdown create mode 100644 config/docs/d/tse_access_address.html.markdown create mode 100644 config/docs/d/tse_gateway_canary_rules.html.markdown create mode 100644 config/docs/d/tse_gateway_certificates.html.markdown create mode 100644 config/docs/d/tse_gateway_nodes.html.markdown create mode 100644 config/docs/d/tse_gateway_routes.html.markdown create mode 100644 config/docs/d/tse_gateway_services.html.markdown create mode 100644 config/docs/d/tse_gateways.html.markdown create mode 100644 config/docs/d/tse_groups.html.markdown create mode 100644 config/docs/d/tse_nacos_replicas.html.markdown create mode 100644 config/docs/d/tse_nacos_server_interfaces.html.markdown create mode 100644 config/docs/d/tse_zookeeper_replicas.html.markdown create mode 100644 config/docs/d/tse_zookeeper_server_interfaces.html.markdown create mode 100644 config/docs/d/tsf_api_detail.html.markdown create mode 100644 config/docs/d/tsf_api_group.html.markdown create mode 100644 config/docs/d/tsf_application.html.markdown create mode 100644 config/docs/d/tsf_application_attribute.html.markdown create mode 100644 config/docs/d/tsf_application_config.html.markdown create mode 100644 config/docs/d/tsf_application_file_config.html.markdown create mode 100644 config/docs/d/tsf_application_public_config.html.markdown create mode 100644 config/docs/d/tsf_business_log_configs.html.markdown create mode 100644 config/docs/d/tsf_cluster.html.markdown create mode 100644 config/docs/d/tsf_config_summary.html.markdown create mode 100644 config/docs/d/tsf_container_group.html.markdown create mode 100644 config/docs/d/tsf_delivery_config_by_group_id.html.markdown create mode 100644 config/docs/d/tsf_delivery_configs.html.markdown create mode 100644 config/docs/d/tsf_gateway_all_group_apis.html.markdown create mode 100644 config/docs/d/tsf_group_config_release.html.markdown create mode 100644 config/docs/d/tsf_group_gateways.html.markdown create mode 100644 config/docs/d/tsf_group_instances.html.markdown create mode 100644 config/docs/d/tsf_groups.html.markdown create mode 100644 config/docs/d/tsf_microservice.html.markdown create mode 100644 config/docs/d/tsf_microservice_api_version.html.markdown create mode 100644 config/docs/d/tsf_ms_api_list.html.markdown create mode 100644 config/docs/d/tsf_pod_instances.html.markdown create mode 100644 config/docs/d/tsf_public_config_summary.html.markdown create mode 100644 config/docs/d/tsf_repository.html.markdown create mode 100644 config/docs/d/tsf_unit_rules.html.markdown create mode 100644 config/docs/d/tsf_usable_unit_namespaces.html.markdown create mode 100644 config/docs/d/user_info.html.markdown create mode 100644 config/docs/d/vod_adaptive_dynamic_streaming_templates.html.markdown create mode 100644 config/docs/d/vod_image_sprite_templates.html.markdown create mode 100644 config/docs/d/vod_procedure_templates.html.markdown create mode 100644 config/docs/d/vod_snapshot_by_time_offset_templates.html.markdown create mode 100644 config/docs/d/vod_super_player_configs.html.markdown create mode 100644 config/docs/d/vpc.html.markdown create mode 100644 config/docs/d/vpc_account_attributes.html.markdown create mode 100644 config/docs/d/vpc_acls.html.markdown create mode 100644 config/docs/d/vpc_bandwidth_package_bill_usage.html.markdown create mode 100644 config/docs/d/vpc_bandwidth_package_quota.html.markdown create mode 100644 config/docs/d/vpc_classic_link_instances.html.markdown create mode 100644 config/docs/d/vpc_cvm_instances.html.markdown create mode 100644 config/docs/d/vpc_gateway_flow_monitor_detail.html.markdown create mode 100644 config/docs/d/vpc_gateway_flow_qos.html.markdown create mode 100644 config/docs/d/vpc_instances.html.markdown create mode 100644 config/docs/d/vpc_limits.html.markdown create mode 100644 config/docs/d/vpc_net_detect_state_check.html.markdown create mode 100644 config/docs/d/vpc_net_detect_states.html.markdown create mode 100644 config/docs/d/vpc_network_interface_limit.html.markdown create mode 100644 config/docs/d/vpc_private_ip_addresses.html.markdown create mode 100644 config/docs/d/vpc_product_quota.html.markdown create mode 100644 config/docs/d/vpc_resource_dashboard.html.markdown create mode 100644 config/docs/d/vpc_route_conflicts.html.markdown create mode 100644 config/docs/d/vpc_route_tables.html.markdown create mode 100644 config/docs/d/vpc_security_group_limits.html.markdown create mode 100644 config/docs/d/vpc_security_group_references.html.markdown create mode 100644 config/docs/d/vpc_sg_snapshot_file_content.html.markdown create mode 100644 config/docs/d/vpc_snapshot_files.html.markdown create mode 100644 config/docs/d/vpc_subnet_resource_dashboard.html.markdown create mode 100644 config/docs/d/vpc_subnets.html.markdown create mode 100644 config/docs/d/vpc_template_limits.html.markdown create mode 100644 config/docs/d/vpc_used_ip_address.html.markdown create mode 100644 config/docs/d/vpn_connections.html.markdown create mode 100644 config/docs/d/vpn_customer_gateway_vendors.html.markdown create mode 100644 config/docs/d/vpn_customer_gateways.html.markdown create mode 100644 config/docs/d/vpn_default_health_check_ip.html.markdown create mode 100644 config/docs/d/vpn_gateway_routes.html.markdown create mode 100644 config/docs/d/vpn_gateways.html.markdown create mode 100644 config/docs/d/waf_attack_log_histogram.html.markdown create mode 100644 config/docs/d/waf_attack_log_list.html.markdown create mode 100644 config/docs/d/waf_attack_overview.html.markdown create mode 100644 config/docs/d/waf_attack_total_count.html.markdown create mode 100644 config/docs/d/waf_ciphers.html.markdown create mode 100644 config/docs/d/waf_domains.html.markdown create mode 100644 config/docs/d/waf_find_domains.html.markdown create mode 100644 config/docs/d/waf_instance_qps_limit.html.markdown create mode 100644 config/docs/d/waf_peak_points.html.markdown create mode 100644 config/docs/d/waf_ports.html.markdown create mode 100644 config/docs/d/waf_tls_versions.html.markdown create mode 100644 config/docs/d/waf_user_clb_regions.html.markdown create mode 100644 config/docs/d/waf_user_domains.html.markdown create mode 100644 config/docs/d/wedata_data_source_info_list.html.markdown create mode 100644 config/docs/d/wedata_data_source_list.html.markdown create mode 100644 config/docs/d/wedata_data_source_without_info.html.markdown create mode 100644 config/docs/d/wedata_rule_templates.html.markdown create mode 100644 config/docs/r/address_template.html.markdown create mode 100644 config/docs/r/address_template_group.html.markdown create mode 100644 config/docs/r/alb_server_attachment.html.markdown create mode 100644 config/docs/r/antiddos_cc_black_white_ip.html.markdown create mode 100644 config/docs/r/antiddos_cc_precision_policy.html.markdown create mode 100644 config/docs/r/antiddos_ddos_black_white_ip.html.markdown create mode 100644 config/docs/r/antiddos_ddos_geo_ip_block_config.html.markdown create mode 100644 config/docs/r/antiddos_ddos_speed_limit_config.html.markdown create mode 100644 config/docs/r/antiddos_default_alarm_threshold.html.markdown create mode 100644 config/docs/r/antiddos_ip_alarm_threshold_config.html.markdown create mode 100644 config/docs/r/antiddos_packet_filter_config.html.markdown create mode 100644 config/docs/r/antiddos_port_acl_config.html.markdown create mode 100644 config/docs/r/antiddos_scheduling_domain_user_name.html.markdown create mode 100644 config/docs/r/api_gateway_api.html.markdown create mode 100644 config/docs/r/api_gateway_api_app.html.markdown create mode 100644 config/docs/r/api_gateway_api_app_attachment.html.markdown create mode 100644 config/docs/r/api_gateway_api_doc.html.markdown create mode 100644 config/docs/r/api_gateway_api_key.html.markdown create mode 100644 config/docs/r/api_gateway_api_key_attachment.html.markdown create mode 100644 config/docs/r/api_gateway_custom_domain.html.markdown create mode 100644 config/docs/r/api_gateway_import_open_api.html.markdown create mode 100644 config/docs/r/api_gateway_ip_strategy.html.markdown create mode 100644 config/docs/r/api_gateway_plugin.html.markdown create mode 100644 config/docs/r/api_gateway_plugin_attachment.html.markdown create mode 100644 config/docs/r/api_gateway_service.html.markdown create mode 100644 config/docs/r/api_gateway_service_release.html.markdown create mode 100644 config/docs/r/api_gateway_strategy_attachment.html.markdown create mode 100644 config/docs/r/api_gateway_update_api_app_key.html.markdown create mode 100644 config/docs/r/api_gateway_upstream.html.markdown create mode 100644 config/docs/r/api_gateway_usage_plan.html.markdown create mode 100644 config/docs/r/api_gateway_usage_plan_attachment.html.markdown create mode 100644 config/docs/r/apm_instance.html.markdown create mode 100644 config/docs/r/as_attachment.html.markdown create mode 100644 config/docs/r/as_complete_lifecycle.html.markdown create mode 100644 config/docs/r/as_execute_scaling_policy.html.markdown create mode 100644 config/docs/r/as_lifecycle_hook.html.markdown create mode 100644 config/docs/r/as_notification.html.markdown create mode 100644 config/docs/r/as_protect_instances.html.markdown create mode 100644 config/docs/r/as_remove_instances.html.markdown create mode 100644 config/docs/r/as_scale_in_instances.html.markdown create mode 100644 config/docs/r/as_scale_out_instances.html.markdown create mode 100644 config/docs/r/as_scaling_config.html.markdown create mode 100644 config/docs/r/as_scaling_group.html.markdown create mode 100644 config/docs/r/as_scaling_group_status.html.markdown create mode 100644 config/docs/r/as_scaling_policy.html.markdown create mode 100644 config/docs/r/as_schedule.html.markdown create mode 100644 config/docs/r/as_start_instances.html.markdown create mode 100644 config/docs/r/as_stop_instances.html.markdown create mode 100644 config/docs/r/audit.html.markdown create mode 100644 config/docs/r/audit_track.html.markdown create mode 100644 config/docs/r/bi_datasource.html.markdown create mode 100644 config/docs/r/bi_datasource_cloud.html.markdown create mode 100644 config/docs/r/bi_embed_interval_apply.html.markdown create mode 100644 config/docs/r/bi_embed_token_apply.html.markdown create mode 100644 config/docs/r/bi_project.html.markdown create mode 100644 config/docs/r/bi_project_user_role.html.markdown create mode 100644 config/docs/r/bi_user_role.html.markdown create mode 100644 config/docs/r/cam_access_key.html.markdown create mode 100644 config/docs/r/cam_group.html.markdown create mode 100644 config/docs/r/cam_group_membership.html.markdown create mode 100644 config/docs/r/cam_group_policy_attachment.html.markdown create mode 100644 config/docs/r/cam_mfa_flag.html.markdown create mode 100644 config/docs/r/cam_oidc_sso.html.markdown create mode 100644 config/docs/r/cam_policy.html.markdown create mode 100644 config/docs/r/cam_policy_by_name.html.markdown create mode 100644 config/docs/r/cam_policy_version.html.markdown create mode 100644 config/docs/r/cam_role.html.markdown create mode 100644 config/docs/r/cam_role_by_name.html.markdown create mode 100644 config/docs/r/cam_role_permission_boundary_attachment.html.markdown create mode 100644 config/docs/r/cam_role_policy_attachment.html.markdown create mode 100644 config/docs/r/cam_role_policy_attachment_by_name.html.markdown create mode 100644 config/docs/r/cam_role_sso.html.markdown create mode 100644 config/docs/r/cam_saml_provider.html.markdown create mode 100644 config/docs/r/cam_service_linked_role.html.markdown create mode 100644 config/docs/r/cam_set_policy_version_config.html.markdown create mode 100644 config/docs/r/cam_tag_role_attachment.html.markdown create mode 100644 config/docs/r/cam_user.html.markdown create mode 100644 config/docs/r/cam_user_permission_boundary_attachment.html.markdown create mode 100644 config/docs/r/cam_user_policy_attachment.html.markdown create mode 100644 config/docs/r/cam_user_saml_config.html.markdown create mode 100644 config/docs/r/cat_task_set.html.markdown create mode 100644 config/docs/r/cbs_disk_backup.html.markdown create mode 100644 config/docs/r/cbs_disk_backup_rollback_operation.html.markdown create mode 100644 config/docs/r/cbs_snapshot.html.markdown create mode 100644 config/docs/r/cbs_snapshot_policy.html.markdown create mode 100644 config/docs/r/cbs_snapshot_policy_attachment.html.markdown create mode 100644 config/docs/r/cbs_snapshot_share_permission.html.markdown create mode 100644 config/docs/r/cbs_storage.html.markdown create mode 100644 config/docs/r/cbs_storage_attachment.html.markdown create mode 100644 config/docs/r/cbs_storage_set.html.markdown create mode 100644 config/docs/r/cbs_storage_set_attachment.html.markdown create mode 100644 config/docs/r/ccn.html.markdown create mode 100644 config/docs/r/ccn_attachment.html.markdown create mode 100644 config/docs/r/ccn_bandwidth_limit.html.markdown create mode 100644 config/docs/r/ccn_instances_accept_attach.html.markdown create mode 100644 config/docs/r/ccn_instances_reject_attach.html.markdown create mode 100644 config/docs/r/ccn_instances_reset_attach.html.markdown create mode 100644 config/docs/r/ccn_routes.html.markdown create mode 100644 config/docs/r/cdh_instance.html.markdown create mode 100644 config/docs/r/cdn_domain.html.markdown create mode 100644 config/docs/r/cdn_url_purge.html.markdown create mode 100644 config/docs/r/cdn_url_push.html.markdown create mode 100644 config/docs/r/cdwpg_instance.html.markdown create mode 100644 config/docs/r/cfs_access_group.html.markdown create mode 100644 config/docs/r/cfs_access_rule.html.markdown create mode 100644 config/docs/r/cfs_auto_snapshot_policy.html.markdown create mode 100644 config/docs/r/cfs_auto_snapshot_policy_attachment.html.markdown create mode 100644 config/docs/r/cfs_file_system.html.markdown create mode 100644 config/docs/r/cfs_sign_up_cfs_service.html.markdown create mode 100644 config/docs/r/cfs_snapshot.html.markdown create mode 100644 config/docs/r/cfs_user_quota.html.markdown create mode 100644 config/docs/r/cfw_address_template.html.markdown create mode 100644 config/docs/r/cfw_block_ignore.html.markdown create mode 100644 config/docs/r/cfw_edge_firewall_switch.html.markdown create mode 100644 config/docs/r/cfw_edge_policy.html.markdown create mode 100644 config/docs/r/cfw_nat_firewall_switch.html.markdown create mode 100644 config/docs/r/cfw_nat_instance.html.markdown create mode 100644 config/docs/r/cfw_nat_policy.html.markdown create mode 100644 config/docs/r/cfw_sync_asset.html.markdown create mode 100644 config/docs/r/cfw_sync_route.html.markdown create mode 100644 config/docs/r/cfw_vpc_firewall_switch.html.markdown create mode 100644 config/docs/r/cfw_vpc_instance.html.markdown create mode 100644 config/docs/r/cfw_vpc_policy.html.markdown create mode 100644 config/docs/r/chdfs_access_group.html.markdown create mode 100644 config/docs/r/chdfs_access_rule.html.markdown create mode 100644 config/docs/r/chdfs_file_system.html.markdown create mode 100644 config/docs/r/chdfs_life_cycle_rule.html.markdown create mode 100644 config/docs/r/chdfs_mount_point.html.markdown create mode 100644 config/docs/r/chdfs_mount_point_attachment.html.markdown create mode 100644 config/docs/r/ci_bucket_attachment.html.markdown create mode 100644 config/docs/r/ci_bucket_pic_style.html.markdown create mode 100644 config/docs/r/ci_guetzli.html.markdown create mode 100644 config/docs/r/ci_hot_link.html.markdown create mode 100644 config/docs/r/ci_media_animation_template.html.markdown create mode 100644 config/docs/r/ci_media_concat_template.html.markdown create mode 100644 config/docs/r/ci_media_pic_process_template.html.markdown create mode 100644 config/docs/r/ci_media_smart_cover_template.html.markdown create mode 100644 config/docs/r/ci_media_snapshot_template.html.markdown create mode 100644 config/docs/r/ci_media_speech_recognition_template.html.markdown create mode 100644 config/docs/r/ci_media_super_resolution_template.html.markdown create mode 100644 config/docs/r/ci_media_transcode_pro_template.html.markdown create mode 100644 config/docs/r/ci_media_transcode_template.html.markdown create mode 100644 config/docs/r/ci_media_tts_template.html.markdown create mode 100644 config/docs/r/ci_media_video_montage_template.html.markdown create mode 100644 config/docs/r/ci_media_video_process_template.html.markdown create mode 100644 config/docs/r/ci_media_voice_separate_template.html.markdown create mode 100644 config/docs/r/ci_media_watermark_template.html.markdown create mode 100644 config/docs/r/ci_original_image_protection.html.markdown create mode 100644 config/docs/r/ciam_user_group.html.markdown create mode 100644 config/docs/r/ciam_user_store.html.markdown create mode 100644 config/docs/r/ckafka_acl.html.markdown create mode 100644 config/docs/r/ckafka_acl_rule.html.markdown create mode 100644 config/docs/r/ckafka_connect_resource.html.markdown create mode 100644 config/docs/r/ckafka_consumer_group.html.markdown create mode 100644 config/docs/r/ckafka_consumer_group_modify_offset.html.markdown create mode 100644 config/docs/r/ckafka_datahub_task.html.markdown create mode 100644 config/docs/r/ckafka_datahub_topic.html.markdown create mode 100644 config/docs/r/ckafka_instance.html.markdown create mode 100644 config/docs/r/ckafka_renew_instance.html.markdown create mode 100644 config/docs/r/ckafka_route.html.markdown create mode 100644 config/docs/r/ckafka_topic.html.markdown create mode 100644 config/docs/r/ckafka_user.html.markdown create mode 100644 config/docs/r/clb_attachment.html.markdown create mode 100644 config/docs/r/clb_customized_config.html.markdown create mode 100644 config/docs/r/clb_function_targets_attachment.html.markdown create mode 100644 config/docs/r/clb_instance.html.markdown create mode 100644 config/docs/r/clb_instance_mix_ip_target_config.html.markdown create mode 100644 config/docs/r/clb_instance_sla_config.html.markdown create mode 100644 config/docs/r/clb_listener.html.markdown create mode 100644 config/docs/r/clb_listener_rule.html.markdown create mode 100644 config/docs/r/clb_log_set.html.markdown create mode 100644 config/docs/r/clb_log_topic.html.markdown create mode 100644 config/docs/r/clb_redirection.html.markdown create mode 100644 config/docs/r/clb_replace_cert_for_lbs.html.markdown create mode 100644 config/docs/r/clb_security_group_attachment.html.markdown create mode 100644 config/docs/r/clb_snat_ip.html.markdown create mode 100644 config/docs/r/clb_target_group.html.markdown create mode 100644 config/docs/r/clb_target_group_attachment.html.markdown create mode 100644 config/docs/r/clb_target_group_instance_attachment.html.markdown create mode 100644 config/docs/r/clickhouse_account.html.markdown create mode 100644 config/docs/r/clickhouse_account_permission.html.markdown create mode 100644 config/docs/r/clickhouse_backup.html.markdown create mode 100644 config/docs/r/clickhouse_backup_strategy.html.markdown create mode 100644 config/docs/r/clickhouse_delete_backup_data.html.markdown create mode 100644 config/docs/r/clickhouse_instance.html.markdown create mode 100644 config/docs/r/clickhouse_recover_backup_job.html.markdown create mode 100644 config/docs/r/cls_alarm.html.markdown create mode 100644 config/docs/r/cls_alarm_notice.html.markdown create mode 100644 config/docs/r/cls_ckafka_consumer.html.markdown create mode 100644 config/docs/r/cls_config.html.markdown create mode 100644 config/docs/r/cls_config_attachment.html.markdown create mode 100644 config/docs/r/cls_config_extra.html.markdown create mode 100644 config/docs/r/cls_cos_recharge.html.markdown create mode 100644 config/docs/r/cls_cos_shipper.html.markdown create mode 100644 config/docs/r/cls_data_transform.html.markdown create mode 100644 config/docs/r/cls_export.html.markdown create mode 100644 config/docs/r/cls_index.html.markdown create mode 100644 config/docs/r/cls_kafka_recharge.html.markdown create mode 100644 config/docs/r/cls_logset.html.markdown create mode 100644 config/docs/r/cls_machine_group.html.markdown create mode 100644 config/docs/r/cls_scheduled_sql.html.markdown create mode 100644 config/docs/r/cls_topic.html.markdown create mode 100644 config/docs/r/container_cluster.html.markdown create mode 100644 config/docs/r/container_cluster_instance.html.markdown create mode 100644 config/docs/r/cos_batch.html.markdown create mode 100644 config/docs/r/cos_bucket.html.markdown create mode 100644 config/docs/r/cos_bucket_domain_certificate_attachment.html.markdown create mode 100644 config/docs/r/cos_bucket_generate_inventory_immediately_operation.html.markdown create mode 100644 config/docs/r/cos_bucket_inventory.html.markdown create mode 100644 config/docs/r/cos_bucket_object.html.markdown create mode 100644 config/docs/r/cos_bucket_policy.html.markdown create mode 100644 config/docs/r/cos_bucket_referer.html.markdown create mode 100644 config/docs/r/cos_bucket_version.html.markdown create mode 100644 config/docs/r/cos_object_abort_multipart_upload_operation.html.markdown create mode 100644 config/docs/r/cos_object_copy_operation.html.markdown create mode 100644 config/docs/r/cos_object_download_operation.html.markdown create mode 100644 config/docs/r/cos_object_restore_operation.html.markdown create mode 100644 config/docs/r/css_authenticate_domain_owner_operation.html.markdown create mode 100644 config/docs/r/css_backup_stream.html.markdown create mode 100644 config/docs/r/css_callback_rule_attachment.html.markdown create mode 100644 config/docs/r/css_callback_template.html.markdown create mode 100644 config/docs/r/css_domain.html.markdown create mode 100644 config/docs/r/css_domain_config.html.markdown create mode 100644 config/docs/r/css_domain_referer.html.markdown create mode 100644 config/docs/r/css_enable_optimal_switching.html.markdown create mode 100644 config/docs/r/css_live_transcode_rule_attachment.html.markdown create mode 100644 config/docs/r/css_live_transcode_template.html.markdown create mode 100644 config/docs/r/css_pad_rule_attachment.html.markdown create mode 100644 config/docs/r/css_pad_template.html.markdown create mode 100644 config/docs/r/css_play_auth_key_config.html.markdown create mode 100644 config/docs/r/css_play_domain_cert_attachment.html.markdown create mode 100644 config/docs/r/css_pull_stream_task.html.markdown create mode 100644 config/docs/r/css_pull_stream_task_restart.html.markdown create mode 100644 config/docs/r/css_push_auth_key_config.html.markdown create mode 100644 config/docs/r/css_record_rule_attachment.html.markdown create mode 100644 config/docs/r/css_snapshot_rule_attachment.html.markdown create mode 100644 config/docs/r/css_snapshot_template.html.markdown create mode 100644 config/docs/r/css_start_stream_monitor.html.markdown create mode 100644 config/docs/r/css_stream_monitor.html.markdown create mode 100644 config/docs/r/css_timeshift_rule_attachment.html.markdown create mode 100644 config/docs/r/css_timeshift_template.html.markdown create mode 100644 config/docs/r/css_watermark.html.markdown create mode 100644 config/docs/r/css_watermark_rule_attachment.html.markdown create mode 100644 config/docs/r/cvm_chc_assist_vpc.html.markdown create mode 100644 config/docs/r/cvm_chc_attribute.html.markdown create mode 100644 config/docs/r/cvm_chc_config.html.markdown create mode 100644 config/docs/r/cvm_chc_deploy_vpc.html.markdown create mode 100644 config/docs/r/cvm_export_images.html.markdown create mode 100644 config/docs/r/cvm_hpc_cluster.html.markdown create mode 100644 config/docs/r/cvm_image_share_permission.html.markdown create mode 100644 config/docs/r/cvm_launch_template.html.markdown create mode 100644 config/docs/r/cvm_launch_template_default_version.html.markdown create mode 100644 config/docs/r/cvm_launch_template_version.html.markdown create mode 100644 config/docs/r/cvm_reboot_instance.html.markdown create mode 100644 config/docs/r/cvm_renew_instance.html.markdown create mode 100644 config/docs/r/cvm_security_group_attachment.html.markdown create mode 100644 config/docs/r/cvm_sync_image.html.markdown create mode 100644 config/docs/r/cwp_license_bind_attachment.html.markdown create mode 100644 config/docs/r/cwp_license_order.html.markdown create mode 100644 config/docs/r/cynosdb_account.html.markdown create mode 100644 config/docs/r/cynosdb_account_privileges.html.markdown create mode 100644 config/docs/r/cynosdb_audit_log_file.html.markdown create mode 100644 config/docs/r/cynosdb_binlog_save_days.html.markdown create mode 100644 config/docs/r/cynosdb_cluster.html.markdown create mode 100644 config/docs/r/cynosdb_cluster_databases.html.markdown create mode 100644 config/docs/r/cynosdb_cluster_password_complexity.html.markdown create mode 100644 config/docs/r/cynosdb_cluster_resource_packages_attachment.html.markdown create mode 100644 config/docs/r/cynosdb_cluster_slave_zone.html.markdown create mode 100644 config/docs/r/cynosdb_export_instance_error_logs.html.markdown create mode 100644 config/docs/r/cynosdb_export_instance_slow_queries.html.markdown create mode 100644 config/docs/r/cynosdb_instance_param.html.markdown create mode 100644 config/docs/r/cynosdb_isolate_instance.html.markdown create mode 100644 config/docs/r/cynosdb_param_template.html.markdown create mode 100644 config/docs/r/cynosdb_proxy.html.markdown create mode 100644 config/docs/r/cynosdb_proxy_end_point.html.markdown create mode 100644 config/docs/r/cynosdb_read_only_instance_exclusive_access.html.markdown create mode 100644 config/docs/r/cynosdb_readonly_instance.html.markdown create mode 100644 config/docs/r/cynosdb_reload_proxy_node.html.markdown create mode 100644 config/docs/r/cynosdb_restart_instance.html.markdown create mode 100644 config/docs/r/cynosdb_roll_back_cluster.html.markdown create mode 100644 config/docs/r/cynosdb_security_group.html.markdown create mode 100644 config/docs/r/cynosdb_upgrade_proxy_version.html.markdown create mode 100644 config/docs/r/cynosdb_wan.html.markdown create mode 100644 config/docs/r/dasb_acl.html.markdown create mode 100644 config/docs/r/dasb_bind_device_account_password.html.markdown create mode 100644 config/docs/r/dasb_bind_device_account_private_key.html.markdown create mode 100644 config/docs/r/dasb_bind_device_resource.html.markdown create mode 100644 config/docs/r/dasb_cmd_template.html.markdown create mode 100644 config/docs/r/dasb_device.html.markdown create mode 100644 config/docs/r/dasb_device_account.html.markdown create mode 100644 config/docs/r/dasb_device_group.html.markdown create mode 100644 config/docs/r/dasb_device_group_members.html.markdown create mode 100644 config/docs/r/dasb_reset_user.html.markdown create mode 100644 config/docs/r/dasb_resource.html.markdown create mode 100644 config/docs/r/dasb_user.html.markdown create mode 100644 config/docs/r/dasb_user_group.html.markdown create mode 100644 config/docs/r/dasb_user_group_members.html.markdown create mode 100644 config/docs/r/dayu_cc_http_policy.html.markdown create mode 100644 config/docs/r/dayu_cc_https_policy.html.markdown create mode 100644 config/docs/r/dayu_cc_policy_v2.html.markdown create mode 100644 config/docs/r/dayu_ddos_ip_attachment_v2.html.markdown create mode 100644 config/docs/r/dayu_ddos_policy.html.markdown create mode 100644 config/docs/r/dayu_ddos_policy_attachment.html.markdown create mode 100644 config/docs/r/dayu_ddos_policy_case.html.markdown create mode 100644 config/docs/r/dayu_ddos_policy_v2.html.markdown create mode 100644 config/docs/r/dayu_eip.html.markdown create mode 100644 config/docs/r/dayu_l4_rule.html.markdown create mode 100644 config/docs/r/dayu_l7_rule.html.markdown create mode 100644 config/docs/r/dayu_l7_rule_v2.html.markdown create mode 100644 config/docs/r/dbbrain_db_diag_report_task.html.markdown create mode 100644 config/docs/r/dbbrain_modify_diag_db_instance_operation.html.markdown create mode 100644 config/docs/r/dbbrain_security_audit_log_export_task.html.markdown create mode 100644 config/docs/r/dbbrain_sql_filter.html.markdown create mode 100644 config/docs/r/dbbrain_tdsql_audit_log.html.markdown create mode 100644 config/docs/r/dc_gateway.html.markdown create mode 100644 config/docs/r/dc_gateway_attachment.html.markdown create mode 100644 config/docs/r/dc_gateway_ccn_route.html.markdown create mode 100644 config/docs/r/dc_instance.html.markdown create mode 100644 config/docs/r/dc_internet_address.html.markdown create mode 100644 config/docs/r/dc_internet_address_config.html.markdown create mode 100644 config/docs/r/dc_share_dcx_config.html.markdown create mode 100644 config/docs/r/dcdb_account.html.markdown create mode 100644 config/docs/r/dcdb_account_privileges.html.markdown create mode 100644 config/docs/r/dcdb_activate_hour_instance_operation.html.markdown create mode 100644 config/docs/r/dcdb_cancel_dcn_job_operation.html.markdown create mode 100644 config/docs/r/dcdb_db_instance.html.markdown create mode 100644 config/docs/r/dcdb_db_parameters.html.markdown create mode 100644 config/docs/r/dcdb_db_sync_mode_config.html.markdown create mode 100644 config/docs/r/dcdb_encrypt_attributes_config.html.markdown create mode 100644 config/docs/r/dcdb_flush_binlog_operation.html.markdown create mode 100644 config/docs/r/dcdb_hourdb_instance.html.markdown create mode 100644 config/docs/r/dcdb_instance_config.html.markdown create mode 100644 config/docs/r/dcdb_isolate_hour_instance_operation.html.markdown create mode 100644 config/docs/r/dcdb_security_group_attachment.html.markdown create mode 100644 config/docs/r/dcdb_switch_db_instance_ha_operation.html.markdown create mode 100644 config/docs/r/dcx.html.markdown create mode 100644 config/docs/r/dcx_extra_config.html.markdown create mode 100644 config/docs/r/dlc_add_users_to_work_group_attachment.html.markdown create mode 100644 config/docs/r/dlc_bind_work_groups_to_user_attachment.html.markdown create mode 100644 config/docs/r/dlc_data_engine.html.markdown create mode 100644 config/docs/r/dlc_modify_data_engine_description_operation.html.markdown create mode 100644 config/docs/r/dlc_modify_user_typ_operation.html.markdown create mode 100644 config/docs/r/dlc_renew_data_engine_operation.html.markdown create mode 100644 config/docs/r/dlc_restart_data_engine_operation.html.markdown create mode 100644 config/docs/r/dlc_rollback_data_engine_image_operation.html.markdown create mode 100644 config/docs/r/dlc_store_location_config.html.markdown create mode 100644 config/docs/r/dlc_suspend_resume_data_engine.html.markdown create mode 100644 config/docs/r/dlc_switch_data_engine_image_operation.html.markdown create mode 100644 config/docs/r/dlc_update_data_engine_config_operation.html.markdown create mode 100644 config/docs/r/dlc_update_row_filter_operation.html.markdown create mode 100644 config/docs/r/dlc_upgrade_data_engine_image_operation.html.markdown create mode 100644 config/docs/r/dlc_user.html.markdown create mode 100644 config/docs/r/dlc_user_data_engine_config.html.markdown create mode 100644 config/docs/r/dlc_work_group.html.markdown create mode 100644 config/docs/r/dnat.html.markdown create mode 100644 config/docs/r/dnspod_custom_line.html.markdown create mode 100644 config/docs/r/dnspod_domain_alias.html.markdown create mode 100644 config/docs/r/dnspod_domain_instance.html.markdown create mode 100644 config/docs/r/dnspod_domain_lock.html.markdown create mode 100644 config/docs/r/dnspod_download_snapshot_operation.html.markdown create mode 100644 config/docs/r/dnspod_modify_domain_owner_operation.html.markdown create mode 100644 config/docs/r/dnspod_modify_record_group_operation.html.markdown create mode 100644 config/docs/r/dnspod_record.html.markdown create mode 100644 config/docs/r/dnspod_record_group.html.markdown create mode 100644 config/docs/r/dnspod_snapshot_config.html.markdown create mode 100644 config/docs/r/dts_compare_task.html.markdown create mode 100644 config/docs/r/dts_compare_task_stop_operation.html.markdown create mode 100644 config/docs/r/dts_migrate_job.html.markdown create mode 100644 config/docs/r/dts_migrate_job_config.html.markdown create mode 100644 config/docs/r/dts_migrate_job_resume_operation.html.markdown create mode 100644 config/docs/r/dts_migrate_job_start_operation.html.markdown create mode 100644 config/docs/r/dts_migrate_service.html.markdown create mode 100644 config/docs/r/dts_sync_check_job_operation.html.markdown create mode 100644 config/docs/r/dts_sync_config.html.markdown create mode 100644 config/docs/r/dts_sync_job.html.markdown create mode 100644 config/docs/r/dts_sync_job_continue_operation.html.markdown create mode 100644 config/docs/r/dts_sync_job_isolate_operation.html.markdown create mode 100644 config/docs/r/dts_sync_job_pause_operation.html.markdown create mode 100644 config/docs/r/dts_sync_job_recover_operation.html.markdown create mode 100644 config/docs/r/dts_sync_job_resize_operation.html.markdown create mode 100644 config/docs/r/dts_sync_job_resume_operation.html.markdown create mode 100644 config/docs/r/dts_sync_job_start_operation.html.markdown create mode 100644 config/docs/r/dts_sync_job_stop_operation.html.markdown create mode 100644 config/docs/r/eb_event_bus.html.markdown create mode 100644 config/docs/r/eb_event_connector.html.markdown create mode 100644 config/docs/r/eb_event_rule.html.markdown create mode 100644 config/docs/r/eb_event_target.html.markdown create mode 100644 config/docs/r/eb_event_transform.html.markdown create mode 100644 config/docs/r/eb_put_events.html.markdown create mode 100644 config/docs/r/eip.html.markdown create mode 100644 config/docs/r/eip_address_transform.html.markdown create mode 100644 config/docs/r/eip_association.html.markdown create mode 100644 config/docs/r/eip_normal_address_return.html.markdown create mode 100644 config/docs/r/eip_public_address_adjust.html.markdown create mode 100644 config/docs/r/elasticsearch_diagnose.html.markdown create mode 100644 config/docs/r/elasticsearch_diagnose_instance.html.markdown create mode 100644 config/docs/r/elasticsearch_index.html.markdown create mode 100644 config/docs/r/elasticsearch_instance.html.markdown create mode 100644 config/docs/r/elasticsearch_logstash.html.markdown create mode 100644 config/docs/r/elasticsearch_logstash_pipeline.html.markdown create mode 100644 config/docs/r/elasticsearch_restart_instance_operation.html.markdown create mode 100644 config/docs/r/elasticsearch_restart_kibana_operation.html.markdown create mode 100644 config/docs/r/elasticsearch_restart_logstash_instance_operation.html.markdown create mode 100644 config/docs/r/elasticsearch_restart_nodes_operation.html.markdown create mode 100644 config/docs/r/elasticsearch_security_group.html.markdown create mode 100644 config/docs/r/elasticsearch_start_logstash_pipeline_operation.html.markdown create mode 100644 config/docs/r/elasticsearch_stop_logstash_pipeline_operation.html.markdown create mode 100644 config/docs/r/elasticsearch_update_plugins_operation.html.markdown create mode 100644 config/docs/r/emr_cluster.html.markdown create mode 100644 config/docs/r/emr_user_manager.html.markdown create mode 100644 config/docs/r/eni.html.markdown create mode 100644 config/docs/r/eni_attachment.html.markdown create mode 100644 config/docs/r/eni_sg_attachment.html.markdown create mode 100644 config/docs/r/gaap_certificate.html.markdown create mode 100644 config/docs/r/gaap_domain_error_page.html.markdown create mode 100644 config/docs/r/gaap_global_domain.html.markdown create mode 100644 config/docs/r/gaap_global_domain_dns.html.markdown create mode 100644 config/docs/r/gaap_http_domain.html.markdown create mode 100644 config/docs/r/gaap_http_rule.html.markdown create mode 100644 config/docs/r/gaap_layer4_listener.html.markdown create mode 100644 config/docs/r/gaap_layer7_listener.html.markdown create mode 100644 config/docs/r/gaap_proxy.html.markdown create mode 100644 config/docs/r/gaap_realserver.html.markdown create mode 100644 config/docs/r/gaap_security_policy.html.markdown create mode 100644 config/docs/r/gaap_security_rule.html.markdown create mode 100644 config/docs/r/ha_vip.html.markdown create mode 100644 config/docs/r/ha_vip_eip_attachment.html.markdown create mode 100644 config/docs/r/image.html.markdown create mode 100644 config/docs/r/instance.html.markdown create mode 100644 config/docs/r/instance_set.html.markdown create mode 100644 config/docs/r/ipv6_address_bandwidth.html.markdown create mode 100644 config/docs/r/key_pair.html.markdown create mode 100644 config/docs/r/kms_cloud_resource_attachment.html.markdown create mode 100644 config/docs/r/kms_external_key.html.markdown create mode 100644 config/docs/r/kms_key.html.markdown create mode 100644 config/docs/r/kms_overwrite_white_box_device_fingerprints.html.markdown create mode 100644 config/docs/r/kms_white_box_key.html.markdown create mode 100644 config/docs/r/kubernetes_addon_attachment.html.markdown create mode 100644 config/docs/r/kubernetes_auth_attachment.html.markdown create mode 100644 config/docs/r/kubernetes_backup_storage_location.html.markdown create mode 100644 config/docs/r/kubernetes_cluster.html.markdown create mode 100644 config/docs/r/kubernetes_cluster_attachment.html.markdown create mode 100644 config/docs/r/kubernetes_cluster_endpoint.html.markdown create mode 100644 config/docs/r/kubernetes_encryption_protection.html.markdown create mode 100644 config/docs/r/kubernetes_node_pool.html.markdown create mode 100644 config/docs/r/kubernetes_scale_worker.html.markdown create mode 100644 config/docs/r/kubernetes_serverless_node_pool.html.markdown create mode 100644 config/docs/r/lb.html.markdown create mode 100644 config/docs/r/lighthouse_apply_disk_backup.html.markdown create mode 100644 config/docs/r/lighthouse_apply_instance_snapshot.html.markdown create mode 100644 config/docs/r/lighthouse_blueprint.html.markdown create mode 100644 config/docs/r/lighthouse_disk.html.markdown create mode 100644 config/docs/r/lighthouse_disk_attachment.html.markdown create mode 100644 config/docs/r/lighthouse_disk_backup.html.markdown create mode 100644 config/docs/r/lighthouse_firewall_rule.html.markdown create mode 100644 config/docs/r/lighthouse_firewall_template.html.markdown create mode 100644 config/docs/r/lighthouse_instance.html.markdown create mode 100644 config/docs/r/lighthouse_key_pair.html.markdown create mode 100644 config/docs/r/lighthouse_key_pair_attachment.html.markdown create mode 100644 config/docs/r/lighthouse_reboot_instance.html.markdown create mode 100644 config/docs/r/lighthouse_renew_disk.html.markdown create mode 100644 config/docs/r/lighthouse_renew_instance.html.markdown create mode 100644 config/docs/r/lighthouse_snapshot.html.markdown create mode 100644 config/docs/r/lighthouse_start_instance.html.markdown create mode 100644 config/docs/r/lighthouse_stop_instance.html.markdown create mode 100644 config/docs/r/mariadb_account.html.markdown create mode 100644 config/docs/r/mariadb_account_privileges.html.markdown create mode 100644 config/docs/r/mariadb_activate_hour_db_instance.html.markdown create mode 100644 config/docs/r/mariadb_backup_time.html.markdown create mode 100644 config/docs/r/mariadb_cancel_dcn_job.html.markdown create mode 100644 config/docs/r/mariadb_clone_account.html.markdown create mode 100644 config/docs/r/mariadb_close_db_extranet_access.html.markdown create mode 100644 config/docs/r/mariadb_copy_account_privileges.html.markdown create mode 100644 config/docs/r/mariadb_create_tmp_instance.html.markdown create mode 100644 config/docs/r/mariadb_dedicatedcluster_db_instance.html.markdown create mode 100644 config/docs/r/mariadb_flush_binlog.html.markdown create mode 100644 config/docs/r/mariadb_grant_account_privileges.html.markdown create mode 100644 config/docs/r/mariadb_hour_db_instance.html.markdown create mode 100644 config/docs/r/mariadb_instance.html.markdown create mode 100644 config/docs/r/mariadb_instance_config.html.markdown create mode 100644 config/docs/r/mariadb_log_file_retention_period.html.markdown create mode 100644 config/docs/r/mariadb_operate_hour_db_instance.html.markdown create mode 100644 config/docs/r/mariadb_parameters.html.markdown create mode 100644 config/docs/r/mariadb_renew_instance.html.markdown create mode 100644 config/docs/r/mariadb_restart_instance.html.markdown create mode 100644 config/docs/r/mariadb_security_groups.html.markdown create mode 100644 config/docs/r/mariadb_switch_ha.html.markdown create mode 100644 config/docs/r/mdl_stream_live_input.html.markdown create mode 100644 config/docs/r/mongodb_instance.html.markdown create mode 100644 config/docs/r/mongodb_instance_account.html.markdown create mode 100644 config/docs/r/mongodb_instance_backup.html.markdown create mode 100644 config/docs/r/mongodb_sharding_instance.html.markdown create mode 100644 config/docs/r/mongodb_standby_instance.html.markdown create mode 100644 config/docs/r/monitor_alarm_notice.html.markdown create mode 100644 config/docs/r/monitor_alarm_policy.html.markdown create mode 100644 config/docs/r/monitor_alarm_policy_set_default.html.markdown create mode 100644 config/docs/r/monitor_binding_object.html.markdown create mode 100644 config/docs/r/monitor_binding_receiver.html.markdown create mode 100644 config/docs/r/monitor_grafana_dns_config.html.markdown create mode 100644 config/docs/r/monitor_grafana_env_config.html.markdown create mode 100644 config/docs/r/monitor_grafana_instance.html.markdown create mode 100644 config/docs/r/monitor_grafana_integration.html.markdown create mode 100644 config/docs/r/monitor_grafana_notification_channel.html.markdown create mode 100644 config/docs/r/monitor_grafana_plugin.html.markdown create mode 100644 config/docs/r/monitor_grafana_sso_account.html.markdown create mode 100644 config/docs/r/monitor_grafana_sso_cam_config.html.markdown create mode 100644 config/docs/r/monitor_grafana_sso_config.html.markdown create mode 100644 config/docs/r/monitor_grafana_version_upgrade.html.markdown create mode 100644 config/docs/r/monitor_grafana_whitelist_config.html.markdown create mode 100644 config/docs/r/monitor_policy_binding_object.html.markdown create mode 100644 config/docs/r/monitor_tmp_alert_rule.html.markdown create mode 100644 config/docs/r/monitor_tmp_cvm_agent.html.markdown create mode 100644 config/docs/r/monitor_tmp_exporter_integration.html.markdown create mode 100644 config/docs/r/monitor_tmp_grafana_config.html.markdown create mode 100644 config/docs/r/monitor_tmp_instance.html.markdown create mode 100644 config/docs/r/monitor_tmp_manage_grafana_attachment.html.markdown create mode 100644 config/docs/r/monitor_tmp_recording_rule.html.markdown create mode 100644 config/docs/r/monitor_tmp_scrape_job.html.markdown create mode 100644 config/docs/r/monitor_tmp_tke_alert_policy.html.markdown create mode 100644 config/docs/r/monitor_tmp_tke_basic_config.html.markdown create mode 100644 config/docs/r/monitor_tmp_tke_cluster_agent.html.markdown create mode 100644 config/docs/r/monitor_tmp_tke_config.html.markdown create mode 100644 config/docs/r/monitor_tmp_tke_global_notification.html.markdown create mode 100644 config/docs/r/monitor_tmp_tke_record_rule_yaml.html.markdown create mode 100644 config/docs/r/monitor_tmp_tke_template.html.markdown create mode 100644 config/docs/r/monitor_tmp_tke_template_attachment.html.markdown create mode 100644 config/docs/r/mps_adaptive_dynamic_streaming_template.html.markdown create mode 100644 config/docs/r/mps_ai_analysis_template.html.markdown create mode 100644 config/docs/r/mps_ai_recognition_template.html.markdown create mode 100644 config/docs/r/mps_animated_graphics_template.html.markdown create mode 100644 config/docs/r/mps_content_review_template.html.markdown create mode 100644 config/docs/r/mps_edit_media_operation.html.markdown create mode 100644 config/docs/r/mps_enable_schedule_config.html.markdown create mode 100644 config/docs/r/mps_enable_workflow_config.html.markdown create mode 100644 config/docs/r/mps_event.html.markdown create mode 100644 config/docs/r/mps_execute_function_operation.html.markdown create mode 100644 config/docs/r/mps_flow.html.markdown create mode 100644 config/docs/r/mps_image_sprite_template.html.markdown create mode 100644 config/docs/r/mps_input.html.markdown create mode 100644 config/docs/r/mps_manage_task_operation.html.markdown create mode 100644 config/docs/r/mps_output.html.markdown create mode 100644 config/docs/r/mps_person_sample.html.markdown create mode 100644 config/docs/r/mps_process_live_stream_operation.html.markdown create mode 100644 config/docs/r/mps_process_media_operation.html.markdown create mode 100644 config/docs/r/mps_sample_snapshot_template.html.markdown create mode 100644 config/docs/r/mps_schedule.html.markdown create mode 100644 config/docs/r/mps_snapshot_by_timeoffset_template.html.markdown create mode 100644 config/docs/r/mps_start_flow_operation.html.markdown create mode 100644 config/docs/r/mps_transcode_template.html.markdown create mode 100644 config/docs/r/mps_watermark_template.html.markdown create mode 100644 config/docs/r/mps_withdraws_watermark_operation.html.markdown create mode 100644 config/docs/r/mps_word_sample.html.markdown create mode 100644 config/docs/r/mps_workflow.html.markdown create mode 100644 config/docs/r/mysql_account.html.markdown create mode 100644 config/docs/r/mysql_account_privilege.html.markdown create mode 100644 config/docs/r/mysql_audit_log_file.html.markdown create mode 100644 config/docs/r/mysql_backup_download_restriction.html.markdown create mode 100644 config/docs/r/mysql_backup_encryption_status.html.markdown create mode 100644 config/docs/r/mysql_backup_policy.html.markdown create mode 100644 config/docs/r/mysql_database.html.markdown create mode 100644 config/docs/r/mysql_deploy_group.html.markdown create mode 100644 config/docs/r/mysql_dr_instance_to_mater.html.markdown create mode 100644 config/docs/r/mysql_instance.html.markdown create mode 100644 config/docs/r/mysql_instance_encryption_operation.html.markdown create mode 100644 config/docs/r/mysql_isolate_instance.html.markdown create mode 100644 config/docs/r/mysql_local_binlog_config.html.markdown create mode 100644 config/docs/r/mysql_param_template.html.markdown create mode 100644 config/docs/r/mysql_password_complexity.html.markdown create mode 100644 config/docs/r/mysql_privilege.html.markdown create mode 100644 config/docs/r/mysql_proxy.html.markdown create mode 100644 config/docs/r/mysql_readonly_instance.html.markdown create mode 100644 config/docs/r/mysql_reload_balance_proxy_node.html.markdown create mode 100644 config/docs/r/mysql_remote_backup_config.html.markdown create mode 100644 config/docs/r/mysql_renew_db_instance_operation.html.markdown create mode 100644 config/docs/r/mysql_reset_root_account.html.markdown create mode 100644 config/docs/r/mysql_restart_db_instances_operation.html.markdown create mode 100644 config/docs/r/mysql_ro_group.html.markdown create mode 100644 config/docs/r/mysql_ro_group_load_operation.html.markdown create mode 100644 config/docs/r/mysql_ro_instance_ip.html.markdown create mode 100644 config/docs/r/mysql_ro_start_replication.html.markdown create mode 100644 config/docs/r/mysql_ro_stop_replication.html.markdown create mode 100644 config/docs/r/mysql_rollback.html.markdown create mode 100644 config/docs/r/mysql_rollback_stop.html.markdown create mode 100644 config/docs/r/mysql_security_groups_attachment.html.markdown create mode 100644 config/docs/r/mysql_switch_for_upgrade.html.markdown create mode 100644 config/docs/r/mysql_switch_master_slave_operation.html.markdown create mode 100644 config/docs/r/mysql_time_window.html.markdown create mode 100644 config/docs/r/mysql_verify_root_account.html.markdown create mode 100644 config/docs/r/nat_gateway.html.markdown create mode 100644 config/docs/r/nat_gateway_snat.html.markdown create mode 100644 config/docs/r/nat_refresh_nat_dc_route.html.markdown create mode 100644 config/docs/r/oceanus_job.html.markdown create mode 100644 config/docs/r/oceanus_job_config.html.markdown create mode 100644 config/docs/r/oceanus_job_copy.html.markdown create mode 100644 config/docs/r/oceanus_resource.html.markdown create mode 100644 config/docs/r/oceanus_resource_config.html.markdown create mode 100644 config/docs/r/oceanus_run_job.html.markdown create mode 100644 config/docs/r/oceanus_stop_job.html.markdown create mode 100644 config/docs/r/oceanus_trigger_job_savepoint.html.markdown create mode 100644 config/docs/r/oceanus_work_space.html.markdown create mode 100644 config/docs/r/organization_instance.html.markdown create mode 100644 config/docs/r/organization_org_identity.html.markdown create mode 100644 config/docs/r/organization_org_member.html.markdown create mode 100644 config/docs/r/organization_org_member_auth_identity_attachment.html.markdown create mode 100644 config/docs/r/organization_org_member_email.html.markdown create mode 100644 config/docs/r/organization_org_member_policy_attachment.html.markdown create mode 100644 config/docs/r/organization_org_node.html.markdown create mode 100644 config/docs/r/organization_policy_sub_account_attachment.html.markdown create mode 100644 config/docs/r/organization_quit_organization_operation.html.markdown create mode 100644 config/docs/r/placement_group.html.markdown create mode 100644 config/docs/r/postgresql_backup_download_restriction_config.html.markdown create mode 100644 config/docs/r/postgresql_backup_plan_config.html.markdown create mode 100644 config/docs/r/postgresql_base_backup.html.markdown create mode 100644 config/docs/r/postgresql_clone_db_instance_operation.html.markdown create mode 100644 config/docs/r/postgresql_delete_log_backup_operation.html.markdown create mode 100644 config/docs/r/postgresql_disisolate_db_instance_operation.html.markdown create mode 100644 config/docs/r/postgresql_instance.html.markdown create mode 100644 config/docs/r/postgresql_instance_network_access_attachment.html.markdown create mode 100644 config/docs/r/postgresql_isolate_db_instance_operation.html.markdown create mode 100644 config/docs/r/postgresql_modify_account_remark_operation.html.markdown create mode 100644 config/docs/r/postgresql_modify_db_instance_charge_type_operation.html.markdown create mode 100644 config/docs/r/postgresql_modify_switch_time_period_operation.html.markdown create mode 100644 config/docs/r/postgresql_parameter_template.html.markdown create mode 100644 config/docs/r/postgresql_readonly_attachment.html.markdown create mode 100644 config/docs/r/postgresql_readonly_group.html.markdown create mode 100644 config/docs/r/postgresql_readonly_group_network_access_attachment.html.markdown create mode 100644 config/docs/r/postgresql_readonly_instance.html.markdown create mode 100644 config/docs/r/postgresql_rebalance_readonly_group_operation.html.markdown create mode 100644 config/docs/r/postgresql_renew_db_instance_operation.html.markdown create mode 100644 config/docs/r/postgresql_restart_db_instance_operation.html.markdown create mode 100644 config/docs/r/postgresql_security_group_config.html.markdown create mode 100644 config/docs/r/private_dns_record.html.markdown create mode 100644 config/docs/r/private_dns_zone.html.markdown create mode 100644 config/docs/r/private_dns_zone_vpc_attachment.html.markdown create mode 100644 config/docs/r/project.html.markdown create mode 100644 config/docs/r/protocol_template.html.markdown create mode 100644 config/docs/r/protocol_template_group.html.markdown create mode 100644 config/docs/r/pts_alert_channel.html.markdown create mode 100644 config/docs/r/pts_cron_job.html.markdown create mode 100644 config/docs/r/pts_cron_job_abort.html.markdown create mode 100644 config/docs/r/pts_cron_job_restart.html.markdown create mode 100644 config/docs/r/pts_file.html.markdown create mode 100644 config/docs/r/pts_job.html.markdown create mode 100644 config/docs/r/pts_job_abort.html.markdown create mode 100644 config/docs/r/pts_project.html.markdown create mode 100644 config/docs/r/pts_scenario.html.markdown create mode 100644 config/docs/r/pts_tmp_key_generate.html.markdown create mode 100644 config/docs/r/redis_account.html.markdown create mode 100644 config/docs/r/redis_backup_config.html.markdown create mode 100644 config/docs/r/redis_backup_download_restriction.html.markdown create mode 100644 config/docs/r/redis_backup_operation.html.markdown create mode 100644 config/docs/r/redis_clear_instance_operation.html.markdown create mode 100644 config/docs/r/redis_connection_config.html.markdown create mode 100644 config/docs/r/redis_instance.html.markdown create mode 100644 config/docs/r/redis_maintenance_window.html.markdown create mode 100644 config/docs/r/redis_param.html.markdown create mode 100644 config/docs/r/redis_param_template.html.markdown create mode 100644 config/docs/r/redis_read_only.html.markdown create mode 100644 config/docs/r/redis_renew_instance_operation.html.markdown create mode 100644 config/docs/r/redis_replica_readonly.html.markdown create mode 100644 config/docs/r/redis_replicate_attachment.html.markdown create mode 100644 config/docs/r/redis_security_group_attachment.html.markdown create mode 100644 config/docs/r/redis_ssl.html.markdown create mode 100644 config/docs/r/redis_startup_instance_operation.html.markdown create mode 100644 config/docs/r/redis_switch_master.html.markdown create mode 100644 config/docs/r/redis_switck_master.html.markdown create mode 100644 config/docs/r/redis_upgrade_cache_version_operation.html.markdown create mode 100644 config/docs/r/redis_upgrade_multi_zone_operation.html.markdown create mode 100644 config/docs/r/redis_upgrade_proxy_version_operation.html.markdown create mode 100644 config/docs/r/reserved_instance.html.markdown create mode 100644 config/docs/r/route_entry.html.markdown create mode 100644 config/docs/r/route_table.html.markdown create mode 100644 config/docs/r/route_table_association.html.markdown create mode 100644 config/docs/r/route_table_entry.html.markdown create mode 100644 config/docs/r/rum_instance_status_config.html.markdown create mode 100644 config/docs/r/rum_offline_log_config_attachment.html.markdown create mode 100644 config/docs/r/rum_project.html.markdown create mode 100644 config/docs/r/rum_project_status_config.html.markdown create mode 100644 config/docs/r/rum_taw_instance.html.markdown create mode 100644 config/docs/r/rum_whitelist.html.markdown create mode 100644 config/docs/r/scf_function.html.markdown create mode 100644 config/docs/r/scf_function_alias.html.markdown create mode 100644 config/docs/r/scf_function_event_invoke_config.html.markdown create mode 100644 config/docs/r/scf_function_version.html.markdown create mode 100644 config/docs/r/scf_invoke_function.html.markdown create mode 100644 config/docs/r/scf_layer.html.markdown create mode 100644 config/docs/r/scf_namespace.html.markdown create mode 100644 config/docs/r/scf_provisioned_concurrency_config.html.markdown create mode 100644 config/docs/r/scf_reserved_concurrency_config.html.markdown create mode 100644 config/docs/r/scf_sync_invoke_function.html.markdown create mode 100644 config/docs/r/scf_terminate_async_event.html.markdown create mode 100644 config/docs/r/scf_trigger_config.html.markdown create mode 100644 config/docs/r/security_group.html.markdown create mode 100644 config/docs/r/security_group_lite_rule.html.markdown create mode 100644 config/docs/r/security_group_rule.html.markdown create mode 100644 config/docs/r/security_group_rule_set.html.markdown create mode 100644 config/docs/r/ses_batch_send_email.html.markdown create mode 100644 config/docs/r/ses_black_list.html.markdown create mode 100644 config/docs/r/ses_black_list_delete.html.markdown create mode 100644 config/docs/r/ses_domain.html.markdown create mode 100644 config/docs/r/ses_email_address.html.markdown create mode 100644 config/docs/r/ses_receiver.html.markdown create mode 100644 config/docs/r/ses_send_email.html.markdown create mode 100644 config/docs/r/ses_template.html.markdown create mode 100644 config/docs/r/ses_verify_domain.html.markdown create mode 100644 config/docs/r/sms_sign.html.markdown create mode 100644 config/docs/r/sms_template.html.markdown create mode 100644 config/docs/r/sqlserver_account.html.markdown create mode 100644 config/docs/r/sqlserver_account_db_attachment.html.markdown create mode 100644 config/docs/r/sqlserver_basic_instance.html.markdown create mode 100644 config/docs/r/sqlserver_business_intelligence_file.html.markdown create mode 100644 config/docs/r/sqlserver_business_intelligence_instance.html.markdown create mode 100644 config/docs/r/sqlserver_complete_expansion.html.markdown create mode 100644 config/docs/r/sqlserver_config_backup_strategy.html.markdown create mode 100644 config/docs/r/sqlserver_config_database_cdc.html.markdown create mode 100644 config/docs/r/sqlserver_config_database_ct.html.markdown create mode 100644 config/docs/r/sqlserver_config_database_mdf.html.markdown create mode 100644 config/docs/r/sqlserver_config_delete_db.html.markdown create mode 100644 config/docs/r/sqlserver_config_instance_network.html.markdown create mode 100644 config/docs/r/sqlserver_config_instance_param.html.markdown create mode 100644 config/docs/r/sqlserver_config_instance_ro_group.html.markdown create mode 100644 config/docs/r/sqlserver_config_instance_security_groups.html.markdown create mode 100644 config/docs/r/sqlserver_config_terminate_db_instance.html.markdown create mode 100644 config/docs/r/sqlserver_database_tde.html.markdown create mode 100644 config/docs/r/sqlserver_db.html.markdown create mode 100644 config/docs/r/sqlserver_full_backup_migration.html.markdown create mode 100644 config/docs/r/sqlserver_general_backup.html.markdown create mode 100644 config/docs/r/sqlserver_general_clone.html.markdown create mode 100644 config/docs/r/sqlserver_general_cloud_instance.html.markdown create mode 100644 config/docs/r/sqlserver_general_cloud_ro_instance.html.markdown create mode 100644 config/docs/r/sqlserver_general_communication.html.markdown create mode 100644 config/docs/r/sqlserver_incre_backup_migration.html.markdown create mode 100644 config/docs/r/sqlserver_instance.html.markdown create mode 100644 config/docs/r/sqlserver_instance_tde.html.markdown create mode 100644 config/docs/r/sqlserver_migration.html.markdown create mode 100644 config/docs/r/sqlserver_publish_subscribe.html.markdown create mode 100644 config/docs/r/sqlserver_readonly_instance.html.markdown create mode 100644 config/docs/r/sqlserver_recycle_ro_group.html.markdown create mode 100644 config/docs/r/sqlserver_renew_db_instance.html.markdown create mode 100644 config/docs/r/sqlserver_renew_postpaid_db_instance.html.markdown create mode 100644 config/docs/r/sqlserver_restart_db_instance.html.markdown create mode 100644 config/docs/r/sqlserver_restore_instance.html.markdown create mode 100644 config/docs/r/sqlserver_rollback_instance.html.markdown create mode 100644 config/docs/r/sqlserver_start_backup_full_migration.html.markdown create mode 100644 config/docs/r/sqlserver_start_backup_incremental_migration.html.markdown create mode 100644 config/docs/r/sqlserver_start_xevent.html.markdown create mode 100644 config/docs/r/ssl_certificate.html.markdown create mode 100644 config/docs/r/ssl_check_certificate_chain_operation.html.markdown create mode 100644 config/docs/r/ssl_complete_certificate_operation.html.markdown create mode 100644 config/docs/r/ssl_deploy_certificate_instance_operation.html.markdown create mode 100644 config/docs/r/ssl_deploy_certificate_record_retry_operation.html.markdown create mode 100644 config/docs/r/ssl_deploy_certificate_record_rollback_operation.html.markdown create mode 100644 config/docs/r/ssl_download_certificate_operation.html.markdown create mode 100644 config/docs/r/ssl_free_certificate.html.markdown create mode 100644 config/docs/r/ssl_pay_certificate.html.markdown create mode 100644 config/docs/r/ssl_replace_certificate_operation.html.markdown create mode 100644 config/docs/r/ssl_revoke_certificate_operation.html.markdown create mode 100644 config/docs/r/ssl_update_certificate_instance_operation.html.markdown create mode 100644 config/docs/r/ssl_update_certificate_record_retry_operation.html.markdown create mode 100644 config/docs/r/ssl_update_certificate_record_rollback_operation.html.markdown create mode 100644 config/docs/r/ssl_upload_revoke_letter_operation.html.markdown create mode 100644 config/docs/r/ssm_product_secret.html.markdown create mode 100644 config/docs/r/ssm_rotate_product_secret.html.markdown create mode 100644 config/docs/r/ssm_secret.html.markdown create mode 100644 config/docs/r/ssm_secret_version.html.markdown create mode 100644 config/docs/r/ssm_ssh_key_pair_secret.html.markdown create mode 100644 config/docs/r/subnet.html.markdown create mode 100644 config/docs/r/tag.html.markdown create mode 100644 config/docs/r/tag_attachment.html.markdown create mode 100644 config/docs/r/tat_command.html.markdown create mode 100644 config/docs/r/tat_invocation_command_attachment.html.markdown create mode 100644 config/docs/r/tat_invocation_invoke_attachment.html.markdown create mode 100644 config/docs/r/tat_invoker.html.markdown create mode 100644 config/docs/r/tat_invoker_config.html.markdown create mode 100644 config/docs/r/tcaplus_cluster.html.markdown create mode 100644 config/docs/r/tcaplus_idl.html.markdown create mode 100644 config/docs/r/tcaplus_table.html.markdown create mode 100644 config/docs/r/tcaplus_tablegroup.html.markdown create mode 100644 config/docs/r/tcm_access_log_config.html.markdown create mode 100644 config/docs/r/tcm_cluster_attachment.html.markdown create mode 100644 config/docs/r/tcm_mesh.html.markdown create mode 100644 config/docs/r/tcm_prometheus_attachment.html.markdown create mode 100644 config/docs/r/tcm_tracing_config.html.markdown create mode 100644 config/docs/r/tcmq_queue.html.markdown create mode 100644 config/docs/r/tcmq_subscribe.html.markdown create mode 100644 config/docs/r/tcmq_topic.html.markdown create mode 100644 config/docs/r/tcr_create_image_signature_operation.html.markdown create mode 100644 config/docs/r/tcr_customized_domain.html.markdown create mode 100644 config/docs/r/tcr_delete_image_operation.html.markdown create mode 100644 config/docs/r/tcr_immutable_tag_rule.html.markdown create mode 100644 config/docs/r/tcr_instance.html.markdown create mode 100644 config/docs/r/tcr_manage_replication_operation.html.markdown create mode 100644 config/docs/r/tcr_namespace.html.markdown create mode 100644 config/docs/r/tcr_repository.html.markdown create mode 100644 config/docs/r/tcr_service_account.html.markdown create mode 100644 config/docs/r/tcr_tag_retention_execution_config.html.markdown create mode 100644 config/docs/r/tcr_tag_retention_rule.html.markdown create mode 100644 config/docs/r/tcr_token.html.markdown create mode 100644 config/docs/r/tcr_vpc_attachment.html.markdown create mode 100644 config/docs/r/tcr_webhook_trigger.html.markdown create mode 100644 config/docs/r/tdcpg_cluster.html.markdown create mode 100644 config/docs/r/tdcpg_instance.html.markdown create mode 100644 config/docs/r/tdmq_instance.html.markdown create mode 100644 config/docs/r/tdmq_namespace.html.markdown create mode 100644 config/docs/r/tdmq_namespace_role_attachment.html.markdown create mode 100644 config/docs/r/tdmq_rabbitmq_user.html.markdown create mode 100644 config/docs/r/tdmq_rabbitmq_vip_instance.html.markdown create mode 100644 config/docs/r/tdmq_rabbitmq_virtual_host.html.markdown create mode 100644 config/docs/r/tdmq_rocketmq_cluster.html.markdown create mode 100644 config/docs/r/tdmq_rocketmq_environment_role.html.markdown create mode 100644 config/docs/r/tdmq_rocketmq_group.html.markdown create mode 100644 config/docs/r/tdmq_rocketmq_namespace.html.markdown create mode 100644 config/docs/r/tdmq_rocketmq_role.html.markdown create mode 100644 config/docs/r/tdmq_rocketmq_topic.html.markdown create mode 100644 config/docs/r/tdmq_rocketmq_vip_instance.html.markdown create mode 100644 config/docs/r/tdmq_role.html.markdown create mode 100644 config/docs/r/tdmq_send_rocketmq_message.html.markdown create mode 100644 config/docs/r/tdmq_topic.html.markdown create mode 100644 config/docs/r/tem_app_config.html.markdown create mode 100644 config/docs/r/tem_application.html.markdown create mode 100644 config/docs/r/tem_application_service.html.markdown create mode 100644 config/docs/r/tem_environment.html.markdown create mode 100644 config/docs/r/tem_gateway.html.markdown create mode 100644 config/docs/r/tem_log_config.html.markdown create mode 100644 config/docs/r/tem_scale_rule.html.markdown create mode 100644 config/docs/r/tem_workload.html.markdown create mode 100644 config/docs/r/teo_acceleration_domain.html.markdown create mode 100644 config/docs/r/teo_application_proxy_rule.html.markdown create mode 100644 config/docs/r/teo_certificate_config.html.markdown create mode 100644 config/docs/r/teo_origin_group.html.markdown create mode 100644 config/docs/r/teo_ownership_verify.html.markdown create mode 100644 config/docs/r/teo_rule_engine.html.markdown create mode 100644 config/docs/r/teo_zone.html.markdown create mode 100644 config/docs/r/teo_zone_setting.html.markdown create mode 100644 config/docs/r/trocket_rocketmq_consumer_group.html.markdown create mode 100644 config/docs/r/trocket_rocketmq_instance.html.markdown create mode 100644 config/docs/r/trocket_rocketmq_role.html.markdown create mode 100644 config/docs/r/trocket_rocketmq_topic.html.markdown create mode 100644 config/docs/r/tse_cngw_canary_rule.html.markdown create mode 100644 config/docs/r/tse_cngw_certificate.html.markdown create mode 100644 config/docs/r/tse_cngw_gateway.html.markdown create mode 100644 config/docs/r/tse_cngw_group.html.markdown create mode 100644 config/docs/r/tse_cngw_route.html.markdown create mode 100644 config/docs/r/tse_cngw_route_rate_limit.html.markdown create mode 100644 config/docs/r/tse_cngw_service.html.markdown create mode 100644 config/docs/r/tse_cngw_service_rate_limit.html.markdown create mode 100644 config/docs/r/tse_instance.html.markdown create mode 100644 config/docs/r/tse_waf_domains.html.markdown create mode 100644 config/docs/r/tse_waf_protection.html.markdown create mode 100644 config/docs/r/tsf_api_group.html.markdown create mode 100644 config/docs/r/tsf_api_rate_limit_rule.html.markdown create mode 100644 config/docs/r/tsf_application.html.markdown create mode 100644 config/docs/r/tsf_application_config.html.markdown create mode 100644 config/docs/r/tsf_application_file_config.html.markdown create mode 100644 config/docs/r/tsf_application_file_config_release.html.markdown create mode 100644 config/docs/r/tsf_application_public_config.html.markdown create mode 100644 config/docs/r/tsf_application_public_config_release.html.markdown create mode 100644 config/docs/r/tsf_application_release_config.html.markdown create mode 100644 config/docs/r/tsf_bind_api_group.html.markdown create mode 100644 config/docs/r/tsf_cluster.html.markdown create mode 100644 config/docs/r/tsf_config_template.html.markdown create mode 100644 config/docs/r/tsf_contain_group.html.markdown create mode 100644 config/docs/r/tsf_deploy_container_group.html.markdown create mode 100644 config/docs/r/tsf_deploy_vm_group.html.markdown create mode 100644 config/docs/r/tsf_enable_unit_rule.html.markdown create mode 100644 config/docs/r/tsf_group.html.markdown create mode 100644 config/docs/r/tsf_instances_attachment.html.markdown create mode 100644 config/docs/r/tsf_lane.html.markdown create mode 100644 config/docs/r/tsf_lane_rule.html.markdown create mode 100644 config/docs/r/tsf_microservice.html.markdown create mode 100644 config/docs/r/tsf_namespace.html.markdown create mode 100644 config/docs/r/tsf_operate_container_group.html.markdown create mode 100644 config/docs/r/tsf_operate_group.html.markdown create mode 100644 config/docs/r/tsf_path_rewrite.html.markdown create mode 100644 config/docs/r/tsf_release_api_group.html.markdown create mode 100644 config/docs/r/tsf_repository.html.markdown create mode 100644 config/docs/r/tsf_task.html.markdown create mode 100644 config/docs/r/tsf_unit_namespace.html.markdown create mode 100644 config/docs/r/tsf_unit_rule.html.markdown create mode 100644 config/docs/r/vod_adaptive_dynamic_streaming_template.html.markdown create mode 100644 config/docs/r/vod_image_sprite_template.html.markdown create mode 100644 config/docs/r/vod_procedure_template.html.markdown create mode 100644 config/docs/r/vod_snapshot_by_time_offset_template.html.markdown create mode 100644 config/docs/r/vod_sub_application.html.markdown create mode 100644 config/docs/r/vod_super_player_config.html.markdown create mode 100644 config/docs/r/vpc.html.markdown create mode 100644 config/docs/r/vpc_acl.html.markdown create mode 100644 config/docs/r/vpc_acl_attachment.html.markdown create mode 100644 config/docs/r/vpc_bandwidth_package.html.markdown create mode 100644 config/docs/r/vpc_bandwidth_package_attachment.html.markdown create mode 100644 config/docs/r/vpc_dhcp_ip.html.markdown create mode 100644 config/docs/r/vpc_enable_end_point_connect.html.markdown create mode 100644 config/docs/r/vpc_end_point.html.markdown create mode 100644 config/docs/r/vpc_end_point_service.html.markdown create mode 100644 config/docs/r/vpc_end_point_service_white_list.html.markdown create mode 100644 config/docs/r/vpc_flow_log.html.markdown create mode 100644 config/docs/r/vpc_flow_log_config.html.markdown create mode 100644 config/docs/r/vpc_ipv6_cidr_block.html.markdown create mode 100644 config/docs/r/vpc_ipv6_eni_address.html.markdown create mode 100644 config/docs/r/vpc_ipv6_subnet_cidr_block.html.markdown create mode 100644 config/docs/r/vpc_local_gateway.html.markdown create mode 100644 config/docs/r/vpc_net_detect.html.markdown create mode 100644 config/docs/r/vpc_resume_snapshot_instance.html.markdown create mode 100644 config/docs/r/vpc_snapshot_policy.html.markdown create mode 100644 config/docs/r/vpc_snapshot_policy_attachment.html.markdown create mode 100644 config/docs/r/vpc_snapshot_policy_config.html.markdown create mode 100644 config/docs/r/vpc_traffic_package.html.markdown create mode 100644 config/docs/r/vpn_connection.html.markdown create mode 100644 config/docs/r/vpn_connection_reset.html.markdown create mode 100644 config/docs/r/vpn_customer_gateway.html.markdown create mode 100644 config/docs/r/vpn_customer_gateway_configuration_download.html.markdown create mode 100644 config/docs/r/vpn_gateway.html.markdown create mode 100644 config/docs/r/vpn_gateway_ccn_routes.html.markdown create mode 100644 config/docs/r/vpn_gateway_route.html.markdown create mode 100644 config/docs/r/vpn_gateway_ssl_client_cert.html.markdown create mode 100644 config/docs/r/vpn_ssl_client.html.markdown create mode 100644 config/docs/r/vpn_ssl_server.html.markdown create mode 100644 config/docs/r/waf_anti_fake.html.markdown create mode 100644 config/docs/r/waf_anti_info_leak.html.markdown create mode 100644 config/docs/r/waf_auto_deny_rules.html.markdown create mode 100644 config/docs/r/waf_cc.html.markdown create mode 100644 config/docs/r/waf_cc_auto_status.html.markdown create mode 100644 config/docs/r/waf_cc_session.html.markdown create mode 100644 config/docs/r/waf_clb_domain.html.markdown create mode 100644 config/docs/r/waf_clb_instance.html.markdown create mode 100644 config/docs/r/waf_custom_rule.html.markdown create mode 100644 config/docs/r/waf_custom_white_rule.html.markdown create mode 100644 config/docs/r/waf_ip_access_control.html.markdown create mode 100644 config/docs/r/waf_modify_access_period.html.markdown create mode 100644 config/docs/r/waf_module_status.html.markdown create mode 100644 config/docs/r/waf_protection_mode.html.markdown create mode 100644 config/docs/r/waf_saas_domain.html.markdown create mode 100644 config/docs/r/waf_saas_instance.html.markdown create mode 100644 config/docs/r/waf_web_shell.html.markdown create mode 100644 config/docs/r/wedata_baseline.html.markdown create mode 100644 config/docs/r/wedata_datasource.html.markdown create mode 100644 config/docs/r/wedata_dq_rule.html.markdown create mode 100644 config/docs/r/wedata_dq_rule_template.html.markdown create mode 100644 config/docs/r/wedata_function.html.markdown create mode 100644 config/docs/r/wedata_integration_offline_task.html.markdown create mode 100644 config/docs/r/wedata_integration_realtime_task.html.markdown create mode 100644 config/docs/r/wedata_integration_task_node.html.markdown create mode 100644 config/docs/r/wedata_resource.html.markdown create mode 100644 config/docs/r/wedata_rule_template.html.markdown create mode 100644 config/docs/r/wedata_script.html.markdown diff --git a/config/docs/d/address_template_groups.html.markdown b/config/docs/d/address_template_groups.html.markdown new file mode 100644 index 0000000..5c233f1 --- /dev/null +++ b/config/docs/d/address_template_groups.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_address_template_groups" +sidebar_current: "docs-tencentcloud-datasource-address_template_groups" +description: |- + Use this data source to query detailed information of address template groups. +--- + +# tencentcloud_address_template_groups + +Use this data source to query detailed information of address template groups. + +## Example Usage + +```hcl +data "tencentcloud_address_template_groups" "name" { + name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) Id of the address template group to query. +* `name` - (Optional, String) Name of the address template group to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `group_list` - Information list of the dedicated address template groups. + * `id` - Id of the address template group. + * `name` - Name of address template group. + * `template_ids` - ID set of the address template. + + diff --git a/config/docs/d/address_templates.html.markdown b/config/docs/d/address_templates.html.markdown new file mode 100644 index 0000000..90a4112 --- /dev/null +++ b/config/docs/d/address_templates.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_address_templates" +sidebar_current: "docs-tencentcloud-datasource-address_templates" +description: |- + Use this data source to query detailed information of address templates. +--- + +# tencentcloud_address_templates + +Use this data source to query detailed information of address templates. + +## Example Usage + +```hcl +data "tencentcloud_address_templates" "name" { + name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the address template to query. +* `name` - (Optional, String) Name of the address template to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `template_list` - Information list of the dedicated address templates. + * `addresses` - Set of the addresses. + * `id` - ID of the address template. + * `name` - Name of address template. + + diff --git a/config/docs/d/antiddos_basic_device_status.html.markdown b/config/docs/d/antiddos_basic_device_status.html.markdown new file mode 100644 index 0000000..e0ccf87 --- /dev/null +++ b/config/docs/d/antiddos_basic_device_status.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Anti-DDoS" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_basic_device_status" +sidebar_current: "docs-tencentcloud-datasource-antiddos_basic_device_status" +description: |- + Use this data source to query detailed information of antiddos basic_device_status +--- + +# tencentcloud_antiddos_basic_device_status + +Use this data source to query detailed information of antiddos basic_device_status + +## Example Usage + +```hcl +data "tencentcloud_antiddos_basic_device_status" "basic_device_status" { + ip_list = [ + "127.0.0.1" + ] + filter_region = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filter_region` - (Optional, Int) Region Id. +* `id_list` - (Optional, Set: [`String`]) Named resource transfer ID. +* `ip_list` - (Optional, Set: [`String`]) Ip resource list. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `clb_data` - Note: This field may return null, indicating that a valid value cannot be obtained. + * `key` - Properties name. + * `value` - Properties value. +* `data` - Return resources and status, status code: 1- Blocking status 2- Normal status 3- Attack status. + * `key` - Properties name. + * `value` - Properties value. + + diff --git a/config/docs/d/antiddos_bgp_biz_trend.html.markdown b/config/docs/d/antiddos_bgp_biz_trend.html.markdown new file mode 100644 index 0000000..1641707 --- /dev/null +++ b/config/docs/d/antiddos_bgp_biz_trend.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Anti-DDoS" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_bgp_biz_trend" +sidebar_current: "docs-tencentcloud-datasource-antiddos_bgp_biz_trend" +description: |- + Use this data source to query detailed information of antiddos bgp_biz_trend +--- + +# tencentcloud_antiddos_bgp_biz_trend + +Use this data source to query detailed information of antiddos bgp_biz_trend + +## Example Usage + +```hcl +data "tencentcloud_antiddos_bgp_biz_trend" "bgp_biz_trend" { + business = "bgp-multip" + start_time = "2023-11-22 09:25:00" + end_time = "2023-11-22 10:25:00" + metric_name = "intraffic" + instance_id = "bgp-00000ry7" + flag = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `business` - (Required, String) Dayu sub product code (bgpip represents advanced defense IP; net represents professional version of advanced defense IP). +* `end_time` - (Required, String) Statistic end time. +* `flag` - (Required, Int) 0 represents fixed time, 1 represents custom time. +* `instance_id` - (Required, String) Antiddos InstanceId. +* `metric_name` - (Required, String) Statistic metric name, for example: intraffic, outtraffic, inpkg, outpkg. +* `start_time` - (Required, String) Statistic start time. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data_list` - Values at various time points on the graph. +* `max_data` - Returns the maximum value of an array. +* `total` - Number of values in the curve graph. + + diff --git a/config/docs/d/antiddos_list_listener.html.markdown b/config/docs/d/antiddos_list_listener.html.markdown new file mode 100644 index 0000000..b19d78b --- /dev/null +++ b/config/docs/d/antiddos_list_listener.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Anti-DDoS" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_list_listener" +sidebar_current: "docs-tencentcloud-datasource-antiddos_list_listener" +description: |- + Use this data source to query detailed information of antiddos list_listener +--- + +# tencentcloud_antiddos_list_listener + +Use this data source to query detailed information of antiddos list_listener + +## Example Usage + +```hcl +data "tencentcloud_antiddos_list_listener" "list_listener" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `layer4_listeners` - L4 listener list. + * `backend_port` - Origin port, value 1~65535. + * `frontend_port` - Forwarding port, value 1~65535. + * `instance_detail_rule` - Resource instance to which the rule belongs. + * `cname` - Instance cname. + * `eip_list` - Resource instance ip. + * `instance_id` - InstanceId. + * `instance_details` - Resource instance. + * `eip_list` - Instance ip. + * `instance_id` - InstanceId. + * `protocol` - TCP or UDP. + * `real_servers` - Source server list. + * `port` - 0~65535. + * `real_server` - Source server addr, ip or domain. + * `rs_type` - 1: domain, 2: ip. + * `weight` - The return weight of the source station, ranging from 1 to 100. +* `layer7_listeners` - Layer 7 forwarding listener list. + * `domain` - Domain. + * `instance_detail_rule` - Resource instance to which the rule belongs. + * `cname` - Cname. + * `eip_list` - Instance ip list. + * `instance_id` - Instance id. + * `instance_details` - InstanceDetails. + * `eip_list` - Instance ip list. + * `instance_id` - Instance id. + * `protocol` - Protocol. + * `proxy_type_list` - List of forwarding types. + * `proxy_ports` - Forwarding listening port list, port value is 1~65535. + * `proxy_type` - Http, https. + * `real_servers` - Source server list. + * `port` - 0-65535. + * `real_server` - Source server list. + * `rs_type` - 1: domain, 2: ip. + * `weight` - Weight: 1-100. + * `vport` - Port. + + diff --git a/config/docs/d/antiddos_overview_attack_trend.html.markdown b/config/docs/d/antiddos_overview_attack_trend.html.markdown new file mode 100644 index 0000000..e5c78bd --- /dev/null +++ b/config/docs/d/antiddos_overview_attack_trend.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Anti-DDoS" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_overview_attack_trend" +sidebar_current: "docs-tencentcloud-datasource-antiddos_overview_attack_trend" +description: |- + Use this data source to query detailed information of antiddos overview_attack_trend +--- + +# tencentcloud_antiddos_overview_attack_trend + +Use this data source to query detailed information of antiddos overview_attack_trend + +## Example Usage + +```hcl +data "tencentcloud_antiddos_overview_attack_trend" "overview_attack_trend" { + type = "ddos" + dimension = "attackcount" + period = 86400 + start_time = "2023-11-21 10:28:31" + end_time = "2023-11-22 10:28:31" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dimension` - (Required, String) Latitude, currently only attackcount is supported. +* `end_time` - (Required, String) Protection Overview Attack Trend End Time. +* `period` - (Required, Int) Period, currently only 86400 is supported. +* `start_time` - (Required, String) Protection Overview Attack Trend Start Time. +* `type` - (Required, String) Attack type: cc, ddos. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Number of attacks per cycle point. +* `period_point_count` - Number of period points included. + + diff --git a/config/docs/d/antiddos_overview_cc_trend.html.markdown b/config/docs/d/antiddos_overview_cc_trend.html.markdown new file mode 100644 index 0000000..8d0c972 --- /dev/null +++ b/config/docs/d/antiddos_overview_cc_trend.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_overview_cc_trend" +sidebar_current: "docs-tencentcloud-datasource-antiddos_overview_cc_trend" +description: |- + Use this data source to query detailed information of antiddos overview_cc_trend +--- + +# tencentcloud_antiddos_overview_cc_trend + +Use this data source to query detailed information of antiddos overview_cc_trend + +## Example Usage + +```hcl +data "tencentcloud_antiddos_overview_cc_trend" "overview_cc_trend" { + period = 300 + start_time = "2023-11-20 00:00:00" + end_time = "2023-11-21 00:00:00" + metric_name = "inqps" + business = "bgpip" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) EndTime. +* `metric_name` - (Required, String) Indicator, values [inqps (peak total requests, dropqps (peak attack requests)), incount (number of requests), dropcount (number of attacks)]. +* `period` - (Required, Int) Statistical granularity, values [300 (5 minutes), 3600 (hours), 86400 (days)]. +* `start_time` - (Required, String) StartTime. +* `business` - (Optional, String) Dayu sub product code (bgpip represents advanced defense IP; net represents professional version of advanced defense IP). +* `ip_list` - (Optional, Set: [`String`]) resource id list. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Data. + + diff --git a/config/docs/d/antiddos_overview_ddos_event_list.html.markdown b/config/docs/d/antiddos_overview_ddos_event_list.html.markdown new file mode 100644 index 0000000..3bb680f --- /dev/null +++ b/config/docs/d/antiddos_overview_ddos_event_list.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_overview_ddos_event_list" +sidebar_current: "docs-tencentcloud-datasource-antiddos_overview_ddos_event_list" +description: |- + Use this data source to query detailed information of antiddos overview_ddos_event_list +--- + +# tencentcloud_antiddos_overview_ddos_event_list + +Use this data source to query detailed information of antiddos overview_ddos_event_list + +## Example Usage + +```hcl +data "tencentcloud_antiddos_overview_ddos_event_list" "overview_ddos_event_list" { + start_time = "2023-11-20 00:00:00" + end_time = "2023-11-21 00:00:00" + attack_status = "end" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) EndTime. +* `start_time` - (Required, String) StartTime. +* `attack_status` - (Optional, String) filter event by attack status, start: attacking; end: attack end. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `event_list` - EventList. + * `attack_status` - Attack status, 0: Under attack; 1: End of attack. + * `attack_type` - AttackType. + * `business` - Dayu sub product code (bgpip represents advanced defense IP; net represents professional version of advanced defense IP). + * `end_time` - EndTime. + * `id` - event id. + * `instance_id` - InstanceId. + * `instance_name` - InstanceId. + * `mbps` - Attack traffic, unit Mbps. + * `pps` - unit Mbps. + * `start_time` - StartTime. + * `vip` - ip. + + diff --git a/config/docs/d/antiddos_overview_ddos_trend.html.markdown b/config/docs/d/antiddos_overview_ddos_trend.html.markdown new file mode 100644 index 0000000..dcb630d --- /dev/null +++ b/config/docs/d/antiddos_overview_ddos_trend.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_overview_ddos_trend" +sidebar_current: "docs-tencentcloud-datasource-antiddos_overview_ddos_trend" +description: |- + Use this data source to query detailed information of antiddos overview ddos trend +--- + +# tencentcloud_antiddos_overview_ddos_trend + +Use this data source to query detailed information of antiddos overview ddos trend + +## Example Usage + +```hcl +data "tencentcloud_antiddos_overview_ddos_trend" "overview_ddos_trend" { + period = 300 + start_time = "2023-11-20 14:16:23" + end_time = "2023-11-21 14:16:23" + metric_name = "bps" + business = "bgpip" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) EndTime. +* `metric_name` - (Required, String) Indicator, value [bps (attack traffic bandwidth, pps (attack packet rate)]. +* `period` - (Required, Int) Statistical granularity, values [300 (5 minutes), 3600 (hours), 86400 (days)]. +* `start_time` - (Required, String) StartTime. +* `business` - (Optional, String) Dayu sub product code (bgpip represents advanced defense IP; net represents professional version of advanced defense IP). +* `ip_list` - (Optional, Set: [`String`]) instance IpList. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Array, attack traffic bandwidth in Mbps, packet rate in pps. + + diff --git a/config/docs/d/antiddos_overview_index.html.markdown b/config/docs/d/antiddos_overview_index.html.markdown new file mode 100644 index 0000000..80ddadb --- /dev/null +++ b/config/docs/d/antiddos_overview_index.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_overview_index" +sidebar_current: "docs-tencentcloud-datasource-antiddos_overview_index" +description: |- + Use this data source to query detailed information of antiddos overview index +--- + +# tencentcloud_antiddos_overview_index + +Use this data source to query detailed information of antiddos overview index + +## Example Usage + +```hcl +data "tencentcloud_antiddos_overview_index" "overview_index" { + start_time = "2023-11-20 12:32:12" + end_time = "2023-11-21 12:32:12" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) EndTime. +* `start_time` - (Required, String) StartTime. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `all_ip_count` - ip count. +* `antiddos_domain_count` - AntiddosDomainCount. +* `antiddos_ip_count` - Total number of advanced defense IPs (including advanced defense packets and advanced defense IPs). +* `attack_domain_count` - AttackDomainCount. +* `attack_ip_count` - AttackIpCount. +* `block_ip_count` - BlockIpCount. +* `max_attack_flow` - MaxAttackFlow. +* `new_attack_ip` - The IP address in the most recent attack. +* `new_attack_time` - The time in the most recent attack. +* `new_attack_type` - The type in the most recent attack. + + diff --git a/config/docs/d/antiddos_pending_risk_info.html.markdown b/config/docs/d/antiddos_pending_risk_info.html.markdown new file mode 100644 index 0000000..2df4476 --- /dev/null +++ b/config/docs/d/antiddos_pending_risk_info.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_pending_risk_info" +sidebar_current: "docs-tencentcloud-datasource-antiddos_pending_risk_info" +description: |- + Use this data source to query detailed information of antiddos pending risk info +--- + +# tencentcloud_antiddos_pending_risk_info + +Use this data source to query detailed information of antiddos pending risk info + +## Example Usage + +```hcl +data "tencentcloud_antiddos_pending_risk_info" "pending_risk_info" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `attacking_count` - Number of resources in the attack. +* `blocking_count` - Number of resources in blockage. +* `expired_count` - Number of expired resources. +* `is_paid_usr` - Is it a paid user? True: paid user, false: regular user. +* `total` - Total number of all pending risk events. + + diff --git a/config/docs/d/api_gateway_api_app_api.html.markdown b/config/docs/d/api_gateway_api_app_api.html.markdown new file mode 100644 index 0000000..b5d0cce --- /dev/null +++ b/config/docs/d/api_gateway_api_app_api.html.markdown @@ -0,0 +1,137 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_app_api" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_api_app_api" +description: |- + Use this data source to query detailed information of apiGateway api_app_api +--- + +# tencentcloud_api_gateway_api_app_api + +Use this data source to query detailed information of apiGateway api_app_api + +## Example Usage + +```hcl +data "tencentcloud_api_gateway_api_app_api" "example" { + service_id = "service-nxz6yync" + api_id = "api-0cvmf4x4" + api_region = "ap-guangzhou" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_id` - (Required, String) API interface unique ID. +* `api_region` - (Required, String) Api region. +* `service_id` - (Required, String) The unique ID of the service where the API resides. +* `result_output_file` - (Optional, String) Used to save apiAppApis. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - API details. + * `api_business_type` - Type of OAUTH API. Possible values are NORMAL (Business API), OAUTH (Authorization API). + * `api_desc` - Description of the API interface. + * `api_id` - API interface unique ID. + * `api_name` - The name of the API interface. + * `api_type` - API type. Possible values are NORMAL (normal API) and TSF (microservice API). + * `auth_relation_api_id` - OAUTH The unique ID of the authorization API associated with the business API. + * `auth_type` - API authentication type. Possible values are SECRET (key pair authentication), NONE (authentication-free), and OAUTH. + * `base64_encoded_trigger_rules` - Header triggers rules, and the total number of rules does not exceed 10. + * `name` - Header for encoding triggering, optional values Accept and Content_Type correspond to Accept and Content-Type in the actual data flow request header. + * `value` - An array of optional values for the header triggered by encoding. The maximum string length of the array element is 40. The elements can include numbers, English letters and special characters. The optional values for special characters are: `.` `+` ` *` `-` `/` `_` For example [ application/x-vpeg005, application/xhtml+xml, application/vnd.ms -project, application/vnd.rn-rn_music_package] etc. are all legal. + * `constant_parameters` - Constant parameters. + * `default_value` - Constant parameter default value. This parameter is only used if the ServiceType is HTTP. + * `desc` - Constant parameter description. This parameter is only used if the ServiceType is HTTP. + * `name` - Constant parameter name. This parameter is only used if the ServiceType is HTTP. + * `position` - Constant parameter position. This parameter is only used if the ServiceType is HTTP. + * `created_time` - Creation time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ. + * `enable_cors` - Whether to enable cross-domain. + * `environments` - API published environment information. + * `internal_domain` - WEBSOCKET pushback address. + * `is_base64_encoded` - Whether to enable Base64 encoding will only take effect when the backend is scf. + * `is_base64_trigger` - Whether to enable Base64-encoded header triggering will only take effect when the backend is scf. + * `is_debug_after_charge` - Whether to debug after purchase (parameters reserved in the cloud market). + * `micro_services_info` - Microservice information details. + * `micro_services` - API binding microservice list. + * `cluster_id` - Microservice cluster ID. + * `micro_service_name` - Microservice name. + * `namespace_id` - Microservice namespace ID. + * `modified_time` - Last modification time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ. + * `oauth_config` - OAUTH configuration. + * `login_redirect_url` - Redirect address, used to guide users to log in. + * `public_key` - Public key, used to verify user token. + * `token_location` - Token delivery position. + * `protocol` - The front-end request type of the API, such as HTTP or HTTPS or HTTP and HTTPS. + * `request_config` - The requested frontend configuration. + * `method` - API request method, such as GET. + * `path` - API path, such as /path. + * `request_parameters` - Front-end request parameters. + * `default_value` - API front-end parameter default value. + * `desc` - API front-end parameter remarks. + * `name` - API front-end parameter name. + * `position` - The front-end parameter position of the API, such as header. Currently supports header, query, path. + * `required` - . + * `type` - API front-end parameter type, such as String, int. + * `response_error_codes` - User-defined error code configuration. + * `code` - Custom response configuration error code. + * `converted_code` - Custom error code conversion. + * `desc` - Custom response configuration error code remarks. + * `msg` - Custom response configuration error message. + * `need_convert` - Whether it is necessary to enable error code conversion. + * `response_fail_example` - Custom response configuration failure response example. + * `response_success_example` - Custom response configuration successful response example. + * `response_type` - Return type. + * `service_config` - Backend service configuration for the API. + * `method` - API backend service request method, such as GET. If ServiceType is HTTP, this parameter is required. The front-end and back-end methods can be different. + * `path` - API backend service path, such as /path. If ServiceType is HTTP, this parameter is required. The front-end and back-end paths can be different. + * `product` - Backend type. It takes effect when vpc is enabled. Currently supported types are clb, cvm and upstream. + * `uniq_vpc_id` - The unique ID of the vpc. + * `upstream_id` - Only required when binding vpc channel. + * `url` - API&#39;s backend service url. If ServiceType is HTTP, this parameter must be passed. + * `service_desc` - A description of the service where the API resides. + * `service_id` - The unique ID of the service where the API resides. + * `service_mock_return_message` - APIs backend Mock returns information. If ServiceType is Mock, this parameter must be passed. + * `service_name` - The name of the service where the API resides. + * `service_parameters` - API backend service parameters. + * `default_value` - Default values for the APIs backend service parameters. This parameter is only used if the ServiceType is HTTP. + * `name` - The backend service parameter name of the API. This parameter will be used only if the ServiceType is HTTP. The front-end and back-end parameter names can be different. + * `position` - The backend service parameter location of the API, such as head. This parameter is only used if the ServiceType is HTTP. The front-end and back-end parameter positions can be configured differently. + * `relevant_request_parameter_desc` - Remarks on the backend service parameters of the API. This parameter is only used if the ServiceType is HTTP. + * `relevant_request_parameter_name` - The front-end parameter name corresponding to the back-end service parameter of the API. This parameter is only used if the ServiceType is HTTP. + * `relevant_request_parameter_position` - The front-end parameter position corresponding to the back-end service parameter of the API, such as head. This parameter is only used if the ServiceType is HTTP. + * `service_scf_function_name` - Scf function name. Effective when the backend type is SCF. + * `service_scf_function_namespace` - Scf function namespace. Effective when the backend type is SCF. + * `service_scf_function_qualifier` - Scf function version. Effective when the backend type is SCF. + * `service_scf_is_integrated_response` - Whether to enable integrated response. + * `service_timeout` - The backend service timeout of the API, in seconds. + * `service_tsf_health_check_conf` - Health check configuration for microservices. + * `error_threshold_percentage` - Threshold percentage. + * `is_health_check` - Whether to enable health check. + * `request_volume_threshold` - Health check threshold. + * `sleep_window_in_milliseconds` - Window size. + * `service_tsf_load_balance_conf` - Load balancing configuration for microservices. + * `is_load_balance` - Whether to enable load balancing. + * `method` - Load balancing method. + * `session_stick_required` - Whether to enable session persistence. + * `session_stick_timeout` - Session retention timeout. + * `service_type` - The backend service type of the API. Possible values are HTTP, MOCK, TSF, CLB, SCF, WEBSOCKET, and TARGET (internal testing). + * `service_websocket_cleanup_function_name` - Scf websocket cleaning function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF. + * `service_websocket_cleanup_function_namespace` - Scf websocket cleanup function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF. + * `service_websocket_cleanup_function_qualifier` - Scf websocket cleanup function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF. + * `service_websocket_register_function_name` - Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF. + * `service_websocket_register_function_namespace` - Scf websocket registration function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF. + * `service_websocket_register_function_qualifier` - Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF. + * `service_websocket_transport_function_name` - Scf websocket transfer function. Valid when the front-end type is WEBSOCKET and the back-end type is SCF. + * `service_websocket_transport_function_namespace` - Scf websocket transfer function namespace. Valid when the front-end type is WEBSOCKET and the back-end type is SCF. + * `service_websocket_transport_function_qualifier` - Scf websocket transfer function version. Valid when the front-end type is WEBSOCKET and the back-end type is SCF. + * `tags` - API binding tag information. + * `key` - Key of the label. + * `value` - The value of the note. + + diff --git a/config/docs/d/api_gateway_api_app_service.html.markdown b/config/docs/d/api_gateway_api_app_service.html.markdown new file mode 100644 index 0000000..4e4a88d --- /dev/null +++ b/config/docs/d/api_gateway_api_app_service.html.markdown @@ -0,0 +1,123 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_app_service" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_api_app_service" +description: |- + Use this data source to query detailed information of apigateway api_app_services +--- + +# tencentcloud_api_gateway_api_app_service + +Use this data source to query detailed information of apigateway api_app_services + +## Example Usage + +```hcl +data "tencentcloud_api_gateway_api_app_service" "example" { + service_id = tencentcloud_api_gateway_api.example.service_id + api_region = "ap-guangzhou" +} + +resource "tencentcloud_api_gateway_service" "example" { + service_name = "tf_example" + protocol = "http&https" + service_desc = "desc." + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_api" "example" { + service_id = tencentcloud_api_gateway_service.example.id + api_name = "tf_example" + api_desc = "my hello api update" + auth_type = "APP" + protocol = "HTTP" + enable_cors = true + request_config_path = "/user/info" + request_config_method = "POST" + request_parameters { + name = "email" + position = "QUERY" + type = "string" + desc = "desc." + default_value = "test@qq.com" + required = true + } + service_config_type = "HTTP" + service_config_timeout = 10 + service_config_url = "http://www.tencent.com" + service_config_path = "/user" + service_config_method = "POST" + response_type = "XML" + response_success_example = "success" + response_fail_example = "fail" + response_error_codes { + code = 500 + msg = "system error" + desc = "system error code" + converted_code = 5000 + need_convert = true + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_region` - (Required, String) Territory to which the service belongs. +* `service_id` - (Required, String) The unique ID of the service to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `api_id_status_set` - API list.Note: This field may return null, indicating that a valid value cannot be obtained. + * `api_business_type` - API business type.Note: This field may return null, indicating that a valid value cannot be obtained. + * `api_desc` - API DescriptionNote: This field may return null, indicating that a valid value cannot be obtained. + * `api_id` - API unique ID. + * `api_name` - API name.Note: This field may return null, indicating that a valid value cannot be obtained. + * `api_type` - API type.Note: This field may return null, indicating that a valid value cannot be obtained. + * `auth_relation_api_id` - Unique ID of the association authorization API.Note: This field may return null, indicating that a valid value cannot be obtained. + * `auth_type` - Authorization type.Note: This field may return null, indicating that a valid value cannot be obtained. + * `created_time` - Service creation time. + * `is_debug_after_charge` - Whether to debug after purchase.Note: This field may return null, indicating that a valid value cannot be obtained. + * `method` - API METHOD. + * `modified_time` - Service modification time. + * `oauth_config` - OAuth configuration information.Note: This field may return null, indicating that a valid value cannot be obtained. + * `login_redirect_url` - Redirect address, used to guide users in login operations. + * `public_key` - Public key, used to verify user tokens. + * `token_location` - Token passes the position. + * `path` - API PATH. + * `protocol` - API protocol.Note: This field may return null, indicating that a valid value cannot be obtained. + * `service_id` - Service unique ID. + * `token_location` - OAuth2.0 API request, token storage location.Note: This field may return null, indicating that a valid value cannot be obtained. + * `uniq_vpc_id` - VPC unique ID.Note: This field may return null, indicating that a valid value cannot be obtained. +* `api_total_count` - Total number of APIs.Note: This field may return null, indicating that a valid value cannot be obtained. +* `available_environments` - List of service environments.Note: This field may return null, indicating that a valid value cannot be obtained. +* `created_time` - Service creation time.Note: This field may return null, indicating that a valid value cannot be obtained. +* `inner_http_port` - Internal network access HTTP service port number. +* `inner_https_port` - Internal network access https port number. +* `internal_sub_domain` - Intranet access sub domain name. +* `ip_version` - IP version.Note: This field may return null, indicating that a valid value cannot be obtained. +* `modified_time` - Service modification time.Note: This field may return null, indicating that a valid value cannot be obtained. +* `net_types` - A list of network types, where INNER represents internal network access and OUTER represents external network access. +* `outer_sub_domain` - External network access sub domain name. +* `protocol` - Service support protocol, optional values are http, https, and http&amp;https. +* `service_desc` - Service description.Note: This field may return null, indicating that a valid value cannot be obtained. +* `service_name` - Service name.Note: This field may return null, indicating that a valid value cannot be obtained. +* `set_id` - Reserved fields.Note: This field may return null, indicating that a valid value cannot be obtained. +* `usage_plan_list` - Use a plan array.Note: This field may return null, indicating that a valid value cannot be obtained. + * `created_time` - Use planned time. + * `environment` - Environment name. + * `max_request_num_pre_sec` - Use plan qps, -1 indicates no restrictions. + * `modified_time` - Use the schedule to modify the time. + * `usage_plan_desc` - Use plan description.Note: This field may return null, indicating that a valid value cannot be obtained. + * `usage_plan_id` - Use a unique ID for the plan. + * `usage_plan_name` - Use the plan name. +* `usage_plan_total_count` - Total number of usage plans.Note: This field may return null, indicating that a valid value cannot be obtained. +* `user_type` - The user type of this service.Note: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/api_gateway_api_apps.html.markdown b/config/docs/d/api_gateway_api_apps.html.markdown new file mode 100644 index 0000000..70a5a95 --- /dev/null +++ b/config/docs/d/api_gateway_api_apps.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_apps" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_api_apps" +description: |- + Use this data source to query list information of api_gateway api_app +--- + +# tencentcloud_api_gateway_api_apps + +Use this data source to query list information of api_gateway api_app + +## Example Usage + +```hcl +data "tencentcloud_api_gateway_api_apps" "test" { + api_app_id = ["app-rj8t6zx3"] + api_app_name = ["app_test"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_app_id` - (Optional, String) Api app ID. +* `api_app_name` - (Optional, String) Api app name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `api_app_list` - List of ApiApp. + * `api_app_desc` - ApiApp description. + * `api_app_id` - ApiApp ID. + * `api_app_key` - ApiApp key. + * `api_app_name` - ApiApp Name. + * `api_app_secret` - ApiApp secret. + * `created_time` - ApiApp create time. + * `modified_time` - ApiApp modified time. + + diff --git a/config/docs/d/api_gateway_api_docs.html.markdown b/config/docs/d/api_gateway_api_docs.html.markdown new file mode 100644 index 0000000..f4a3715 --- /dev/null +++ b/config/docs/d/api_gateway_api_docs.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_docs" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_api_docs" +description: |- + Use this data source to query list information of api_gateway api_doc +--- + +# tencentcloud_api_gateway_api_docs + +Use this data source to query list information of api_gateway api_doc + +## Example Usage + +```hcl +data "tencentcloud_api_gateway_api_docs" "my_api_doc" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `api_doc_list` - List of ApiDocs. + * `api_doc_id` - Api Doc ID. + * `api_doc_name` - Api Doc Name. + * `api_doc_status` - Api Doc Status. + + diff --git a/config/docs/d/api_gateway_api_keys.html.markdown b/config/docs/d/api_gateway_api_keys.html.markdown new file mode 100644 index 0000000..25e3017 --- /dev/null +++ b/config/docs/d/api_gateway_api_keys.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_keys" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_api_keys" +description: |- + Use this data source to query API gateway access keys. +--- + +# tencentcloud_api_gateway_api_keys + +Use this data source to query API gateway access keys. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_api_key" "test" { + secret_name = "my_api_key" + status = "on" +} + +data "tencentcloud_api_gateway_api_keys" "name" { + secret_name = tencentcloud_api_gateway_api_key.test.secret_name +} + +data "tencentcloud_api_gateway_api_keys" "id" { + api_key_id = tencentcloud_api_gateway_api_key.test.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_key_id` - (Optional, String) Created API key ID, this field is exactly the same as ID. +* `result_output_file` - (Optional, String) Used to save results. +* `secret_name` - (Optional, String) Custom key name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of API keys. + * `access_key_secret` - Created API key. + * `api_key_id` - API key ID. + * `create_time` - Creation time in the format of `YYYY-MM-DDThh:mm:ssZ` according to ISO 8601 standard. UTC time is used. + * `modify_time` - Last modified time in the format of `YYYY-MM-DDThh:mm:ssZ` according to ISO 8601 standard. UTC time is used. + * `status` - Key status. Values: `on`, `off`. + + diff --git a/config/docs/d/api_gateway_api_plugins.html.markdown b/config/docs/d/api_gateway_api_plugins.html.markdown new file mode 100644 index 0000000..92b6305 --- /dev/null +++ b/config/docs/d/api_gateway_api_plugins.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_plugins" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_api_plugins" +description: |- + Use this data source to query detailed information of apiGateway api_plugins +--- + +# tencentcloud_api_gateway_api_plugins + +Use this data source to query detailed information of apiGateway api_plugins + +## Example Usage + +```hcl +data "tencentcloud_api_gateway_api_plugins" "example" { + api_id = "api-0cvmf4x4" + service_id = "service-nxz6yync" + environment_name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_id` - (Required, String) API ID to be queried. +* `service_id` - (Required, String) The service ID to be queried. +* `environment_name` - (Optional, String) Environment information. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - API list information that the plug-in can bind. + * `attached_time` - Binding time. + * `description` - Plugin description. + * `environment` - Environment information. + * `plugin_data` - Plug-in definition statement. + * `plugin_id` - Plugin ID. + * `plugin_name` - Plugin name. + * `plugin_type` - Plugin type. + + diff --git a/config/docs/d/api_gateway_api_usage_plans.html.markdown b/config/docs/d/api_gateway_api_usage_plans.html.markdown new file mode 100644 index 0000000..a1f535d --- /dev/null +++ b/config/docs/d/api_gateway_api_usage_plans.html.markdown @@ -0,0 +1,107 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_usage_plans" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_api_usage_plans" +description: |- + Use this data source to query detailed information of apigateway api_usage_plan +--- + +# tencentcloud_api_gateway_api_usage_plans + +Use this data source to query detailed information of apigateway api_usage_plan + +## Example Usage + +```hcl +data "tencentcloud_api_gateway_api_usage_plans" "example" { + service_id = tencentcloud_api_gateway_usage_plan_attachment.example.service_id +} + +resource "tencentcloud_api_gateway_usage_plan" "example" { + usage_plan_name = "tf_example" + usage_plan_desc = "desc." + max_request_num = 100 + max_request_num_pre_sec = 10 +} + +resource "tencentcloud_api_gateway_service" "example" { + service_name = "tf_example" + protocol = "http&https" + service_desc = "desc." + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_api" "example" { + service_id = tencentcloud_api_gateway_service.example.id + api_name = "tf_example" + api_desc = "my hello api update" + auth_type = "SECRET" + protocol = "HTTP" + enable_cors = true + request_config_path = "/user/info" + request_config_method = "POST" + request_parameters { + name = "email" + position = "QUERY" + type = "string" + desc = "desc." + default_value = "test@qq.com" + required = true + } + service_config_type = "HTTP" + service_config_timeout = 10 + service_config_url = "http://www.tencent.com" + service_config_path = "/user" + service_config_method = "POST" + response_type = "XML" + response_success_example = "success" + response_fail_example = "fail" + response_error_codes { + code = 500 + msg = "system error" + desc = "system error code" + converted_code = 5000 + need_convert = true + } +} + +resource "tencentcloud_api_gateway_usage_plan_attachment" "example" { + usage_plan_id = tencentcloud_api_gateway_usage_plan.example.id + service_id = tencentcloud_api_gateway_service.example.id + environment = "release" + bind_type = "API" + api_id = tencentcloud_api_gateway_api.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `service_id` - (Required, String) The unique ID of the service to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - API binding usage plan list.Note: This field may return null, indicating that a valid value cannot be obtained. + * `api_id` - API unique ID.Note: This field may return null, indicating that a valid value cannot be obtained. + * `api_name` - API name.Note: This field may return null, indicating that a valid value cannot be obtained. + * `created_time` - Create a time using a schedule.Note: This field may return null, indicating that a valid value cannot be obtained. + * `environment` - Use the service environment bound by the plan.Note: This field may return null, indicating that a valid value cannot be obtained. + * `in_use_request_num` - The quota that has already been used.Note: This field may return null, indicating that a valid value cannot be obtained. + * `max_request_num_pre_sec` - Request QPS upper limit, -1 indicates no limit.Note: This field may return null, indicating that a valid value cannot be obtained. + * `max_request_num` - Request total quota, -1 indicates no limit.Note: This field may return null, indicating that a valid value cannot be obtained. + * `method` - API method.Note: This field may return null, indicating that a valid value cannot be obtained. + * `modified_time` - Use the last modification time of the plan.Note: This field may return null, indicating that a valid value cannot be obtained. + * `path` - API path.Note: This field may return null, indicating that a valid value cannot be obtained. + * `service_id` - Service unique ID.Note: This field may return null, indicating that a valid value cannot be obtained. + * `service_name` - Service name.Note: This field may return null, indicating that a valid value cannot be obtained. + * `usage_plan_desc` - Description of the usage plan.Note: This field may return null, indicating that a valid value cannot be obtained. + * `usage_plan_id` - Use the unique ID of the plan.Note: This field may return null, indicating that a valid value cannot be obtained. + * `usage_plan_name` - Use the name of the plan.Note: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/api_gateway_apis.html.markdown b/config/docs/d/api_gateway_apis.html.markdown new file mode 100644 index 0000000..f8efbd3 --- /dev/null +++ b/config/docs/d/api_gateway_apis.html.markdown @@ -0,0 +1,107 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_apis" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_apis" +description: |- + Use this data source to query API gateway APIs. +--- + +# tencentcloud_api_gateway_apis + +Use this data source to query API gateway APIs. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_service" "service" { + service_name = "ck" + protocol = "http&https" + service_desc = "your nice service" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_api" "api" { + service_id = tencentcloud_api_gateway_service.service.id + api_name = "hello" + api_desc = "my hello api" + auth_type = "NONE" + protocol = "HTTP" + enable_cors = true + request_config_path = "/user/info" + request_config_method = "GET" + service_config_type = "HTTP" + service_config_timeout = 15 + service_config_url = "http://www.qq.com" + service_config_path = "/user" + service_config_method = "GET" + response_type = "HTML" + response_success_example = "success" + response_fail_example = "fail" +} + +data "tencentcloud_api_gateway_apis" "id" { + service_id = tencentcloud_api_gateway_service.service.id + api_id = tencentcloud_api_gateway_api.api.id +} + +data "tencentcloud_api_gateway_apis" "name" { + service_id = tencentcloud_api_gateway_service.service.id + api_name = tencentcloud_api_gateway_api.api.api_name +} +``` + +## Argument Reference + +The following arguments are supported: + +* `service_id` - (Required, String) Service ID for query. +* `api_id` - (Optional, String) Created API ID. +* `api_name` - (Optional, String) Custom API name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of APIs. + * `api_desc` - Custom API description. + * `api_name` - Custom API name. + * `auth_type` - API authentication type. Valid values: `SECRET`, `NONE`. `SECRET` means key pair authentication, `NONE` means no authentication. + * `create_time` - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + * `enable_cors` - Whether to enable CORS. + * `modify_time` - Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + * `protocol` - API frontend request type, such as `HTTP`,`WEBSOCKET`. + * `request_config_method` - Request frontend method configuration. Like `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`ANY`. + * `request_config_path` - Request frontend path configuration. Like `/user/getinfo`. + * `request_parameters` - Frontend request parameters. + * `default_value` - Parameter default value. + * `desc` - Parameter description. + * `name` - Parameter name. + * `position` - Parameter location. + * `required` - If this parameter required. + * `type` - Parameter type. + * `response_error_codes` - Custom error code configuration. Must keep at least one after set. + * `code` - Custom response configuration error code. + * `converted_code` - Custom error code conversion. + * `desc` - Parameter description. + * `msg` - Custom response configuration error message. + * `need_convert` - Whether to enable error code conversion. Default value: `false`. + * `response_fail_example` - Response failure sample of custom response configuration. + * `response_success_example` - Successful response sample of custom response configuration. + * `response_type` - Return type. + * `service_config_method` - API backend service request method, such as `GET`. If `service_config_type` is `HTTP`, this parameter will be required. The frontend `request_config_method` and backend method `service_config_method` can be different. + * `service_config_mock_return_message` - Returned information of API backend mocking. + * `service_config_path` - API backend service path, such as /path. If `service_config_type` is `HTTP`, this parameter will be required. The frontend `request_config_path` and backend path `service_config_path` can be different. + * `service_config_product` - Backend type. This parameter takes effect when VPC is enabled. Currently, only `clb` is supported. + * `service_config_scf_function_name` - SCF function name. This parameter takes effect when `service_config_type` is `SCF`. + * `service_config_scf_function_namespace` - SCF function namespace. This parameter takes effect when `service_config_type` is `SCF`. + * `service_config_scf_function_qualifier` - SCF function version. This parameter takes effect when `service_config_type` is `SCF`. + * `service_config_timeout` - API backend service timeout period in seconds. + * `service_config_type` - API backend service type. + * `service_config_url` - API backend service url. This parameter is required when `service_config_type` is `HTTP`. + * `service_config_vpc_id` - Unique VPC ID. + * `service_id` - Which service this API belongs. Refer to resource `tencentcloud_api_gateway_service`. + + diff --git a/config/docs/d/api_gateway_bind_api_apps_status.html.markdown b/config/docs/d/api_gateway_bind_api_apps_status.html.markdown new file mode 100644 index 0000000..8334953 --- /dev/null +++ b/config/docs/d/api_gateway_bind_api_apps_status.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_bind_api_apps_status" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_bind_api_apps_status" +description: |- + Use this data source to query detailed information of apiGateway bind_api_apps_status +--- + +# tencentcloud_api_gateway_bind_api_apps_status + +Use this data source to query detailed information of apiGateway bind_api_apps_status + +## Example Usage + +```hcl +data "tencentcloud_api_gateway_bind_api_apps_status" "example" { + service_id = "service-nxz6yync" + api_ids = ["api-0cvmf4x4", "api-jvqlzolk"] + filters { + name = "ApiAppId" + values = ["app-krljp4wn"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_ids` - (Required, Set: [`String`]) Array of API IDs. +* `service_id` - (Required, String) Service ID. +* `filters` - (Optional, List) Filter conditions. Supports ApiAppId, Environment, KeyWord (can match name or ID). +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Field to be filtered. +* `values` - (Required, Set) Filter value of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - List of APIs bound by the application. + * `api_app_api_set` - Application bound API information array. + * `api_app_id` - Application ID. + * `api_app_name` - Application Name. + * `api_id` - API ID. + * `api_name` - API name. + * `api_region` - Apis region. + * `authorized_time` - Authorization binding time, expressed in accordance with the ISO8601 standard and using UTC time. The format is: YYYY-MM-DDThh:mm:ssZ. + * `environment_name` - Authorization binding environment. + * `service_id` - Service ID. + + diff --git a/config/docs/d/api_gateway_customer_domains.html.markdown b/config/docs/d/api_gateway_customer_domains.html.markdown new file mode 100644 index 0000000..146b818 --- /dev/null +++ b/config/docs/d/api_gateway_customer_domains.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_customer_domains" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_customer_domains" +description: |- + Use this data source to query API gateway domain list. +--- + +# tencentcloud_api_gateway_customer_domains + +Use this data source to query API gateway domain list. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_custom_domain" "foo" { + service_id = "service-ohxqslqe" + sub_domain = "tic-test.dnsv1.com" + protocol = "http" + net_type = "OUTER" + is_default_mapping = "false" + default_domain = "service-ohxqslqe-1259649581.gz.apigw.tencentcs.com" + path_mappings = ["/good#test", "/root#release"] +} + +data "tencentcloud_api_gateway_customer_domains" "id" { + service_id = tencentcloud_api_gateway_custom_domain.foo.service_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `service_id` - (Required, String) The service ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - Service custom domain name list. + * `certificate_id` - The certificate ID. + * `domain_name` - Domain name. + * `is_default_mapping` - Whether to use default path mapping. Valid values: `true`, `false`. `true` means to use default path mapping, `false` means to use custom path mapping. + * `is_status_on` - Domain name resolution status. Valid values: `true`, `false`. `true` means normal parsing, `false` means parsing failed. + * `net_type` - Network type. + * `path_mappings` - Domain name mapping path and environment list. + * `environment` - Release environment. + * `path` - The domain mapping path. + * `protocol` - Custom domain name agreement type. + + diff --git a/config/docs/d/api_gateway_ip_strategies.html.markdown b/config/docs/d/api_gateway_ip_strategies.html.markdown new file mode 100644 index 0000000..eed74ae --- /dev/null +++ b/config/docs/d/api_gateway_ip_strategies.html.markdown @@ -0,0 +1,83 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_ip_strategies" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_ip_strategies" +description: |- + Use this data source to query API gateway IP strategy. +--- + +# tencentcloud_api_gateway_ip_strategies + +Use this data source to query API gateway IP strategy. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_service" "service" { + service_name = "ck" + protocol = "http&https" + service_desc = "your nice service" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_ip_strategy" "test" { + service_id = tencentcloud_api_gateway_service.service.id + strategy_name = "tf_test" + strategy_type = "BLACK" + strategy_data = "9.9.9.9" +} + +data "tencentcloud_api_gateway_ip_strategies" "id" { + service_id = tencentcloud_api_gateway_ip_strategy.test.service_id +} + +data "tencentcloud_api_gateway_ip_strategies" "name" { + service_id = tencentcloud_api_gateway_ip_strategy.test.service_id + strategy_name = tencentcloud_api_gateway_ip_strategy.test.strategy_name +} +``` + +## Argument Reference + +The following arguments are supported: + +* `service_id` - (Required, String) The service ID to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `strategy_name` - (Optional, String) Name of IP policy. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of strategy. + * `attach_list` - List of bound API details. + * `api_business_type` - The type of oauth API. This field is valid when the `auth_type` is `OAUTH`, and the values are `NORMAL` (business API) and `OAUTH` (authorization API). + * `api_desc` - API interface description. + * `api_id` - The API ID. + * `api_name` - API name. + * `api_type` - API type. Valid values: `NORMAL`, `TSF`. `NORMAL` means common API, `TSF` means microservice API. + * `auth_relation_api_id` - The unique ID of the associated authorization API, which takes effect when the authType is `OAUTH` and `ApiBusinessType` is normal. Identifies the unique ID of the oauth2.0 authorization API bound to the business API. + * `auth_type` - API authentication type. Valid values: `SECRET`, `NONE`, `OAUTH`. `SECRET` means key pair authentication, `NONE` means no authentication. + * `create_time` - Creation time in the format of `YYYY-MM-DDThh:mm:ssZ` according to ISO 8601 standard. UTC time is used. + * `method` - API request method. + * `modify_time` - Last modified time in the format of `YYYY-MM-DDThh:mm:ssZ` according to ISO 8601 standard. UTC time is used. + * `oauth_config` - OAUTH configuration information. It takes effect when authType is `OAUTH`. + * `path` - API path. + * `protocol` - API protocol. + * `relation_business_api_ids` - List of business API associated with authorized API. + * `service_id` - The service ID. + * `tags` - The label information associated with the API. + * `uniq_vpc_id` - VPC unique ID. + * `vpc_id` - VPC ID. + * `bind_api_total_count` - The number of API bound to the strategy. + * `create_time` - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + * `ip_list` - The list of IP. + * `modify_time` - Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + * `service_id` - The service ID. + * `strategy_id` - The strategy ID. + * `strategy_name` - Name of the strategy. + * `strategy_type` - Type of the strategy. + + diff --git a/config/docs/d/api_gateway_plugins.html.markdown b/config/docs/d/api_gateway_plugins.html.markdown new file mode 100644 index 0000000..7f17ea3 --- /dev/null +++ b/config/docs/d/api_gateway_plugins.html.markdown @@ -0,0 +1,111 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_plugins" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_plugins" +description: |- + Use this data source to query detailed information of apigateway plugin +--- + +# tencentcloud_api_gateway_plugins + +Use this data source to query detailed information of apigateway plugin + +## Example Usage + +```hcl +data "tencentcloud_api_gateway_plugins" "example" { + service_id = tencentcloud_api_gateway_service_release.example.service_id + plugin_id = tencentcloud_api_gateway_plugin.example.id + environment_name = "release" +} + +resource "tencentcloud_api_gateway_service" "example" { + service_name = "tf_example" + protocol = "http&https" + service_desc = "desc." + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" + tags = { + testKey = "testValue" + } + release_limit = 500 + pre_limit = 500 + test_limit = 500 +} + +resource "tencentcloud_api_gateway_api" "example" { + service_id = tencentcloud_api_gateway_service.example.id + api_name = "hello" + api_desc = "my hello api" + auth_type = "NONE" + protocol = "HTTP" + enable_cors = true + request_config_path = "/user/info" + request_config_method = "GET" + + request_parameters { + name = "name" + position = "QUERY" + type = "string" + desc = "who are you?" + default_value = "tom" + required = true + } + service_config_type = "HTTP" + service_config_timeout = 15 + service_config_url = "http://www.qq.com" + service_config_path = "/user" + service_config_method = "GET" + response_type = "HTML" + response_success_example = "success" + response_fail_example = "fail" + response_error_codes { + code = 500 + msg = "system error" + desc = "system error code" + converted_code = 5000 + need_convert = true + } +} + +resource "tencentcloud_api_gateway_service_release" "example" { + service_id = tencentcloud_api_gateway_api.example.service_id + environment_name = "release" + release_desc = "desc." +} + +resource "tencentcloud_api_gateway_plugin" "example" { + plugin_name = "tf-example" + plugin_type = "IPControl" + plugin_data = jsonencode({ + "type" : "white_list", + "blocks" : "1.1.1.1", + }) + description = "desc." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `environment_name` - (Required, String) Environmental information. +* `plugin_id` - (Required, String) The plugin ID to query. +* `service_id` - (Required, String) The service ID to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - List of plugin related APIs. + * `api_id` - API ID. + * `api_name` - API name. + * `api_type` - API type. + * `attached_other_plugin` - Whether the API is bound to other plugins.Note: This field may return null, indicating that a valid value cannot be obtained. + * `is_attached` - Whether the API is bound to the current plugin.Note: This field may return null, indicating that a valid value cannot be obtained. + * `method` - API method. + * `path` - API path. + + diff --git a/config/docs/d/api_gateway_service_environment_list.html.markdown b/config/docs/d/api_gateway_service_environment_list.html.markdown new file mode 100644 index 0000000..0cb9459 --- /dev/null +++ b/config/docs/d/api_gateway_service_environment_list.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_service_environment_list" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_service_environment_list" +description: |- + Use this data source to query detailed information of apiGateway service_environment_list +--- + +# tencentcloud_api_gateway_service_environment_list + +Use this data source to query detailed information of apiGateway service_environment_list + +## Example Usage + +```hcl +data "tencentcloud_api_gateway_service_environment_list" "example" { + service_id = "service-nxz6yync" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `service_id` - (Required, String) The unique ID of the service to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Service binding environment details.Note: This field may return null, indicating that no valid value can be obtained. + * `environment_name` - Environment name. + * `status` - Release status, 1 means released, 0 means not released. + * `url` - Access path. + * `version_name` - Running version. + + diff --git a/config/docs/d/api_gateway_service_release_versions.html.markdown b/config/docs/d/api_gateway_service_release_versions.html.markdown new file mode 100644 index 0000000..13febb6 --- /dev/null +++ b/config/docs/d/api_gateway_service_release_versions.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_service_release_versions" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_service_release_versions" +description: |- + Use this data source to query detailed information of apiGateway service_release_versions +--- + +# tencentcloud_api_gateway_service_release_versions + +Use this data source to query detailed information of apiGateway service_release_versions + +## Example Usage + +```hcl +data "tencentcloud_api_gateway_service_release_versions" "example" { + service_id = "service-nxz6yync" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `service_id` - (Required, String) The unique ID of the service to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - List of service releases.Note: This field may return null, indicating that no valid value can be obtained. + * `version_desc` - Version description.Note: This field may return null, indicating that no valid value can be obtained. + * `version_name` - Version number.Note: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/api_gateway_services.html.markdown b/config/docs/d/api_gateway_services.html.markdown new file mode 100644 index 0000000..80917c4 --- /dev/null +++ b/config/docs/d/api_gateway_services.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_services" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_services" +description: |- + Use this data source to query API gateway services. +--- + +# tencentcloud_api_gateway_services + +Use this data source to query API gateway services. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_service" "service" { + service_name = "niceservice" + protocol = "http&https" + service_desc = "your nice service" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +data "tencentcloud_api_gateway_services" "name" { + service_name = tencentcloud_api_gateway_service.service.service_name +} + +data "tencentcloud_api_gateway_services" "id" { + service_id = tencentcloud_api_gateway_service.service.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `service_id` - (Optional, String) Service ID for query. +* `service_name` - (Optional, String) Service name for query. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of services. + * `create_time` - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + * `exclusive_set_name` - (**Deprecated**) It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created. + * `inner_http_port` - Port number for http access over private network. + * `inner_https_port` - Port number for https access over private network. + * `internal_sub_domain` - Private network access sub-domain name. + * `ip_version` - IP version number. + * `modify_time` - Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + * `net_type` - Network type list, which is used to specify the supported network types. Valid values: `INNER`, `OUTER`. `INNER` indicates access over private network, and `OUTER` indicates access over public network. + * `outer_sub_domain` - Public network access subdomain name. + * `protocol` - Service frontend request type. Valid values: `http`, `https`, `http&https`. + * `service_desc` - Custom service description. + * `service_id` - Custom service ID. + * `service_name` - Custom service name. + * `usage_plan_list` - A list of attach usage plans. Each element contains the following attributes: + * `api_id` - ID of the API. + * `bind_type` - Binding type. + * `usage_plan_id` - ID of the usage plan. + * `usage_plan_name` - Name of the usage plan. + + diff --git a/config/docs/d/api_gateway_throttling_apis.html.markdown b/config/docs/d/api_gateway_throttling_apis.html.markdown new file mode 100644 index 0000000..8bccdb6 --- /dev/null +++ b/config/docs/d/api_gateway_throttling_apis.html.markdown @@ -0,0 +1,96 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_throttling_apis" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_throttling_apis" +description: |- + Use this data source to query API gateway throttling APIs. +--- + +# tencentcloud_api_gateway_throttling_apis + +Use this data source to query API gateway throttling APIs. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_service" "service" { + service_name = "niceservice" + protocol = "http&https" + service_desc = "your nice service" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_api" "api" { + service_id = tencentcloud_api_gateway_service.service.id + api_name = "tf_example" + api_desc = "my hello api update" + auth_type = "SECRET" + protocol = "HTTP" + enable_cors = true + request_config_path = "/user/info" + request_config_method = "POST" + request_parameters { + name = "email" + position = "QUERY" + type = "string" + desc = "your email please?" + default_value = "tom@qq.com" + required = true + } + service_config_type = "HTTP" + service_config_timeout = 10 + service_config_url = "http://www.tencent.com" + service_config_path = "/user" + service_config_method = "POST" + response_type = "XML" + response_success_example = "success" + response_fail_example = "fail" + response_error_codes { + code = 10 + msg = "system error" + desc = "system error code" + converted_code = -10 + need_convert = true + } + + release_limit = 100 + pre_limit = 100 + test_limit = 100 +} + +data "tencentcloud_api_gateway_throttling_apis" "id" { + service_id = tencentcloud_api_gateway_api.service_id +} + +data "tencentcloud_api_gateway_throttling_apis" "foo" { + service_id = tencentcloud_api_gateway_api.service.service_id + environment_names = ["release", "test"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `environment_names` - (Optional, List: [`String`]) Environment list. +* `result_output_file` - (Optional, String) Used to save results. +* `service_id` - (Optional, String) Unique service ID of API. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of policies bound to API. + * `api_environment_strategies` - List of throttling policies bound to API. + * `api_id` - Unique API ID. + * `api_name` - Custom API name. + * `method` - API method. + * `path` - API path. + * `strategy_list` - Environment throttling information. + * `environment_name` - Environment name. + * `quota` - Throttling value. + * `service_id` - Unique service ID of API. + + diff --git a/config/docs/d/api_gateway_throttling_services.html.markdown b/config/docs/d/api_gateway_throttling_services.html.markdown new file mode 100644 index 0000000..605af1c --- /dev/null +++ b/config/docs/d/api_gateway_throttling_services.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_throttling_services" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_throttling_services" +description: |- + Use this data source to query API gateway throttling services. +--- + +# tencentcloud_api_gateway_throttling_services + +Use this data source to query API gateway throttling services. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_service" "service" { + service_name = "niceservice" + protocol = "http&https" + service_desc = "your nice service" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" + release_limit = 100 + pre_limit = 100 + test_limit = 100 +} + +data "tencentcloud_api_gateway_throttling_services" "id" { + service_id = tencentcloud_api_gateway_service.service.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `service_id` - (Optional, String) Service ID for query. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of Throttling policy. + * `environments` - A list of Throttling policy. + * `environment_name` - Environment name. + * `status` - Release status. + * `strategy` - Throttling value. + * `url` - Access service environment URL. + * `version_name` - Published version number. + * `service_id` - Service ID for query. + + diff --git a/config/docs/d/api_gateway_upstreams.html.markdown b/config/docs/d/api_gateway_upstreams.html.markdown new file mode 100644 index 0000000..b11f4bb --- /dev/null +++ b/config/docs/d/api_gateway_upstreams.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_upstreams" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_upstreams" +description: |- + Use this data source to query detailed information of apigateway upstream +--- + +# tencentcloud_api_gateway_upstreams + +Use this data source to query detailed information of apigateway upstream + +## Example Usage + +```hcl +data "tencentcloud_api_gateway_upstreams" "example" { + upstream_id = "upstream-4n5bfklc" +} +``` + +### Filtered Queries + +```hcl +data "tencentcloud_api_gateway_upstreams" "example" { + upstream_id = "upstream-4n5bfklc" + + filters { + name = "ServiceId" + values = "service-hvg0uueg" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `upstream_id` - (Required, String) Backend channel ID. +* `filters` - (Optional, List) ServiceId and ApiId filtering queries. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Fields that need to be filtered. +* `values` - (Required, Set) The filtering value of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Query Results. + * `api_id` - API Unique ID. + * `api_name` - API nameNote: This field may return null, indicating that a valid value cannot be obtained. + * `bind_time` - binding time. + * `service_id` - Service Unique ID. + * `service_name` - Service NameNote: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/api_gateway_usage_plan_environments.html.markdown b/config/docs/d/api_gateway_usage_plan_environments.html.markdown new file mode 100644 index 0000000..33322de --- /dev/null +++ b/config/docs/d/api_gateway_usage_plan_environments.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_usage_plan_environments" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_usage_plan_environments" +description: |- + Used to query the environment list bound by the plan. +--- + +# tencentcloud_api_gateway_usage_plan_environments + +Used to query the environment list bound by the plan. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_usage_plan" "plan" { + usage_plan_name = "my_plan" + usage_plan_desc = "nice plan" + max_request_num = 100 + max_request_num_pre_sec = 10 +} + +resource "tencentcloud_api_gateway_service" "service" { + service_name = "niceservice" + protocol = "http&https" + service_desc = "your nice service" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_usage_plan_attachment" "attach_service" { + usage_plan_id = tencentcloud_api_gateway_usage_plan.plan.id + service_id = tencentcloud_api_gateway_service.service.id + environment = "test" + bind_type = "SERVICE" +} + +data "tencentcloud_api_gateway_usage_plan_environments" "environment_test" { + usage_plan_id = tencentcloud_api_gateway_usage_plan_attachment.attach_service.usage_plan_id + bind_type = "SERVICE" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `usage_plan_id` - (Required, String) ID of the usage plan to be queried. +* `bind_type` - (Optional, String) Binding type. Valid values: `API`, `SERVICE`. Default value: `SERVICE`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of usage plan binding details. + * `api_id` - The API ID, this value is empty if attach service. + * `api_name` - The API name, this value is empty if attach service. + * `create_time` - Creation time in the format of `YYYY-MM-DDThh:mm:ssZ` according to ISO 8601 standard. UTC time is used. + * `environment` - The environment name. + * `method` - The API method, this value is empty if attach service. + * `modify_time` - Last modified time in the format of `YYYY-MM-DDThh:mm:ssZ` according to ISO 8601 standard. UTC time is used. + * `path` - The API path, this value is empty if attach service. + * `service_id` - The service ID. + * `service_name` - The service name. + + diff --git a/config/docs/d/api_gateway_usage_plans.html.markdown b/config/docs/d/api_gateway_usage_plans.html.markdown new file mode 100644 index 0000000..23f46c6 --- /dev/null +++ b/config/docs/d/api_gateway_usage_plans.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_usage_plans" +sidebar_current: "docs-tencentcloud-datasource-api_gateway_usage_plans" +description: |- + Use this data source to query API gateway usage plans. +--- + +# tencentcloud_api_gateway_usage_plans + +Use this data source to query API gateway usage plans. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_usage_plan" "plan" { + usage_plan_name = "my_plan" + usage_plan_desc = "nice plan" + max_request_num = 100 + max_request_num_pre_sec = 10 +} + +data "tencentcloud_api_gateway_usage_plans" "name" { + usage_plan_name = tencentcloud_api_gateway_usage_plan.plan.usage_plan_name +} + +data "tencentcloud_api_gateway_usage_plans" "id" { + usage_plan_id = tencentcloud_api_gateway_usage_plan.plan.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `usage_plan_id` - (Optional, String) ID of the usage plan. +* `usage_plan_name` - (Optional, String) Name of the usage plan. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of usage plans. + * `create_time` - Creation time in the format of `YYYY-MM-DDThh:mm:ssZ` according to ISO 8601 standard. UTC time is used. + * `max_request_num_pre_sec` - Limit of requests per second. Valid values formats: `-1`, `[1,2000]`. The default value is -1, which indicates no limit. + * `max_request_num` - Total number of requests allowed. Valid value formats: `-1`, `[1,99999999]`. The default value is -1, which indicates no limit. + * `modify_time` - Last modified time in the format of `YYYY-MM-DDThh:mm:ssZ` according to ISO 8601 standard. UTC time is used. + * `usage_plan_desc` - Custom usage plan description. + * `usage_plan_id` - ID of the usage plan. + * `usage_plan_name` - Name of the usage plan. + + diff --git a/config/docs/d/as_advices.html.markdown b/config/docs/d/as_advices.html.markdown new file mode 100644 index 0000000..e0bc0f9 --- /dev/null +++ b/config/docs/d/as_advices.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_advices" +sidebar_current: "docs-tencentcloud-datasource-as_advices" +description: |- + Use this data source to query detailed information of as advices +--- + +# tencentcloud_as_advices + +Use this data source to query detailed information of as advices + +## Example Usage + +```hcl +data "tencentcloud_as_advices" "advices" { + auto_scaling_group_ids = ["asc-lo0b94oy"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_scaling_group_ids` - (Required, Set: [`String`]) List of scaling groups to be queried. Upper limit: 100. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `auto_scaling_advice_set` - A collection of suggestions for scaling group configurations. + * `advices` - A collection of suggestions for scaling group configurations. + * `detail` - Problem Details. + * `problem` - Problem Description. + * `solution` - Recommended resolutions. + * `auto_scaling_group_id` - Auto scaling group ID. + * `level` - Scaling group warning level. Valid values: NORMAL, WARNING, CRITICAL. + + diff --git a/config/docs/d/as_instances.html.markdown b/config/docs/d/as_instances.html.markdown new file mode 100644 index 0000000..84d5adf --- /dev/null +++ b/config/docs/d/as_instances.html.markdown @@ -0,0 +1,70 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_instances" +sidebar_current: "docs-tencentcloud-datasource-as_instances" +description: |- + Use this data source to query detailed information of as instances +--- + +# tencentcloud_as_instances + +Use this data source to query detailed information of as instances + +## Example Usage + +```hcl +resource "tencentcloud_as_scaling_group" "scaling_group" { + scaling_group_name = "tf-as-group-ds-ins-basic" + configuration_id = "your_launch_configuration_id" + max_size = 1 + min_size = 1 + vpc_id = "your_vpc_id" + subnet_ids = ["your_subnet_id"] + + tags = { + "test" = "test" + } +} + +data "tencentcloud_as_instances" "instances" { + filters { + name = "auto-scaling-group-id" + values = [tencentcloud_as_scaling_group.scaling_group.id] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter conditions. If there are multiple Filters, the relationship between Filters is a logical AND (AND) relationship. If there are multiple Values in the same Filter, the relationship between Values under the same Filter is a logical OR (OR) relationship. +* `instance_ids` - (Optional, Set: [`String`]) Instance ID of the cloud server (CVM) to be queried. The limit is 100 per request. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Fields to be filtered. Valid names: `instance-id`: Filters by instance ID, `auto-scaling-group-id`: Filter by scaling group ID. +* `values` - (Required, Set) Value of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - List of instance details. + * `add_time` - The time when the instance joined the group. + * `auto_scaling_group_id` - Auto scaling group ID. + * `auto_scaling_group_name` - Auto scaling group name. + * `creation_type` - Valid values: `AUTO_CREATION`, `MANUAL_ATTACHING`. + * `health_status` - Health status, the valid values are HEALTHY and UNHEALTHY. + * `instance_id` - Instance ID. + * `instance_type` - Instance type. + * `launch_configuration_id` - Launch configuration ID. + * `launch_configuration_name` - Launch configuration name. + * `life_cycle_state` - Life cycle state. Please refer to the link for field value details: https://cloud.tencent.com/document/api/377/20453#Instance. + * `protected_from_scale_in` - Enable scale in protection. + * `version_number` - Version ID. + * `zone` - Available zone. + + diff --git a/config/docs/d/as_last_activity.html.markdown b/config/docs/d/as_last_activity.html.markdown new file mode 100644 index 0000000..49327c3 --- /dev/null +++ b/config/docs/d/as_last_activity.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_last_activity" +sidebar_current: "docs-tencentcloud-datasource-as_last_activity" +description: |- + Use this data source to query detailed information of as last_activity +--- + +# tencentcloud_as_last_activity + +Use this data source to query detailed information of as last_activity + +## Example Usage + +```hcl +data "tencentcloud_as_last_activity" "last_activity" { + auto_scaling_group_ids = ["asc-lo0b94oy"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_scaling_group_ids` - (Required, Set: [`String`]) ID list of an auto scaling group. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `activity_set` - Information set of eligible scaling activities. Scaling groups without scaling activities are not returned. For example, if there are 50 auto scaling group IDs but only 45 records are returned, it indicates that 5 of the auto scaling groups do not have scaling activities. + * `activity_id` - Scaling activity ID. + * `activity_related_instance_set` - Information set of the instances related to the scaling activity. + * `instance_id` - Instance ID. + * `instance_status` - Status of the instance in the scaling activity. Value range: INIT, RUNNING, SUCCESSFUL, FAILED. + * `activity_type` - Type of the scaling activity. Value range: SCALE_OUT, SCALE_IN, ATTACH_INSTANCES, REMOVE_INSTANCES, DETACH_INSTANCES, TERMINATE_INSTANCES_UNEXPECTEDLY, REPLACE_UNHEALTHY_INSTANCE, START_INSTANCES, STOP_INSTANCES, INVOKE_COMMAND. + * `auto_scaling_group_id` - Auto scaling group ID. + * `cause` - Cause of the scaling activity. + * `created_time` - Creation time of the scaling activity. + * `description` - Description of the scaling activity. + * `detailed_status_message_set` - Detailed description of scaling activity status. + * `code` - Error type. + * `instance_charge_type` - Instance billing mode. + * `instance_id` - Instance ID. + * `instance_type` - Instance type. + * `message` - Error message. + * `subnet_id` - Subnet ID. + * `zone` - AZ information. + * `end_time` - End time of the scaling activity. + * `invocation_result_set` - Result of the command execution. + * `command_id` - Command ID. Note: This field may return null, indicating that no valid values can be obtained. + * `error_message` - Execution exception information. Note: This field may return null, indicating that no valid values can be obtained. + * `instance_id` - Instance ID. Note: This field may return null, indicating that no valid values can be obtained. + * `invocation_id` - Execution activity ID. Note: This field may return null, indicating that no valid values can be obtained. + * `invocation_task_id` - Execution task ID. Note: This field may return null, indicating that no valid values can be obtained. + * `task_status` - Execution Status. Note: This field may return null, indicating that no valid values can be obtained. + * `lifecycle_action_result_set` - Result of the lifecycle hook action in the scaling activity. + * `instance_id` - ID of the instance. + * `invocation_id` - Execution task ID. You can query the result by using the DescribeInvocations API of TAT. + * `invoke_command_result` - Result of command invocation, value range: SUCCESSFUL, FAILED, NONE. + * `lifecycle_action_result` - Result of the lifecycle hook action, value range: CONTINUE, ABANDON. + * `lifecycle_hook_id` - ID of the lifecycle hook. + * `notification_result` - Notification result, which indicates whether it is successful to notify CMQ/TDMQ, value range: SUCCESSFUL, FAILED, NONE. + * `result_reason` - Reason of the result, value range: HEARTBEAT_TIMEOUT: Heartbeat timed out. The setting of DefaultResult is used. NOTIFICATION_FAILURE: Failed to send the notification. The setting of DefaultResult is used. CALL_INTERFACE: Calls the CompleteLifecycleAction to set the result ANOTHER_ACTION_ABANDON: It has been set to ABANDON by another operation. COMMAND_CALL_FAILURE: Failed to call the command. The DefaultResult is applied. COMMAND_EXEC_FINISH: Command completed COMMAND_CALL_FAILURE: Failed to execute the command. The DefaultResult is applied. COMMAND_EXEC_RESULT_CHECK_FAILURE: Failed to check the command result. The DefaultResult is applied. + * `start_time` - Start time of the scaling activity. + * `status_code` - Scaling activity status. Value range: INIT, RUNNING, SUCCESSFUL, PARTIALLY_SUCCESSFUL, FAILED, CANCELLED. + * `status_message_simplified` - Brief description of the scaling activity status. + * `status_message` - Description of the scaling activity status. + + diff --git a/config/docs/d/as_limits.html.markdown b/config/docs/d/as_limits.html.markdown new file mode 100644 index 0000000..7182c99 --- /dev/null +++ b/config/docs/d/as_limits.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_limits" +sidebar_current: "docs-tencentcloud-datasource-as_limits" +description: |- + Use this data source to query detailed information of as limits +--- + +# tencentcloud_as_limits + +Use this data source to query detailed information of as limits + +## Example Usage + +```hcl +data "tencentcloud_as_limits" "limits" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `max_number_of_auto_scaling_groups` - Maximum number of auto scaling groups allowed for creation by the user account. +* `max_number_of_launch_configurations` - Maximum number of launch configurations allowed for creation by the user account. +* `number_of_auto_scaling_groups` - Current number of auto scaling groups under the user account. +* `number_of_launch_configurations` - Current number of launch configurations under the user account. + + diff --git a/config/docs/d/as_scaling_configs.html.markdown b/config/docs/d/as_scaling_configs.html.markdown new file mode 100644 index 0000000..e343faa --- /dev/null +++ b/config/docs/d/as_scaling_configs.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_scaling_configs" +sidebar_current: "docs-tencentcloud-datasource-as_scaling_configs" +description: |- + Use this data source to query scaling configuration information. +--- + +# tencentcloud_as_scaling_configs + +Use this data source to query scaling configuration information. + +## Example Usage + +```hcl +data "tencentcloud_as_scaling_configs" "as_configs" { + configuration_id = "asc-oqio4yyj" + result_output_file = "my_test_path" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `configuration_id` - (Optional, String) Launch configuration ID. +* `configuration_name` - (Optional, String) Launch configuration name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `configuration_list` - A list of configuration. Each element contains the following attributes: + * `configuration_id` - Launch configuration ID. + * `configuration_name` - Launch configuration name. + * `create_time` - The time when the launch configuration was created. + * `data_disk` - Configurations of data disk. + * `delete_with_instance` - Indicates whether the disk remove after instance terminated. + * `disk_size` - Volume of disk in GB. Default is `0`. + * `disk_type` - Type of disk. + * `snapshot_id` - Data disk snapshot ID. + * `disk_type_policy` - Policy of cloud disk type. + * `enhanced_monitor_service` - Whether to activate cloud monitor service. + * `enhanced_security_service` - Whether to activate cloud security service. + * `image_id` - ID of available image, for example `img-8toqc6s3`. + * `instance_tags` - A tag list associates with an instance. + * `instance_types` - Instance type list of the scaling configuration. + * `internet_charge_type` - Charge types for network traffic. + * `internet_max_bandwidth_out` - Max bandwidth of Internet access in Mbps. + * `key_ids` - ID list of login keys. + * `project_id` - ID of the project to which the configuration belongs. Default value is 0. + * `public_ip_assigned` - Specify whether to assign an Internet IP address. + * `security_group_ids` - Security groups to which the instance belongs. + * `status` - Current status of a launch configuration. + * `system_disk_size` - System disk size of the scaling configuration in GB. + * `system_disk_type` - System disk category of the scaling configuration. + * `user_data` - Base64-encoded User Data text. + + diff --git a/config/docs/d/as_scaling_groups.html.markdown b/config/docs/d/as_scaling_groups.html.markdown new file mode 100644 index 0000000..5ff64c1 --- /dev/null +++ b/config/docs/d/as_scaling_groups.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_scaling_groups" +sidebar_current: "docs-tencentcloud-datasource-as_scaling_groups" +description: |- + Use this data source to query the detail information of an existing autoscaling group. +--- + +# tencentcloud_as_scaling_groups + +Use this data source to query the detail information of an existing autoscaling group. + +## Example Usage + +```hcl +data "tencentcloud_as_scaling_groups" "as_scaling_groups" { + scaling_group_name = "myasgroup" + configuration_id = "asc-oqio4yyj" + result_output_file = "my_test_path" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `configuration_id` - (Optional, String) Filter results by launch configuration ID. +* `result_output_file` - (Optional, String) Used to save results. +* `scaling_group_id` - (Optional, String) A specified scaling group ID used to query. +* `scaling_group_name` - (Optional, String) A scaling group name used to query. +* `tags` - (Optional, Map) Tags used to query. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `scaling_group_list` - A list of scaling group. Each element contains the following attributes: + * `configuration_id` - Launch configuration ID. + * `create_time` - The time when the AS group was created. + * `default_cooldown` - Default cooldown time of scaling group. + * `desired_capacity` - The desired number of CVM instances. + * `forward_balancer_ids` - A list of application clb ids. + * `listener_id` - Listener ID for application load balancers. + * `load_balancer_id` - ID of available load balancers. + * `location_id` - ID of forwarding rules. + * `target_attribute` - Attribute list of target rules. + * `port` - Port number. + * `weight` - Weight. + * `instance_count` - Number of instance. + * `load_balancer_ids` - A list of traditional clb ids which the CVM instances attached to. + * `max_size` - The maximum number of CVM instances. + * `min_size` - The minimum number of CVM instances. + * `multi_zone_subnet_policy` - Multi zone or subnet strategy, Valid values: PRIORITY and EQUALITY. + * `project_id` - ID of the project to which the scaling group belongs. Default value is 0. + * `retry_policy` - A retry policy can be used when a creation fails. + * `scaling_group_id` - Auto scaling group ID. + * `scaling_group_name` - Auto scaling group name. + * `status` - Current status of a scaling group. + * `subnet_ids` - A list of subnet IDs. + * `tags` - Tags of the scaling group. + * `termination_policies` - A policy used to select a CVM instance to be terminated from the scaling group. + * `vpc_id` - ID of the vpc with which the instance is associated. + * `zones` - A list of available zones. + + diff --git a/config/docs/d/as_scaling_policies.html.markdown b/config/docs/d/as_scaling_policies.html.markdown new file mode 100644 index 0000000..ddada33 --- /dev/null +++ b/config/docs/d/as_scaling_policies.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_scaling_policies" +sidebar_current: "docs-tencentcloud-datasource-as_scaling_policies" +description: |- + Use this data source to query detailed information of scaling policy. +--- + +# tencentcloud_as_scaling_policies + +Use this data source to query detailed information of scaling policy. + +## Example Usage + +```hcl +data "tencentcloud_as_scaling_policies" "as_scaling_policies" { + scaling_policy_id = "asg-mvyghxu7" + result_output_file = "mytestpath" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy_name` - (Optional, String) Scaling policy name. +* `result_output_file` - (Optional, String) Used to save results. +* `scaling_group_id` - (Optional, String) Scaling group ID. +* `scaling_policy_id` - (Optional, String) Scaling policy ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `scaling_policy_list` - A list of scaling policy. Each element contains the following attributes: + * `adjustment_type` - Adjustment type of the scaling rule. + * `adjustment_value` - Adjustment value of the scaling rule. + * `comparison_operator` - Comparison operator. + * `continuous_time` - Retry times. + * `cooldown` - Cool down time of the scaling rule. + * `metric_name` - Name of an indicator. + * `notification_user_group_ids` - Users need to be notified when an alarm is triggered. + * `period` - Time period in second. + * `policy_name` - Scaling policy name. + * `scaling_group_id` - Scaling policy ID. + * `statistic` - Statistic types. + * `threshold` - Alarm threshold. + + diff --git a/config/docs/d/audit_cos_regions.html.markdown b/config/docs/d/audit_cos_regions.html.markdown new file mode 100644 index 0000000..320f839 --- /dev/null +++ b/config/docs/d/audit_cos_regions.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Cloud Audit(Audit)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_audit_cos_regions" +sidebar_current: "docs-tencentcloud-datasource-audit_cos_regions" +description: |- + Use this data source to query the cos region list supported by the audit. +--- + +# tencentcloud_audit_cos_regions + +Use this data source to query the cos region list supported by the audit. + +## Example Usage + +```hcl +data "tencentcloud_audit_cos_regions" "foo" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `audit_cos_region_list` - List of available regions supported by audit cos. + * `cos_region_name` - Cos region chinese name. + * `cos_region` - Cos region. + + diff --git a/config/docs/d/audit_key_alias.html.markdown b/config/docs/d/audit_key_alias.html.markdown new file mode 100644 index 0000000..33d1e58 --- /dev/null +++ b/config/docs/d/audit_key_alias.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Audit(Audit)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_audit_key_alias" +sidebar_current: "docs-tencentcloud-datasource-audit_key_alias" +description: |- + Use this data source to query the key alias list specified with region supported by the audit. +--- + +# tencentcloud_audit_key_alias + +Use this data source to query the key alias list specified with region supported by the audit. + +## Example Usage + +```hcl +data "tencentcloud_audit_key_alias" "all" { + region = "ap-hongkong" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `region` - (Required, String) Region. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `audit_key_alias_list` - List of available key alias supported by audit. + * `key_alias` - Key alias. + * `key_id` - Key ID. + + diff --git a/config/docs/d/audits.html.markdown b/config/docs/d/audits.html.markdown new file mode 100644 index 0000000..6df1398 --- /dev/null +++ b/config/docs/d/audits.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Cloud Audit(Audit)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_audits" +sidebar_current: "docs-tencentcloud-datasource-audits" +description: |- + Use this data source to query detailed information of audits. +--- + +# tencentcloud_audits + +Use this data source to query detailed information of audits. + +## Example Usage + +```hcl +data "tencentcloud_audits" "audits" { + name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Optional, String) Name of the audits. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `audit_list` - Information list of the dedicated audits. + * `audit_switch` - Indicate whether audit start logging or not. + * `cos_bucket` - Cos bucket name where audit save logs. + * `id` - ID of the audit. + * `log_file_prefix` - Prefix of the log file of the audit. + * `name` - Name of the audit. + + diff --git a/config/docs/d/availability_regions.html.markdown b/config/docs/d/availability_regions.html.markdown new file mode 100644 index 0000000..dc03c10 --- /dev/null +++ b/config/docs/d/availability_regions.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Provider Data Sources" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_availability_regions" +sidebar_current: "docs-tencentcloud-datasource-availability_regions" +description: |- + Use this data source to get the available regions. By default only `AVAILABLE` regions will be returned, but `UNAVAILABLE` regions can also be fetched when `include_unavailable` is specified. +--- + +# tencentcloud_availability_regions + +Use this data source to get the available regions. By default only `AVAILABLE` regions will be returned, but `UNAVAILABLE` regions can also be fetched when `include_unavailable` is specified. + +## Example Usage + +```hcl +data "tencentcloud_availability_regions" "my_favourite_region" { + name = "ap-guangzhou" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `include_unavailable` - (Optional, Bool) A bool variable indicates that the query will include `UNAVAILABLE` regions. +* `name` - (Optional, String) When specified, only the region with the exactly name match will be returned. `default` value means it consistent with the provider region. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `regions` - A list of regions will be exported and its every element contains the following attributes: + * `description` - The description of the region, like `Guangzhou Region`. + * `name` - The name of the region, like `ap-guangzhou`. + * `state` - The state of the region, indicate availability using `AVAILABLE` and `UNAVAILABLE` values. + + diff --git a/config/docs/d/availability_zones.html.markdown b/config/docs/d/availability_zones.html.markdown new file mode 100644 index 0000000..58b80cd --- /dev/null +++ b/config/docs/d/availability_zones.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Provider Data Sources" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_availability_zones" +sidebar_current: "docs-tencentcloud-datasource-availability_zones" +description: |- + Use this data source to get the available zones in current region. By default only `AVAILABLE` zones will be returned, but `UNAVAILABLE` zones can also be fetched when `include_unavailable` is specified. +--- + +# tencentcloud_availability_zones + +Use this data source to get the available zones in current region. By default only `AVAILABLE` zones will be returned, but `UNAVAILABLE` zones can also be fetched when `include_unavailable` is specified. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_availability_zones_by_product. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "my_favourite_zone" { + name = "ap-guangzhou-3" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `include_unavailable` - (Optional, Bool) A bool variable indicates that the query will include `UNAVAILABLE` zones. +* `name` - (Optional, String) When specified, only the zone with the exactly name match will be returned. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `zones` - A list of zones will be exported and its every element contains the following attributes: + * `description` - The description of the zone, like `Guangzhou Zone 3`. + * `id` - An internal id for the zone, like `200003`, usually not so useful. + * `name` - The name of the zone, like `ap-guangzhou-3`. + * `state` - The state of the zone, indicate availability using `AVAILABLE` and `UNAVAILABLE` values. + + diff --git a/config/docs/d/availability_zones_by_product.html.markdown b/config/docs/d/availability_zones_by_product.html.markdown new file mode 100644 index 0000000..f4f9395 --- /dev/null +++ b/config/docs/d/availability_zones_by_product.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Provider Data Sources" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_availability_zones_by_product" +sidebar_current: "docs-tencentcloud-datasource-availability_zones_by_product" +description: |- + Use this data source to get the available zones in current region. Must set product param to fetch the product infomations(e.g. => cvm, vpc). By default only `AVAILABLE` zones will be returned, but `UNAVAILABLE` zones can also be fetched when `include_unavailable` is specified. +--- + +# tencentcloud_availability_zones_by_product + +Use this data source to get the available zones in current region. Must set product param to fetch the product infomations(e.g. => cvm, vpc). By default only `AVAILABLE` zones will be returned, but `UNAVAILABLE` zones can also be fetched when `include_unavailable` is specified. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "all" { + product = "cvm" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `product` - (Required, String) A string variable indicates that the query will use product information. +* `include_unavailable` - (Optional, Bool) A bool variable indicates that the query will include `UNAVAILABLE` zones. +* `name` - (Optional, String) When specified, only the zone with the exactly name match will be returned. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `zones` - A list of zones will be exported and its every element contains the following attributes: + * `description` - The description of the zone, like `Guangzhou Zone 3`. + * `id` - An internal id for the zone, like `200003`, usually not so useful. + * `name` - The name of the zone, like `ap-guangzhou-3`. + * `state` - The state of the zone, indicate availability using `AVAILABLE` and `UNAVAILABLE` values. + + diff --git a/config/docs/d/bi_project.html.markdown b/config/docs/d/bi_project.html.markdown new file mode 100644 index 0000000..4db195f --- /dev/null +++ b/config/docs/d/bi_project.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "Business Intelligence(BI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_bi_project" +sidebar_current: "docs-tencentcloud-datasource-bi_project" +description: |- + Use this data source to query detailed information of bi project +--- + +# tencentcloud_bi_project + +Use this data source to query detailed information of bi project + +## Example Usage + +```hcl +data "tencentcloud_bi_project" "project" { + page_no = 1 + keyword = "abc" + all_page = true + module_collection = "sys_common_user" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `all_page` - (Optional, Bool) Whether to display all, if true, ignore paging. +* `keyword` - (Optional, String) Retrieve fuzzy fields. +* `module_collection` - (Optional, String) Role information, can be ignored. +* `page_no` - (Optional, Int) Page number. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `extra` - Additional information(Note: This field may return null, indicating that no valid value can be obtained). +* `list` - Array(Note: This field may return null, indicating that no valid value can be obtained). + * `apply` - Apply(Note: This field may return null, indicating that no valid value can be obtained). + * `auth_list` - List of permissions within the project(Note: This field may return null, indicating that no valid value can be obtained). + * `color_code` - Logo colour(Note: This field may return null, indicating that no valid value can be obtained). + * `config_list` - Customized parameters, this parameter can be ignored(Note: This field may return null, indicating that no valid value can be obtained). + * `components` - Components(Note: This field may return null, indicating that no valid value can be obtained). + * `include_type` - Include type(Note: This field may return null, indicating that no valid value can be obtained). + * `module_id` - Module id(Note: This field may return null, indicating that no valid value can be obtained). + * `params` - Extra parameters(Note: This field may return null, indicating that no valid value can be obtained). + * `module_group` - Module group(Note: This field may return null, indicating that no valid value can be obtained). + * `corp_id` - Enterprise id(Note: This field may return null, indicating that no valid value can be obtained). + * `created_at` - Created at(Note: This field may return null, indicating that no valid value can be obtained). + * `created_user` - Created by(Note: This field may return null, indicating that no valid value can be obtained). + * `id` - Project id. + * `is_external_manage` - Determine whether it is hosted(Note: This field may return null, indicating that no valid value can be obtained). + * `last_modify_name` - Last modified report and presentation names(Note: This field may return null, indicating that no valid value can be obtained). + * `logo` - Project logo(Note: This field may return null, indicating that no valid value can be obtained). + * `manage_platform` - Hosting platform name(Note: This field may return null, indicating that no valid value can be obtained). + * `mark` - Remark(Note: This field may return null, indicating that no valid value can be obtained). + * `member_count` - Member count(Note: This field may return null, indicating that no valid value can be obtained). + * `name` - Project name(Note: This field may return null, indicating that no valid value can be obtained). + * `page_count` - Page count(Note: This field may return null, indicating that no valid value can be obtained). + * `panel_scope` - Default kanban(Note: This field may return null, indicating that no valid value can be obtained). + * `seed` - Obfuscated field(Note: This field may return null, indicating that no valid value can be obtained). + * `source` - Interface call source(Note: This field may return null, indicating that no valid value can be obtained). + * `updated_at` - Updated by(Note: This field may return null, indicating that no valid value can be obtained). + * `updated_user` - Updated by(Note: This field may return null, indicating that no valid value can be obtained). +* `msg` - Interface information(Note: This field may return null, indicating that no valid value can be obtained). + + diff --git a/config/docs/d/bi_user_project.html.markdown b/config/docs/d/bi_user_project.html.markdown new file mode 100644 index 0000000..60f3d06 --- /dev/null +++ b/config/docs/d/bi_user_project.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Business Intelligence(BI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_bi_user_project" +sidebar_current: "docs-tencentcloud-datasource-bi_user_project" +description: |- + Use this data source to query detailed information of bi user_project +--- + +# tencentcloud_bi_user_project + +Use this data source to query detailed information of bi user_project + +## Example Usage + +```hcl +data "tencentcloud_bi_user_project" "user_project" { + project_id = 123 + all_page = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `all_page` - (Optional, Bool) Whether to display all, if true, ignore paging. +* `project_id` - (Optional, Int) Project id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - Array(Note: This field may return null, indicating that no valid value can be obtained). + * `area_code` - Mobile area code(Note: This field may return null, indicating that no valid value can be obtained). + * `corp_id` - Enterprise id(Note: This field may return null, indicating that no valid value can be obtained). + * `created_at` - Created at(Note: This field may return null, indicating that no valid value can be obtained). + * `created_user` - Created by(Note: This field may return null, indicating that no valid value can be obtained). + * `email` - E-mail(Note: This field may return null, indicating that no valid value can be obtained). + * `first_modify` - First login to change password, public cloud unrelated fields(Note: This field may return null, indicating that no valid value can be obtained). + * `global_user_name` - Global role name(Note: This field may return null, indicating that no valid value can be obtained). + * `last_login` - Last login time, public cloud unrelated fields(Note: This field may return null, indicating that no valid value can be obtained). + * `mobile` - Mobile number, public cloud unrelated fields(Note: This field may return null, indicating that no valid value can be obtained). + * `phone_number` - Phone number(Note: This field may return null, indicating that no valid value can be obtained). + * `status` - Disabled state(Note: This field may return null, indicating that no valid value can be obtained). + * `updated_at` - Updated at(Note: This field may return null, indicating that no valid value can be obtained). + * `updated_user` - Updated by(Note: This field may return null, indicating that no valid value can be obtained). + * `user_id` - User id. + * `user_name` - Username. + + diff --git a/config/docs/d/cam_account_summary.html.markdown b/config/docs/d/cam_account_summary.html.markdown new file mode 100644 index 0000000..2129f87 --- /dev/null +++ b/config/docs/d/cam_account_summary.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_account_summary" +sidebar_current: "docs-tencentcloud-datasource-cam_account_summary" +description: |- + Use this data source to query detailed information of cam account_summary +--- + +# tencentcloud_cam_account_summary + +Use this data source to query detailed information of cam account_summary + +## Example Usage + +```hcl +data "tencentcloud_cam_account_summary" "account_summary" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `group` - The number of Group. +* `identity_providers` - The number of identity provider. +* `member` - The number of grouped users. +* `policies` - The number of policy. +* `roles` - The number of role. +* `user` - The number of Sub-user. + + diff --git a/config/docs/d/cam_group_memberships.html.markdown b/config/docs/d/cam_group_memberships.html.markdown new file mode 100644 index 0000000..00a98cb --- /dev/null +++ b/config/docs/d/cam_group_memberships.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_group_memberships" +sidebar_current: "docs-tencentcloud-datasource-cam_group_memberships" +description: |- + Use this data source to query detailed information of CAM group memberships +--- + +# tencentcloud_cam_group_memberships + +Use this data source to query detailed information of CAM group memberships + +## Example Usage + +```hcl +data "tencentcloud_cam_group_memberships" "foo" { + group_id = tencentcloud_cam_group.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Optional, String) ID of CAM group to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `membership_list` - A list of CAM group membership. Each element contains the following attributes: + * `group_id` - ID of CAM group. + * `user_ids` - (**Deprecated**) It has been deprecated from version 1.59.5. Use `user_names` instead. ID set of the CAM group members. + * `user_names` - ID set of the CAM group members. + + diff --git a/config/docs/d/cam_group_policy_attachments.html.markdown b/config/docs/d/cam_group_policy_attachments.html.markdown new file mode 100644 index 0000000..fb0b29e --- /dev/null +++ b/config/docs/d/cam_group_policy_attachments.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_group_policy_attachments" +sidebar_current: "docs-tencentcloud-datasource-cam_group_policy_attachments" +description: |- + Use this data source to query detailed information of CAM group policy attachments +--- + +# tencentcloud_cam_group_policy_attachments + +Use this data source to query detailed information of CAM group policy attachments + +## Example Usage + +```hcl +# query by group_id +data "tencentcloud_cam_group_policy_attachments" "foo" { + group_id = tencentcloud_cam_group.foo.id +} + +# query by group_id and policy_id +data "tencentcloud_cam_group_policy_attachments" "bar" { + group_id = tencentcloud_cam_group.foo.id + policy_id = tencentcloud_cam_policy.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String) ID of the attached CAM group to be queried. +* `create_mode` - (Optional, Int) Mode of creation of the CAM user policy attachment. 1 means the cam policy attachment is created by production, and the others indicate syntax strategy ways. +* `policy_id` - (Optional, String) ID of CAM policy to be queried. +* `policy_type` - (Optional, String) Type of the policy strategy. 'User' means customer strategy and 'QCS' means preset strategy. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `group_policy_attachment_list` - A list of CAM group policy attachments. Each element contains the following attributes: + * `create_mode` - Mode of Creation of the CAM group policy attachment. 1 means the cam policy attachment is created by production, and the others indicate syntax strategy ways. + * `create_time` - Create time of the CAM group policy attachment. + * `group_id` - ID of CAM group. + * `policy_id` - Name of CAM group. + * `policy_name` - Name of the policy. + * `policy_type` - Type of the policy strategy. 'User' means customer strategy and 'QCS' means preset strategy. + + diff --git a/config/docs/d/cam_group_user_account.html.markdown b/config/docs/d/cam_group_user_account.html.markdown new file mode 100644 index 0000000..37f5089 --- /dev/null +++ b/config/docs/d/cam_group_user_account.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_group_user_account" +sidebar_current: "docs-tencentcloud-datasource-cam_group_user_account" +description: |- + Use this data source to query detailed information of cam group_user_account +--- + +# tencentcloud_cam_group_user_account + +Use this data source to query detailed information of cam group_user_account + +## Example Usage + +```hcl +data "tencentcloud_cam_group_user_account" "group_user_account" { + sub_uin = 100033690181 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `rp` - (Optional, Int) Number per page. The default is 20. +* `sub_uin` - (Optional, Int) Sub-user uin. +* `uid` - (Optional, Int) Sub-user uid. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `group_info` - User group information. + * `create_time` - Create time. + * `group_id` - User group ID. + * `group_name` - User group name. + * `remark` - Remark. +* `total_num` - The total number of user groups the sub-user has joined. + + diff --git a/config/docs/d/cam_groups.html.markdown b/config/docs/d/cam_groups.html.markdown new file mode 100644 index 0000000..3272cbf --- /dev/null +++ b/config/docs/d/cam_groups.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_groups" +sidebar_current: "docs-tencentcloud-datasource-cam_groups" +description: |- + Use this data source to query detailed information of CAM groups +--- + +# tencentcloud_cam_groups + +Use this data source to query detailed information of CAM groups + +## Example Usage + +```hcl +# query by group_id +data "tencentcloud_cam_groups" "foo" { + group_id = tencentcloud_cam_group.foo.id +} + +# query by name +data "tencentcloud_cam_groups" "bar" { + name = "cam-group-test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Optional, String) ID of CAM group to be queried. +* `name` - (Optional, String) Name of the CAM group to be queried. +* `remark` - (Optional, String) Description of the cam group to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `group_list` - A list of CAM groups. Each element contains the following attributes: + * `create_time` - Create time of the CAM group. + * `group_id` - ID of the CAM group. + * `name` - Name of CAM group. + * `remark` - Description of CAM group. + + diff --git a/config/docs/d/cam_list_entities_for_policy.html.markdown b/config/docs/d/cam_list_entities_for_policy.html.markdown new file mode 100644 index 0000000..7566f4e --- /dev/null +++ b/config/docs/d/cam_list_entities_for_policy.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_list_entities_for_policy" +sidebar_current: "docs-tencentcloud-datasource-cam_list_entities_for_policy" +description: |- + Use this data source to query detailed information of cam list_entities_for_policy +--- + +# tencentcloud_cam_list_entities_for_policy + +Use this data source to query detailed information of cam list_entities_for_policy + +## Example Usage + +```hcl +data "tencentcloud_cam_list_entities_for_policy" "list_entities_for_policy" { + policy_id = 1 + entity_filter = "All" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy_id` - (Required, Int) Policy Id. +* `entity_filter` - (Optional, String) Can take values of &amp;#39;All&amp;#39;, &amp;#39;User&amp;#39;, &amp;#39;Group&amp;#39;, and &amp;#39;Role&amp;#39;. &amp;#39;All&amp;#39; represents obtaining all entity types, &amp;#39;User&amp;#39; represents only obtaining sub accounts, &amp;#39;Group&amp;#39; represents only obtaining user groups, and &amp;#39;Role&amp;#39; represents only obtaining roles. The default value is&amp;#39; All &amp;#39;. +* `result_output_file` - (Optional, String) Used to save results. +* `rp` - (Optional, Int) Per page size, default value is 20. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - Entity ListNote: This field may return null, indicating that a valid value cannot be obtained. + * `attachment_time` - Policy association timeNote: This field may return null, indicating that a valid value cannot be obtained. + * `id` - Entity ID. + * `name` - Entity NameNote: This field may return null, indicating that a valid value cannot be obtained. + * `related_type` - Association type. 1. User association; 2 User Group Association. + * `uin` - Entity UinNote: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/cam_oidc_config.html.markdown b/config/docs/d/cam_oidc_config.html.markdown new file mode 100644 index 0000000..81cbf06 --- /dev/null +++ b/config/docs/d/cam_oidc_config.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_oidc_config" +sidebar_current: "docs-tencentcloud-datasource-cam_oidc_config" +description: |- + Use this data source to query detailed information of cam oidc_config +--- + +# tencentcloud_cam_oidc_config + +Use this data source to query detailed information of cam oidc_config + +## Example Usage + +```hcl +data "tencentcloud_cam_oidc_config" "oidc_config" { + name = "cls-kzilgv5m" +} + +output "identity_key" { + value = data.tencentcloud_cam_oidc_config.oidc_config.identity_key +} + +output "identity_url" { + value = data.tencentcloud_cam_oidc_config.oidc_config.identity_url +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `client_id` - Client ID. +* `description` - Description. +* `identity_key` - Public key for signature. +* `identity_url` - IdP URL. +* `provider_type` - IdP type. 11: Role IdP. +* `status` - Status. 0: Not set; 2: Disabled; 11: Enabled. + + diff --git a/config/docs/d/cam_policies.html.markdown b/config/docs/d/cam_policies.html.markdown new file mode 100644 index 0000000..f657767 --- /dev/null +++ b/config/docs/d/cam_policies.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_policies" +sidebar_current: "docs-tencentcloud-datasource-cam_policies" +description: |- + Use this data source to query detailed information of CAM policies +--- + +# tencentcloud_cam_policies + +Use this data source to query detailed information of CAM policies + +## Example Usage + +```hcl +# query by policy_id +data "tencentcloud_cam_policies" "foo" { + policy_id = tencentcloud_cam_policy.foo.id +} + +# query by policy_id and name +data "tencentcloud_cam_policies" "bar" { + policy_id = tencentcloud_cam_policy.foo.id + name = "tf-auto-test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `create_mode` - (Optional, Int) Mode of creation of policy strategy. Valid values: `1`, `2`. `1` means policy was created with console, and `2` means it was created by strategies. +* `description` - (Optional, String) The description of the CAM policy. +* `name` - (Optional, String) Name of the CAM policy to be queried. +* `policy_id` - (Optional, String) ID of CAM policy to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `type` - (Optional, Int) Type of the policy strategy. Valid values: `1`, `2`. `1` means customer strategy and `2` means preset strategy. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `policy_list` - A list of CAM policies. Each element contains the following attributes: + * `attachments` - Number of attached users. + * `create_mode` - Mode of creation of policy strategy. `1` means policy was created with console, and `2` means it was created by strategies. + * `create_time` - Create time of the CAM policy. + * `description` - Description of CAM policy. + * `name` - Name of CAM policy. + * `policy_id` - ID of the policy strategy. + * `service_type` - Name of attached products. + * `type` - Type of the policy strategy. `1` means customer strategy and `2` means preset strategy. + + diff --git a/config/docs/d/cam_policy_granting_service_access.html.markdown b/config/docs/d/cam_policy_granting_service_access.html.markdown new file mode 100644 index 0000000..f8b9cde --- /dev/null +++ b/config/docs/d/cam_policy_granting_service_access.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_policy_granting_service_access" +sidebar_current: "docs-tencentcloud-datasource-cam_policy_granting_service_access" +description: |- + Use this data source to query detailed information of cam policy_granting_service_access +--- + +# tencentcloud_cam_policy_granting_service_access + +Use this data source to query detailed information of cam policy_granting_service_access + +## Example Usage + +```hcl +data "tencentcloud_cam_policy_granting_service_access" "policy_granting_service_access" { + role_id = 4611686018436805021 + service_type = "cam" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Optional, Int) Group Id, one of the three (TargetUin, RoleId, GroupId) must be passed. +* `result_output_file` - (Optional, String) Used to save results. +* `role_id` - (Optional, Int) Role Id, one of the three (TargetUin, RoleId, GroupId) must be passed. +* `service_type` - (Optional, String) Service type, this field needs to be passed when viewing the details of the service authorization interface. +* `target_uin` - (Optional, Int) Sub-account uin, one of the three (TargetUin, RoleId, GroupId) must be passed. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - List. + * `action` - Action list. + * `description` - Action description. + * `name` - Action name. + * `policy` - Policy list. + * `policy_description` - Policy description. + * `policy_id` - Policy Id. + * `policy_name` - Policy name. + * `policy_type` - Polic type. + * `service` - Service info. + * `service_name` - Service name. + * `service_type` - Service type. + + diff --git a/config/docs/d/cam_role_policy_attachments.html.markdown b/config/docs/d/cam_role_policy_attachments.html.markdown new file mode 100644 index 0000000..003ead4 --- /dev/null +++ b/config/docs/d/cam_role_policy_attachments.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_role_policy_attachments" +sidebar_current: "docs-tencentcloud-datasource-cam_role_policy_attachments" +description: |- + Use this data source to query detailed information of CAM role policy attachments +--- + +# tencentcloud_cam_role_policy_attachments + +Use this data source to query detailed information of CAM role policy attachments + +## Example Usage + +```hcl +# query by role_id +data "tencentcloud_cam_role_policy_attachments" "foo" { + role_id = tencentcloud_cam_role.foo.id +} + +# query by role_id and policy_id +data "tencentcloud_cam_role_policy_attachments" "bar" { + role_id = tencentcloud_cam_role.foo.id + policy_id = tencentcloud_cam_policy.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `role_id` - (Required, String) ID of the attached CAM role to be queried. +* `create_mode` - (Optional, Int) Mode of Creation of the CAM user policy attachment. `1` means the cam policy attachment is created by production, and the others indicate syntax strategy ways. +* `policy_id` - (Optional, String) ID of CAM policy to be queried. +* `policy_type` - (Optional, String) Type of the policy strategy. Valid values are 'User', 'QCS'. 'User' means customer strategy and 'QCS' means preset strategy. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `role_policy_attachment_list` - A list of CAM role policy attachments. Each element contains the following attributes: + * `create_mode` - Mode of Creation of the CAM role policy attachment. `1` means the cam policy attachment is created by production, and the others indicate syntax strategy ways. + * `create_time` - Create time of the CAM role policy attachment. + * `policy_id` - Name of CAM role. + * `policy_name` - Name of the policy. + * `policy_type` - Type of the policy strategy. 'User' means customer strategy and 'QCS' means preset strategy. + * `role_id` - ID of CAM role. + + diff --git a/config/docs/d/cam_roles.html.markdown b/config/docs/d/cam_roles.html.markdown new file mode 100644 index 0000000..b94b1f8 --- /dev/null +++ b/config/docs/d/cam_roles.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_roles" +sidebar_current: "docs-tencentcloud-datasource-cam_roles" +description: |- + Use this data source to query detailed information of CAM roles +--- + +# tencentcloud_cam_roles + +Use this data source to query detailed information of CAM roles + +## Example Usage + +```hcl +# query by role_id +data "tencentcloud_cam_roles" "foo" { + role_id = tencentcloud_cam_role.foo.id +} + +# query by name +data "tencentcloud_cam_roles" "bar" { + name = "cam-role-test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `description` - (Optional, String) The description of the CAM role to be queried. +* `name` - (Optional, String) Name of the CAM policy to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `role_id` - (Optional, String) ID of the CAM role to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `role_list` - A list of CAM roles. Each element contains the following attributes: + * `console_login` - Indicate whether the CAM role can be login or not. + * `create_time` - The create time of the CAM role. + * `description` - Description of CAM role. + * `document` - Policy document of CAM role. + * `name` - Name of CAM role. + * `role_id` - Id of CAM role. + * `update_time` - The last update time of the CAM role. + + diff --git a/config/docs/d/cam_saml_providers.html.markdown b/config/docs/d/cam_saml_providers.html.markdown new file mode 100644 index 0000000..e338d73 --- /dev/null +++ b/config/docs/d/cam_saml_providers.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_saml_providers" +sidebar_current: "docs-tencentcloud-datasource-cam_saml_providers" +description: |- + Use this data source to query detailed information of CAM SAML providers +--- + +# tencentcloud_cam_saml_providers + +Use this data source to query detailed information of CAM SAML providers + +## Example Usage + +```hcl +data "tencentcloud_cam_saml_providers" "foo" { + name = "cam-test-provider" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `description` - (Optional, String) The description of the CAM SAML provider. +* `name` - (Optional, String) Name of the CAM SAML provider to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `provider_list` - A list of CAM SAML providers. Each element contains the following attributes: + * `create_time` - Create time of the CAM SAML provider. + * `description` - Description of CAM SAML provider. + * `modify_time` - The last modify time of the CAM SAML provider. + * `name` - Name of CAM SAML provider. + + diff --git a/config/docs/d/cam_secret_last_used_time.html.markdown b/config/docs/d/cam_secret_last_used_time.html.markdown new file mode 100644 index 0000000..2c43343 --- /dev/null +++ b/config/docs/d/cam_secret_last_used_time.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_secret_last_used_time" +sidebar_current: "docs-tencentcloud-datasource-cam_secret_last_used_time" +description: |- + Use this data source to query detailed information of cam secret_last_used_time +--- + +# tencentcloud_cam_secret_last_used_time + +Use this data source to query detailed information of cam secret_last_used_time + +## Example Usage + +```hcl +data "tencentcloud_cam_secret_last_used_time" "secret_last_used_time" { + secret_id_list = ["xxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `secret_id_list` - (Required, Set: [`String`]) Query the key ID list. Supports up to 10. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `secret_id_last_used_rows` - Last used time list. + * `last_secret_used_date` - Last used timestamp. + * `last_used_date` - Last used date (with 1 day delay). + * `secret_id` - Secret Id. + + diff --git a/config/docs/d/cam_user_policy_attachments.html.markdown b/config/docs/d/cam_user_policy_attachments.html.markdown new file mode 100644 index 0000000..06c3b69 --- /dev/null +++ b/config/docs/d/cam_user_policy_attachments.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_user_policy_attachments" +sidebar_current: "docs-tencentcloud-datasource-cam_user_policy_attachments" +description: |- + Use this data source to query detailed information of CAM user policy attachments +--- + +# tencentcloud_cam_user_policy_attachments + +Use this data source to query detailed information of CAM user policy attachments + +## Example Usage + +```hcl +# query by user_id +data "tencentcloud_cam_user_policy_attachments" "foo" { + user_id = tencentcloud_cam_user.foo.id +} + +# query by user_id and policy_id +data "tencentcloud_cam_user_policy_attachments" "bar" { + user_id = tencentcloud_cam_user.foo.id + policy_id = tencentcloud_cam_policy.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `create_mode` - (Optional, Int) Mode of Creation of the CAM user policy attachment. `1` means the CAM policy attachment is created by production, and the others indicate syntax strategy ways. +* `policy_id` - (Optional, String) ID of CAM policy to be queried. +* `policy_type` - (Optional, String) Type of the policy strategy. 'User' means customer strategy and 'QCS' means preset strategy. +* `result_output_file` - (Optional, String) Used to save results. +* `user_id` - (Optional, String, **Deprecated**) It has been deprecated from version 1.59.6. Use `user_name` instead. ID of the attached CAM user to be queried. +* `user_name` - (Optional, String) Name of the attached CAM user as unique key to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `user_policy_attachment_list` - A list of CAM user policy attachments. Each element contains the following attributes: + * `create_mode` - Mode of Creation of the CAM user policy attachment. `1` means the cam policy attachment is created by production, and the others indicate syntax strategy ways. + * `create_time` - The create time of the CAM user policy attachment. + * `policy_id` - Name of CAM user. + * `policy_name` - The name of the policy. + * `policy_type` - Type of the policy strategy. 'User' means customer strategy and 'QCS' means preset strategy. + * `user_id` - (**Deprecated**) It has been deprecated from version 1.59.6. Use `user_name` instead. ID of CAM user. + * `user_name` - Name of CAM user as unique key. + + diff --git a/config/docs/d/cam_users.html.markdown b/config/docs/d/cam_users.html.markdown new file mode 100644 index 0000000..8e33eb1 --- /dev/null +++ b/config/docs/d/cam_users.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_users" +sidebar_current: "docs-tencentcloud-datasource-cam_users" +description: |- + Use this data source to query detailed information of CAM users +--- + +# tencentcloud_cam_users + +Use this data source to query detailed information of CAM users + +## Example Usage + +```hcl +# query by name +data "tencentcloud_cam_users" "foo" { + name = "cam-user-test" +} + +# query by email +data "tencentcloud_cam_users" "bar" { + email = "hello@test.com" +} + +# query by phone +data "tencentcloud_cam_users" "far" { + phone_num = "12345678910" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `console_login` - (Optional, Bool) Indicate whether the user can login in. +* `country_code` - (Optional, String) Country code of the CAM user to be queried. +* `email` - (Optional, String) Email of the CAM user to be queried. +* `name` - (Optional, String) Name of CAM user to be queried. +* `phone_num` - (Optional, String) Phone num of the CAM user to be queried. +* `remark` - (Optional, String) Remark of the CAM user to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `uid` - (Optional, Int) Uid of the CAM user to be queried. +* `uin` - (Optional, Int) Uin of the CAM user to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `user_list` - A list of CAM users. Each element contains the following attributes: + * `country_code` - Country code of the CAM user. + * `email` - Email of the CAM user. + * `name` - Name of CAM user. + * `phone_num` - Phone num of the CAM user. + * `remark` - Remark of the CAM user. + * `uid` - Uid of the CAM user. + * `uin` - Uin of the CAM user. + * `user_id` - ID of CAM user. Its value equals to `name` argument. + + diff --git a/config/docs/d/cat_metric_data.html.markdown b/config/docs/d/cat_metric_data.html.markdown new file mode 100644 index 0000000..de70a2c --- /dev/null +++ b/config/docs/d/cat_metric_data.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "Cloud Automated Testing(CAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cat_metric_data" +sidebar_current: "docs-tencentcloud-datasource-cat_metric_data" +description: |- + Use this data source to query detailed information of cat metric_data +--- + +# tencentcloud_cat_metric_data + +Use this data source to query detailed information of cat metric_data + +## Example Usage + +```hcl +data "tencentcloud_cat_metric_data" "metric_data" { + analyze_task_type = "AnalyzeTaskType_Network" + metric_type = "gauge" + field = "avg(\"ping_time\")" + filters = [ + "\"host\" = 'www.qq.com'", + "time >= now()-1h", + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `analyze_task_type` - (Required, String) Analysis of task type, supported types: `AnalyzeTaskType_Network`: network quality, `AnalyzeTaskType_Browse`: page performance, `AnalyzeTaskType_Transport`: port performance, `AnalyzeTaskType_UploadDownload`: file transport, `AnalyzeTaskType_MediaStream`: audiovisual experience. +* `field` - (Required, String) Detailed fields of metrics, specified metrics can be passed or aggregate metrics, such as avg(ping_time) means entire delay. +* `filters` - (Required, Set: [`String`]) Multiple condition filtering, supports combining multiple filtering conditions for query. +* `metric_type` - (Required, String) Metric type, metrics queries are passed with gauge by default. +* `filter` - (Optional, String) Filter conditions can be passed as a single filter or multiple parameters concatenated together. +* `group_by` - (Optional, String) Aggregation time, such as 1m, 1d, 30d, and so on. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `metric_set` - Return JSON string. + + diff --git a/config/docs/d/cat_node.html.markdown b/config/docs/d/cat_node.html.markdown new file mode 100644 index 0000000..9191e39 --- /dev/null +++ b/config/docs/d/cat_node.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Cloud Automated Testing(CAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cat_node" +sidebar_current: "docs-tencentcloud-datasource-cat_node" +description: |- + Use this data source to query detailed information of cat node +--- + +# tencentcloud_cat_node + +Use this data source to query detailed information of cat node + +## Example Usage + +```hcl +data "tencentcloud_cat_node" "node" { + node_type = 1 + location = 2 + is_ipv6 = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `is_ipv6` - (Optional, Bool) is IPv6. +* `location` - (Optional, Int) Node area:1=Chinese Mainland,2=Hong Kong, Macao and Taiwan,3=Overseas. +* `node_name` - (Optional, String) Node name. +* `node_type` - (Optional, Int) Node type 1:IDC,2:LastMile,3:Mobile. +* `pay_mode` - (Optional, Int) Payment mode:1=Trial version,2=Paid version. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `node_define` - Probe node list. + * `city` - City. + * `code_type` - If the node type is base, it is an availability dial test point; if it is blank, it is an advanced dial test point. + * `code` - Node ID. + * `district` - District. + * `ip_type` - IP type:1 = IPv4,2 = IPv6. + * `location` - Node area:1=Chinese Mainland,2=Hong Kong, Macao and Taiwan,3=Overseas. + * `name` - Node name. + * `net_service` - Network service provider. + * `node_define_status` - Node status: 1=running, 2=offline. + * `task_types` - The task types supported by the node. `1`: page performance, `2`: file upload, `3`: file download, `4`: port performance, `5`: network quality, `6`: audio and video experience. + * `type` - Node Type;1 = IDC,2 = LastMile,3 = Mobile. + + diff --git a/config/docs/d/cat_probe_data.html.markdown b/config/docs/d/cat_probe_data.html.markdown new file mode 100644 index 0000000..acad0d4 --- /dev/null +++ b/config/docs/d/cat_probe_data.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "Cloud Automated Testing(CAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cat_probe_data" +sidebar_current: "docs-tencentcloud-datasource-cat_probe_data" +description: |- + Use this data source to query detailed information of cat probe data +--- + +# tencentcloud_cat_probe_data + +Use this data source to query detailed information of cat probe data + +## Example Usage + +```hcl +data "tencentcloud_cat_probe_data" "probe_data" { + begin_time = 1667923200000 + end_time = 1667996208428 + task_type = "AnalyzeTaskType_Network" + sort_field = "ProbeTime" + ascending = true + selected_fields = ["terraform"] + offset = 0 + limit = 20 + task_id = ["task-knare1mk"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ascending` - (Required, Bool) true is Ascending. +* `begin_time` - (Required, Int) Start timestamp (in milliseconds). +* `end_time` - (Required, Int) End timestamp (in milliseconds). +* `limit` - (Required, Int) Limit. +* `offset` - (Required, Int) Offset. +* `selected_fields` - (Required, Set: [`String`]) Selected Fields. +* `sort_field` - (Required, String) Fields to be sorted ProbeTime dial test time sorting can be filled in You can also fill in the selected fields in SelectedFields. +* `task_type` - (Required, String) Task Type in AnalyzeTaskType_Network,AnalyzeTaskType_Browse,AnalyzeTaskType_UploadDownload,AnalyzeTaskType_Transport,AnalyzeTaskType_MediaStream. +* `city` - (Optional, Set: [`String`]) City list. +* `code` - (Optional, Set: [`String`]) Code list. +* `districts` - (Optional, Set: [`String`]) Districts list. +* `error_types` - (Optional, Set: [`String`]) ErrorTypes list. +* `operators` - (Optional, Set: [`String`]) Operators list. +* `result_output_file` - (Optional, String) Used to save results. +* `task_id` - (Optional, Set: [`String`]) TaskID list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `detailed_single_data_define` - Probe node list. + * `fields` - Fields. + * `id` - ID. + * `name` - Custom Field Name/Description. + * `value` - Value. + * `labels` - Labels. + * `id` - ID. + * `name` - Custom Field Name/Description. + * `value` - Value. + * `probe_time` - Probe time. + + diff --git a/config/docs/d/cbs_snapshot_policies.html.markdown b/config/docs/d/cbs_snapshot_policies.html.markdown new file mode 100644 index 0000000..7b08b25 --- /dev/null +++ b/config/docs/d/cbs_snapshot_policies.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_snapshot_policies" +sidebar_current: "docs-tencentcloud-datasource-cbs_snapshot_policies" +description: |- + Use this data source to query detailed information of CBS snapshot policies. +--- + +# tencentcloud_cbs_snapshot_policies + +Use this data source to query detailed information of CBS snapshot policies. + +## Example Usage + +```hcl +data "tencentcloud_cbs_snapshot_policies" "policies" { + snapshot_policy_id = "snap-f3io7adt" + snapshot_policy_name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `snapshot_policy_id` - (Optional, String) ID of the snapshot policy to be queried. +* `snapshot_policy_name` - (Optional, String) Name of the snapshot policy to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `snapshot_policy_list` - A list of snapshot policy. Each element contains the following attributes: + * `attached_storage_ids` - Storage IDs that the snapshot policy attached. + * `create_time` - Create time of the snapshot policy. + * `repeat_hours` - Trigger hours of periodic snapshot. + * `repeat_weekdays` - Trigger days of periodic snapshot. + * `retention_days` - Retention days of the snapshot. + * `snapshot_policy_id` - ID of the snapshot policy. + * `snapshot_policy_name` - Name of the snapshot policy. + * `status` - Status of the snapshot policy. + + diff --git a/config/docs/d/cbs_snapshots.html.markdown b/config/docs/d/cbs_snapshots.html.markdown new file mode 100644 index 0000000..d8b84f5 --- /dev/null +++ b/config/docs/d/cbs_snapshots.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_snapshots" +sidebar_current: "docs-tencentcloud-datasource-cbs_snapshots" +description: |- + Use this data source to query detailed information of CBS snapshots. +--- + +# tencentcloud_cbs_snapshots + +Use this data source to query detailed information of CBS snapshots. + +## Example Usage + +```hcl +data "tencentcloud_cbs_snapshots" "snapshots" { + snapshot_id = "snap-f3io7adt" + result_output_file = "mytestpath" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Optional, String) The available zone that the CBS instance locates at. +* `project_id` - (Optional, Int) ID of the project within the snapshot. +* `result_output_file` - (Optional, String) Used to save results. +* `snapshot_id` - (Optional, String) ID of the snapshot to be queried. +* `snapshot_name` - (Optional, String) Name of the snapshot to be queried. +* `storage_id` - (Optional, String) ID of the the CBS which this snapshot created from. +* `storage_usage` - (Optional, String) Types of CBS which this snapshot created from, and available values include SYSTEM_DISK and DATA_DISK. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `snapshot_list` - A list of snapshot. Each element contains the following attributes: + * `availability_zone` - The available zone that the CBS instance locates at. + * `create_time` - Creation time of snapshot. + * `encrypt` - Indicates whether the snapshot is encrypted. + * `percent` - Snapshot creation progress percentage. + * `project_id` - ID of the project within the snapshot. + * `snapshot_id` - ID of the snapshot. + * `snapshot_name` - Name of the snapshot. + * `storage_id` - ID of the the CBS which this snapshot created from. + * `storage_size` - Volume of storage which this snapshot created from. + * `storage_usage` - Types of CBS which this snapshot created from. + + diff --git a/config/docs/d/cbs_storages.html.markdown b/config/docs/d/cbs_storages.html.markdown new file mode 100644 index 0000000..4928f59 --- /dev/null +++ b/config/docs/d/cbs_storages.html.markdown @@ -0,0 +1,78 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_storages" +sidebar_current: "docs-tencentcloud-datasource-cbs_storages" +description: |- + Use this data source to query detailed information of CBS storages. +--- + +# tencentcloud_cbs_storages + +Use this data source to query detailed information of CBS storages. + +## Example Usage + +```hcl +data "tencentcloud_cbs_storages" "storages" { + storage_id = "disk-kdt0sq6m" + result_output_file = "mytestpath" +} +``` + +### The following snippet shows the new supported query params + +```hcl +data "tencentcloud_cbs_storages" "whats_new" { + charge_type = ["POSTPAID_BY_HOUR", "PREPAID"] + portable = true + storage_state = ["ATTACHED"] + instance_ips = ["10.0.0.2"] + instance_name = ["my-instance"] + tag_keys = ["foo"] + tag_values = ["bar", "baz"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Optional, String) The available zone that the CBS instance locates at. +* `charge_type` - (Optional, List: [`String`]) List filter by disk charge type (`POSTPAID_BY_HOUR` | `PREPAID`). +* `instance_ips` - (Optional, List: [`String`]) List filter by attached instance public or private IPs. +* `instance_name` - (Optional, List: [`String`]) List filter by attached instance name. +* `portable` - (Optional, Bool) Filter by whether the disk is portable (Boolean `true` or `false`). +* `project_id` - (Optional, Int) ID of the project with which the CBS is associated. +* `result_output_file` - (Optional, String) Used to save results. +* `storage_id` - (Optional, String) ID of the CBS to be queried. +* `storage_name` - (Optional, String) Name of the CBS to be queried. +* `storage_state` - (Optional, List: [`String`]) List filter by disk state (`UNATTACHED` | `ATTACHING` | `ATTACHED` | `DETACHING` | `EXPANDING` | `ROLLBACKING` | `TORECYCLE`). +* `storage_type` - (Optional, String) Filter by cloud disk media type (`CLOUD_BASIC`: HDD cloud disk | `CLOUD_PREMIUM`: Premium Cloud Storage | `CLOUD_SSD`: SSD cloud disk). +* `storage_usage` - (Optional, String) Filter by cloud disk type (`SYSTEM_DISK`: system disk | `DATA_DISK`: data disk). +* `tag_keys` - (Optional, List: [`String`]) List filter by tag keys. +* `tag_values` - (Optional, List: [`String`]) List filter by tag values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `storage_list` - A list of storage. Each element contains the following attributes: + * `attached` - Indicates whether the CBS is mounted the CVM. + * `availability_zone` - The zone of CBS. + * `charge_type` - Pay type of the CBS instance. + * `create_time` - Creation time of CBS. + * `encrypt` - Indicates whether CBS is encrypted. + * `instance_id` - ID of the CVM instance that be mounted by this CBS. + * `prepaid_renew_flag` - The way that CBS instance will be renew automatically or not when it reach the end of the prepaid tenancy. + * `project_id` - ID of the project. + * `status` - Status of CBS. + * `storage_id` - ID of CBS. + * `storage_name` - Name of CBS. + * `storage_size` - Volume of CBS. + * `storage_type` - Types of storage medium. + * `storage_usage` - Types of CBS. + * `tags` - The available tags within this CBS. + * `throughput_performance` - Add extra performance to the data disk. Only works when disk type is `CLOUD_TSSD` or `CLOUD_HSSD`. + + diff --git a/config/docs/d/cbs_storages_set.html.markdown b/config/docs/d/cbs_storages_set.html.markdown new file mode 100644 index 0000000..bc91577 --- /dev/null +++ b/config/docs/d/cbs_storages_set.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_storages_set" +sidebar_current: "docs-tencentcloud-datasource-cbs_storages_set" +description: |- + Use this data source to query detailed information of CBS storages in parallel. +--- + +# tencentcloud_cbs_storages_set + +Use this data source to query detailed information of CBS storages in parallel. + +## Example Usage + +```hcl +data "tencentcloud_cbs_storages_set" "storages" { + availability_zone = "ap-guangzhou-3" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Optional, String) The available zone that the CBS instance locates at. +* `charge_type` - (Optional, List: [`String`]) List filter by disk charge type (`POSTPAID_BY_HOUR` | `PREPAID`). +* `instance_ips` - (Optional, List: [`String`]) List filter by attached instance public or private IPs. +* `instance_name` - (Optional, List: [`String`]) List filter by attached instance name. +* `portable` - (Optional, Bool) Filter by whether the disk is portable (Boolean `true` or `false`). +* `project_id` - (Optional, Int) ID of the project with which the CBS is associated. +* `result_output_file` - (Optional, String) Used to save results. +* `storage_id` - (Optional, String) ID of the CBS to be queried. +* `storage_name` - (Optional, String) Name of the CBS to be queried. +* `storage_state` - (Optional, List: [`String`]) List filter by disk state (`UNATTACHED` | `ATTACHING` | `ATTACHED` | `DETACHING` | `EXPANDING` | `ROLLBACKING` | `TORECYCLE`). +* `storage_type` - (Optional, String) Filter by cloud disk media type (`CLOUD_BASIC`: HDD cloud disk | `CLOUD_PREMIUM`: Premium Cloud Storage | `CLOUD_SSD`: SSD cloud disk). +* `storage_usage` - (Optional, String) Filter by cloud disk type (`SYSTEM_DISK`: system disk | `DATA_DISK`: data disk). +* `tag_keys` - (Optional, List: [`String`]) List filter by tag keys. +* `tag_values` - (Optional, List: [`String`]) List filter by tag values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `storage_list` - A list of storage. Each element contains the following attributes: + * `attached` - Indicates whether the CBS is mounted the CVM. + * `availability_zone` - The zone of CBS. + * `charge_type` - Pay type of the CBS instance. + * `create_time` - Creation time of CBS. + * `encrypt` - Indicates whether CBS is encrypted. + * `instance_id` - ID of the CVM instance that be mounted by this CBS. + * `prepaid_renew_flag` - The way that CBS instance will be renew automatically or not when it reach the end of the prepaid tenancy. + * `project_id` - ID of the project. + * `status` - Status of CBS. + * `storage_id` - ID of CBS. + * `storage_name` - Name of CBS. + * `storage_size` - Volume of CBS. + * `storage_type` - Types of storage medium. + * `storage_usage` - Types of CBS. + * `tags` - The available tags within this CBS. + * `throughput_performance` - Add extra performance to the data disk. Only works when disk type is `CLOUD_TSSD` or `CLOUD_HSSD`. + + diff --git a/config/docs/d/ccn_bandwidth_limits.html.markdown b/config/docs/d/ccn_bandwidth_limits.html.markdown new file mode 100644 index 0000000..5607036 --- /dev/null +++ b/config/docs/d/ccn_bandwidth_limits.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_bandwidth_limits" +sidebar_current: "docs-tencentcloud-datasource-ccn_bandwidth_limits" +description: |- + Use this data source to query detailed information of CCN bandwidth limits. +--- + +# tencentcloud_ccn_bandwidth_limits + +Use this data source to query detailed information of CCN bandwidth limits. + +## Example Usage + +```hcl +variable "other_region1" { + default = "ap-shanghai" +} + +resource "tencentcloud_ccn" "main" { + name = "ci-temp-test-ccn" + description = "ci-temp-test-ccn-des" + qos = "AG" +} + +data "tencentcloud_ccn_bandwidth_limits" "limit" { + ccn_id = tencentcloud_ccn.main.id +} + +resource "tencentcloud_ccn_bandwidth_limit" "limit1" { + ccn_id = tencentcloud_ccn.main.id + region = var.other_region1 + bandwidth_limit = 500 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ccn_id` - (Required, String) ID of the CCN to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `limits` - The bandwidth limits of regions: + * `bandwidth_limit` - Limitation of bandwidth. + * `dst_region` - Destination area restriction. + * `region` - Limitation of region. + + diff --git a/config/docs/d/ccn_cross_border_compliance.html.markdown b/config/docs/d/ccn_cross_border_compliance.html.markdown new file mode 100644 index 0000000..c85dd54 --- /dev/null +++ b/config/docs/d/ccn_cross_border_compliance.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_cross_border_compliance" +sidebar_current: "docs-tencentcloud-datasource-ccn_cross_border_compliance" +description: |- + Use this data source to query detailed information of ccn cross_border_compliance +--- + +# tencentcloud_ccn_cross_border_compliance + +Use this data source to query detailed information of ccn cross_border_compliance + +## Example Usage + +```hcl +data "tencentcloud_ccn_cross_border_compliance" "cross_border_compliance" { + service_provider = "UNICOM" + compliance_id = 10002 + email = "test@tencent.com" + service_start_date = "2020-07-29" + service_end_date = "2021-07-29" + state = "APPROVED" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `business_address` - (Optional, String) (Fuzzy query) business license address. +* `company` - (Optional, String) (Fuzzy query) Company name. +* `compliance_id` - (Optional, Int) (Exact match) compliance approval form: 'ID'. +* `email` - (Optional, String) (Exact match) email. +* `issuing_authority` - (Optional, String) (Fuzzy query) Issuing authority. +* `legal_person` - (Optional, String) (Fuzzy query) legal representative. +* `manager_address` - (Optional, String) (Fuzzy query) ID card address of the person in charge. +* `manager_id` - (Optional, String) (Exact query) ID number of the person in charge. +* `manager_telephone` - (Optional, String) (Exact match) contact number of the person in charge. +* `manager` - (Optional, String) (Fuzzy query) Person in charge. +* `post_code` - (Optional, Int) (Exact match) post code. +* `result_output_file` - (Optional, String) Used to save results. +* `service_end_date` - (Optional, String) (Exact match) service end date, such as: '2020-07-28'. +* `service_provider` - (Optional, String) (Exact match) service provider, optional value: 'UNICOM'. +* `service_start_date` - (Optional, String) (Exact match) service start date, such as: '2020-07-28'. +* `state` - (Optional, String) (Exact match) status. Pending: PENDING, Passed: APPROVED, Denied: DENY. +* `uniform_social_credit_code` - (Optional, String) (Exact match) Uniform Social Credit Code. + + diff --git a/config/docs/d/ccn_cross_border_flow_monitor.html.markdown b/config/docs/d/ccn_cross_border_flow_monitor.html.markdown new file mode 100644 index 0000000..ff3acb3 --- /dev/null +++ b/config/docs/d/ccn_cross_border_flow_monitor.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_cross_border_flow_monitor" +sidebar_current: "docs-tencentcloud-datasource-ccn_cross_border_flow_monitor" +description: |- + Use this data source to query detailed information of vpc cross_border_flow_monitor +--- + +# tencentcloud_ccn_cross_border_flow_monitor + +Use this data source to query detailed information of vpc cross_border_flow_monitor + +## Example Usage + +```hcl +data "tencentcloud_ccn_cross_border_flow_monitor" "cross_border_flow_monitor" { + source_region = "ap-guangzhou" + destination_region = "ap-singapore" + ccn_id = "ccn-39lqkygf" + ccn_uin = "979137" + period = 60 + start_time = "2023-01-01 00:00:00" + end_time = "2023-01-01 01:00:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ccn_id` - (Required, String) CcnId. +* `ccn_uin` - (Required, String) CcnUin. +* `destination_region` - (Required, String) DestinationRegion. +* `end_time` - (Required, String) EndTime. +* `period` - (Required, Int) TimePeriod. +* `source_region` - (Required, String) SourceRegion. +* `start_time` - (Required, String) StartTime. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cross_border_flow_monitor_data` - monitor data of cross border. + * `in_bandwidth` - in bandwidth, `bps`. + * `in_pkg` - in pkg, `pps`. + * `out_bandwidth` - out bandwidth, `bps`. + * `out_pkg` - out pkg, `pps`. + + diff --git a/config/docs/d/ccn_cross_border_region_bandwidth_limits.html.markdown b/config/docs/d/ccn_cross_border_region_bandwidth_limits.html.markdown new file mode 100644 index 0000000..21a353d --- /dev/null +++ b/config/docs/d/ccn_cross_border_region_bandwidth_limits.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_cross_border_region_bandwidth_limits" +sidebar_current: "docs-tencentcloud-datasource-ccn_cross_border_region_bandwidth_limits" +description: |- + Use this data source to query detailed information of ccn_cross_border_region_bandwidth_limits +--- + +# tencentcloud_ccn_cross_border_region_bandwidth_limits + +Use this data source to query detailed information of ccn_cross_border_region_bandwidth_limits + +-> **NOTE:** This resource is dedicated to Unicom. + +## Example Usage + +```hcl +data "tencentcloud_ccn_cross_border_region_bandwidth_limits" "ccn_region_bandwidth_limits" { + filters { + name = "source-region" + values = ["ap-guangzhou"] + } + + filters { + name = "destination-region" + values = ["ap-shanghai"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter condition. Currently, only one value is supported. The supported fields, 1)source-region, the value is like ap-guangzhou; 2)destination-region, the value is like ap-shanghai; 3)ccn-ids,cloud network ID array, the value is like ccn-12345678; 4)user-account-id,user account ID, the value is like 12345678. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) attribute name. +* `values` - (Required, Set) Value of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `ccn_bandwidth_set` - Info of cross region ccn instance. + * `ccn_id` - ccn id. + * `ccn_region_bandwidth_limit` - bandwidth limit of cross region. + * `bandwidth_limit` - bandwidth list(Mbps). + * `destination_region` - destination region, such as. + * `source_region` - source region, such as 'ap-shanghai'. + * `created_time` - create time. + * `expired_time` - expired time. + * `instance_charge_type` - `POSTPAID` or `PREPAID`. + * `is_cross_border` - if cross region. + * `is_security_lock` - `true` means locked. + * `market_id` - market id. + * `region_flow_control_id` - Id of RegionFlowControl. + * `renew_flag` - renew flag. + * `update_time` - update time. + * `user_account_id` - user account id. + + diff --git a/config/docs/d/ccn_instances.html.markdown b/config/docs/d/ccn_instances.html.markdown new file mode 100644 index 0000000..a4f49e0 --- /dev/null +++ b/config/docs/d/ccn_instances.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_instances" +sidebar_current: "docs-tencentcloud-datasource-ccn_instances" +description: |- + Use this data source to query detailed information of CCN instances. +--- + +# tencentcloud_ccn_instances + +Use this data source to query detailed information of CCN instances. + +## Example Usage + +```hcl +resource "tencentcloud_ccn" "main" { + name = "ci-temp-test-ccn" + description = "ci-temp-test-ccn-des" + qos = "AG" +} + +data "tencentcloud_ccn_instances" "id_instances" { + ccn_id = tencentcloud_ccn.main.id +} + +data "tencentcloud_ccn_instances" "name_instances" { + name = tencentcloud_ccn.main.name +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ccn_id` - (Optional, String) ID of the CCN to be queried. +* `name` - (Optional, String) Name of the CCN to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - Information list of CCN. + * `attachment_list` - Information list of instance is attached. + * `attached_time` - Time of attaching. + * `cidr_block` - A network address block of the instance that is attached. + * `instance_id` - ID of instance is attached. + * `instance_region` - The region that the instance locates at. + * `instance_type` - Type of attached instance network, and available values include VPC, DIRECTCONNECT, BMVPC and VPNGW. + * `state` - States of instance is attached, and available values include PENDING, ACTIVE, EXPIRED, REJECTED, DELETED, FAILED(asynchronous forced disassociation after 2 hours), ATTACHING, DETACHING and DETACHFAILED(asynchronous forced disassociation after 2 hours). + * `bandwidth_limit_type` - The speed limit type. + * `ccn_id` - ID of the CCN. + * `charge_type` - Billing mode. + * `create_time` - Creation time of resource. + * `description` - Description of the CCN. + * `name` - Name of the CCN. + * `qos` - Service quality of CCN, and the available value include 'PT', 'AU', 'AG'. The default is 'AU'. + * `state` - States of instance. The available value include 'ISOLATED'(arrears) and 'AVAILABLE'. + + diff --git a/config/docs/d/ccn_tenant_instances.html.markdown b/config/docs/d/ccn_tenant_instances.html.markdown new file mode 100644 index 0000000..2108ad6 --- /dev/null +++ b/config/docs/d/ccn_tenant_instances.html.markdown @@ -0,0 +1,32 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_tenant_instances" +sidebar_current: "docs-tencentcloud-datasource-ccn_tenant_instances" +description: |- + Use this data source to query detailed information of vpc tenant_ccn +--- + +# tencentcloud_ccn_tenant_instances + +Use this data source to query detailed information of vpc tenant_ccn + +## Example Usage + +```hcl +data "tencentcloud_ccn_tenant_instances" "tenant_ccn" { + ccn_ids = ["ccn-39lqkygf"] + is_security_lock = ["true"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ccn_ids` - (Optional, Set: [`String`]) filter by ccn ids, like: ['ccn-12345678']. +* `is_security_lock` - (Optional, Set: [`String`]) filter by locked, like ['true']. +* `result_output_file` - (Optional, String) Used to save results. +* `user_account_id` - (Optional, Set: [`String`]) filter by ccn ids, like: ['12345678']. + + diff --git a/config/docs/d/cdh_instances.html.markdown b/config/docs/d/cdh_instances.html.markdown new file mode 100644 index 0000000..e480215 --- /dev/null +++ b/config/docs/d/cdh_instances.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "CVM Dedicated Host(CDH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cdh_instances" +sidebar_current: "docs-tencentcloud-datasource-cdh_instances" +description: |- + Use this data source to query CDH instances. +--- + +# tencentcloud_cdh_instances + +Use this data source to query CDH instances. + +## Example Usage + +```hcl +data "tencentcloud_cdh_instances" "list" { + availability_zone = "ap-guangzhou-3" + host_id = "host-d6s7i5q4" + host_name = "test" + host_state = "RUNNING" + project_id = 1154137 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Optional, String) The available zone that the CDH instance locates at. +* `host_id` - (Optional, String) ID of the CDH instances to be queried. +* `host_name` - (Optional, String) Name of the CDH instances to be queried. +* `host_state` - (Optional, String) State of the CDH instances to be queried. Valid values: `PENDING`, `LAUNCH_FAILURE`, `RUNNING`, `EXPIRED`. +* `project_id` - (Optional, Int) The project CDH belongs to. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cdh_instance_list` - An information list of cdh instance. Each element contains the following attributes: + * `availability_zone` - The available zone that the CDH instance locates at. + * `cage_id` - Cage ID of the CDH instance. This parameter is only valid for CDH instances in the cages of finance availability zones. + * `charge_type` - The charge type of the CDH instance. + * `create_time` - Creation time of the CDH instance. + * `cvm_instance_ids` - Id of CVM instances that have been created on the CDH instance. + * `expired_time` - Expired time of the CDH instance. + * `host_id` - ID of the CDH instance. + * `host_name` - Name of the CDH instance. + * `host_resource` - An information list of host resource. Each element contains the following attributes: + * `cpu_available_num` - The number of available CPU cores of the instance. + * `cpu_total_num` - The number of total CPU cores of the instance. + * `disk_available_size` - Instance disk available capacity, unit in GB. + * `disk_total_size` - Instance disk total capacity, unit in GB. + * `disk_type` - Type of the disk. + * `memory_available_size` - Instance memory available capacity, unit in GB. + * `memory_total_size` - Instance memory total capacity, unit in GB. + * `host_state` - State of the CDH instance. + * `host_type` - Type of the CDH instance. + * `prepaid_renew_flag` - Auto renewal flag. + * `project_id` - The project CDH belongs to. + + diff --git a/config/docs/d/cdn_domain_verifier.html.markdown b/config/docs/d/cdn_domain_verifier.html.markdown new file mode 100644 index 0000000..68bdc63 --- /dev/null +++ b/config/docs/d/cdn_domain_verifier.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Content Delivery Network(CDN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cdn_domain_verifier" +sidebar_current: "docs-tencentcloud-datasource-cdn_domain_verifier" +description: |- + Provides a resource to check or create a cdn Domain Verify Record +--- + +# tencentcloud_cdn_domain_verifier + +Provides a resource to check or create a cdn Domain Verify Record + +~> **NOTE:** + +## Example Usage + +```hcl +data "tencentcloud_cdn_domain_verifier" "vr" { + domain = "www.examplexxx123.com" + auto_verify = true # auto create record if not verified + freeze_record = true # once been freeze and verified, it will never be changed again +} + +locals { + recordValue = data.tencentcloud_cdn_domain_verifier.record + recordType = data.tencentcloud_cdn_domain_verifier.record_type +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Specify domain name, e.g. `www.examplexxx123.com`. +* `auto_verify` - (Optional, Bool) Specify whether to keep first create result instead of re-create again. +* `failed_reason` - (Optional, String) Indicates failed reason of verification. +* `freeze_record` - (Optional, Bool) Specify whether the verification record needs to be freeze instead of refresh every 8 hours, this used for domain verification. +* `result_output_file` - (Optional, String) Used for save result json. +* `verify_type` - (Optional, String) Specify verify type, values: `dns` (default), `file`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `file_verify_domains` - List of file verified domains. +* `file_verify_name` - Name of file verifications. +* `file_verify_url` - File verify URL guidance. +* `record_type` - Type of resolution. +* `record` - Resolution record value. +* `sub_domain` - Sub-domain resolution. +* `verify_result` - Verify result. + + diff --git a/config/docs/d/cdn_domains.html.markdown b/config/docs/d/cdn_domains.html.markdown new file mode 100644 index 0000000..109ac9a --- /dev/null +++ b/config/docs/d/cdn_domains.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "Content Delivery Network(CDN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cdn_domains" +sidebar_current: "docs-tencentcloud-datasource-cdn_domains" +description: |- + Use this data source to query the detail information of CDN domain. +--- + +# tencentcloud_cdn_domains + +Use this data source to query the detail information of CDN domain. + +## Example Usage + +```hcl +data "tencentcloud_cdn_domains" "foo" { + domain = "xxxx.com" + service_type = "web" + full_url_cache = false + origin_pull_protocol = "follow" + https_switch = "on" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Optional, String) Acceleration domain name. +* `full_url_cache` - (Optional, Bool) Whether to enable full-path cache. +* `https_switch` - (Optional, String) HTTPS configuration. Valid values: `on`, `off` and `processing`. +* `origin_pull_protocol` - (Optional, String) Origin-pull protocol configuration. Valid values: `http`, `https` and `follow`. +* `result_output_file` - (Optional, String) Used to save results. +* `service_type` - (Optional, String) Service type of acceleration domain name. The available value include `web`, `download` and `media`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `domain_list` - An information list of cdn domain. Each element contains the following attributes: + * `area` - Acceleration region. + * `cname` - CNAME address of domain name. + * `create_time` - Domain name creation time. + * `domain` - Acceleration domain name. + * `full_url_cache` - Whether to enable full-path cache. + * `https_config` - HTTPS acceleration configuration. It's a list and consist of at most one item. + * `http2_switch` - HTTP2 configuration switch. + * `https_switch` - HTTPS configuration switch. + * `ocsp_stapling_switch` - OCSP configuration switch. + * `spdy_switch` - Spdy configuration switch. + * `verify_client` - Client certificate authentication feature. + * `id` - Domain name ID. + * `origin` - Origin server configuration. + * `backup_origin_list` - Backup origin server list. + * `backup_origin_type` - Backup origin server type. + * `backup_server_name` - Host header used when accessing the backup origin server. If left empty, the ServerName of master origin server will be used by default. + * `cos_private_access` - When OriginType is COS, you can specify if access to private buckets is allowed. + * `origin_list` - Master origin server list. + * `origin_pull_protocol` - Origin-pull protocol configuration. + * `origin_type` - Master origin server type. + * `server_name` - Host header used when accessing the master origin server. If left empty, the acceleration domain name will be used by default. + * `project_id` - The project CDN belongs to. + * `range_origin_switch` - Sharding back to source configuration switch. + * `request_header` - Request header configuration. + * `header_rules` - Custom request header configuration rules. + * `header_mode` - Http header setting method. + * `header_name` - Http header name. + * `header_value` - Http header value. + * `rule_paths` - Rule paths. + * `rule_type` - Rule type. + * `switch` - Custom request header configuration switch. + * `rule_cache` - Advanced path cache configuration. + * `follow_origin_switch` - Follow the source station configuration switch. + * `ignore_set_cookie` - Ignore the Set-Cookie header of the origin site. + * `no_cache_switch` - Cache configuration switch. + * `re_validate` - Always check back to origin. + * `rule_paths` - Rule paths. + * `rule_type` - Rule type. + * `switch` - Cache configuration switch. + * `service_type` - Service type of acceleration domain name. + * `status` - Acceleration service status. + * `tags` - Tags of cdn domain. + * `update_time` - Last modified time of domain name. + + diff --git a/config/docs/d/cfs_access_groups.html.markdown b/config/docs/d/cfs_access_groups.html.markdown new file mode 100644 index 0000000..18a1316 --- /dev/null +++ b/config/docs/d/cfs_access_groups.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_access_groups" +sidebar_current: "docs-tencentcloud-datasource-cfs_access_groups" +description: |- + Use this data source to query the detail information of CFS access group. +--- + +# tencentcloud_cfs_access_groups + +Use this data source to query the detail information of CFS access group. + +## Example Usage + +```hcl +data "tencentcloud_cfs_access_groups" "access_groups" { + access_group_id = "pgroup-7nx89k7l" + name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_group_id` - (Optional, String) A specified access group ID used to query. +* `name` - (Optional, String) A access group Name used to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `access_group_list` - An information list of CFS access group. Each element contains the following attributes: + * `access_group_id` - ID of the access group. + * `create_time` - Creation time of the access group. + * `description` - Description of the access group. + * `name` - Name of the access group. + + diff --git a/config/docs/d/cfs_access_rules.html.markdown b/config/docs/d/cfs_access_rules.html.markdown new file mode 100644 index 0000000..1cba0e4 --- /dev/null +++ b/config/docs/d/cfs_access_rules.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_access_rules" +sidebar_current: "docs-tencentcloud-datasource-cfs_access_rules" +description: |- + Use this data source to query the detail information of CFS access rule. +--- + +# tencentcloud_cfs_access_rules + +Use this data source to query the detail information of CFS access rule. + +## Example Usage + +```hcl +data "tencentcloud_cfs_access_rules" "access_rules" { + access_group_id = "pgroup-7nx89k7l" + access_rule_id = "rule-qcndbqzj" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_group_id` - (Required, String) A specified access group ID used to query. +* `access_rule_id` - (Optional, String) A specified access rule ID used to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `access_rule_list` - An information list of CFS access rule. Each element contains the following attributes: + * `access_rule_id` - ID of the access rule. + * `auth_client_ip` - Allowed IP of the access rule. + * `priority` - The priority level of access rule. + * `rw_permission` - Read and write permissions. + * `user_permission` - The permissions of accessing users. + + diff --git a/config/docs/d/cfs_available_zone.html.markdown b/config/docs/d/cfs_available_zone.html.markdown new file mode 100644 index 0000000..c686f33 --- /dev/null +++ b/config/docs/d/cfs_available_zone.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_available_zone" +sidebar_current: "docs-tencentcloud-datasource-cfs_available_zone" +description: |- + Use this data source to query detailed information of cfs available_zone +--- + +# tencentcloud_cfs_available_zone + +Use this data source to query detailed information of cfs available_zone + +## Example Usage + +```hcl +data "tencentcloud_cfs_available_zone" "available_zone" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `region_zones` - Information such as resource availability in each AZ and the supported storage classes and protocols. + * `region_cn_name` - Region chinese name, such as `Guangzhou`. + * `region_name` - Region name, such as `bj`. + * `region_status` - Region availability. If a region has at least one AZ where resources are purchasable, this value will be AVAILABLE; otherwise, it will be UNAVAILABLE. + * `region` - Region name, such as `ap-beijing`. + * `zones` - Array of AZs. + * `types` - Array of classes. + * `prepayment` - Indicates whether prepaid is supported. true: yes; false: no. + * `protocols` - Protocol and sale details. + * `protocol` - Protocol type. Valid values: NFS, CIFS. + * `sale_status` - Sale status. Valid values: sale_out (sold out), saling (purchasable), no_saling (non-purchasable). + * `type` - Storage class. Valid values: SD (standard storage) and HP (high-performance storage). + * `zone_cn_name` - Chinese name of an AZ. + * `zone_id` - AZ ID. + * `zone_name` - Chinese and English names of an AZ. + * `zone` - AZ name. + + diff --git a/config/docs/d/cfs_file_system_clients.html.markdown b/config/docs/d/cfs_file_system_clients.html.markdown new file mode 100644 index 0000000..2f7662c --- /dev/null +++ b/config/docs/d/cfs_file_system_clients.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_file_system_clients" +sidebar_current: "docs-tencentcloud-datasource-cfs_file_system_clients" +description: |- + Use this data source to query detailed information of cfs file_system_clients +--- + +# tencentcloud_cfs_file_system_clients + +Use this data source to query detailed information of cfs file_system_clients + +## Example Usage + +```hcl +data "tencentcloud_cfs_file_system_clients" "file_system_clients" { + file_system_id = "cfs-iobiaxtj" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `file_system_id` - (Required, String) File system ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `client_list` - Client list. + * `cfs_vip` - IP address of the file system. + * `client_ip` - Client IP. + * `mount_directory` - Path in which the file system is mounted to the client. + * `vpc_id` - File system VPCID. + * `zone_name` - AZ name. + * `zone` - Name of the availability zone, e.g. ap-beijing-1. For more information, see regions and availability zones in the Overview document. + + diff --git a/config/docs/d/cfs_file_systems.html.markdown b/config/docs/d/cfs_file_systems.html.markdown new file mode 100644 index 0000000..2d36956 --- /dev/null +++ b/config/docs/d/cfs_file_systems.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_file_systems" +sidebar_current: "docs-tencentcloud-datasource-cfs_file_systems" +description: |- + Use this data source to query the detail information of cloud file systems(CFS). +--- + +# tencentcloud_cfs_file_systems + +Use this data source to query the detail information of cloud file systems(CFS). + +## Example Usage + +```hcl +data "tencentcloud_cfs_file_systems" "file_systems" { + file_system_id = "cfs-6hgquxmj" + name = "test" + availability_zone = "ap-guangzhou-3" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Optional, String) The available zone that the file system locates at. +* `file_system_id` - (Optional, String) A specified file system ID used to query. +* `name` - (Optional, String) A file system name used to query. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) ID of a vpc subnet. +* `vpc_id` - (Optional, String) ID of the vpc to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `file_system_list` - An information list of cloud file system. Each element contains the following attributes: + * `access_group_id` - ID of the access group. + * `availability_zone` - The available zone that the file system locates at. + * `create_time` - Creation time of the file system. + * `file_system_id` - ID of the file system. + * `fs_id` - Mount root-directory. + * `mount_ip` - IP of the file system. + * `name` - Name of the file system. + * `protocol` - Protocol of the file system. + * `size_limit` - Size limit of the file system. + * `size_used` - Size used of the file system. + * `status` - Status of the file system. + * `storage_type` - Storage type of the file system. + + diff --git a/config/docs/d/cfs_mount_targets.html.markdown b/config/docs/d/cfs_mount_targets.html.markdown new file mode 100644 index 0000000..bb999af --- /dev/null +++ b/config/docs/d/cfs_mount_targets.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_mount_targets" +sidebar_current: "docs-tencentcloud-datasource-cfs_mount_targets" +description: |- + Use this data source to query detailed information of cfs mount_targets +--- + +# tencentcloud_cfs_mount_targets + +Use this data source to query detailed information of cfs mount_targets + +## Example Usage + +```hcl +data "tencentcloud_cfs_mount_targets" "mount_targets" { + file_system_id = "cfs-iobiaxtj" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `file_system_id` - (Required, String) File system ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `mount_targets` - Mount target details. + * `ccn_id` - CCN instance ID used by CFS Turbo. + * `cidr_block` - CCN IP range used by CFS Turbo. + * `file_system_id` - File system ID. + * `fs_id` - Mount root-directory. + * `ip_address` - Mount target IP. + * `life_cycle_state` - Mount target status. + * `mount_target_id` - Mount target ID. + * `network_interface` - Network type. + * `subnet_id` - Subnet ID. + * `subnet_name` - Subnet name. + * `vpc_id` - VPC ID. + * `vpc_name` - VPC name. + + diff --git a/config/docs/d/cfw_edge_fw_switches.html.markdown b/config/docs/d/cfw_edge_fw_switches.html.markdown new file mode 100644 index 0000000..6efb6f5 --- /dev/null +++ b/config/docs/d/cfw_edge_fw_switches.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_edge_fw_switches" +sidebar_current: "docs-tencentcloud-datasource-cfw_edge_fw_switches" +description: |- + Use this data source to query detailed information of cfw edge_fw_switches +--- + +# tencentcloud_cfw_edge_fw_switches + +Use this data source to query detailed information of cfw edge_fw_switches + +## Example Usage + +```hcl +data "tencentcloud_cfw_edge_fw_switches" "example" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Ip switch list. + * `asset_type` - Asset Type. + * `instance_id` - Instance Id. + * `instance_name` - Instance Name. + * `intranet_ip` - Intranet Ip. + * `public_ip_type` - Public IP type. + * `public_ip` - public ip. + * `region` - region. + * `status` - status. + * `switch_mode` - switch mode. + * `vpc_id` - vpc id. + + diff --git a/config/docs/d/cfw_nat_fw_switches.html.markdown b/config/docs/d/cfw_nat_fw_switches.html.markdown new file mode 100644 index 0000000..366be68 --- /dev/null +++ b/config/docs/d/cfw_nat_fw_switches.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_nat_fw_switches" +sidebar_current: "docs-tencentcloud-datasource-cfw_nat_fw_switches" +description: |- + Use this data source to query detailed information of cfw nat_fw_switches +--- + +# tencentcloud_cfw_nat_fw_switches + +Use this data source to query detailed information of cfw nat_fw_switches + +## Example Usage + +### Query Nat instance'switch by instance id + +```hcl +data "tencentcloud_cfw_nat_fw_switches" "example" { + nat_ins_id = "cfwnat-18d2ba18" +} +``` + +### Or filter by switch status + +```hcl +data "tencentcloud_cfw_nat_fw_switches" "example" { + nat_ins_id = "cfwnat-18d2ba18" + status = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `nat_ins_id` - (Optional, String) Filter the NAT firewall instance to which the NAT firewall subnet switch belongs. +* `result_output_file` - (Optional, String) Used to save results. +* `status` - (Optional, Int) Switch status, 1 open; 0 close. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - NAT border firewall switch list data. + * `abnormal` - Whether the switch is abnormal, 0: normal, 1: abnormal. + * `cvm_num` - Cvm Num. + * `enable` - Effective status. + * `id` - ID. + * `nat_id` - NAT gatway Id. + * `nat_ins_id` - NAT firewall instance Id. + * `nat_ins_name` - NAT firewall instance name. + * `nat_name` - NAT gatway name. + * `region` - Region. + * `route_id` - Route Id. + * `route_name` - Route Name. + * `status` - Switch status. + * `subnet_cidr` - IPv4 CIDR. + * `subnet_id` - Subnet Id. + * `subnet_name` - Subnet Name. + * `vpc_id` - Vpc Id. + * `vpc_name` - Vpc Name. + + diff --git a/config/docs/d/cfw_vpc_fw_switches.html.markdown b/config/docs/d/cfw_vpc_fw_switches.html.markdown new file mode 100644 index 0000000..66755ce --- /dev/null +++ b/config/docs/d/cfw_vpc_fw_switches.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_vpc_fw_switches" +sidebar_current: "docs-tencentcloud-datasource-cfw_vpc_fw_switches" +description: |- + Use this data source to query detailed information of cfw vpc_fw_switches +--- + +# tencentcloud_cfw_vpc_fw_switches + +Use this data source to query detailed information of cfw vpc_fw_switches + +## Example Usage + +```hcl +data "tencentcloud_cfw_vpc_fw_switches" "example" { + vpc_ins_id = "cfwg-c8c2de41" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `vpc_ins_id` - (Required, String) Firewall instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `switch_list` - Switch list. + * `enable` - Switch status 0: off, 1: on. + * `status` - Switch status 0: normal, 1: switching. + * `switch_id` - Firewall switch ID. + * `switch_mode` - switch mode. + * `switch_name` - Firewall switch name. + + diff --git a/config/docs/d/chdfs_access_groups.html.markdown b/config/docs/d/chdfs_access_groups.html.markdown new file mode 100644 index 0000000..95f9292 --- /dev/null +++ b/config/docs/d/chdfs_access_groups.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Cloud HDFS(CHDFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_chdfs_access_groups" +sidebar_current: "docs-tencentcloud-datasource-chdfs_access_groups" +description: |- + Use this data source to query detailed information of chdfs access_groups +--- + +# tencentcloud_chdfs_access_groups + +Use this data source to query detailed information of chdfs access_groups + +## Example Usage + +```hcl +data "tencentcloud_chdfs_access_groups" "access_groups" { + vpc_id = "vpc-pewdpc0d" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `owner_uin` - (Optional, Int) get groups belongs to the owner uin, must set but only can use one of VpcId and OwnerUin to get the groups. +* `result_output_file` - (Optional, String) Used to save results. +* `vpc_id` - (Optional, String) get groups belongs to the vpc id, must set but only can use one of VpcId and OwnerUin to get the groups. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `access_groups` - access group list. + * `access_group_id` - access group id. + * `access_group_name` - access group name. + * `create_time` - create time. + * `description` - access group description. + * `vpc_id` - VPC ID. + * `vpc_type` - vpc network type(1:CVM, 2:BM 1.0). + + diff --git a/config/docs/d/chdfs_file_systems.html.markdown b/config/docs/d/chdfs_file_systems.html.markdown new file mode 100644 index 0000000..5892b32 --- /dev/null +++ b/config/docs/d/chdfs_file_systems.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud HDFS(CHDFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_chdfs_file_systems" +sidebar_current: "docs-tencentcloud-datasource-chdfs_file_systems" +description: |- + Use this data source to query detailed information of chdfs file_systems +--- + +# tencentcloud_chdfs_file_systems + +Use this data source to query detailed information of chdfs file_systems + +## Example Usage + +```hcl +data "tencentcloud_chdfs_file_systems" "file_systems" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `file_systems` - file system list. + * `app_id` - appid of the user. + * `block_size` - block size of the file system(byte). + * `capacity_quota` - capacity of the file system(byte). + * `create_time` - create time. + * `description` - desc of the file system. + * `enable_ranger` - check the ranger address or not. + * `file_system_id` - file system id. + * `file_system_name` - file system name. + * `posix_acl` - check POSIX ACL or not. + * `ranger_service_addresses` - ranger address list. + * `region` - region of the file system. + * `status` - status of the file system(1: creating create success 3: create failed). + * `super_users` - super users of the file system. + + diff --git a/config/docs/d/chdfs_mount_points.html.markdown b/config/docs/d/chdfs_mount_points.html.markdown new file mode 100644 index 0000000..6297a4a --- /dev/null +++ b/config/docs/d/chdfs_mount_points.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Cloud HDFS(CHDFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_chdfs_mount_points" +sidebar_current: "docs-tencentcloud-datasource-chdfs_mount_points" +description: |- + Use this data source to query detailed information of chdfs mount_points +--- + +# tencentcloud_chdfs_mount_points + +Use this data source to query detailed information of chdfs mount_points + +## Example Usage + +```hcl +data "tencentcloud_chdfs_mount_points" "mount_points" { + file_system_id = "f14mpfy5lh4e" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_group_id` - (Optional, String) get mount points belongs to access group id, only can use one of the AccessGroupId,FileSystemId,OwnerUin parameters. +* `file_system_id` - (Optional, String) get mount points belongs to file system id, only can use one of the AccessGroupId,FileSystemId,OwnerUin parameters. +* `owner_uin` - (Optional, Int) get mount points belongs to owner uin, only can use one of the AccessGroupId,FileSystemId,OwnerUin parameters. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `mount_points` - mount point list. + * `access_group_ids` - associated group ids. + * `create_time` - create time. + * `file_system_id` - mounted file system id. + * `mount_point_id` - mount point id. + * `mount_point_name` - mount point name. + * `status` - mount point status. + + diff --git a/config/docs/d/ckafka_acls.html.markdown b/config/docs/d/ckafka_acls.html.markdown new file mode 100644 index 0000000..208644b --- /dev/null +++ b/config/docs/d/ckafka_acls.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_acls" +sidebar_current: "docs-tencentcloud-datasource-ckafka_acls" +description: |- + Use this data source to query detailed acl information of Ckafka +--- + +# tencentcloud_ckafka_acls + +Use this data source to query detailed acl information of Ckafka + +## Example Usage + +```hcl +data "tencentcloud_ckafka_acls" "foo" { + instance_id = "ckafka-f9ife4zz" + resource_type = "TOPIC" + resource_name = "topic-tf-test" + host = "2" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Id of the ckafka instance. +* `resource_name` - (Required, String) ACL resource name, which is related to `resource_type`. For example, if `resource_type` is `TOPIC`, this field indicates the topic name; if `resource_type` is `GROUP`, this field indicates the group name. +* `resource_type` - (Required, String) ACL resource type. Valid values are `UNKNOWN`, `ANY`, `TOPIC`, `GROUP`, `CLUSTER`, `TRANSACTIONAL_ID`. Currently, only `TOPIC` is available, and other fields will be used for future ACLs compatible with open-source Kafka. +* `host` - (Optional, String) Host substr used for querying. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `acl_list` - A list of ckafka acls. Each element contains the following attributes: + * `host` - IP address allowed to access. + * `operation_type` - ACL operation mode. + * `permission_type` - ACL permission type, valid values are `UNKNOWN`, `ANY`, `DENY`, `ALLOW`, and `ALLOW` by default. Currently, CKafka supports `ALLOW` (equivalent to allow list), and other fields will be used for future ACLs compatible with open-source Kafka. + * `principal` - User which can access. `*` means that any user can access. + * `resource_name` - ACL resource name, which is related to `resource_type`. + * `resource_type` - ACL resource type. + + diff --git a/config/docs/d/ckafka_connect_resource.html.markdown b/config/docs/d/ckafka_connect_resource.html.markdown new file mode 100644 index 0000000..41ccacc --- /dev/null +++ b/config/docs/d/ckafka_connect_resource.html.markdown @@ -0,0 +1,145 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_connect_resource" +sidebar_current: "docs-tencentcloud-datasource-ckafka_connect_resource" +description: |- + Use this data source to query detailed information of ckafka connect_resource +--- + +# tencentcloud_ckafka_connect_resource + +Use this data source to query detailed information of ckafka connect_resource + +## Example Usage + +```hcl +data "tencentcloud_ckafka_connect_resource" "connect_resource" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `limit` - (Optional, Int) Return the number, the default is 20, the maximum is 100. +* `offset` - (Optional, Int) Page offset, default is 0. +* `resource_region` - (Optional, String) Keyword query of the connection source, query the connection in the connection management list in the local region according to the region (only support the connection source containing the region input). +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) Keyword for search. +* `type` - (Optional, String) connection source type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Connection source list. + * `connect_resource_list` - Resource List. + * `clickhouse_connect_param` - ClickHouse configuration, returned when Type is CLICKHOUSE. + * `is_update` - Whether to update to the associated Datahub task. + * `password` - The password of the connection source. + * `port` - ClickHouse port. + * `resource` - Instance resource of connection source. + * `self_built` - Whether the connection source is a self-built cluster. + * `service_vip` - Instance VIP of the connection source, when it is a Tencent Cloud instance, it is required. + * `uniq_vpc_id` - The vpc Id of the connection source, when it is a Tencent Cloud instance, it is required. + * `user_name` - The username of the connection source. + * `create_time` - Creation time. + * `ctsdb_connect_param` - Ctsdb configuration, returned when Type is CTSDB. + * `password` - The password of the connection source. + * `port` - Ctsdb port. + * `resource` - Instance resource of connection source. + * `service_vip` - Ctsdb vip. + * `uniq_vpc_id` - Ctsdb vpcId. + * `user_name` - The username of the connection source. + * `current_step` - The current step of the connection source. + * `datahub_task_count` - The number of Datahub tasks associated with this connection source. + * `description` - Description. + * `doris_connect_param` - Doris Configuration, returned when Type is DORIS. + * `be_port` - Doris's http load balancing connection port, usually mapped to be's 8040 port. + * `is_update` - Whether to update to the associated Datahub task. + * `password` - The password of the connection source. + * `port` - Doris jdbc Load balancing connection port, usually mapped to port 9030 of fe. + * `resource` - Instance resource of connection source. + * `self_built` - Whether the connection source is a self-built cluster. + * `service_vip` - Instance VIP of the connection source, when it is a Tencent Cloud instance, it is required. + * `uniq_vpc_id` - The vpc Id of the connection source, when it is a Tencent Cloud instance, it is required. + * `user_name` - The username of the connection source. + * `dts_connect_param` - Dts configuration, returned when Type is DTS. + * `group_id` - The id of the Dts consumer group. + * `is_update` - Whether to update to the associated Datahub task. + * `password` - The password of the Dts consumer group. + * `port` - Dts port. + * `resource` - Dts Id. + * `topic` - Topic subscribed by Dts. + * `user_name` - The UserName of the Dts consumer group. + * `error_message` - Error Messages. + * `es_connect_param` - Es configuration, return when Type is ES. + * `is_update` - Whether to update to the associated Datahub task. + * `password` - The password of the connection source. + * `port` - ES port. + * `resource` - Instance resource of connection source. + * `self_built` - Whether the connection source is a self-built cluster. + * `service_vip` - Instance VIP of the connection source, when it is a Tencent Cloud instance, it is required. + * `uniq_vpc_id` - The vpc Id of the connection source, when it is a Tencent Cloud instance, it is required. + * `user_name` - The username of the connection source. + * `kafka_connect_param` - Kafka configuration, returned when Type is KAFKA. + * `broker_address` - Broker address for Kafka connection, required for self-build. + * `is_update` - Whether to update to the associated Dip task. + * `region` - Instance resource region of CKafka connection source, required when crossing regions. + * `resource` - Instance resource of Kafka connection source, required when not self-built. + * `self_built` - Whether it is a self-built cluster. + * `maria_db_connect_param` - Mariadb configuration, returned when Type is MARIADB. + * `is_update` - Whether to update to the associated Datahub task. + * `password` - The password of the connection source. + * `port` - MariaDB port. + * `resource` - Instance resource of connection source. + * `service_vip` - Instance VIP of the connection source, when it is a Tencent Cloud instance, it is required. + * `uniq_vpc_id` - The vpc Id of the connection source, when it is a Tencent Cloud instance, it is required. + * `user_name` - The username of the connection source. + * `mongo_db_connect_param` - Mongo DB configuration, returned when Type is MONGODB. + * `is_update` - Whether to update to the associated Datahub task. + * `password` - The password of the connection source. + * `port` - MongoDB port. + * `resource` - Instance resource of connection source. + * `self_built` - Whether the connection source is a self-built cluster. + * `service_vip` - Instance VIP of the connection source, when it is a Tencent Cloud instance, it is required. + * `uniq_vpc_id` - The vpc Id of the connection source, when it is a Tencent Cloud instance, it is required. + * `user_name` - The username of the connection source. + * `mysql_connect_param` - Mysql configuration, returned when Type is MYSQL or TDSQL C MYSQL. + * `cluster_id` - Required when type is TDSQL C_MYSQL. + * `is_update` - Whether to update to the associated Datahub task. + * `password` - The password of the connection source. + * `port` - MySQL port. + * `resource` - MySQL Instance resource of connection source. + * `self_built` - Mysql Whether the connection source is a self-built cluster. + * `service_vip` - Instance VIP of the connection source, when it is a Tencent Cloud instance, it is required. + * `uniq_vpc_id` - The vpc Id of the connection source, when it is a Tencent Cloud instance, it is required. + * `user_name` - The username of the connection source. + * `postgre_sql_connect_param` - Postgresql configuration, returned when Type is POSTGRESQL or TDSQL C POSTGRESQL. + * `cluster_id` - Required when type is TDSQL C_POSTGRESQL. + * `is_update` - Whether to update to the associated Datahub task. + * `password` - The password of the connection source. + * `port` - PostgreSQL port. + * `resource` - Instance resource of connection source. + * `self_built` - Whether the connection source is a self-built cluster. + * `service_vip` - Instance VIP of the connection source, when it is a Tencent Cloud instance, it is required. + * `uniq_vpc_id` - The vpc Id of the connection source, when it is a Tencent Cloud instance, it is required. + * `user_name` - The username of the connection source. + * `resource_id` - Resource id. + * `resource_name` - Resource name. + * `sql_server_connect_param` - SQL Server configuration, returned when Type is SQLSERVER. + * `is_update` - Whether to update to the associated Dip task. + * `password` - The password of the connection source. + * `port` - SQLServer port. + * `resource` - Instance resource of connection source. + * `service_vip` - Instance VIP of the connection source, when it is a Tencent Cloud instance, it is required. + * `uniq_vpc_id` - The vpc Id of the connection source, when it is a Tencent Cloud instance, it is required. + * `user_name` - The username of the connection source. + * `status` - Resource status. + * `step_list` - Step List. + * `task_progress` - Creation progress percentage. + * `type` - Resource type. + * `total_count` - Number of connection sources. + + diff --git a/config/docs/d/ckafka_datahub_group_offsets.html.markdown b/config/docs/d/ckafka_datahub_group_offsets.html.markdown new file mode 100644 index 0000000..1aaf1dc --- /dev/null +++ b/config/docs/d/ckafka_datahub_group_offsets.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_datahub_group_offsets" +sidebar_current: "docs-tencentcloud-datasource-ckafka_datahub_group_offsets" +description: |- + Use this data source to query detailed information of ckafka datahub_group_offsets +--- + +# tencentcloud_ckafka_datahub_group_offsets + +Use this data source to query detailed information of ckafka datahub_group_offsets + +## Example Usage + +```hcl +data "tencentcloud_ckafka_datahub_group_offsets" "datahub_group_offsets" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group` - (Required, String) Kafka consumer group. +* `name` - (Required, String) topic name that the task subscribe. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) fuzzy match topicName. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `topic_list` - The topic array, where each element is a json object. + * `partitions` - The topic partition array, where each element is a json object. + * `error_code` - Error Code. + * `lag` - The number of unconsumed messages. + * `log_end_offset` - partition Log End Offset. + * `metadata` - Usually an empty string. + * `offset` - consumer offset. + * `partition` - topic partitionId. + * `topic` - topic name. + + diff --git a/config/docs/d/ckafka_datahub_task.html.markdown b/config/docs/d/ckafka_datahub_task.html.markdown new file mode 100644 index 0000000..3db4143 --- /dev/null +++ b/config/docs/d/ckafka_datahub_task.html.markdown @@ -0,0 +1,556 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_datahub_task" +sidebar_current: "docs-tencentcloud-datasource-ckafka_datahub_task" +description: |- + Use this data source to query detailed information of ckafka datahub_task +--- + +# tencentcloud_ckafka_datahub_task + +Use this data source to query detailed information of ckafka datahub_task + +## Example Usage + +```hcl +data "tencentcloud_ckafka_datahub_task" "datahub_task" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource` - (Optional, String) Resource. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) search key. +* `source_type` - (Optional, String) The source type. +* `target_type` - (Optional, String) Destination type of dump. +* `task_type` - (Optional, String) Task type, SOURCE|SINK. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `task_list` - Datahub task information list. + * `create_time` - CreateTime. + * `datahub_id` - Datahub Id. + * `error_message` - ErrorMessage. + * `source_resource` - data resource. + * `click_house_param` - ClickHouse config, Type CLICKHOUSE requierd. + * `cluster` - ClickHouse cluster. + * `database` - ClickHouse database name. + * `drop_cls` - When the member parameter Drop Invalid Message To Cls is set to true, the Drop Invalid Message parameter is invalid. + * `drop_cls_log_set` - cls LogSet id. + * `drop_cls_owneruin` - cls account. + * `drop_cls_region` - cls region. + * `drop_cls_topic_id` - cls topicId. + * `drop_invalid_message_to_cls` - Whether to deliver to cls. + * `drop_invalid_message` - Whether ClickHouse discards the message that fails to parse, the default is true. + * `ip` - ClickHouse ip. + * `password` - ClickHouse passwd. + * `port` - ClickHouse port. + * `resource` - resource id. + * `schema` - ClickHouse schema. + * `allow_null` - Whether the column item is allowed to be empty. + * `column_name` - column name. + * `json_key` - The json Key name corresponding to this column. + * `type` - type of table column. + * `self_built` - Whether it is a self-built cluster. + * `service_vip` - instance vip. + * `table` - ClickHouse table. + * `type` - ClickHouse type, emr-clickhouse: emr; cdw-clickhouse: cdwch; selfBuilt: "". + * `uniq_vpc_id` - instance vpc id. + * `user_name` - ClickHouse user name. + * `cls_param` - Cls configuration, Required when Type is CLS. + * `content_key` - Required when Decode Json is false. + * `decode_json` - Whether the produced information is in json format. + * `log_set` - LogSet id. + * `resource` - cls id. + * `time_field` - Specify the content of a field in the message as the time of the cls log. The format of the field content needs to be a second-level timestamp. + * `cos_param` - Cos configuration, required when Type is COS. + * `aggregate_batch_size` - The size of aggregated messages MB. + * `aggregate_interval` - time interval. + * `bucket_name` - cos bucket name. + * `directory_time_format` - Partition format formatted according to strptime time. + * `format_output_type` - The file format after message aggregation csv|json. + * `object_key_prefix` - Dumped object directory prefix. + * `object_key` - ObjectKey. + * `region` - region code. + * `ctsdb_param` - Ctsdb configuration, Required when Type is CTSDB. + * `ctsdb_metric` - Ctsdb metric. + * `resource` - resource id. + * `dts_param` - Dts configuration, required when Type is DTS. + * `group_id` - Dts consumer group Id. + * `group_password` - Dts consumer group passwd. + * `group_user` - Dts account. + * `ip` - Dts connection ip. + * `port` - Dts connection port. + * `resource` - Dts instance Id. + * `topic` - Dts topic. + * `tran_sql` - False to synchronize the original data, true to synchronize the parsed json format data, the default is true. + * `es_param` - Es configuration, required when Type is ES. + * `content_key` - key for data in non-json format. + * `database_primary_key` - When the message dumped to ES is the binlog of Database, if you need to synchronize database operations, that is, fill in the primary key of the database table when adding, deleting, and modifying operations to ES. + * `date_format` - Es date suffix. + * `document_id_field` - The field name of the document ID value dumped into Es. + * `drop_cls` - When the member parameter Drop Invalid Message To Cls is set to true, the Drop Invalid Message parameter is invalid. + * `drop_cls_log_set` - cls log set. + * `drop_cls_owneruin` - Delivery account of cls. + * `drop_cls_region` - The region where the cls is delivered. + * `drop_cls_topic_id` - topic of cls. + * `drop_invalid_message_to_cls` - Whether to deliver to cls. + * `drop_dlq` - dead letter queue. + * `dlq_type` - dlq type, CKAFKA|TOPIC. + * `kafka_param` - Ckafka type dlq. + * `compression_type` - Whether to compress when writing to the Topic, if it is not enabled, fill in none, if it is enabled, fill in open. + * `connector_sync_type` - ConnectorSyncType. + * `enable_toleration` - Enable the fault-tolerant instance and enable the dead-letter queue. + * `keep_partition` - KeepPartition. + * `msg_multiple` - 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). + * `offset_type` - Offset type, initial position earliest, latest position latest, time point position timestamp. + * `partition_num` - Partition num. + * `qps_limit` - Qps limit. + * `resource_name` - resource id name. + * `resource` - resource id. + * `self_built` - Whether it is a self-built cluster. + * `start_time` - It must be passed when the Offset type is timestamp, and the time stamp is passed, accurate to the second. + * `table_mappings` - The route from Table to Topic must be passed when the Distribute to multiple topics switch is turned on. + * `database` - database name. + * `table` - Table name, multiple tables, separated by (commas). + * `topic_id` - Topic ID. + * `topic` - Topic name. + * `topic_id` - Topic Id. + * `topic` - Topic name, multiple separated by,. + * `use_auto_create_topic` - whether the used topic need to be automatically created (currently only supports SOURCE inflow tasks, if you do not use to distribute to multiple topics, you need to fill in the topic name that needs to be automatically created in the Topic field). + * `use_table_mapping` - Distribute to multiple topics switch, the default is false. + * `zone_id` - Zone ID. + * `max_retry_attempts` - retry times. + * `retry_interval` - retry interval. + * `topic_param` - DIP Topic type dead letter queue. + * `compression_type` - Whether to perform compression when writing a topic, if it is not enabled, fill in none, if it is enabled, you can choose one of gzip, snappy, lz4 to fill in. + * `msg_multiple` - 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). + * `offset_type` - Offset type, initial position earliest, latest position latest, time point position timestamp. + * `resource` - The topic name of the topic sold separately. + * `start_time` - It must be passed when the Offset type is timestamp, and the time stamp is passed, accurate to the second. + * `topic_id` - TopicId. + * `use_auto_create_topic` - whether the used topic need to be automatically created (currently only supports SOURCE inflow tasks). + * `type` - type, DLQ dead letter queue, IGNORE_ERROR|DROP. + * `drop_invalid_json_message` - Whether Es discards messages in non-json format. + * `drop_invalid_message` - Whether Es discards the message of parsing failure. + * `index_type` - Es custom index name type, STRING, JSONPATH, the default is STRING. + * `index` - Es index name. + * `password` - Es Password. + * `port` - Es connection port. + * `resource` - Resource. + * `self_built` - Whether it is a self-built cluster. + * `service_vip` - instance vip. + * `uniq_vpc_id` - instance vpc id. + * `user_name` - Es UserName. + * `event_bus_param` - EB configuration, required when type is EB. + * `function_name` - SCF function name. + * `namespace` - SCF namespace. + * `qualifier` - SCF version and alias. + * `resource` - instance id. + * `self_built` - Whether it is a self-built cluster. + * `type` - resource type EB_COS/EB_ES/EB_CLS. + * `kafka_param` - ckafka configuration, required when Type is KAFKA. + * `compression_type` - Whether to compress when writing to the Topic, if it is not enabled, fill in none, if it is enabled, fill in open. + * `connector_sync_type` - ConnectorSyncType. + * `enable_toleration` - enable dead letter queue. + * `keep_partition` - KeepPartition. + * `msg_multiple` - 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). + * `offset_type` - Offset type, from beginning:earliest, from latest:latest, from specific time:timestamp. + * `partition_num` - the partition num of the topic. + * `qps_limit` - Qps(query per seconds) limit. + * `resource_name` - instance name. + * `resource` - instance resource. + * `self_built` - whether the cluster is built by yourself instead of cloud product. + * `start_time` - when Offset type timestamp is required. + * `table_mappings` - maps of table to topic, required when multi topic is selected. + * `database` - database name. + * `table` - table name. + * `topic_id` - Topic ID. + * `topic` - Topic name. + * `topic_id` - Topic Id. + * `topic` - Topic name, use `,` when more than 1 topic. + * `use_auto_create_topic` - Does the used topic need to be automatically created (currently only supports SOURCE inflow tasks, if you do not use to distribute to multiple topics, you need to fill in the topic name that needs to be automatically created in the Topic field). + * `use_table_mapping` - whether to use multi table. + * `zone_id` - Zone ID. + * `maria_db_param` - MariaDB configuration, Required when Type is MARIADB. + * `database` - MariaDB database name, * for all database. + * `include_content_changes` - If the value is all, DDL data and DML data will also be written to the selected topic; if the value is dml, only DML data will be written to the selected topic. + * `include_query` - If the value is true, and the value of the binlog rows query log events configuration item in My SQL is ON, the data flowing into the topic contains the original SQL statement; if the value is false, the data flowing into the topic does not contain Original SQL statement. + * `is_table_prefix` - When the Table input is a prefix, the value of this item is true, otherwise it is false. + * `key_columns` - Format library 1. table 1: field 1, field 2; library 2. table 2: field 2, between tables; (semicolon) separated, between fields, (comma) separated. The table that is not specified defaults to the primary key of the table. + * `output_format` - output format, DEFAULT, CANAL_1, CANAL_2. + * `record_with_schema` - If the value is true, the message will carry the schema corresponding to the message structure, if the value is false, it will not carry. + * `resource` - MariaDB connection Id. + * `snapshot_mode` - schema_only|initial, default initial. + * `table` - MariaDB db name, is the non-system table in all the monitored databases, you can use to monitor multiple data tables, but the data table needs to be filled in the format of data database name.data table name. + * `mongo_db_param` - MongoDB config, Required when Type is MONGODB. + * `collection` - MongoDB collection. + * `copy_existing` - Whether to copy the stock data, the default parameter is true. + * `database` - MongoDB database name. + * `ip` - Mongo DB connection ip. + * `listening_event` - Listening event type, if it is empty, it means select all. Values include insert, update, replace, delete, invalidate, drop, dropdatabase, rename, used between multiple types, separated by commas. + * `password` - MongoDB database password. + * `pipeline` - aggregation pipeline. + * `port` - MongoDB connection port. + * `read_preference` - Master-slave priority, default master node. + * `resource` - resource id. + * `self_built` - Whether it is a self-built cluster. + * `user_name` - MongoDB database user name. + * `my_sql_param` - MySQL configuration, Required when Type is MYSQL. + * `data_source_increment_column` - The name of the column to be monitored. + * `data_source_increment_mode` - TIMESTAMP indicates that the incremental column is of timestamp type, INCREMENT indicates that the incremental column is of self-incrementing id type'. + * `data_source_monitor_mode` - TABLE indicates that the read item is a table, QUERY indicates that the read item is a query. + * `data_source_monitor_resource` - When DataMonitorMode=TABLE, pass in the Table that needs to be read; when DataMonitorMode=QUERY, pass in the query sql statement that needs to be read. + * `data_source_start_from` - HEAD means copy stock + incremental data, TAIL means copy only incremental data. + * `data_target_insert_mode` - INSERT means insert using Insert mode, UPSERT means insert using Upsert mode. + * `data_target_primary_key_field` - When DataInsertMode=UPSERT, pass in the primary key that the current upsert depends on. + * `data_target_record_mapping` - Mapping relationship between tables and messages. + * `allow_null` - Whether the message is allowed to be empty. + * `auto_increment` - Whether it is an auto-increment column. + * `column_name` - Corresponding mapping column name. + * `column_size` - current column size. + * `decimal_digits` - current column precision. + * `default_value` - Database table default parameters. + * `extra_info` - Database table extra fields. + * `json_key` - The key name of the message. + * `type` - message type. + * `database` - MySQL database name, * is the whole database. + * `ddl_topic` - The Topic that stores the Ddl information of My SQL, if it is empty, it will not be stored by default. + * `drop_cls` - When the member parameter Drop Invalid Message To Cls is set to true, the Drop Invalid Message parameter is invalid. + * `drop_cls_log_set` - cls LogSet id. + * `drop_cls_owneruin` - account. + * `drop_cls_region` - The region where the cls is delivered. + * `drop_cls_topic_id` - cls topic. + * `drop_invalid_message_to_cls` - Whether to deliver to cls. + * `drop_invalid_message` - Whether to discard messages that fail to parse, the default is true. + * `include_content_changes` - If the value is all, DDL data and DML data will also be written to the selected topic; if the value is dml, only DML data will be written to the selected topic. + * `include_query` - If the value is true, and the value of the binlog rows query log events configuration item in My SQL is ON, the data flowing into the topic contains the original SQL statement; if the value is false, the data flowing into the topic does not contain Original SQL statement. + * `is_table_prefix` - When the Table input is a prefix, the value of this item is true, otherwise it is false. + * `is_table_regular` - Whether the input table is a regular expression, if this option and Is Table Prefix are true at the same time, the judgment priority of this option is higher than Is Table Prefix. + * `key_columns` - Format library1.table1 field 1,field 2;library 2.table2 field 2, between tables; (semicolon) separated, between fields, (comma) separated. The table that is not specified defaults to the primary key of the table. + * `output_format` - output format, DEFAULT, CANAL_1, CANAL_2. + * `record_with_schema` - If the value is true, the message will carry the schema corresponding to the message structure, if the value is false, it will not carry. + * `resource` - MySQL connection Id. + * `signal_database` - database name of signal table. + * `snapshot_mode` - whether to Copy inventory information (schema_only does not copy, initial full amount), the default is initial. + * `table` - The name of the MySQL data table, is the non-system table in all the monitored databases, which can be separated by, to monitor multiple data tables, but the data table needs to be filled in the format of data database name.data table name, when a regular expression needs to be filled in, the format is data database name.data table name. + * `topic_regex` - Regular expression for routing events to specific topics, defaults to (.*). + * `topic_replacement` - TopicRegex, $1, $2. + * `postgre_sql_param` - PostgreSQL configuration, Required when Type is POSTGRESQL or TDSQL C_POSTGRESQL. + * `data_format` - Upstream data format (JSON|Debezium), required when the database synchronization mode matches the default field. + * `data_target_insert_mode` - INSERT means insert using Insert mode, UPSERT means insert using Upsert mode. + * `data_target_primary_key_field` - When DataInsertMode=UPSERT, pass in the primary key that the current upsert depends on. + * `data_target_record_mapping` - Mapping relationship between tables and messages. + * `allow_null` - Whether the message is allowed to be empty. + * `auto_increment` - Whether it is an auto-increment column. + * `column_name` - Column Name. + * `column_size` - current ColumnSize. + * `decimal_digits` - current Column DecimalDigits. + * `default_value` - Database table default parameters. + * `extra_info` - Database table extra fields. + * `json_key` - The key name of the message. + * `type` - message type. + * `database` - PostgreSQL database name. + * `drop_invalid_message` - Whether to discard messages that fail to parse, the default is true. + * `is_table_regular` - Whether the input table is a regular expression. + * `key_columns` - Format library1.table1:field 1,field2;library2.table2:field2, between tables; (semicolon) separated, between fields, (comma) separated. The table that is not specified defaults to the primary key of the table. + * `plugin_name` - (decoderbufs/pgoutput), default decoderbufs. + * `record_with_schema` - If the value is true, the message will carry the schema corresponding to the message structure, if the value is false, it will not carry. + * `resource` - PostgreSQL connection Id. + * `snapshot_mode` - never|initial, default initial. + * `table` - PostgreSQL tableName, * is the non-system table in all the monitored databases, you can use, to monitor multiple data tables, but the data table needs to be filled in the format of Schema name.Data table name, and you need to fill in a regular expression When, the format is Schema name.data table name. + * `scf_param` - Scf configuration, Required when Type is SCF. + * `batch_size` - The maximum number of messages sent in each batch, the default is 1000. + * `function_name` - SCF function name. + * `max_retries` - The number of retries after the SCF call fails, the default is 5. + * `namespace` - SCF cloud function namespace, the default is default. + * `qualifier` - SCF cloud function version and alias, the default is DEFAULT. + * `sql_server_param` - SQLServer configuration, Required when Type is SQLSERVER. + * `database` - SQLServer database name. + * `resource` - SQLServer connection Id. + * `snapshot_mode` - schema_only|initial default initial. + * `table` - SQLServer table is the non-system table in all the monitored databases, you can use, to monitor multiple data tables, but the data table needs to be filled in the format of data database name.data table name. + * `tdw_param` - Tdw configuration, required when Type is TDW. + * `bid` - Tdw bid. + * `is_domestic` - default true. + * `tdw_host` - TDW address, defalt tl-tdbank-tdmanager.tencent-distribute.com. + * `tdw_port` - TDW port, default 8099. + * `tid` - Tdw tid. + * `topic_param` - Topic configuration, Required when Type is Topic. + * `compression_type` - Whether to perform compression when writing a topic, if it is not enabled, fill in none, if it is enabled, you can choose one of gzip, snappy, lz4 to fill in. + * `msg_multiple` - 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). + * `offset_type` - Offset type, initial position earliest, latest position latest, time point position timestamp. + * `resource` - The topic name of the topic sold separately. + * `start_time` - It must be passed when the Offset type is timestamp, and the time stamp is passed, accurate to the second. + * `topic_id` - Topic TopicId. + * `use_auto_create_topic` - whether the used topic need to be automatically created (currently only supports SOURCE inflow tasks). + * `type` - resource type. + * `status` - Status, -1 failed to create, 0 to create, 1 to run, 2 to delete, 3 to deleted, 4 to delete failed, 5 to pause, 6 to pause, 7 to pause, 8 to resume, 9 to resume failed. + * `step_list` - StepList. + * `target_resource` - Target Resource. + * `click_house_param` - ClickHouse config, Type CLICKHOUSE requierd. + * `cluster` - ClickHouse cluster. + * `database` - ClickHouse database name. + * `drop_cls` - When the member parameter Drop Invalid Message To Cls is set to true, the Drop Invalid Message parameter is invalid. + * `drop_cls_log_set` - cls LogSet id. + * `drop_cls_owneruin` - cls account. + * `drop_cls_region` - cls region. + * `drop_cls_topic_id` - cls topicId. + * `drop_invalid_message_to_cls` - Whether to deliver to cls. + * `drop_invalid_message` - Whether ClickHouse discards the message that fails to parse, the default is true. + * `ip` - ClickHouse ip. + * `password` - ClickHouse passwd. + * `port` - ClickHouse port. + * `resource` - resource id. + * `schema` - ClickHouse schema. + * `allow_null` - Whether the column item is allowed to be empty. + * `column_name` - column name. + * `json_key` - The json Key name corresponding to this column. + * `type` - type of table column. + * `self_built` - Whether it is a self-built cluster. + * `service_vip` - instance vip. + * `table` - ClickHouse table. + * `type` - ClickHouse type, emr-clickhouse: emr; cdw-clickhouse: cdwch; selfBuilt: "". + * `uniq_vpc_id` - instance vpc id. + * `user_name` - ClickHouse user name. + * `cls_param` - Cls configuration, Required when Type is CLS. + * `content_key` - Required when Decode Json is false. + * `decode_json` - Whether the produced information is in json format. + * `log_set` - LogSet id. + * `resource` - cls id. + * `time_field` - Specify the content of a field in the message as the time of the cls log. The format of the field content needs to be a second-level timestamp. + * `cos_param` - Cos configuration, required when Type is COS. + * `aggregate_batch_size` - The size of aggregated messages MB. + * `aggregate_interval` - time interval. + * `bucket_name` - cos bucket name. + * `directory_time_format` - Partition format formatted according to strptime time. + * `format_output_type` - The file format after message aggregation csv|json. + * `object_key_prefix` - Dumped object directory prefix. + * `object_key` - ObjectKey. + * `region` - region code. + * `ctsdb_param` - Ctsdb configuration, Required when Type is CTSDB. + * `ctsdb_metric` - Ctsdb metric. + * `resource` - resource id. + * `dts_param` - Dts configuration, required when Type is DTS. + * `group_id` - Dts consumer group Id. + * `group_password` - Dts consumer group passwd. + * `group_user` - Dts account. + * `ip` - Dts connection ip. + * `port` - Dts connection port. + * `resource` - Dts instance Id. + * `topic` - Dts topic. + * `tran_sql` - False to synchronize the original data, true to synchronize the parsed json format data, the default is true. + * `es_param` - Es configuration, required when Type is ES. + * `content_key` - key for data in non-json format. + * `database_primary_key` - When the message dumped to ES is the binlog of Database, if you need to synchronize database operations, that is, fill in the primary key of the database table when adding, deleting, and modifying operations to ES. + * `date_format` - Es date suffix. + * `document_id_field` - The field name of the document ID value dumped into Es. + * `drop_cls` - When the member parameter Drop Invalid Message To Cls is set to true, the Drop Invalid Message parameter is invalid. + * `drop_cls_log_set` - cls log set. + * `drop_cls_owneruin` - Delivery account of cls. + * `drop_cls_region` - The region where the cls is delivered. + * `drop_cls_topic_id` - topic of cls. + * `drop_invalid_message_to_cls` - Whether to deliver to cls. + * `drop_dlq` - dead letter queue. + * `dlq_type` - dlq type, CKAFKA|TOPIC. + * `kafka_param` - Ckafka type dlq. + * `compression_type` - Whether to compress when writing to the Topic, if it is not enabled, fill in none, if it is enabled, fill in open. + * `connector_sync_type` - ConnectorSyncType. + * `enable_toleration` - Enable the fault-tolerant instance and enable the dead-letter queue. + * `keep_partition` - KeepPartition. + * `msg_multiple` - 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). + * `offset_type` - Offset type, initial position earliest, latest position latest, time point position timestamp. + * `partition_num` - Partition num. + * `qps_limit` - Qps limit. + * `resource_name` - resource id name. + * `resource` - resource id. + * `self_built` - Whether it is a self-built cluster. + * `start_time` - It must be passed when the Offset type is timestamp, and the time stamp is passed, accurate to the second. + * `table_mappings` - The route from Table to Topic must be passed when the Distribute to multiple topics switch is turned on. + * `database` - database name. + * `table` - Table name, multiple tables, separated by (commas). + * `topic_id` - Topic ID. + * `topic` - Topic name. + * `topic_id` - Topic Id. + * `topic` - Topic name, multiple separated by. + * `use_auto_create_topic` - whether the used topic need to be automatically created (currently only supports SOURCE inflow tasks, if you do not use to distribute to multiple topics, you need to fill in the topic name that needs to be automatically created in the Topic field). + * `use_table_mapping` - Distribute to multiple topics switch, the default is false. + * `zone_id` - Zone ID. + * `max_retry_attempts` - retry times. + * `retry_interval` - retry interval. + * `topic_param` - DIP Topic type dead letter queue. + * `compression_type` - Whether to perform compression when writing a topic, if it is not enabled, fill in none, if it is enabled, you can choose one of gzip, snappy, lz4 to fill in. + * `msg_multiple` - 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). + * `offset_type` - Offset type, initial position earliest, latest position latest, time point position timestamp. + * `resource` - The topic name of the topic sold separately. + * `start_time` - It must be passed when the Offset type is timestamp, and the time stamp is passed, accurate to the second. + * `topic_id` - TopicId. + * `use_auto_create_topic` - whether the used topic need to be automatically created (currently only supports SOURCE inflow tasks). + * `type` - type, DLQ dead letter queue, IGNORE_ERROR|DROP. + * `drop_invalid_json_message` - Whether Es discards messages in non-json format. + * `drop_invalid_message` - Whether Es discards the message of parsing failure. + * `index_type` - Es custom index name type, STRING, JSONPATH, the default is STRING. + * `index` - Es index name. + * `password` - Es Password. + * `port` - Es connection port. + * `resource` - Resource. + * `self_built` - Whether it is a self-built cluster. + * `service_vip` - instance vip. + * `uniq_vpc_id` - instance vpc id. + * `user_name` - Es UserName. + * `event_bus_param` - EB configuration, required when type is EB. + * `function_name` - SCF function name. + * `namespace` - SCF namespace. + * `qualifier` - SCF version and alias. + * `resource` - instance id. + * `self_built` - Whether it is a self-built cluster. + * `type` - resource type EB_COS/EB_ES/EB_CLS. + * `kafka_param` - ckafka configuration, required when Type is KAFKA. + * `compression_type` - Whether to compress when writing to the Topic, if it is not enabled, fill in none, if it is enabled, fill in open. + * `connector_sync_type` - ConnectorSyncType. + * `enable_toleration` - enable dead letter queue. + * `keep_partition` - KeepPartition. + * `msg_multiple` - 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). + * `offset_type` - Offset type, from beginning:earliest, from latest:latest, from specific time:timestamp. + * `partition_num` - the partition num of the topic. + * `qps_limit` - Qps(query per seconds) limit. + * `resource_name` - instance name. + * `resource` - instance resource. + * `self_built` - whether the cluster is built by yourself instead of cloud product. + * `start_time` - when Offset type timestamp is required. + * `table_mappings` - maps of table to topic, required when multi topic is selected. + * `database` - database name. + * `table` - table name. + * `topic_id` - Topic ID. + * `topic` - Topic name. + * `topic_id` - Topic Id. + * `topic` - Topic name, use `,` when more than 1 topic. + * `use_auto_create_topic` - Does the used topic need to be automatically created (currently only supports SOURCE inflow tasks, if you do not use to distribute to multiple topics, you need to fill in the topic name that needs to be automatically created in the Topic field). + * `use_table_mapping` - whether to use multi table. + * `zone_id` - Zone ID. + * `maria_db_param` - MariaDB configuration, Required when Type is MARIADB. + * `database` - MariaDB database name, * for all database. + * `include_content_changes` - If the value is all, DDL data and DML data will also be written to the selected topic; if the value is dml, only DML data will be written to the selected topic. + * `include_query` - If the value is true, and the value of the binlog rows query log events configuration item in My SQL is ON, the data flowing into the topic contains the original SQL statement; if the value is false, the data flowing into the topic does not contain Original SQL statement. + * `is_table_prefix` - When the Table input is a prefix, the value of this item is true, otherwise it is false. + * `key_columns` - Format library 1. table 1: field 1, field 2; library 2. table 2: field 2, between tables; (semicolon) separated, between fields, (comma) separated. The table that is not specified defaults to the primary key of the table. + * `output_format` - output format, DEFAULT, CANAL_1, CANAL_2. + * `record_with_schema` - If the value is true, the message will carry the schema corresponding to the message structure, if the value is false, it will not carry. + * `resource` - MariaDB connection Id. + * `snapshot_mode` - schema_only|initial, default initial. + * `table` - MariaDB db name, is the non-system table in all the monitored databases, you can use, to monitor multiple data tables, but the data table needs to be filled in the format of data database name.data table name. + * `mongo_db_param` - MongoDB config, Required when Type is MONGODB. + * `collection` - MongoDB collection. + * `copy_existing` - Whether to copy the stock data, the default parameter is true. + * `database` - MongoDB database name. + * `ip` - Mongo DB connection ip. + * `listening_event` - Listening event type, if it is empty, it means select all. Values include insert, update, replace, delete, invalidate, drop, dropdatabase, rename, used between multiple types, separated by commas. + * `password` - MongoDB database password. + * `pipeline` - aggregation pipeline. + * `port` - MongoDB connection port. + * `read_preference` - Master-slave priority, default master node. + * `resource` - resource id. + * `self_built` - Whether it is a self-built cluster. + * `user_name` - MongoDB database user name. + * `my_sql_param` - MySQL configuration, Required when Type is MYSQL. + * `data_source_increment_column` - the name of the column to be monitored. + * `data_source_increment_mode` - TIMESTAMP indicates that the incremental column is of timestamp type, INCREMENT indicates that the incremental column is of self-incrementing id type. + * `data_source_monitor_mode` - TABLE indicates that the read item is a table, QUERY indicates that the read item is a query. + * `data_source_monitor_resource` - When DataMonitorMode=TABLE, pass in the Table that needs to be read; when DataMonitorMode=QUERY, pass in the query sql statement that needs to be read. + * `data_source_start_from` - HEAD means copy stock + incremental data, TAIL means copy only incremental data. + * `data_target_insert_mode` - INSERT means insert using Insert mode, UPSERT means insert using Upsert mode. + * `data_target_primary_key_field` - When DataInsertMode=UPSERT, pass in the primary key that the current upsert depends on. + * `data_target_record_mapping` - Mapping relationship between tables and messages. + * `allow_null` - Whether the message is allowed to be empty. + * `auto_increment` - Whether it is an auto-increment column. + * `column_name` - Corresponding mapping column name. + * `column_size` - current column size. + * `decimal_digits` - current column precision. + * `default_value` - Database table default parameters. + * `extra_info` - Database table extra fields. + * `json_key` - The key name of the message. + * `type` - message type. + * `database` - MySQL database name, * is the whole database. + * `ddl_topic` - The Topic that stores the Ddl information of My SQL, if it is empty, it will not be stored by default. + * `drop_cls` - When the member parameter Drop Invalid Message To Cls is set to true, the Drop Invalid Message parameter is invalid. + * `drop_cls_log_set` - cls LogSet id. + * `drop_cls_owneruin` - account. + * `drop_cls_region` - The region where the cls is delivered. + * `drop_cls_topic_id` - cls topic. + * `drop_invalid_message_to_cls` - Whether to deliver to cls. + * `drop_invalid_message` - Whether to discard messages that fail to parse, the default is true. + * `include_content_changes` - If the value is all, DDL data and DML data will also be written to the selected topic; if the value is dml, only DML data will be written to the selected topic. + * `include_query` - If the value is true, and the value of the binlog rows query log events configuration item in My SQL is ON, the data flowing into the topic contains the original SQL statement; if the value is false, the data flowing into the topic does not contain Original SQL statement. + * `is_table_prefix` - When the Table input is a prefix, the value of this item is true, otherwise it is false. + * `is_table_regular` - Whether the input table is a regular expression, if this option and Is Table Prefix are true at the same time, the judgment priority of this option is higher than Is Table Prefix. + * `key_columns` - Format library1.table1 field 1,field 2;library 2.table2 field 2, between tables; (semicolon) separated, between fields, (comma) separated. The table that is not specified defaults to the primary key of the table. + * `output_format` - output format, DEFAULT, CANAL_1, CANAL_2. + * `record_with_schema` - If the value is true, the message will carry the schema corresponding to the message structure, if the value is false, it will not carry. + * `resource` - MySQL connection Id. + * `signal_database` - database name of signal table. + * `snapshot_mode` - whether to Copy inventory information (schema_only does not copy, initial full amount), the default is initial. + * `table` - The name of the MySQL data table is the non-system table in all the monitored databases, which can be separated by, to monitor multiple data tables, but the data table needs to be filled in the format of data database name.data table name, when a regular expression needs to be filled in, the format is data database name.data table name. + * `topic_regex` - Regular expression for routing events to specific topics, defaults to (.*). + * `topic_replacement` - TopicRegex, $1, $2. + * `postgre_sql_param` - PostgreSQL configuration, Required when Type is POSTGRESQL or TDSQL C_POSTGRESQL. + * `data_format` - Upstream data format (JSON|Debezium), required when the database synchronization mode matches the default field. + * `data_target_insert_mode` - INSERT means insert using Insert mode, UPSERT means insert using Upsert mode. + * `data_target_primary_key_field` - When DataInsertMode=UPSERT, pass in the primary key that the current upsert depends on. + * `data_target_record_mapping` - Mapping relationship between tables and messages. + * `allow_null` - Whether the message is allowed to be empty. + * `auto_increment` - Whether it is an auto-increment column. + * `column_name` - Column Name. + * `column_size` - current ColumnSize. + * `decimal_digits` - current Column DecimalDigits. + * `default_value` - Database table default parameters. + * `extra_info` - Database table extra fields. + * `json_key` - The key name of the message. + * `type` - message type. + * `database` - PostgreSQL database name. + * `drop_invalid_message` - Whether to discard messages that fail to parse, the default is true. + * `is_table_regular` - Whether the input table is a regular expression. + * `key_columns` - Format library1.table1:field 1,field2;library2.table2:field2, between tables; (semicolon) separated, between fields, (comma) separated. The table that is not specified defaults to the primary key of the table. + * `plugin_name` - (decoderbufs/pgoutput), default decoderbufs. + * `record_with_schema` - If the value is true, the message will carry the schema corresponding to the message structure, if the value is false, it will not carry. + * `resource` - PostgreSQL connection Id. + * `snapshot_mode` - never|initial, default initial. + * `table` - PostgreSQL tableName, is the non-system table in all the monitored databases, you can use, to monitor multiple data tables, but the data table needs to be filled in the format of Schema name.Data table name, and you need to fill in a regular expression When, the format is Schema name.data table name. + * `scf_param` - Scf configuration, Required when Type is SCF. + * `batch_size` - The maximum number of messages sent in each batch, the default is 1000. + * `function_name` - SCF function name. + * `max_retries` - The number of retries after the SCF call fails, the default is 5. + * `namespace` - SCF cloud function namespace, the default is default. + * `qualifier` - SCF cloud function version and alias, the default is DEFAULT. + * `sql_server_param` - SQLServer configuration, Required when Type is SQLSERVER. + * `database` - SQLServer database name. + * `resource` - SQLServer connection Id. + * `snapshot_mode` - schema_only|initial default initial. + * `table` - SQLServer table, is the non-system table in all the monitored databases, you can use, to monitor multiple data tables, but the data table needs to be filled in the format of data database name.data table name. + * `tdw_param` - Tdw configuration, required when Type is TDW. + * `bid` - Tdw bid. + * `is_domestic` - default true. + * `tdw_host` - TDW address, defalt tl-tdbank-tdmanager.tencent-distribute.com. + * `tdw_port` - TDW port, default 8099. + * `tid` - Tdw tid. + * `topic_param` - Topic configuration, Required when Type is Topic. + * `compression_type` - Whether to perform compression when writing a topic, if it is not enabled, fill in none, if it is enabled, you can choose one of gzip, snappy, lz4 to fill in. + * `msg_multiple` - 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). + * `offset_type` - Offset type, initial position earliest, latest position latest, time point position timestamp. + * `resource` - The topic name of the topic sold separately. + * `start_time` - It must be passed when the Offset type is timestamp, and the time stamp is passed, accurate to the second. + * `topic_id` - Topic TopicId. + * `use_auto_create_topic` - whether the used topic need to be automatically created (currently only supports SOURCE inflow tasks). + * `type` - Resource Type. + * `task_current_step` - Task Current Step. + * `task_id` - task ID. + * `task_name` - TaskName. + * `task_progress` - Creation progress percentage. + * `task_type` - TaskType, SOURCE|SINK. + + diff --git a/config/docs/d/ckafka_datahub_topic.html.markdown b/config/docs/d/ckafka_datahub_topic.html.markdown new file mode 100644 index 0000000..31e10ab --- /dev/null +++ b/config/docs/d/ckafka_datahub_topic.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_datahub_topic" +sidebar_current: "docs-tencentcloud-datasource-ckafka_datahub_topic" +description: |- + Use this data source to query detailed information of ckafka datahub_topic +--- + +# tencentcloud_ckafka_datahub_topic + +Use this data source to query detailed information of ckafka datahub_topic + +## Example Usage + +```hcl +data "tencentcloud_ckafka_datahub_topic" "datahub_topic" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `limit` - (Optional, Int) The maximum number of results returned this time, the default is 50, and the maximum value is 50. +* `offset` - (Optional, Int) The offset position of this query, the default is 0. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) query key word. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `topic_list` - Topic list. + * `name` - name. + * `note` - Remark. + * `partition_num` - number of partitions. + * `retention_ms` - Expiration. + * `status` - Status, 1 in use, 2 in deletion. + * `topic_id` - Topic Id. + * `topic_name` - Topic name. + + diff --git a/config/docs/d/ckafka_group.html.markdown b/config/docs/d/ckafka_group.html.markdown new file mode 100644 index 0000000..9e7d6a9 --- /dev/null +++ b/config/docs/d/ckafka_group.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_group" +sidebar_current: "docs-tencentcloud-datasource-ckafka_group" +description: |- + Use this data source to query detailed information of ckafka group +--- + +# tencentcloud_ckafka_group + +Use this data source to query detailed information of ckafka group + +## Example Usage + +```hcl +data "tencentcloud_ckafka_group" "group" { + instance_id = "ckafka-xxxxxxx" + search_word = "xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) InstanceId. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) search for the keyword. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `group_list` - GroupList. + * `group` - groupId. + * `protocol` - The protocol used by this group. + + diff --git a/config/docs/d/ckafka_group_info.html.markdown b/config/docs/d/ckafka_group_info.html.markdown new file mode 100644 index 0000000..0873c7f --- /dev/null +++ b/config/docs/d/ckafka_group_info.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_group_info" +sidebar_current: "docs-tencentcloud-datasource-ckafka_group_info" +description: |- + Use this data source to query detailed information of ckafka group_info +--- + +# tencentcloud_ckafka_group_info + +Use this data source to query detailed information of ckafka group_info + +## Example Usage + +```hcl +data "tencentcloud_ckafka_group_info" "group_info" { + instance_id = "ckafka-xxxxxx" + group_list = ["xxxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_list` - (Required, Set: [`String`]) Kafka consumption group, Consumer-group, here is an array format, format GroupList.0=xxx&amp;GroupList.1=yyy. +* `instance_id` - (Required, String) InstanceId. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - result. + * `error_code` - Error code, normally 0. + * `group` - Kafka consumer group. + * `members` - This array contains information only if state is Stable and protocol_type is consumer. + * `assignment` - Stores the partition information assigned to the consumer. + * `topics` - topic list. + * `partitions` - Allocated partition information. + * `topic` - Assigned topic name. + * `version` - assignment version information. + * `client_host` - Generally store the customer's IP address. + * `client_id` - The client.id information set by the client consumer SDK itself. + * `member_id` - ID that the coordinator generated for consumer. + * `protocol_type` - The protocol type selected by the consumption group is normally the consumer, but some systems use their own protocol, such as kafka-connect, which uses connect. Only the standard consumer protocol, this interface knows the format of the specific allocation method, and can analyze the specific partition allocation. + * `protocol` - Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin|sticky. + * `state` - Group state description (commonly Empty, Stable, and Dead states): Dead: The consumption group does not exist Empty: The consumption group does not currently have any consumer subscriptions PreparingRebalance: The consumption group is in the rebalance state CompletingRebalance: The consumption group is in the rebalance state Stable: Each consumer in the consumption group has joined and is in a stable state. + + diff --git a/config/docs/d/ckafka_group_offsets.html.markdown b/config/docs/d/ckafka_group_offsets.html.markdown new file mode 100644 index 0000000..2e876d8 --- /dev/null +++ b/config/docs/d/ckafka_group_offsets.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_group_offsets" +sidebar_current: "docs-tencentcloud-datasource-ckafka_group_offsets" +description: |- + Use this data source to query detailed information of ckafka group_offsets +--- + +# tencentcloud_ckafka_group_offsets + +Use this data source to query detailed information of ckafka group_offsets + +## Example Usage + +```hcl +data "tencentcloud_ckafka_group_offsets" "group_offsets" { + instance_id = "ckafka-xxxxxx" + group = "xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group` - (Required, String) Kafka consumer group name. +* `instance_id` - (Required, String) InstanceId. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) fuzzy match topicName. +* `topics` - (Optional, Set: [`String`]) An array of topic names subscribed by the group, if there is no such array, it means all topic information under the specified group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `topic_list` - The topic array, where each element is a json object. + * `partitions` - he topic partition array, where each element is a json object. + * `error_code` - ErrorCode. + * `lag` - The number of unconsumed messages. + * `log_end_offset` - The latest offset of the current partition. + * `metadata` - When consumers submit messages, they can pass in metadata for other purposes. Currently, it is usually an empty string. + * `offset` - The offset of the position. + * `partition` - topic partitionId. + * `topic` - topicName. + + diff --git a/config/docs/d/ckafka_instances.html.markdown b/config/docs/d/ckafka_instances.html.markdown new file mode 100644 index 0000000..d236cc3 --- /dev/null +++ b/config/docs/d/ckafka_instances.html.markdown @@ -0,0 +1,80 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_instances" +sidebar_current: "docs-tencentcloud-datasource-ckafka_instances" +description: |- + Use this data source to query detailed instance information of Ckafka +--- + +# tencentcloud_ckafka_instances + +Use this data source to query detailed instance information of Ckafka + +## Example Usage + +```hcl +data "tencentcloud_ckafka_instances" "foo" { + instance_ids = ["ckafka-vv7wpvae"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter. filter.name supports ('Ip', 'VpcId', 'SubNetId', 'InstanceType','InstanceId'), filter.values can pass up to 10 values. +* `instance_ids` - (Optional, List: [`String`]) Filter by instance ID. +* `limit` - (Optional, Int) The number of pages, default is `10`. +* `offset` - (Optional, Int) The page start offset, default is `0`. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) Filter by instance name, support fuzzy query. +* `status` - (Optional, List: [`Int`]) (Filter Criteria) The status of the instance. 0: Create, 1: Run, 2: Delete, do not fill the default return all. +* `tag_key` - (Optional, String) Matches the tag key value. + +The `filters` object supports the following: + +* `name` - (Required, String) The field that needs to be filtered. +* `values` - (Required, List) The filtered value of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - A list of ckafka users. Each element contains the following attributes: + * `bandwidth` - Instance bandwidth, in Mbps. + * `create_time` - The time when the instance was created. + * `cvm` - ckafka sale type. Note: This field may return null, indicating that a valid value could not be retrieved. + * `disk_size` - The storage size of the instance, in GB. + * `disk_type` - Disk Type. Note: This field may return null, indicating that a valid value could not be retrieved. + * `expire_time` - The instance expiration time. + * `healthy_message` - Instance status information. + * `healthy` - Instance status int: 1 indicates health, 2 indicates alarm, and 3 indicates abnormal instance status. + * `instance_id` - The instance ID. + * `instance_name` - The instance name. + * `instance_type` - ckafka instance type. Note: This field may return null, indicating that a valid value could not be retrieved. + * `is_internal` - Whether it is an internal customer. A value of 1 indicates an internal customer. + * `max_partition_number` - The maximum number of Partitions for the current specifications. Note: This field may return null, indicating that a valid value could not be retrieved. + * `max_topic_number` - The maximum number of topics in the current specifications. Note: This field may return null, indicating that a valid value could not be retrieved.. + * `partition_number` - The current number of instances. Note: This field may return null, indicating that a valid value could not be retrieved.. + * `public_network_charge_type` - The type of Internet bandwidth. Note: This field may return null, indicating that a valid value could not be retrieved.. + * `public_network` - The Internet bandwidth value. Note: This field may return null, indicating that a valid value could not be retrieved.. + * `rebalance_time` - Schedule the upgrade configuration time. Note: This field may return null, indicating that a valid value could not be retrieved.. + * `renew_flag` - Whether the instance is renewed, the int enumeration value: 1 indicates auto-renewal, and 2 indicates that it is not automatically renewed. + * `status` - The status of the instance. 0: Created, 1: Running, 2: Delete: 5 Quarantined, -1 Creation failed. + * `subnet_id` - Subnet id. + * `tags` - Tag information. + * `tag_key` - Tag Key. + * `tag_value` - Tag Value. + * `topic_num` - The number of topics. + * `version` - Kafka version information. Note: This field may return null, indicating that a valid value could not be retrieved. + * `vip_list` - Virtual IP entities. + * `vip` - Virtual IP. + * `vport` - Virtual PORT. + * `vip` - Virtual IP. + * `vpc_id` - VpcId, if empty, indicates that it is the underlying network. + * `vport` - Virtual PORT. + * `zone_id` - Availability Zone ID. + * `zone_ids` - Across Availability Zones. Note: This field may return null, indicating that a valid value could not be retrieved. + + diff --git a/config/docs/d/ckafka_region.html.markdown b/config/docs/d/ckafka_region.html.markdown new file mode 100644 index 0000000..3351ebe --- /dev/null +++ b/config/docs/d/ckafka_region.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_region" +sidebar_current: "docs-tencentcloud-datasource-ckafka_region" +description: |- + Use this data source to query detailed information of ckafka region +--- + +# tencentcloud_ckafka_region + +Use this data source to query detailed information of ckafka region + +## Example Usage + +```hcl +data "tencentcloud_ckafka_region" "region" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return a list of region enumeration results. + * `area_name` - area name. + * `ipv6` - Whether to support ipv6, 0: means not supported, 1: means supported. + * `multi_zone` - Whether to support cross-availability zones, 0: means not supported, 1: means supported. + * `region_code_v3` - Region Code(V3 version). + * `region_code` - Region Code. + * `region_id` - region ID. + * `region_name` - geographical name. + * `support` - NONE: The default value does not support any special models CVM: Supports CVM types. + + diff --git a/config/docs/d/ckafka_task_status.html.markdown b/config/docs/d/ckafka_task_status.html.markdown new file mode 100644 index 0000000..bff048c --- /dev/null +++ b/config/docs/d/ckafka_task_status.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_task_status" +sidebar_current: "docs-tencentcloud-datasource-ckafka_task_status" +description: |- + Use this data source to query detailed information of ckafka task_status +--- + +# tencentcloud_ckafka_task_status + +Use this data source to query detailed information of ckafka task_status + +## Example Usage + +```hcl +data "tencentcloud_ckafka_task_status" "task_status" { + flow_id = 123456 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `flow_id` - (Required, Int) FlowId. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Result. + * `output` - OutPut Info. + * `status` - Status. + + diff --git a/config/docs/d/ckafka_topic_flow_ranking.html.markdown b/config/docs/d/ckafka_topic_flow_ranking.html.markdown new file mode 100644 index 0000000..3d9a842 --- /dev/null +++ b/config/docs/d/ckafka_topic_flow_ranking.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_topic_flow_ranking" +sidebar_current: "docs-tencentcloud-datasource-ckafka_topic_flow_ranking" +description: |- + Use this data source to query detailed information of ckafka topic_flow_ranking +--- + +# tencentcloud_ckafka_topic_flow_ranking + +Use this data source to query detailed information of ckafka topic_flow_ranking + +## Example Usage + +```hcl +data "tencentcloud_ckafka_topic_flow_ranking" "topic_flow_ranking" { + instance_id = "ckafka-xxxxxx" + ranking_type = "PRO" + begin_date = "2023-05-29T00:00:00+08:00" + end_date = "2021-05-29T23:59:59+08:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) InstanceId. +* `ranking_type` - (Required, String) Ranking type. `PRO`: topic production flow, `CON`: topic consumption traffic. +* `begin_date` - (Optional, String) BeginDate. +* `end_date` - (Optional, String) EndDate. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - result. + * `consume_speed` - ConsumeSpeed. + * `consumer_group_name` - ConsumerGroupName. + * `speed` - Speed. + * `topic_flow` - TopicFlow. + * `message_heap` - Topic MessageHeap. + * `partition_num` - partitionNum. + * `replica_num` - ReplicaNum. + * `topic_id` - topicId. + * `topic_name` - topicName. + * `topic_traffic` - TopicTraffic. + * `topic_message_heap` - TopicMessageHeapRanking. + * `message_heap` - Topic MessageHeap. + * `partition_num` - PartitionNum. + * `replica_num` - ReplicaNum. + * `topic_id` - topicId. + * `topic_name` - topicName. + * `topic_traffic` - TopicTraffic. + + diff --git a/config/docs/d/ckafka_topic_produce_connection.html.markdown b/config/docs/d/ckafka_topic_produce_connection.html.markdown new file mode 100644 index 0000000..ad9267d --- /dev/null +++ b/config/docs/d/ckafka_topic_produce_connection.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_topic_produce_connection" +sidebar_current: "docs-tencentcloud-datasource-ckafka_topic_produce_connection" +description: |- + Use this data source to query detailed information of ckafka topic_produce_connection +--- + +# tencentcloud_ckafka_topic_produce_connection + +Use this data source to query detailed information of ckafka topic_produce_connection + +## Example Usage + +```hcl +data "tencentcloud_ckafka_topic_produce_connection" "topic_produce_connection" { + instance_id = "ckafka-xxxxxx" + topic_name = "topic-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) InstanceId. +* `topic_name` - (Required, String) TopicName. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - link information return result set. + * `ip_addr` - ip address. + * `is_un_support_version` - Is the supported version. + * `time` - connect time. + + diff --git a/config/docs/d/ckafka_topic_subscribe_group.html.markdown b/config/docs/d/ckafka_topic_subscribe_group.html.markdown new file mode 100644 index 0000000..68b0385 --- /dev/null +++ b/config/docs/d/ckafka_topic_subscribe_group.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_topic_subscribe_group" +sidebar_current: "docs-tencentcloud-datasource-ckafka_topic_subscribe_group" +description: |- + Use this data source to query detailed information of ckafka topic_subscribe_group +--- + +# tencentcloud_ckafka_topic_subscribe_group + +Use this data source to query detailed information of ckafka topic_subscribe_group + +## Example Usage + +```hcl +data "tencentcloud_ckafka_topic_subscribe_group" "topic_subscribe_group" { + instance_id = "ckafka-xxxxxx" + topic_name = "xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) InstanceId. +* `topic_name` - (Required, String) TopicName. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `groups_info` - Consumer group information. + * `error_code` - Error code, normally 0. + * `group` - Kafka consumer group. + * `members` - This array contains information only if state is Stable and protocol_type is consumer. + * `assignment` - Stores the partition information assigned to the consumer. + * `topics` - topic list. + * `partitions` - partition list. + * `topic` - topic name. + * `version` - assignment version information. + * `client_host` - Generally store the customer's IP address. + * `client_id` - The client.id information set by the client consumer SDK itself. + * `member_id` - ID that the coordinator generated for consumer. + * `protocol_type` - The protocol type selected by the consumption group is normally the consumer, but some systems use their own protocol, such as kafka-connect, which uses connect. Only the standard consumer protocol, this interface knows the format of the specific allocation method, and can analyze the specific partition allocation. + * `protocol` - Common consumer partition allocation algorithms are as follows (the default option for Kafka consumer SDK is range) range|roundrobin| sticky. + * `state` - Group state description (commonly Empty, Stable, and Dead states): Dead: The consumption group does not exist Empty: The consumption group does not currently have any consumer subscriptions PreparingRebalance: The consumption group is in the rebalance state CompletingRebalance: The consumption group is in the rebalance state Stable: Each consumer in the consumption group has joined and is in a stable state. + + diff --git a/config/docs/d/ckafka_topic_sync_replica.html.markdown b/config/docs/d/ckafka_topic_sync_replica.html.markdown new file mode 100644 index 0000000..66cb239 --- /dev/null +++ b/config/docs/d/ckafka_topic_sync_replica.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_topic_sync_replica" +sidebar_current: "docs-tencentcloud-datasource-ckafka_topic_sync_replica" +description: |- + Use this data source to query detailed information of ckafka topic_sync_replica +--- + +# tencentcloud_ckafka_topic_sync_replica + +Use this data source to query detailed information of ckafka topic_sync_replica + +## Example Usage + +```hcl +data "tencentcloud_ckafka_topic_sync_replica" "topic_sync_replica" { + instance_id = "ckafka-xxxxxx" + topic_name = "xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) InstanceId. +* `topic_name` - (Required, String) TopicName. +* `out_of_sync_replica_only` - (Optional, Bool) Filter only unsynced replicas. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `topic_in_sync_replica_list` - Topic details and copy collection. + * `begin_offset` - BeginOffset. + * `end_offset` - EndOffset. + * `in_sync_replica` - ISR. + * `leader` - Leader Id. + * `message_count` - Message Count. + * `out_of_sync_replica` - Out Of Sync Replica. + * `partition` - partition name. + * `replica` - replica set. + + diff --git a/config/docs/d/ckafka_topics.html.markdown b/config/docs/d/ckafka_topics.html.markdown new file mode 100644 index 0000000..a1aac5f --- /dev/null +++ b/config/docs/d/ckafka_topics.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_topics" +sidebar_current: "docs-tencentcloud-datasource-ckafka_topics" +description: |- + Use this data source to query detailed information of ckafka topic. +--- + +# tencentcloud_ckafka_topics + +Use this data source to query detailed information of ckafka topic. + +## Example Usage + +```hcl +resource "tencentcloud_ckafka_topic" "foo" { + instance_id = "ckafka-f9ife4zz" + topic_name = "example" + note = "topic note" + replica_num = 2 + partition_num = 1 + enable_white_list = true + ip_white_list = ["ip1", "ip2"] + clean_up_policy = "delete" + sync_replica_min_num = 1 + unclean_leader_election_enable = false + segment = 3600000 + retention = 60000 + max_message_bytes = 1024 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Ckafka instance ID. +* `result_output_file` - (Optional, String) Used to store results. +* `topic_name` - (Optional, String) Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). The length range is from 1 to 64. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - A list of instances. Each element contains the following attributes. + * `clean_up_policy` - Clear log policy, log clear mode. `delete`: logs are deleted according to the storage time, `compact`: logs are compressed according to the key, `compact, delete`: logs are compressed according to the key and will be deleted according to the storage time. + * `create_time` - Create time of the CKafka topic. + * `enable_white_list` - Whether to open the IP Whitelist. `true`: open, `false`: close. + * `forward_cos_bucket` - Data backup cos bucket: the bucket address that is dumped to cos. + * `forward_interval` - Periodic frequency of data backup to cos. + * `forward_status` - Data backup cos status. `1`: do not open data backup, `0`: open data backup. + * `ip_white_list_count` - IP Whitelist count. + * `max_message_bytes` - Max message bytes. + * `note` - CKafka topic note description. + * `partition_num` - The number of partition. + * `replica_num` - The number of replica. + * `retention` - Message can be selected. Retention time(unit ms). + * `segment_bytes` - Number of bytes rolled by shard. + * `segment` - Segment scrolling time, in ms. + * `sync_replica_min_num` - Min number of sync replicas. + * `topic_id` - ID of the CKafka topic. + * `topic_name` - Name of the CKafka topic. + * `unclean_leader_election_enable` - Whether to allow unsynchronized replicas to be selected as leader, default is `false`, `true: `allowed, `false`: not allowed. + + diff --git a/config/docs/d/ckafka_users.html.markdown b/config/docs/d/ckafka_users.html.markdown new file mode 100644 index 0000000..00497bc --- /dev/null +++ b/config/docs/d/ckafka_users.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_users" +sidebar_current: "docs-tencentcloud-datasource-ckafka_users" +description: |- + Use this data source to query detailed user information of Ckafka +--- + +# tencentcloud_ckafka_users + +Use this data source to query detailed user information of Ckafka + +## Example Usage + +```hcl +data "tencentcloud_ckafka_users" "foo" { + instance_id = "ckafka-f9ife4zz" + account_name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Id of the ckafka instance. +* `account_name` - (Optional, String) Account name used when query ckafka users' infos. Could be a substr of user name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `user_list` - A list of ckafka users. Each element contains the following attributes: + * `account_name` - Account name of user. + * `create_time` - Creation time of the account. + * `update_time` - The last update time of the account. + + diff --git a/config/docs/d/ckafka_zone.html.markdown b/config/docs/d/ckafka_zone.html.markdown new file mode 100644 index 0000000..8b79988 --- /dev/null +++ b/config/docs/d/ckafka_zone.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_zone" +sidebar_current: "docs-tencentcloud-datasource-ckafka_zone" +description: |- + Use this data source to query detailed information of ckafka zone +--- + +# tencentcloud_ckafka_zone + +Use this data source to query detailed information of ckafka zone + +## Example Usage + +```hcl +data "tencentcloud_ckafka_zone" "ckafka_zone" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cdc_id` - (Optional, String) cdc professional cluster business parameters. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - query result complex object entity. + * `cluster_info` - User exclusive cluster information. + * `available_band_width` - The current available bandwidth of the cluster in MBs. + * `available_disk_size` - The current available disk of the cluster, in GB. + * `cluster_id` - ClusterId. + * `cluster_name` - ClusterName. + * `max_band_width` - Maximum cluster bandwidth in MBs. + * `max_disk_size` - The largest disk in the cluster, in GB. + * `zone_id` - Availability zone to which the cluster belongs, indicating the availability zone to which the cluster belongs. + * `zone_ids` - The availability zone where the cluster node is located. If the cluster is a cross-availability zone cluster, it includes multiple availability zones where the cluster node is located. + * `max_bandwidth` - Maximum purchased bandwidth in Mbs. + * `max_buy_instance_num` - The maximum number of purchased instances. + * `message_price` - Postpaid message unit price. + * `real_total_cost` - discount price. + * `total_cost` - original price. + * `physical` - Physical Exclusive Edition Configuration. + * `profession` - Professional Edition configuration. + * `public_network_limit` - Public network bandwidth configuration. + * `public_network` - Public network bandwidth. + * `standard_s2` - Standard Edition S2 configuration. + * `standard` - Purchase Standard Edition Configuration. + * `unit_price` - Postpaid unit price. + * `real_total_cost` - discount price. + * `total_cost` - original price. + * `zone_list` - zone list. + * `app_id` - app id. + * `exflag` - extra flag. + * `flag` - flag. + * `is_internal_app` - internal APP. + * `sales_info` - Standard Edition Sold Out Information. + * `flag` - Manually set flags. + * `platform` - Professional Edition, Standard Edition flag. + * `sold_out` - sold out flag: true sold out. + * `version` - ckakfa version(1.1.1/2.4.2/0.10.2). + * `sold_out` - json object, key is model, value true is sold out, false is not sold out. + * `zone_id` - zone id. + * `zone_name` - zone name. + * `zone_status` - zone status. + + diff --git a/config/docs/d/clb_attachments.html.markdown b/config/docs/d/clb_attachments.html.markdown new file mode 100644 index 0000000..58a849c --- /dev/null +++ b/config/docs/d/clb_attachments.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_attachments" +sidebar_current: "docs-tencentcloud-datasource-clb_attachments" +description: |- + Use this data source to query detailed information of CLB attachments +--- + +# tencentcloud_clb_attachments + +Use this data source to query detailed information of CLB attachments + +## Example Usage + +```hcl +data "tencentcloud_clb_attachments" "clblab" { + listener_id = "lbl-hh141sn9" + clb_id = "lb-k2zjp9lv" + rule_id = "loc-4xxr2cy7" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_id` - (Required, String) ID of the CLB to be queried. +* `listener_id` - (Required, String) ID of the CLB listener to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `rule_id` - (Optional, String) ID of the CLB listener rule. If the protocol of listener is `HTTP`/`HTTPS`, this para is required. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `attachment_list` - A list of cloud load balancer attachment configurations. Each element contains the following attributes: + * `clb_id` - ID of the CLB. + * `listener_id` - ID of the CLB listener. + * `protocol_type` - Type of protocol within the listener, and available values include `TCP`, `UDP`, `HTTP`, `HTTPS` and `TCP_SSL`. NOTES: `TCP_SSL` is testing internally, please apply if you need to use. + * `rule_id` - ID of the CLB listener rule. + * `targets` - Information of the backends to be attached. + * `instance_id` - Id of the backend server. + * `port` - Port of the backend server. + * `weight` - Forwarding weight of the backend service, the range of [0, 100], defaults to `10`. + + diff --git a/config/docs/d/clb_cluster_resources.html.markdown b/config/docs/d/clb_cluster_resources.html.markdown new file mode 100644 index 0000000..d118bdf --- /dev/null +++ b/config/docs/d/clb_cluster_resources.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_cluster_resources" +sidebar_current: "docs-tencentcloud-datasource-clb_cluster_resources" +description: |- + Use this data source to query detailed information of clb cluster_resources +--- + +# tencentcloud_clb_cluster_resources + +Use this data source to query detailed information of clb cluster_resources + +## Example Usage + +```hcl +data "tencentcloud_clb_cluster_resources" "cluster_resources" { + filters { + name = "idle" + values = ["True"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter conditions to query cluster. cluster-id - String - Required: No - (Filter condition) Filter by cluster ID, such as tgw-12345678. vip - String - Required: No - (Filter condition) Filter by loadbalancer vip, such as 192.168.0.1. loadblancer-id - String - Required: No - (Filter condition) Filter by loadblancer ID, such as lbl-12345678. idle - String - Required: No - (Filter condition) Filter by Whether load balancing is idle, such as True, False. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Filter name. +* `values` - (Required, Set) Filter values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cluster_resource_set` - Cluster resource set. + * `cluster_id` - Cluster ID. + * `cluster_name` - cluster name. + * `clusters_zone` - clusters zone. + * `master_zone` - Availability master zone where the cluster is located. + * `slave_zone` - Availability slave zone where the cluster is located. + * `idle` - Is it idle. + * `isp` - Isp. + * `load_balancer_id` - Loadbalance Id. + * `vip` - vip. + + diff --git a/config/docs/d/clb_cross_targets.html.markdown b/config/docs/d/clb_cross_targets.html.markdown new file mode 100644 index 0000000..cb3a21b --- /dev/null +++ b/config/docs/d/clb_cross_targets.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_cross_targets" +sidebar_current: "docs-tencentcloud-datasource-clb_cross_targets" +description: |- + Use this data source to query detailed information of clb cross_targets +--- + +# tencentcloud_clb_cross_targets + +Use this data source to query detailed information of clb cross_targets + +## Example Usage + +```hcl +data "tencentcloud_clb_cross_targets" "cross_targets" { + filters { + name = "vpc-id" + values = ["vpc-4owdpnwr"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter conditions to query CVMs and ENIs: vpc-id - String - Required: No - (Filter condition) Filter by VPC ID, such as vpc-12345678. ip - String - Required: No - (Filter condition) Filter by real server IP, such as 192.168.0.1. listener-id - String - Required: No - (Filter condition) Filter by listener ID, such as lbl-12345678. location-id - String - Required: No - (Filter condition) Filter by forwarding rule ID of the layer-7 listener, such as loc-12345678. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Filter name. +* `values` - (Required, Set) Filter values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cross_target_set` - Cross target set. + * `eni_id` - ENI ID of the CVM instance. + * `instance_id` - ID of the CVM instance.Note: This field may return null, indicating that no valid value was found. + * `instance_name` - Name of the CVM instance. Note: This field may return null, indicating that no valid value was found. + * `ip` - IP address of the CVM or ENI instance. + * `local_vpc_id` - VPC ID of the CLB instance. + * `region` - Region of the CVM or ENI instance. + * `vpc_id` - VPC ID of the CVM or ENI instance. + * `vpc_name` - VPC name of the CVM or ENI instance. + + diff --git a/config/docs/d/clb_exclusive_clusters.html.markdown b/config/docs/d/clb_exclusive_clusters.html.markdown new file mode 100644 index 0000000..5ecea8c --- /dev/null +++ b/config/docs/d/clb_exclusive_clusters.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_exclusive_clusters" +sidebar_current: "docs-tencentcloud-datasource-clb_exclusive_clusters" +description: |- + Use this data source to query detailed information of clb exclusive_clusters +--- + +# tencentcloud_clb_exclusive_clusters + +Use this data source to query detailed information of clb exclusive_clusters + +## Example Usage + +```hcl +data "tencentcloud_clb_exclusive_clusters" "exclusive_clusters" { + filters { + name = "zone" + values = ["ap-guangzhou-1"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter to query the list of AZ resources as detailed below: cluster-type - String - Required: No - (Filter condition) Filter by cluster type, such as TGW. cluster-id - String - Required: No - (Filter condition) Filter by cluster ID, such as tgw-xxxxxxxx. cluster-name - String - Required: No - (Filter condition) Filter by cluster name, such as test-xxxxxx. cluster-tag - String - Required: No - (Filter condition) Filter by cluster tag, such as TAG-xxxxx. vip - String - Required: No - (Filter condition) Filter by vip in the cluster, such as x.x.x.x. network - String - Required: No - (Filter condition) Filter by cluster network type, such as Public or Private. zone - String - Required: No - (Filter condition) Filter by cluster zone, such as ap-guangzhou-1. isp - String - Required: No - (Filter condition) Filter by TGW cluster isp type, such as BGP. loadblancer-id - String - Required: No - (Filter condition) Filter by loadblancer-id in the cluste, such as lb-xxxxxxxx. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Filter name. +* `values` - (Required, Set) Filter value array. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cluster_set` - cluster list. + * `cluster_id` - cluster ID. + * `cluster_name` - cluster name. + * `cluster_tag` - Dedicated layer-7 tag. Note: this field may return null, indicating that no valid values can be obtained. + * `cluster_type` - cluster type: TGW, STGW, VPCGW. + * `clusters_version` - clusters version. + * `clusters_zone` - Availability zone where the cluster is located. + * `master_zone` - Availability master zone where the cluster is located. + * `slave_zone` - Availability slave zone where the cluster is located. + * `disaster_recovery_type` - Cluster disaster recovery type:SINGLE-ZONE, DISASTER-RECOVERY, MUTUAL-DISASTER-RECOVERY. + * `http_max_new_conn` - Maximum number of new http connections. + * `http_qps` - Http Qps. + * `https_max_new_conn` - Maximum number of new https connections. + * `https_qps` - Https Qps. + * `idle_resource_count` - The total number of free resources in the cluster. + * `isp` - Isp: BGP, CMCC,CUCC,CTCC,INTERNAL. + * `load_balance_director_count` - Total number of forwarders in the cluster. + * `max_conn` - Maximum number of connections. + * `max_in_flow` - Maximum incoming Bandwidth. + * `max_in_pkg` - Maximum incoming packet. + * `max_new_conn` - Maximum number of new connections. + * `max_out_flow` - Maximum output bandwidth. + * `max_out_pkg` - Maximum output packet. + * `network` - cluster network type. + * `resource_count` - The total number of resources in the cluster. + * `zone` - . + + diff --git a/config/docs/d/clb_idle_instances.html.markdown b/config/docs/d/clb_idle_instances.html.markdown new file mode 100644 index 0000000..fb78150 --- /dev/null +++ b/config/docs/d/clb_idle_instances.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_idle_instances" +sidebar_current: "docs-tencentcloud-datasource-clb_idle_instances" +description: |- + Use this data source to query detailed information of clb idle_loadbalancers +--- + +# tencentcloud_clb_idle_instances + +Use this data source to query detailed information of clb idle_loadbalancers + +## Example Usage + +```hcl +data "tencentcloud_clb_idle_instances" "idle_instance" { + load_balancer_region = "ap-guangzhou" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `load_balancer_region` - (Optional, String) CLB instance region. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `idle_load_balancers` - List of idle CLBs. Note: This field may return null, indicating that no valid values can be obtained. + * `domain` - The load balancing hostname.Note: This field may return null, indicating that no valid values can be obtained. + * `forward` - CLB type. Value range: 1 (CLB); 0 (classic CLB). + * `idle_reason` - The reason why the load balancer is considered idle. NO_RULES: No rules configured. NO_RS: The rules are not associated with servers. + * `load_balancer_id` - CLB instance ID. + * `load_balancer_name` - CLB instance name. + * `region` - CLB instance region. + * `status` - CLB instance status, including:0: Creating; 1: Running. + * `vip` - CLB instance VIP. + + diff --git a/config/docs/d/clb_instance_by_cert_id.html.markdown b/config/docs/d/clb_instance_by_cert_id.html.markdown new file mode 100644 index 0000000..90f831c --- /dev/null +++ b/config/docs/d/clb_instance_by_cert_id.html.markdown @@ -0,0 +1,128 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_instance_by_cert_id" +sidebar_current: "docs-tencentcloud-datasource-clb_instance_by_cert_id" +description: |- + Use this data source to query detailed information of clb instance_by_cert_id +--- + +# tencentcloud_clb_instance_by_cert_id + +Use this data source to query detailed information of clb instance_by_cert_id + +## Example Usage + +```hcl +data "tencentcloud_clb_instance_by_cert_id" "instance_by_cert_id" { + cert_ids = ["3a6B5y8v"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cert_ids` - (Required, Set: [`String`]) Server or client certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cert_set` - Certificate ID and list of CLB instances associated with it. + * `cert_id` - Certificate ID. + * `load_balancers` - List of CLB instances associated with certificate. Note: this field may return null, indicating that no valid values can be obtained. + * `address_i_p_version` - IP version. Valid values: ipv4, ipv6. Note: this field may return null, indicating that no valid values can be obtained. + * `address_i_pv6` - IPv6 address of a CLB instance. Note: This field may return null, indicating that no valid values can be obtained. + * `anycast_zone` - Anycast CLB publishing region. For non-anycast CLB, this field returns an empty string. Note: This field may return null, indicating that no valid values can be obtained. + * `attribute_flags` - Cluster ID.Note: This field may return null, indicating that no valid values can be obtained. + * `backup_zone_set` - backup zone. + * `edge_zone` - Whether the AZ is an edge zone. Values: true, false. Note: This field may return null, indicating that no valid values can be obtained. + * `local_zone` - Whether the AZ is the LocalZone, e.g., false. Note: This field may return null, indicating that no valid values can be obtained. + * `zone_id` - Unique AZ ID in a numeric form, such as 100001. Note: This field may return null, indicating that no valid values can be obtained. + * `zone_name` - AZ name, such as Guangzhou Zone 1. Note: This field may return null, indicating that no valid values can be obtained. + * `zone_region` - AZ region, e.g., ap-guangzhou. Note: This field may return null, indicating that no valid values can be obtained. + * `zone` - Unique AZ ID in a numeric form, such as 100001. Note: This field may return null, indicating that no valid values can be obtained. + * `charge_type` - Billing mode of CLB instance. Valid values: PREPAID (monthly subscription), POSTPAID_BY_HOUR (pay as you go). Note: this field may return null, indicating that no valid values can be obtained. + * `cluster_ids` - Cluster ID. Note: This field may return null, indicating that no valid values can be obtained. + * `cluster_tag` - Dedicated layer-7 tag. Note: this field may return null, indicating that no valid values can be obtained. + * `config_id` - Custom configuration ID at the CLB instance level. Note: This field may return null, indicating that no valid values can be obtained. + * `create_time` - CLB instance creation time. Note: This field may return null, indicating that no valid values can be obtained. + * `domain` - Domain name of the CLB instance. It is only available for public classic CLBs. This parameter will be discontinued soon. Please use LoadBalancerDomain instead. Note: This field may return null, indicating that no valid values can be obtained. + * `exclusive_cluster` - Private network dedicated cluster. Note: this field may return null, indicating that no valid values can be obtained. + * `classical_cluster` - vpcgw cluster. Note: this field may return null, indicating that no valid values can be obtained. + * `cluster_id` - Unique cluster ID. + * `cluster_name` - Cluster name. Note: this field may return null, indicating that no valid values can be obtained. + * `zone` - Cluster AZ, such as ap-guangzhou-1. Note: this field may return null, indicating that no valid values can be obtained. + * `l4_clusters` - Layer-4 dedicated cluster list. Note: this field may return null, indicating that no valid values can be obtained. + * `cluster_id` - Unique cluster ID. + * `cluster_name` - Cluster name. Note: this field may return null, indicating that no valid values can be obtained. + * `zone` - Cluster AZ, such as ap-guangzhou-1. Note: this field may return null, indicating that no valid values can be obtained. + * `l7_clusters` - Layer-7 dedicated cluster list. Note: this field may return null, indicating that no valid values can be obtained. + * `cluster_id` - Unique cluster ID. + * `cluster_name` - Cluster name. Note: this field may return null, indicating that no valid values can be obtained. + * `zone` - Cluster AZ, such as ap-guangzhou-1. Note: this field may return null, indicating that no valid values can be obtained. + * `expire_time` - CLB instance expiration time, which takes effect only for prepaid instances. Note: This field may return null, indicating that no valid values can be obtained. + * `extra_info` - Reserved field which can be ignored generally.Note: This field may return null, indicating that no valid values can be obtained. + * `tgw_group_name` - TgwGroup name. Note: This field may return null, indicating that no valid values can be obtained. + * `zhi_tong` - Whether to enable VIP direct connection. Note: This field may return null, indicating that no valid values can be obtained. + * `forward` - CLB type identifier. Value range: 1 (CLB); 0 (classic CLB). + * `health_log_set_id` - Health check logset ID of CLB CLS. Note: this field may return null, indicating that no valid values can be obtained. + * `health_log_topic_id` - Health check log topic ID of CLB CLS. Note: this field may return null, indicating that no valid values can be obtained. + * `ipv6_mode` - This field is meaningful only when the IP address version is ipv6. Valid values: IPv6Nat64, IPv6FullChain. Note: this field may return null, indicating that no valid values can be obtained. + * `is_block_time` - Time blocked or unblocked. Note: this field may return null, indicating that no valid values can be obtained. + * `is_block` - Whether VIP is blocked. Note: this field may return null, indicating that no valid values can be obtained. + * `is_ddos` - Whether an Anti-DDoS Pro instance can be bound. Note: This field may return null, indicating that no valid values can be obtained. + * `isolated_time` - CLB instance isolation time. Note: This field may return null, indicating that no valid values can be obtained. + * `isolation` - 0: not isolated; 1: isolated. Note: This field may return null, indicating that no valid values can be obtained. + * `load_balancer_domain` - Domain name of the CLB instance. Note: This field may return null, indicating that no valid values can be obtained. + * `load_balancer_id` - CLB instance ID. + * `load_balancer_name` - CLB instance name. + * `load_balancer_pass_to_target` - Whether a real server opens the traffic from a CLB instance to the internet. Note: this field may return null, indicating that no valid values can be obtained. + * `load_balancer_type` - CLB instance network type:OPEN: public network; INTERNAL: private network. + * `load_balancer_vips` - List of VIPs of a CLB instance. Note: This field may return null, indicating that no valid values can be obtained. + * `local_bgp` - Whether the IP type is the local BGP. + * `log_set_id` - Logset ID of CLB Log Service (CLS). Note: This field may return null, indicating that no valid values can be obtained. + * `log_topic_id` - Log topic ID of CLB Log Service (CLS). Note: This field may return null, indicating that no valid values can be obtained. + * `log` - Log information. Only the public network CLB that have HTTP or HTTPS listeners can generate logs. Note: This field may return null, indicating that no valid values can be obtained. + * `master_zone` - Primary AZ. Note: This field may return null, indicating that no valid values can be obtained. + * `edge_zone` - Whether the AZ is an edge zone. Values: true, false. Note: This field may return null, indicating that no valid values can be obtained. + * `local_zone` - Whether the AZ is the LocalZone, e.g., false. Note: This field may return null, indicating that no valid values can be obtained. + * `zone_id` - . + * `zone_name` - AZ name, such as Guangzhou Zone 1. Note: This field may return null, indicating that no valid values can be obtained. + * `zone_region` - AZ region, e.g., ap-guangzhou. Note: This field may return null, indicating that no valid values can be obtained. + * `zone` - Unique AZ ID in a numeric form, such as 100001. Note: This field may return null, indicating that no valid values can be obtained. + * `mix_ip_target` - If the layer-7 listener of an IPv6FullChain CLB instance is enabled, the CLB instance can be bound with an IPv4 and an IPv6 CVM instance simultaneously. Note: this field may return null, indicating that no valid values can be obtained. + * `network_attributes` - CLB instance network attributes. Note: This field may return null, indicating that no valid values can be obtained. + * `bandwidthpkg_sub_type` - Bandwidth package type, such as SINGLEISP. Note: This field may return null, indicating that no valid values can be obtained. + * `internet_charge_type` - TRAFFIC_POSTPAID_BY_HOUR: hourly pay-as-you-go by traffic; BANDWIDTH_POSTPAID_BY_HOUR: hourly pay-as-you-go by bandwidth; BANDWIDTH_PACKAGE: billed by bandwidth package (currently, this method is supported only if the ISP is specified). + * `internet_max_bandwidth_out` - Maximum outbound bandwidth in Mbps, which applies only to public network CLB. Value range: 0-65,535. Default value: 10. + * `nfv_info` - Whether it is an NFV CLB instance. No returned information: no; l7nfv: yes. Note: this field may return null, indicating that no valid values can be obtained. + * `numerical_vpc_id` - VPC ID in a numeric form. Note: This field may return null, indicating that no valid values can be obtained. + * `open_bgp` - Protective CLB identifier. Value range: 1 (protective), 0 (non-protective). Note: This field may return null, indicating that no valid values can be obtained. + * `prepaid_attributes` - Prepaid billing attributes of a CLB instance. Note: This field may return null, indicating that no valid values can be obtained. + * `period` - Cycle, indicating the number of months (reserved field). Note: This field may return null, indicating that no valid values can be obtained. + * `renew_flag` - Renewal type. AUTO_RENEW: automatic renewal; MANUAL_RENEW: manual renewal. Note: This field may return null, indicating that no valid values can be obtained. + * `project_id` - ID of the project to which a CLB instance belongs. 0: default project. + * `secure_groups` - Security group of a CLB instance. Note: This field may return null, indicating that no valid values can be obtained. + * `sla_type` - Specification of the LCU-supported instance. Note: This field may return null, indicating that no valid values can be obtained. + * `snat_ips` - SnatIp list after SnatPro load balancing is enabled. Note: this field may return null, indicating that no valid values can be obtained. + * `ip` - IP address, such as 192.168.0.1. + * `subnet_id` - Unique VPC subnet ID, such as subnet-12345678. + * `snat_pro` - Whether to enable SnatPro. Note: this field may return null, indicating that no valid values can be obtained. + * `snat` - SNAT is enabled for all private network classic CLB created before December 2016. Note: This field may return null, indicating that no valid values can be obtained. + * `status_time` - Last status change time of a CLB instance. Note: This field may return null, indicating that no valid values can be obtained. + * `status` - CLB instance status, including:0: creating; 1: running. Note: This field may return null, indicating that no valid values can be obtained. + * `subnet_id` - Subnet where a CLB instance resides (meaningful only for private network VPC CLB). Note: This field may return null, indicating that no valid values can be obtained. + * `tags` - CLB instance tag information. Note: This field may return null, indicating that no valid values can be obtained. + * `tag_key` - Tag key. + * `tag_value` - Tag value. + * `target_region_info` - Basic information of a backend server bound to a CLB instance. Note: This field may return null, indicating that no valid values can be obtained. + * `region` - Region of the target, such as ap-guangzhou. + * `vpc_id` - Network of the target, which is in the format of vpc-abcd1234 for VPC or 0 for basic network. + * `vip_isp` - ISP to which a CLB IP address belongs. Note: This field may return null, indicating that no valid values can be obtained. + * `vpc_id` - VPC ID Note: This field may return null, indicating that no valid values can be obtained. + * `zones` - Availability zone of a VPC-based private network CLB instance. Note: this field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/clb_instance_detail.html.markdown b/config/docs/d/clb_instance_detail.html.markdown new file mode 100644 index 0000000..1d0b003 --- /dev/null +++ b/config/docs/d/clb_instance_detail.html.markdown @@ -0,0 +1,89 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_instance_detail" +sidebar_current: "docs-tencentcloud-datasource-clb_instance_detail" +description: |- + Use this data source to query detailed information of clb instance_detail +--- + +# tencentcloud_clb_instance_detail + +Use this data source to query detailed information of clb instance_detail + +## Example Usage + +```hcl +data "tencentcloud_clb_instance_detail" "instance_detail" { + target_type = "NODE" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `fields` - (Optional, Set: [`String`]) List of fields. Only fields specified will be returned. If it's left blank, `null` is returned. The fields `LoadBalancerId` and `LoadBalancerName` are added by default. For details about fields. +* `filters` - (Optional, List) Filter condition of querying lists describing CLB instance details:loadbalancer-id - String - Required: no - (Filter condition) CLB instance ID, such as lb-12345678; project-id - String - Required: no - (Filter condition) Project ID, such as 0 and 123; network - String - Required: no - (Filter condition) Network type of the CLB instance, such as Public and Private.&lt;/li&gt;&lt;li&gt; vip - String - Required: no - (Filter condition) CLB instance VIP, such as 1.1.1.1 and 2204::22:3; target-ip - String - Required: no - (Filter condition) Private IP of the target real servers, such as1.1.1.1 and 2203::214:4; vpcid - String - Required: no - (Filter condition) Identifier of the VPC instance to which the CLB instance belongs, such as vpc-12345678; zone - String - Required: no - (Filter condition) Availability zone where the CLB instance resides, such as ap-guangzhou-1; tag-key - String - Required: no - (Filter condition) Tag key of the CLB instance, such as name; tag:* - String - Required: no - (Filter condition) CLB instance tag, followed by tag key after the colon. For example, use {Name: tag:name,Values: [zhangsan, lisi]} to filter the tag key `name` with the tag value `zhangsan` and `lisi`; fuzzy-search - String - Required: no - (Filter condition) Fuzzy search for CLB instance VIP and CLB instance name, such as 1. +* `result_output_file` - (Optional, String) Used to save results. +* `target_type` - (Optional, String) Target type. Valid values: NODE and GROUP. If the list of fields contains `TargetId`, `TargetAddress`, `TargetPort`, `TargetWeight` and other fields, `Target` of the target group or non-target group must be exported. + +The `filters` object supports the following: + +* `name` - (Required, String) Filter name. +* `values` - (Required, Set) Filter value array. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `load_balancer_detail_set` - List of CLB instance details.Note: this field may return null, indicating that no valid values can be obtained. + * `address_ip_version` - IP version of the CLB instance. Valid values: IPv4, IPv6.Note: this field may return null, indicating that no valid values can be obtained. + * `address_ipv6` - IPv6 VIP address of the CLB instance.Note: this field may return null, indicating that no valid values can be obtained. + * `address_isp` - ISP to which the CLB IP address belongs.Note: this field may return null, indicating that no valid values can be obtained. + * `address` - CLB instance VIP.Note: this field may return null, indicating that no valid values can be obtained. + * `charge_type` - CLB instance billing mode.Note: this field may return null, indicating that no valid values can be obtained. + * `config_id` - Custom configuration IDs of CLB instances. Multiple IDs must be separated by commas (,).Note: This field may return null, indicating that no valid values can be obtained. + * `create_time` - CLB instance creation time.Note: this field may return null, indicating that no valid values can be obtained. + * `domain` - Domain name of the forwarding rule.Note: this field may return null, indicating that no valid values can be obtained. + * `domains` - List o domain names associated with the forwarding ruleNote: This field may return `null`, indicating that no valid values can be obtained. + * `extra_info` - Reserved field, which can be ignored generally.Note: this field may return null, indicating that no valid values can be obtained. + * `tgw_group_name` - TgwGroup nameNote: This field may return null, indicating that no valid values can be obtained. + * `zhi_tong` - Whether to enable VIP direct connectionNote: This field may return null, indicating that no valid values can be obtained. + * `ipv6_mode` - IPv6 address type of the CLB instance. Valid values: IPv6Nat64, IPv6FullChain.Note: this field may return null, indicating that no valid values can be obtained. + * `isolation` - 0: not isolated; 1: isolated.Note: this field may return null, indicating that no valid values can be obtained. + * `listener_id` - CLB listener ID.Note: this field may return null, indicating that no valid values can be obtained. + * `load_balancer_domain` - Domain name of the CLB instance.Note: This field may return null, indicating that no valid values can be obtained. + * `load_balancer_id` - CLB instance ID. + * `load_balancer_name` - CLB instance name. + * `load_balancer_pass_to_target` - Whether the CLB instance is billed by IP.Note: this field may return `null`, indicating that no valid values can be obtained. + * `load_balancer_type` - CLB instance network type:Public: public network; Private: private network.Note: this field may return null, indicating that no valid values can be obtained. + * `location_id` - Forwarding rule ID.Note: this field may return null, indicating that no valid values can be obtained. + * `network_attributes` - CLB instance network attribute.Note: this field may return null, indicating that no valid values can be obtained. + * `bandwidth_pkg_sub_type` - Bandwidth package type, such as SINGLEISPNote: This field may return null, indicating that no valid values can be obtained. + * `internet_charge_type` - TRAFFIC_POSTPAID_BY_HOUR: hourly pay-as-you-go by traffic; BANDWIDTH_POSTPAID_BY_HOUR: hourly pay-as-you-go by bandwidth;BANDWIDTH_PACKAGE: billed by bandwidth package (currently, this method is supported only if the ISP is specified). + * `internet_max_bandwidth_out` - Maximum outbound bandwidth in Mbps, which applies only to public network CLB. Value range: 0-65,535. Default value: 10. + * `port` - Listener port.Note: this field may return null, indicating that no valid values can be obtained. + * `prepaid_attributes` - Pay-as-you-go attribute of the CLB instance.Note: this field may return null, indicating that no valid values can be obtained. + * `period` - Cycle, indicating the number of months (reserved field)Note: This field may return null, indicating that no valid values can be obtained. + * `renew_flag` - Renewal type. AUTO_RENEW: automatic renewal; MANUAL_RENEW: manual renewalNote: This field may return null, indicating that no valid values can be obtained. + * `project_id` - ID of the project to which the CLB instance belongs. 0: default project.Note: this field may return null, indicating that no valid values can be obtained. + * `protocol` - Listener protocol.Note: this field may return null, indicating that no valid values can be obtained. + * `security_group` - List of the security groups bound to the CLB instance.Note: this field may return `null`, indicating that no valid values can be obtained. + * `slave_zone` - The secondary zone of multi-AZ CLB instanceNote: This field may return `null`, indicating that no valid values can be obtained. + * `sni_switch` - Whether SNI is enabled. This parameter is only meaningful for HTTPS listeners.Note: This field may return `null`, indicating that no valid values can be obtained. + * `status` - CLB instance status, including:0: creating; 1: running.Note: this field may return null, indicating that no valid values can be obtained. + * `tags` - CLB instance tag information.Note: this field may return null, indicating that no valid values can be obtained. + * `tag_key` - Tag key. + * `tag_value` - Tag value. + * `target_address` - Address of target real servers.Note: this field may return null, indicating that no valid values can be obtained. + * `target_health` - Health status of the target real server.Note: this field may return `null`, indicating that no valid values can be obtained. + * `target_id` - ID of target real servers.Note: this field may return null, indicating that no valid values can be obtained. + * `target_port` - Listening port of target real servers.Note: this field may return null, indicating that no valid values can be obtained. + * `target_weight` - Forwarding weight of target real servers.Note: this field may return null, indicating that no valid values can be obtained. + * `url` - Forwarding rule path.Note: this field may return null, indicating that no valid values can be obtained. + * `vpc_id` - ID of the VPC instance to which the CLB instance belongs.Note: this field may return null, indicating that no valid values can be obtained. + * `zone` - Availability zone where the CLB instance resides.Note: this field may return null, indicating that no valid values can be obtained. + * `zones` - The AZ of private CLB instance. This is only available for beta users.Note: This field may return `null`, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/clb_instance_traffic.html.markdown b/config/docs/d/clb_instance_traffic.html.markdown new file mode 100644 index 0000000..412e717 --- /dev/null +++ b/config/docs/d/clb_instance_traffic.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_instance_traffic" +sidebar_current: "docs-tencentcloud-datasource-clb_instance_traffic" +description: |- + Use this data source to query detailed information of clb instance_traffic +--- + +# tencentcloud_clb_instance_traffic + +Use this data source to query detailed information of clb instance_traffic + +## Example Usage + +```hcl +data "tencentcloud_clb_instance_traffic" "instance_traffic" { + load_balancer_region = "ap-guangzhou" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `load_balancer_region` - (Optional, String) CLB instance region. If this parameter is not passed in, CLB instances in all regions will be returned. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `load_balancer_traffic` - Information of CLB instances sorted by outbound bandwidth from highest to lowest. Note: This field may return null, indicating that no valid values can be obtained. + * `domain` - CLB domain name. Note: This field may return null, indicating that no valid values can be obtained. + * `load_balancer_id` - CLB instance ID. + * `load_balancer_name` - CLB instance name. + * `out_bandwidth` - Maximum outbound bandwidth in Mbps. + * `region` - CLB instance region. + * `vip` - CLB instance VIP. + + diff --git a/config/docs/d/clb_instances.html.markdown b/config/docs/d/clb_instances.html.markdown new file mode 100644 index 0000000..5e1e30f --- /dev/null +++ b/config/docs/d/clb_instances.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_instances" +sidebar_current: "docs-tencentcloud-datasource-clb_instances" +description: |- + Use this data source to query detailed information of CLB +--- + +# tencentcloud_clb_instances + +Use this data source to query detailed information of CLB + +## Example Usage + +```hcl +data "tencentcloud_clb_instances" "foo" { + clb_id = "lb-k2zjp9lv" + network_type = "OPEN" + clb_name = "myclb" + project_id = 0 + result_output_file = "mytestpath" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_id` - (Optional, String) ID of the CLB to be queried. +* `clb_name` - (Optional, String) Name of the CLB to be queried. +* `master_zone` - (Optional, String) Master available zone id. +* `network_type` - (Optional, String) Type of CLB instance, and available values include `OPEN` and `INTERNAL`. +* `project_id` - (Optional, Int) Project ID of the CLB. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `clb_list` - A list of cloud load balancers. Each element contains the following attributes: + * `address_ip_version` - IP version, only applicable to open CLB. Valid values are `IPV4`, `IPV6` and `IPv6FullChain`. + * `clb_id` - ID of CLB. + * `clb_name` - Name of CLB. + * `clb_vips` - The virtual service address table of the CLB. + * `create_time` - Create time of the CLB. + * `internet_bandwidth_max_out` - Max bandwidth out, only applicable to open CLB. Valid value ranges is [1, 2048]. Unit is MB. + * `internet_charge_type` - Internet charge type, only applicable to open CLB. Valid values are `TRAFFIC_POSTPAID_BY_HOUR`, `BANDWIDTH_POSTPAID_BY_HOUR` and `BANDWIDTH_PACKAGE`. + * `local_zone` - Whether this available zone is local zone, This field maybe null, means cannot get a valid value. + * `network_type` - Types of CLB. + * `project_id` - ID of the project. + * `security_groups` - ID set of the security groups. + * `status_time` - Latest state transition time of CLB. + * `status` - The status of CLB. + * `subnet_id` - ID of the subnet. + * `tags` - The available tags within this CLB. + * `target_region_info_region` - Region information of backend service are attached the CLB. + * `target_region_info_vpc_id` - VpcId information of backend service are attached the CLB. + * `vip_isp` - Network operator, only applicable to open CLB. Valid values are `CMCC`(China Mobile), `CTCC`(Telecom), `CUCC`(China Unicom) and `BGP`. If this ISP is specified, network billing method can only use the bandwidth package billing (BANDWIDTH_PACKAGE). + * `vpc_id` - ID of the VPC. + * `zone_id` - Available zone unique id(numerical representation), This field maybe null, means cannot get a valid value. + * `zone_name` - Available zone name, This field maybe null, means cannot get a valid value. + * `zone_region` - Region that this available zone belong to, This field maybe null, means cannot get a valid value. + * `zone` - Available zone unique id(string representation), This field maybe null, means cannot get a valid value. + + diff --git a/config/docs/d/clb_listener_rules.html.markdown b/config/docs/d/clb_listener_rules.html.markdown new file mode 100644 index 0000000..14d2ca1 --- /dev/null +++ b/config/docs/d/clb_listener_rules.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_listener_rules" +sidebar_current: "docs-tencentcloud-datasource-clb_listener_rules" +description: |- + Use this data source to query detailed information of CLB listener rule +--- + +# tencentcloud_clb_listener_rules + +Use this data source to query detailed information of CLB listener rule + +## Example Usage + +```hcl +data "tencentcloud_clb_listener_rules" "foo" { + clb_id = "lb-k2zjp9lv" + listener_id = "lbl-mwr6vbtv" + rule_id = "loc-inem40hz" + domain = "abc.com" + url = "/" + scheduler = "WRR" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_id` - (Required, String) ID of the CLB to be queried. +* `listener_id` - (Required, String) ID of the CLB listener to be queried. +* `domain` - (Optional, String) Domain name of the forwarding rule to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `rule_id` - (Optional, String) ID of the forwarding rule to be queried. +* `scheduler` - (Optional, String) Scheduling method of the forwarding rule of thr CLB listener, and available values include `WRR`, `IP HASH` and `LEAST_CONN`. The default is `WRR`. +* `url` - (Optional, String) Url of the forwarding rule to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `rule_list` - A list of forward rules of listeners. Each element contains the following attributes: + * `certificate_ca_id` - ID of the client certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol. + * `certificate_id` - ID of the server certificate. NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol. + * `certificate_ssl_mode` - Type of SSL Mode, and available values inclue 'UNIDIRECTIONAL', 'MUTUAL'.NOTES: Only supports listeners of 'HTTPS' and 'TCP_SSL' protocol. + * `clb_id` - ID of the CLB. + * `health_check_health_num` - Health threshold of health check, and the default is `3`. If a success result is returned for the health check three consecutive times, the CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. + * `health_check_http_code` - HTTP Status Code. The default is 31 and value range is 1-31. 1 means the return value '1xx' is health. 2 means the return value '2xx' is health. 4 means the return value '3xx' is health. 8 means the return value 4xx is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol. + * `health_check_http_domain` - Domain name of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol. + * `health_check_http_method` - Methods of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol. The default is 'HEAD', the available value include 'HEAD' and 'GET'. + * `health_check_http_path` - Path of health check. NOTES: Only supports listeners of 'HTTPS' and 'HTTP' protocol. + * `health_check_interval_time` - Interval time of health check. The value range is 2-300 sec, and the default is `5` sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. + * `health_check_switch` - Indicates whether health check is enabled. + * `health_check_unhealth_num` - Unhealth threshold of health check, and the default is `3`. If a success result is returned for the health check three consecutive times, the CVM is identified as unhealthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. + * `http2_switch` - Indicate to set HTTP2 protocol or not. + * `listener_id` - ID of the listener. + * `rule_id` - ID of the rule. + * `scheduler` - Scheduling method of the CLB listener, and available values include 'WRR', 'IP_HASH' and 'LEAST_CONN'. The default is 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. + * `session_expire_time` - Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as 'WRR'. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. + + diff --git a/config/docs/d/clb_listeners.html.markdown b/config/docs/d/clb_listeners.html.markdown new file mode 100644 index 0000000..3cfc951 --- /dev/null +++ b/config/docs/d/clb_listeners.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_listeners" +sidebar_current: "docs-tencentcloud-datasource-clb_listeners" +description: |- + Use this data source to query detailed information of CLB listener +--- + +# tencentcloud_clb_listeners + +Use this data source to query detailed information of CLB listener + +## Example Usage + +```hcl +data "tencentcloud_clb_listeners" "foo" { + clb_id = "lb-k2zjp9lv" + listener_id = "lbl-mwr6vbtv" + protocol = "TCP" + port = 80 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_id` - (Required, String) Id of the CLB to be queried. +* `listener_id` - (Optional, String) Id of the listener to be queried. +* `port` - (Optional, Int) Port of the CLB listener. +* `protocol` - (Optional, String) Type of protocol within the listener, and available values are `TCP`, `UDP`, `HTTP`, `HTTPS` and `TCP_SSL`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `listener_list` - A list of listeners of cloud load balancers. Each element contains the following attributes: + * `certificate_ca_id` - Id of the client certificate. It must be set when SSLMode is `mutual`. NOTES: only supported by listeners of `HTTPS` and `TCP_SSL` protocol. + * `certificate_id` - Id of the server certificate. It must be set when protocol is `HTTPS` or `TCP_SSL`. NOTES: only supported by listeners of `HTTPS` and `TCP_SSL` protocol and must be set when it is available. + * `certificate_ssl_mode` - Type of certificate, and available values inclue `UNIDIRECTIONAL`, `MUTUAL`. NOTES: Only supports listeners of `HTTPS` and `TCP_SSL` protocol and must be set when it is available. + * `clb_id` - ID of the CLB. + * `health_check_context_type` - Health check protocol. + * `health_check_health_num` - Health threshold of health check, and the default is `3`. If a success result is returned for the health check three consecutive times, the CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. + * `health_check_http_code` - HTTP health check code of TCP listener. + * `health_check_http_domain` - HTTP health check domain of TCP listener. + * `health_check_http_method` - HTTP health check method of TCP listener. + * `health_check_http_path` - HTTP health check path of TCP listener. + * `health_check_http_version` - The HTTP version of the backend service. + * `health_check_interval_time` - Interval time of health check. The value range is 2-300 sec, and the default is `5` sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. + * `health_check_port` - The health check port is the port of the backend service. + * `health_check_recv_context` - It represents the result returned by the health check. + * `health_check_send_context` - It represents the content of the request sent by the health check. + * `health_check_switch` - Indicates whether health check is enabled. + * `health_check_time_out` - Response timeout of health check. The value range is 2-60 sec, and the default is `2` sec. Response timeout needs to be less than check interval. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration. + * `health_check_type` - Protocol used for health check. + * `health_check_unhealth_num` - Unhealthy threshold of health check, and the default is `3`. If a success result is returned for the health check three consecutive times, the CVM is identified as unhealthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. + * `listener_id` - ID of the listener. + * `listener_name` - Name of the CLB listener. + * `port` - Port of the CLB listener. + * `protocol` - Protocol of the listener. Available values are `HTTP`, `HTTPS`, `TCP`, `UDP`, `TCP_SSL`. + * `scheduler` - Scheduling method of the CLB listener, and available values are `WRR` and `LEAST_CONN`. The default is `WRR`. NOTES: The listener of 'HTTP' and `HTTPS` protocol additionally supports the `IP HASH` method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. + * `session_expire_time` - Time of session persistence within the CLB listener. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. + * `sni_switch` - Indicates whether SNI is enabled. NOTES: Only supported by `HTTPS` protocol. + + diff --git a/config/docs/d/clb_listeners_by_targets.html.markdown b/config/docs/d/clb_listeners_by_targets.html.markdown new file mode 100644 index 0000000..e919b5e --- /dev/null +++ b/config/docs/d/clb_listeners_by_targets.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_listeners_by_targets" +sidebar_current: "docs-tencentcloud-datasource-clb_listeners_by_targets" +description: |- + Use this data source to query detailed information of clb listeners_by_targets +--- + +# tencentcloud_clb_listeners_by_targets + +Use this data source to query detailed information of clb listeners_by_targets + +## Example Usage + +```hcl +data "tencentcloud_clb_listeners_by_targets" "listeners_by_targets" { + backends { + vpc_id = "vpc-4owdpnwr" + private_ip = "106.52.160.211" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backends` - (Required, List) List of private network IPs to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +The `backends` object supports the following: + +* `private_ip` - (Required, String) Private network IP to be queried, which can be of the CVM or ENI. +* `vpc_id` - (Required, String) VPC ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `load_balancers` - Detail of the CLB instance. + * `listeners` - Listener rule. + * `end_port` - End port of the listener. Note: this field may return null, indicating that no valid values can be obtained. + * `listener_id` - Listener ID. + * `port` - Listener port. + * `protocol` - Listener protocol. + * `rules` - Bound rule. Note: this field may return null, indicating that no valid values can be obtained. + * `domain` - Domain name. + * `location_id` - Rule ID. + * `targets` - Object bound to the real server. + * `port` - Port bound to the real server. + * `private_ip` - Private network IP of the real server. + * `type` - Private network IP type, which can be cvm or eni. + * `vpc_id` - VPC ID of the real server. Note: this field may return null, indicating that no valid values can be obtained. + * `weight` - Weight of the real server. Note: this field may return null, indicating that no valid values can be obtained. + * `url` - url. + * `targets` - Object bound to the layer-4 listener. Note: this field may return null, indicating that no valid values can be obtained. + * `port` - Port bound to the real server. + * `private_ip` - Private network IP of the real server. + * `type` - Private network IP type, which can be cvm or eni. + * `vpc_id` - VPC ID of the real server. Note: this field may return null, indicating that no valid values can be obtained. + * `weight` - Weight of the real server. Note: this field may return null, indicating that no valid values can be obtained. + * `load_balancer_id` - String ID of the CLB instance. + * `region` - CLB instance region. + * `vip` - VIP of the CLB instance. + + diff --git a/config/docs/d/clb_redirections.html.markdown b/config/docs/d/clb_redirections.html.markdown new file mode 100644 index 0000000..33e58b3 --- /dev/null +++ b/config/docs/d/clb_redirections.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_redirections" +sidebar_current: "docs-tencentcloud-datasource-clb_redirections" +description: |- + Use this data source to query detailed information of CLB redirections +--- + +# tencentcloud_clb_redirections + +Use this data source to query detailed information of CLB redirections + +## Example Usage + +```hcl +data "tencentcloud_clb_redirections" "foo" { + clb_id = "lb-p7olt9e5" + source_listener_id = "lbl-jc1dx6ju" + target_listener_id = "lbl-asj1hzuo" + source_rule_id = "loc-ft8fmngv" + target_rule_id = "loc-4xxr2cy7" + result_output_file = "mytestpath" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_id` - (Required, String) ID of the CLB to be queried. +* `source_listener_id` - (Required, String) ID of source listener to be queried. +* `source_rule_id` - (Required, String) Rule ID of source listener to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `target_listener_id` - (Optional, String) ID of target listener to be queried. +* `target_rule_id` - (Optional, String) Rule ID of target listener to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `redirection_list` - A list of cloud load balancer redirection configurations. Each element contains the following attributes: + * `clb_id` - ID of the CLB. + * `source_listener_id` - ID of source listener. + * `source_rule_id` - Rule ID of source listener. + * `target_listener_id` - ID of target listener. + * `target_rule_id` - Rule ID of target listener. + + diff --git a/config/docs/d/clb_resources.html.markdown b/config/docs/d/clb_resources.html.markdown new file mode 100644 index 0000000..1fc35ce --- /dev/null +++ b/config/docs/d/clb_resources.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_resources" +sidebar_current: "docs-tencentcloud-datasource-clb_resources" +description: |- + Use this data source to query detailed information of clb resources +--- + +# tencentcloud_clb_resources + +Use this data source to query detailed information of clb resources + +## Example Usage + +```hcl +data "tencentcloud_clb_resources" "resources" { + filters { + name = "isp" + values = ["BGP"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter to query the list of AZ resources as detailed below: zone - String - Optional - Filter by AZ, such as ap-guangzhou-1. isp -- String - Optional - Filter by the ISP. Values: BGP, CMCC, CUCC and CTCC. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Filter name. +* `values` - (Required, Set) Filter value array. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `zone_resource_set` - List of resources supported by the AZ. + * `edge_zone` - Whether the AZ is an edge zone. Values: true, false. + * `ip_version` - IP version. Values: IPv4, IPv6, and IPv6_Nat. + * `local_zone` - Whether the AZ is a LocalZone. Values: true, false. + * `master_zone` - Primary AZ, such as ap-guangzhou-1. + * `resource_set` - List of resources. Note: This field may return null, indicating that no valid values can be obtained. + * `availability_set` - Available resources. Note: This field may return null, indicating that no valid values can be obtaine. + * `availability` - Whether the resource is available. Values: Available, Unavailable. + * `type` - Specific ISP resource information. Values: CMCC, CUCC, CTCC, BGP. + * `isp` - ISP information, such as CMCC, CUCC, CTCC, BGP, and INTERNAL. + * `type` - Specific ISP resource information, Vaules: CMCC, CUCC, CTCC, BGP, and INTERNAL. + * `slave_zone` - Secondary AZ, such as ap-guangzhou-2. Note: This field may return null, indicating that no valid values can be obtained. + * `zone_region` - Region of the AZ, such as ap-guangzhou. + * `zone_resource_type` - Type of resources in the zone. Values: SHARED, EXCLUSIVE. + + diff --git a/config/docs/d/clb_target_group_list.html.markdown b/config/docs/d/clb_target_group_list.html.markdown new file mode 100644 index 0000000..823fc29 --- /dev/null +++ b/config/docs/d/clb_target_group_list.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_target_group_list" +sidebar_current: "docs-tencentcloud-datasource-clb_target_group_list" +description: |- + Use this data source to query detailed information of clb target_group_list +--- + +# tencentcloud_clb_target_group_list + +Use this data source to query detailed information of clb target_group_list + +## Example Usage + +```hcl +data "tencentcloud_clb_target_group_list" "target_group_list" { + filters { + name = "TargetGroupName" + values = ["keep-tgg"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter array, which is exclusive of TargetGroupIds. Valid values: TargetGroupVpcId and TargetGroupName. Target group ID will be used first. +* `result_output_file` - (Optional, String) Used to save results. +* `target_group_ids` - (Optional, Set: [`String`]) Target group ID array. + +The `filters` object supports the following: + +* `name` - (Required, String) Filter name. +* `values` - (Required, Set) Filter value array. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `target_group_set` - Information set of displayed target groups. + * `associated_rule` - Array of associated rules. Note: this field may return null, indicating that no valid values can be obtained. + * `domain` - Domain name of associated forwarding rule. Note: this field may return null, indicating that no valid values can be obtained. + * `listener_id` - ID of associated listener. + * `listener_name` - Listener name. + * `load_balancer_id` - ID of associated CLB instance. + * `load_balancer_name` - CLB instance name. + * `location_id` - ID of associated forwarding rule. Note: this field may return null, indicating that no valid values can be obtained. + * `port` - Port of associated listener. + * `protocol` - Protocol type of associated listener, such as HTTP or TCP. + * `url` - URL of associated forwarding rule. Note: this field may return null, indicating that no valid values can be obtained. + * `created_time` - Target group creation time. + * `port` - Default port of target group. Note: this field may return null, indicating that no valid values can be obtained. + * `target_group_id` - Target group ID. + * `target_group_name` - Target group name. + * `updated_time` - Target group modification time. + * `vpc_id` - vpcid of target group. + + diff --git a/config/docs/d/clb_target_groups.html.markdown b/config/docs/d/clb_target_groups.html.markdown new file mode 100644 index 0000000..3bf0c4b --- /dev/null +++ b/config/docs/d/clb_target_groups.html.markdown @@ -0,0 +1,96 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_target_groups" +sidebar_current: "docs-tencentcloud-datasource-clb_target_groups" +description: |- + Use this data source to query target group information. +--- + +# tencentcloud_clb_target_groups + +Use this data source to query target group information. + +## Example Usage + +```hcl +resource "tencentcloud_clb_instance" "clb_basic" { + network_type = "OPEN" + clb_name = "tf-clb-rule-basic" +} + +resource "tencentcloud_clb_listener" "listener_basic" { + clb_id = tencentcloud_clb_instance.clb_basic.id + port = 1 + protocol = "HTTP" + listener_name = "listener_basic" +} + +resource "tencentcloud_clb_listener_rule" "rule_basic" { + clb_id = tencentcloud_clb_instance.clb_basic.id + listener_id = tencentcloud_clb_listener.listener_basic.listener_id + domain = "abc.com" + url = "/" + session_expire_time = 30 + scheduler = "WRR" + target_type = "TARGETGROUP" +} + +resource "tencentcloud_clb_target_group" "test" { + target_group_name = "test-target-keep-1" +} + +resource "tencentcloud_clb_target_group_attachment" "group" { + clb_id = tencentcloud_clb_instance.clb_basic.id + listener_id = tencentcloud_clb_listener.listener_basic.listener_id + rule_id = tencentcloud_clb_listener_rule.rule_basic.rule_id + targrt_group_id = tencentcloud_clb_target_group.test.id +} + +data "tencentcloud_clb_target_groups" "target_group_info_id" { + target_group_id = tencentcloud_clb_target_group.test.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `target_group_id` - (Optional, String) ID of Target group. Mutually exclusive with `vpc_id` and `target_group_name`. `target_group_id` is preferred. +* `target_group_name` - (Optional, String) Name of target group. Mutually exclusive with `target_group_id`. `target_group_id` is preferred. +* `vpc_id` - (Optional, String) Target group VPC ID. Mutually exclusive with `target_group_id`. `target_group_id` is preferred. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - Target group info list. + * `associated_rule_list` - List of associated rules. + * `domain` - Forwarding rule domain. + * `listener_id` - Listener ID. + * `listener_name` - Listener name. + * `listener_port` - Listener port. + * `load_balancer_id` - Load balance ID. + * `load_balancer_name` - Load balance name. + * `location_id` - Forwarding rule ID. + * `protocol` - Listener protocol type. + * `url` - Forwarding rule URL. + * `create_time` - Creation time of the target group. + * `port` - Port of target group. + * `target_group_id` - ID of Target group. + * `target_group_instance_list` - List of backend servers bound to the target group. + * `eni_id` - ID of Elastic Network Interface. + * `instance_id` - ID of backend service. + * `instance_name` - The instance name of the backend service. + * `private_ip_addresses` - Intranet IP list of back-end services. + * `public_ip_addresses` - List of external network IP of back-end services. + * `registered_time` - The time the backend service was bound. + * `server_port` - Port of backend service. + * `server_type` - Type of backend service. + * `weight` - Forwarding weight of back-end services. + * `target_group_name` - Target group VPC ID. + * `update_time` - Modification time of the target group. + * `vpc_id` - Name of target group. + + diff --git a/config/docs/d/clb_target_health.html.markdown b/config/docs/d/clb_target_health.html.markdown new file mode 100644 index 0000000..0a035ca --- /dev/null +++ b/config/docs/d/clb_target_health.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_target_health" +sidebar_current: "docs-tencentcloud-datasource-clb_target_health" +description: |- + Use this data source to query detailed information of clb target_health +--- + +# tencentcloud_clb_target_health + +Use this data source to query detailed information of clb target_health + +## Example Usage + +```hcl +data "tencentcloud_clb_target_health" "target_health" { + load_balancer_ids = ["lb-5dnrkgry"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `load_balancer_ids` - (Required, Set: [`String`]) List of IDs of CLB instances to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `load_balancers` - CLB instance list. Note: This field may return null, indicating that no valid values can be obtained. + * `listeners` - List of listeners. Note: This field may return null, indicating that no valid values can be obtained. + * `listener_id` - Listener ID. + * `listener_name` - Listener name. Note: This field may return null, indicating that no valid values can be obtained. + * `port` - Listener port. + * `protocol` - Listener protocol. + * `rules` - List of forwarding rules of the listener. Note: This field may return null, indicating that no valid values can be obtained. + * `domain` - Domain name of the forwarding rule. Note: This field may return null, indicating that no valid values can be obtained. + * `location_id` - Forwarding rule ID. + * `targets` - Health status of the real server bound to this rule. Note: this field may return null, indicating that no valid values can be obtained. + * `health_status_detail` - Detailed information about the current health status. Alive: healthy; Dead: exceptional; Unknown: check not started/checking/unknown status. + * `health_status` - Current health status. true: healthy; false: unhealthy. + * `ip` - Private IP of the target. + * `port` - Port bound to the target. + * `target_id` - Instance ID of the target, such as ins-12345678. + * `url` - Forwarding rule Url. Note: This field may return null, indicating that no valid values can be obtained. + * `load_balancer_id` - CLB instance ID. + * `load_balancer_name` - CLB instance name. Note: This field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/clickhouse_backup_job_detail.html.markdown b/config/docs/d/clickhouse_backup_job_detail.html.markdown new file mode 100644 index 0000000..dbc3c2a --- /dev/null +++ b/config/docs/d/clickhouse_backup_job_detail.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "ClickHouse(CDWCH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clickhouse_backup_job_detail" +sidebar_current: "docs-tencentcloud-datasource-clickhouse_backup_job_detail" +description: |- + Use this data source to query detailed information of clickhouse backup job detail +--- + +# tencentcloud_clickhouse_backup_job_detail + +Use this data source to query detailed information of clickhouse backup job detail + +## Example Usage + +```hcl +data "tencentcloud_clickhouse_backup_job_detail" "backup_job_detail" { + instance_id = "cdwch-xxxxxx" + back_up_job_id = 1234 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `back_up_job_id` - (Required, Int) Back up job id. +* `instance_id` - (Required, String) Instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `table_contents` - Back up tables. + * `database` - Database. + * `ips` - Ips. + * `rip` - Ip address of cvm. + * `table` - Table. + * `total_bytes` - Total bytes. + * `v_cluster` - Virtual cluster. + * `zoo_path` - ZK path. + + diff --git a/config/docs/d/clickhouse_backup_jobs.html.markdown b/config/docs/d/clickhouse_backup_jobs.html.markdown new file mode 100644 index 0000000..048b1ef --- /dev/null +++ b/config/docs/d/clickhouse_backup_jobs.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "ClickHouse(CDWCH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clickhouse_backup_jobs" +sidebar_current: "docs-tencentcloud-datasource-clickhouse_backup_jobs" +description: |- + Use this data source to query detailed information of clickhouse backup jobs +--- + +# tencentcloud_clickhouse_backup_jobs + +Use this data source to query detailed information of clickhouse backup jobs + +## Example Usage + +```hcl +data "tencentcloud_clickhouse_backup_jobs" "backup_jobs" { + instance_id = "cdwch-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance id. +* `begin_time` - (Optional, String) Begin time. +* `end_time` - (Optional, String) End time. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `back_up_jobs` - Back up jobs. + * `back_up_size` - Back up size. + * `back_up_time` - Back up create time. + * `back_up_type` - Back up type. + * `expire_time` - Back up expire time. + * `job_id` - Back up job id. + * `job_status` - Job status. + * `snapshot` - Back up job name. + + diff --git a/config/docs/d/clickhouse_backup_tables.html.markdown b/config/docs/d/clickhouse_backup_tables.html.markdown new file mode 100644 index 0000000..3ec5881 --- /dev/null +++ b/config/docs/d/clickhouse_backup_tables.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "ClickHouse(CDWCH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clickhouse_backup_tables" +sidebar_current: "docs-tencentcloud-datasource-clickhouse_backup_tables" +description: |- + Use this data source to query detailed information of clickhouse backup tables +--- + +# tencentcloud_clickhouse_backup_tables + +Use this data source to query detailed information of clickhouse backup tables + +## Example Usage + +```hcl +data "tencentcloud_clickhouse_backup_tables" "backup_tables" { + instance_id = "cdwch-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `available_tables` - Available tables. + * `database` - Database. + * `ips` - Table ips. + * `rip` - Ip address of cvm. + * `table` - Table. + * `total_bytes` - Table total bytes. + * `v_cluster` - Virtual cluster. + * `zoo_path` - Zk path. + + diff --git a/config/docs/d/cls_machine_group_configs.html.markdown b/config/docs/d/cls_machine_group_configs.html.markdown new file mode 100644 index 0000000..dcd79e3 --- /dev/null +++ b/config/docs/d/cls_machine_group_configs.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_machine_group_configs" +sidebar_current: "docs-tencentcloud-datasource-cls_machine_group_configs" +description: |- + Use this data source to query detailed information of cls machine_group_configs +--- + +# tencentcloud_cls_machine_group_configs + +Use this data source to query detailed information of cls machine_group_configs + +## Example Usage + +```hcl +resource "tencentcloud_cls_machine_group" "group" { + group_name = "tf-describe-mg-config-test" + service_logging = true + auto_update = true + update_end_time = "19:05:00" + update_start_time = "17:05:00" + + machine_group_type { + type = "ip" + values = [ + "192.168.1.1", + "192.168.1.2", + ] + } +} + +data "tencentcloud_cls_machine_group_configs" "machine_group_configs" { + group_id = tencentcloud_cls_machine_group.group.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String) group id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `configs` - scrape config list. + * `config_id` - scrape config id. + * `create_time` - create time. + * `exclude_paths` - Collection path blocklist. + * `type` - Type. Valid values: File, Path. + * `value` - Specific content corresponding to Type. + * `extract_rule` - Extraction rule. If ExtractRule is set, LogType must be set. + * `address` - syslog system log collection specifies the address and port that the collector listens to. + * `backtracking` - Size of the data to be rewound in incremental collection mode. Default value: -1 (full collection). + * `begin_regex` - First-Line matching rule, which is valid only if log_type is multiline_log or fullregex_log. + * `delimiter` - Delimiter for delimited log, which is valid only if log_type is delimiter_log. + * `filter_key_regex` - Log keys to be filtered and the corresponding regex. + * `key` - Log key to be filtered. + * `regex` - Filter rule regex corresponding to key. + * `is_gbk` - GBK encoding. Default 0. + * `json_standard` - standard json. Default 0. + * `keys` - Key name of each extracted field. An empty key indicates to discard the field. This parameter is valid only if log_type is delimiter_log. json_log logs use the key of JSON itself. + * `log_regex` - Full log matching rule, which is valid only if log_type is fullregex_log. + * `meta_tags` - metadata tags. + * `key` - tag key. + * `value` - tag value. + * `metadata_type` - metadata type. + * `parse_protocol` - parse protocol. + * `path_regex` - metadata path regex. + * `protocol` - syslog protocol, tcp or udp. + * `time_format` - Time field format. For more information, please see the output parameters of the time format description of the strftime function in C language. + * `time_key` - Time field key name. time_key and time_format must appear in pair. + * `un_match_log_key` - Unmatched log key. + * `un_match_up_load_switch` - Whether to upload the logs that failed to be parsed. Valid values: true: yes; false: no. + * `log_format` - style of log format. + * `log_type` - log type. + * `name` - scrape config name. + * `output` - topicid. + * `path` - scrape log path. + * `update_time` - update time. + * `user_define_rule` - user define rule. + + diff --git a/config/docs/d/cls_machines.html.markdown b/config/docs/d/cls_machines.html.markdown new file mode 100644 index 0000000..e17f392 --- /dev/null +++ b/config/docs/d/cls_machines.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_machines" +sidebar_current: "docs-tencentcloud-datasource-cls_machines" +description: |- + Use this data source to query detailed information of cls machines +--- + +# tencentcloud_cls_machines + +Use this data source to query detailed information of cls machines + +## Example Usage + +```hcl +resource "tencentcloud_cls_machine_group" "group" { + group_name = "tf-describe-mg-test" + service_logging = true + auto_update = true + update_end_time = "19:05:00" + update_start_time = "17:05:00" + + machine_group_type { + type = "ip" + values = [ + "192.168.1.1", + "192.168.1.2", + ] + } +} + +data "tencentcloud_cls_machines" "machines" { + group_id = tencentcloud_cls_machine_group.group.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String) Group id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `machines` - Info of Machines. + * `auto_update` - if open auto update flag. + * `err_code` - code of update operation. + * `err_msg` - msg of update operation. + * `ip` - ip of machine. + * `offline_time` - offline time of machine. + * `status` - status of machine. + * `update_status` - machine update status. + * `version` - current machine version. + + diff --git a/config/docs/d/cls_shipper_tasks.html.markdown b/config/docs/d/cls_shipper_tasks.html.markdown new file mode 100644 index 0000000..79b9afa --- /dev/null +++ b/config/docs/d/cls_shipper_tasks.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_shipper_tasks" +sidebar_current: "docs-tencentcloud-datasource-cls_shipper_tasks" +description: |- + Use this data source to query detailed information of cls shipper_tasks +--- + +# tencentcloud_cls_shipper_tasks + +Use this data source to query detailed information of cls shipper_tasks + +## Example Usage + +```hcl +data "tencentcloud_cls_shipper_tasks" "shipper_tasks" { + shipper_id = "dbde3c9b-ea16-4032-bc2a-d8fa65567a8e" + start_time = 160749910700 + end_time = 160749910800 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) end time(ms). +* `shipper_id` - (Required, String) shipper id. +* `start_time` - (Required, Int) start time(ms). +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `tasks` - . + * `end_time` - end time(ms). + * `message` - detail info. + * `range_end` - end time of current task (ms). + * `range_start` - start time of current task (ms). + * `shipper_id` - shipper id. + * `start_time` - start time(ms). + * `status` - status of current shipper task. + * `task_id` - task id. + * `topic_id` - topic id. + + diff --git a/config/docs/d/container_cluster_instances.html.markdown b/config/docs/d/container_cluster_instances.html.markdown new file mode 100644 index 0000000..ba93d9a --- /dev/null +++ b/config/docs/d/container_cluster_instances.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Container Cluster" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_container_cluster_instances" +sidebar_current: "docs-tencentcloud-datasource-container_cluster_instances" +description: |- + Get all instances of the specific cluster. +--- + +# tencentcloud_container_cluster_instances + +Get all instances of the specific cluster. + +Use this data source to get all instances in a specific cluster. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_kubernetes_clusters. + +## Example Usage + +```hcl +data "tencentcloud_container_cluster_instances" "foo_instance" { + cluster_id = "cls-abcdefg" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) An ID identify the cluster, like cls-xxxxxx. +* `limit` - (Optional, Int) An int variable describe how many instances in return at most. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `nodes` - An information list of kubernetes instances. + * `abnormal_reason` - Describe the reason when node is in abnormal state(if it was). + * `cpu` - Describe the cpu of the node. + * `instance_id` - An id identify the node, provided by cvm. + * `is_normal` - Describe whether the node is normal. + * `lan_ip` - Describe the LAN IP of the node. + * `mem` - Describe the memory of the node. + * `wan_ip` - Describe the WAN IP of the node. +* `total_count` - Number of instances. + + diff --git a/config/docs/d/container_clusters.html.markdown b/config/docs/d/container_clusters.html.markdown new file mode 100644 index 0000000..6652ad3 --- /dev/null +++ b/config/docs/d/container_clusters.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Container Cluster" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_container_clusters" +sidebar_current: "docs-tencentcloud-datasource-container_clusters" +description: |- + Get container clusters in the current region. +--- + +# tencentcloud_container_clusters + +Get container clusters in the current region. + +Use this data source to get container clusters in the current region. By default every clusters in current region will be returned. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_kubernetes_clusters. + +## Example Usage + +```hcl +data "tencentcloud_container_clusters" "foo" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Optional, String) An id identify the cluster, like `cls-xxxxxx`. +* `limit` - (Optional, Int) An int variable describe how many cluster in return at most. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `clusters` - An information list of kubernetes clusters. + * `cluster_id` - An id identify the cluster, like `cls-xxxxxx`. + * `cluster_name` - Name the cluster. + * `description` - The description of the cluster. + * `kubernetes_version` - Describe the running kubernetes version on the cluster. + * `nodes_num` - Describe how many cluster instances in the cluster. + * `nodes_status` - Describe the current status of the instances in the cluster. + * `security_certification_authority` - Describe the certificate string needed for using kubectl to access to kubernetes. + * `security_cluster_external_endpoint` - Describe the address needed for using kubectl to access to kubernetes. + * `security_password` - Describe the password needed for using kubectl to access to kubernetes. + * `security_username` - Describe the username needed for using kubectl to access to kubernetes. + * `total_cpu` - Describe the total cpu of each instance in the cluster. + * `total_mem` - Describe the total memory of each instance in the cluster. +* `total_count` - Number of clusters. + + diff --git a/config/docs/d/cos_batchs.html.markdown b/config/docs/d/cos_batchs.html.markdown new file mode 100644 index 0000000..105429a --- /dev/null +++ b/config/docs/d/cos_batchs.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_batchs" +sidebar_current: "docs-tencentcloud-datasource-cos_batchs" +description: |- + Use this data source to query the COS batch. +--- + +# tencentcloud_cos_batchs + +Use this data source to query the COS batch. + +## Example Usage + +```hcl +data "tencentcloud_cos_batchs" "cos_batchs" { + uin = "xxxxxx" + appid = "xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `appid` - (Required, Int) Appid. +* `uin` - (Required, String) Uin. +* `job_statuses` - (Optional, String) The task status information you need to query. If you do not specify a task status, COS returns the status of all tasks that have been executed, including those that are in progress. If you specify a task status, COS returns the task in the specified state. Optional task states include: Active, Cancelled, Cancelling, Complete, Completing, Failed, Failing, New, Paused, Pausing, Preparing, Ready, Suspended. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `jobs` - Multiple batch processing task information. + * `creation_time` - Job creation time. + * `description` - Mission description. The length is limited to 0-256 bytes. + * `job_id` - Job ID. The length is limited to 1-64 bytes. + * `operation` - Actions performed on objects in a batch processing job. For example, COSPutObjectCopy. + * `priority` - Mission priority. Tasks with higher values will be given priority. The priority size is limited to 0-2147483647. + * `progress_summary` - Summary of the status of task implementation. Describe the total number of operations performed in this task, the number of successful operations, and the number of failed operations. + * `number_of_tasks_failed` - The current failed Operand. + * `number_of_tasks_succeeded` - The current successful Operand. + * `total_number_of_tasks` - Total Operand. + * `status` - Task execution status. Legal parameter values include Active, Cancelled, Cancelling, Complete, Completing, Failed, Failing, New, Paused, Pausing, Preparing, Ready, Suspended. + * `termination_date` - The end time of the batch processing job. + + diff --git a/config/docs/d/cos_bucket_inventorys.html.markdown b/config/docs/d/cos_bucket_inventorys.html.markdown new file mode 100644 index 0000000..03b1ae1 --- /dev/null +++ b/config/docs/d/cos_bucket_inventorys.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_bucket_inventorys" +sidebar_current: "docs-tencentcloud-datasource-cos_bucket_inventorys" +description: |- + Use this data source to query the COS bucket inventorys. +--- + +# tencentcloud_cos_bucket_inventorys + +Use this data source to query the COS bucket inventorys. + +## Example Usage + +```hcl +data "tencentcloud_cos_bucket_inventorys" "cos_bucket_inventorys" { + bucket = "xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) Bucket. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `inventorys` - Multiple batch processing task information. + * `destination` - Information about the inventory result destination. + * `account_id` - ID of the bucket owner. + * `bucket` - Bucket name. + * `encryption` - Server-side encryption for the inventory result. + * `sse_cos` - Encryption with COS-managed key. This field can be left empty. + * `format` - Format of the inventory result. Valid value: CSV. + * `prefix` - Prefix of the inventory result. + * `filter` - Filters objects prefixed with the specified value to analyze. + * `period` - Creation time range of the objects to analyze. + * `end_time` - Creation end time of the objects to analyze. The parameter is a timestamp in seconds, for example, 1568688762. + * `start_time` - Creation start time of the objects to analyze. The parameter is a timestamp in seconds, for example, 1568688761. + * `prefix` - Prefix of the objects to analyze. + * `id` - Whether to enable the inventory. true or false. + * `included_object_versions` - Whether to include object versions in the inventory. All or No. + * `is_enabled` - Whether to enable the inventory. true or false. + * `schedule` - Inventory job cycle. + * `frequency` - Frequency of the inventory job. Enumerated values: Daily, Weekly. + + diff --git a/config/docs/d/cos_bucket_multipart_uploads.html.markdown b/config/docs/d/cos_bucket_multipart_uploads.html.markdown new file mode 100644 index 0000000..e55bbc0 --- /dev/null +++ b/config/docs/d/cos_bucket_multipart_uploads.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_bucket_multipart_uploads" +sidebar_current: "docs-tencentcloud-datasource-cos_bucket_multipart_uploads" +description: |- + Use this data source to query the COS bucket multipart uploads. +--- + +# tencentcloud_cos_bucket_multipart_uploads + +Use this data source to query the COS bucket multipart uploads. + +## Example Usage + +```hcl +data "tencentcloud_cos_bucket_multipart_uploads" "cos_bucket_multipart_uploads" { + bucket = "xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) Bucket. +* `delimiter` - (Optional, String) The delimiter is a symbol, and the Object name contains the Object between the specified prefix and the first occurrence of delimiter characters as a set of elements: common prefix. If there is no prefix, start from the beginning of the path. +* `encoding_type` - (Optional, String) Specifies the encoding format of the return value. Legal value: url. +* `prefix` - (Optional, String) The returned Object key must be prefixed with Prefix. Note that when using the prefix query, the returned key still contains Prefix. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `uploads` - Information for each Upload. + * `initiated` - The starting time of multipart upload. + * `initiator` - Used to represent the information of the initiator of this upload. + * `display_name` - Abbreviation for user identity ID (UIN). + * `id` - The user's unique CAM identity ID. + * `key` - Name of the Object. + * `owner` - Information used to represent the owner of these chunks. + * `display_name` - Abbreviation for user identity ID (UIN). + * `id` - The user's unique CAM identity ID. + * `storage_class` - Used to represent the storage level of a chunk. Enumerated value: STANDARD,STANDARD_IA,ARCHIVE. + * `upload_id` - Mark the ID of this multipart upload. + + diff --git a/config/docs/d/cos_bucket_object.html.markdown b/config/docs/d/cos_bucket_object.html.markdown new file mode 100644 index 0000000..654ad6e --- /dev/null +++ b/config/docs/d/cos_bucket_object.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_bucket_object" +sidebar_current: "docs-tencentcloud-datasource-cos_bucket_object" +description: |- + Use this data source to query the metadata of an object stored inside a bucket. +--- + +# tencentcloud_cos_bucket_object + +Use this data source to query the metadata of an object stored inside a bucket. + +## Example Usage + +```hcl +data "tencentcloud_cos_bucket_object" "mycos" { + bucket = "mycos-test-1258798060" + key = "hello-world.py" + result_output_file = "TFresults" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) Name of the bucket that contains the objects to query. +* `key` - (Required, String) The full path to the object inside the bucket. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cache_control` - Specifies caching behavior along the request/reply chain. +* `content_disposition` - Specifies presentational information for the object. +* `content_encoding` - Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. +* `content_type` - A standard MIME type describing the format of the object data. +* `etag` - ETag generated for the object, which is may not equal to MD5 value. +* `last_modified` - Last modified date of the object. +* `storage_class` - Object storage type such as STANDARD. + + diff --git a/config/docs/d/cos_buckets.html.markdown b/config/docs/d/cos_buckets.html.markdown new file mode 100644 index 0000000..e81e47a --- /dev/null +++ b/config/docs/d/cos_buckets.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_buckets" +sidebar_current: "docs-tencentcloud-datasource-cos_buckets" +description: |- + Use this data source to query the COS buckets of the current Tencent Cloud user. +--- + +# tencentcloud_cos_buckets + +Use this data source to query the COS buckets of the current Tencent Cloud user. + +## Example Usage + +```hcl +data "tencentcloud_cos_buckets" "cos_buckets" { + bucket_prefix = "tf-bucket-" + result_output_file = "mytestpath" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket_prefix` - (Optional, String) A prefix string to filter results by bucket name. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) Tags to filter bucket. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `bucket_list` - A list of bucket. Each element contains the following attributes: + * `acl_body` - Bucket verbose acl configurations. + * `acl` - Bucket access control configurations. + * `bucket` - Bucket name, the format likes `-`. + * `cors_rules` - A list of CORS rule configurations. + * `allowed_headers` - Specifies which headers are allowed. + * `allowed_methods` - Specifies which methods are allowed. Can be GET, PUT, POST, DELETE or HEAD. + * `allowed_origins` - Specifies which origins are allowed. + * `expose_headers` - Specifies expose header in the response. + * `max_age_seconds` - Specifies time in seconds that browser can cache the response for a preflight request. + * `cos_bucket_url` - The URL of this cos bucket. + * `lifecycle_rules` - The lifecycle configuration of a bucket. + * `expiration` - Specifies a period in the object's expire. + * `date` - Specifies the date after which you want the corresponding action to take effect. + * `days` - Specifies the number of days after object creation when the specific rule action takes effect. + * `filter_prefix` - Object key prefix identifying one or more objects to which the rule applies. + * `non_current_expiration` - Specifies when non current object versions shall expire. + * `non_current_days` - Number of days after non current object creation when the specific rule action takes effect. The maximum value is 3650. + * `non_current_transition` - Specifies when to transition objects of non current versions and the target storage class. + * `non_current_days` - Number of days after non current object creation when the specific rule action takes effect. + * `storage_class` - Specifies the storage class to which you want the non current object to transition. Available values include STANDARD, STANDARD_IA and ARCHIVE. + * `transition` - Specifies a period in the object's transitions. + * `date` - Specifies the date after which you want the corresponding action to take effect. + * `days` - Specifies the number of days after object creation when the specific rule action takes effect. + * `storage_class` - Specifies the storage class to which you want the object to transition. Available values include STANDARD, STANDARD_IA and ARCHIVE. + * `origin_domain_rules` - Bucket origin domain rules. + * `origin_pull_rules` - Bucket Origin-Pull rules. + * `tags` - The tags of a bucket. + * `website` - A list of one element containing configuration parameters used when the bucket is used as a website. + * `error_document` - An absolute path to the document to return in case of a 4XX error. + * `index_document` - COS returns this index document when requests are made to the root domain or any of the subfolders. + + diff --git a/config/docs/d/css_backup_stream.html.markdown b/config/docs/d/css_backup_stream.html.markdown new file mode 100644 index 0000000..1f0793b --- /dev/null +++ b/config/docs/d/css_backup_stream.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_backup_stream" +sidebar_current: "docs-tencentcloud-datasource-css_backup_stream" +description: |- + Use this data source to query detailed information of css backup_stream +--- + +# tencentcloud_css_backup_stream + +Use this data source to query detailed information of css backup_stream + +## Example Usage + +```hcl +data "tencentcloud_css_backup_stream" "backup_stream" { + stream_name = "live" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `stream_name` - (Optional, String) Stream id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `stream_info_list` - Backup stream group info. + * `backup_list` - Backup stream info. + * `app_name` - Push path. + * `domain_name` - Push domain. + * `master_flag` - Master stream flag. + * `publish_time` - UTC time, eg, 2018-06-29T19:00:00Z. + * `source_from` - Source from. + * `upstream_sequence` - Push stream sequence. + * `host_group_name` - Group name. + * `optimal_enable` - Optimal switch, 1-enable, 0-disable. + * `stream_name` - Stream name. + + diff --git a/config/docs/d/css_domains.html.markdown b/config/docs/d/css_domains.html.markdown new file mode 100644 index 0000000..29e4b9d --- /dev/null +++ b/config/docs/d/css_domains.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_domains" +sidebar_current: "docs-tencentcloud-datasource-css_domains" +description: |- + Use this data source to query detailed information of css domains +--- + +# tencentcloud_css_domains + +Use this data source to query detailed information of css domains + +## Example Usage + +```hcl +data "tencentcloud_css_domains" "domains" { + domain_type = 0 + play_type = 1 + is_delay_live = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_prefix` - (Optional, String) domain name prefix. +* `domain_status` - (Optional, Int) domain name status filter. 0-disable, 1-enable. +* `domain_type` - (Optional, Int) Domain name type filtering. 0-push, 1-play. +* `is_delay_live` - (Optional, Int) 0 normal live broadcast 1 slow live broadcast default 0. +* `play_type` - (Optional, Int) Playing area, this parameter is meaningful only when DomainType=1. 1: Domestic.2: Global.3: Overseas. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `domain_list` - A list of domain name details. + * `b_c_name` - Is there a CName to the fixed rule domain name: 0: No. 1: Yes. + * `create_time` - add time.Note: This field is Beijing time (UTC+8 time zone). + * `current_c_name` - The cname information used by the current client. + * `is_delay_live` - Whether to slow live broadcast: 0: normal live broadcast. 1: Slow live broadcast. + * `is_mini_program_live` - 0: Standard live broadcast. 1: Mini program live broadcast. Note: This field may return null, indicating that no valid value can be obtained. + * `name` - Live domain name. + * `play_type` - Playing area, this parameter is meaningful only when Type=1. 1: Domestic. 2: Global. 3: Overseas. + * `rent_expire_time` - Failure parameter, can be ignored. Note: This field is Beijing time (UTC+8 time zone). + * `rent_tag` - invalid parameter, can be ignored. + * `status` - Domain Status: 0: disable. 1: Enabled. + * `target_domain` - The domain name corresponding to the cname. + * `type` - Domain Type: 0: push stream. 1: Play. + + diff --git a/config/docs/d/css_monitor_report.html.markdown b/config/docs/d/css_monitor_report.html.markdown new file mode 100644 index 0000000..0dfce03 --- /dev/null +++ b/config/docs/d/css_monitor_report.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_monitor_report" +sidebar_current: "docs-tencentcloud-datasource-css_monitor_report" +description: |- + Use this data source to query detailed information of css monitor_report +--- + +# tencentcloud_css_monitor_report + +Use this data source to query detailed information of css monitor_report + +## Example Usage + +```hcl +data "tencentcloud_css_monitor_report" "monitor_report" { + monitor_id = "0e8a12b5-df2a-4a1b-aa98-97d5610aa142" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `monitor_id` - (Required, String) Monitor ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `diagnose_result` - The information about the media diagnostic result.Note: This field may return null, indicating that no valid value was found. + * `low_frame_rate_results` - The information about low frame rate.Note: This field may return null, indicating that no valid value was found. + * `stream_broken_results` - The information about the stream interruption.Note: This field may return null, indicating that no valid value was found. + * `stream_format_results` - The information about the stream format diagnosis.Note: This field may return null, indicating that no valid value was found. +* `mps_result` - The information about the media processing result.Note: This field may return null, indicating that no valid value was found. + * `ai_asr_results` - The result of intelligent speech recognition.Note: This field may return null, indicating that no valid value was found. + * `ai_ocr_results` - The result of intelligent text recognition.Note: This field may return null, indicating that no valid value was found. + + diff --git a/config/docs/d/css_pad_templates.html.markdown b/config/docs/d/css_pad_templates.html.markdown new file mode 100644 index 0000000..8a23516 --- /dev/null +++ b/config/docs/d/css_pad_templates.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_pad_templates" +sidebar_current: "docs-tencentcloud-datasource-css_pad_templates" +description: |- + Use this data source to query detailed information of css pad_templates +--- + +# tencentcloud_css_pad_templates + +Use this data source to query detailed information of css pad_templates + +## Example Usage + +```hcl +data "tencentcloud_css_pad_templates" "pad_templates" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `templates` - Live pad template information. + * `create_time` - Template create time. + * `description` - Description info. + * `max_duration` - Maximum pad duration.Value range: 0 - positive infinity.Unit: milliseconds. + * `template_id` - Template id. + * `template_name` - Template name. + * `type` - Pad content type: 1: Image, 2: Video. Default value: 1. + * `update_time` - Template modify time. + * `url` - Pad content. + * `wait_duration` - Stream interruption waiting time.Value range: 0-30000.Unit: milliseconds. + + diff --git a/config/docs/d/css_pull_stream_task_status.html.markdown b/config/docs/d/css_pull_stream_task_status.html.markdown new file mode 100644 index 0000000..12a67dc --- /dev/null +++ b/config/docs/d/css_pull_stream_task_status.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_pull_stream_task_status" +sidebar_current: "docs-tencentcloud-datasource-css_pull_stream_task_status" +description: |- + Use this data source to query detailed information of css pull_stream_task_status +--- + +# tencentcloud_css_pull_stream_task_status + +Use this data source to query detailed information of css pull_stream_task_status + +## Example Usage + +```hcl +data "tencentcloud_css_pull_stream_task_status" "pull_stream_task_status" { + task_id = "63229997" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `task_id` - (Required, String) Task ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `task_status_info` - Task status info. + * `file_duration` - The duration of the VOD source file, in seconds. + * `file_url` - Current use source url. + * `looped_times` - The number of times a VOD source task is played in a loop. + * `next_file_url` - The URL of the next progress VOD file. + * `offset_time` - The playback offset of the VOD source, in seconds. + * `report_time` - The latest heartbeat reporting time in UTC format, for example: 2022-02-11T10:00:00Z.Note: UTC time is 8 hours ahead of Beijing time. + * `run_status` - Real run status:active,inactive. + + diff --git a/config/docs/d/css_stream_monitor_list.html.markdown b/config/docs/d/css_stream_monitor_list.html.markdown new file mode 100644 index 0000000..8138545 --- /dev/null +++ b/config/docs/d/css_stream_monitor_list.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_stream_monitor_list" +sidebar_current: "docs-tencentcloud-datasource-css_stream_monitor_list" +description: |- + Use this data source to query detailed information of css stream_monitor_list +--- + +# tencentcloud_css_stream_monitor_list + +Use this data source to query detailed information of css stream_monitor_list + +## Example Usage + +```hcl +data "tencentcloud_css_stream_monitor_list" "stream_monitor_list" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `live_stream_monitors` - The list of live stream monitoring tasks.Note: This field may return null, indicating that no valid value is available. + * `ai_asr_input_index_list` - The list of input indices for enabling intelligent speech recognition.Note: This field may return null, indicating that no valid value is available. + * `ai_format_diagnose` - Whether to enable format diagnosis. Note: This field may return null, indicating that no valid value is available. + * `ai_ocr_input_index_list` - The list of input indices for enabling intelligent text recognition.Note: This field may return null, indicating that no valid value is available. + * `allow_monitor_report` - Whether to store monitoring events in the monitoring report and allow querying of the monitoring report.Note: This field may return null, indicating that no valid value is available. + * `asr_language` - The language for intelligent speech recognition:0: Disabled1: Chinese2: English3: Japanese4: KoreanNote: This field may return null, indicating that no valid value is available. + * `audible_input_index_list` - The list of input indices for the output audio.Note: This field may return null, indicating that no valid value is available. + * `check_stream_broken` - Whether to enable stream disconnection detection.Note: This field may return null, indicating that no valid value is available. + * `check_stream_low_frame_rate` - Whether to enable low frame rate detection.Note: This field may return null, indicating that no valid value is available. + * `create_time` - The creation time of the monitoring task, in Unix timestamp format.Note: This field may return null, indicating that no valid value is available. + * `input_list` - The input stream information for the monitoring task.Note: This field may return null, indicating that no valid value is available. + * `description` - Description of the monitoring task.It should be within 256 bytes.Note: This field may return null, indicating that no valid value is available. + * `input_app` - The push path for the input stream to be monitored.It should be within 32 bytes and can only contain letters, numbers, `-`, `_`, and `.` characters.Note: This field may return null, indicating that no valid value is available. + * `input_domain` - The push domain for the input stream to be monitored.It should be within 128 bytes and can only be filled with an enabled push domain.Note: This field may return null, indicating that no valid value is available. + * `input_stream_name` - The name of the input stream for the monitoring task.It should be within 256 bytes and can only contain letters, numbers, `-`, `_`, and `.` characters.Note: This field may return null, indicating that no valid value is available. + * `input_url` - The push URL for the input stream to be monitored. In most cases, this parameter is not required.Note: This field may return null, indicating that no valid value is available. + * `monitor_id` - Monitoring task ID.Note: This field may return null, indicating that no valid value is available. + * `monitor_name` - Monitoring task name. Up to 128 bytes.Note: This field may return null, indicating that no valid value is available. + * `notify_policy` - The notification policy for monitoring events.Note: This field may return null, indicating that no valid value is available. + * `callback_url` - The callback URL for notifications. It should be of length [0,512] and only support URLs with the http and https types.Note: This field may return null, indicating that no valid value is available. + * `notify_policy_type` - The type of notification policy: Range [0,1] 0: Represents no notification policy is used. 1: Represents the use of a global callback policy, where all events are notified to the CallbackUrl.Note: This field may return null, indicating that no valid value is available. + * `ocr_language` - The language for intelligent text recognition:0: Disabled1: Chinese and EnglishNote: This field may return null, indicating that no valid value is available. + * `output_info` - Monitoring task output information.Note: This field may return null, indicating that no valid value is available. + * `output_app` - The playback path for the monitoring task.It should be within 32 bytes and can only contain letters, numbers, `-`, `_`, and `.` characters.Note: This field may return null, indicating that no valid value is available. + * `output_domain` - The playback domain for the monitoring task.It should be within 128 bytes and can only be filled with an enabled playback domain.Note: This field may return null, indicating that no valid value is available. + * `output_stream_height` - The height of the output stream in pixels for the monitoring task. The range is [1, 1080]. It is recommended to be at least 100 pixels.Note: This field may return null, indicating that no valid value is available. + * `output_stream_name` - The name of the output stream for the monitoring task.If not specified, the system will generate a name automatically.The name should be within 256 bytes and can only contain letters, numbers, `-`, `_`, and `.` characters.Note: This field may return null, indicating that no valid value is available. + * `output_stream_width` - The width of the output stream in pixels for the monitoring task. The range is [1, 1920]. It is recommended to be at least 100 pixels.Note: This field may return null, indicating that no valid value is available. + * `start_time` - The last start time of the monitoring task, in Unix timestamp format.Note: This field may return null, indicating that no valid value is available. + * `status` - The status of the monitoring task. 0: Represents idle. 1: Represents monitoring in progress.Note: This field may return null, indicating that no valid value is available. + * `stop_time` - The last stop time of the monitoring task, in Unix timestamp format.Note: This field may return null, indicating that no valid value is available. + * `update_time` - The update time of the monitoring task, in Unix timestamp format.Note: This field may return null, indicating that no valid value is available. + + diff --git a/config/docs/d/css_time_shift_record_detail.html.markdown b/config/docs/d/css_time_shift_record_detail.html.markdown new file mode 100644 index 0000000..9dca713 --- /dev/null +++ b/config/docs/d/css_time_shift_record_detail.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_time_shift_record_detail" +sidebar_current: "docs-tencentcloud-datasource-css_time_shift_record_detail" +description: |- + Use this data source to query detailed information of css time_shift_record_detail +--- + +# tencentcloud_css_time_shift_record_detail + +Use this data source to query detailed information of css time_shift_record_detail + +## Example Usage + +```hcl +data "tencentcloud_css_time_shift_record_detail" "time_shift_record_detail" { + domain = "177154.push.tlivecloud.com" + app_name = "qqq" + stream_name = "live" + start_time = 1698768000 + end_time = 1698820641 + domain_group = "tf-test" + trans_code_id = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `app_name` - (Required, String) Push path. +* `domain` - (Required, String) Push domain. +* `end_time` - (Required, Int) The ending time of the query range is specified in Unix timestamp. +* `start_time` - (Required, Int) The starting time of the query range is specified in Unix timestamp. +* `stream_name` - (Required, String) Stream name. +* `domain_group` - (Optional, String) The streaming domain belongs to a group. If there is no domain group or the domain group is an empty string, it can be left blank. +* `result_output_file` - (Optional, String) Used to save results. +* `trans_code_id` - (Optional, Int) The transcoding template ID can be left blank if it is 0. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `record_list` - The array of time-shift recording sessions.Note: This field may return null, indicating that no valid value was found. + * `end_time` - The end time of the recording session is specified in Unix timestamp. + * `sid` - The identifier for the time-shift recording session. + * `start_time` - The start time of the recording session is specified in Unix timestamp. + + diff --git a/config/docs/d/css_time_shift_stream_list.html.markdown b/config/docs/d/css_time_shift_stream_list.html.markdown new file mode 100644 index 0000000..8b80305 --- /dev/null +++ b/config/docs/d/css_time_shift_stream_list.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_time_shift_stream_list" +sidebar_current: "docs-tencentcloud-datasource-css_time_shift_stream_list" +description: |- + Use this data source to query detailed information of css time_shift_stream_list +--- + +# tencentcloud_css_time_shift_stream_list + +Use this data source to query detailed information of css time_shift_stream_list + +## Example Usage + +```hcl +data "tencentcloud_css_time_shift_stream_list" "time_shift_stream_list" { + start_time = 1698768000 + end_time = 1698820641 + stream_name = "live" + domain = "177154.push.tlivecloud.com" + domain_group = "tf-test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) The end time, which must be a Unix timestamp. +* `start_time` - (Required, Int) The start time, which must be a Unix timestamp. +* `domain_group` - (Optional, String) The group the push domain belongs to. +* `domain` - (Optional, String) The push domain. +* `result_output_file` - (Optional, String) Used to save results. +* `stream_name` - (Optional, String) The stream name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `stream_list` - The information of the streams.Note: This field may return null, indicating that no valid values can be obtained. + * `app_name` - The push path. + * `domain_group` - The group the push domain belongs to.Note: This field may return null, indicating that no valid values can be obtained. + * `domain` - The push domain. + * `duration` - The storage duration (seconds) of the recording.Note: This field may return null, indicating that no valid values can be obtained. + * `end_time` - The stream end time (for streams that ended before the time of query), which is a Unix timestamp. + * `start_time` - The stream start time, which is a Unix timestamp. + * `stream_name` - The stream name. + * `stream_type` - The stream type. `0`: The original stream; `1`: The watermarked stream; `2`: The transcoded stream. + * `trans_code_id` - The transcoding template ID.Note: This field may return null, indicating that no valid values can be obtained. +* `total_size` - The total number of records in the specified time period. + + diff --git a/config/docs/d/css_watermarks.html.markdown b/config/docs/d/css_watermarks.html.markdown new file mode 100644 index 0000000..4c4b32a --- /dev/null +++ b/config/docs/d/css_watermarks.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_watermarks" +sidebar_current: "docs-tencentcloud-datasource-css_watermarks" +description: |- + Use this data source to query detailed information of css watermarks +--- + +# tencentcloud_css_watermarks + +Use this data source to query detailed information of css watermarks + +## Example Usage + +```hcl +data "tencentcloud_css_watermarks" "watermarks" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `watermark_list` - Watermark information list. + * `create_time` - The time when the watermark was added.Note: Beijing time (UTC+8) is used. + * `height` - Watermark height. + * `picture_url` - Watermark image URL. + * `status` - Current status. 0: not used. 1: in use. + * `watermark_id` - Watermark ID. + * `watermark_name` - Watermark name. + * `width` - Watermark width. + * `x_position` - Display position: X-axis offset. + * `y_position` - Display position: Y-axis offset. + + diff --git a/config/docs/d/css_xp2p_detail_info_list.html.markdown b/config/docs/d/css_xp2p_detail_info_list.html.markdown new file mode 100644 index 0000000..5aa0653 --- /dev/null +++ b/config/docs/d/css_xp2p_detail_info_list.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_xp2p_detail_info_list" +sidebar_current: "docs-tencentcloud-datasource-css_xp2p_detail_info_list" +description: |- + Use this data source to query detailed information of css xp2p_detail_info_list +--- + +# tencentcloud_css_xp2p_detail_info_list + +Use this data source to query detailed information of css xp2p_detail_info_list + +## Example Usage + +```hcl +data "tencentcloud_css_xp2p_detail_info_list" "xp2p_detail_info_list" { + query_time = "2023-11-01T14:55:01+08:00" + type = ["live"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dimension` - (Optional, Set: [`String`]) The dimension parameter can be used to specify the dimension for the query. If this parameter is not passed, the query will default to stream-level data. If you pass this parameter, it will only retrieve data for the specified dimension. The available dimension currently supported is AppId dimension, which allows you to query data based on the application ID. Please note that the returned fields will be related to the specified dimension. +* `query_time` - (Optional, String) The UTC minute granularity query time for querying usage data for a specific minute is in the format: yyyy-mm-ddTHH:MM:00Z. Please refer to the link https://cloud.tencent.com/document/product/266/11732#I.For example, if the local time is 2019-01-08 10:00:00 in Beijing, the corresponding UTC time would be 2019-01-08T10:00:00+08:00.This query supports data from the past six months. +* `result_output_file` - (Optional, String) Used to save results. +* `stream_names` - (Optional, Set: [`String`]) The stream array can be used to specify the streams to be queried. If no stream is specified, the query will include all streams by default. +* `type` - (Optional, Set: [`String`]) The type array can be used to specify the type of media content to be queried. The two available options are live for live streaming and vod for video on demand. If no type is specified, the query will include both live and VOD content by default. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data_info_list` - P2P streaming statistical information. + * `app_id` - AppId. Note: This field may return null, indicating that no valid value is available. + * `cdn_bytes` - CDN traffic. + * `online_people` - Online numbers. + * `p2p_bytes` - P2P traffic. + * `request_success` - Success numbers. + * `request` - Request numbers. + * `stream_name` - Stream ID.Note: This field may return null, indicating that no valid value is available. + * `stuck_people` - People count. + * `stuck_times` - Count. + * `time` - The requested format for time in UTC with one-minute granularity is yyyy-mm-ddTHH:MM:SSZ. This format follows the ISO 8601 standard and is commonly used for representing timestamps in UTC. For more information and examples, you can refer to the link provided: https://cloud.tencent.com/document/product/266/11732#I. + * `type` - Type, divided into two categories: live and vod.Note: This field may return null, indicating that no valid value is available. + + diff --git a/config/docs/d/cvm_chc_denied_actions.html.markdown b/config/docs/d/cvm_chc_denied_actions.html.markdown new file mode 100644 index 0000000..f0ef35e --- /dev/null +++ b/config/docs/d/cvm_chc_denied_actions.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_chc_denied_actions" +sidebar_current: "docs-tencentcloud-datasource-cvm_chc_denied_actions" +description: |- + Use this data source to query detailed information of cvm chc_denied_actions +--- + +# tencentcloud_cvm_chc_denied_actions + +Use this data source to query detailed information of cvm chc_denied_actions + +## Example Usage + +```hcl +data "tencentcloud_cvm_chc_denied_actions" "chc_denied_actions" { + chc_ids = ["chc-xxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `chc_ids` - (Required, Set: [`String`]) CHC host IDs. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `chc_host_denied_action_set` - Actions not allowed for the CHC instance. + * `chc_id` - CHC instance ID. + * `deny_actions` - Actions not allowed for the current CHC instance. + * `state` - CHC instance status. + + diff --git a/config/docs/d/cvm_chc_hosts.html.markdown b/config/docs/d/cvm_chc_hosts.html.markdown new file mode 100644 index 0000000..b528a9f --- /dev/null +++ b/config/docs/d/cvm_chc_hosts.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_chc_hosts" +sidebar_current: "docs-tencentcloud-datasource-cvm_chc_hosts" +description: |- + Use this data source to query detailed information of cvm chc_hosts +--- + +# tencentcloud_cvm_chc_hosts + +Use this data source to query detailed information of cvm chc_hosts + +## Example Usage + +```hcl +data "tencentcloud_cvm_chc_hosts" "chc_hosts" { + chc_ids = ["chc-xxxxxx"] + filters { + name = "zone" + values = ["ap-guangzhou-7"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `chc_ids` - (Optional, Set: [`String`]) CHC host ID. Up to 100 instances per request is allowed. ChcIds and Filters cannot be specified at the same time. +* `filters` - (Optional, List) - `zone` Filter by the availability zone, such as ap-guangzhou-1. Valid values: See [Regions and Availability Zones](https://www.tencentcloud.com/document/product/213/6091?from_cn_redirect=1). +- `instance-name` Filter by the instance name. +- `instance-state` Filter by the instance status. For status details, see [InstanceStatus](https://www.tencentcloud.com/document/api/213/15753?from_cn_redirect=1#InstanceStatus). +- `device-type` Filter by the device type. +- `vpc-id` Filter by the unique VPC ID. +- `subnet-id` Filter by the unique VPC subnet ID. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Filter name. +* `values` - (Required, Set) Filter values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `chc_host_set` - List of returned instances. + * `bmc_ip` - Out-of-band network IPNote: This field may return null, indicating that no valid values can be obtained. + * `bmc_mac` - MAC address assigned under the out-of-band networkNote: This field may return null, indicating that no valid values can be obtained. + * `bmc_security_group_ids` - Out-of-band network security group IDNote: This field may return null, indicating that no valid values can be obtained. + * `bmc_virtual_private_cloud` - Out-of-band networkNote: This field may return null, indicating that no valid values can be obtained. + * `as_vpc_gateway` - Whether to use a CVM instance as a public gateway. The public gateway is only available when the instance has a public IP and resides in a VPC. Valid values:<br><li>TRUE: yes;<br><li>FALSE: no<br><br>Default: FALSE. + * `ipv6_address_count` - Number of IPv6 addresses randomly generated for the ENI. + * `private_ip_addresses` - Array of VPC subnet IPs. You can use this parameter when creating instances or modifying VPC attributes of instances. Currently you can specify multiple IPs in one subnet only when creating multiple instances at the same time. + * `subnet_id` - VPC subnet ID in the format subnet-xxx. To obtain valid subnet IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call DescribeSubnets and look for the unSubnetId fields in the response. If you specify DEFAULT for both SubnetId and VpcId when creating an instance, the default VPC will be used. + * `vpc_id` - VPC ID in the format of vpc-xxx. To obtain valid VPC IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call the DescribeVpcEx API and look for the unVpcId fields in the response. If you specify DEFAULT for both VpcId and SubnetId when creating an instance, the default VPC will be used. + * `chc_id` - CHC host ID. + * `cpu` - CPU cores of the CHC hostNote: This field may return null, indicating that no valid values can be obtained. + * `created_time` - Server creation time. + * `cvm_instance_id` - ID of the associated CVMNote: This field may return null, indicating that no valid values can be obtained. + * `deploy_ip` - Deployment network IPNote: This field may return null, indicating that no valid values can be obtained. + * `deploy_mac` - MAC address assigned under the deployment networkNote: This field may return null, indicating that no valid values can be obtained. + * `deploy_security_group_ids` - Deployment network security group IDNote: This field may return null, indicating that no valid values can be obtained. + * `deploy_virtual_private_cloud` - Deployment networkNote: This field may return null, indicating that no valid values can be obtained. + * `as_vpc_gateway` - Whether to use a CVM instance as a public gateway. The public gateway is only available when the instance has a public IP and resides in a VPC. Valid values:<br><li>TRUE: yes;<br><li>FALSE: no<br><br>Default: FALSE. + * `ipv6_address_count` - Number of IPv6 addresses randomly generated for the ENI. + * `private_ip_addresses` - Array of VPC subnet IPs. You can use this parameter when creating instances or modifying VPC attributes of instances. Currently you can specify multiple IPs in one subnet only when creating multiple instances at the same time. + * `subnet_id` - VPC subnet ID in the format subnet-xxx. To obtain valid subnet IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call DescribeSubnets and look for the unSubnetId fields in the response. If you specify DEFAULT for both SubnetId and VpcId when creating an instance, the default VPC will be used. + * `vpc_id` - VPC ID in the format of vpc-xxx. To obtain valid VPC IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call the DescribeVpcEx API and look for the unVpcId fields in the response. If you specify DEFAULT for both VpcId and SubnetId when creating an instance, the default VPC will be used. + * `device_type` - Device typeNote: This field may return null, indicating that no valid values can be obtained. + * `disk` - Disk capacity of the CHC hostNote: This field may return null, indicating that no valid values can be obtained. + * `hardware_description` - Instance hardware description, including CPU cores, memory capacity and disk capacity.Note: This field may return null, indicating that no valid values can be obtained. + * `instance_name` - Instance name. + * `instance_state` - CHC host status<br/><ul><li>REGISTERED: The CHC host is registered, but the out-of-band network and deployment network are not configured.</li><li>VPC_READY: The out-of-band network and deployment network are configured.</li><li>PREPARED: It's ready and can be associated with a CVM.</li><li>ONLINE: It's already associated with a CVM.</li></ul>. + * `memory` - Memory capacity of the CHC host (unit: GB)Note: This field may return null, indicating that no valid values can be obtained. + * `placement` - Availability zone. + * `host_id` - The ID of the CDH to which the instance belongs, only used as an output parameter. + * `host_ids` - ID list of CDHs from which the instance can be created. If you have purchased CDHs and specify this parameter, the instances you purchase will be randomly deployed on the CDHs. + * `host_ips` - IPs of the hosts to create CVMs. + * `project_id` - ID of the project to which the instance belongs. This parameter can be obtained from the projectId returned by DescribeProject. If this is left empty, the default project is used. + * `zone` - ID of the availability zone where the instance resides. You can call the [DescribeZones](https://www.tencentcloud.com/document/product/213/35071) API and obtain the ID in the returned Zone field. + * `serial_number` - Server serial number. + * `tenant_type` - Management typeHOSTING: HostingTENANT: LeasingNote: This field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/cvm_disaster_recover_group_quota.html.markdown b/config/docs/d/cvm_disaster_recover_group_quota.html.markdown new file mode 100644 index 0000000..cd9b5c9 --- /dev/null +++ b/config/docs/d/cvm_disaster_recover_group_quota.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_disaster_recover_group_quota" +sidebar_current: "docs-tencentcloud-datasource-cvm_disaster_recover_group_quota" +description: |- + Use this data source to query detailed information of cvm disaster_recover_group_quota +--- + +# tencentcloud_cvm_disaster_recover_group_quota + +Use this data source to query detailed information of cvm disaster_recover_group_quota + +## Example Usage + +```hcl +data "tencentcloud_cvm_disaster_recover_group_quota" "disaster_recover_group_quota" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `current_num` - The number of placement groups that have been created by the current user. +* `cvm_in_host_group_quota` - Quota on instances in a physical-machine-type disaster recovery group. +* `cvm_in_rack_group_quota` - Quota on instances in a rack-type disaster recovery group. +* `cvm_in_sw_group_quota` - Quota on instances in a switch-type disaster recovery group. +* `group_quota` - The maximum number of placement groups that can be created. + + diff --git a/config/docs/d/cvm_image_quota.html.markdown b/config/docs/d/cvm_image_quota.html.markdown new file mode 100644 index 0000000..a1a0871 --- /dev/null +++ b/config/docs/d/cvm_image_quota.html.markdown @@ -0,0 +1,33 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_image_quota" +sidebar_current: "docs-tencentcloud-datasource-cvm_image_quota" +description: |- + Use this data source to query detailed information of cvm image_quota +--- + +# tencentcloud_cvm_image_quota + +Use this data source to query detailed information of cvm image_quota + +## Example Usage + +```hcl +data "tencentcloud_cvm_image_quota" "image_quota" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `image_num_quota` - The image quota of an account. + + diff --git a/config/docs/d/cvm_image_share_permission.html.markdown b/config/docs/d/cvm_image_share_permission.html.markdown new file mode 100644 index 0000000..65b57af --- /dev/null +++ b/config/docs/d/cvm_image_share_permission.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_image_share_permission" +sidebar_current: "docs-tencentcloud-datasource-cvm_image_share_permission" +description: |- + Use this data source to query detailed information of cvm image_share_permission +--- + +# tencentcloud_cvm_image_share_permission + +Use this data source to query detailed information of cvm image_share_permission + +## Example Usage + +```hcl +data "tencentcloud_cvm_image_share_permission" "image_share_permission" { + image_id = "img-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `image_id` - (Required, String) The ID of the image to be shared. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `share_permission_set` - Information on image sharing. + * `account_id` - ID of the account with which the image is shared. + * `created_time` - Time when an image was shared. + + diff --git a/config/docs/d/cvm_import_image_os.html.markdown b/config/docs/d/cvm_import_image_os.html.markdown new file mode 100644 index 0000000..417ec04 --- /dev/null +++ b/config/docs/d/cvm_import_image_os.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_import_image_os" +sidebar_current: "docs-tencentcloud-datasource-cvm_import_image_os" +description: |- + Use this data source to query detailed information of cvm import_image_os +--- + +# tencentcloud_cvm_import_image_os + +Use this data source to query detailed information of cvm import_image_os + +## Example Usage + +```hcl +data "tencentcloud_cvm_import_image_os" "import_image_os" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `import_image_os_list_supported` - Supported operating system types of imported images. + * `linux` - Supported Linux OS Note: This field may return null, indicating that no valid values can be obtained. + * `windows` - Supported Windows OS Note: This field may return null, indicating that no valid values can be obtained. +* `import_image_os_version_set` - Supported operating system versions of imported images. + * `architecture` - Supported operating system architecture. + * `os_name` - Operating system type. + * `os_versions` - Supported operating system versions. + + diff --git a/config/docs/d/cvm_instance_vnc_url.html.markdown b/config/docs/d/cvm_instance_vnc_url.html.markdown new file mode 100644 index 0000000..771ea48 --- /dev/null +++ b/config/docs/d/cvm_instance_vnc_url.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_instance_vnc_url" +sidebar_current: "docs-tencentcloud-datasource-cvm_instance_vnc_url" +description: |- + Use this data source to query detailed information of cvm instance_vnc_url +--- + +# tencentcloud_cvm_instance_vnc_url + +Use this data source to query detailed information of cvm instance_vnc_url + +## Example Usage + +```hcl +data "tencentcloud_cvm_instance_vnc_url" "instance_vnc_url" { + instance_id = "ins-xxxxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. To obtain the instance IDs, you can call `DescribeInstances` and look for `InstanceId` in the response. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_vnc_url` - Instance VNC URL. + + diff --git a/config/docs/d/cvm_instances_modification.html.markdown b/config/docs/d/cvm_instances_modification.html.markdown new file mode 100644 index 0000000..b67fb82 --- /dev/null +++ b/config/docs/d/cvm_instances_modification.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_instances_modification" +sidebar_current: "docs-tencentcloud-datasource-cvm_instances_modification" +description: |- + Use this data source to query cvm instances modification. +--- + +# tencentcloud_cvm_instances_modification + +Use this data source to query cvm instances modification. + +## Example Usage + +```hcl +data "tencentcloud_cvm_instances_modification" "foo" { + instance_ids = ["ins-xxxxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) The upper limit of Filters for each request is 10 and the upper limit for Filter.Values is 2. +* `instance_ids` - (Optional, Set: [`String`]) One or more instance ID to be queried. It can be obtained from the InstanceId in the returned value of API DescribeInstances. The maximum number of instances in batch for each request is 20. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Fields to be filtered. +* `values` - (Required, Set) Value of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_type_config_status_list` - The list of model configurations that can be adjusted by the instance. + * `instance_type_config` - Configuration information. + * `cpu` - The number of CPU kernels, in cores. + * `fpga` - The number of FPGA kernels, in cores. + * `gpu` - The number of GPU kernels, in cores. + * `instance_family` - Instance family. + * `instance_type` - Instance type. + * `memory` - Memory capacity (in GB). + * `zone` - Availability zone. + * `message` - Status description information. + * `status` - State description. + + diff --git a/config/docs/d/cwp_machines_simple.html.markdown b/config/docs/d/cwp_machines_simple.html.markdown new file mode 100644 index 0000000..bd2c2b7 --- /dev/null +++ b/config/docs/d/cwp_machines_simple.html.markdown @@ -0,0 +1,126 @@ +--- +subcategory: "Cwp" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cwp_machines_simple" +sidebar_current: "docs-tencentcloud-datasource-cwp_machines_simple" +description: |- + Use this data source to query detailed information of cwp machines_simple +--- + +# tencentcloud_cwp_machines_simple + +Use this data source to query detailed information of cwp machines_simple + +## Example Usage + +```hcl +data "tencentcloud_cwp_machines_simple" "example" { + machine_type = "CVM" + machine_region = "ap-guangzhou" + project_ids = [1210293, 1157652] +} +``` + +### Query by Keyword filter + +```hcl +data "tencentcloud_cwp_machines_simple" "example" { + machine_type = "CVM" + machine_region = "ap-guangzhou" + project_ids = [0] + + filters { + name = "Keywords" + values = ["tf_example"] + exact_match = true + } +} +``` + +### Query by Version filter + +```hcl +data "tencentcloud_cwp_machines_simple" "example" { + machine_type = "CVM" + machine_region = "ap-guangzhou" + project_ids = [0] + + filters { + name = "Version" + values = ["BASIC_VERSION"] + exact_match = true + } +} +``` + +### Query by TagId filter + +```hcl +data "tencentcloud_cwp_machines_simple" "example" { + machine_type = "ALL" + machine_region = "all-regions" + + filters { + name = "TagId" + values = ["13771"] + exact_match = true + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `machine_region` - (Required, String) The area where the machine belongs,Such as: ap-guangzhou, ap-shanghai, all-regions: All server region types. +* `machine_type` - (Required, String) Service types. -CVM: Cloud Virtual Machine; -ECM: Edge Computing Machine; -LH: Lighthouse; -Other: Mixed cloud; -ALL: All server types. +* `filters` - (Optional, List) filter list. +* `project_ids` - (Optional, Set: [`Int`]) Project id list. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Only supported Keywords, Version and TagId. +* `values` - (Required, Set) If `name` is `Keywords`: enter keyword query; If `name` is `Version`: enter PRO_VERSION: Professional Edition | BASIC_VERSION: Basic | Flagship: Flagship | ProtectedMachines: Professional+Flagship | UnFlagship: Non Flagship | PRO_POST_PAY: Professional Edition Pay by Volume | PRO_PRE_PAY: Professional Edition Monthly Package query; If `name` is `TagId`: enter tag ID query. +* `exact_match` - (Optional, Bool) exact match. true or false. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `machines` - Machine list. + * `cloud_tags` - Cloud tags detailNote: This field may return null, indicating that a valid value cannot be obtained. + * `tag_key` - Tag key. + * `tag_value` - Tag value. + * `instance_id` - Instance IDNote: This field may return null, indicating that a valid value cannot be obtained. + * `instance_state` - Instance status. + * `is_pro_version` - Paid version or not. true: yes; false: no. + * `kernel_version` - Core Version. + * `license_order` - License Order ObjectNote: This field may return null, indicating that a valid value cannot be obtained. + * `license_id` - License ID. + * `license_type` - License Types. + * `resource_id` - Resource ID. + * `source_type` - Order types. + * `status` - License Order Status. + * `machine_ip` - Machine Internal net IP. + * `machine_name` - Machine name. + * `machine_os` - Machine OS System. + * `machine_type` - Service types. -CVM: Cloud Virtual Machine; -ECM: Edge Computing Machine -LH: Lighthouse; -Other: Mixed cloud; -ALL: All server types. + * `machine_wan_ip` - Machine Outer net IP. + * `pay_mode` - Payment model. POSTPAY: Pay as you go; PREPAY: Monthly subscription. + * `project_id` - Project ID. + * `protect_type` - Protection Version. -BASIC_VERSION: Basic Version; -PRO_VERSION: Pro Version -Flagship: Flagship Version; -GENERAL_DISCOUNT: CWP-LH Version. + * `quuid` - Cloud server sole UUID. + * `region_info` - Region detail. + * `region_code` - Region Code. + * `region_id` - Region ID. + * `region_name_en` - Regional English name. + * `region_name` - Regional Chinese name. + * `region` - Region, Such as ap-guangzhou, ap-shanghai, ap-beijing. + * `tag` - Tag. + * `name` - Tag name. + * `rid` - Relevance tag id. + * `tag_id` - Tag ID. + * `uuid` - Cwp client sole UUID. + + diff --git a/config/docs/d/cynosdb_account_all_grant_privileges.html.markdown b/config/docs/d/cynosdb_account_all_grant_privileges.html.markdown new file mode 100644 index 0000000..d59c69b --- /dev/null +++ b/config/docs/d/cynosdb_account_all_grant_privileges.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_account_all_grant_privileges" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_account_all_grant_privileges" +description: |- + Use this data source to query detailed information of cynosdb account_all_grant_privileges +--- + +# tencentcloud_cynosdb_account_all_grant_privileges + +Use this data source to query detailed information of cynosdb account_all_grant_privileges + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_account_all_grant_privileges" "account_all_grant_privileges" { + cluster_id = "cynosdbmysql-bws8h88b" + account { + account_name = "keep_dts" + host = "%" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account` - (Required, List) account information. +* `cluster_id` - (Required, String) Cluster ID. +* `result_output_file` - (Optional, String) Used to save results. + +The `account` object supports the following: + +* `account_name` - (Required, String) Account. +* `host` - (Optional, String) Host, default `%`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `database_privileges` - Database permissions note: This field may return null, indicating that a valid value cannot be obtained. + * `db` - database. + * `privileges` - Permission List. +* `global_privileges` - Global permission note: This field may return null, indicating that a valid value cannot be obtained. +* `privilege_statements` - Permission statement note: This field may return null, indicating that a valid value cannot be obtained. +* `table_privileges` - Database table permissions note: This field may return null, indicating that a valid value cannot be obtained. + * `db` - Database name. + * `privileges` - Permission List. + * `table_name` - Table Name. + + diff --git a/config/docs/d/cynosdb_accounts.html.markdown b/config/docs/d/cynosdb_accounts.html.markdown new file mode 100644 index 0000000..9911a5d --- /dev/null +++ b/config/docs/d/cynosdb_accounts.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_accounts" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_accounts" +description: |- + Use this data source to query detailed information of cynosdb accounts +--- + +# tencentcloud_cynosdb_accounts + +Use this data source to query detailed information of cynosdb accounts + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_accounts" "accounts" { + cluster_id = "cynosdbmysql-bws8h88b" + account_names = ["root"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) The ID of cluster. +* `account_names` - (Optional, Set: [`String`]) List of accounts to be filtered. +* `hosts` - (Optional, Set: [`String`]) List of hosts to be filtered. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `account_set` - Database account list.&quot;&quot;Note: This field may return null, indicating that no valid value can be obtained. + * `account_name` - Account name of database. + * `create_time` - Create time. + * `description` - The account description of database. + * `host` - Host. + * `max_user_connections` - Maximum number of user connections. + * `update_time` - Update time. + + diff --git a/config/docs/d/cynosdb_audit_logs.html.markdown b/config/docs/d/cynosdb_audit_logs.html.markdown new file mode 100644 index 0000000..7cfe75b --- /dev/null +++ b/config/docs/d/cynosdb_audit_logs.html.markdown @@ -0,0 +1,81 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_audit_logs" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_audit_logs" +description: |- + Use this data source to query detailed information of cynosdb audit_logs +--- + +# tencentcloud_cynosdb_audit_logs + +Use this data source to query detailed information of cynosdb audit_logs + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_audit_logs" "audit_logs" { + instance_id = "cynosdbmysql-ins-afqx1hy0" + start_time = "2023-06-18 10:00:00" + end_time = "2023-06-18 10:00:02" + order = "DESC" + order_by = "timestamp" + filter { + host = ["30.50.207.176"] + user = ["keep_dts"] + policy_name = ["default_audit"] + sql_type = "SELECT" + sql = "SELECT @@max_allowed_packet" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) The end time is in the format of 2017-07-12 10:29:20. +* `instance_id` - (Required, String) Instance ID. +* `start_time` - (Required, String) Start time, format: 2017-07-12 10:29:20. +* `filter` - (Optional, List) Filter conditions. You can filter logs according to the set filtering criteria. +* `order_by` - (Optional, String) Sort fields. The supported values include: timestamp - timestamp; &#39;effectRows&#39; - affects the number of rows; &#39;execTime&#39; - Execution time. +* `order` - (Optional, String) Sort by. The supported values include: ASC - ascending order, DESC - descending order. +* `result_output_file` - (Optional, String) Used to save results. + +The `filter` object supports the following: + +* `affect_rows` - (Optional, Int) Affects the number of rows. Indicates that filtering affects audit logs with rows greater than this value. +* `db_name` - (Optional, Set) Database name. +* `exec_time` - (Optional, Int) Execution time. Unit: ms. Indicates audit logs with a filter execution time greater than this value. +* `host` - (Optional, Set) Client address. +* `policy_name` - (Optional, Set) Audit policy name. +* `sent_rows` - (Optional, Int) Returns the number of rows. +* `sql_type` - (Optional, String) SQL type. Currently supported: SELECT, Insert, UPDATE, DELETE, CREATE, DROP, ALT, SET, REPLACE, EXECUTE. +* `sql_types` - (Optional, Set) SQL type. Supports simultaneous querying of multiple types. Currently supported: SELECT, Insert, UPDATE, DELETE, CREATE, DROP, ALT, SET, REPLACE, EXECUTE. +* `sql` - (Optional, String) SQL statement. Supports fuzzy matching. +* `sqls` - (Optional, Set) SQL statement. Supports passing multiple SQL statements. +* `table_name` - (Optional, Set) Table name. +* `thread_id` - (Optional, Set) Thread ID. +* `user` - (Optional, Set) User name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Audit log details. Note: This field may return null, indicating that a valid value cannot be obtained. + * `affect_rows` - Affects the number of rows. + * `db_name` - Database name. + * `err_code` - Error code. + * `exec_time` - Execution time. + * `host` - Client address. + * `instance_name` - Instance name. + * `policy_name` - Audit policy name. + * `sent_rows` - Number of rows sent. + * `sql_type` - SQL type. + * `sql` - SQL statement. + * `table_name` - Table name. + * `thread_id` - Execution thread ID. + * `timestamp` - Timestamp. + * `user` - User name. + + diff --git a/config/docs/d/cynosdb_binlog_download_url.html.markdown b/config/docs/d/cynosdb_binlog_download_url.html.markdown new file mode 100644 index 0000000..00c5c8c --- /dev/null +++ b/config/docs/d/cynosdb_binlog_download_url.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_binlog_download_url" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_binlog_download_url" +description: |- + Use this data source to query detailed information of cynosdb binlog_download_url +--- + +# tencentcloud_cynosdb_binlog_download_url + +Use this data source to query detailed information of cynosdb binlog_download_url + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_binlog_download_url" "binlog_download_url" { + cluster_id = "cynosdbmysql-bws8h88b" + binlog_id = 6202249 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `binlog_id` - (Required, Int) Binlog file ID. +* `cluster_id` - (Required, String) Cluster ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `download_url` - Download address. + + diff --git a/config/docs/d/cynosdb_cluster.html.markdown b/config/docs/d/cynosdb_cluster.html.markdown new file mode 100644 index 0000000..1c5e5c8 --- /dev/null +++ b/config/docs/d/cynosdb_cluster.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_cluster" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_cluster" +description: |- + Use this data source to query detailed information of cynosdb cluster +--- + +# tencentcloud_cynosdb_cluster + +Use this data source to query detailed information of cynosdb cluster + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_cluster" "cluster" { + cluster_id = "cynosdbmysql-bws8h88b" + database = "users" + table = "tb_user_name" + table_type = "all" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `database` - (Optional, String) Database name. +* `result_output_file` - (Optional, String) Used to save results. +* `table_type` - (Optional, String) Data table type: view: only return view, base_ Table: only returns the basic table, all: returns the view and table. +* `table` - (Optional, String) Data Table Name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `tables` - Note to the data table list: This field may return null, indicating that a valid value cannot be obtained. + * `database` - Database name note: This field may return null, indicating that a valid value cannot be obtained. + * `tables` - Table Name List Note: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/cynosdb_cluster_detail_databases.html.markdown b/config/docs/d/cynosdb_cluster_detail_databases.html.markdown new file mode 100644 index 0000000..c44541a --- /dev/null +++ b/config/docs/d/cynosdb_cluster_detail_databases.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_cluster_detail_databases" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_cluster_detail_databases" +description: |- + Use this data source to query detailed information of cynosdb cluster_detail_databases +--- + +# tencentcloud_cynosdb_cluster_detail_databases + +Use this data source to query detailed information of cynosdb cluster_detail_databases + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_cluster_detail_databases" "cluster_detail_databases" { + cluster_id = "cynosdbmysql-bws8h88b" + db_name = "users" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `db_name` - (Optional, String) Database Name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `db_infos` - Database information note: This field may return null, indicating that a valid value cannot be obtained. + * `app_id` - User appid note: This field may return null, indicating that a valid value cannot be obtained. + * `character_set` - Character Set Type. + * `cluster_id` - Cluster Id note: This field may return null, indicating that a valid value cannot be obtained. + * `collate_rule` - Capture Rules. + * `create_time` - Creation time note: This field may return null, indicating that a valid value cannot be obtained. + * `db_id` - Database ID note: This field may return null, indicating that a valid value cannot be obtained. + * `db_name` - Database Name. + * `description` - Database note: This field may return null, indicating that a valid value cannot be obtained. + * `status` - Database Status. + * `uin` - User Uin note: This field may return null, indicating that a valid value cannot be obtained. + * `update_time` - Update time note: This field may return null, indicating that a valid value cannot be obtained. + * `user_host_privileges` - User permission note: This field may return null, indicating that a valid value cannot be obtained. + * `db_host` - Database host. + * `db_privilege` - User permission note: This field may return null, indicating that a valid value cannot be obtained. + * `db_user_name` - DbUserName. + + diff --git a/config/docs/d/cynosdb_cluster_instance_groups.html.markdown b/config/docs/d/cynosdb_cluster_instance_groups.html.markdown new file mode 100644 index 0000000..59e8e00 --- /dev/null +++ b/config/docs/d/cynosdb_cluster_instance_groups.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_cluster_instance_groups" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_cluster_instance_groups" +description: |- + Use this data source to query detailed information of cynosdb cluster_instance_groups +--- + +# tencentcloud_cynosdb_cluster_instance_groups + +Use this data source to query detailed information of cynosdb cluster_instance_groups + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_cluster_instance_groups" "cluster_instance_groups" { + cluster_id = xxxxxx ; +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) The ID of cluster. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_grp_info_list` - List of instance groups. + * `app_id` - App id. + * `cluster_id` - The ID of cluster. + * `created_time` - Created time. + * `deleted_time` - Deleted time. + * `instance_grp_id` - The ID of instance group. + * `instance_set` - Instance groups contain instance information. + * `app_id` - User app id. + * `business_type` - Business type.Note: This field may return null, indicating that no valid value can be obtained. + * `cluster_id` - The id of cluster. + * `cluster_name` - The name of cluster. + * `cpu` - Cpu, unit: CORE. + * `create_time` - Create time. + * `cynos_version` - Cynos kernel version. + * `db_type` - Database type. + * `db_version` - Database version. + * `destroy_deadline_text` - Destroy deadline. + * `destroy_time` - Instance destroy time. + * `instance_id` - The id of instance. + * `instance_name` - The name of instance. + * `instance_role` - Instance role. + * `instance_type` - Instance type. + * `is_freeze` - Whether to freeze.Note: This field may return null, indicating that no valid value can be obtained. + * `isolate_time` - Isolate time. + * `max_cpu` - Serverless instance maxmum cpu. + * `memory` - Memory, unit: GB. + * `min_cpu` - Serverless instance minimum cpu. + * `net_type` - Net type. + * `pay_mode` - Pay mode. + * `period_end_time` - Instance expiration time. + * `physical_zone` - Physical zone. + * `processing_task` - Task being processed. + * `project_id` - The id of project. + * `region` - Region. + * `renew_flag` - Renew flag. + * `resource_tags` - Resource tags.Note: This field may return null, indicating that no valid value can be obtained. + * `tag_key` - The key of tag. + * `tag_value` - The value of tag. + * `serverless_status` - Serverless instance status, optional values:resumepause. + * `status_desc` - Instance state Chinese description. + * `status` - The status of instance. + * `storage_id` - Prepaid Storage Id.Note: This field may return null, indicating that no valid value can be obtained.. + * `storage_pay_mode` - Storage payment type. + * `storage` - Storage, unit: GB. + * `subnet_id` - Subnet ID. + * `tasks` - Task list.Note: This field may return null, indicating that no valid value can be obtained. + * `object_id` - Task ID (cluster ID|instance group ID|instance ID).Note: This field may return null, indicating that no valid value can be obtained. + * `object_type` - Object type.Note: This field may return null, indicating that no valid value can be obtained. + * `task_id` - Task auto-increment ID.Note: This field may return null, indicating that no valid value can be obtained. + * `task_status` - Task status.Note: This field may return null, indicating that no valid value can be obtained. + * `task_type` - Task type.Note: This field may return null, indicating that no valid value can be obtained. + * `uin` - User Uin. + * `update_time` - Update time. + * `vip` - Instance intranet IP. + * `vpc_id` - VPC network ID. + * `vport` - Instance intranet VPort. + * `wan_domain` - Public domain. + * `wan_ip` - Public IP. + * `wan_port` - Public port. + * `wan_status` - Public status. + * `zone` - Availability zone. + * `status` - Status. + * `type` - Instance group type. ha-ha group; ro-read-only group. + * `updated_time` - Updated time. + * `vip` - Intranet IP. + * `vport` - Intranet port. + * `wan_domain` - Public domain name. + * `wan_ip` - Public IP. + * `wan_port` - Public port. + * `wan_status` - Public status. + + diff --git a/config/docs/d/cynosdb_cluster_param_logs.html.markdown b/config/docs/d/cynosdb_cluster_param_logs.html.markdown new file mode 100644 index 0000000..898ae3b --- /dev/null +++ b/config/docs/d/cynosdb_cluster_param_logs.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_cluster_param_logs" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_cluster_param_logs" +description: |- + Use this data source to query detailed information of cynosdb cluster_param_logs +--- + +# tencentcloud_cynosdb_cluster_param_logs + +Use this data source to query detailed information of cynosdb cluster_param_logs + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_cluster_param_logs" "cluster_param_logs" { + cluster_id = "cynosdbmysql-bws8h88b" + instance_ids = ["cynosdbmysql-ins-afqx1hy0"] + order_by = "CreateTime" + order_by_type = "DESC" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `instance_ids` - (Optional, Set: [`String`]) Instance ID list, used to record specific instances of operations. +* `order_by_type` - (Optional, String) Define specific sorting rules, limited to one of desc, asc, DESC, or ASC. +* `order_by` - (Optional, String) Sort field, defining which field to sort based on when returning results. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cluster_param_logs` - Parameter modification record note: This field may return null, indicating that a valid value cannot be obtained. + * `cluster_id` - Cluster ID. + * `create_time` - Creation time. + * `current_value` - Current value. + * `instance_id` - Instance ID. + * `param_name` - Parameter Name. + * `status` - modify state. + * `update_time` - Update time. + * `update_value` - Modified value. + + diff --git a/config/docs/d/cynosdb_cluster_params.html.markdown b/config/docs/d/cynosdb_cluster_params.html.markdown new file mode 100644 index 0000000..c6ae960 --- /dev/null +++ b/config/docs/d/cynosdb_cluster_params.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_cluster_params" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_cluster_params" +description: |- + Use this data source to query detailed information of cynosdb cluster_params +--- + +# tencentcloud_cynosdb_cluster_params + +Use this data source to query detailed information of cynosdb cluster_params + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_cluster_params" "cluster_params" { + cluster_id = "cynosdbmysql-bws8h88b" + param_name = "innodb_checksum_algorithm" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) The ID of cluster. +* `param_name` - (Optional, String) Parameter name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Instance parameter list. Note: This field may return null, indicating that no valid value can be obtained. + * `current_value` - Current value. + * `default` - Default value. + * `description` - The description of parameter. + * `enum_value` - When the parameter is enum/string/bool, the optional value list.Note: This field may return null, indicating that no valid value can be obtained. + * `func` - Function.Note: This field may return null, indicating that no valid value can be obtained. + * `is_func` - Is it a function.Note: This field may return null, indicating that no valid value can be obtained. + * `is_global` - Is it a global parameter.Note: This field may return null, indicating that no valid value can be obtained. + * `match_type` - Matching type, multiVal, regex is used when the parameter type is string. + * `match_value` - Match the target value, when multiVal, each key is divided by `;`. + * `max` - The maximum value when the parameter type is float/integer. + * `min` - The minimum value when the parameter type is float/integer. + * `need_reboot` - Whether to reboot. + * `param_name` - The name of parameter. + * `param_type` - Parameter type: integer/float/string/enum/bool. + + diff --git a/config/docs/d/cynosdb_clusters.html.markdown b/config/docs/d/cynosdb_clusters.html.markdown new file mode 100644 index 0000000..8742a6a --- /dev/null +++ b/config/docs/d/cynosdb_clusters.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_clusters" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_clusters" +description: |- + Use this data source to query detailed information of Cynosdb clusters. +--- + +# tencentcloud_cynosdb_clusters + +Use this data source to query detailed information of Cynosdb clusters. + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_clusters" "foo" { + cluster_id = "cynosdbmysql-dzj5l8gz" + project_id = 0 + db_type = "MYSQL" + cluster_name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Optional, String) ID of the cluster to be queried. +* `cluster_name` - (Optional, String) Name of the cluster to be queried. +* `db_type` - (Optional, String) Type of CynosDB, and available values include `MYSQL`, `POSTGRESQL`. +* `project_id` - (Optional, Int) ID of the project to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cluster_list` - A list of clusters. Each element contains the following attributes: + * `auto_renew_flag` - Auto renew flag. Valid values are `0`(MANUAL_RENEW), `1`(AUTO_RENEW). Only works for PREPAID cluster. + * `available_zone` - The available zone of the CynosDB Cluster. + * `charge_type` - The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. Default value is `POSTPAID_BY_HOUR`. + * `cluster_id` - ID of CynosDB cluster. + * `cluster_limit` - Storage limit of CynosDB cluster instance, unit in GB. + * `cluster_name` - Name of CynosDB cluster. + * `cluster_status` - Status of the Cynosdb cluster. + * `create_time` - Creation time of the CynosDB cluster. + * `db_type` - Type of CynosDB, and available values include `MYSQL`. + * `db_version` - Version of CynosDB, which is related to `db_type`. For `MYSQL`, available value is `5.7`. + * `port` - Port of CynosDB cluster. + * `project_id` - ID of the project. + * `subnet_id` - ID of the subnet within this VPC. + * `vpc_id` - ID of the VPC. + + diff --git a/config/docs/d/cynosdb_describe_instance_error_logs.html.markdown b/config/docs/d/cynosdb_describe_instance_error_logs.html.markdown new file mode 100644 index 0000000..879d606 --- /dev/null +++ b/config/docs/d/cynosdb_describe_instance_error_logs.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_describe_instance_error_logs" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_describe_instance_error_logs" +description: |- + Use this data source to query detailed information of cynosdb describe_instance_error_logs +--- + +# tencentcloud_cynosdb_describe_instance_error_logs + +Use this data source to query detailed information of cynosdb describe_instance_error_logs + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_describe_instance_error_logs" "describe_instance_error_logs" { + instance_id = "cynosdbmysql-ins-afqx1hy0" + start_time = "2023-06-01 15:04:05" + end_time = "2023-06-19 15:04:05" + order_by = "Timestamp" + order_by_type = "DESC" + log_levels = ["note", "warning"] + key_words = ["Aborted"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance Id. +* `end_time` - (Optional, String) End time. +* `key_words` - (Optional, Set: [`String`]) Keywords, supports fuzzy search. +* `log_levels` - (Optional, Set: [`String`]) Log levels, including error, warning, and note, support simultaneous search of multiple levels. +* `order_by_type` - (Optional, String) Sort type, with ASC and DESC enumeration values. +* `order_by` - (Optional, String) Sort fields with Timestamp enumeration values. +* `result_output_file` - (Optional, String) Used to save results. +* `start_time` - (Optional, String) start time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `error_logs` - Error log list note: This field may return null, indicating that a valid value cannot be obtained. + * `content` - Note to log content: This field may return null, indicating that a valid value cannot be obtained. + * `level` - Log level note: This field may return null, indicating that a valid value cannot be obtained. + * `timestamp` - Log timestamp note: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/cynosdb_describe_instance_slow_queries.html.markdown b/config/docs/d/cynosdb_describe_instance_slow_queries.html.markdown new file mode 100644 index 0000000..9cba455 --- /dev/null +++ b/config/docs/d/cynosdb_describe_instance_slow_queries.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_describe_instance_slow_queries" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_describe_instance_slow_queries" +description: |- + Use this data source to query detailed information of cynosdb describe_instance_slow_queries +--- + +# tencentcloud_cynosdb_describe_instance_slow_queries + +Use this data source to query detailed information of cynosdb describe_instance_slow_queries + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_describe_instance_slow_queries" "describe_instance_slow_queries" { + cluster_id = "cynosdbmysql-bws8h88b" + start_time = "2023-06-01 12:00:00" + end_time = "2023-06-19 14:00:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `end_time` - (Optional, String) End time. +* `result_output_file` - (Optional, String) Used to save results. +* `start_time` - (Optional, String) start time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `binlogs` - Note to the Binlog list: This field may return null, indicating that a valid value cannot be obtained. + * `binlog_id` - Binlog file ID. + * `file_name` - Binlog file name. + * `file_size` - File size in bytes. + * `finish_time` - Latest transaction time. + * `start_time` - Earliest transaction time. + + diff --git a/config/docs/d/cynosdb_instance_slow_queries.html.markdown b/config/docs/d/cynosdb_instance_slow_queries.html.markdown new file mode 100644 index 0000000..bd6d5c5 --- /dev/null +++ b/config/docs/d/cynosdb_instance_slow_queries.html.markdown @@ -0,0 +1,99 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_instance_slow_queries" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_instance_slow_queries" +description: |- + Use this data source to query detailed information of cynosdb instance_slow_queries +--- + +# tencentcloud_cynosdb_instance_slow_queries + +Use this data source to query detailed information of cynosdb instance_slow_queries + +## Example Usage + +### Query slow queries of instance + +```hcl +variable "cynosdb_cluster_id" { + default = "default_cynosdb_cluster" +} + +data "tencentcloud_cynosdb_instance_slow_queries" "instance_slow_queries" { + instance_id = var.cynosdb_cluster_id + start_time = "2023-06-20 23:19:03" + end_time = "2023-06-30 23:19:03" + username = "keep_dts" + host = "%%" + database = "tf_ci_test" + order_by = "QueryTime" + order_by_type = "desc" +} +``` + +### Query slow queries by time range + +```hcl +variable "cynosdb_cluster_id" { + default = "default_cynosdb_cluster" +} + +data "tencentcloud_cynosdb_instance_slow_queries" "instance_slow_queries" { + instance_id = var.cynosdb_cluster_id + start_time = "2023-06-20 23:19:03" + end_time = "2023-06-30 23:19:03" + order_by = "QueryTime" + order_by_type = "desc" +} +``` + +### Query slow queries by user and db name + +```hcl +variable "cynosdb_cluster_id" { + default = "default_cynosdb_cluster" +} + +data "tencentcloud_cynosdb_instance_slow_queries" "instance_slow_queries" { + instance_id = var.cynosdb_cluster_id + username = "keep_dts" + host = "%%" + database = "tf_ci_test" + order_by = "QueryTime" + order_by_type = "desc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `database` - (Optional, String) Database name. +* `end_time` - (Optional, String) Latest transaction start time. +* `host` - (Optional, String) Client host. +* `order_by_type` - (Optional, String) Sort type, optional values: asc, desc. +* `order_by` - (Optional, String) Sort field, optional values: QueryTime, LockTime, RowsExamined, RowsSent. +* `result_output_file` - (Optional, String) Used to save results. +* `start_time` - (Optional, String) Earliest transaction start time. +* `username` - (Optional, String) user name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `slow_queries` - Slow query records. + * `database` - Database name. + * `lock_time` - Lock duration in seconds. + * `query_time` - Execution time in seconds. + * `rows_examined` - Scan Rows. + * `rows_sent` - Return the number of rows. + * `sql_md5` - SQL statement md5. + * `sql_template` - SQL template. + * `sql_text` - SQL statement. + * `timestamp` - Execution timestamp. + * `user_host` - Client host. + * `user_name` - user name. + + diff --git a/config/docs/d/cynosdb_instances.html.markdown b/config/docs/d/cynosdb_instances.html.markdown new file mode 100644 index 0000000..678d78d --- /dev/null +++ b/config/docs/d/cynosdb_instances.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_instances" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_instances" +description: |- + Use this data source to query detailed information of Cynosdb instances. +--- + +# tencentcloud_cynosdb_instances + +Use this data source to query detailed information of Cynosdb instances. + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_instances" "foo" { + instance_id = "cynosdbmysql-ins-0wln9u6w" + project_id = 0 + db_type = "MYSQL" + instance_name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Optional, String) ID of the cluster. +* `db_type` - (Optional, String) Type of CynosDB, and available values include `MYSQL`, `POSTGRESQL`. +* `instance_id` - (Optional, String) ID of the Cynosdb instance to be queried. +* `instance_name` - (Optional, String) Name of the Cynosdb instance to be queried. +* `project_id` - (Optional, Int) ID of the project to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - A list of instances. Each element contains the following attributes: + * `create_time` - Creation time of the CynosDB instance. + * `instance_name` - Name of CynosDB instance. + * `instance_status` - Status of the Cynosdb instance. + * `instance_storage_size` - Storage size of the Cynosdb instance, unit in GB. + * `instance_type` - Instance type. `ro` for readonly instance, `rw` for read and write instance. + + diff --git a/config/docs/d/cynosdb_param_templates.html.markdown b/config/docs/d/cynosdb_param_templates.html.markdown new file mode 100644 index 0000000..ad3d103 --- /dev/null +++ b/config/docs/d/cynosdb_param_templates.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_param_templates" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_param_templates" +description: |- + Use this data source to query detailed information of cynosdb param_templates +--- + +# tencentcloud_cynosdb_param_templates + +Use this data source to query detailed information of cynosdb param_templates + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_param_templates" "param_templates" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_modes` - (Optional, Set: [`String`]) Database mode, optional values: NORMAL, SERVERLESS. +* `engine_types` - (Optional, Set: [`String`]) Engine types. +* `engine_versions` - (Optional, Set: [`String`]) Database engine version number. +* `limit` - (Optional, Int) Query limit. +* `offset` - (Optional, Int) Page offset. +* `order_by` - (Optional, String) The sort field for the returned results. +* `order_direction` - (Optional, String) Sort by (asc, desc). +* `products` - (Optional, Set: [`String`]) The product type corresponding to the query template. +* `result_output_file` - (Optional, String) Used to save results. +* `template_ids` - (Optional, Set: [`Int`]) The id list of templates. +* `template_names` - (Optional, Set: [`String`]) The name list of templates. +* `template_types` - (Optional, Set: [`String`]) Template types. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Parameter Template Information. + * `db_mode` - Database mode, optional values: NORMAL, SERVERLESS. + * `engine_version` - Engine version. + * `id` - The ID of template. + * `param_info_set` - Parameter template details.Note: This field may return null, indicating that no valid value can be obtained. + * `current_value` - Current value. + * `default` - Default value. + * `description` - The description of parameter. + * `enum_value` - An optional set of value types when the parameter type is enum.Note: This field may return null, indicating that no valid value can be obtained. + * `max` - The maximum value when the parameter type is float/integer.Note: This field may return null, indicating that no valid value can be obtained. + * `min` - The minimum value when the parameter type is float/integer.Note: This field may return null, indicating that no valid value can be obtained. + * `need_reboot` - Whether to reboot. + * `param_name` - The name of parameter. + * `param_type` - Parameter type: integer/float/string/enum. + * `template_description` - The description of template. + * `template_name` - The name of template. + + diff --git a/config/docs/d/cynosdb_project_security_groups.html.markdown b/config/docs/d/cynosdb_project_security_groups.html.markdown new file mode 100644 index 0000000..ad3d954 --- /dev/null +++ b/config/docs/d/cynosdb_project_security_groups.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_project_security_groups" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_project_security_groups" +description: |- + Use this data source to query detailed information of cynosdb project_security_groups +--- + +# tencentcloud_cynosdb_project_security_groups + +Use this data source to query detailed information of cynosdb project_security_groups + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_project_security_groups" "project_security_groups" { + project_id = 1250480 + search_key = "自定义模版" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Optional, Int) Project ID. +* `result_output_file` - (Optional, String) Used to save results. +* `search_key` - (Optional, String) Search Keywords. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `groups` - Security Group Details. + * `create_time` - Creation time, time format: yyyy mm dd hh: mm: ss. + * `inbound` - Inbound Rules. + * `action` - Action. + * `address_module` - AddressModule. + * `cidr_ip` - CidrIp. + * `desc` - Description. + * `id` - id. + * `ip_protocol` - Ip protocol. + * `port_range` - PortRange. + * `service_module` - Service Module. + * `outbound` - Outbound rules. + * `action` - Action. + * `address_module` - Address module. + * `cidr_ip` - Cidr Ip. + * `desc` - Description. + * `id` - id. + * `ip_protocol` - Ip protocol. + * `port_range` - Port range. + * `service_module` - Service module. + * `project_id` - Project ID. + * `security_group_id` - Security Group ID. + * `security_group_name` - Security Group Name. + * `security_group_remark` - Security Group Notes. + + diff --git a/config/docs/d/cynosdb_proxy_node.html.markdown b/config/docs/d/cynosdb_proxy_node.html.markdown new file mode 100644 index 0000000..38e63a8 --- /dev/null +++ b/config/docs/d/cynosdb_proxy_node.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_proxy_node" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_proxy_node" +description: |- + Use this data source to query detailed information of cynosdb proxy_node +--- + +# tencentcloud_cynosdb_proxy_node + +Use this data source to query detailed information of cynosdb proxy_node + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_proxy_node" "proxy_node" { + order_by = "CREATETIME" + order_by_type = "DESC" + filters { + names = "ClusterId" + values = "cynosdbmysql-cgd2gpwr" + exact_match = false + name = "ClusterId" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Search criteria, if there are multiple filters, the relationship between the filters is a logical AND relationship. +* `order_by_type` - (Optional, String) Sort type, value range:ASC: ascending sort; DESC: descending sort. +* `order_by` - (Optional, String) Sort field, value range:CREATETIME: creation time; PRIODENDTIME: expiration time. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `names` - (Required, Set) Search String. +* `values` - (Required, Set) Search String. +* `exact_match` - (Optional, Bool) Exact match or not. +* `name` - (Optional, String) Search Fields. Supported: Status, ProxyNodeId, ClusterId. +* `operator` - (Optional, String) Operator. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `proxy_node_infos` - Database Agent Node List. + * `app_id` - User AppID. + * `cluster_id` - Cluster ID. + * `cpu` - Database Agent Node CPU. + * `mem` - Database Agent Node Memory. + * `proxy_group_id` - Database Agent Group ID. + * `proxy_node_connections` - The current number of connections of the node. The DescribeProxyNodes interface does not return a value for this field. + * `proxy_node_id` - Database Agent Node ID. + * `region` - region. + * `status` - Database Agent Node Status. + * `zone` - Availability Zone. + + diff --git a/config/docs/d/cynosdb_proxy_version.html.markdown b/config/docs/d/cynosdb_proxy_version.html.markdown new file mode 100644 index 0000000..e7bbb38 --- /dev/null +++ b/config/docs/d/cynosdb_proxy_version.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_proxy_version" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_proxy_version" +description: |- + Use this data source to query detailed information of cynosdb proxy_version +--- + +# tencentcloud_cynosdb_proxy_version + +Use this data source to query detailed information of cynosdb proxy_version + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_proxy_version" "proxy_version" { + cluster_id = "cynosdbmysql-bws8h88b" + proxy_group_id = "cynosdbmysql-proxy-l6zf9t30" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `proxy_group_id` - (Optional, String) Database Agent Group ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `current_proxy_version` - Current proxy version number note: This field may return null, indicating that a valid value cannot be obtained. +* `support_proxy_versions` - Supported Database Agent Version Collection Note: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/cynosdb_resource_package_list.html.markdown b/config/docs/d/cynosdb_resource_package_list.html.markdown new file mode 100644 index 0000000..8607cc2 --- /dev/null +++ b/config/docs/d/cynosdb_resource_package_list.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_resource_package_list" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_resource_package_list" +description: |- + Use this data source to query detailed information of cynosdb resource_package_list +--- + +# tencentcloud_cynosdb_resource_package_list + +Use this data source to query detailed information of cynosdb resource_package_list + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_resource_package_list" "resource_package_list" { + package_id = ["package-hy4d2ppl"] + package_name = ["keep-package-disk"] + package_type = ["DISK"] + package_region = ["china"] + status = ["using"] + order_by = ["startTime"] + order_direction = "DESC" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `order_by` - (Optional, Set: [`String`]) Sorting conditions supported: startTime - effective time, expireTime - expiration time, packageUsedSpec - usage capacity, and packageTotalSpec - total storage capacity. Arrange in array order;. +* `order_direction` - (Optional, String) Sort by, DESC Descending, ASC Ascending. +* `package_id` - (Optional, Set: [`String`]) Resource Package Unique ID. +* `package_name` - (Optional, Set: [`String`]) Resource Package Name. +* `package_region` - (Optional, Set: [`String`]) Resource package usage region China - common in mainland China, overseas - common in Hong Kong, Macao, Taiwan, and overseas. +* `package_type` - (Optional, Set: [`String`]) Resource package type CCU - Compute resource package, DISK - Storage resource package. +* `result_output_file` - (Optional, String) Used to save results. +* `status` - (Optional, Set: [`String`]) Resource package status creating - creating; Using - In use; Expired - has expired; Normal_ Finish - used up; Apply_ Refund - Applying for a refund; Refund - The fee has been refunded. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `resource_package_list` - Resource package details note: This field may return null, indicating that a valid value cannot be obtained. + * `app_id` - AppID note: This field may return null, indicating that a valid value cannot be obtained. + * `bind_instance_infos` - Note for binding instance information: This field may return null, indicating that a valid value cannot be obtained. + * `instance_id` - Instance ID. + * `instance_region` - Region of instance. + * `instance_type` - Instance type. + * `expire_time` - Expiration time: August 1st, 2022 00:00:00 Attention: This field may return null, indicating that a valid value cannot be obtained. + * `has_quota` - Resource package usage note: This field may return null, indicating that a valid value cannot be obtained. + * `package_id` - Resource Package Unique ID Note: This field may return null, indicating that a valid value cannot be obtained. + * `package_name` - Resource package name note: This field may return null, indicating that a valid value cannot be obtained. + * `package_region` - The resource package is used in China, which is commonly used in mainland China, and in overseas, which is commonly used in Hong Kong, Macao, Taiwan, and overseas. Note: This field may return null, indicating that a valid value cannot be obtained. + * `package_total_spec` - Attention to the total amount of resource packages: This field may return null, indicating that a valid value cannot be obtained. + * `package_type` - Resource package type CCU - Compute resource package, DISK - Store resource package Note: This field may return null, indicating that a valid value cannot be obtained. + * `package_used_spec` - Resource package usage note: This field may return null, indicating that a valid value cannot be obtained. + * `start_time` - Effective time: July 1st, 2022 00:00:00 Attention: This field may return null, indicating that a valid value cannot be obtained. + * `status` - Resource package status creating - creating; Using - In use; Expired - has expired; Normal_ Finish - used up; Apply_ Refund - Applying for a refund; Refund - The fee has been refunded. Note: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/cynosdb_resource_package_sale_specs.html.markdown b/config/docs/d/cynosdb_resource_package_sale_specs.html.markdown new file mode 100644 index 0000000..df7d2cc --- /dev/null +++ b/config/docs/d/cynosdb_resource_package_sale_specs.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_resource_package_sale_specs" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_resource_package_sale_specs" +description: |- + Use this data source to query detailed information of cynosdb resource_package_sale_specs +--- + +# tencentcloud_cynosdb_resource_package_sale_specs + +Use this data source to query detailed information of cynosdb resource_package_sale_specs + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_resource_package_sale_specs" "resource_package_sale_specs" { + instance_type = "cynosdb-serverless" + package_region = "china" + package_type = "CCU" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_type` - (Required, String) Instance Type. Value range: cynosdb-serverless, cynosdb, cdb. +* `package_region` - (Required, String) Resource package usage region China - common in mainland China, overseas - common in Hong Kong, Macao, Taiwan, and overseas. +* `package_type` - (Required, String) Resource package type CCU - Computing resource package DISK - Storage resource package. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `detail` - Resource package details note: This field may return null, indicating that a valid value cannot be obtained. + * `expire_day` - Resource package validity period, in days. Note: This field may return null, indicating that a valid value cannot be obtained. + * `max_package_spec` - The maximum number of resources in the current version of the resource package, calculated in units of resources; Storage resource: GB Note: This field may return null, indicating that a valid value cannot be obtained. + * `min_package_spec` - The minimum number of resources in the current version of the resource package, calculated in units of resources; Storage resource: GB Note: This field may return null, indicating that a valid value cannot be obtained. + * `package_region` - Note: This field may return null, indicating that a valid value cannot be obtained. + * `package_type` - Resource package type CCU - Compute resource package DISK - Store resource package Note: This field may return null, indicating that a valid value cannot be obtained. + * `package_version` - Resource package version base basic version, common general version, enterprise enterprise version Note: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/cynosdb_rollback_time_range.html.markdown b/config/docs/d/cynosdb_rollback_time_range.html.markdown new file mode 100644 index 0000000..907b8fb --- /dev/null +++ b/config/docs/d/cynosdb_rollback_time_range.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_rollback_time_range" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_rollback_time_range" +description: |- + Use this data source to query detailed information of cynosdb rollback_time_range +--- + +# tencentcloud_cynosdb_rollback_time_range + +Use this data source to query detailed information of cynosdb rollback_time_range + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_rollback_time_range" "rollback_time_range" { + cluster_id = "cynosdbmysql-bws8h88b" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `rollback_time_ranges` - Reversible time range. + * `time_range_end` - End time. + * `time_range_start` - start time. +* `time_range_end` - Effective regression time range end time point (obsolete) Note: This field may return null, indicating that a valid value cannot be obtained. +* `time_range_start` - Effective regression time range start time point (obsolete) Note: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/cynosdb_zone.html.markdown b/config/docs/d/cynosdb_zone.html.markdown new file mode 100644 index 0000000..ed996fc --- /dev/null +++ b/config/docs/d/cynosdb_zone.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_zone" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_zone" +description: |- + Use this data source to query detailed information of cynosdb zone +--- + +# tencentcloud_cynosdb_zone + +Use this data source to query detailed information of cynosdb zone + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_zone" "zone" { + include_virtual_zones = true + show_permission = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `include_virtual_zones` - (Optional, Bool) Is virtual zone included. +* `result_output_file` - (Optional, String) Used to save results. +* `show_permission` - (Optional, Bool) Whether to display all available zones under the region and display the permissions of each available zone of the user. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `region_set` - Information of region. + * `db_type` - Database type. + * `modules` - Regional module support. + * `is_disable` - Is zone on sale, optional values: yes, no. + * `module_name` - Module name. + * `region_id` - Region ID. + * `region_zh` - Region name in Chinese. + * `region` - Region in English. + * `zone_set` - List of available zones for sale. + * `has_permission` - Whether the user have zone permissionsNote: This field may return null, indicating that no valid value can be obtained. + * `is_support_normal` - Does it support normal clusters, 0:Not supported 1:Support. + * `is_support_serverless` - Does it support serverless clusters, 0:Not supported 1:Support. + * `is_whole_rdma_zone` - Is zone Rdma. + * `physical_zone` - Physical zone. + * `zone_id` - ZoneId. + * `zone_zh` - Zone name in Chinesee. + * `zone` - Zone name in English. + + diff --git a/config/docs/d/cynosdb_zone_config.html.markdown b/config/docs/d/cynosdb_zone_config.html.markdown new file mode 100644 index 0000000..c9a822e --- /dev/null +++ b/config/docs/d/cynosdb_zone_config.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_zone_config" +sidebar_current: "docs-tencentcloud-datasource-cynosdb_zone_config" +description: |- + Use this data source to query which instance types of Redis are available in a specific region. +--- + +# tencentcloud_cynosdb_zone_config + +Use this data source to query which instance types of Redis are available in a specific region. + +## Example Usage + +```hcl +data "tencentcloud_cynosdb_zone_config" "foo" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of zone. Each element contains the following attributes: + * `cpu` - Instance CPU, unit: core. + * `machine_type` - Machine type. + * `max_io_bandwidth` - Max io bandwidth. + * `max_storage_size` - The maximum available storage for the instance, unit GB. + * `memory` - Instance memory, unit: GB. + * `min_storage_size` - Minimum available storage of the instance, unit: GB. + * `zone_stock_infos` - Regional inventory information. + * `has_stock` - Has stock. + * `zone` - Availability zone. + + diff --git a/config/docs/d/dayu_cc_http_policies.html.markdown b/config/docs/d/dayu_cc_http_policies.html.markdown new file mode 100644 index 0000000..12fe1f1 --- /dev/null +++ b/config/docs/d/dayu_cc_http_policies.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_cc_http_policies" +sidebar_current: "docs-tencentcloud-datasource-dayu_cc_http_policies" +description: |- + Use this data source to query dayu CC http policies +--- + +# tencentcloud_dayu_cc_http_policies + +Use this data source to query dayu CC http policies + +## Example Usage + +```hcl +data "tencentcloud_dayu_cc_http_policies" "id_test" { + resource_type = tencentcloud_dayu_cc_http_policy.test_policy.resource_type + resource_id = tencentcloud_dayu_cc_http_policy.test_policy.resource_id + policy_id = tencentcloud_dayu_cc_http_policy.test_policy.policy_id +} +data "tencentcloud_dayu_cc_http_policies" "name_test" { + resource_type = tencentcloud_dayu_cc_http_policy.test_policy.resource_type + resource_id = tencentcloud_dayu_cc_http_policy.test_policy.resource_id + name = tencentcloud_dayu_cc_http_policy.test_policy.name +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_id` - (Required, String) ID of the resource that the CC http policy works for. +* `resource_type` - (Required, String) Type of the resource that the CC http policy works for, valid values are `bgpip`, `bgp`, `bgp-multip` and `net`. +* `name` - (Optional, String) Name of the CC http policy to be queried. +* `policy_id` - (Optional, String) Id of the CC http policy to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of CC http policies. Each element contains the following attributes: + * `action` - Action mode. + * `create_time` - Create time of the CC self-define http policy. + * `frequency` - Max frequency per minute. + * `ip_list` - IP of the CC self-define http policy. + * `name` - Name of the CC self-define http policy. + * `policy_id` - ID of the CC self-define http policy. + * `resource_id` - ID of the resource that the CC self-define http policy works for. + * `resource_type` - Type of the resource that the CC self-define http policy works for. + * `smode` - Match mode. + * `switch` - Indicate the CC self-define http policy takes effect or not. + + diff --git a/config/docs/d/dayu_cc_https_policies.html.markdown b/config/docs/d/dayu_cc_https_policies.html.markdown new file mode 100644 index 0000000..185a975 --- /dev/null +++ b/config/docs/d/dayu_cc_https_policies.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_cc_https_policies" +sidebar_current: "docs-tencentcloud-datasource-dayu_cc_https_policies" +description: |- + Use this data source to query dayu CC https policies +--- + +# tencentcloud_dayu_cc_https_policies + +Use this data source to query dayu CC https policies + +## Example Usage + +```hcl +data "tencentcloud_dayu_cc_https_policies" "name_test" { + resource_type = tencentcloud_dayu_cc_https_policy.test_policy.resource_type + resource_id = tencentcloud_dayu_cc_https_policy.test_policy.resource_id + name = tencentcloud_dayu_cc_https_policy.test_policy.name +} +data "tencentcloud_dayu_cc_https_policies" "id_test" { + resource_type = tencentcloud_dayu_cc_https_policy.test_policy.resource_type + resource_id = tencentcloud_dayu_cc_https_policy.test_policy.resource_id + policy_id = tencentcloud_dayu_cc_https_policy.test_policy.policy_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_id` - (Required, String) Id of the resource that the CC https policy works for. +* `resource_type` - (Required, String) Type of the resource that the CC https policy works for, valid value is `bgpip`. +* `name` - (Optional, String) Name of the CC https policy to be queried. +* `policy_id` - (Optional, String) Id of the CC https policy to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of CC https policies. Each element contains the following attributes: + * `action` - Action mode. + * `create_time` - Create time of the CC self-define https policy. + * `domain` - Domain that the CC self-define https policy works for. + * `ip_list` - Ip of the CC self-define https policy. + * `name` - Name of the CC self-define https policy. + * `policy_id` - Id of the CC self-define https policy. + * `resource_id` - ID of the resource that the CC self-define https policy works for. + * `resource_type` - Type of the resource that the CC self-define https policy works for. + * `rule_id` - Rule id of the domain that the CC self-define https policy works for. + * `switch` - Indicate the CC self-define https policy takes effect or not. + + diff --git a/config/docs/d/dayu_ddos_policies.html.markdown b/config/docs/d/dayu_ddos_policies.html.markdown new file mode 100644 index 0000000..89869e7 --- /dev/null +++ b/config/docs/d/dayu_ddos_policies.html.markdown @@ -0,0 +1,91 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_ddos_policies" +sidebar_current: "docs-tencentcloud-datasource-dayu_ddos_policies" +description: |- + Use this data source to query dayu DDoS policies +--- + +# tencentcloud_dayu_ddos_policies + +Use this data source to query dayu DDoS policies + +## Example Usage + +```hcl +data "tencentcloud_dayu_ddos_policies" "id_test" { + resource_type = tencentcloud_dayu_ddos_policy.test_policy.resource_type + policy_id = tencentcloud_dayu_ddos_policy.test_policy.policy_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_type` - (Required, String) Type of the resource that the DDoS policy works for, valid values are `bgpip`, `bgp`, `bgp-multip` and `net`. +* `policy_id` - (Optional, String) ID of the DDoS policy to be query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of DDoS policies. Each element contains the following attributes: + * `create_time` - Create time of the DDoS policy. + * `drop_options` - Option list of abnormal check of the DDoS policy. + * `bad_conn_threshold` - The number of new connections based on destination IP that trigger suppression of connections. + * `check_sync_conn` - Indicate whether to check null connection or not. + * `conn_timeout` - Connection timeout of abnormal connection check. + * `d_conn_limit` - The limit of concurrent connections based on destination IP. + * `d_new_limit` - The limit of new connections based on destination IP. + * `drop_icmp` - Indicate whether to drop ICMP protocol or not. + * `drop_other` - Indicate whether to drop other protocols(exclude TCP/UDP/ICMP) or not. + * `drop_tcp` - Indicate whether to drop TCP protocol or not. + * `drop_udp` - Indicate to drop UDP protocol or not. + * `icmp_mbps_limit` - The limit of ICMP traffic rate. + * `null_conn_enable` - Indicate to enable null connection or not. + * `other_mbps_limit` - The limit of other protocols(exclude TCP/UDP/ICMP) traffic rate. + * `s_conn_limit` - The limit of concurrent connections based on source IP. + * `s_new_limit` - The limit of new connections based on source IP. + * `syn_limit` - The limit of syn of abnormal connection check. + * `syn_rate` - The percentage of syn in ack of abnormal connection check. + * `tcp_mbps_limit` - The limit of TCP traffic. + * `udp_mbps_limit` - The limit of UDP traffic rate. + * `name` - Name of the DDoS policy. + * `packet_filters` - Message filter options list. + * `action` - Action of port to take. + * `d_end_port` - End port of the destination. + * `d_start_port` - Start port of the destination. + * `depth` - The depth of match. + * `is_include` - Indicate whether to include the key word/regular expression or not. + * `match_begin` - Indicate whether to check load or not. + * `match_str` - The key word or regular expression. + * `match_type` - Match type. + * `offset` - The offset of match. + * `pkt_length_max` - The max length of the packet. + * `pkt_length_min` - The minimum length of the packet. + * `protocol` - Protocol. + * `s_end_port` - End port of the source. + * `s_start_port` - Start port of the source. + * `policy_id` - Id of policy. + * `port_filters` - Port limits of abnormal check of the DDoS policy. + * `action` - Action of port to take. + * `end_port` - End port. + * `kind` - The type of forbidden port, and valid values are 0, 1, 2. 0 for destination port, 1 for source port and 2 for both destination and source posts. + * `protocol` - Protocol. + * `start_port` - Start port. + * `scene_id` - Id of policy case that the DDoS policy works for. + * `watermark_filters` - Watermark policy options, and only support one watermark policy at most. + * `auto_remove` - Indicate whether to auto-remove the watermark or not. + * `offset` - The offset of watermark. + * `open_switch` - Indicate whether to open watermark or not. + * `tcp_port_list` - Port range of TCP. + * `udp_port_list` - Port range of TCP. + * `watermark_key` - Watermark content. + * `content` - Content of the watermark. + * `id` - Id of the watermark. + * `open_switch` - Indicate whether to auto-remove the watermark or not. + + diff --git a/config/docs/d/dayu_ddos_policy_attachments.html.markdown b/config/docs/d/dayu_ddos_policy_attachments.html.markdown new file mode 100644 index 0000000..7c61ef2 --- /dev/null +++ b/config/docs/d/dayu_ddos_policy_attachments.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_ddos_policy_attachments" +sidebar_current: "docs-tencentcloud-datasource-dayu_ddos_policy_attachments" +description: |- + Use this data source to query detailed information of dayu DDoS policy attachments +--- + +# tencentcloud_dayu_ddos_policy_attachments + +Use this data source to query detailed information of dayu DDoS policy attachments + +## Example Usage + +```hcl +data "tencentcloud_dayu_ddos_policy_attachments" "foo_type" { + resource_type = tencentcloud_dayu_ddos_policy_attachment.dayu_ddos_policy_attachment.resource_type +} +data "tencentcloud_dayu_ddos_policy_attachments" "foo_resource" { + resource_id = tencentcloud_dayu_ddos_policy_attachment.dayu_ddos_policy_attachment.resource_id + resource_type = tencentcloud_dayu_ddos_policy_attachment.dayu_ddos_policy_attachment.resource_type +} +data "tencentcloud_dayu_ddos_policy_attachments" "foo_policy" { + resource_type = tencentcloud_dayu_ddos_policy_attachment.dayu_ddos_policy_attachment.resource_type + policy_id = tencentcloud_dayu_ddos_policy_attachment.dayu_ddos_policy_attachment.policy_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_type` - (Required, String) Type of the resource that the DDoS policy works for, valid values are `bgpip`, `bgp`, `bgp-multip` and `net`. +* `policy_id` - (Optional, String) Id of the policy to be queried. +* `resource_id` - (Optional, String) ID of the attached resource to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `dayu_ddos_policy_attachment_list` - A list of dayu DDoS policy attachments. Each element contains the following attributes: + * `policy_id` - ID of the policy. + * `resource_id` - ID of the attached resource. + * `resource_type` - Type of the resource that the DDoS policy works for. + + diff --git a/config/docs/d/dayu_ddos_policy_cases.html.markdown b/config/docs/d/dayu_ddos_policy_cases.html.markdown new file mode 100644 index 0000000..43736c5 --- /dev/null +++ b/config/docs/d/dayu_ddos_policy_cases.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_ddos_policy_cases" +sidebar_current: "docs-tencentcloud-datasource-dayu_ddos_policy_cases" +description: |- + Use this data source to query dayu DDoS policy cases +--- + +# tencentcloud_dayu_ddos_policy_cases + +Use this data source to query dayu DDoS policy cases + +## Example Usage + +```hcl +data "tencentcloud_dayu_ddos_policy_cases" "id_test" { + resource_type = tencentcloud_dayu_ddos_policy_case.test_policy_case.resource_type + scene_id = tencentcloud_dayu_ddos_policy_case.test_policy_case.scene_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_type` - (Required, String) Type of the resource that the DDoS policy case works for, valid values are `bgpip`, `bgp`, `bgp-multip` and `net`. +* `scene_id` - (Required, String) ID of the DDoS policy case to be query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of DDoS policy cases. Each element contains the following attributes: + * `app_protocols` - App protocol set of the DDoS policy case. + * `app_type` - App type of the DDoS policy case. + * `create_time` - Create time of the DDoS policy case. + * `has_abroad` - Indicate whether the service involves overseas or not. + * `has_initiate_tcp` - Indicate whether the service actively initiates TCP requests or not. + * `has_initiate_udp` - Indicate whether the actively initiate UDP requests or not. + * `has_vpn` - Indicate whether the service involves VPN service or not. + * `max_tcp_package_len` - The max length of TCP message package. + * `max_udp_package_len` - The max length of UDP message package. + * `min_tcp_package_len` - The minimum length of TCP message package. + * `min_udp_package_len` - The minimum length of UDP message package. + * `name` - Name of the DDoS policy case. + * `peer_tcp_port` - The port that actively initiates TCP requests. + * `peer_udp_port` - The port that actively initiates UDP requests. + * `platform_types` - Platform set of the DDoS policy case. + * `resource_type` - Type of the resource that the DDoS policy case works for. + * `scene_id` - ID of the DDoS policy case. + * `tcp_end_port` - End port of the TCP service. + * `tcp_footprint` - The fixed signature of TCP protocol load. + * `tcp_start_port` - Start port of the TCP service. + * `udp_end_port` - End port of the UDP service. + * `udp_footprint` - The fixed signature of TCP protocol load. + * `udp_start_port` - Start port of the UDP service. + * `web_api_urls` - Web API url set. + + diff --git a/config/docs/d/dayu_eip.html.markdown b/config/docs/d/dayu_eip.html.markdown new file mode 100644 index 0000000..5c4ef37 --- /dev/null +++ b/config/docs/d/dayu_eip.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_eip" +sidebar_current: "docs-tencentcloud-datasource-dayu_eip" +description: |- + Use this data source to query dayu eip rules +--- + +# tencentcloud_dayu_eip + +Use this data source to query dayu eip rules + +## Example Usage + +```hcl +data "tencentcloud_dayu_eip" "test" { + resource_id = "bgpip-000004xg" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_id` - (Required, String) Id of the resource. +* `bind_status` - (Optional, List: [`String`]) The binding state of the instance, value range [BINDING, BIND, UNBINDING, UNBIND], default is [BINDING, BIND, UNBINDING, UNBIND]. +* `limit` - (Optional, Int) The number of pages, default is `10`. +* `offset` - (Optional, Int) The page start offset, default is `0`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of layer 4 rules. Each element contains the following attributes: + + diff --git a/config/docs/d/dayu_l4_rules.html.markdown b/config/docs/d/dayu_l4_rules.html.markdown new file mode 100644 index 0000000..e14d5a8 --- /dev/null +++ b/config/docs/d/dayu_l4_rules.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_l4_rules" +sidebar_current: "docs-tencentcloud-datasource-dayu_l4_rules" +description: |- + Use this data source to query dayu layer 4 rules +--- + +# tencentcloud_dayu_l4_rules + +Use this data source to query dayu layer 4 rules + +## Example Usage + +```hcl +data "tencentcloud_dayu_l4_rules" "name_test" { + resource_type = tencentcloud_dayu_l4_rule.test_rule.resource_type + resource_id = tencentcloud_dayu_l4_rule.test_rule.resource_id + name = tencentcloud_dayu_l4_rule.test_rule.name +} +data "tencentcloud_dayu_l4_rules" "id_test" { + resource_type = tencentcloud_dayu_l4_rule.test_rule.resource_type + resource_id = tencentcloud_dayu_l4_rule.test_rule.resource_id + rule_id = tencentcloud_dayu_l4_rule.test_rule.rule_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_id` - (Required, String) Id of the resource that the layer 4 rule works for. +* `resource_type` - (Required, String) Type of the resource that the layer 4 rule works for, valid values are `bgpip`, `bgp`, `bgp-multip` and `net`. +* `name` - (Optional, String) Name of the layer 4 rule to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `rule_id` - (Optional, String) Id of the layer 4 rule to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of layer 4 rules. Each element contains the following attributes: + * `d_port` - The destination port of the layer 4 rule. + * `health_check_health_num` - Health threshold of health check. + * `health_check_interval` - Interval time of health check. + * `health_check_switch` - Indicates whether health check is enabled. + * `health_check_timeout` - HTTP Status Code. `1` means the return value `1xx` is health. `2` means the return value `2xx` is health. `4` means the return value `3xx` is health. `8` means the return value `4xx` is health. `16` means the return value `5xx` is health. If you want multiple return codes to indicate health, need to add the corresponding values. + * `health_check_unhealth_num` - Unhealthy threshold of health check. + * `lb_type` - LB type of the rule, `1` for weight cycling and `2` for IP hash. + * `name` - Name of the rule. + * `protocol` - Protocol of the rule. + * `rule_id` - ID of the 4 layer rule. + * `s_port` - The source port of the layer 4 rule. + * `session_switch` - Indicate that the session will keep or not. + * `session_time` - Session keep time, only valid when `session_switch` is true, the available value ranges from 1 to 300 and unit is second. + * `source_type` - Source type, `1` for source of host, `2` for source of IP. + + diff --git a/config/docs/d/dayu_l4_rules_v2.html.markdown b/config/docs/d/dayu_l4_rules_v2.html.markdown new file mode 100644 index 0000000..5d4f1c7 --- /dev/null +++ b/config/docs/d/dayu_l4_rules_v2.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_l4_rules_v2" +sidebar_current: "docs-tencentcloud-datasource-dayu_l4_rules_v2" +description: |- + Use this data source to query dayu new layer 4 rules +--- + +# tencentcloud_dayu_l4_rules_v2 + +Use this data source to query dayu new layer 4 rules + +## Example Usage + +```hcl +data "tencentcloud_dayu_l4_rules_v2" "tencentcloud_dayu_l4_rules_v2" { + business = "bgpip" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `business` - (Required, String) Type of the resource that the layer 4 rule works for, valid values are `bgpip`, `bgp`, `bgp-multip` and `net`. +* `ip` - (Optional, String) Ip of the resource. +* `result_output_file` - (Optional, String) Used to save results. +* `virtual_port` - (Optional, Int) Virtual port of resource. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of layer 4 rules. Each element contains the following attributes: + * `id` - Bind the resource ID information. + * `ip` - Bind the resource IP information. + * `keep_enable` - session hold switch. + * `keeptime` - The keeptime of the layer 4 rule. + * `lb_type` - LB type of the rule, `1` for weight cycling and `2` for IP hash. + * `modify_time` - Rule modification time. + * `protocol` - Protocol of the rule. + * `region` - Corresponding regional information. + * `remove_switch` - Remove the watermark state. + * `rule_id` - ID of the 4 layer rule. + * `rule_name` - Name of the rule. + * `source_port` - The source port of the layer 4 rule. + * `source_type` - Source type, `1` for source of host, `2` for source of IP. + * `virtual_port` - The virtual port of the layer 4 rule. + + diff --git a/config/docs/d/dayu_l7_rules.html.markdown b/config/docs/d/dayu_l7_rules.html.markdown new file mode 100644 index 0000000..27261c7 --- /dev/null +++ b/config/docs/d/dayu_l7_rules.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_l7_rules" +sidebar_current: "docs-tencentcloud-datasource-dayu_l7_rules" +description: |- + Use this data source to query dayu layer 7 rules +--- + +# tencentcloud_dayu_l7_rules + +Use this data source to query dayu layer 7 rules + +## Example Usage + +```hcl +data "tencentcloud_dayu_l7_rules" "domain_test" { + resource_type = tencentcloud_dayu_l7_rule.test_rule.resource_type + resource_id = tencentcloud_dayu_l7_rule.test_rule.resource_id + domain = tencentcloud_dayu_l7_rule.test_rule.domain +} +data "tencentcloud_dayu_l7_rules" "id_test" { + resource_type = tencentcloud_dayu_l7_rule.test_rule.resource_type + resource_id = tencentcloud_dayu_l7_rule.test_rule.resource_id + rule_id = tencentcloud_dayu_l7_rule.test_rule.rule_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_id` - (Required, String) Id of the resource that the layer 7 rule works for. +* `resource_type` - (Required, String) Type of the resource that the layer 7 rule works for, valid value is `bgpip`. +* `domain` - (Optional, String) Domain of the layer 7 rule to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `rule_id` - (Optional, String) Id of the layer 7 rule to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of layer 7 rules. Each element contains the following attributes: + * `domain` - Domain that the 7 layer rule works for. + * `health_check_code` - HTTP Status Code. `1` means the return value `1xx` is health. `2` means the return value `2xx` is health. `4` means the return value `3xx` is health. `8` means the return value `4xx` is health. `16` means the return value `5xx` is health. If you want multiple return codes to indicate health, need to add the corresponding values. + * `health_check_health_num` - Health threshold of health check. + * `health_check_interval` - Interval time of health check. + * `health_check_method` - Methods of health check. + * `health_check_path` - Path of health check. + * `health_check_switch` - Indicates whether health check is enabled. + * `health_check_unhealth_num` - Unhealthy threshold of health check. + * `name` - Name of the rule. + * `protocol` - Protocol of the rule. + * `rule_id` - Id of the 7 layer rule. + * `source_list` - Source list of the rule. + * `source_type` - Source type, 1 for source of host, 2 for source of ip. + * `ssl_id` - SSL id. + * `status` - Status of the rule. `0` for create/modify success, `2` for create/modify fail, `3` for delete success, `5` for waiting to be created/modified, `7` for waiting to be deleted and `8` for waiting to get SSL id. + * `switch` - Indicate the rule will take effect or not. + * `threshold` - Threshold of the rule. + + diff --git a/config/docs/d/dayu_l7_rules_v2.html.markdown b/config/docs/d/dayu_l7_rules_v2.html.markdown new file mode 100644 index 0000000..cfb4f09 --- /dev/null +++ b/config/docs/d/dayu_l7_rules_v2.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_l7_rules_v2" +sidebar_current: "docs-tencentcloud-datasource-dayu_l7_rules_v2" +description: |- + Use this data source to query new dayu layer 7 rules +--- + +# tencentcloud_dayu_l7_rules_v2 + +Use this data source to query new dayu layer 7 rules + +## Example Usage + +```hcl +data "tencentcloud_dayu_l7_rules_v2" "test" { + business = "bgpip" + domain = "qq.com" + protocol = "https" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `business` - (Required, String) Type of the resource that the layer 4 rule works for, valid values are `bgpip`, `bgp`, `bgp-multip` and `net`. +* `domain` - (Optional, String) Domain of resource. +* `ip` - (Optional, String) Ip of the resource. +* `limit` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.81.21. The number of pages, default is `10`. +* `offset` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.81.21. The page start offset, default is `0`. +* `protocol` - (Optional, String) Protocol of resource, value range [`http`, `https`]. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of layer 4 rules. Each element contains the following attributes: + * `cc_enable` - CC protection status of HTTPS protocol, the value is [0 (off), 1 (on)]. + * `cc_level` - CC protection level of HTTPS protocol. + * `cc_status` - CC protection status, value [0(off), 1(on)]. + * `cc_threshold` - CC protection threshold of HTTPS protocol. + * `cert_type` - The source of the certificate. + * `domain` - Domain of resource. + * `https_to_http_enable` - Whether to enable the Https protocol to use Http back-to-source, take the value [0 (off), 1 (on)], default is off. + * `id` - Id of the resource. + * `ip` - Ip of the resource. + * `keep_enable` - Session keep switch, value [0 (session keep closed), 1 (session keep open)]. + * `keep_time` - Session hold time, in seconds. + * `lb_type` - Load balancing mode, the value is [1 (weighted round-robin)]. + * `modify_time` - Modify time of resource. + * `protocol` - Protocol of resource, value range [`http`, `https`]. + * `region` - The area code. + * `rule_name` - Rule description. + * `source_list` - Source list of the rule. + * `source` - Back-to-source IP or domain name. + * `weight` - Weight value, take value [0,100]. + * `source_type` - Back-to-origin method, value [1 (domain name back-to-source), 2 (IP back-to-source)]. + * `ssl_id` - SSL id of the resource. + * `status` - Rule status, value [0 (rule configuration is successful), 1 (rule configuration is in effect), 2 (rule configuration fails), 3 (rule deletion is in effect), 5 (rule deletion fails), 6 (rule is waiting to be configured), 7 (rule pending deletion), 8 (rule pending configuration certificate)]. + * `virtual_port` - Virtual port of resource. + + diff --git a/config/docs/d/dbbrain_db_space_status.html.markdown b/config/docs/d/dbbrain_db_space_status.html.markdown new file mode 100644 index 0000000..7563747 --- /dev/null +++ b/config/docs/d/dbbrain_db_space_status.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_db_space_status" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_db_space_status" +description: |- + Use this data source to query detailed information of dbbrain db_space_status +--- + +# tencentcloud_dbbrain_db_space_status + +Use this data source to query detailed information of dbbrain db_space_status + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_db_space_status" "db_space_status" { + instance_id = "%s" + range_days = 7 + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `product` - (Optional, String) Service product type, supported values include: mysql - cloud database MySQL, cynosdb - cloud database CynosDB for MySQL, the default is mysql. +* `range_days` - (Optional, Int) The number of days in the time period, the deadline is the current day, and the default is 7 days. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `available_days` - Estimated number of days available. +* `growth` - Disk growth (MB). +* `remain` - Disk remaining (MB). +* `total` - Total disk size (MB). + + diff --git a/config/docs/d/dbbrain_diag_db_instances.html.markdown b/config/docs/d/dbbrain_diag_db_instances.html.markdown new file mode 100644 index 0000000..349122b --- /dev/null +++ b/config/docs/d/dbbrain_diag_db_instances.html.markdown @@ -0,0 +1,76 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_diag_db_instances" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_diag_db_instances" +description: |- + Use this data source to query detailed information of dbbrain diag_db_instances +--- + +# tencentcloud_dbbrain_diag_db_instances + +Use this data source to query detailed information of dbbrain diag_db_instances + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_diag_db_instances" "diag_db_instances" { + is_supported = true + product = "mysql" + instance_names = ["keep_preset_mysql"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `is_supported` - (Required, Bool) whether it is an instance supported by DBbrain, always pass `true`. +* `product` - (Required, String) service product type, supported values include: `mysql` - cloud database MySQL, `cynosdb` - cloud database TDSQL-C for MySQL, the default is `mysql`. +* `instance_ids` - (Optional, Set: [`String`]) query based on the instance ID condition. +* `instance_names` - (Optional, Set: [`String`]) query based on the instance name condition. +* `regions` - (Optional, Set: [`String`]) query based on geographical conditions. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `db_scan_status` - all-instance inspection status. `0`: All-instance inspection is enabled; `1`: All-instance inspection is not enabled. +* `items` - information about the instance. + * `audit_policy_status` - Instance audit log enable status. `ALL_AUDIT`: full audit is enabled; `RULE_AUDIT`: rule audit is enabled; `UNBOUND`: audit is not enabled. + * `audit_running_status` - Instance audit log running status. `normal`: running; `paused`: arrears suspended. + * `cpu` - number of cores. + * `create_time` - create time. + * `deadline_time` - resource expiration time. + * `deploy_mode` - cdb type. + * `engine_version` - database version. + * `event_count` - the number of abnormal events. + * `group_id` - group ID. + * `group_name` - group name. + * `health_score` - health score. + * `init_flag` - cdb instance initialization flag: `0`: not initialized; `1`: initialized. + * `instance_conf` - status of instance inspection/overview. + * `daily_inspection` - database inspection switch, Yes/No. + * `key_delimiters` - Custom separator for redis large key analysis, only used by `redis`. Note: This field may return null, indicating that no valid value can be obtained. + * `overview_display` - instance overview switch, Yes/No. + * `instance_id` - instance id. + * `instance_name` - instance name. + * `instance_type` - instance type. `1`: MASTER; `2`: DR, `3`: RO, `4`: SDR. + * `internal_vip` - Intranet VIPNote: This field may return null, indicating that no valid value can be obtained. + * `internal_vport` - Intranet portNote: This field may return null, indicating that no valid value can be obtained. + * `is_supported` - whether it is an instance supported by DBbrain. + * `memory` - memory, in MB. + * `product` - belongs to the product. + * `region` - region. + * `sec_audit_status` - enabled status of the instance security audit log. `ON`: security audit is enabled; `OFF`: security audit is not enabled. + * `source` - access source. + * `status` - Instance status: `0`: Shipping; `1`: Running normally; `4`: Destroying; `5`: Isolating. + * `task_status` - task status. + * `uniq_subnet_id` - subnet uniform ID. + * `uniq_vpc_id` - the unified ID of the private network. + * `vip` - intranet address. + * `volume` - hard disk storage, in GB. + * `vport` - intranet port. + + diff --git a/config/docs/d/dbbrain_diag_event.html.markdown b/config/docs/d/dbbrain_diag_event.html.markdown new file mode 100644 index 0000000..4f3a3e4 --- /dev/null +++ b/config/docs/d/dbbrain_diag_event.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_diag_event" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_diag_event" +description: |- + Use this data source to query detailed information of dbbrain diag_event +--- + +# tencentcloud_dbbrain_diag_event + +Use this data source to query detailed information of dbbrain diag_event + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_diag_history" "diag_history" { + instance_id = "%s" + start_time = "%s" + end_time = "%s" + product = "mysql" +} + +data "tencentcloud_dbbrain_diag_event" "diag_event" { + instance_id = "%s" + event_id = data.tencentcloud_dbbrain_diag_history.diag_history.events.0.event_id + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) isntance id. +* `event_id` - (Optional, Int) Event ID. Obtain it through `Get Instance Diagnosis History DescribeDBDiagHistory`. +* `product` - (Optional, String) Service product type, supported values include: `mysql` - cloud database MySQL, `cynosdb` - cloud database CynosDB for MySQL, the default is `mysql`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `diag_item` - diagnostic item. +* `diag_type` - Diagnostic type. +* `end_time` - End Time. +* `explanation` - Diagnostic event details, output is empty if there is no additional explanatory information. +* `metric` - reserved text. Note: This field may return null, indicating that no valid value can be obtained. +* `outline` - Diagnostic summary. +* `problem` - Diagnosed problem. +* `severity` - severity. The severity is divided into 5 levels, according to the degree of impact from high to low: 1: Fatal, 2: Serious, 3: Warning, 4: Prompt, 5: Healthy. +* `start_time` - Starting time. +* `suggestions` - A diagnostic suggestion, or empty if there is no suggestion. + + diff --git a/config/docs/d/dbbrain_diag_events.html.markdown b/config/docs/d/dbbrain_diag_events.html.markdown new file mode 100644 index 0000000..740bc8b --- /dev/null +++ b/config/docs/d/dbbrain_diag_events.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_diag_events" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_diag_events" +description: |- + Use this data source to query detailed information of dbbrain diag_events +--- + +# tencentcloud_dbbrain_diag_events + +Use this data source to query detailed information of dbbrain diag_events + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_diag_events" "diag_events" { + instance_ids = ["%s"] + start_time = "%s" + end_time = "%s" + severities = [1, 4, 5] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) end time. +* `start_time` - (Required, String) start time. +* `instance_ids` - (Optional, Set: [`String`]) instance id list. +* `result_output_file` - (Optional, String) Used to save results. +* `severities` - (Optional, Set: [`Int`]) severity list, optional value is 1-fatal, 2-severity, 3-warning, 4-tips, 5-health. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - diag event list. + * `diag_item` - diag item. + * `diag_type` - diag type. + * `end_time` - end time. + * `event_id` - event id. + * `instance_id` - instance id. + * `metric` - metric. + * `outline` - outline. + * `region` - region. + * `severity` - severity. + * `start_time` - start time. + + diff --git a/config/docs/d/dbbrain_diag_history.html.markdown b/config/docs/d/dbbrain_diag_history.html.markdown new file mode 100644 index 0000000..537a573 --- /dev/null +++ b/config/docs/d/dbbrain_diag_history.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_diag_history" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_diag_history" +description: |- + Use this data source to query detailed information of dbbrain diag_history +--- + +# tencentcloud_dbbrain_diag_history + +Use this data source to query detailed information of dbbrain diag_history + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_diag_history" "diag_history" { + instance_id = "%s" + start_time = "%s" + end_time = "%s" + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) End time, such as `2019-09-11 12:13:14`, the interval between the end time and the start time can be up to 2 days. +* `instance_id` - (Required, String) instance id. +* `start_time` - (Required, String) Start time, such as `2019-09-10 12:13:14`. +* `product` - (Optional, String) Service product type, supported values include: `mysql` - cloud database MySQL, `cynosdb` - cloud database CynosDB for MySQL, the default is `mysql`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `events` - Event description. + * `diag_item` - Description of the diagnostic item. + * `diag_type` - Diagnostic type. + * `end_time` - End Time. + * `event_id` - Event unique ID. + * `instance_id` - instance id. + * `metric` - reserved text. Note: This field may return null, indicating that no valid value can be obtained. + * `outline` - Diagnostic summary. + * `region` - region. + * `severity` - severity. The severity is divided into 5 levels, according to the degree of impact from high to low: 1: Fatal, 2: Serious, 3: Warning, 4: Prompt, 5: Healthy. + * `start_time` - start Time. + + diff --git a/config/docs/d/dbbrain_health_scores.html.markdown b/config/docs/d/dbbrain_health_scores.html.markdown new file mode 100644 index 0000000..1b59105 --- /dev/null +++ b/config/docs/d/dbbrain_health_scores.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_health_scores" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_health_scores" +description: |- + Use this data source to query detailed information of dbbrain health_scores +--- + +# tencentcloud_dbbrain_health_scores + +Use this data source to query detailed information of dbbrain health_scores + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_health_scores" "health_scores" { + instance_id = "" + time = "" + product = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of the instance whose health score needs to be obtained. +* `product` - (Required, String) Service product type, supported values include: mysql - cloud database MySQL, cynosdb - cloud database TDSQL-C for MySQL, the default is mysql. +* `time` - (Required, String) The time to obtain the health score, the time format is as follows: 2019-09-10 12:13:14. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Health score and abnormal deduction items. + * `events_total_count` - The total number of abnormal events. + * `health_level` - Health level, such as: HEALTH, SUB_HEALTH, RISK, HIGH_RISK. + * `health_score` - Health score. + * `issue_types` - Exception details. + * `events` - unusual event. + * `count` - Number of alerts. + * `diag_type` - Diagnostic type. + * `end_time` - End Time. + * `event_id` - Event ID. + * `metric` - reserved text. + * `outline` - overview. + * `score_lost` - Points deducted. + * `severity` - severity. The severity is divided into 5 levels, according to the degree of impact from high to low: 1: Fatal, 2: Serious, 3: Warning, 4: Prompt, 5: Healthy. + * `start_time` - Starting time. + * `issue_type` - Index classification: AVAILABILITY: availability, MAINTAINABILITY: maintainability, PERFORMANCE, performance, RELIABILITY reliability. + * `total_count` - The total number of abnormal events. + + diff --git a/config/docs/d/dbbrain_mysql_process_list.html.markdown b/config/docs/d/dbbrain_mysql_process_list.html.markdown new file mode 100644 index 0000000..d199f18 --- /dev/null +++ b/config/docs/d/dbbrain_mysql_process_list.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_mysql_process_list" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_mysql_process_list" +description: |- + Use this data source to query detailed information of dbbrain mysql_process_list +--- + +# tencentcloud_dbbrain_mysql_process_list + +Use this data source to query detailed information of dbbrain mysql_process_list + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_mysql_process_list" "mysql_process_list" { + instance_id = local.mysql_id + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `command` - (Optional, String) The execution type of the thread, used to filter the thread list. +* `db` - (Optional, String) The threads operations database, used to filter the thread list. +* `host` - (Optional, String) The operating host address of the thread, used to filter the thread list. +* `id` - (Optional, Int) thread ID, used to filter the thread list. +* `info` - (Optional, String) The threads operation statement is used to filter the thread list. +* `product` - (Optional, String) Service product type, supported values: `mysql` - cloud database MySQL; `cynosdb` - cloud database TDSQL-C for MySQL, the default is `mysql`. +* `result_output_file` - (Optional, String) Used to save results. +* `state` - (Optional, String) The operational state of the thread, used to filter the thread list. +* `time` - (Optional, Int) The minimum value of the operation duration of a thread, in seconds, used to filter the list of threads whose operation duration is longer than this value. +* `user` - (Optional, String) The operating account name of the thread, used to filter the thread list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `process_list` - Live thread list. + * `command` - The execution type of the thread. + * `db` - The thread that operates the database. + * `host` - The operating host address of the thread. + * `id` - thread ID. + * `info` - The operation statement for the thread. + * `state` - The operational state of the thread. + * `time` - The operation duration of the thread, in seconds. + * `user` - The operating account name of the thread. + + diff --git a/config/docs/d/dbbrain_no_primary_key_tables.html.markdown b/config/docs/d/dbbrain_no_primary_key_tables.html.markdown new file mode 100644 index 0000000..4dc6204 --- /dev/null +++ b/config/docs/d/dbbrain_no_primary_key_tables.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_no_primary_key_tables" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_no_primary_key_tables" +description: |- + Use this data source to query detailed information of dbbrain no_primary_key_tables +--- + +# tencentcloud_dbbrain_no_primary_key_tables + +Use this data source to query detailed information of dbbrain no_primary_key_tables + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_no_primary_key_tables" "no_primary_key_tables" { + instance_id = "" + date = "" + product = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `date` - (Required, String) Query date, such as 2021-05-27, the earliest date is 30 days ago. +* `instance_id` - (Required, String) instance id. +* `product` - (Optional, String) Service product type, supported values: `mysql` - ApsaraDB for MySQL, the default is `mysql`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `no_primary_key_table_count_diff` - The difference with yesterday&#39;s scan of the table without a primary key. A positive number means an increase, a negative number means a decrease, and 0 means no change. +* `no_primary_key_tables` - A list of tables without primary keys. + * `engine` - Storage engine for database tables. + * `table_name` - tableName. + * `table_rows` - rows. + * `table_schema` - library name. + * `total_length` - Total space used (MB). +* `timestamp` - Collection timestamp (seconds). + + diff --git a/config/docs/d/dbbrain_redis_top_big_keys.html.markdown b/config/docs/d/dbbrain_redis_top_big_keys.html.markdown new file mode 100644 index 0000000..d34f0bf --- /dev/null +++ b/config/docs/d/dbbrain_redis_top_big_keys.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_redis_top_big_keys" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_redis_top_big_keys" +description: |- + Use this data source to query detailed information of dbbrain redis_top_big_keys +--- + +# tencentcloud_dbbrain_redis_top_big_keys + +Use this data source to query detailed information of dbbrain redis_top_big_keys + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_redis_top_big_keys" "redis_top_big_keys" { + instance_id = local.redis_id + date = "%s" + product = "redis" + sort_by = "Capacity" + key_type = "string" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `date` - (Required, String) Query date, such as 2021-05-27, the earliest date can be the previous 30 days. +* `instance_id` - (Required, String) instance id. +* `product` - (Required, String) Service product type, supported values include `redis` - cloud database Redis. +* `key_type` - (Optional, String) Key type filter condition, the default is no filter, the value includes `string`, `list`, `set`, `hash`, `sortedset`, `stream`. +* `result_output_file` - (Optional, String) Used to save results. +* `sort_by` - (Optional, String) Sorting field, the value includes `Capacity` - memory, `ItemCount` - number of elements, the default is `Capacity`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `top_keys` - list of top keys. + * `encoding` - key encoding method. + * `expire_time` - Key expiration timestamp (in milliseconds), 0 means no expiration time is set. + * `item_count` - number of elements. + * `key` - key name. + * `length` - Key memory size, unit Byte. + * `max_element_size` - Maximum element length. + * `type` - key type. + + diff --git a/config/docs/d/dbbrain_redis_top_key_prefix_list.html.markdown b/config/docs/d/dbbrain_redis_top_key_prefix_list.html.markdown new file mode 100644 index 0000000..3d4784d --- /dev/null +++ b/config/docs/d/dbbrain_redis_top_key_prefix_list.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_redis_top_key_prefix_list" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_redis_top_key_prefix_list" +description: |- + Use this data source to query detailed information of dbbrain redis_top_key_prefix_list +--- + +# tencentcloud_dbbrain_redis_top_key_prefix_list + +Use this data source to query detailed information of dbbrain redis_top_key_prefix_list + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_redis_top_key_prefix_list" "redis_top_key_prefix_list" { + instance_id = local.redis_id + date = "%s" + product = "redis" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `date` - (Required, String) Query date, such as 2021-05-27, the earliest date can be the previous 30 days. +* `instance_id` - (Required, String) instance id. +* `product` - (Required, String) Service product type, supported values include `redis` - cloud database Redis. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - list of top key prefixes. + * `ave_element_size` - Average element length. + * `count` - The number of keys. + * `item_count` - number of elements. + * `key_pre_index` - key prefix. + * `length` - Total occupied memory (Byte). + * `max_element_size` - Maximum element length. + + diff --git a/config/docs/d/dbbrain_security_audit_log_download_urls.html.markdown b/config/docs/d/dbbrain_security_audit_log_download_urls.html.markdown new file mode 100644 index 0000000..e005aab --- /dev/null +++ b/config/docs/d/dbbrain_security_audit_log_download_urls.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_security_audit_log_download_urls" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_security_audit_log_download_urls" +description: |- + Use this data source to query detailed information of dbbrain security_audit_log_download_urls +--- + +# tencentcloud_dbbrain_security_audit_log_download_urls + +Use this data source to query detailed information of dbbrain security_audit_log_download_urls + +## Example Usage + +```hcl +resource "tencentcloud_dbbrain_security_audit_log_export_task" "task" { + sec_audit_group_id = "%s" + start_time = "%s" + end_time = "%s" + product = "mysql" + danger_levels = [0, 1, 2] +} + +data "tencentcloud_dbbrain_security_audit_log_download_urls" "test" { + sec_audit_group_id = "%s" + async_request_id = tencentcloud_dbbrain_security_audit_log_export_task.task.async_request_id + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `async_request_id` - (Required, Int) Asynchronous task ID. +* `product` - (Required, String) Service product type, supported values: `mysql` - ApsaraDB for MySQL. +* `sec_audit_group_id` - (Required, String) Security audit group Id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `urls` - List of COS links to export results. When the result set is large, it may be divided into multiple urls for download. + + diff --git a/config/docs/d/dbbrain_security_audit_log_export_tasks.html.markdown b/config/docs/d/dbbrain_security_audit_log_export_tasks.html.markdown new file mode 100644 index 0000000..86bc853 --- /dev/null +++ b/config/docs/d/dbbrain_security_audit_log_export_tasks.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_security_audit_log_export_tasks" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_security_audit_log_export_tasks" +description: |- + Use this data source to query detailed information of dbbrain securityAuditLogExportTasks +--- + +# tencentcloud_dbbrain_security_audit_log_export_tasks + +Use this data source to query detailed information of dbbrain securityAuditLogExportTasks + +## Example Usage + +```hcl +resource "tencentcloud_dbbrain_security_audit_log_export_task" "task" { + sec_audit_group_id = "sec_audit_group_id" + start_time = "start_time" + end_time = "end_time" + product = "mysql" + danger_levels = [0, 1, 2] +} + +data "tencentcloud_dbbrain_security_audit_log_export_tasks" "tasks" { + sec_audit_group_id = "sec_audit_group_id" + product = "mysql" + async_request_ids = [tencentcloud_dbbrain_security_audit_log_export_task.task.async_request_id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `product` - (Required, String) product, optional value is mysql. +* `sec_audit_group_id` - (Required, String) security audit group id. +* `async_request_ids` - (Optional, Set: [`Int`]) async request id list. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - security audit log export task list. + * `async_request_id` - async request id. + * `create_time` - create time. + * `danger_levels` - danger level list. + * `end_time` - end time. + * `log_end_time` - log end time. + * `log_start_time` - log start time. + * `progress` - task progress. + * `start_time` - start time. + * `status` - status. + * `total_size` - the total size of log. + + diff --git a/config/docs/d/dbbrain_slow_log_time_series_stats.html.markdown b/config/docs/d/dbbrain_slow_log_time_series_stats.html.markdown new file mode 100644 index 0000000..ff148ca --- /dev/null +++ b/config/docs/d/dbbrain_slow_log_time_series_stats.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_slow_log_time_series_stats" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_slow_log_time_series_stats" +description: |- + Use this data source to query detailed information of dbbrain slow_log_time_series_stats +--- + +# tencentcloud_dbbrain_slow_log_time_series_stats + +Use this data source to query detailed information of dbbrain slow_log_time_series_stats + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_slow_log_time_series_stats" "test" { + instance_id = "%s" + start_time = "%s" + end_time = "%s" + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) End time, such as `2019-09-10 12:13:14`, the interval between the end time and the start time can be up to 7 days. +* `instance_id` - (Required, String) Instance ID. +* `start_time` - (Required, String) Start time, such as `2019-09-10 12:13:14`. +* `product` - (Optional, String) Service product type, supported values include: `mysql` - cloud database MySQL, `cynosdb` - cloud database CynosDB for MySQL, the default is `mysql`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `period` - The unit time interval between bars, in seconds. +* `series_data` - Instan1ce cpu utilization monitoring data within a unit time interval. + * `series` - Monitor metrics. + * `metric` - Indicator name. + * `unit` - Indicator unit. + * `values` - Index value. Note: This field may return null, indicating that no valid value can be obtained. + * `timestamp` - The timestamp corresponding to the monitoring indicator. +* `time_series` - Statistics on the number of slow logs in a unit time interval. + * `count` - total. + * `timestamp` - Statistics start time. + + diff --git a/config/docs/d/dbbrain_slow_log_top_sqls.html.markdown b/config/docs/d/dbbrain_slow_log_top_sqls.html.markdown new file mode 100644 index 0000000..d09610f --- /dev/null +++ b/config/docs/d/dbbrain_slow_log_top_sqls.html.markdown @@ -0,0 +1,75 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_slow_log_top_sqls" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_slow_log_top_sqls" +description: |- + Use this data source to query detailed information of dbbrain slow_log_top_sqls +--- + +# tencentcloud_dbbrain_slow_log_top_sqls + +Use this data source to query detailed information of dbbrain slow_log_top_sqls + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_slow_log_top_sqls" "test" { + instance_id = "%s" + start_time = "%s" + end_time = "%s" + sort_by = "QueryTimeMax" + order_by = "ASC" + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) The deadline, such as `2019-09-11 10:13:14`, the interval between the deadline and the start time is less than 7 days. +* `instance_id` - (Required, String) instance id. +* `start_time` - (Required, String) Start time, such as `2019-09-10 12:13:14`. +* `order_by` - (Optional, String) The sorting method supports ASC (ascending) and DESC (descending). The default is DESC. +* `product` - (Optional, String) Service product type, supported values include: `mysql` - cloud database MySQL, `cynosdb` - cloud database CynosDB for MySQL, the default is `mysql`. +* `result_output_file` - (Optional, String) Used to save results. +* `schema_list` - (Optional, List) Array of database names. +* `sort_by` - (Optional, String) Sort key, currently supports sort keys such as QueryTime, ExecTimes, RowsSent, LockTime and RowsExamined, the default is QueryTime. + +The `schema_list` object supports the following: + +* `schema` - (Required, String) DB name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `rows` - Slow log top sql list. + * `exec_times` - Execution times. + * `lock_time_avg` - Average lock waiting time, in seconds. + * `lock_time_max` - Maximum lock waiting time, in seconds. + * `lock_time_min` - Minimum lock waiting time, in seconds. + * `lock_time_ratio` - The ratio of the total lock waiting time of SQL, in %. + * `lock_time` - SQL total lock waiting time, in seconds. + * `md5` - MD5 value of SOL template. + * `query_time_avg` - Average execution time, in seconds. + * `query_time_max` - The maximum execution time, in seconds. + * `query_time_min` - The minimum execution time, in seconds. + * `query_time_ratio` - Total time-consuming ratio, unit %. + * `query_time` - Total time, in seconds. + * `rows_examined_avg` - average number of lines scanned. + * `rows_examined_max` - Maximum number of scan lines. + * `rows_examined_min` - Minimum number of scan lines. + * `rows_examined_ratio` - The proportion of the total number of scanned lines, unit %. + * `rows_examined` - total scan lines. + * `rows_sent_avg` - average number of rows returned. + * `rows_sent_max` - Maximum number of rows returned. + * `rows_sent_min` - Minimum number of rows returned. + * `rows_sent_ratio` - The proportion of the total number of rows returned, in %. + * `rows_sent` - total number of rows returned. + * `schema` - Database name. + * `sql_template` - sql template. + * `sql_text` - SQL with parameters (random). + + diff --git a/config/docs/d/dbbrain_slow_log_user_host_stats.html.markdown b/config/docs/d/dbbrain_slow_log_user_host_stats.html.markdown new file mode 100644 index 0000000..5e48a96 --- /dev/null +++ b/config/docs/d/dbbrain_slow_log_user_host_stats.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_slow_log_user_host_stats" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_slow_log_user_host_stats" +description: |- + Use this data source to query detailed information of dbbrain slow_log_user_host_stats +--- + +# tencentcloud_dbbrain_slow_log_user_host_stats + +Use this data source to query detailed information of dbbrain slow_log_user_host_stats + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_slow_log_user_host_stats" "test" { + instance_id = "%s" + start_time = "%s" + end_time = "%s" + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) EndTime time of the query range, time format such as: 2019-09-10 12:13:14. +* `instance_id` - (Required, String) instance id. +* `start_time` - (Required, String) Start time of the query range, time format such as: 2019-09-10 12:13:14. +* `md5` - (Optional, String) MD5 value of SOL template. +* `product` - (Optional, String) Types of service products, supported values:`mysql` - Cloud Database MySQL; `cynosdb` - Cloud Database TDSQL-C for MySQL, defaults to `mysql`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Detailed list of the slow log proportion for each source address. + * `count` - The number of slow logs for this source address. + * `ratio` - The ratio of the number of slow logs of the source address to the total, in %. + * `user_host` - source address. + + diff --git a/config/docs/d/dbbrain_slow_log_user_sql_advice.html.markdown b/config/docs/d/dbbrain_slow_log_user_sql_advice.html.markdown new file mode 100644 index 0000000..e6accc3 --- /dev/null +++ b/config/docs/d/dbbrain_slow_log_user_sql_advice.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_slow_log_user_sql_advice" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_slow_log_user_sql_advice" +description: |- + Use this data source to query detailed information of dbbrain slow_log_user_sql_advice +--- + +# tencentcloud_dbbrain_slow_log_user_sql_advice + +Use this data source to query detailed information of dbbrain slow_log_user_sql_advice + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_slow_log_user_sql_advice" "test" { + instance_id = "%s" + sql_text = "%s" + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `sql_text` - (Required, String) SQL statements. +* `product` - (Optional, String) Service product type, supported values: `mysql` - cloud database MySQL; `cynosdb` - cloud database TDSQL-C for MySQL; `dbbrain-mysql` - self-built MySQL, the default is `mysql`. +* `result_output_file` - (Optional, String) Used to save results. +* `schema` - (Optional, String) library name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `advices` - SQL optimization suggestion, which can be parsed into a JSON array, and the output is empty when no optimization is required. +* `comments` - SQL optimization suggestion remarks, which can be parsed into a String array, and the output is empty when optimization is not required. +* `cost` - The cost saving details after SQL optimization can be parsed as JSON, and the output is empty when no optimization is required. +* `request_id` - Unique request ID, returned for every request. The RequestId of the request needs to be provided when locating the problem. +* `sql_plan` - The SQL execution plan can be parsed into JSON, and the output is empty when no optimization is required. +* `tables` - The DDL information of related tables can be parsed into a JSON array. + + diff --git a/config/docs/d/dbbrain_slow_logs.html.markdown b/config/docs/d/dbbrain_slow_logs.html.markdown new file mode 100644 index 0000000..fee6749 --- /dev/null +++ b/config/docs/d/dbbrain_slow_logs.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_slow_logs" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_slow_logs" +description: |- + Use this data source to query detailed information of dbbrain slow_logs +--- + +# tencentcloud_dbbrain_slow_logs + +Use this data source to query detailed information of dbbrain slow_logs + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_slow_logs" "slow_logs" { + product = "mysql" + instance_id = "%s" + md5 = "4961208426639258265" + start_time = "%s" + end_time = "%s" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) The deadline, such as 2019-09-11 10:13:14, the interval between the deadline and the start time is less than 7 days. +* `instance_id` - (Required, String) instance Id. +* `md5` - (Required, String) md5 value of sql template. +* `product` - (Required, String) Service product type, supported values include: mysql - cloud database MySQL, cynosdb - cloud database CynosDB for MySQL, the default is mysql. +* `start_time` - (Required, String) Start time, such as 2019-09-10 12:13:14. +* `db` - (Optional, Set: [`String`]) database list. +* `ip` - (Optional, Set: [`String`]) ip. +* `key` - (Optional, Set: [`String`]) keywords. +* `result_output_file` - (Optional, String) Used to save results. +* `time` - (Optional, Set: [`Int`]) Time-consuming interval, the left and right boundaries of the time-consuming interval correspond to the 0th element and the first element of the array respectively. +* `user` - (Optional, Set: [`String`]) user. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `rows` - Slow log details. + * `database` - database. + * `lock_time` - lock time, in secondsNote: This field may return null, indicating that no valid value can be obtained. + * `query_time` - Execution time, in seconds. + * `rows_examined` - scan linesNote: This field may return null, indicating that no valid value can be obtained. + * `rows_sent` - Return the number of rowsNote: This field may return null, indicating that no valid value can be obtained. + * `sql_text` - sql statement. + * `timestamp` - Slow log start time. + * `user_host` - Ip sourceNote: This field may return null, indicating that no valid value can be obtained. + * `user_name` - User sourceNote: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/dbbrain_sql_filters.html.markdown b/config/docs/d/dbbrain_sql_filters.html.markdown new file mode 100644 index 0000000..7ba978e --- /dev/null +++ b/config/docs/d/dbbrain_sql_filters.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_sql_filters" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_sql_filters" +description: |- + Use this data source to query detailed information of dbbrain sqlFilters +--- + +# tencentcloud_dbbrain_sql_filters + +Use this data source to query detailed information of dbbrain sqlFilters + +## Example Usage + +```hcl +resource "tencentcloud_dbbrain_sql_filter" "sql_filter" { + instance_id = "mysql_ins_id" + session_token { + user = "user" + password = "password" + } + sql_type = "SELECT" + filter_key = "test" + max_concurrency = 10 + duration = 3600 +} + +data "tencentcloud_dbbrain_sql_filters" "sql_filters" { + instance_id = "mysql_ins_id" + filter_ids = [tencentcloud_dbbrain_sql_filter.sql_filter.filter_id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `filter_ids` - (Optional, Set: [`Int`]) filter id list. +* `result_output_file` - (Optional, String) Used to save results. +* `statuses` - (Optional, Set: [`String`]) status list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - sql filter list. + * `create_time` - create time. + * `current_concurrency` - current concurrency. + * `current_time` - current time. + * `expire_time` - expire time. + * `id` - task id. + * `max_concurrency` - maxmum concurrency. + * `origin_keys` - origin keys. + * `origin_rule` - origin rule. + * `rejected_sql_count` - rejected sql count. + * `sql_type` - sql type, optional value is SELECT, UPDATE, DELETE, INSERT, REPLACE. + * `status` - task status, optional value is RUNNING, FINISHED, TERMINATED. + + diff --git a/config/docs/d/dbbrain_sql_templates.html.markdown b/config/docs/d/dbbrain_sql_templates.html.markdown new file mode 100644 index 0000000..9ce4c48 --- /dev/null +++ b/config/docs/d/dbbrain_sql_templates.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_sql_templates" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_sql_templates" +description: |- + Use this data source to query detailed information of dbbrain sql_templates +--- + +# tencentcloud_dbbrain_sql_templates + +Use this data source to query detailed information of dbbrain sql_templates + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_sql_templates" "sql_templates" { + instance_id = "" + schema = "" + sql_text = "" + product = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `schema` - (Required, String) database name. +* `sql_text` - (Required, String) SQL statements. +* `product` - (Optional, String) Service product type, supported values include: mysql - cloud database MySQL, cynosdb - cloud database CynosDB for MySQL, the default is mysql. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `sql_id` - SQL template ID. +* `sql_template` - SQL template content. +* `sql_type` - sql type. + + diff --git a/config/docs/d/dbbrain_top_space_schema_time_series.html.markdown b/config/docs/d/dbbrain_top_space_schema_time_series.html.markdown new file mode 100644 index 0000000..1b449a0 --- /dev/null +++ b/config/docs/d/dbbrain_top_space_schema_time_series.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_top_space_schema_time_series" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_top_space_schema_time_series" +description: |- + Use this data source to query detailed information of dbbrain top_space_schema_time_series +--- + +# tencentcloud_dbbrain_top_space_schema_time_series + +Use this data source to query detailed information of dbbrain top_space_schema_time_series + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_top_space_schema_time_series" "top_space_schema_time_series" { + instance_id = "%s" + sort_by = "DataLength" + start_date = "%s" + end_date = "%s" + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `end_date` - (Optional, String) The deadline, such as 2021-01-01, the earliest is the 29th day before the current day, and the default is the current day. +* `limit` - (Optional, Int) The number of Top libraries to return, the maximum value is 100, and the default is 20. +* `product` - (Optional, String) Service product type, supported values include: mysql - cloud database MySQL, cynosdb - cloud database CynosDB for MySQL, the default is mysql. +* `result_output_file` - (Optional, String) Used to save results. +* `sort_by` - (Optional, String) The sorting field used to filter the Top library. The optional fields include DataLength, IndexLength, TotalLength, DataFree, FragRatio, TableRows, and PhysicalFileSize (only supported by ApsaraDB for MySQL instances). The default for ApsaraDB for MySQL instances is PhysicalFileSize, and the default for other product instances is TotalLength. +* `start_date` - (Optional, String) The start date, such as 2021-01-01, the earliest is the 29th day before the current day, and the default is the 6th day before the deadline. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `top_space_schema_time_series` - The time series data list of the returned top library space statistics. + * `series_data` - Spatial index data in unit time interval. + * `series` - Monitor metrics. + * `metric` - Indicator name. + * `unit` - Indicator unit. + * `values` - Index value. Note: This field may return null, indicating that no valid value can be obtained. + * `timestamp` - The timestamp corresponding to the monitoring indicator. + * `table_schema` - databases name. + + diff --git a/config/docs/d/dbbrain_top_space_schemas.html.markdown b/config/docs/d/dbbrain_top_space_schemas.html.markdown new file mode 100644 index 0000000..d57545f --- /dev/null +++ b/config/docs/d/dbbrain_top_space_schemas.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_top_space_schemas" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_top_space_schemas" +description: |- + Use this data source to query detailed information of dbbrain top_space_schemas +--- + +# tencentcloud_dbbrain_top_space_schemas + +Use this data source to query detailed information of dbbrain top_space_schemas + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_top_space_schemas" "top_space_schemas" { + instance_id = "%s" + sort_by = "DataLength" + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `limit` - (Optional, Int) The number of Top libraries to return, the maximum value is 100, and the default is 20. +* `product` - (Optional, String) Service product type, supported values include: mysql - cloud database MySQL, cynosdb - cloud database CynosDB for MySQL, the default is mysql. +* `result_output_file` - (Optional, String) Used to save results. +* `sort_by` - (Optional, String) The sorting field used to filter the Top library. The optional fields include DataLength, IndexLength, TotalLength, DataFree, FragRatio, TableRows, and PhysicalFileSize (only supported by ApsaraDB for MySQL instances). The default for ApsaraDB for MySQL instances is PhysicalFileSize, and the default for other product instances is TotalLength. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `timestamp` - Timestamp (in seconds) when library space data is collected. +* `top_space_schemas` - The returned list of top library space statistics. + * `data_free` - Fragmentation space (MB). + * `data_length` - data space (MB). + * `frag_ratio` - Fragmentation rate (%). + * `index_length` - Index space (MB). + * `physical_file_size` - The sum (MB) of the independent physical file sizes corresponding to all tables in the library. Note: This field may return null, indicating that no valid value can be obtained. + * `table_rows` - Number of lines. + * `table_schema` - library name. + * `total_length` - Total space used (MB). + + diff --git a/config/docs/d/dbbrain_top_space_table_time_series.html.markdown b/config/docs/d/dbbrain_top_space_table_time_series.html.markdown new file mode 100644 index 0000000..3e8ef22 --- /dev/null +++ b/config/docs/d/dbbrain_top_space_table_time_series.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_top_space_table_time_series" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_top_space_table_time_series" +description: |- + Use this data source to query detailed information of dbbrain top_space_table_time_series +--- + +# tencentcloud_dbbrain_top_space_table_time_series + +Use this data source to query detailed information of dbbrain top_space_table_time_series + +## Example Usage + +```hcl +data "tencentcloud_dbbrain_top_space_table_time_series" "top_space_table_time_series" { + instance_id = "%s" + sort_by = "DataLength" + start_date = "%s" + end_date = "%s" + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `end_date` - (Optional, String) The deadline, such as 2021-01-01, the earliest is the 29th day before the current day, and the default is the current day. +* `limit` - (Optional, Int) The number of Top tables returned, the maximum value is 100, and the default is 20. +* `product` - (Optional, String) Service product type, supported values include: mysql - cloud database MySQL, cynosdb - cloud database CynosDB for MySQL, the default is mysql. +* `result_output_file` - (Optional, String) Used to save results. +* `sort_by` - (Optional, String) The sorting field used to filter the Top table. The optional fields include DataLength, IndexLength, TotalLength, DataFree, FragRatio, TableRows, and PhysicalFileSize. The default is PhysicalFileSize. +* `start_date` - (Optional, String) The start date, such as 2021-01-01, the earliest is the 29th day before the current day, and the default is the 6th day before the deadline. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `top_space_table_time_series` - The time-series data list of the returned Top tablespace statistics. + * `engine` - Storage engine for database tables. + * `series_data` - Spatial index data in unit time interval. + * `series` - Monitor metrics. + * `metric` - Indicator name. + * `unit` - Indicator unit. + * `values` - Index value. Note: This field may return null, indicating that no valid value can be obtained. + * `timestamp` - The timestamp corresponding to the monitoring indicator. + * `table_name` - table name. + * `table_schema` - databases name. + + diff --git a/config/docs/d/dbbrain_top_space_tables.html.markdown b/config/docs/d/dbbrain_top_space_tables.html.markdown new file mode 100644 index 0000000..79b70d4 --- /dev/null +++ b/config/docs/d/dbbrain_top_space_tables.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_top_space_tables" +sidebar_current: "docs-tencentcloud-datasource-dbbrain_top_space_tables" +description: |- + Use this data source to query detailed information of dbbrain top_space_tables +--- + +# tencentcloud_dbbrain_top_space_tables + +Use this data source to query detailed information of dbbrain top_space_tables + +## Example Usage + +### Sort by PhysicalFileSize + +```hcl +data "tencentcloud_dbbrain_top_space_tables" "top_space_tables" { + instance_id = "%s" + sort_by = "PhysicalFileSize" + product = "mysql" +} +``` + +### Sort by TotalLength + +```hcl +data "tencentcloud_dbbrain_top_space_tables" "top_space_tables" { + instance_id = "%s" + sort_by = "PhysicalFileSize" + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `limit` - (Optional, Int) The number of Top tables returned, the maximum value is 100, and the default is 20. +* `product` - (Optional, String) Service product type, supported values include: mysql - cloud database MySQL, cynosdb - cloud database CynosDB for MySQL, the default is mysql. +* `result_output_file` - (Optional, String) Used to save results. +* `sort_by` - (Optional, String) The sorting field used to filter the Top table. The optional fields include DataLength, IndexLength, TotalLength, DataFree, FragRatio, TableRows, and PhysicalFileSize (only supported by ApsaraDB for MySQL instances). The default for ApsaraDB for MySQL instances is PhysicalFileSize, and the default for other product instances is TotalLength. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `timestamp` - The timestamp (in seconds) of collecting tablespace data. +* `top_space_tables` - The list of Top tablespace statistics returned. + * `data_free` - Fragmentation space (MB). + * `data_length` - data space (MB). + * `engine` - Storage engine for database tables. + * `frag_ratio` - Fragmentation rate (%). + * `index_length` - Index space (MB). + * `physical_file_size` - The independent physical file size (MB) corresponding to the table. + * `table_name` - table name. + * `table_rows` - Number of lines. + * `table_schema` - database name. + * `total_length` - Total space used (MB). + + diff --git a/config/docs/d/dc_access_points.html.markdown b/config/docs/d/dc_access_points.html.markdown new file mode 100644 index 0000000..161a891 --- /dev/null +++ b/config/docs/d/dc_access_points.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_access_points" +sidebar_current: "docs-tencentcloud-datasource-dc_access_points" +description: |- + Use this data source to query detailed information of dc access_points +--- + +# tencentcloud_dc_access_points + +Use this data source to query detailed information of dc access_points + +## Example Usage + +```hcl +data "tencentcloud_dc_access_points" "access_points" { + region_id = "ap-guangzhou" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `region_id` - (Optional, String) Access point region, which can be queried through `DescribeRegions`.You can call `DescribeRegions` to get the region ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `access_point_set` - Access point information. + * `access_point_id` - Unique access point ID. + * `access_point_name` - Access point name. + * `access_point_type` - Access point type. Valid values: `VXLAN`, `QCPL`, and `QCAR`.Note: this field may return `null`, indicating that no valid values can be obtained. + * `area` - Access point regionNote: this field may return `null`, indicating that no valid values can be obtained. + * `available_port_type` - Available port type at the access point. Valid values: 1000BASE-T: gigabit electrical port; 1000BASE-LX: 10 km gigabit single-mode optical port; 1000BASE-ZX: 80 km gigabit single-mode optical port; 10GBASE-LR: 10 km 10-gigabit single-mode optical port; 10GBASE-ZR: 80 km 10-gigabit single-mode optical port; 10GBASE-LH: 40 km 10-gigabit single-mode optical port; 100GBASE-LR4: 10 km 100-gigabit single-mode optical portfiber optic port.Note: this field may return `null`, indicating that no valid value is obtained. + * `city` - City where the access point is locatedNote: this field may return `null`, indicating that no valid values can be obtained. + * `coordinate` - Latitude and longitude of the access pointNote: this field may return `null`, indicating that no valid values can be obtained. + * `lat` - Latitude. + * `lng` - Longitude. + * `line_operator` - List of ISPs supported by access point. + * `location` - Access point location. + * `region_id` - ID of the region that manages the access point. + * `state` - Access point status. Valid values: available, unavailable. + + diff --git a/config/docs/d/dc_gateway_ccn_routes.html.markdown b/config/docs/d/dc_gateway_ccn_routes.html.markdown new file mode 100644 index 0000000..1dc5b20 --- /dev/null +++ b/config/docs/d/dc_gateway_ccn_routes.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Direct Connect Gateway(DCG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_gateway_ccn_routes" +sidebar_current: "docs-tencentcloud-datasource-dc_gateway_ccn_routes" +description: |- + Use this data source to query detailed information of direct connect gateway route entries. +--- + +# tencentcloud_dc_gateway_ccn_routes + +Use this data source to query detailed information of direct connect gateway route entries. + +## Example Usage + +```hcl +resource "tencentcloud_ccn" "main" { + name = "ci-temp-test-ccn" + description = "ci-temp-test-ccn-des" + qos = "AG" +} + +resource "tencentcloud_dc_gateway" "ccn_main" { + name = "ci-cdg-ccn-test" + network_instance_id = tencentcloud_ccn.main.id + network_type = "CCN" + gateway_type = "NORMAL" +} + +resource "tencentcloud_dc_gateway_ccn_route" "route1" { + dcg_id = tencentcloud_dc_gateway.ccn_main.id + cidr_block = "10.1.1.0/32" +} + +resource "tencentcloud_dc_gateway_ccn_route" "route2" { + dcg_id = tencentcloud_dc_gateway.ccn_main.id + cidr_block = "192.1.1.0/32" +} + +#You need to sleep for a few seconds because there is a cache on the server +data "tencentcloud_dc_gateway_ccn_routes" "test" { + dcg_id = tencentcloud_dc_gateway.ccn_main.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dcg_id` - (Required, String) ID of the DCG to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - Information list of the DCG route entries. + * `as_path` - As path list of the BGP. + * `cidr_block` - A network address segment of IDC. + * `dcg_id` - ID of the DCG. + * `route_id` - ID of the DCG route. + + diff --git a/config/docs/d/dc_gateway_instances.html.markdown b/config/docs/d/dc_gateway_instances.html.markdown new file mode 100644 index 0000000..2f904ea --- /dev/null +++ b/config/docs/d/dc_gateway_instances.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Direct Connect Gateway(DCG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_gateway_instances" +sidebar_current: "docs-tencentcloud-datasource-dc_gateway_instances" +description: |- + Use this data source to query detailed information of direct connect gateway instances. +--- + +# tencentcloud_dc_gateway_instances + +Use this data source to query detailed information of direct connect gateway instances. + +## Example Usage + +```hcl +resource "tencentcloud_ccn" "main" { + name = "ci-temp-test-ccn" + description = "ci-temp-test-ccn-des" + qos = "AG" +} + +resource "tencentcloud_dc_gateway" "ccn_main" { + name = "ci-cdg-ccn-test" + network_instance_id = tencentcloud_ccn.main.id + network_type = "CCN" + gateway_type = "NORMAL" +} + +#You need to sleep for a few seconds because there is a cache on the server +data "tencentcloud_dc_gateway_instances" "name_select" { + name = tencentcloud_dc_gateway.ccn_main.name +} + +data "tencentcloud_dc_gateway_instances" "id_select" { + dcg_id = tencentcloud_dc_gateway.ccn_main.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dcg_id` - (Optional, String) ID of the DCG to be queried. +* `name` - (Optional, String) Name of the DCG to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - Information list of the DCG. + * `cnn_route_type` - Type of CCN route. Valid values: `BGP` and `STATIC`. + * `create_time` - Creation time of resource. + * `dcg_id` - ID of the DCG. + * `dcg_ip` - IP of the DCG. + * `enable_bgp` - Indicates whether the BGP is enabled. + * `gateway_type` - Type of the gateway. Valid values: `NORMAL` and `NAT`. Default is `NORMAL`. + * `name` - Name of the DCG. + * `network_instance_id` - Type of associated network. Valid values: `VPC` and `CCN`. + * `network_type` - IP of the DCG. + + diff --git a/config/docs/d/dc_instances.html.markdown b/config/docs/d/dc_instances.html.markdown new file mode 100644 index 0000000..eb9315a --- /dev/null +++ b/config/docs/d/dc_instances.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_instances" +sidebar_current: "docs-tencentcloud-datasource-dc_instances" +description: |- + Use this data source to query detailed information of DC instances. +--- + +# tencentcloud_dc_instances + +Use this data source to query detailed information of DC instances. + +## Example Usage + +```hcl +data "tencentcloud_dc_instances" "name_select" { + name = "t" +} + +data "tencentcloud_dc_instances" "id" { + dcx_id = "dc-kax48sg7" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dc_id` - (Optional, String) ID of the DC to be queried. +* `name` - (Optional, String) Name of the DC to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - Information list of the DC. + * `access_point_id` - Access point ID of tne DC. + * `bandwidth` - Bandwidth of the DC. + * `circuit_code` - The circuit code provided by the operator for the DC. + * `create_time` - Creation time of resource. + * `customer_address` - Interconnect IP of the DC within client. Note: This field may return null, indicating that no valid values are taken. + * `customer_email` - Applicant email of the DC, the default is obtained from the account. Note: This field may return null, indicating that no valid values are taken. + * `customer_name` - Applicant name of the DC, the default is obtained from the account. Note: This field may return null, indicating that no valid values are taken. + * `customer_phone` - Applicant phone number of the DC, the default is obtained from the account. Note: This field may return null, indicating that no valid values are taken. + * `dc_id` - ID of the DC. + * `enabled_time` - Enable time of resource. + * `expired_time` - Expire date of resource. + * `fault_report_contact_person` - Contact of reporting a faulty. Note: This field may return null, indicating that no valid values are taken. + * `fault_report_contact_phone` - Phone number of reporting a faulty. Note: This field may return null, indicating that no valid values are taken. + * `line_operator` - Operator of the DC, and available values include `ChinaTelecom`, `ChinaMobile`, `ChinaUnicom`, `In-houseWiring`, `ChinaOther` and `InternationalOperator`. + * `location` - The DC location where the connection is located. + * `name` - Name of the DC. + * `port_type` - Port type of the DC in client, and available values include `100Base-T`, `1000Base-T`, `1000Base-LX`, `10GBase-T` and `10GBase-LR`. The default value is `1000Base-LX`. + * `redundant_dc_id` - ID of the redundant DC. + * `state` - State of the DC, and available values include `REJECTED`, `TOPAY`, `PAID`, `ALLOCATED`, `AVAILABLE`, `DELETING` and `DELETED`. + * `tencent_address` - Interconnect IP of the DC within Tencent. Note: This field may return null, indicating that no valid values are taken. + + diff --git a/config/docs/d/dc_internet_address_quota.html.markdown b/config/docs/d/dc_internet_address_quota.html.markdown new file mode 100644 index 0000000..806f8e0 --- /dev/null +++ b/config/docs/d/dc_internet_address_quota.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_internet_address_quota" +sidebar_current: "docs-tencentcloud-datasource-dc_internet_address_quota" +description: |- + Use this data source to query detailed information of dc internet_address_quota +--- + +# tencentcloud_dc_internet_address_quota + +Use this data source to query detailed information of dc internet_address_quota + +## Example Usage + +```hcl +data "tencentcloud_dc_internet_address_quota" "internet_address_quota" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `ipv4_bgp_num` - Number of used BGP type IPv4 Internet addresses. +* `ipv4_bgp_quota` - BGP type IPv4 Internet address quota. +* `ipv4_other_num` - The number of non-BGP Internet addresses used. +* `ipv4_other_quota` - Non-BGP type IPv4 Internet address quota. +* `ipv6_prefix_len` - The minimum prefix length allowed on the IPv6 Internet public network. + + diff --git a/config/docs/d/dc_internet_address_statistics.html.markdown b/config/docs/d/dc_internet_address_statistics.html.markdown new file mode 100644 index 0000000..77dc0c6 --- /dev/null +++ b/config/docs/d/dc_internet_address_statistics.html.markdown @@ -0,0 +1,34 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_internet_address_statistics" +sidebar_current: "docs-tencentcloud-datasource-dc_internet_address_statistics" +description: |- + Use this data source to query detailed information of dc internet_address_statistics +--- + +# tencentcloud_dc_internet_address_statistics + +Use this data source to query detailed information of dc internet_address_statistics + +## Example Usage + +```hcl +data "tencentcloud_dc_internet_address_statistics" "internet_address_statistics" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `internet_address_statistics` - Statistical Information List of Internet Public Network Addresses. + * `region` - region. + * `subnet_num` - Number of Internet public network addresses. + + diff --git a/config/docs/d/dc_public_direct_connect_tunnel_routes.html.markdown b/config/docs/d/dc_public_direct_connect_tunnel_routes.html.markdown new file mode 100644 index 0000000..5b6b05c --- /dev/null +++ b/config/docs/d/dc_public_direct_connect_tunnel_routes.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_public_direct_connect_tunnel_routes" +sidebar_current: "docs-tencentcloud-datasource-dc_public_direct_connect_tunnel_routes" +description: |- + Use this data source to query detailed information of dc public_direct_connect_tunnel_routes +--- + +# tencentcloud_dc_public_direct_connect_tunnel_routes + +Use this data source to query detailed information of dc public_direct_connect_tunnel_routes + +## Example Usage + +```hcl +data "tencentcloud_dc_public_direct_connect_tunnel_routes" "public_direct_connect_tunnel_routes" { + direct_connect_tunnel_id = "dcx-4z49tnws" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `direct_connect_tunnel_id` - (Required, String) direct connect tunnel id. +* `filters` - (Optional, List) filter condition: route-type: route type, value: BGP/STATIC route-subnet: route cidr, value such as: 192.68.1.0/24. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Fields to be filtered. +* `values` - (Required, Set) filter value of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `routes` - Internet tunnel route list. + * `as_path` - ASPath info. + * `destination_cidr_block` - Network CIDR. + * `next_hop` - Route next hop ip. + * `route_id` - direct connect tunnel route id. + * `route_type` - Route type: BGP/STATIC route. + * `status` - ENABLE: routing is enabled, DISABLE: routing is disabled. + + diff --git a/config/docs/d/dcdb_accounts.html.markdown b/config/docs/d/dcdb_accounts.html.markdown new file mode 100644 index 0000000..936a2aa --- /dev/null +++ b/config/docs/d/dcdb_accounts.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_accounts" +sidebar_current: "docs-tencentcloud-datasource-dcdb_accounts" +description: |- + Use this data source to query detailed information of dcdb accounts. +--- + +# tencentcloud_dcdb_accounts + +Use this data source to query detailed information of dcdb accounts. + +## Example Usage + +```hcl +data "tencentcloud_dcdb_accounts" "foo" { + instance_id = tencentcloud_dcdb_account.foo.instance_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - Cloud database account information. + * `create_time` - Creation time. + * `delay_thresh` - If the standby machine delay exceeds the setting value of this parameter, the system will consider that the standby machine is faulty and recommend that the parameter value be greater than 10. This parameter takes effect when ReadOnly selects 1 and 2. + * `description` - User remarks info. + * `host` - From which host the user can log in (corresponding to the host field of MySQL users, UserName + Host uniquely identifies a user, in the form of IP, the IP segment ends with %; supports filling in %; if it is empty, it defaults to %). + * `read_only` - Read-only flag, 0: No, 1: The SQL request of this account is preferentially executed on the standby machine, and the host is selected for execution when the standby machine is unavailable. 2: The standby machine is preferentially selected for execution, and the operation fails when the standby machine is unavailable. + * `slave_const` - For read-only accounts, set the policy whether to fix the standby machine, 0: not fix the standby machine, that is, the standby machine will not disconnect from the client if it does not meet the conditions, the Proxy selects other available standby machines, 1: the standby machine will be disconnected if the conditions are not met, Make sure a connection is secured to the standby machine. + * `update_time` - Last update time. + * `user_name` - User Name. + + diff --git a/config/docs/d/dcdb_database_objects.html.markdown b/config/docs/d/dcdb_database_objects.html.markdown new file mode 100644 index 0000000..9bde97b --- /dev/null +++ b/config/docs/d/dcdb_database_objects.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_database_objects" +sidebar_current: "docs-tencentcloud-datasource-dcdb_database_objects" +description: |- + Use this data source to query detailed information of dcdb database_objects +--- + +# tencentcloud_dcdb_database_objects + +Use this data source to query detailed information of dcdb database_objects + +## Example Usage + +```hcl +data "tencentcloud_dcdb_database_objects" "database_objects" { + instance_id = "dcdbt-ow7t8lmc" + db_name = & lt ; nil & gt ; +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_name` - (Required, String) Database name, obtained through the DescribeDatabases api. +* `instance_id` - (Required, String) The ID of instance. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `funcs` - Function list. + * `func` - The name of function. +* `procs` - Procedure list. + * `proc` - The name of procedure. +* `tables` - Table list. + * `table` - The name of table. +* `views` - View list. + * `view` - The name of view. + + diff --git a/config/docs/d/dcdb_database_tables.html.markdown b/config/docs/d/dcdb_database_tables.html.markdown new file mode 100644 index 0000000..65fb149 --- /dev/null +++ b/config/docs/d/dcdb_database_tables.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_database_tables" +sidebar_current: "docs-tencentcloud-datasource-dcdb_database_tables" +description: |- + Use this data source to query detailed information of dcdb database_tables +--- + +# tencentcloud_dcdb_database_tables + +Use this data source to query detailed information of dcdb database_tables + +## Example Usage + +```hcl +data "tencentcloud_dcdb_database_tables" "database_tables" { + instance_id = "dcdbt-ow7t8lmc" + db_name = & lt ; nil & gt ; + table = & lt ; nil & gt ; + table = & lt ; nil & gt ; + cols { + col = & lt ; nil & gt ; + type = & lt ; nil & gt ; + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_name` - (Required, String) Database name, obtained through the DescribeDatabases api. +* `instance_id` - (Required, String) The ID of instance. +* `table` - (Required, String) Table name, obtained through the DescribeDatabaseObjects api. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cols` - Column information. + * `col` - The name of column. + * `type` - Column type. + + diff --git a/config/docs/d/dcdb_databases.html.markdown b/config/docs/d/dcdb_databases.html.markdown new file mode 100644 index 0000000..d9e0574 --- /dev/null +++ b/config/docs/d/dcdb_databases.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_databases" +sidebar_current: "docs-tencentcloud-datasource-dcdb_databases" +description: |- + Use this data source to query detailed information of dcdb databases +--- + +# tencentcloud_dcdb_databases + +Use this data source to query detailed information of dcdb databases + +## Example Usage + +```hcl +data "tencentcloud_dcdb_databases" "databases" { + instance_id = "your_dcdb_instance_id" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - Database information. + * `db_name` - Database Name. + + diff --git a/config/docs/d/dcdb_file_download_url.html.markdown b/config/docs/d/dcdb_file_download_url.html.markdown new file mode 100644 index 0000000..74ca24e --- /dev/null +++ b/config/docs/d/dcdb_file_download_url.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_file_download_url" +sidebar_current: "docs-tencentcloud-datasource-dcdb_file_download_url" +description: |- + Use this data source to query detailed information of dcdb file_download_url +--- + +# tencentcloud_dcdb_file_download_url + +Use this data source to query detailed information of dcdb file_download_url + +## Example Usage + +```hcl +data "tencentcloud_dcdb_file_download_url" "file_download_url" { + instance_id = local.dcdb_id + shard_id = "shard-1b5r04az" + file_path = "/cos_backup/test.txt" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `file_path` - (Required, String) Unsigned file path. +* `instance_id` - (Required, String) Instance ID. +* `shard_id` - (Required, String) Instance Shard ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `pre_signed_url` - Signed download URL. + + diff --git a/config/docs/d/dcdb_instance_node_info.html.markdown b/config/docs/d/dcdb_instance_node_info.html.markdown new file mode 100644 index 0000000..ba9ddcc --- /dev/null +++ b/config/docs/d/dcdb_instance_node_info.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_instance_node_info" +sidebar_current: "docs-tencentcloud-datasource-dcdb_instance_node_info" +description: |- + Use this data source to query detailed information of dcdb instance_node_info +--- + +# tencentcloud_dcdb_instance_node_info + +Use this data source to query detailed information of dcdb instance_node_info + +## Example Usage + +```hcl +data "tencentcloud_dcdb_instance_node_info" "instance_node_info" { + instance_id = local.dcdb_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, such as tdsqlshard-6ltok4u9. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `nodes_info` - Node information. + * `node_id` - Node ID. + * `role` - Node role. Valid values: `master`, `slave`. + * `shard_id` - Instance shard ID. + + diff --git a/config/docs/d/dcdb_instances.html.markdown b/config/docs/d/dcdb_instances.html.markdown new file mode 100644 index 0000000..ddc4529 --- /dev/null +++ b/config/docs/d/dcdb_instances.html.markdown @@ -0,0 +1,107 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_instances" +sidebar_current: "docs-tencentcloud-datasource-dcdb_instances" +description: |- + Use this data source to query detailed information of dcdb instances +--- + +# tencentcloud_dcdb_instances + +Use this data source to query detailed information of dcdb instances + +## Example Usage + +```hcl +data "tencentcloud_dcdb_instances" "instances1" { + instance_ids = "your_dcdb_instance1_id" + search_name = "instancename" + search_key = "search_key" + project_ids = [0] + excluster_type = 0 + is_filter_excluster = true + excluster_type = 0 + is_filter_vpc = true + vpc_id = "your_vpc_id" + subnet_id = "your_subnet_id" +} + +data "tencentcloud_dcdb_instances" "instances2" { + instance_ids = ["your_dcdb_instance2_id"] +} + +data "tencentcloud_dcdb_instances" "instances3" { + search_name = "instancename" + search_key = "instances3" + is_filter_excluster = false + excluster_type = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `excluster_type` - (Optional, Int) cluster excluster type. +* `instance_ids` - (Optional, Set: [`String`]) instance ids. +* `is_filter_excluster` - (Optional, Bool) search according to the cluster excluter type. +* `is_filter_vpc` - (Optional, Bool) search according to the vpc. +* `project_ids` - (Optional, Set: [`Int`]) project ids. +* `result_output_file` - (Optional, String) Used to save results. +* `search_key` - (Optional, String) search key, support fuzzy query. +* `search_name` - (Optional, String) search name, support instancename, vip, all. +* `subnet_id` - (Optional, String) subnet id, valid when IsFilterVpc is true. +* `vpc_id` - (Optional, String) vpc id, valid when IsFilterVpc is true. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - instance list. + * `app_id` - app id. + * `auto_renew_flag` - auto renew flag. + * `create_time` - create time. + * `db_engine` - db engine. + * `db_version` - db engine version. + * `instance_id` - instance id. + * `instance_name` - instance name. + * `instance_type` - instance type. + * `is_audit_supported` - aduit support, 0:support, 1:unsupport. + * `is_tmp` - tmp instance mark. + * `isolated_timestamp` - isolated time. + * `memory` - memory, the unit is GB. + * `node_count` - node count. + * `paymode` - pay mode. + * `period_end_time` - expired time. + * `project_id` - project id. + * `region` - region. + * `resource_tags` - resource tags. + * `tag_key` - tag key. + * `tag_value` - tag value. + * `shard_count` - shard count. + * `shard_detail` - shard detail. + * `cpu` - cpu cores. + * `createtime` - shard create time. + * `memory` - memory. + * `node_count` - node count. + * `shard_id` - shard id. + * `shard_instance_id` - shard instance id. + * `shard_serial_id` - shard serial id. + * `status` - shard status. + * `storage` - storage. + * `status_desc` - status description. + * `status` - status. + * `storage` - memory, the unit is GB. + * `subnet_id` - subnet id. + * `uin` - account uin. + * `update_time` - update time. + * `vip` - vip. + * `vpc_id` - vpc id. + * `vport` - vport. + * `wan_domain` - wan domain. + * `wan_port` - wan port. + * `wan_status` - wan status, 0:nonactivated, 1:activated, 2:closed, 3:activating. + * `wan_vip` - wan vip. + + diff --git a/config/docs/d/dcdb_log_files.html.markdown b/config/docs/d/dcdb_log_files.html.markdown new file mode 100644 index 0000000..8ba925b --- /dev/null +++ b/config/docs/d/dcdb_log_files.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_log_files" +sidebar_current: "docs-tencentcloud-datasource-dcdb_log_files" +description: |- + Use this data source to query detailed information of dcdb log_files +--- + +# tencentcloud_dcdb_log_files + +Use this data source to query detailed information of dcdb log_files + +## Example Usage + +```hcl +data "tencentcloud_dcdb_log_files" "log_files" { + instance_id = local.dcdb_id + shard_id = "shard-1b5r04az" + type = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID in the format of `tdsqlshard-ow728lmc`. +* `shard_id` - (Required, String) Instance shard ID in the format of `shard-rc754ljk`. +* `type` - (Required, Int) Requested log type. Valid values: 1 (binlog), 2 (cold backup), 3 (errlog), 4 (slowlog). +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `files` - Information such as `uri`, `length`, and `mtime` (modification time). + * `file_name` - Filename. + * `length` - File length. + * `mtime` - Last modified time of log. + * `uri` - Uniform resource identifier (URI) used during log download. +* `normal_prefix` - For an instance in a common network, this prefix plus URI can be used as the download address. +* `vpc_prefix` - For an instance in a VPC, this prefix plus URI can be used as the download address. + + diff --git a/config/docs/d/dcdb_orders.html.markdown b/config/docs/d/dcdb_orders.html.markdown new file mode 100644 index 0000000..7127c20 --- /dev/null +++ b/config/docs/d/dcdb_orders.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_orders" +sidebar_current: "docs-tencentcloud-datasource-dcdb_orders" +description: |- + Use this data source to query detailed information of dcdb orders +--- + +# tencentcloud_dcdb_orders + +Use this data source to query detailed information of dcdb orders + +## Example Usage + +```hcl +data "tencentcloud_dcdb_orders" "orders" { + deal_names = ["2023061224903413767xxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `deal_names` - (Required, Set: [`String`]) List of long order numbers to be queried, which are returned for the APIs for creating, renewing, or scaling instances. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `deals` - Order information list. + * `count` - Number of items. + * `deal_name` - Order number. + * `flow_id` - ID of the associated process, which can be used to query the process execution status. + * `instance_ids` - The ID of the created instance, which is required only for the order that creates an instance.Note: This field may return null, indicating that no valid values can be obtained. + * `owner_uin` - Account. + * `pay_mode` - Payment mode. Valid values: 0 (postpaid), 1 (prepaid). + + diff --git a/config/docs/d/dcdb_parameters.html.markdown b/config/docs/d/dcdb_parameters.html.markdown new file mode 100644 index 0000000..88f1c06 --- /dev/null +++ b/config/docs/d/dcdb_parameters.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_parameters" +sidebar_current: "docs-tencentcloud-datasource-dcdb_parameters" +description: |- + Use this data source to query detailed information of dcdb parameters +--- + +# tencentcloud_dcdb_parameters + +Use this data source to query detailed information of dcdb parameters + +## Example Usage + +```hcl +data "tencentcloud_dcdb_parameters" "parameters" { + instance_id = "your_instance_id" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - parameter list. + * `constraint` - params constraint. + * `enum` - a list of optional values of type num. + * `range` - range constraint. + * `max` - max value. + * `min` - min value. + * `string` - constraint type is string. + * `type` - type. + * `default` - default value. + * `have_set_value` - have set value. + * `need_restart` - need restart. + * `param` - parameter name. + * `value` - parameter value. + + diff --git a/config/docs/d/dcdb_price.html.markdown b/config/docs/d/dcdb_price.html.markdown new file mode 100644 index 0000000..9d065d2 --- /dev/null +++ b/config/docs/d/dcdb_price.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_price" +sidebar_current: "docs-tencentcloud-datasource-dcdb_price" +description: |- + Use this data source to query detailed information of dcdb price +--- + +# tencentcloud_dcdb_price + +Use this data source to query detailed information of dcdb price + +## Example Usage + +```hcl +data "tencentcloud_dcdb_price" "price" { + instance_count = 1 + zone = var.default_az + period = 1 + shard_node_count = 2 + shard_memory = 2 + shard_storage = 10 + shard_count = 2 + paymode = "postpaid" + amount_unit = "pent" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_count` - (Required, Int) The count of instances wants to buy. +* `period` - (Required, Int) Purchase period in months. +* `shard_count` - (Required, Int) Number of instance shards. +* `shard_memory` - (Required, Int) Shard memory size in GB. +* `shard_node_count` - (Required, Int) Number of instance shard nodes. +* `shard_storage` - (Required, Int) Shard storage capacity in GB. +* `zone` - (Required, String) AZ ID of the purchased instance. +* `amount_unit` - (Optional, String) Price unit. Valid values: `pent` (cent), `microPent` (microcent). +* `paymode` - (Optional, String) Billing type. Valid values: `postpaid` (pay-as-you-go), `prepaid` (monthly subscription). +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `original_price` - Original price. Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. Currency: CNY (Chinese site), USD (international site). +* `price` - The actual price may be different from the original price due to discounts. Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. Currency: CNY (Chinese site), USD (international site). + + diff --git a/config/docs/d/dcdb_project_security_groups.html.markdown b/config/docs/d/dcdb_project_security_groups.html.markdown new file mode 100644 index 0000000..b2c59c7 --- /dev/null +++ b/config/docs/d/dcdb_project_security_groups.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_project_security_groups" +sidebar_current: "docs-tencentcloud-datasource-dcdb_project_security_groups" +description: |- + Use this data source to query detailed information of dcdb project_security_groups +--- + +# tencentcloud_dcdb_project_security_groups + +Use this data source to query detailed information of dcdb project_security_groups + +## Example Usage + +```hcl +data "tencentcloud_dcdb_project_security_groups" "project_security_groups" { + product = "dcdb" + project_id = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `product` - (Required, String) Database engine name. Valid value: `dcdb`. +* `project_id` - (Optional, Int) Project ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `groups` - Security group details. + * `create_time` - Creation time in the format of yyyy-mm-dd hh:mm:ss. + * `inbound` - Inbound rule. + * `action` - Policy, which can be `ACCEPT` or `DROP`. + * `cidr_ip` - Source IP or source IP range, such as 192.168.0.0/16. + * `ip_protocol` - Network protocol. UDP and TCP are supported. + * `port_range` - Port. + * `outbound` - Outbound rule. + * `action` - Policy, which can be `ACCEPT` or `DROP`. + * `cidr_ip` - Source IP or source IP range, such as 192.168.0.0/16. + * `ip_protocol` - Network protocol. UDP and TCP are supported. + * `port_range` - Port. + * `project_id` - Project ID. + * `security_group_id` - Security group ID. + * `security_group_name` - Security group name. + * `security_group_remark` - Security group remarks. + + diff --git a/config/docs/d/dcdb_projects.html.markdown b/config/docs/d/dcdb_projects.html.markdown new file mode 100644 index 0000000..d36dc84 --- /dev/null +++ b/config/docs/d/dcdb_projects.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_projects" +sidebar_current: "docs-tencentcloud-datasource-dcdb_projects" +description: |- + Use this data source to query detailed information of dcdb projects +--- + +# tencentcloud_dcdb_projects + +Use this data source to query detailed information of dcdb projects + +## Example Usage + +```hcl +data "tencentcloud_dcdb_projects" "projects" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `projects` - Project list. + * `app_id` - Application ID. + * `create_time` - Creation time. + * `creator_uin` - Creator UIN. + * `info` - Description. + * `is_default` - Whether it is the default project. Valid values: `1` (yes), `0` (no). + * `name` - Project name. + * `owner_uin` - The UIN of the resource owner (root account). + * `project_id` - Project ID. + * `src_app_id` - Source APPID. + * `src_plat` - Source platform. + * `status` - Project status. Valid values: `0` (normal), `-1` (disabled), `3` (default project). + + diff --git a/config/docs/d/dcdb_renewal_price.html.markdown b/config/docs/d/dcdb_renewal_price.html.markdown new file mode 100644 index 0000000..f486078 --- /dev/null +++ b/config/docs/d/dcdb_renewal_price.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_renewal_price" +sidebar_current: "docs-tencentcloud-datasource-dcdb_renewal_price" +description: |- + Use this data source to query detailed information of dcdb renewal_price +--- + +# tencentcloud_dcdb_renewal_price + +Use this data source to query detailed information of dcdb renewal_price + +## Example Usage + +```hcl +data "tencentcloud_dcdb_renewal_price" "renewal_price" { + instance_id = local.dcdb_id + period = 1 + amount_unit = "pent" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `amount_unit` - (Optional, String) Price unit. Valid values: `pent` (cent), `microPent` (microcent). +* `period` - (Optional, Int) Renewal duration, default: 1 month. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `original_price` - Original price. Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. Currency: CNY (Chinese site), USD (international site). +* `price` - The actual price may be different from the original price due to discounts. Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. Currency: CNY (Chinese site), USD (international site). + + diff --git a/config/docs/d/dcdb_sale_info.html.markdown b/config/docs/d/dcdb_sale_info.html.markdown new file mode 100644 index 0000000..c0c5bcf --- /dev/null +++ b/config/docs/d/dcdb_sale_info.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_sale_info" +sidebar_current: "docs-tencentcloud-datasource-dcdb_sale_info" +description: |- + Use this data source to query detailed information of dcdb sale_info +--- + +# tencentcloud_dcdb_sale_info + +Use this data source to query detailed information of dcdb sale_info + +## Example Usage + +```hcl +data "tencentcloud_dcdb_sale_info" "sale_info" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `region_list` - list of sale region info. + * `available_choice` - available zone choice. + * `master_zone` - master zone. + * `on_sale` - is zone on sale. + * `zone_id` - zone id. + * `zone_name` - zone name(zh). + * `zone` - zone name(en). + * `slave_zones` - slave zones. + * `on_sale` - is zone on sale. + * `zone_id` - zone id. + * `zone_name` - zone name(zh). + * `zone` - zone name(en). + * `region_id` - region id. + * `region_name` - region name(zh). + * `region` - region name(en). + * `zone_list` - list of az zone. + * `on_sale` - is zone on sale. + * `zone_id` - zone id. + * `zone_name` - zone name(zh). + * `zone` - zone name(en). + + diff --git a/config/docs/d/dcdb_security_groups.html.markdown b/config/docs/d/dcdb_security_groups.html.markdown new file mode 100644 index 0000000..351fde4 --- /dev/null +++ b/config/docs/d/dcdb_security_groups.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_security_groups" +sidebar_current: "docs-tencentcloud-datasource-dcdb_security_groups" +description: |- + Use this data source to query detailed information of dcdb securityGroups +--- + +# tencentcloud_dcdb_security_groups + +Use this data source to query detailed information of dcdb securityGroups + +## Example Usage + +```hcl +data "tencentcloud_dcdb_security_groups" "securityGroups" { + instance_id = "your_instance_id" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - security group list. + * `create_time` - create time. + * `inbound` - inbound rules. + * `action` - policy action. + * `cidr_ip` - cidr ip. + * `ip_protocol` - internet protocol. + * `port_range` - port range. + * `outbound` - outbound rules. + * `action` - policy action. + * `cidr_ip` - cidr ip. + * `ip_protocol` - internet protocol. + * `port_range` - port range. + * `project_id` - project id. + * `security_group_id` - security group id. + * `security_group_name` - security group name. + + diff --git a/config/docs/d/dcdb_shard_spec.html.markdown b/config/docs/d/dcdb_shard_spec.html.markdown new file mode 100644 index 0000000..35ae400 --- /dev/null +++ b/config/docs/d/dcdb_shard_spec.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_shard_spec" +sidebar_current: "docs-tencentcloud-datasource-dcdb_shard_spec" +description: |- + Use this data source to query detailed information of dcdb shard_spec +--- + +# tencentcloud_dcdb_shard_spec + +Use this data source to query detailed information of dcdb shard_spec + +## Example Usage + +```hcl +data "tencentcloud_dcdb_shard_spec" "shard_spec" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `spec_config` - list of instance specifications. + * `machine` - machine type. + * `spec_config_infos` - list of machine specifications. + * `cpu` - CPU cores. + * `max_storage` - maximum storage size, inGB. + * `memory` - memory, in GB. + * `min_storage` - minimum storage size, in GB. + * `node_count` - node count. + * `pid` - product price id. + * `qps` - maximum QPS. + * `suit_info` - recommended usage scenarios. + + diff --git a/config/docs/d/dcdb_shards.html.markdown b/config/docs/d/dcdb_shards.html.markdown new file mode 100644 index 0000000..2574e3a --- /dev/null +++ b/config/docs/d/dcdb_shards.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_shards" +sidebar_current: "docs-tencentcloud-datasource-dcdb_shards" +description: |- + Use this data source to query detailed information of dcdb shards +--- + +# tencentcloud_dcdb_shards + +Use this data source to query detailed information of dcdb shards + +## Example Usage + +```hcl +data "tencentcloud_dcdb_shards" "shards" { + instance_id = "your_instance_id" + shard_instance_ids = ["shard1_id"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `result_output_file` - (Optional, String) Used to save results. +* `shard_instance_ids` - (Optional, Set: [`String`]) shard instance ids. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - shard list. + * `cpu` - cpu cores. + * `create_time` - create time. + * `instance_id` - instance id. + * `memory_usage` - memory usage. + * `memory` - memory, the unit is GB. + * `node_count` - node count. + * `paymode` - pay mode. + * `period_end_time` - expired time. + * `project_id` - project id. + * `proxy_version` - proxy version. + * `range` - the range of shard key. + * `region` - region. + * `shard_instance_id` - shard instance id. + * `shard_master_zone` - shard master zone. + * `shard_serial_id` - shard serial id. + * `shard_slave_zones` - shard slave zones. + * `status_desc` - status description. + * `status` - status. + * `storage_usage` - storage usage. + * `storage` - memory, the unit is GB. + * `subnet_id` - subnet id. + * `vpc_id` - vpc id. + * `zone` - zone. + + diff --git a/config/docs/d/dcdb_slow_logs.html.markdown b/config/docs/d/dcdb_slow_logs.html.markdown new file mode 100644 index 0000000..b0e896b --- /dev/null +++ b/config/docs/d/dcdb_slow_logs.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_slow_logs" +sidebar_current: "docs-tencentcloud-datasource-dcdb_slow_logs" +description: |- + Use this data source to query detailed information of dcdb slow_logs +--- + +# tencentcloud_dcdb_slow_logs + +Use this data source to query detailed information of dcdb slow_logs + +## Example Usage + +```hcl +data "tencentcloud_dcdb_slow_logs" "slow_logs" { + instance_id = local.dcdb_id + start_time = "%s" + end_time = "%s" + shard_id = "shard-1b5r04az" + db = "tf_test_db" + order_by = "query_time_sum" + order_by_type = "desc" + slave = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID in the format of `tdsqlshard-ow728lmc`. +* `shard_id` - (Required, String) Instance shard ID in the format of `shard-rc754ljk`. +* `start_time` - (Required, String) Query start time in the format of 2016-07-23 14:55:20. +* `db` - (Optional, String) Specific name of the database to be queried. +* `end_time` - (Optional, String) Query end time in the format of 2016-08-22 14:55:20. +* `order_by_type` - (Optional, String) Sorting order. Valid values: desc, asc. +* `order_by` - (Optional, String) Sorting metric. Valid values: query_time_sum, query_count. +* `result_output_file` - (Optional, String) Used to save results. +* `slave` - (Optional, Int) Query slow queries from either the primary or the replica. Valid values: 0 (primary), 1 (replica). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Slow query log data. + * `check_sum` - Statement checksum for querying details. + * `db` - Database name. + * `example_sql` - Sample SQLNote: This field may return null, indicating that no valid values can be obtained. + * `finger_print` - Abstracted SQL statement. + * `host` - Host address of account. + * `lock_time_avg` - Average lock time. + * `lock_time_max` - Maximum lock time. + * `lock_time_min` - Minimum lock time. + * `lock_time_sum` - Total lock time. + * `query_count` - Number of queries. + * `query_time_avg` - Average query time. + * `query_time_max` - Maximum query time. + * `query_time_min` - Minimum query time. + * `query_time_sum` - Total query time. + * `rows_examined_sum` - Number of scanned rows. + * `rows_sent_sum` - Number of sent rows. + * `ts_max` - Last execution time. + * `ts_min` - First execution time. + * `user` - Account. +* `lock_time_sum` - Total statement lock time. +* `query_count` - Total number of statement queries. +* `query_time_sum` - Total statement query time. + + diff --git a/config/docs/d/dcdb_upgrade_price.html.markdown b/config/docs/d/dcdb_upgrade_price.html.markdown new file mode 100644 index 0000000..84cbc75 --- /dev/null +++ b/config/docs/d/dcdb_upgrade_price.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_upgrade_price" +sidebar_current: "docs-tencentcloud-datasource-dcdb_upgrade_price" +description: |- + Use this data source to query detailed information of dcdb upgrade_price +--- + +# tencentcloud_dcdb_upgrade_price + +Use this data source to query detailed information of dcdb upgrade_price + +## Example Usage + +```hcl +data "tencentcloud_dcdb_upgrade_price" "add_upgrade_price" { + instance_id = local.dcdb_id + upgrade_type = "ADD" + add_shard_config { + shard_count = 2 + shard_memory = 2 + shard_storage = 100 + } + amount_unit = "pent" +} + +data "tencentcloud_dcdb_upgrade_price" "expand_upgrade_price" { + instance_id = local.dcdb_id + upgrade_type = "EXPAND" + + expand_shard_config { + shard_instance_ids = ["shard-1b5r04az"] + shard_memory = 2 + shard_storage = 40 + shard_node_count = 2 + } + amount_unit = "pent" +} + +data "tencentcloud_dcdb_upgrade_price" "split_upgrade_price" { + instance_id = local.dcdb_id + upgrade_type = "SPLIT" + + split_shard_config { + shard_instance_ids = ["shard-1b5r04az"] + split_rate = 50 + shard_memory = 2 + shard_storage = 100 + } + amount_unit = "pent" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `upgrade_type` - (Required, String) Upgrade type, ADD: add new shard, EXPAND: upgrade the existing shard, SPLIT: split existing shard. +* `add_shard_config` - (Optional, List) Config for adding new shard. +* `amount_unit` - (Optional, String) Price unit. Valid values: `pent` (cent), `microPent` (microcent). +* `expand_shard_config` - (Optional, List) Config for expanding existing shard. +* `result_output_file` - (Optional, String) Used to save results. +* `split_shard_config` - (Optional, List) Config for splitting existing shard. + +The `add_shard_config` object supports the following: + +* `shard_count` - (Required, Int) The number of new shards. +* `shard_memory` - (Required, Int) Shard memory size in GB. +* `shard_storage` - (Required, Int) Shard storage capacity in GB. + +The `expand_shard_config` object supports the following: + +* `shard_instance_ids` - (Required, Set) List of shard ID. +* `shard_memory` - (Required, Int) Shard memory size in GB. +* `shard_storage` - (Required, Int) Shard storage capacity in GB. +* `shard_node_count` - (Optional, Int) Shard node count. + +The `split_shard_config` object supports the following: + +* `shard_instance_ids` - (Required, Set) List of shard ID. +* `shard_memory` - (Required, Int) Shard memory size in GB. +* `shard_storage` - (Required, Int) Shard storage capacity in GB. +* `split_rate` - (Required, Int) Data split ratio, fixed at 50%. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `formula` - Price calculation formula. +* `original_price` - Original price. Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. Currency: CNY (Chinese site), USD (international site). +* `price` - The actual price may be different from the original price due to discounts. Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. Currency: CNY (Chinese site), USD (international site). + + diff --git a/config/docs/d/dcx_instances.html.markdown b/config/docs/d/dcx_instances.html.markdown new file mode 100644 index 0000000..441e581 --- /dev/null +++ b/config/docs/d/dcx_instances.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcx_instances" +sidebar_current: "docs-tencentcloud-datasource-dcx_instances" +description: |- + Use this data source to query detailed information of dedicated tunnels instances. +--- + +# tencentcloud_dcx_instances + +Use this data source to query detailed information of dedicated tunnels instances. + +## Example Usage + +```hcl +data "tencentcloud_dcx_instances" "name_select" { + name = "main" +} + +data "tencentcloud_dcx_instances" "id" { + dcx_id = "dcx-3ikuw30k" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dcx_id` - (Optional, String) ID of the dedicated tunnels to be queried. +* `name` - (Optional, String) Name of the dedicated tunnels to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - Information list of the dedicated tunnels. + * `bandwidth` - Bandwidth of the DC. + * `bgp_asn` - BGP ASN of the user. + * `bgp_auth_key` - BGP key of the user. + * `create_time` - Creation time of resource. + * `customer_address` - Interconnect IP of the DC within client. + * `dc_id` - ID of the DC. + * `dcg_id` - ID of the DC Gateway. Currently only new in the console. + * `dcx_id` - ID of the dedicated tunnel. + * `name` - Name of the dedicated tunnel. + * `network_region` - The region of the dedicated tunnel. + * `network_type` - Type of the network. Valid values: `VPC`, `BMVPC` and `CCN`. The default value is `VPC`. + * `route_filter_prefixes` - Static route, the network address of the user IDC. + * `route_type` - Type of the route. Valid values: `BGP` and `STATIC`. The default value is `BGP`. + * `state` - State of the dedicated tunnels. Valid values: `PENDING`, `ALLOCATING`, `ALLOCATED`, `ALTERING`, `DELETING`, `DELETED`, `COMFIRMING` and `REJECTED`. + * `tencent_address` - Interconnect IP of the DC within Tencent. + * `vlan` - Vlan of the dedicated tunnels. Valid value ranges: [0-3000]. `0` means that only one tunnel can be created for the physical connect. + * `vpc_id` - ID of the VPC or BMVPC. + + diff --git a/config/docs/d/dlc_check_data_engine_config_pairs_validity.html.markdown b/config/docs/d/dlc_check_data_engine_config_pairs_validity.html.markdown new file mode 100644 index 0000000..fbb3b6d --- /dev/null +++ b/config/docs/d/dlc_check_data_engine_config_pairs_validity.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_check_data_engine_config_pairs_validity" +sidebar_current: "docs-tencentcloud-datasource-dlc_check_data_engine_config_pairs_validity" +description: |- + Use this data source to query detailed information of dlc check_data_engine_config_pairs_validity +--- + +# tencentcloud_dlc_check_data_engine_config_pairs_validity + +Use this data source to query detailed information of dlc check_data_engine_config_pairs_validity + +## Example Usage + +```hcl +data "tencentcloud_dlc_check_data_engine_config_pairs_validity" "check_data_engine_config_pairs_validity" { + child_image_version_id = "d3ftghd4-9a7e-4f64-a3f4-f38507c69742" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `child_image_version_id` - (Optional, String) Engine Image version id. +* `data_engine_config_pairs` - (Optional, List) User-defined parameters. +* `image_version_id` - (Optional, String) Engine major version id. If a minor version id exists, you only need to pass in the minor version id. If it does not exist, the latest minor version id under the current major version will be obtained. +* `result_output_file` - (Optional, String) Used to save results. + +The `data_engine_config_pairs` object supports the following: + +* `config_item` - (Required, String) Configuration item. +* `config_value` - (Required, String) Configuration value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `is_available` - Parameter validity: true: valid, false: at least one invalid parameter exists. +* `unavailable_config` - Invalid parameter set. + + diff --git a/config/docs/d/dlc_check_data_engine_image_can_be_rollback.html.markdown b/config/docs/d/dlc_check_data_engine_image_can_be_rollback.html.markdown new file mode 100644 index 0000000..bc0019e --- /dev/null +++ b/config/docs/d/dlc_check_data_engine_image_can_be_rollback.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_check_data_engine_image_can_be_rollback" +sidebar_current: "docs-tencentcloud-datasource-dlc_check_data_engine_image_can_be_rollback" +description: |- + Use this data source to query detailed information of dlc check_data_engine_image_can_be_rollback +--- + +# tencentcloud_dlc_check_data_engine_image_can_be_rollback + +Use this data source to query detailed information of dlc check_data_engine_image_can_be_rollback + +## Example Usage + +```hcl +data "tencentcloud_dlc_check_data_engine_image_can_be_rollback" "check_data_engine_image_can_be_rollback" { + data_engine_id = "DataEngine-public-1308919341" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_id` - (Required, String) Engine unique id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `from_record_id` - Log record id before rollback. +* `is_rollback` - Is it possible to roll back. +* `to_record_id` - Log record id after rollback. + + diff --git a/config/docs/d/dlc_check_data_engine_image_can_be_upgrade.html.markdown b/config/docs/d/dlc_check_data_engine_image_can_be_upgrade.html.markdown new file mode 100644 index 0000000..73cc137 --- /dev/null +++ b/config/docs/d/dlc_check_data_engine_image_can_be_upgrade.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_check_data_engine_image_can_be_upgrade" +sidebar_current: "docs-tencentcloud-datasource-dlc_check_data_engine_image_can_be_upgrade" +description: |- + Use this data source to query detailed information of dlc check_data_engine_image_can_be_upgrade +--- + +# tencentcloud_dlc_check_data_engine_image_can_be_upgrade + +Use this data source to query detailed information of dlc check_data_engine_image_can_be_upgrade + +## Example Usage + +```hcl +data "tencentcloud_dlc_check_data_engine_image_can_be_upgrade" "check_data_engine_image_can_be_upgrade" { + data_engine_id = "DataEngine-cgkvbas6" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_id` - (Required, String) Engine unique id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `child_image_version_id` - The latest image version id that can be upgraded. +* `is_upgrade` - Is it possible to upgrade. + + diff --git a/config/docs/d/dlc_describe_data_engine.html.markdown b/config/docs/d/dlc_describe_data_engine.html.markdown new file mode 100644 index 0000000..173ece1 --- /dev/null +++ b/config/docs/d/dlc_describe_data_engine.html.markdown @@ -0,0 +1,107 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_describe_data_engine" +sidebar_current: "docs-tencentcloud-datasource-dlc_describe_data_engine" +description: |- + Use this data source to query detailed information of dlc describe_data_engine +--- + +# tencentcloud_dlc_describe_data_engine + +Use this data source to query detailed information of dlc describe_data_engine + +## Example Usage + +```hcl +data "tencentcloud_dlc_describe_data_engine" "describe_data_engine" { + data_engine_name = "testSpark" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_name` - (Required, String) Engine name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data_engine` - Data engine details. + * `auto_resume` - Whether to automatically start the cluster, prepay not support. + * `auto_suspend_time` - Cluster automatic suspension time, default 10 minutes. + * `auto_suspend` - Whether to automatically suspend the cluster, prepay not support. + * `child_image_version_id` - Engine Image version id. + * `cidr_block` - Engine VPC network segment, just like 192.0.2.1/24. + * `cluster_type` - Engine cluster type, only support: spark_cu/presto_cu. + * `create_time` - Create time. + * `crontab_resume_suspend_strategy` - Engine auto suspend strategy, when AutoSuspend is true, CrontabResumeSuspend must stop. + * `resume_time` - Scheduled pull-up time: For example: 8 o&#39;clock on Monday is expressed as 1000000-08:00:00. + * `suspend_strategy` - Suspend configuration: 0 (default): wait for the task to end before suspending, 1: force suspend. + * `suspend_time` - Scheduled suspension time: For example: 20 o&#39;clock on Monday is expressed as 1000000-20:00:00. + * `crontab_resume_suspend` - Engine crontab resume or suspend strategy, only support: 0: Wait(default), 1: Kill. + * `data_engine_id` - Engine unique id. + * `data_engine_name` - Engine name. + * `default_data_engine` - Whether it is the default virtual cluster. + * `default_house` - Is it the default engine?. + * `elastic_limit` - For spark Batch ExecType, yearly and monthly cluster elastic limit. + * `elastic_switch` - For spark Batch ExecType, yearly and monthly cluster whether to enable elasticity. + * `engine_exec_type` - Engine exec type, only support SQL(default) or BATCH. + * `engine_type` - Engine type, only support: spark/presto. + * `expire_time` - Expire time. + * `image_version_id` - Engine major version id. + * `image_version_name` - Engine image version name. + * `isolated_time` - Isolated time. + * `max_clusters` - Engine max cluster size, MaxClusters less than or equal to 10 and MaxClusters bigger than MinClusters. + * `max_concurrency` - Maximum number of concurrent tasks in a single cluster, default 5. + * `message` - Engine description information. + * `min_clusters` - Engine min size, greater than or equal to 1 and MaxClusters bigger than MinClusters. + * `mode` - Engine mode, only support 1: ByAmount, 2: YearlyAndMonthly. + * `network_connection_set` - Network connection configuration. + * `appid` - User appid. + * `associate_id` - Network configuration unique identifier. + * `create_time` - Create time. + * `datasource_connection_cidr_block` - Datasource connection cidr block. + * `datasource_connection_id` - Data source id (obsolete). + * `datasource_connection_name` - Network configuration name. + * `datasource_connection_subnet_cidr_block` - Datasource connection subnet cidr block. + * `datasource_connection_subnet_id` - Datasource subnetId. + * `datasource_connection_vpc_id` - Datasource vpcid. + * `house_id` - Data engine id. + * `house_name` - Data engine name. + * `id` - Network configuration id. + * `network_connection_desc` - Network configuration description. + * `network_connection_type` - Network configuration type. + * `state` - Network configuration status (0-initialization, 1-normal). + * `sub_account_uin` - User sub uin. + * `uin` - User uin. + * `update_time` - Update time. + * `permissions` - Engine permissions. + * `quota_id` - Reference ID. + * `renew_flag` - Automatic renewal flag, 0, initial state, automatic renewal is not performed by default. If the user has prepaid non-stop service privileges, automatic renewal will occur. 1: Automatic renewal. 2: Make it clear that there will be no automatic renewal. + * `resource_type` - Engine resource type not match, only support: Standard_CU/Memory_CU(only BATCH ExecType). + * `reversal_time` - Reversal time. + * `session_resource_template` - For spark Batch ExecType, cluster session resource configuration template. + * `driver_size` - Engine driver size specification only supports: small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge. + * `executor_max_numbers` - Specify the executor max number (in a dynamic configuration scenario), the minimum value is 1, and the maximum value is less than the cluster specification (when ExecutorMaxNumbers is less than ExecutorNums, the value is set to ExecutorNums). + * `executor_nums` - Specify the number of executors. The minimum value is 1 and the maximum value is less than the cluster specification. + * `executor_size` - Engine executor size specification only supports: small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge. + * `size` - Engine size. + * `spend_after` - Automatic recovery time, prepay not support. + * `start_standby_cluster` - Whether to enable the backup cluster. + * `state` - Engine state, only support: 0:Init/-1:Failed/-2:Deleted/1:Pause/2:Running/3:ToBeDelete/4:Deleting. + * `sub_account_uin` - Operator. + * `tag_list` - Tag list. + * `tag_key` - Tag key. + * `tag_value` - Tag value. + * `tolerable_queue_time` - Tolerable queuing time, default 0. scaling may be triggered when tasks are queued for longer than the tolerable time. if this parameter is 0, it means that capacity expansion may be triggered immediately once a task is queued. + * `ui_u_r_l` - Jump address of ui. + * `update_time` - Update time. + * `user_alias` - User&#39;s nickname. + * `user_app_id` - User appid. + * `user_uin` - User uin. + + diff --git a/config/docs/d/dlc_describe_data_engine_image_versions.html.markdown b/config/docs/d/dlc_describe_data_engine_image_versions.html.markdown new file mode 100644 index 0000000..20eb9bd --- /dev/null +++ b/config/docs/d/dlc_describe_data_engine_image_versions.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_describe_data_engine_image_versions" +sidebar_current: "docs-tencentcloud-datasource-dlc_describe_data_engine_image_versions" +description: |- + Use this data source to query detailed information of dlc describe_data_engine_image_versions +--- + +# tencentcloud_dlc_describe_data_engine_image_versions + +Use this data source to query detailed information of dlc describe_data_engine_image_versions + +## Example Usage + +```hcl +data "tencentcloud_dlc_describe_data_engine_image_versions" "describe_data_engine_image_versions" { + engine_type = "SparkBatch" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `engine_type` - (Required, String) Engine type only support: SparkSQL/PrestoSQL/SparkBatch. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `image_parent_versions` - Cluster large version image information list. + * `description` - Image major version description. + * `engine_type` - Engine type only support: SparkSQL/PrestoSQL/SparkBatch. + * `image_version_id` - Engine major version id. + * `image_version` - Engine major version name. + * `insert_time` - Create time. + * `is_public` - Whether it is a public version, only support: 1: public;/2: private. + * `is_shared_engine` - Is shared engine, only support: 1:yes/2:no. + * `state` - Version status, only support: 1: initialized/2: online/3: offline. + * `update_time` - Update time. + + diff --git a/config/docs/d/dlc_describe_data_engine_python_spark_images.html.markdown b/config/docs/d/dlc_describe_data_engine_python_spark_images.html.markdown new file mode 100644 index 0000000..4a82b82 --- /dev/null +++ b/config/docs/d/dlc_describe_data_engine_python_spark_images.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_describe_data_engine_python_spark_images" +sidebar_current: "docs-tencentcloud-datasource-dlc_describe_data_engine_python_spark_images" +description: |- + Use this data source to query detailed information of dlc describe_data_engine_python_spark_images +--- + +# tencentcloud_dlc_describe_data_engine_python_spark_images + +Use this data source to query detailed information of dlc describe_data_engine_python_spark_images + +## Example Usage + +```hcl +data "tencentcloud_dlc_describe_data_engine_python_spark_images" "describe_data_engine_python_spark_images" { + child_image_version_id = "d3ftghd4-9a7e-4f64-a3f4-f38507c69742" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `child_image_version_id` - (Required, String) Engine Image version id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `python_spark_images` - Pyspark image list. + * `child_image_version_id` - Engine Image version id. + * `create_time` - Spark image create time. + * `description` - Spark image description information. + * `spark_image_id` - Spark image unique id. + * `spark_image_version` - Spark image name. + * `update_time` - Spark image update time. + + diff --git a/config/docs/d/dlc_describe_engine_usage_info.html.markdown b/config/docs/d/dlc_describe_engine_usage_info.html.markdown new file mode 100644 index 0000000..03e34b1 --- /dev/null +++ b/config/docs/d/dlc_describe_engine_usage_info.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_describe_engine_usage_info" +sidebar_current: "docs-tencentcloud-datasource-dlc_describe_engine_usage_info" +description: |- + Use this data source to query detailed information of dlc describe_engine_usage_info +--- + +# tencentcloud_dlc_describe_engine_usage_info + +Use this data source to query detailed information of dlc describe_engine_usage_info + +## Example Usage + +```hcl +data "tencentcloud_dlc_describe_engine_usage_info" "describe_engine_usage_info" { + data_engine_id = "DataEngine-g5ds87d8" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_id` - (Required, String) Engine unique id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `available` - Remaining cluster specifications. +* `used` - Engine specifications occupied. + + diff --git a/config/docs/d/dlc_describe_updatable_data_engines.html.markdown b/config/docs/d/dlc_describe_updatable_data_engines.html.markdown new file mode 100644 index 0000000..75d1c7c --- /dev/null +++ b/config/docs/d/dlc_describe_updatable_data_engines.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_describe_updatable_data_engines" +sidebar_current: "docs-tencentcloud-datasource-dlc_describe_updatable_data_engines" +description: |- + Use this data source to query detailed information of dlc describe_updatable_data_engines +--- + +# tencentcloud_dlc_describe_updatable_data_engines + +Use this data source to query detailed information of dlc describe_updatable_data_engines + +## Example Usage + +```hcl +data "tencentcloud_dlc_describe_updatable_data_engines" "describe_updatable_data_engines" { + data_engine_config_command = "UpdateSparkSQLLakefsPath" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_config_command` - (Required, String) Engine configuration operation command, UpdateSparkSQLLakefsPath updates the managed table path, UpdateSparkSQLResultPath updates the result bucket path. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data_engine_basic_infos` - Engine basic information. + * `app_id` - User unique ID. + * `create_time` - Create time. + * `data_engine_id` - Engine unique id. + * `data_engine_name` - Engine name. + * `data_engine_type` - Engine type, valid values: PrestoSQL/SparkSQL/SparkBatch. + * `message` - Returned messages. + * `state` - Engine state, only support: 0:Init/-1:Failed/-2:Deleted/1:Pause/2:Running/3:ToBeDelete/4:Deleting. + * `update_time` - Update time. + * `user_uin` - User unique uin. + + diff --git a/config/docs/d/dlc_describe_user_info.html.markdown b/config/docs/d/dlc_describe_user_info.html.markdown new file mode 100644 index 0000000..92b66f4 --- /dev/null +++ b/config/docs/d/dlc_describe_user_info.html.markdown @@ -0,0 +1,120 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_describe_user_info" +sidebar_current: "docs-tencentcloud-datasource-dlc_describe_user_info" +description: |- + Use this data source to query detailed information of dlc describe_user_info +--- + +# tencentcloud_dlc_describe_user_info + +Use this data source to query detailed information of dlc describe_user_info + +## Example Usage + +```hcl +data "tencentcloud_dlc_describe_user_info" "describe_user_info" { + user_id = "100032772113" + type = "Group" + sort_by = "create-time" + sorting = "desc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Query filter conditions. when type is Group, fuzzy search with Key as workgroup-name is supported. when type is DataAuth, key is supported. policy-type: permission type, policy-source: data source, data-name: database table. Fuzzy search, when type is EngineAuth, supports fuzzy search of key, policy-type: permission type, policy-source: data source, engine-name: library table. +* `result_output_file` - (Optional, String) Used to save results. +* `sort_by` - (Optional, String) Sorting field, when type is Group, support create-time, group-name, when type is DataAuth, support create-time, when type is EngineAuth, support create-time. +* `sorting` - (Optional, String) Sorting method, desc means forward order, asc means reverse order, the default is asc. +* `type` - (Optional, String) Query information type, Group: work group DataAuth: data permission EngineAuth: engine permission. +* `user_id` - (Optional, String) User id, the same as the sub-user uin. + +The `filters` object supports the following: + +* `name` - (Required, String) Attribute name. If there are multiple Filters, the relationship between Filters is a logical OR (OR) relationship. +* `values` - (Required, Set) Attribute value, if there are multiple Values in the same filter, the relationship between values under the same filter is a logical OR relationship. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `user_info` - User details. + * `data_policy_info` - Data permission information collection. + * `policy_set` - Policy set. + * `catalog` - For the data source name that requires authorization, only * (representing all resources at this level) is supported under the administrator level; in the case of data source level and database level authentication, only COSDataCatalog or * is supported; in data table level authentication, it is possible Fill in the user-defined data source. If left blank, it defaults to DataLakeCatalog. note: If a user-defined data source is authenticated, the permissions that dlc can manage are a subset of the accounts provided by the user when accessing the data source. + * `column` - For columns that require authorization, fill in * to represent all current columns. When the authorization type is administrator level, only * is allowed. + * `create_time` - The time when the permission was created. Leave the input parameter blank. + * `data_engine` - Data engines that require authorization, fill in * to represent all current engines. when the authorization type is administrator level, only * is allowed. + * `database` - Database name that requires authorization, fill in * to represent all databases under the current catalog. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level, only blanks are allowed to be filled in. For other types, the database can be specified arbitrarily. + * `function` - For the function name that requires authorization, fill in * to represent all functions under the current catalog. when the authorization type is administrator level, only * is allowed to be filled in. When the authorization type is data connection level, only blanks are allowed to be filled in. in other types, functions can be specified arbitrarily. + * `id` - Policy id. + * `mode` - Authorization mode, please leave this parameter blank. COMMON: normal mode; SENIOR: advanced mode. + * `operation` - Authorized permission operations provide different operations for different levels of authentication. administrator permissions: ALL, default is ALL if left blank; data connection level authentication: CREATE; database level authentication: ALL, CREATE, ALTER, DROP; data table permissions: ALL, SELECT, INSERT, ALTER, DELETE, DROP, UPDATE. note: under data table permissions, only SELECT operations are supported when the specified data source is not COSDataCatalog. + * `operator` - Operator, do not fill in the input parameters. + * `policy_type` - Authorization type, currently supports eight authorization types: ADMIN: Administrator level authentication DATASOURCE: data connection level authentication DATABASE: database level authentication TABLE: Table level authentication VIEW: view level authentication FUNCTION: Function level authentication COLUMN: Column level authentication ENGINE: Data engine authentication. if left blank, the default is administrator level authentication. + * `re_auth` - Whether the user can perform secondary authorization. when it is true, the authorized user can re-authorize the permissions obtained this time to other sub-users. default is false. + * `source_id` - The id of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the Source field is WORKGROUP. + * `source_name` - The name of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the source field is WORKGROUP. + * `source` - Permission source, please leave it blank. USER: permissions come from the user itself; WORKGROUP: permissions come from the bound workgroup. + * `table` - For the table name that requires authorization, fill in * to represent all tables under the current database. when the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. For other types, data tables can be specified arbitrarily. + * `view` - For views that require authorization, fill in * to represent all views under the current database. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. for other types, the view can be specified arbitrarily. + * `total_count` - Total count. + * `engine_policy_info` - Engine permission collection. + * `policy_set` - Policy set. + * `catalog` - For the data source name that requires authorization, only * (representing all resources at this level) is supported under the administrator level; in the case of data source level and database level authentication, only COSDataCatalog or * is supported; in data table level authentication, it is possible Fill in the user-defined data source. If left blank, it defaults to DataLakeCatalog. note: If a user-defined data source is authenticated, the permissions that dlc can manage are a subset of the accounts provided by the user when accessing the data source. + * `column` - For columns that require authorization, fill in * to represent all current columns. When the authorization type is administrator level, only * is allowed. + * `create_time` - The time when the permission was created. Leave the input parameter blank. + * `data_engine` - Data engines that require authorization, fill in * to represent all current engines. when the authorization type is administrator level, only * is allowed. + * `database` - Database name that requires authorization, fill in * to represent all databases under the current catalog. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level, only blanks are allowed to be filled in. For other types, the database can be specified arbitrarily. + * `function` - For the function name that requires authorization, fill in * to represent all functions under the current catalog. when the authorization type is administrator level, only * is allowed to be filled in. When the authorization type is data connection level, only blanks are allowed to be filled in. in other types, functions can be specified arbitrarily. + * `id` - Policy id. + * `mode` - Authorization mode, please leave this parameter blank. COMMON: normal mode; SENIOR: advanced mode. + * `operation` - Authorized permission operations provide different operations for different levels of authentication. administrator permissions: ALL, default is ALL if left blank; data connection level authentication: CREATE; database level authentication: ALL, CREATE, ALTER, DROP; data table permissions: ALL, SELECT, INSERT, ALTER, DELETE, DROP, UPDATE. note: under data table permissions, only SELECT operations are supported when the specified data source is not COSDataCatalog. + * `operator` - Operator, do not fill in the input parameters. + * `policy_type` - Authorization type, currently supports eight authorization types: ADMIN: Administrator level authentication DATASOURCE: data connection level authentication DATABASE: database level authentication TABLE: Table level authentication VIEW: view level authentication FUNCTION: Function level authentication COLUMN: Column level authentication ENGINE: Data engine authentication. if left blank, the default is administrator level authentication. + * `re_auth` - Whether the user can perform secondary authorization. when it is true, the authorized user can re-authorize the permissions obtained this time to other sub-users. default is false. + * `source_id` - The id of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the Source field is WORKGROUP. + * `source_name` - The name of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the source field is WORKGROUP. + * `source` - Permission source, please leave it blank. USER: permissions come from the user itself; WORKGROUP: permissions come from the bound workgroup. + * `table` - For the table name that requires authorization, fill in * to represent all tables under the current database. when the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. For other types, data tables can be specified arbitrarily. + * `view` - For views that require authorization, fill in * to represent all views under the current database. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. for other types, the view can be specified arbitrarily. + * `total_count` - Total count. + * `row_filter_info` - Row filter collection. + * `policy_set` - Policy set. + * `catalog` - For the data source name that requires authorization, only * (representing all resources at this level) is supported under the administrator level; in the case of data source level and database level authentication, only COSDataCatalog or * is supported; in data table level authentication, it is possible Fill in the user-defined data source. If left blank, it defaults to DataLakeCatalog. note: If a user-defined data source is authenticated, the permissions that dlc can manage are a subset of the accounts provided by the user when accessing the data source. + * `column` - For columns that require authorization, fill in * to represent all current columns. When the authorization type is administrator level, only * is allowed. + * `create_time` - The time when the permission was created. Leave the input parameter blank. + * `data_engine` - Data engines that require authorization, fill in * to represent all current engines. when the authorization type is administrator level, only * is allowed. + * `database` - Database name that requires authorization, fill in * to represent all databases under the current catalog. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level, only blanks are allowed to be filled in. For other types, the database can be specified arbitrarily. + * `function` - For the function name that requires authorization, fill in * to represent all functions under the current catalog. when the authorization type is administrator level, only * is allowed to be filled in. When the authorization type is data connection level, only blanks are allowed to be filled in. in other types, functions can be specified arbitrarily. + * `id` - Policy id. + * `mode` - Authorization mode, please leave this parameter blank. COMMON: normal mode; SENIOR: advanced mode. + * `operation` - Authorized permission operations provide different operations for different levels of authentication. administrator permissions: ALL, default is ALL if left blank; data connection level authentication: CREATE; database level authentication: ALL, CREATE, ALTER, DROP; data table permissions: ALL, SELECT, INSERT, ALTER, DELETE, DROP, UPDATE. note: under data table permissions, only SELECT operations are supported when the specified data source is not COSDataCatalog. + * `operator` - Operator, do not fill in the input parameters. + * `policy_type` - Authorization type, currently supports eight authorization types: ADMIN: Administrator level authentication DATASOURCE: data connection level authentication DATABASE: database level authentication TABLE: Table level authentication VIEW: view level authentication FUNCTION: Function level authentication COLUMN: Column level authentication ENGINE: Data engine authentication. if left blank, the default is administrator level authentication. + * `re_auth` - Whether the user can perform secondary authorization. when it is true, the authorized user can re-authorize the permissions obtained this time to other sub-users. default is false. + * `source_id` - The id of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the Source field is WORKGROUP. + * `source_name` - The name of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the source field is WORKGROUP. + * `source` - Permission source, please leave it blank. USER: permissions come from the user itself; WORKGROUP: permissions come from the bound workgroup. + * `table` - For the table name that requires authorization, fill in * to represent all tables under the current database. when the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. For other types, data tables can be specified arbitrarily. + * `view` - For views that require authorization, fill in * to represent all views under the current database. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. for other types, the view can be specified arbitrarily. + * `total_count` - Total count. + * `type` - The type of information returned, Group: the returned workgroup information of the current user; DataAuth: the returned data permission information of the current user; EngineAuth: the returned engine permission information of the current user. + * `user_alias` - User alias. + * `user_description` - User description. + * `user_id` - User id, the same as the sub-user uin. + * `user_type` - User type: ADMIN: Administrator COMMON: General user. + * `work_group_info` - Workgroup collection information bound to this user. + * `total_count` - Total count. + * `work_group_set` - Work group set. + * `create_time` - The time the workgroup was created. + * `creator` - Creator. + * `work_group_description` - Work group description. + * `work_group_id` - Work group unique id. + * `work_group_name` - Work group name. + + diff --git a/config/docs/d/dlc_describe_user_roles.html.markdown b/config/docs/d/dlc_describe_user_roles.html.markdown new file mode 100644 index 0000000..bd144bf --- /dev/null +++ b/config/docs/d/dlc_describe_user_roles.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_describe_user_roles" +sidebar_current: "docs-tencentcloud-datasource-dlc_describe_user_roles" +description: |- + Use this data source to query detailed information of dlc describe_user_roles +--- + +# tencentcloud_dlc_describe_user_roles + +Use this data source to query detailed information of dlc describe_user_roles + +## Example Usage + +```hcl +data "tencentcloud_dlc_describe_user_roles" "describe_user_roles" { + fuzzy = "1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `fuzzy` - (Optional, String) List according to ARN blur. +* `result_output_file` - (Optional, String) Used to save results. +* `sort_by` - (Optional, String) The return results are sorted according to this field. +* `sorting` - (Optional, String) Positive or inverted, such as DESC. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `user_roles` - User role information. + * `app_id` - User app ID. + * `arn` - Role Permissions. + * `cos_permission_list` - COS authorization path listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cos_path` - COS pathNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `permissions` - Permissions [Read, WRITE]Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `creator` - Creator UinNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `desc` - Character description information. + * `modify_time` - Recently modify the time stamp. + * `permission_json` - CAM strategy jsonNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `role_id` - Character ID. + * `role_name` - Role NameNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `uin` - User ID. + + diff --git a/config/docs/d/dlc_describe_user_type.html.markdown b/config/docs/d/dlc_describe_user_type.html.markdown new file mode 100644 index 0000000..49708f3 --- /dev/null +++ b/config/docs/d/dlc_describe_user_type.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_describe_user_type" +sidebar_current: "docs-tencentcloud-datasource-dlc_describe_user_type" +description: |- + Use this data source to query detailed information of dlc describe_user_type +--- + +# tencentcloud_dlc_describe_user_type + +Use this data source to query detailed information of dlc describe_user_type + +## Example Usage + +```hcl +data "tencentcloud_dlc_describe_user_type" "describe_user_type" { + user_id = "127382378" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `user_id` - (Optional, String) User id (uin), if left blank, it defaults to the caller's sub-uin. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `user_type` - User type, only support: ADMIN: ddministrator/COMMON: ordinary user. + + diff --git a/config/docs/d/dlc_describe_work_group_info.html.markdown b/config/docs/d/dlc_describe_work_group_info.html.markdown new file mode 100644 index 0000000..7b0f096 --- /dev/null +++ b/config/docs/d/dlc_describe_work_group_info.html.markdown @@ -0,0 +1,119 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_describe_work_group_info" +sidebar_current: "docs-tencentcloud-datasource-dlc_describe_work_group_info" +description: |- + Use this data source to query detailed information of dlc describe_work_group_info +--- + +# tencentcloud_dlc_describe_work_group_info + +Use this data source to query detailed information of dlc describe_work_group_info + +## Example Usage + +```hcl +data "tencentcloud_dlc_describe_work_group_info" "describe_work_group_info" { + work_group_id = 23181 + type = "User" + sort_by = "create-time" + sorting = "desc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Query filter conditions. when Type is User, fuzzy search with Key as user-name is supported; when Type is DataAuth, key is supported; policy-type: permission type; policy-source: data source; data-name: database table fuzzy search; when Type is EngineAuth, supports key; policy-type: permission type; policy-source: data source; engine-name: fuzzy search of library tables. +* `result_output_file` - (Optional, String) Used to save results. +* `sort_by` - (Optional, String) Sorting fields, when Type is User, support create-time, user-name, when type is DataAuth, support create-time, when type is EngineAuth, support create-time. +* `sorting` - (Optional, String) Sorting method, desc means forward order, asc means reverse order, the default is asc. +* `type` - (Optional, String) Query information type, only support: User: user information/DataAuth: data permission/EngineAuth: engine permission. +* `work_group_id` - (Optional, Int) Work group id. + +The `filters` object supports the following: + +* `name` - (Required, String) Attribute name. If there are multiple Filters, the relationship between filters is a logical or (OR) relationship. +* `values` - (Required, Set) Attribute value, if there are multiple values in the same filter, the relationship between values under the same filter is a logical or relationship. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `work_group_info` - Workgroup details. + * `data_policy_info` - Data permission collection. + * `policy_set` - Policy set. + * `catalog` - For the data source name that requires authorization, only * (representing all resources at this level) is supported under the administrator level; in the case of data source level and database level authentication, only COSDataCatalog or * is supported; in data table level authentication, it is possible Fill in the user-defined data source. If left blank, it defaults to DataLakeCatalog. note: If a user-defined data source is authenticated, the permissions that dlc can manage are a subset of the accounts provided by the user when accessing the data source. + * `column` - For columns that require authorization, fill in * to represent all current columns. When the authorization type is administrator level, only * is allowed. + * `create_time` - The time when the permission was created. Leave the input parameter blank. + * `data_engine` - Data engines that require authorization, fill in * to represent all current engines. when the authorization type is administrator level, only * is allowed. + * `database` - Database name that requires authorization, fill in * to represent all databases under the current catalog. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level, only blanks are allowed to be filled in. For other types, the database can be specified arbitrarily. + * `function` - For the function name that requires authorization, fill in * to represent all functions under the current catalog. when the authorization type is administrator level, only * is allowed to be filled in. When the authorization type is data connection level, only blanks are allowed to be filled in. in other types, functions can be specified arbitrarily. + * `id` - Policy id. + * `mode` - Authorization mode, please leave this parameter blank. COMMON: normal mode; SENIOR: advanced mode. + * `operation` - Authorized permission operations provide different operations for different levels of authentication. administrator permissions: ALL, default is ALL if left blank; data connection level authentication: CREATE; database level authentication: ALL, CREATE, ALTER, DROP; data table permissions: ALL, SELECT, INSERT, ALTER, DELETE, DROP, UPDATE. note: under data table permissions, only SELECT operations are supported when the specified data source is not COSDataCatalog. + * `operator` - Operator, do not fill in the input parameters. + * `policy_type` - Authorization type, currently supports eight authorization types: ADMIN: Administrator level authentication DATASOURCE: data connection level authentication DATABASE: database level authentication TABLE: Table level authentication VIEW: view level authentication FUNCTION: Function level authentication COLUMN: Column level authentication ENGINE: Data engine authentication. if left blank, the default is administrator level authentication. + * `re_auth` - Whether the user can perform secondary authorization. when it is true, the authorized user can re-authorize the permissions obtained this time to other sub-users. default is false. + * `source_id` - The id of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the Source field is WORKGROUP. + * `source_name` - The name of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the source field is WORKGROUP. + * `source` - Permission source, please leave it blank. USER: permissions come from the user itself; WORKGROUP: permissions come from the bound workgroup. + * `table` - For the table name that requires authorization, fill in * to represent all tables under the current database. when the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. For other types, data tables can be specified arbitrarily. + * `view` - For views that require authorization, fill in * to represent all views under the current database. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. for other types, the view can be specified arbitrarily. + * `total_count` - Total count. + * `engine_policy_info` - Engine permission collection. + * `policy_set` - Policy set. + * `catalog` - For the data source name that requires authorization, only * (representing all resources at this level) is supported under the administrator level; in the case of data source level and database level authentication, only COSDataCatalog or * is supported; in data table level authentication, it is possible Fill in the user-defined data source. If left blank, it defaults to DataLakeCatalog. note: If a user-defined data source is authenticated, the permissions that dlc can manage are a subset of the accounts provided by the user when accessing the data source. + * `column` - For columns that require authorization, fill in * to represent all current columns. When the authorization type is administrator level, only * is allowed. + * `create_time` - The time when the permission was created. Leave the input parameter blank. + * `data_engine` - Data engines that require authorization, fill in * to represent all current engines. when the authorization type is administrator level, only * is allowed. + * `database` - Database name that requires authorization, fill in * to represent all databases under the current catalog. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level, only blanks are allowed to be filled in. For other types, the database can be specified arbitrarily. + * `function` - For the function name that requires authorization, fill in * to represent all functions under the current catalog. when the authorization type is administrator level, only * is allowed to be filled in. When the authorization type is data connection level, only blanks are allowed to be filled in. in other types, functions can be specified arbitrarily. + * `id` - Policy id. + * `mode` - Authorization mode, please leave this parameter blank. COMMON: normal mode; SENIOR: advanced mode. + * `operation` - Authorized permission operations provide different operations for different levels of authentication. administrator permissions: ALL, default is ALL if left blank; data connection level authentication: CREATE; database level authentication: ALL, CREATE, ALTER, DROP; data table permissions: ALL, SELECT, INSERT, ALTER, DELETE, DROP, UPDATE. note: under data table permissions, only SELECT operations are supported when the specified data source is not COSDataCatalog. + * `operator` - Operator, do not fill in the input parameters. + * `policy_type` - Authorization type, currently supports eight authorization types: ADMIN: Administrator level authentication DATASOURCE: data connection level authentication DATABASE: database level authentication TABLE: Table level authentication VIEW: view level authentication FUNCTION: Function level authentication COLUMN: Column level authentication ENGINE: Data engine authentication. if left blank, the default is administrator level authentication. + * `re_auth` - Whether the user can perform secondary authorization. when it is true, the authorized user can re-authorize the permissions obtained this time to other sub-users. default is false. + * `source_id` - The id of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the Source field is WORKGROUP. + * `source_name` - The name of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the source field is WORKGROUP. + * `source` - Permission source, please leave it blank. USER: permissions come from the user itself; WORKGROUP: permissions come from the bound workgroup. + * `table` - For the table name that requires authorization, fill in * to represent all tables under the current database. when the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. For other types, data tables can be specified arbitrarily. + * `view` - For views that require authorization, fill in * to represent all views under the current database. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. for other types, the view can be specified arbitrarily. + * `total_count` - Total count. + * `row_filter_info` - Row filter information collection. + * `policy_set` - Policy set. + * `catalog` - For the data source name that requires authorization, only * (representing all resources at this level) is supported under the administrator level; in the case of data source level and database level authentication, only COSDataCatalog or * is supported; in data table level authentication, it is possible Fill in the user-defined data source. If left blank, it defaults to DataLakeCatalog. note: If a user-defined data source is authenticated, the permissions that dlc can manage are a subset of the accounts provided by the user when accessing the data source. + * `column` - For columns that require authorization, fill in * to represent all current columns. When the authorization type is administrator level, only * is allowed. + * `create_time` - The time when the permission was created. Leave the input parameter blank. + * `data_engine` - Data engines that require authorization, fill in * to represent all current engines. when the authorization type is administrator level, only * is allowed. + * `database` - Database name that requires authorization, fill in * to represent all databases under the current catalog. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level, only blanks are allowed to be filled in. For other types, the database can be specified arbitrarily. + * `function` - For the function name that requires authorization, fill in * to represent all functions under the current catalog. when the authorization type is administrator level, only * is allowed to be filled in. When the authorization type is data connection level, only blanks are allowed to be filled in. in other types, functions can be specified arbitrarily. + * `id` - Policy id. + * `mode` - Authorization mode, please leave this parameter blank. COMMON: normal mode; SENIOR: advanced mode. + * `operation` - Authorized permission operations provide different operations for different levels of authentication. administrator permissions: ALL, default is ALL if left blank; data connection level authentication: CREATE; database level authentication: ALL, CREATE, ALTER, DROP; data table permissions: ALL, SELECT, INSERT, ALTER, DELETE, DROP, UPDATE. note: under data table permissions, only SELECT operations are supported when the specified data source is not COSDataCatalog. + * `operator` - Operator, do not fill in the input parameters. + * `policy_type` - Authorization type, currently supports eight authorization types: ADMIN: Administrator level authentication DATASOURCE: data connection level authentication DATABASE: database level authentication TABLE: Table level authentication VIEW: view level authentication FUNCTION: Function level authentication COLUMN: Column level authentication ENGINE: Data engine authentication. if left blank, the default is administrator level authentication. + * `re_auth` - Whether the user can perform secondary authorization. when it is true, the authorized user can re-authorize the permissions obtained this time to other sub-users. default is false. + * `source_id` - The id of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the Source field is WORKGROUP. + * `source_name` - The name of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the source field is WORKGROUP. + * `source` - Permission source, please leave it blank. USER: permissions come from the user itself; WORKGROUP: permissions come from the bound workgroup. + * `table` - For the table name that requires authorization, fill in * to represent all tables under the current database. when the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. For other types, data tables can be specified arbitrarily. + * `view` - For views that require authorization, fill in * to represent all views under the current database. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. for other types, the view can be specified arbitrarily. + * `total_count` - Total count. + * `type` - The type of information contained. User: user information; DataAuth: data permissions; EngineAuth: engine permissions. + * `user_info` - A collection of users bound to the workgroup. + * `total_count` - Total count. + * `user_set` - User information collection. + * `create_time` - Create time. + * `creator` - The creator of the current user. + * `user_alias` - User alias. + * `user_description` - User description. + * `user_id` - User id, matches the CAM side sub-user uin. + * `work_group_description` - Workgroup description information. + * `work_group_id` - Work group id. + * `work_group_name` - Work group name. + + diff --git a/config/docs/d/dnats.html.markdown b/config/docs/d/dnats.html.markdown new file mode 100644 index 0000000..52b18ac --- /dev/null +++ b/config/docs/d/dnats.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnats" +sidebar_current: "docs-tencentcloud-datasource-dnats" +description: |- + Use this data source to query detailed information of DNATs. +--- + +# tencentcloud_dnats + +Use this data source to query detailed information of DNATs. + +## Example Usage + +```hcl +# query by nat gateway id +data "tencentcloud_dnats" "foo" { + nat_id = "nat-xfaq1" +} + +# query by vpc id +data "tencentcloud_dnats" "foo" { + vpc_id = "vpc-xfqag" +} + +# query by elastic ip +data "tencentcloud_dnats" "foo" { + elastic_ip = "123.207.115.136" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `description` - (Optional, String) Description of the NAT forward. +* `elastic_ip` - (Optional, String) Network address of the EIP. +* `elastic_port` - (Optional, String) Port of the EIP. +* `nat_id` - (Optional, String) ID of the NAT gateway. +* `private_ip` - (Optional, String) Network address of the backend service. +* `private_port` - (Optional, String) Port of intranet. +* `result_output_file` - (Optional, String) Used to save results. +* `vpc_id` - (Optional, String) ID of the VPC. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `dnat_list` - Information list of the DNATs. + * `elastic_ip` - Network address of the EIP. + * `elastic_port` - Port of the EIP. + * `nat_id` - ID of the NAT. + * `private_ip` - Network address of the backend service. + * `private_port` - Port of intranet. + * `protocol` - Type of the network protocol. Valid values: `TCP` and `UDP`. + * `vpc_id` - ID of the VPC. + + diff --git a/config/docs/d/dnspod_domain_analytics.html.markdown b/config/docs/d/dnspod_domain_analytics.html.markdown new file mode 100644 index 0000000..9c7aa38 --- /dev/null +++ b/config/docs/d/dnspod_domain_analytics.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_domain_analytics" +sidebar_current: "docs-tencentcloud-datasource-dnspod_domain_analytics" +description: |- + Use this data source to query detailed information of dnspod domain_analytics +--- + +# tencentcloud_dnspod_domain_analytics + +Use this data source to query detailed information of dnspod domain_analytics + +## Example Usage + +```hcl +data "tencentcloud_dnspod_domain_analytics" "domain_analytics" { + domain = "dnspod.cn" + start_date = "2023-10-07" + end_date = "2023-10-12" + dns_format = "HOUR" + # domain_id = 123 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) The domain name to query for resolution volume. +* `end_date` - (Required, String) The end date of the query, format: YYYY-MM-DD. +* `start_date` - (Required, String) The start date of the query, format: YYYY-MM-DD. +* `dns_format` - (Optional, String) DATE: Statistics by day dimension HOUR: Statistics by hour dimension. +* `domain_id` - (Optional, Int) Domain ID. The parameter DomainId has a higher priority than the parameter Domain. If the parameter DomainId is passed, the parameter Domain will be ignored. You can find all Domains and DomainIds through the DescribeDomainList interface. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `alias_data` - Domain alias resolution volume statistics information. + * `data` - Subtotal of resolution volume for the current statistical dimension. + * `date_key` - For daily statistics, it is the statistical date. + * `hour_key` - For hourly statistics, it is the hour of the current time (0-23), for example, when HourKey is 23, the statistical period is the resolution volume from 22:00 to 23:00. Note: This field may return null, indicating that no valid value can be obtained. + * `num` - Subtotal of resolution volume for the current statistical dimension. + * `info` - Domain resolution volume statistics query information. + * `dns_format` - DATE: Statistics by day dimension HOUR: Statistics by hour dimension. + * `dns_total` - Total resolution volume for the current statistical period. + * `domain` - The domain name currently being queried. + * `end_date` - End time of the current statistical period. + * `start_date` - Start time of the current statistical period. +* `data` - Subtotal of resolution volume for the current statistical dimension. + * `date_key` - For daily statistics, it is the statistical date. + * `hour_key` - For hourly statistics, it is the hour of the current time (0-23), for example, when HourKey is 23, the statistical period is the resolution volume from 22:00 to 23:00. Note: This field may return null, indicating that no valid value can be obtained. + * `num` - Subtotal of resolution volume for the current statistical dimension. +* `info` - Domain resolution volume statistics query information. + * `dns_format` - DATE: Statistics by day dimension HOUR: Statistics by hour dimension. + * `dns_total` - Total resolution volume for the current statistical period. + * `domain` - The domain name currently being queried. + * `end_date` - End time of the current statistical period. + * `start_date` - Start time of the current statistical period. + + diff --git a/config/docs/d/dnspod_domain_list.html.markdown b/config/docs/d/dnspod_domain_list.html.markdown new file mode 100644 index 0000000..c73c836 --- /dev/null +++ b/config/docs/d/dnspod_domain_list.html.markdown @@ -0,0 +1,94 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_domain_list" +sidebar_current: "docs-tencentcloud-datasource-dnspod_domain_list" +description: |- + Use this data source to query detailed information of dnspod domain_list +--- + +# tencentcloud_dnspod_domain_list + +Use this data source to query detailed information of dnspod domain_list + +## Example Usage + +```hcl +data "tencentcloud_dnspod_domain_list" "domain_list" { + type = "ALL" + group_id = [1] + keyword = "" + sort_field = "UPDATED_ON" + sort_type = "DESC" + status = ["PAUSE"] + package = [""] + remark = "" + updated_at_begin = "2021-05-01 03:00:00" + updated_at_end = "2024-05-10 20:00:00" + record_count_begin = 0 + record_count_end = 100 + project_id = -1 + tags { + tag_key = "created_by" + tag_value = ["terraform"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `type` - (Required, String) Get domain names based on domain group type. Available values are ALL, MINE, SHARE, RECENT. ALL: All MINE: My domain names SHARE: Domain names shared with me RECENT: Recently operated domain names. +* `group_id` - (Optional, Set: [`Int`]) Get domain names based on domain group id, which can be obtained through the GroupId field in DescribeDomain or DescribeDomainList interface. +* `keyword` - (Optional, String) Get domain names based on keywords. +* `package` - (Optional, Set: [`String`]) Get domain names based on the package, which can be obtained through the Grade field in DescribeDomain or DescribeDomainList interface. +* `project_id` - (Optional, Int) Project ID. +* `record_count_begin` - (Optional, Int) The start point of the domain name&#39;s record count query range. +* `record_count_end` - (Optional, Int) The end point of the domain name&#39;s record count query range. +* `remark` - (Optional, String) Get domain names based on remark information. +* `result_output_file` - (Optional, String) Used to save results. +* `sort_field` - (Optional, String) Sorting field. Available values are NAME, STATUS, RECORDS, GRADE, UPDATED_ON. NAME: Domain name STATUS: Domain status RECORDS: Number of records GRADE: Package level UPDATED_ON: Update time. +* `sort_type` - (Optional, String) Sorting type, ascending: ASC, descending: DESC. +* `status` - (Optional, Set: [`String`]) Get domain names based on domain status. Available values are ENABLE, LOCK, PAUSE, SPAM. ENABLE: Normal LOCK: Locked PAUSE: Paused SPAM: Banned. +* `tags` - (Optional, List) Tag description list. +* `updated_at_begin` - (Optional, String) The start time of the domain name&#39;s update time to be obtained, such as &#39;2021-05-01 03:00:00&#39;. +* `updated_at_end` - (Optional, String) The end time of the domain name&#39;s update time to be obtained, such as &#39;2021-05-10 20:00:00&#39;. + +The `tags` object supports the following: + +* `tag_key` - (Required, String) Field to be filtered. +* `tag_value` - (Required, Set) Filter value of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `domain_list` - Domain list. + * `cname_speedup` - Whether to enable CNAME acceleration, enabled: ENABLE, disabled: DISABLE. + * `created_on` - Domain addition time. + * `dns_status` - DNS settings status, error: DNSERROR, normal: empty string. + * `domain_id` - Unique identifier assigned to the domain by the system. + * `effective_dns` - Valid DNS assigned to the domain by the system. + * `grade_level` - Sequence number corresponding to the domain package level. + * `grade_title` - Package name. + * `grade` - Domain package level code. + * `group_id` - Group Id the domain belongs to. + * `is_vip` - Whether it is a paid package. + * `name` - Original format of the domain. + * `owner` - Domain owner account. + * `punycode` - Punycode encoded domain format. + * `record_count` - Number of records under the domain. + * `remark` - Domain remark description. + * `search_engine_push` - Whether to enable search engine push optimization, YES: YES, NO: NO. + * `status` - Domain status, normal: ENABLE, paused: PAUSE, banned: SPAM. + * `tag_list` - Domain-related tag list Note: This field may return null, indicating that no valid value can be obtained. + * `tag_key` - Tag key. + * `tag_value` - Tag Value. Note: This field may return null, indicating that no valid value can be obtained. + * `ttl` - Default TTL value for domain resolution records. + * `updated_on` - Domain update time. + * `vip_auto_renew` - Whether the domain has VIP auto-renewal enabled, YES: YES, NO: NO, DEFAULT: DEFAULT. + * `vip_end_at` - Paid package expiration time. + * `vip_start_at` - Paid package activation time. + + diff --git a/config/docs/d/dnspod_domain_log_list.html.markdown b/config/docs/d/dnspod_domain_log_list.html.markdown new file mode 100644 index 0000000..44e3c7f --- /dev/null +++ b/config/docs/d/dnspod_domain_log_list.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_domain_log_list" +sidebar_current: "docs-tencentcloud-datasource-dnspod_domain_log_list" +description: |- + Use this data source to query detailed information of dnspod domain_log_list +--- + +# tencentcloud_dnspod_domain_log_list + +Use this data source to query detailed information of dnspod domain_log_list + +## Example Usage + +```hcl +data "tencentcloud_dnspod_domain_log_list" "domain_log_list" { + domain = "iac-tf.cloud" + domain_id = 123 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Domain. +* `domain_id` - (Optional, Int) Domain ID. The parameter DomainId has a higher priority than the parameter Domain. If the parameter DomainId is passed, the parameter Domain will be ignored. You can find all Domains and DomainIds through the DescribeDomainList interface. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `log_list` - Domain Operation Log List. Note: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/dnspod_record_analytics.html.markdown b/config/docs/d/dnspod_record_analytics.html.markdown new file mode 100644 index 0000000..9740335 --- /dev/null +++ b/config/docs/d/dnspod_record_analytics.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_record_analytics" +sidebar_current: "docs-tencentcloud-datasource-dnspod_record_analytics" +description: |- + Use this data source to query detailed information of dnspod record_analytics +--- + +# tencentcloud_dnspod_record_analytics + +Use this data source to query detailed information of dnspod record_analytics + +## Example Usage + +```hcl +data "tencentcloud_dnspod_record_analytics" "record_analytics" { + domain = "iac-tf.cloud" + start_date = "2023-09-07" + end_date = "2023-11-07" + subdomain = "www" + dns_format = "HOUR" + # domain_id = 123 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) The domain to query for resolution volume. +* `end_date` - (Required, String) The end date of the query, format: YYYY-MM-DD. +* `start_date` - (Required, String) The start date of the query, format: YYYY-MM-DD. +* `subdomain` - (Required, String) The subdomain to query for resolution volume. +* `dns_format` - (Optional, String) DATE: Statistics by day dimension, HOUR: Statistics by hour dimension. +* `domain_id` - (Optional, Int) Domain ID. The parameter DomainId has a higher priority than the parameter Domain. If the parameter DomainId is passed, the parameter Domain will be ignored. You can find all Domains and DomainIds through the DescribeDomainList interface. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `alias_data` - Subdomain alias resolution statistics information. + * `data` - The subtotal of the resolution volume for the current statistical dimension. + * `date_key` - For daily statistics, it is the statistical date. + * `hour_key` - For hourly statistics, it is the hour of the current time for statistics (0-23), e.g., when HourKey is 23, the statistical period is the resolution volume from 22:00 to 23:00. Note: This field may return null, indicating that no valid value can be obtained. + * `num` - The subtotal of the resolution volume for the current statistical dimension. + * `info` - Subdomain resolution statistics query information. + * `dns_format` - DATE: Daily statistics, HOUR: Hourly statistics. + * `dns_total` - Total resolution count for the current statistical period. + * `domain` - The domain currently being queried. + * `end_date` - End date of the current statistical period. + * `start_date` - Start date of the current statistical period. + * `subdomain` - The subdomain currently being analyzed. +* `data` - The subtotal of the resolution volume for the current statistical dimension. + * `date_key` - For daily statistics, it is the statistical date. + * `hour_key` - For hourly statistics, it is the hour of the current time for statistics (0-23), e.g., when HourKey is 23, the statistical period is the resolution volume from 22:00 to 23:00. Note: This field may return null, indicating that no valid value can be obtained. + * `num` - The subtotal of the resolution volume for the current statistical dimension. +* `info` - Subdomain resolution statistics query information. + * `dns_format` - DATE: Daily statistics, HOUR: Hourly statistics. + * `dns_total` - Total resolution count for the current statistical period. + * `domain` - The domain currently being queried. + * `end_date` - End date of the current statistical period. + * `start_date` - Start date of the current statistical period. + * `subdomain` - The subdomain currently being analyzed. + + diff --git a/config/docs/d/dnspod_record_line_list.html.markdown b/config/docs/d/dnspod_record_line_list.html.markdown new file mode 100644 index 0000000..2830076 --- /dev/null +++ b/config/docs/d/dnspod_record_line_list.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_record_line_list" +sidebar_current: "docs-tencentcloud-datasource-dnspod_record_line_list" +description: |- + Use this data source to query detailed information of dnspod record_line_list +--- + +# tencentcloud_dnspod_record_line_list + +Use this data source to query detailed information of dnspod record_line_list + +## Example Usage + +```hcl +data "tencentcloud_dnspod_record_line_list" "record_line_list" { + domain = "iac-tf.cloud" + domain_grade = "DP_FREE" + domain_id = 123 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_grade` - (Required, String) Domain level. + Old packages: D_FREE, D_PLUS, D_EXTRA, D_EXPERT, D_ULTRA correspond to free package, personal luxury, enterprise 1, enterprise 2, enterprise 3. + New packages: DP_FREE, DP_PLUS, DP_EXTRA, DP_EXPERT, DP_ULTRA correspond to new free, personal professional, enterprise basic, enterprise standard, enterprise flagship. +* `domain` - (Required, String) Domain. +* `domain_id` - (Optional, Int) Domain ID. The parameter DomainId has a higher priority than the parameter Domain. If the parameter DomainId is passed, the parameter Domain will be ignored. You can find all Domains and DomainIds through the DescribeDomainList interface. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `line_group_list` - Line group list. + * `line_id` - Line group ID. + * `line_list` - List of lines included in the line group. + * `name` - Line group name. + * `type` - Group type. +* `line_list` - Line list. + * `line_id` - Line ID. + * `name` - Line name. + + diff --git a/config/docs/d/dnspod_record_list.html.markdown b/config/docs/d/dnspod_record_list.html.markdown new file mode 100644 index 0000000..302bbd6 --- /dev/null +++ b/config/docs/d/dnspod_record_list.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_record_list" +sidebar_current: "docs-tencentcloud-datasource-dnspod_record_list" +description: |- + Use this data source to query detailed information of dnspod record_list +--- + +# tencentcloud_dnspod_record_list + +Use this data source to query detailed information of dnspod record_list + +## Example Usage + +```hcl +data "tencentcloud_dnspod_record_list" "record_list" { + domain = "iac-tf.cloud" + # domain_id = 123 + # sub_domain = "www" + record_type = ["A", "NS", "CNAME", "NS", "AAAA"] + # record_line = [""] + group_id = [] + keyword = "" + sort_field = "UPDATED_ON" + sort_type = "DESC" + record_value = "bicycle.dnspod.net" + record_status = ["ENABLE"] + weight_begin = 0 + weight_end = 100 + mx_begin = 0 + mx_end = 10 + ttl_begin = 1 + ttl_end = 864000 + updated_at_begin = "2021-09-07" + updated_at_end = "2023-12-07" + remark = "" + is_exact_sub_domain = true + # project_id = -1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) The domain to which the resolution record belongs. +* `domain_id` - (Optional, Int) The domain ID to which the resolution record belongs. If DomainId is provided, the system will ignore the Domain parameter. You can find all Domain and DomainId through the DescribeDomainList interface. +* `group_id` - (Optional, Set: [`Int`]) When retrieving resolution records under certain groups, pass this group ID. You can obtain the GroupId field through the DescribeRecordGroupList interface. +* `is_exact_sub_domain` - (Optional, Bool) Whether to perform an exact search based on the SubDomain parameter. +* `keyword` - (Optional, String) Search for resolution records by keyword, currently supporting searching host headers and record values. +* `mx_begin` - (Optional, Int) The starting point of the resolution record MX priority query interval. +* `mx_end` - (Optional, Int) The endpoint of the resolution record MX priority query interval. +* `project_id` - (Optional, Int) Project ID. +* `record_line` - (Optional, Set: [`String`]) Retrieve resolution records for certain line IDs. You can view the allowed line information for the current domain through the DescribeRecordLineList interface. +* `record_status` - (Optional, Set: [`String`]) Get the resolution record based on the resolution record status. The possible values are ENABLE and DISABLE. ENABLE: Normal DISABLE: Paused. +* `record_type` - (Optional, Set: [`String`]) Retrieve certain types of resolution records, such as A, CNAME, NS, AAAA, explicit URL, implicit URL, CAA, SPF, etc. +* `record_value` - (Optional, String) Get the resolution record based on the resolution record value. +* `remark` - (Optional, String) Get the resolution record based on the resolution record remark. +* `result_output_file` - (Optional, String) Used to save results. +* `sort_field` - (Optional, String) Sorting field, supporting NAME, LINE, TYPE, VALUE, WEIGHT, MX, TTL, UPDATED_ON fields. NAME: The host header of the resolution record LINE: The resolution record line TYPE: The resolution record type VALUE: The resolution record value WEIGHT: The weight MX: MX priority TTL: The resolution record cache time UPDATED_ON: The resolution record update time. +* `sort_type` - (Optional, String) Sorting method, ascending: ASC, descending: DESC. The default value is ASC. +* `sub_domain` - (Optional, String) Retrieve resolution records based on the host header of the resolution record. Fuzzy matching is used by default. You can set the IsExactSubdomain parameter to true for precise searching. +* `ttl_begin` - (Optional, Int) The starting point of the resolution record TTL query interval. +* `ttl_end` - (Optional, Int) The endpoint of the resolution record TTL query interval. +* `updated_at_begin` - (Optional, String) The starting point of the resolution record update time query interval. +* `updated_at_end` - (Optional, String) The endpoint of the resolution record update time query interval. +* `weight_begin` - (Optional, Int) The starting point of the resolution record weight query interval. +* `weight_end` - (Optional, Int) The endpoint of the resolution record weight query interval. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `record_count_info` - Statistics of the number of records. + * `list_count` - Number of records returned in the list. + * `subdomain_count` - Number of subdomains. + * `total_count` - Total number of records. +* `record_list` - List of records. + * `default_ns` - Whether it is the default NS record. + * `line_id` - Line ID. + * `line` - Record line. + * `monitor_status` - Record monitoring status, normal: OK, alarm: WARN, downtime: DOWN, empty if monitoring is not set or paused. + * `mx` - MX value, only available for MX records Note: This field may return null, indicating that no valid value can be obtained. + * `name` - Host header. + * `record_id` - Record ID. + * `remark` - Record remark description. + * `status` - Record status, enabled: ENABLE, paused: DISABLE. + * `ttl` - Record cache time. + * `type` - Record type. + * `updated_on` - Update time. + * `value` - Record value. + * `weight` - Record weight, used for load balancing records. Note: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/dnspod_record_type.html.markdown b/config/docs/d/dnspod_record_type.html.markdown new file mode 100644 index 0000000..98ca42f --- /dev/null +++ b/config/docs/d/dnspod_record_type.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_record_type" +sidebar_current: "docs-tencentcloud-datasource-dnspod_record_type" +description: |- + Use this data source to query detailed information of dnspod record_type +--- + +# tencentcloud_dnspod_record_type + +Use this data source to query detailed information of dnspod record_type + +## Example Usage + +```hcl +data "tencentcloud_dnspod_record_type" "record_type" { + domain_grade = "DP_FREE" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_grade` - (Required, String) Domain level. + Old packages: D_FREE, D_PLUS, D_EXTRA, D_EXPERT, D_ULTRA correspond to free package, personal luxury, enterprise 1, enterprise 2, enterprise 3. + New packages: DP_FREE, DP_PLUS, DP_EXTRA, DP_EXPERT, DP_ULTRA correspond to new free, personal professional, enterprise basic, enterprise standard, enterprise flagship. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `type_list` - Record type list. + + diff --git a/config/docs/d/dnspod_records.html.markdown b/config/docs/d/dnspod_records.html.markdown new file mode 100644 index 0000000..a6cd63d --- /dev/null +++ b/config/docs/d/dnspod_records.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_records" +sidebar_current: "docs-tencentcloud-datasource-dnspod_records" +description: |- + Use this data source to query dnspod record list. +--- + +# tencentcloud_dnspod_records + +Use this data source to query dnspod record list. + +## Example Usage + +```hcl +data "tencentcloud_dnspod_records" "record" { + domain = "example.com" + subdomain = "www" +} + +output "result" { + value = data.tencentcloud_dnspod_records.record.result +} +``` + +### Use verbose filter + +```hcl +data "tencentcloud_dnspod_records" "record" { + domain = "example.com" + subdomain = "www" + limit = 100 + record_type = "TXT" + sort_field = "updated_on" + sort_type = "DESC" +} + +output "result" { + value = data.tencentcloud_dnspod_records.record.result +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_id` - (Optional, String) The ID of the domain for which DNS records are to be obtained. If DomainId is passed in, the system will omit the parameter domain. +* `domain` - (Optional, String) The domain for which DNS records are to be obtained. +* `group_id` - (Optional, String) The group ID. +* `keyword` - (Optional, String) The keyword for searching for DNS records. Host headers and record values are supported. +* `limit` - (Optional, Int) The limit. It defaults to 100 and can be up to 3,000. +* `offset` - (Optional, Int) The offset. Default value: 0. +* `record_line_id` - (Optional, String) The split zone ID. If `record_line_id` is passed in, the system will omit the parameter `record_line`. +* `record_line` - (Optional, String) The split zone name. +* `record_type` - (Optional, String) The type of DNS record, such as A, CNAME, NS, AAAA, explicit URL, implicit URL, CAA, or SPF record. +* `result_output_file` - (Optional, String) Used for store query result as JSON. +* `sort_field` - (Optional, String) The sorting field. Available values: name, line, type, value, weight, mx, and ttl,updated_on. +* `sort_type` - (Optional, String) The sorting type. Valid values: ASC (ascending, default), DESC (descending). +* `subdomain` - (Optional, String) The host header of a DNS record. If this parameter is passed in, only the DNS record corresponding to this host header will be returned. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `record_count_info` - Count info of the queried record list. + * `list_count` - The count of records returned in the list. + * `subdomain_count` - The subdomain count. + * `total_count` - The total record count. +* `result` - The record list result. + * `line_id` - The split zone ID. + * `line` - The record split zone. + * `monitor_status` - The monitoring status of the record. Valid values: OK (normal), WARN (warning), and DOWN (downtime). It is empty if no monitoring is set or the monitoring is suspended. + * `mx` - The MX value, applicable to the MX record only. +Note: This field may return null, indicating that no valid values can be obtained. + * `name` - The host name. + * `record_id` - Record ID. + * `remark` - The record remarks. + * `status` - The record status. Valid values: ENABLE (enabled), DISABLE (disabled). + * `ttl` - The record cache time. + * `type` - The record type. + * `updated_on` - The update time. + * `value` - The record value. + * `weight` - The record weight, which is required for round-robin DNS records. + + diff --git a/config/docs/d/domains.html.markdown b/config/docs/d/domains.html.markdown new file mode 100644 index 0000000..332d68d --- /dev/null +++ b/config/docs/d/domains.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Domain" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_domains" +sidebar_current: "docs-tencentcloud-datasource-domains" +description: |- + Provide a datasource to query Domains. +--- + +# tencentcloud_domains + +Provide a datasource to query Domains. + +## Example Usage + +```hcl +data "tencentcloud_domains" "foo" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `limit` - (Optional, Int) Specify data limit in range [1, 100]. Default: 20. +* `offset` - (Optional, Int) Specify data offset. Default: 0. +* `result_output_file` - (Optional, String) Used for save response as file locally. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - Domain result list. + * `auto_renew` - Whether the domain auto renew, 0 - manual renew, 1 - auto renew. + * `buy_status` - Domain buy status. + * `code_tld` - Domain code ltd. + * `creation_date` - Domain create time. + * `domain_id` - Domain ID. + * `domain_name` - Domain name. + * `expiration_date` - Domain expiration date. + * `is_premium` - Whether the domain is premium. + * `tld` - Domain ltd. + + diff --git a/config/docs/d/dts_compare_tasks.html.markdown b/config/docs/d/dts_compare_tasks.html.markdown new file mode 100644 index 0000000..a3b3541 --- /dev/null +++ b/config/docs/d/dts_compare_tasks.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_compare_tasks" +sidebar_current: "docs-tencentcloud-datasource-dts_compare_tasks" +description: |- + Use this data source to query detailed information of dts compareTasks +--- + +# tencentcloud_dts_compare_tasks + +Use this data source to query detailed information of dts compareTasks + +## Example Usage + +```hcl +data "tencentcloud_dts_compare_tasks" "compareTasks" { + job_id = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String) job id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - compare task list. + * `check_process` - compare check info. + * `message` - message. + * `percent` - progress info. + * `status` - status. + * `step_all` - all step counts. + * `step_now` - current step number. + * `step` - step info. + * `compare_process` - compare processing info. + * `message` - message. + * `percent` - progress info. + * `status` - status. + * `step_all` - all step counts. + * `step_now` - current step number. + * `step` - step info. + * `compare_task_id` - compare task id. + * `conclusion` - conclusion. + * `config` - config. + * `object_items` - object items. + * `object_mode` - object mode. + * `created_at` - create time. + * `finished_at` - finished time. + * `job_id` - job id. + * `started_at` - start time. + * `status` - compare task status, optional value is created/readyRun/running/success/stopping/failed/canceled. + * `task_name` - compare task name. + + diff --git a/config/docs/d/dts_migrate_db_instances.html.markdown b/config/docs/d/dts_migrate_db_instances.html.markdown new file mode 100644 index 0000000..2a5ae2f --- /dev/null +++ b/config/docs/d/dts_migrate_db_instances.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_migrate_db_instances" +sidebar_current: "docs-tencentcloud-datasource-dts_migrate_db_instances" +description: |- + Use this data source to query detailed information of dts migrate_db_instances +--- + +# tencentcloud_dts_migrate_db_instances + +Use this data source to query detailed information of dts migrate_db_instances + +## Example Usage + +```hcl +data "tencentcloud_dts_migrate_db_instances" "migrate_db_instances" { + database_type = "mysql" + migrate_role = "src" + instance_id = "cdb-ffulb2sg" + instance_name = "cdb_test" + limit = 10 + offset = 10 + account_mode = "self" + tmp_secret_id = "AKIDvBDyVmna9TadcS4YzfBZmkU5TbX12345" + tmp_secret_key = "ZswjGWWHm24qMeiX6QUJsELDpC12345" + tmp_token = "JOqqCPVuWdNZvlVDLxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `database_type` - (Required, String) Database type. +* `account_mode` - (Optional, String) The owning account of the resource is null or self(resources in the self account), other(resources in the other account). +* `instance_id` - (Optional, String) Database instance id. +* `instance_name` - (Optional, String) Database instance name. +* `limit` - (Optional, Int) Limit. +* `migrate_role` - (Optional, String) Whether the instance is the migration source or destination,src(for source), dst(for destination). +* `offset` - (Optional, Int) Offset. +* `result_output_file` - (Optional, String) Used to save results. +* `tmp_secret_id` - (Optional, String) temporary secret id, used across account. +* `tmp_secret_key` - (Optional, String) temporary secret key, used across account. +* `tmp_token` - (Optional, String) temporary token, used across account. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instances` - Instance list. + * `hint` - The reason of can't used in migration. + * `instance_id` - Instance Id. + * `instance_name` - Database instance name. + * `usable` - Can used in migration, 1-yes, 0-no. + * `vip` - Instance vip. + * `vport` - Instance port. +* `request_id` - Unique request id, provide this when encounter a problem. + + diff --git a/config/docs/d/dts_migrate_jobs.html.markdown b/config/docs/d/dts_migrate_jobs.html.markdown new file mode 100644 index 0000000..b9262e6 --- /dev/null +++ b/config/docs/d/dts_migrate_jobs.html.markdown @@ -0,0 +1,189 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_migrate_jobs" +sidebar_current: "docs-tencentcloud-datasource-dts_migrate_jobs" +description: |- + Use this data source to query detailed information of dts migrateJobs +--- + +# tencentcloud_dts_migrate_jobs + +Use this data source to query detailed information of dts migrateJobs + +## Example Usage + +```hcl +resource "tencentcloud_dts_migrate_job" "migrate_job" { + src_database_type = "mysql" + dst_database_type = "cynosdbmysql" + src_region = "ap-guangzhou" + dst_region = "ap-guangzhou" + instance_class = "small" + job_name = "tf_test_migration_job" + tags { + tag_key = "aaa" + tag_value = "bbb" + } +} + +data "tencentcloud_dts_migrate_jobs" "all" {} + +data "tencentcloud_dts_migrate_jobs" "job" { + job_id = tencentcloud_dts_migrate_job.migrate_job.id + job_name = tencentcloud_dts_migrate_job.migrate_job.job_name + status = ["created"] +} + +data "tencentcloud_dts_migrate_jobs" "src_dest" { + + src_region = "ap-guangzhou" + src_database_type = ["mysql"] + dst_region = "ap-guangzhou" + dst_database_type = ["cynosdbmysql"] + + status = ["created"] + tag_filters { + tag_key = "aaa" + tag_value = "bbb" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dst_access_type` - (Optional, Set: [`String`]) destination access type. +* `dst_database_type` - (Optional, Set: [`String`]) destination database type. +* `dst_instance_id` - (Optional, String) source instance id. +* `dst_region` - (Optional, String) destination region. +* `job_id` - (Optional, String) job id. +* `job_name` - (Optional, String) job name. +* `order_seq` - (Optional, String) order by, default by create time. +* `result_output_file` - (Optional, String) Used to save results. +* `run_mode` - (Optional, String) run mode. +* `src_access_type` - (Optional, Set: [`String`]) source access type. +* `src_database_type` - (Optional, Set: [`String`]) source database type. +* `src_instance_id` - (Optional, String) source instance id. +* `src_region` - (Optional, String) source region. +* `status` - (Optional, Set: [`String`]) migrate status. +* `tag_filters` - (Optional, List) tag filters. + +The `tag_filters` object supports the following: + +* `tag_key` - (Optional, String) tag key. +* `tag_value` - (Optional, String) tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - migration job list. + * `action` - action info. + * `all_action` - all action list. + * `allowed_action` - allowed action list. + * `brief_msg` - brief message for migrate error. + * `compare_task` - compare task info. + * `compare_task_id` - compare task id. + * `status` - status. + * `create_time` - create time. + * `dst_info` - destination info. + * `access_type` - access type. + * `database_type` - database type. + * `info` - db info. + * `account_mode` - account mode. + * `account_role` - account role. + * `account` - account. + * `ccn_gw_id` - ccn gateway id. + * `cvm_instance_id` - cvm instance id. + * `db_kernel` - database kernel. + * `engine_version` - engine version. + * `host` - host. + * `instance_id` - instance id. + * `password` - password. + * `port` - port. + * `role` - node role. + * `subnet_id` - subnet id. + * `tmp_secret_id` - temporary secret id. + * `tmp_secret_key` - temporary secret key. + * `tmp_token` - temporary token. + * `uniq_vpn_gw_id` - vpn gateway id. + * `user` - user. + * `vpc_id` - vpc id. + * `node_type` - node type. + * `region` - region. + * `end_time` - end time. + * `expect_run_time` - expected run time. + * `job_id` - job id. + * `job_name` - job name. + * `src_info` - source info. + * `access_type` - access type. + * `database_type` - database type. + * `extra_attr` - extra attributes. + * `key` - key. + * `value` - value. + * `info` - db info. + * `account_mode` - account mode. + * `account_role` - account role. + * `account` - account. + * `ccn_gw_id` - ccn gateway id. + * `cvm_instance_id` - cvm instance id. + * `db_kernel` - database kernel. + * `engine_version` - engine version. + * `host` - host. + * `instance_id` - instance id. + * `password` - password. + * `port` - port. + * `role` - node role. + * `subnet_id` - subnet id. + * `tmp_secret_id` - temporary secret id. + * `tmp_secret_key` - temporary secret key. + * `tmp_token` - temporary token. + * `uniq_vpn_gw_id` - vpn gateway id. + * `user` - user. + * `vpc_id` - vpc id. + * `node_type` - node type. + * `region` - region. + * `supplier` - supplier. + * `start_time` - start time. + * `status` - status. + * `step_info` - step info. + * `master_slave_distance` - master slave distance. + * `seconds_behind_master` - seconds behind master. + * `step_all` - number of all steps. + * `step_info` - step infos. + * `errors` - error list. + * `help_doc` - help document. + * `message` - message. + * `solution` - solution. + * `percent` - the percent of miragtion progress. + * `start_time` - start time. + * `status` - current status. + * `step_id` - step id. + * `step_message` - step message. + * `step_name` - step name. + * `step_no` - step number. + * `warnings` - warning list. + * `help_doc` - help document. + * `message` - message. + * `solution` - solution. + * `step_now` - current step. + * `tags` - tag list. + * `tag_key` - tag key. + * `tag_value` - tag value. + * `trade_info` - trade info. + * `billing_type` - billing type. + * `deal_name` - deal name. + * `expire_time` - expired time. + * `instance_class` - instance class. + * `isolate_reason` - isolate reason. + * `isolate_time` - isolate time. + * `last_deal_name` - last deal name. + * `offline_reason` - offline reason. + * `offline_time` - offline time. + * `pay_type` - pay type. + * `trade_status` - trade status. + * `update_time` - update time. + + diff --git a/config/docs/d/dts_sync_jobs.html.markdown b/config/docs/d/dts_sync_jobs.html.markdown new file mode 100644 index 0000000..edcbff9 --- /dev/null +++ b/config/docs/d/dts_sync_jobs.html.markdown @@ -0,0 +1,191 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_jobs" +sidebar_current: "docs-tencentcloud-datasource-dts_sync_jobs" +description: |- + Use this data source to query detailed information of dts syncJobs +--- + +# tencentcloud_dts_sync_jobs + +Use this data source to query detailed information of dts syncJobs + +## Example Usage + +```hcl +resource "tencentcloud_dts_sync_job" "job" { + job_name = "tf_dts_test" + pay_mode = "PostPay" + src_database_type = "mysql" + src_region = "ap-guangzhou" + dst_database_type = "cynosdbmysql" + dst_region = "ap-guangzhou" + tags { + tag_key = "aaa" + tag_value = "bbb" + } + auto_renew = 0 + instance_class = "micro" +} + +data "tencentcloud_dts_sync_jobs" "sync_jobs" { + job_id = tencentcloud_dts_sync_job.job.id + job_name = "tf_dts_test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Optional, String) job id. +* `job_name` - (Optional, String) job name. +* `job_type` - (Optional, String) job type. +* `order_seq` - (Optional, String) order way, optional value is DESC or ASC. +* `order` - (Optional, String) order field. +* `pay_mode` - (Optional, String) pay mode, optional value is PrePay or PostPay. +* `result_output_file` - (Optional, String) Used to save results. +* `run_mode` - (Optional, String) run mode, optional value is mmediate or Timed. +* `status` - (Optional, Set: [`String`]) status. +* `tag_filters` - (Optional, List) tag filters. + +The `tag_filters` object supports the following: + +* `tag_key` - (Optional, String) tag key. +* `tag_value` - (Optional, String) tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - sync job list. + * `actions` - support action list for current status. + * `all_actions` - all action list. + * `create_time` - create time. + * `detail` - tag list. + * `current_step_progress` - current step progress. + * `master_slave_distance` - master slave distance. + * `message` - message. + * `progress` - progress. + * `seconds_behind_master` - seconds behind master. + * `step_all` - total step numbers. + * `step_infos` - step infos. + * `errors` - error list. + * `code` - code. + * `help_doc` - help document. + * `message` - message. + * `solution` - solution. + * `progress` - current step progress. + * `start_time` - start time. + * `status` - current status. + * `step_id` - step id. + * `step_name` - step name. + * `step_no` - step number. + * `warnings` - waring list. + * `code` - code. + * `help_doc` - help document. + * `message` - message. + * `solution` - solution. + * `step_now` - current step number. + * `dst_database_type` - destination database type. + * `dst_info` - destination info. + * `account_mode` - account mode. + * `account_role` - account role. + * `account` - account. + * `ccn_id` - ccn id. + * `cvm_instance_id` - cvm instance id. + * `db_kernel` - database kernel. + * `db_name` - database name. + * `engine_version` - engine version. + * `instance_id` - instance id. + * `ip` - ip. + * `password` - password. + * `port` - port. + * `region` - region. + * `subnet_id` - subnet id. + * `supplier` - supplier. + * `tmp_secret_id` - temporary secret id. + * `tmp_secret_key` - temporary secret key. + * `tmp_token` - temporary token. + * `uniq_dcg_id` - dedicated gateway id. + * `uniq_vpn_gw_id` - vpn gateway id. + * `user` - user. + * `vpc_id` - vpc id. + * `dst_region` - destination region. + * `end_time` - end time. + * `expect_run_time` - expected run time. + * `expire_time` - expire time. + * `job_id` - job id. + * `job_name` - job name. + * `objects` - objects. + * `advanced_objects` - advanced objects. + * `databases` - database list. + * `db_mode` - database mode. + * `db_name` - database name. + * `function_mode` - function mode. + * `functions` - functions. + * `new_db_name` - new database name. + * `new_schema_name` - new schema name. + * `procedure_mode` - procedure mode. + * `procedures` - procedures. + * `schema_name` - schema name. + * `table_mode` - table mode. + * `tables` - table list. + * `filter_condition` - filter condition. + * `new_table_name` - new table name. + * `table_name` - table name. + * `view_mode` - view mode. + * `views` - view list. + * `new_view_name` - new view name. + * `view_name` - view name. + * `mode` - object mode. + * `options` - options. + * `add_additional_column` - add additional column. + * `conflict_handle_option` - conflict handle option. + * `condition_column` - condition column. + * `condition_operator` - condition override operator. + * `condition_order_in_src_and_dst` - condition order in source and destination. + * `conflict_handle_type` - conflict handle type. + * `ddl_options` - ddl options. + * `ddl_object` - ddl object. + * `ddl_value` - ddl value. + * `deal_of_exist_same_table` - deal of exist same table. + * `init_type` - init type. + * `op_types` - operation types. + * `pay_mode` - pay mode. + * `run_mode` - run mode. + * `specification` - specification. + * `src_access_type` - source access type. + * `src_database_type` - source database type. + * `src_info` - source info. + * `account_mode` - account mode. + * `account_role` - account role. + * `account` - account. + * `ccn_id` - ccn id. + * `cvm_instance_id` - cvm instance id. + * `db_kernel` - database kernel. + * `db_name` - database name. + * `engine_version` - engine version. + * `instance_id` - instance id. + * `ip` - ip. + * `password` - password. + * `port` - port. + * `region` - region. + * `subnet_id` - subnet id. + * `supplier` - supplier. + * `tmp_secret_id` - temporary secret id. + * `tmp_secret_key` - temporary secret key. + * `tmp_token` - temporary token. + * `uniq_dcg_id` - dedicated gateway id. + * `uniq_vpn_gw_id` - vpn gateway id. + * `user` - user. + * `vpc_id` - vpc id. + * `src_region` - source region. + * `start_time` - start time. + * `status` - status. + * `tags` - tag list. + * `tag_key` - tag key. + * `tag_value` - tag value. + + diff --git a/config/docs/d/eb_bus.html.markdown b/config/docs/d/eb_bus.html.markdown new file mode 100644 index 0000000..150fdbc --- /dev/null +++ b/config/docs/d/eb_bus.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_bus" +sidebar_current: "docs-tencentcloud-datasource-eb_bus" +description: |- + Use this data source to query detailed information of eb bus +--- + +# tencentcloud_eb_bus + +Use this data source to query detailed information of eb bus + +## Example Usage + +```hcl +resource "tencentcloud_eb_event_bus" "foo" { + event_bus_name = "tf-event_bus" + description = "event bus desc" + enable_store = false + save_days = 1 + tags = { + "createdBy" = "terraform" + } +} +data "tencentcloud_eb_bus" "bus" { + order_by = "AddTime" + order = "DESC" + filters { + values = ["Custom"] + name = "Type" + } + + depends_on = [tencentcloud_eb_event_bus.foo] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter conditions. The upper limit of Filters per request is 10, and the upper limit of Filter.Values 5. +* `order_by` - (Optional, String) According to which field to sort the returned results, the following fields are supported: AddTime (creation time), ModTime (modification time). +* `order` - (Optional, String) Return results in ascending or descending order, optional values ASC (ascending) and DESC (descending). +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) The name of the filter key. +* `values` - (Required, Set) One or more filter values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `event_buses` - event set information. + * `add_time` - create time. + * `connection_briefs` - Connector basic information, note: this field may return null, indicating that no valid value can be obtained. + * `status` - Connector status, note: this field may return null, indicating that no valid value can be obtained. + * `type` - Connector type, note: this field may return null, indicating that no valid value can be obtained. + * `description` - Event set description, unlimited character type, description within 200 characters. + * `event_bus_id` - event bus Id. + * `event_bus_name` - Event set name, which can only contain letters, numbers, underscores, hyphens, starts with a letter and ends with a number or letter, 2~60 characters. + * `mod_time` - update time. + * `pay_mode` - Billing mode, note: this field may return null, indicating that no valid value can be obtained. + * `target_briefs` - Target brief information, note: this field may return null, indicating that no valid value can be obtained. + * `target_id` - Target ID. + * `type` - Target type. + * `type` - event bus type. + + diff --git a/config/docs/d/eb_event_rules.html.markdown b/config/docs/d/eb_event_rules.html.markdown new file mode 100644 index 0000000..9639302 --- /dev/null +++ b/config/docs/d/eb_event_rules.html.markdown @@ -0,0 +1,82 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_event_rules" +sidebar_current: "docs-tencentcloud-datasource-eb_event_rules" +description: |- + Use this data source to query detailed information of eb event_rules +--- + +# tencentcloud_eb_event_rules + +Use this data source to query detailed information of eb event_rules + +## Example Usage + +```hcl +resource "tencentcloud_eb_event_bus" "foo" { + event_bus_name = "tf-event_bus_rule" + description = "event bus desc" + enable_store = false + save_days = 1 + tags = { + "createdBy" = "terraform" + } +} +resource "tencentcloud_eb_event_rule" "event_rule" { + event_bus_id = tencentcloud_eb_event_bus.foo.id + rule_name = "tf-event_rule" + description = "event rule desc" + enable = true + event_pattern = jsonencode( + { + source = "apigw.cloud.tencent" + type = [ + "connector:apigw", + ] + } + ) + tags = { + "createdBy" = "terraform" + } +} +data "tencentcloud_eb_event_rules" "event_rules" { + event_bus_id = tencentcloud_eb_event_bus.foo.id + order_by = "AddTime" + order = "DESC" + depends_on = [tencentcloud_eb_event_rule.event_rule] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `event_bus_id` - (Required, String) event bus Id. +* `order_by` - (Optional, String) According to which field to sort the returned results, the following fields are supported: AddTime (creation time), ModTime (modification time). +* `order` - (Optional, String) Return results in ascending or descending order, optional values ASC (ascending) and DESC (descending). +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `rules` - Event rule information. + * `add_time` - create time. + * `dead_letter_config` - The dlq rule set by rule. It may be null. Note: this field may return null, indicating that no valid value can be obtained. + * `ckafka_delivery_params` - After setting the DLQ mode, this option is required. The error message will be delivered to the corresponding kafka topic Note: This field may return null, indicating that no valid value can be obtained. + * `resource_description` - ckafka resource qcs six-segment. + * `topic_name` - ckafka topic name. + * `dispose_method` - Support three modes of dlq, discarding, ignoring errors and continuing to pass, corresponding to: DLQ, DROP, IGNORE_ERROR. + * `description` - description. + * `enable` - enable switch. + * `event_bus_id` - event bus Id. + * `mod_time` - modify time. + * `rule_id` - rule Id. + * `rule_name` - rule name. + * `status` - Status. + * `targets` - Target brief information, note: this field may return null, indicating that no valid value can be obtained. + * `target_id` - target Id. + * `type` - target type. + + diff --git a/config/docs/d/eb_plateform_event_template.html.markdown b/config/docs/d/eb_plateform_event_template.html.markdown new file mode 100644 index 0000000..e33603b --- /dev/null +++ b/config/docs/d/eb_plateform_event_template.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_plateform_event_template" +sidebar_current: "docs-tencentcloud-datasource-eb_plateform_event_template" +description: |- + Use this data source to query detailed information of eb plateform_event_template +--- + +# tencentcloud_eb_plateform_event_template + +Use this data source to query detailed information of eb plateform_event_template + +## Example Usage + +```hcl +data "tencentcloud_eb_plateform_event_template" "plateform_event_template" { + event_type = "eb_platform_test:TEST:ALL" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `event_type` - (Required, String) Platform product event type. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `event_template` - Platform product event template. + + diff --git a/config/docs/d/eb_platform_event_names.html.markdown b/config/docs/d/eb_platform_event_names.html.markdown new file mode 100644 index 0000000..fe68737 --- /dev/null +++ b/config/docs/d/eb_platform_event_names.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_platform_event_names" +sidebar_current: "docs-tencentcloud-datasource-eb_platform_event_names" +description: |- + Use this data source to query detailed information of eb platform_event_names +--- + +# tencentcloud_eb_platform_event_names + +Use this data source to query detailed information of eb platform_event_names + +## Example Usage + +```hcl +data "tencentcloud_eb_platform_event_names" "platform_event_names" { + product_type = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `product_type` - (Required, String) Platform product event type. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `event_names` - Platform product list. + * `event_name` - Event name.Note: This field may return null, indicating that no valid value can be obtained. + * `event_type` - Event type.Note: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/eb_platform_event_patterns.html.markdown b/config/docs/d/eb_platform_event_patterns.html.markdown new file mode 100644 index 0000000..eb3b682 --- /dev/null +++ b/config/docs/d/eb_platform_event_patterns.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_platform_event_patterns" +sidebar_current: "docs-tencentcloud-datasource-eb_platform_event_patterns" +description: |- + Use this data source to query detailed information of eb platform_event_patterns +--- + +# tencentcloud_eb_platform_event_patterns + +Use this data source to query detailed information of eb platform_event_patterns + +## Example Usage + +```hcl +data "tencentcloud_eb_platform_event_patterns" "platform_event_patterns" { + product_type = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `product_type` - (Required, String) Platform product type. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `event_patterns` - Platform product event matching rules. + * `event_name` - Platform event name.Note: This field may return null, indicating that no valid value can be obtained. + * `event_pattern` - Platform event matching rules.Note: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/eb_platform_products.html.markdown b/config/docs/d/eb_platform_products.html.markdown new file mode 100644 index 0000000..f109052 --- /dev/null +++ b/config/docs/d/eb_platform_products.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_platform_products" +sidebar_current: "docs-tencentcloud-datasource-eb_platform_products" +description: |- + Use this data source to query detailed information of eb platform_products +--- + +# tencentcloud_eb_platform_products + +Use this data source to query detailed information of eb platform_products + +## Example Usage + +```hcl +data "tencentcloud_eb_platform_products" "platform_products" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `platform_products` - Platform product list. + * `product_name` - Platform product name. + * `product_type` - Platform product type. + + diff --git a/config/docs/d/eip.html.markdown b/config/docs/d/eip.html.markdown new file mode 100644 index 0000000..8d1991c --- /dev/null +++ b/config/docs/d/eip.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eip" +sidebar_current: "docs-tencentcloud-datasource-eip" +description: |- + Provides an available EIP for the user. +--- + +# tencentcloud_eip + +Provides an available EIP for the user. + +The EIP data source fetch proper EIP from user's EIP pool. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_eips. + +## Example Usage + +```hcl +data "tencentcloud_eip" "my_eip" { + filter { + name = "address-status" + values = ["UNBIND"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filter` - (Optional, Set) One or more name/value pairs to filter. +* `include_arrears` - (Optional, Bool) Whether the IP is arrears. +* `include_blocked` - (Optional, Bool) Whether the IP is blocked. + +The `filter` object supports the following: + +* `name` - (Required, String) Key of the filter, valid keys: `address-id`,`address-name`,`address-ip`. +* `values` - (Required, List) Value of the filter. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - An EIP id indicate the uniqueness of a certain EIP, which can be used for instance binding or network interface binding. +* `public_ip` - An public IP address for the EIP. +* `status` - The status of the EIP, there are several status like `BIND`, `UNBIND`, and `BIND_ENI`. + + diff --git a/config/docs/d/eip_address_quota.html.markdown b/config/docs/d/eip_address_quota.html.markdown new file mode 100644 index 0000000..79cd009 --- /dev/null +++ b/config/docs/d/eip_address_quota.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eip_address_quota" +sidebar_current: "docs-tencentcloud-datasource-eip_address_quota" +description: |- + Use this data source to query detailed information of vpc address_quota +--- + +# tencentcloud_eip_address_quota + +Use this data source to query detailed information of vpc address_quota + +## Example Usage + +```hcl +data "tencentcloud_eip_address_quota" "address_quota" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `quota_set` - The specified account EIP quota information. + * `quota_current` - Current count. + * `quota_id` - Quota name: TOTAL_EIP_QUOTA,DAILY_EIP_APPLY,DAILY_PUBLIC_IP_ASSIGN. + * `quota_limit` - quota count. + + diff --git a/config/docs/d/eip_network_account_type.html.markdown b/config/docs/d/eip_network_account_type.html.markdown new file mode 100644 index 0000000..3948549 --- /dev/null +++ b/config/docs/d/eip_network_account_type.html.markdown @@ -0,0 +1,32 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eip_network_account_type" +sidebar_current: "docs-tencentcloud-datasource-eip_network_account_type" +description: |- + Use this data source to query detailed information of eip network_account_type +--- + +# tencentcloud_eip_network_account_type + +Use this data source to query detailed information of eip network_account_type + +## Example Usage + +```hcl +data "tencentcloud_eip_network_account_type" "network_account_type" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `network_account_type` - The network type of the user account, STANDARD is a standard user, LEGACY is a traditional user. + + diff --git a/config/docs/d/eips.html.markdown b/config/docs/d/eips.html.markdown new file mode 100644 index 0000000..0c41041 --- /dev/null +++ b/config/docs/d/eips.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eips" +sidebar_current: "docs-tencentcloud-datasource-eips" +description: |- + Use this data source to query eip instances. +--- + +# tencentcloud_eips + +Use this data source to query eip instances. + +## Example Usage + +```hcl +data "tencentcloud_eips" "foo" { + eip_id = "eip-ry9h95hg" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `eip_id` - (Optional, String) ID of the EIP to be queried. +* `eip_name` - (Optional, String) Name of the EIP to be queried. +* `public_ip` - (Optional, String) The elastic ip address. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) The tags of EIP. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `eip_list` - An information list of EIP. Each element contains the following attributes: + * `create_time` - Creation time of the EIP. + * `eip_id` - ID of the EIP. + * `eip_name` - Name of the EIP. + * `eip_type` - Type of the EIP. + * `eni_id` - The eni id to bind with the EIP. + * `instance_id` - The instance id to bind with the EIP. + * `public_ip` - The elastic ip address. + * `status` - The EIP current status. + * `tags` - Tags of the EIP. + + diff --git a/config/docs/d/elasticsearch_diagnose.html.markdown b/config/docs/d/elasticsearch_diagnose.html.markdown new file mode 100644 index 0000000..d6f1a72 --- /dev/null +++ b/config/docs/d/elasticsearch_diagnose.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_diagnose" +sidebar_current: "docs-tencentcloud-datasource-elasticsearch_diagnose" +description: |- + Use this data source to query detailed information of elasticsearch diagnose +--- + +# tencentcloud_elasticsearch_diagnose + +Use this data source to query detailed information of elasticsearch diagnose + +## Example Usage + +```hcl +data "tencentcloud_elasticsearch_diagnose" "diagnose" { + instance_id = "es-xxxxxx" + date = "20231030" + limit = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance id. +* `date` - (Optional, String) Report date, format 20210301. +* `limit` - (Optional, Int) Number of copies returned in the report. Default value 1. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `diagnose_results` - List of diagnostic reports. + * `completed` - Whether the diagnosis is complete or not. + * `create_time` - Create time. + * `instance_id` - Instance id. + * `job_param` - Diagnostic parameters such as diagnostic time, diagnostic index, etc. + * `indices` - Diagnostic indices. + * `interval` - Historical diagnosis time. + * `jobs` - Diagnostic item list. + * `job_results` - Diagnostic item result list. + * `advise` - Diagnostic advice. + * `detail` - Diagnosis details. + * `job_name` - Diagnostic item name. + * `log_details` - Diagnostic log details. + * `advise` - Log exception handling recommendation. + * `count` - Number of occurrences of log exception names. + * `key` - Log exception name. + * `metric_details` - Details of diagnostic metrics. + * `key` - Metric detail name. + * `metrics` - Metric detail value. + * `dimensions` - Index dimension family. + * `key` - Intelligent operation and maintenance index dimension Key. + * `value` - Dimension value of intelligent operation and maintenance index. + * `value` - Value. + * `score` - Diagnostic item score. + * `setting_details` - Diagnostic configuration detail. + * `advise` - Configuration processing recommendations. + * `key` - Key. + * `value` - Value. + * `status` - Diagnostic item status:-2 failed,-1 to be retried, 0 running, 1 successful. + * `summary` - Diagnostic summary. + * `job_type` - Diagnosis type, 2 timing diagnosis, 3 customer manual trigger diagnosis. + * `request_id` - Request id. + * `score` - Total diagnostic score. + + diff --git a/config/docs/d/elasticsearch_instance_logs.html.markdown b/config/docs/d/elasticsearch_instance_logs.html.markdown new file mode 100644 index 0000000..47eeed2 --- /dev/null +++ b/config/docs/d/elasticsearch_instance_logs.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_instance_logs" +sidebar_current: "docs-tencentcloud-datasource-elasticsearch_instance_logs" +description: |- + Use this data source to query detailed information of es elasticsearch_instance_logs +--- + +# tencentcloud_elasticsearch_instance_logs + +Use this data source to query detailed information of es elasticsearch_instance_logs + +## Example Usage + +```hcl +data "tencentcloud_elasticsearch_instance_logs" "elasticsearch_instance_logs" { + instance_id = "es-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance id. +* `end_time` - (Optional, String) End time. The format is YYYY-MM-DD HH:MM:SS, such as 2019-01-22 20:15:53. +* `log_type` - (Optional, Int) Log type. Log type, default is 1, Valid values: +- 1: master log +- 2: Search slow log +- 3: Index slow log +- 4: GC log. +* `order_by_type` - (Optional, Int) Order type. Time sort method. Default is 0, valid values: +- 0: descending; +- 1: ascending order. +* `result_output_file` - (Optional, String) Used to save results. +* `search_key` - (Optional, String) Search key. Support LUCENE syntax, such as level:WARN, ip:1.1.1.1, message:test-index, etc. +* `start_time` - (Optional, String) Start time. The format is YYYY-MM-DD HH:MM:SS, such as 2019-01-22 20:15:53. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_log_list` - List of log details. + * `ip` - Cluster node ip. + * `level` - Log level. + * `message` - Log message. + * `node_id` - Cluster node id. + * `time` - Log time. + + diff --git a/config/docs/d/elasticsearch_instance_operations.html.markdown b/config/docs/d/elasticsearch_instance_operations.html.markdown new file mode 100644 index 0000000..753e6c7 --- /dev/null +++ b/config/docs/d/elasticsearch_instance_operations.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_instance_operations" +sidebar_current: "docs-tencentcloud-datasource-elasticsearch_instance_operations" +description: |- + Use this data source to query detailed information of elasticsearch instance operations +--- + +# tencentcloud_elasticsearch_instance_operations + +Use this data source to query detailed information of elasticsearch instance operations + +## Example Usage + +```hcl +data "tencentcloud_elasticsearch_instance_operations" "instance_operations" { + instance_id = "es-xxxxxx" + start_time = "2018-01-01 00:00:00" + end_time = "2023-10-31 10:12:45" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) End time, e.g. 2019-03-30 20:18:03. +* `instance_id` - (Required, String) Instance id. +* `start_time` - (Required, String) Start time, e.g. 2019-03-07 16:30:39. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `operations` - Operation records. + * `detail` - Operation details. + * `new_info` - Configuration information after instance update. + * `key` - Key. + * `value` - Value. + * `old_info` - Instance original configuration information. + * `key` - Key. + * `value` - Value. + * `id` - Id. + * `progress` - Operation progress. + * `result` - Operation result. + * `start_time` - Start time. + * `sub_account_uin` - Operator uin. + * `tasks` - Task information. + * `elapsed_time` - Elapsed time. + * `finish_time` - Task completion time. + * `name` - Task name. + * `process_info` - Progress info. + * `completed` - Completed quantity. + * `remain` - Remaining quantity. + * `task_type` - Task type. 60: restart task 70: fragment migration task 80: node modification task. + * `total` - Total quantity. + * `progress` - Task progress. + * `sub_tasks` - Subtask. + * `err_msg` - Subtask error message. + * `failed_indices` - The index name of the failed upgrade check. + * `finish_time` - Subtask end time. + * `level` - Subtask level, 1: warning; 2: failed. + * `name` - Subtask name. + * `result` - Subtask result. + * `status` - Subtask status, 1: success; 0: processing; -1: failure. + * `type` - Subtask type. + * `type` - Type. + + diff --git a/config/docs/d/elasticsearch_instance_plugin_list.html.markdown b/config/docs/d/elasticsearch_instance_plugin_list.html.markdown new file mode 100644 index 0000000..10a69d3 --- /dev/null +++ b/config/docs/d/elasticsearch_instance_plugin_list.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_instance_plugin_list" +sidebar_current: "docs-tencentcloud-datasource-elasticsearch_instance_plugin_list" +description: |- + Use this data source to query detailed information of elasticsearch instance plugin list +--- + +# tencentcloud_elasticsearch_instance_plugin_list + +Use this data source to query detailed information of elasticsearch instance plugin list + +## Example Usage + +```hcl +data "tencentcloud_elasticsearch_instance_plugin_list" "instance_plugin_list" { + instance_id = "es-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance id. +* `order_by_type` - (Optional, String) Order type. Valid values: +- asc: Ascending asc +- desc: Descending Desc. +* `order_by` - (Optional, String) order field. Valid values: `pluginName`. +* `plugin_type` - (Optional, Int) Plugin type. Valid values: `0`: System plugin. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `plugin_list` - Plugin information list. + * `plugin_desc` - Plugin description. + * `plugin_name` - Plugin name. + * `plugin_type` - Plugin type. Valid values: `0`: System plugin. + * `plugin_update_time` - Plugin update time. + * `plugin_version` - Plugin version. + * `removable` - Whether the plug-in can be uninstalled. + * `status` - Plugin status. Valid values: +- `-2` has been uninstalled +- `-1` has been installed in +- `0` installation. + + diff --git a/config/docs/d/elasticsearch_instances.html.markdown b/config/docs/d/elasticsearch_instances.html.markdown new file mode 100644 index 0000000..e7a2c82 --- /dev/null +++ b/config/docs/d/elasticsearch_instances.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_instances" +sidebar_current: "docs-tencentcloud-datasource-elasticsearch_instances" +description: |- + Use this data source to query elasticsearch instances. +--- + +# tencentcloud_elasticsearch_instances + +Use this data source to query elasticsearch instances. + +## Example Usage + +```hcl +data "tencentcloud_elasticsearch_instances" "foo" { + instance_id = "es-17634f05" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Optional, String) ID of the instance to be queried. +* `instance_name` - (Optional, String) Name of the instance to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) Tag of the instance to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - An information list of elasticsearch instance. Each element contains the following attributes: + * `availability_zone` - Availability zone. + * `basic_security_type` - Whether to enable X-Pack security authentication in Basic Edition 6.8 and above. + * `charge_type` - The charge type of instance. + * `create_time` - Instance creation time. + * `deploy_mode` - Cluster deployment mode. + * `elasticsearch_domain` - Elasticsearch domain name. + * `elasticsearch_port` - Elasticsearch port. + * `elasticsearch_vip` - Elasticsearch VIP. + * `instance_id` - ID of the instance. + * `instance_name` - Name of the instance. + * `kibana_url` - Kibana access URL. + * `license_type` - License type. + * `multi_zone_infos` - Details of AZs in multi-AZ deployment mode. + * `availability_zone` - Availability zone. + * `subnet_id` - The id of a VPC subnet. + * `node_info_list` - Node information list, which describe the specification information of various types of nodes in the cluster. + * `disk_size` - Node disk size. + * `disk_type` - Node disk type. + * `encrypt` - Decides this disk encrypted or not. + * `node_num` - Number of nodes. + * `node_type` - Node specification. + * `type` - Node type. + * `subnet_id` - The ID of a VPC subnet. + * `tags` - A mapping of tags to assign to the instance. + * `version` - Version of the instance. + * `vpc_id` - The ID of a VPC network. + + diff --git a/config/docs/d/elasticsearch_logstash_instance_logs.html.markdown b/config/docs/d/elasticsearch_logstash_instance_logs.html.markdown new file mode 100644 index 0000000..574c2c6 --- /dev/null +++ b/config/docs/d/elasticsearch_logstash_instance_logs.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_logstash_instance_logs" +sidebar_current: "docs-tencentcloud-datasource-elasticsearch_logstash_instance_logs" +description: |- + Use this data source to query detailed information of elasticsearch logstash_instance_logs +--- + +# tencentcloud_elasticsearch_logstash_instance_logs + +Use this data source to query detailed information of elasticsearch logstash_instance_logs + +## Example Usage + +```hcl +data "tencentcloud_elasticsearch_logstash_instance_logs" "logstash_instance_logs" { + instance_id = "ls-xxxxxx" + log_type = 1 + start_time = "2023-10-31 10:30:00" + end_time = "2023-10-31 10:30:10" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance id. +* `log_type` - (Required, Int) Log type. Default 1, Valid values: + - 1: Main Log + - 2: Slow log + - 3: GC Log. +* `end_time` - (Optional, String) Log end time, in YYYY-MM-DD HH:MM:SS format, such as 2019-01-22 20:15:53. +* `order_by_type` - (Optional, Int) Time sort method. Default is 0. 0: descending; 1: ascending order. +* `result_output_file` - (Optional, String) Used to save results. +* `search_key` - (Optional, String) Search terms, support LUCENE syntax, such as level:WARN, ip:1.1.1.1, message:test-index, etc. +* `start_time` - (Optional, String) Log start time, in YYYY-MM-DD HH:MM:SS format, such as 2019-01-22 20:15:53. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_log_list` - List of log details. + * `ip` - Cluster node ip. + * `level` - Log level. + * `message` - Log content. + * `node_id` - Cluster node id. + * `time` - Log time. + + diff --git a/config/docs/d/elasticsearch_logstash_instance_operations.html.markdown b/config/docs/d/elasticsearch_logstash_instance_operations.html.markdown new file mode 100644 index 0000000..976317a --- /dev/null +++ b/config/docs/d/elasticsearch_logstash_instance_operations.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_logstash_instance_operations" +sidebar_current: "docs-tencentcloud-datasource-elasticsearch_logstash_instance_operations" +description: |- + Use this data source to query detailed information of elasticsearch logstash_instance_operations +--- + +# tencentcloud_elasticsearch_logstash_instance_operations + +Use this data source to query detailed information of elasticsearch logstash_instance_operations + +## Example Usage + +```hcl +data "tencentcloud_elasticsearch_logstash_instance_operations" "logstash_instance_operations" { + instance_id = "ls-xxxxxx" + start_time = "2018-01-01 00:00:00" + end_time = "2023-10-31 10:12:45" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) End time, e.g. 2019-03-30 20:18:03. +* `instance_id` - (Required, String) Instance id. +* `start_time` - (Required, String) Start time, e.g. 2019-03-07 16:30:39. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `operations` - Operation records. + * `detail` - Operation details. + * `new_info` - Configuration information after instance update. + * `key` - Key. + * `value` - Value. + * `old_info` - Instance original configuration information. + * `key` - Key. + * `value` - Value. + * `id` - Id. + * `progress` - Operation progress. + * `result` - Operation result. + * `start_time` - Start time. + * `sub_account_uin` - Operator uin. + * `tasks` - Task information. + * `elapsed_time` - Elapsed time. + * `finish_time` - Task completion time. + * `name` - Task name. + * `process_info` - Progress info. + * `completed` - Completed quantity. + * `remain` - Remaining quantity. + * `task_type` - Task type. 60: restart task 70: fragment migration task 80: node modification task. + * `total` - Total quantity. + * `progress` - Task progress. + * `sub_tasks` - Subtask. + * `err_msg` - Subtask error message. + * `failed_indices` - The index name of the failed upgrade check. + * `finish_time` - Subtask end time. + * `level` - Subtask level, 1: warning; 2: failed. + * `name` - Subtask name. + * `result` - Subtask result. + * `status` - Subtask status, 1: success; 0: processing; -1: failure. + * `type` - Subtask type. + * `type` - Type. + + diff --git a/config/docs/d/elasticsearch_views.html.markdown b/config/docs/d/elasticsearch_views.html.markdown new file mode 100644 index 0000000..ee765c8 --- /dev/null +++ b/config/docs/d/elasticsearch_views.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_views" +sidebar_current: "docs-tencentcloud-datasource-elasticsearch_views" +description: |- + Use this data source to query detailed information of elasticsearch views +--- + +# tencentcloud_elasticsearch_views + +Use this data source to query detailed information of elasticsearch views + +## Example Usage + +```hcl +data "tencentcloud_elasticsearch_views" "views" { + instance_id = "es-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cluster_view` - Cluster view. + * `avg_cpu_usage` - Average cpu utilization. + * `avg_disk_usage` - Average disk utilization. + * `avg_mem_usage` - Average memory utilization. + * `break` - Whether the cluster is broken or not. + * `data_node_num` - Number of data nodes. + * `disk_used_in_bytes` - Bytes used on disk. + * `doc_num` - Number of documents. + * `health` - Cluster health status. + * `index_num` - Index number. + * `initializing_shard_num` - Initializing shard number. + * `node_num` - Number of online nodes. + * `primary_shard_num` - Primary shard number. + * `relocating_shard_num` - Relocating shard number. + * `searchable_snapshot_cos_app_id` - Enterprise cluster can search the appid to which snapshot cos belongs. + * `searchable_snapshot_cos_bucket` - Enterprise cluster searchable bucket name stored in snapshot cos. + * `shard_num` - Shard number. + * `target_node_types` - Client request node. + * `total_cos_storage` - Storage capacity of COS Enterprise Edition (in GB). + * `total_disk_size` - Total storage size of cluster. + * `total_node_num` - Total number of nodes. + * `unassigned_shard_num` - Unassigned shard number. + * `visible` - Whether the cluster is visible. +* `kibanas_view` - Kibanas view. + * `cpu_num` - CPU number. + * `cpu_usage` - cpu usage. + * `disk_size` - Disk size. + * `disk_usage` - Disk usage. + * `ip` - Kibana node ip. + * `mem_size` - Node memory size. + * `mem_usage` - Memory usage. + * `node_id` - Node id. + * `zone` - zone. +* `nodes_view` - Node View. + * `break` - Whether or not to break. + * `cpu_num` - CPU number. + * `cpu_usage` - CPU usage. + * `disk_ids` - List of disk ID on the node. + * `disk_size` - Total disk size of node. + * `disk_usage` - Disk usage. + * `hidden` - Whether it is a hidden availability zone. + * `is_coordination_node` - Whether to act as a coordinator node or not. + * `jvm_mem_usage` - JVM memory usage. + * `mem_size` - Node memory size (in GB). + * `mem_usage` - Memory usage. + * `node_http_ip` - Node HTTP IP. + * `node_id` - Node id. + * `node_ip` - Node ip. + * `node_role` - Node role. + * `shard_num` - Number of node fragments. + * `visible` - Whether the node is visible. + * `zone` - Zone. + + diff --git a/config/docs/d/emr.html.markdown b/config/docs/d/emr.html.markdown new file mode 100644 index 0000000..a84ddfb --- /dev/null +++ b/config/docs/d/emr.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "MapReduce(EMR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_emr" +sidebar_current: "docs-tencentcloud-datasource-emr" +description: |- + Provides an available EMR for the user. +--- + +# tencentcloud_emr + +Provides an available EMR for the user. + +The EMR data source fetch proper EMR from user's EMR pool. + +## Example Usage + +```hcl +data "tencentcloud_emr" "my_emr" { + display_strategy = "clusterList" + instance_ids = ["emr-rnzqrleq"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `display_strategy` - (Required, String) Display strategy(e.g.:clusterList, monitorManage). +* `instance_ids` - (Optional, List: [`String`]) fetch all instances with same prefix(e.g.:emr-xxxxxx). +* `project_id` - (Optional, Int) Fetch all instances which owner same project. Default 0 meaning use default project id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `clusters` - A list of clusters will be exported and its every element contains the following attributes: + * `add_time` - Add time of instance. + * `charge_type` - Charge type of instance. + * `cluster_id` - Cluster id of instance. + * `cluster_name` - Cluster name of instance. + * `ftitle` - Title of instance. + * `id` - Id of instance. + * `master_ip` - Master ip of instance. + * `project_id` - Project id of instance. + * `region_id` - Region id of instance. + * `status` - Status of instance. + * `zone_id` - Zone id of instance. + * `zone` - Zone of instance. + + diff --git a/config/docs/d/emr_cvm_quota.html.markdown b/config/docs/d/emr_cvm_quota.html.markdown new file mode 100644 index 0000000..9872b63 --- /dev/null +++ b/config/docs/d/emr_cvm_quota.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "MapReduce(EMR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_emr_cvm_quota" +sidebar_current: "docs-tencentcloud-datasource-emr_cvm_quota" +description: |- + Use this data source to query detailed information of emr cvm_quota +--- + +# tencentcloud_emr_cvm_quota + +Use this data source to query detailed information of emr cvm_quota + +## Example Usage + +```hcl +data "tencentcloud_emr_cvm_quota" "cvm_quota" { + cluster_id = "emr-0ze36vnp" + zone_id = 100003 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) EMR cluster ID. +* `result_output_file` - (Optional, String) Used to save results. +* `zone_id` - (Optional, Int) Zone ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `eks_quota_set` - Eks quota Note: This field may return null, indicating that a valid value cannot be obtained. + * `cpu` - Cpu cores. + * `memory` - Memory quantity (unit: GB). + * `node_type` - The specifications of the marketable resource are as follows: `TASK`, `CORE`, `MASTER`, `ROUTER`. + * `number` - Specifies the maximum number of resources that can be applied for. +* `post_paid_quota_set` - Postpaid quota list Note: This field may return null, indicating that no valid value can be obtained. + * `remaining_quota` - Residual quota Note: This field may return null, indicating that a valid value cannot be obtained. + * `total_quota` - Total quota Note: This field may return null, indicating that a valid value cannot be obtained. + * `used_quota` - Used quota Note: This field may return null, indicating that a valid value cannot be obtained. + * `zone` - Available area Note: This field may return null, indicating that a valid value cannot be obtained. +* `spot_paid_quota_set` - Biding instance quota list Note: This field may return null, indicating that a valid value cannot be obtained. + * `remaining_quota` - Residual quota Note: This field may return null, indicating that a valid value cannot be obtained. + * `total_quota` - Total quota Note: This field may return null, indicating that a valid value cannot be obtained. + * `used_quota` - Used quota Note: This field may return null, indicating that a valid value cannot be obtained. + * `zone` - Available area Note: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/emr_nodes.html.markdown b/config/docs/d/emr_nodes.html.markdown new file mode 100644 index 0000000..2b7f890 --- /dev/null +++ b/config/docs/d/emr_nodes.html.markdown @@ -0,0 +1,113 @@ +--- +subcategory: "MapReduce(EMR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_emr_nodes" +sidebar_current: "docs-tencentcloud-datasource-emr_nodes" +description: |- + Provides an available EMR for the user. +--- + +# tencentcloud_emr_nodes + +Provides an available EMR for the user. + +The EMR data source obtain the hardware node information by using the emr cluster ID. + +## Example Usage + +```hcl +data "tencentcloud_emr_nodes" "my_emr_nodes" { + node_flag = "master" + instance_id = "emr-rnzqrleq" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Cluster instance ID, the instance ID is as follows: emr-xxxxxxxx. +* `node_flag` - (Required, String) Node ID, the value is: + - all: Means to get all type nodes, except cdb information. + - master: Indicates that the master node information is obtained. + - core: Indicates that the core node information is obtained. + - task: indicates obtaining task node information. + - common: means to get common node information. + - router: Indicates obtaining router node information. + - db: Indicates that the cdb information for the normal state is obtained. + - recyle: Indicates that the node information in the Recycle Bin isolation, including the cdb information, is obtained. + - renew: Indicates that all node information to be renewed, including cddb information, is obtained, and the auto-renewal node will not be returned. + + Note: Only the above values are now supported, entering other values will cause an error. +* `hardware_resource_type` - (Optional, String) Resource type: Support all/host/pod, default is all. +* `limit` - (Optional, Int) The number returned per page, the default value is 100, and the maximum value is 100. +* `offset` - (Optional, Int) Page number, with a default value of 0, represents the first page. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `nodes` - List of node details. + * `app_id` - User APPID. + * `apply_time` - Application time. + * `auto_flag` - Whether it is an autoscaling node, 0 is a normal node, and 1 is an autoscaling node. + * `cdb_ip` - Database IP. + * `cdb_node_info` - Database information. + * `apply_time` - Application time. + * `expire_flag` - Expired id. + * `expire_time` - Expiration time. + * `instance_name` - DB instance. + * `ip` - Database IP. + * `is_auto_renew` - Renewal identity. + * `mem_size` - Database memory specifications. + * `pay_type` - The type of payment. + * `port` - Database port. + * `region_id` - Region id. + * `serial_no` - Database string. + * `service` - The service identity. + * `status` - Database status. + * `volume` - Database disk specifications. + * `zone_id` - Zone Id. + * `cdb_port` - Database port. + * `charge_type` - The type of payment. + * `cpu_num` - Number of node cores. + * `destroyable` - Whether this node is destroyable, 1 can be destroyed, 0 is not destroyable. + * `device_class` - Device identity. + * `disk_size` - Hard disk size. + * `dynamic_pod_spec` - Floating specification value json string. + * `emr_resource_id` - Node resource ID. + * `expire_time` - Expiration time. + * `flag` - Node type. 0: common node; 1: master node; 2: core node; 3: task node. + * `free_time` - Release time. + * `hardware_resource_type` - Resource type, host/pod. + * `hw_disk_size_desc` - Hard disk capacity description. + * `hw_disk_size` - Hard disk capacity. + * `hw_mem_size_desc` - Memory capacity description. + * `hw_mem_size` - Memory capacity. + * `ip` - Intranet IP. + * `is_auto_renew` - Renewal logo. + * `is_dynamic_spec` - Floating specifications, 1 yes, 0 no. + * `mc_multi_disks` - Multi-cloud disk. + * `count` - The number of cloud disks of this type. + * `type` - Disk type. + * `volume` - The size of the cloud disk. + * `mem_desc` - Node memory description. + * `mem_size` - Node memory. + * `mutable` - Supports variations. + * `name_tag` - Node description. + * `order_no` - Machine instance ID. + * `region_id` - The node is located in the region. + * `root_size` - The size of the system disk. + * `serial_no` - Serial number. + * `services` - Node deployment service. + * `spec` - Node specifications. + * `storage_type` - Disk type. + * `support_modify_pay_mode` - Whether to support change billing type 1 Yes and 0 No. + * `tags` - The label of the node binding. + * `tag_key` - Tag key. + * `tag_value` - Tag value. + * `wan_ip` - The master node is bound to the Internet IP address. + * `zone_id` - Zone where the node is located. + + diff --git a/config/docs/d/enis.html.markdown b/config/docs/d/enis.html.markdown new file mode 100644 index 0000000..71315c1 --- /dev/null +++ b/config/docs/d/enis.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_enis" +sidebar_current: "docs-tencentcloud-datasource-enis" +description: |- + Use this data source to query query ENIs. +--- + +# tencentcloud_enis + +Use this data source to query query ENIs. + +## Example Usage + +```hcl +data "tencentcloud_enis" "name" { + name = "test eni" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `description` - (Optional, String) Description of the ENI. Conflict with `ids`. +* `ids` - (Optional, Set: [`String`]) ID of the ENIs to be queried. Conflict with `vpc_id`,`subnet_id`,`instance_id`,`security_group`,`name`,`ipv4` and `tags`. +* `instance_id` - (Optional, String) ID of the instance which bind the ENI. Conflict with `ids`. +* `ipv4` - (Optional, String) Intranet IP of the ENI. Conflict with `ids`. +* `name` - (Optional, String) Name of the ENI to be queried. Conflict with `ids`. +* `result_output_file` - (Optional, String) Used to save results. +* `security_group` - (Optional, String) A set of security group IDs which bind the ENI. Conflict with `ids`. +* `subnet_id` - (Optional, String) ID of the subnet within this vpc to be queried. Conflict with `ids`. +* `tags` - (Optional, Map) Tags of the ENI. Conflict with `ids`. +* `vpc_id` - (Optional, String) ID of the vpc to be queried. Conflict with `ids`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `enis` - An information list of ENIs. Each element contains the following attributes: + * `create_time` - Creation time of the ENI. + * `description` - Description of the ENI. + * `id` - ID of the ENI. + * `instance_id` - ID of the instance which bind the ENI. + * `ipv4s` - A set of intranet IPv4s. + * `description` - Description of the IP. + * `ip` - Intranet IP. + * `primary` - Indicates whether the IP is primary. + * `mac` - MAC address. + * `name` - Name of the ENI. + * `primary` - Indicates whether the IP is primary. + * `security_groups` - A set of security group IDs which bind the ENI. + * `state` - States of the ENI. + * `subnet_id` - ID of the subnet within this vpc. + * `tags` - Tags of the ENI. + * `vpc_id` - ID of the vpc. + + diff --git a/config/docs/d/gaap_access_regions.html.markdown b/config/docs/d/gaap_access_regions.html.markdown new file mode 100644 index 0000000..45ed93c --- /dev/null +++ b/config/docs/d/gaap_access_regions.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_access_regions" +sidebar_current: "docs-tencentcloud-datasource-gaap_access_regions" +description: |- + Use this data source to query detailed information of gaap access regions +--- + +# tencentcloud_gaap_access_regions + +Use this data source to query detailed information of gaap access regions + +## Example Usage + +```hcl +data "tencentcloud_gaap_access_regions" "access_regions" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `access_region_set` - Acceleration Zone Details List. + * `feature_bitmap` - Property bitmap, where each bit represents a property, where:0, indicates that the feature is not supported;1, indicates support for this feature.The meaning of the feature bitmap is as follows (from right to left):The first bit supports 4-layer acceleration;The second bit supports 7-layer acceleration;The third bit supports Http3 access;The fourth bit supports IPv6;The fifth bit supports high-quality BGP access;The 6th bit supports three network access;The 7th bit supports QoS acceleration in the access segment.Note: This field may return null, indicating that a valid value cannot be obtained. + * `idc_type` - The type of computer room, where dc represents the DataCenter data center and ec represents the EdgeComputing edge node. + * `region_area_name` - Name of the region to which the computer room belongs. + * `region_area` - Region of the computer room. + * `region_id` - Region id. + * `region_name` - English or Chinese name of the region. + * `support_feature` - Ability to access regional supportNote: This field may return null, indicating that a valid value cannot be obtained. + * `network_type` - A list of network types supported by the access area, with normal indicating support for regular BGP, cn2 indicating premium BGP, triple indicating three networks, and secure_ EIP represents a custom secure EIP. + + diff --git a/config/docs/d/gaap_access_regions_by_dest_region.html.markdown b/config/docs/d/gaap_access_regions_by_dest_region.html.markdown new file mode 100644 index 0000000..4d1d293 --- /dev/null +++ b/config/docs/d/gaap_access_regions_by_dest_region.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_access_regions_by_dest_region" +sidebar_current: "docs-tencentcloud-datasource-gaap_access_regions_by_dest_region" +description: |- + Use this data source to query detailed information of gaap access regions by dest region +--- + +# tencentcloud_gaap_access_regions_by_dest_region + +Use this data source to query detailed information of gaap access regions by dest region + +## Example Usage + +```hcl +data "tencentcloud_gaap_access_regions_by_dest_region" "access_regions_by_dest_region" { + dest_region = "SouthChina" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dest_region` - (Required, String) Origin region. +* `ip_address_version` - (Optional, String) IP version, can be taken as IPv4 or IPv6, with a default value of IPv4. +* `package_type` - (Optional, String) Channel package type, where Thunder represents a standard proxy group, Accelerator represents a game accelerator proxy, and CrossBorder represents a cross-border proxy. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `access_region_set` - List of available acceleration zone information. + * `bandwidth_list` - Optional bandwidth value array. + * `concurrent_list` - Optional concurrency value array. + * `feature_bitmap` - The type of computer room, where dc represents the DataCenter data center, ec represents the feature bitmap, and each bit represents a feature, where:0, indicates that the feature is not supported;1, indicates support for this feature.The meaning of the feature bitmap is as follows (from right to left):The first bit supports 4-layer acceleration;The second bit supports 7-layer acceleration;The third bit supports Http3 access;The fourth bit supports IPv6;The fifth bit supports high-quality BGP access;The 6th bit supports three network access;The 7th bit supports QoS acceleration in the access segment.Note: This field may return null, indicating that a valid value cannot be obtained. Edge nodes. + * `idc_type` - The type of computer room, where dc represents the DataCenter data center and ec represents the EdgeComputing edge node. + * `region_area_name` - Region name of the computer room. + * `region_area` - Region of the computer room. + * `region_id` - Region id. + * `region_name` - Chinese or English name of the region. + + diff --git a/config/docs/d/gaap_black_header.html.markdown b/config/docs/d/gaap_black_header.html.markdown new file mode 100644 index 0000000..7b90bfd --- /dev/null +++ b/config/docs/d/gaap_black_header.html.markdown @@ -0,0 +1,33 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_black_header" +sidebar_current: "docs-tencentcloud-datasource-gaap_black_header" +description: |- + Use this data source to query detailed information of gaap black header +--- + +# tencentcloud_gaap_black_header + +Use this data source to query detailed information of gaap black header + +## Example Usage + +```hcl +data "tencentcloud_gaap_black_header" "black_header" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `black_headers` - Disabled custom header listNote: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/gaap_certificates.html.markdown b/config/docs/d/gaap_certificates.html.markdown new file mode 100644 index 0000000..3e93ff3 --- /dev/null +++ b/config/docs/d/gaap_certificates.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_certificates" +sidebar_current: "docs-tencentcloud-datasource-gaap_certificates" +description: |- + Use this data source to query GAAP certificate. +--- + +# tencentcloud_gaap_certificates + +Use this data source to query GAAP certificate. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_certificate" "foo" { + type = "BASIC" + content = "test:tx2KGdo3zJg/." + name = "test_certificate" +} + +data "tencentcloud_gaap_certificates" "foo" { + id = tencentcloud_gaap_certificate.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the certificate to be queried. +* `name` - (Optional, String) Name of the certificate to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `type` - (Optional, String) Type of the certificate to be queried. Valid values: `BASIC`, `CLIENT`, `SERVER`, `REALSERVER` and `PROXY`. `BASIC` means basic certificate; `CLIENT` means client CA certificate; `SERVER` means server SSL certificate; `REALSERVER` means realserver CA certificate; `PROXY` means proxy SSL certificate. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `certificates` - An information list of certificate. Each element contains the following attributes: + * `begin_time` - Beginning time of the certificate. + * `create_time` - Creation time of the certificate. + * `end_time` - Ending time of the certificate. + * `id` - ID of the certificate. + * `issuer_cn` - Issuer name of the certificate. + * `name` - Name of the certificate. + * `subject_cn` - Subject name of the certificate. + * `type` - Type of the certificate. + + diff --git a/config/docs/d/gaap_check_proxy_create.html.markdown b/config/docs/d/gaap_check_proxy_create.html.markdown new file mode 100644 index 0000000..7ab72a3 --- /dev/null +++ b/config/docs/d/gaap_check_proxy_create.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_check_proxy_create" +sidebar_current: "docs-tencentcloud-datasource-gaap_check_proxy_create" +description: |- + Use this data source to query detailed information of gaap check proxy create +--- + +# tencentcloud_gaap_check_proxy_create + +Use this data source to query detailed information of gaap check proxy create + +## Example Usage + +```hcl +data "tencentcloud_gaap_check_proxy_create" "check_proxy_create" { + access_region = "Guangzhou" + real_server_region = "Beijing" + bandwidth = 10 + concurrent = 2 + ip_address_version = "IPv4" + network_type = "normal" + package_type = "Thunder" + http3_supported = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_region` - (Required, String) The access (acceleration) area of the proxy. The value can be obtained through the interface DescribeAccessRegionsByDestRegion. +* `bandwidth` - (Required, Int) The upper limit of proxy bandwidth, in Mbps. +* `concurrent` - (Required, Int) The upper limit of chanproxynel concurrency, representing the number of simultaneous online connections, in tens of thousands. +* `real_server_region` - (Required, String) The origin area of the proxy. The value can be obtained through the interface DescribeDestRegions. +* `group_id` - (Optional, String) If creating a proxy under a proxy group, you need to fill in the ID of the proxy group. +* `ip_address_version` - (Optional, String) IP version, can be taken as IPv4 or IPv6, with a default value of IPv4. +* `network_type` - (Optional, String) Network type, can take values &#39;normal&#39;, &#39;cn2&#39;, default value normal. +* `package_type` - (Optional, String) Channel package type. Thunder represents the standard proxy group, Accelerator represents the game accelerator proxy, and CrossBorder represents the cross-border proxy. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `check_flag` - Query whether the proxy with the given configuration can be created, 1 can be created, 0 cannot be created. + + diff --git a/config/docs/d/gaap_country_area_mapping.html.markdown b/config/docs/d/gaap_country_area_mapping.html.markdown new file mode 100644 index 0000000..26bf4b3 --- /dev/null +++ b/config/docs/d/gaap_country_area_mapping.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_country_area_mapping" +sidebar_current: "docs-tencentcloud-datasource-gaap_country_area_mapping" +description: |- + Use this data source to query detailed information of gaap country area mapping +--- + +# tencentcloud_gaap_country_area_mapping + +Use this data source to query detailed information of gaap country area mapping + +## Example Usage + +```hcl +data "tencentcloud_gaap_country_area_mapping" "country_area_mapping" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `country_area_mapping_list` - Country/region code mapping table. + * `continent_inner_code` - Continental Code. + * `continent_name` - The name of the continent. + * `geographical_zone_inner_code` - Region code. + * `geographical_zone_name` - Region name. + * `nation_country_inner_code` - Country code. + * `nation_country_name` - Country name. + * `remark` - Annotation InformationNote: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/gaap_custom_header.html.markdown b/config/docs/d/gaap_custom_header.html.markdown new file mode 100644 index 0000000..cf80b66 --- /dev/null +++ b/config/docs/d/gaap_custom_header.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_custom_header" +sidebar_current: "docs-tencentcloud-datasource-gaap_custom_header" +description: |- + Use this data source to query detailed information of gaap custom header +--- + +# tencentcloud_gaap_custom_header + +Use this data source to query detailed information of gaap custom header + +## Example Usage + +```hcl +data "tencentcloud_gaap_custom_header" "custom_header" { + rule_id = "rule-9sdhv655" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `rule_id` - (Required, String) Rule IdNote: This field may return null, indicating that a valid value cannot be obtained. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `headers` - HeadersNote: This field may return null, indicating that a valid value cannot be obtained. + * `header_name` - Header Name. + * `header_value` - Header Value. + + diff --git a/config/docs/d/gaap_dest_regions.html.markdown b/config/docs/d/gaap_dest_regions.html.markdown new file mode 100644 index 0000000..f03b8cf --- /dev/null +++ b/config/docs/d/gaap_dest_regions.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_dest_regions" +sidebar_current: "docs-tencentcloud-datasource-gaap_dest_regions" +description: |- + Use this data source to query detailed information of gaap dest regions +--- + +# tencentcloud_gaap_dest_regions + +Use this data source to query detailed information of gaap dest regions + +## Example Usage + +```hcl +data "tencentcloud_gaap_dest_regions" "dest_regions" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `dest_region_set` - Source Site Area Details List. + * `feature_bitmap` - Property bitmap, where each bit represents a property, where:0, indicates that the feature is not supported;1, indicates support for this feature.The meaning of the feature bitmap is as follows (from right to left):The first bit supports 4-layer acceleration;The second bit supports 7-layer acceleration;The third bit supports Http3 access;The fourth bit supports IPv6;The fifth bit supports high-quality BGP access;The 6th bit supports three network access;The 7th bit supports QoS acceleration in the access segment.Note: This field may return null, indicating that a valid value cannot be obtained. + * `idc_type` - The type of computer room, where dc represents the DataCenter data center and ec represents the EdgeComputing edge node. + * `region_area_name` - Region name of the computer room. + * `region_area` - Region of the computer room. + * `region_id` - region ID. + * `region_name` - region name. + * `support_feature` - Ability to access regional supportNote: This field may return null, indicating that a valid value cannot be obtained. + * `network_type` - A list of network types supported by the access area, with normal indicating support for regular BGP, cn2 indicating premium BGP, triple indicating three networks, and secure_EIP represents a custom secure EIP. + + diff --git a/config/docs/d/gaap_domain_error_page_infos.html.markdown b/config/docs/d/gaap_domain_error_page_infos.html.markdown new file mode 100644 index 0000000..5ee6608 --- /dev/null +++ b/config/docs/d/gaap_domain_error_page_infos.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_domain_error_page_infos" +sidebar_current: "docs-tencentcloud-datasource-gaap_domain_error_page_infos" +description: |- + Use this data source to query detailed information of gaap domain error page infos +--- + +# tencentcloud_gaap_domain_error_page_infos + +Use this data source to query detailed information of gaap domain error page infos + +## Example Usage + +```hcl +data "tencentcloud_gaap_domain_error_page_infos" "domain_error_page_infos" { + error_page_ids = ["errorPage-xxxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `error_page_ids` - (Required, Set: [`String`]) Customized error ID list, supporting up to 10. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `error_page_set` - Custom error response configuration setNote: This field may return null, indicating that a valid value cannot be obtained. + * `body` - Response body set (excluding HTTP header)Note: This field may return null, indicating that a valid value cannot be obtained. + * `clear_headers` - Response headers that need to be cleanedNote: This field may return null, indicating that a valid value cannot be obtained. + * `domain` - domain name. + * `error_nos` - Original error code. + * `error_page_id` - Configuration ID for error customization response. + * `listener_id` - Listener ID. + * `new_error_no` - New error codeNote: This field may return null, indicating that a valid value cannot be obtained. + * `set_headers` - Response header to be setNote: This field may return null, indicating that a valid value cannot be obtained. + * `header_name` - HTTP header name. + * `header_value` - HTTP header value. + * `status` - Rule status, 0 indicates successNote: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/gaap_domain_error_pages.html.markdown b/config/docs/d/gaap_domain_error_pages.html.markdown new file mode 100644 index 0000000..e8d20e2 --- /dev/null +++ b/config/docs/d/gaap_domain_error_pages.html.markdown @@ -0,0 +1,79 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_domain_error_pages" +sidebar_current: "docs-tencentcloud-datasource-gaap_domain_error_pages" +description: |- + Use this data source to query custom GAAP HTTP domain error page info list. +--- + +# tencentcloud_gaap_domain_error_pages + +Use this data source to query custom GAAP HTTP domain error page info list. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource tencentcloud_gaap_layer7_listener "foo" { + protocol = "HTTP" + name = "ci-test-gaap-l7-listener" + port = 80 + proxy_id = "%s" +} + +resource tencentcloud_gaap_http_domain "foo" { + listener_id = tencentcloud_gaap_layer7_listener.foo.id + domain = "www.qq.com" +} + +resource tencentcloud_gaap_domain_error_page "foo" { + listener_id = tencentcloud_gaap_layer7_listener.foo.id + domain = tencentcloud_gaap_http_domain.foo.domain + error_codes = [406, 504] + new_error_code = 502 + body = "bad request" + clear_headers = ["Content-Length", "X-TEST"] + + set_headers = { + "X-TEST" = "test" + } +} + +data tencentcloud_gaap_domain_error_pages "foo" { + listener_id = tencentcloud_gaap_domain_error_page.foo.listener_id + domain = tencentcloud_gaap_domain_error_page.foo.domain +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) HTTP domain to be queried. +* `listener_id` - (Required, String) ID of the layer7 listener to be queried. +* `ids` - (Optional, Set: [`String`]) List of the error page info ID to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `error_page_info_list` - An information list of error page info detail. Each element contains the following attributes: + * `body` - New response body. + * `clear_headers` - Response headers to be removed. + * `domain` - HTTP domain. + * `error_codes` - Original error codes. + * `id` - ID of the error page info. + * `listener_id` - ID of the layer7 listener. + * `new_error_codes` - New error code. + * `set_headers` - Response headers to be set. + + diff --git a/config/docs/d/gaap_group_and_statistics_proxy.html.markdown b/config/docs/d/gaap_group_and_statistics_proxy.html.markdown new file mode 100644 index 0000000..4ccca56 --- /dev/null +++ b/config/docs/d/gaap_group_and_statistics_proxy.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_group_and_statistics_proxy" +sidebar_current: "docs-tencentcloud-datasource-gaap_group_and_statistics_proxy" +description: |- + Use this data source to query detailed information of gaap and statistics proxy +--- + +# tencentcloud_gaap_group_and_statistics_proxy + +Use this data source to query detailed information of gaap and statistics proxy + +## Example Usage + +```hcl +data "tencentcloud_gaap_group_and_statistics_proxy" "group_and_statistics_proxy" { + project_id = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Required, Int) Project Id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `group_set` - Channel group information that can be counted. + * `group_id` - Channel Group ID. + * `group_name` - Channel Group name. + * `proxy_set` - Channel list in the proxy group. + * `listener_list` - listener list. + * `listener_id` - listener Id. + * `listener_name` - listener name. + * `port` - listened port. + * `protocol` - Listener protocol type. + * `proxy_id` - Channel Id. + * `proxy_name` - Channel name. + + diff --git a/config/docs/d/gaap_http_domains.html.markdown b/config/docs/d/gaap_http_domains.html.markdown new file mode 100644 index 0000000..98dae7d --- /dev/null +++ b/config/docs/d/gaap_http_domains.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_http_domains" +sidebar_current: "docs-tencentcloud-datasource-gaap_http_domains" +description: |- + Use this data source to query forward domain of layer7 listeners. +--- + +# tencentcloud_gaap_http_domains + +Use this data source to query forward domain of layer7 listeners. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_layer7_listener" "foo" { + protocol = "HTTP" + name = "ci-test-gaap-l7-listener" + port = 80 + proxy_id = tencentcloud_gaap_proxy.foo.id +} + +resource "tencentcloud_gaap_http_domain" "foo" { + listener_id = tencentcloud_gaap_layer7_listener.foo.id + domain = "www.qq.com" +} + +data "tencentcloud_gaap_http_domains" "foo" { + listener_id = tencentcloud_gaap_layer7_listener.foo.id + domain = tencentcloud_gaap_http_domain.foo.domain +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Forward domain of the layer7 listener to be queried. +* `listener_id` - (Required, String) ID of the layer7 listener to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `domains` - An information list of forward domain of the layer7 listeners. Each element contains the following attributes: + * `basic_auth_id` - ID of the basic authentication. + * `basic_auth` - Indicates whether basic authentication is enable. + * `certificate_id` - ID of the server certificate. + * `client_certificate_id` - (**Deprecated**) It has been deprecated from version 1.26.0. Use `client_certificate_ids` instead. ID of the client certificate. + * `client_certificate_ids` - ID list of the client certificate. + * `domain` - Forward domain of the layer7 listener. + * `gaap_auth_id` - ID of the SSL certificate. + * `gaap_auth` - Indicates whether SSL certificate authentication is enable. + * `realserver_auth` - Indicates whether realserver authentication is enable. + * `realserver_certificate_domain` - CA certificate domain of the realserver. + * `realserver_certificate_id` - (**Deprecated**) It has been deprecated from version 1.28.0. Use `realserver_certificate_ids` instead. CA certificate ID of the realserver. + * `realserver_certificate_ids` - CA certificate ID list of the realserver. + + diff --git a/config/docs/d/gaap_http_rules.html.markdown b/config/docs/d/gaap_http_rules.html.markdown new file mode 100644 index 0000000..9cfe925 --- /dev/null +++ b/config/docs/d/gaap_http_rules.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_http_rules" +sidebar_current: "docs-tencentcloud-datasource-gaap_http_rules" +description: |- + Use this data source to query forward rule of layer7 listeners. +--- + +# tencentcloud_gaap_http_rules + +Use this data source to query forward rule of layer7 listeners. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_layer7_listener" "foo" { + protocol = "HTTP" + name = "ci-test-gaap-l7-listener" + port = 80 + proxy_id = tencentcloud_gaap_proxy.foo.id +} + +resource "tencentcloud_gaap_realserver" "foo" { + ip = "1.1.1.1" + name = "ci-test-gaap-realserver" +} + +resource "tencentcloud_gaap_http_rule" "foo" { + listener_id = tencentcloud_gaap_layer7_listener.foo.id + domain = "www.qq.com" + path = "/" + realserver_type = "IP" + health_check = true + + realservers { + id = tencentcloud_gaap_realserver.foo.id + ip = tencentcloud_gaap_realserver.foo.ip + port = 80 + } +} + +data "tencentcloud_gaap_http_rules" "foo" { + listener_id = tencentcloud_gaap_layer7_listener.foo.id + domain = tencentcloud_gaap_http_rule.foo.domain +} +``` + +## Argument Reference + +The following arguments are supported: + +* `listener_id` - (Required, String) ID of the layer7 listener to be queried. +* `domain` - (Optional, String) Forward domain of the layer7 listener to be queried. +* `forward_host` - (Optional, String) Requested host which is forwarded to the realserver by the listener to be queried. +* `path` - (Optional, String) Path of the forward rule to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `rules` - An information list of forward rule of the layer7 listeners. Each element contains the following attributes: + * `connect_timeout` - Timeout of the health check response. + * `domain` - Forward domain of the forward rule. + * `forward_host` - Requested host which is forwarded to the realserver by the listener. + * `health_check_method` - Method of the health check. + * `health_check_path` - Path of health check. + * `health_check_status_codes` - Return code of confirmed normal. + * `health_check` - Indicates whether health check is enable. + * `id` - ID of the forward rule. + * `interval` - Interval of the health check. + * `listener_id` - ID of the layer7 listener. + * `path` - Path of the forward rule. + * `realserver_type` - Type of the realserver. + * `realservers` - An information list of GAAP realserver. Each element contains the following attributes: + * `domain` - Domain of the GAAP realserver. + * `id` - ID of the GAAP realserver. + * `ip` - IP of the GAAP realserver. + * `port` - Port of the GAAP realserver. + * `status` - Status of the GAAP realserver. + * `weight` - Scheduling weight. + * `scheduler` - Scheduling policy of the forward rule. + * `sni_switch` - ServerNameIndication (SNI) switch. + * `sni` - ServerNameIndication (SNI). + + diff --git a/config/docs/d/gaap_layer4_listeners.html.markdown b/config/docs/d/gaap_layer4_listeners.html.markdown new file mode 100644 index 0000000..88bcd99 --- /dev/null +++ b/config/docs/d/gaap_layer4_listeners.html.markdown @@ -0,0 +1,83 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_layer4_listeners" +sidebar_current: "docs-tencentcloud-datasource-gaap_layer4_listeners" +description: |- + Use this data source to query gaap layer4 listeners. +--- + +# tencentcloud_gaap_layer4_listeners + +Use this data source to query gaap layer4 listeners. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_realserver" "foo" { + ip = "1.1.1.1" + name = "ci-test-gaap-realserver" +} + +resource "tencentcloud_gaap_layer4_listener" "foo" { + protocol = "TCP" + name = "ci-test-gaap-4-listener" + port = 80 + realserver_type = "IP" + proxy_id = tencentcloud_gaap_proxy.foo.id + health_check = true + interval = 5 + connect_timeout = 2 + + realserver_bind_set { + id = tencentcloud_gaap_realserver.foo.id + ip = tencentcloud_gaap_realserver.foo.ip + port = 80 + } +} + +data "tencentcloud_gaap_layer4_listeners" "foo" { + protocol = "TCP" + proxy_id = tencentcloud_gaap_proxy.foo.id + listener_id = tencentcloud_gaap_layer4_listener.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `protocol` - (Required, String) Protocol of the layer4 listener to be queried. Valid values: `TCP` and `UDP`. +* `listener_id` - (Optional, String) ID of the layer4 listener to be queried. +* `listener_name` - (Optional, String) Name of the layer4 listener to be queried. +* `port` - (Optional, Int) Port of the layer4 listener to be queried. +* `proxy_id` - (Optional, String) ID of the GAAP proxy to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `listeners` - An information list of layer4 listeners. Each element contains the following attributes: + * `connect_timeout` - Timeout of the health check response. + * `create_time` - Creation time of the layer4 listener. + * `health_check` - Indicates whether health check is enable. + * `id` - ID of the layer4 listener. + * `interval` - Interval of the health check. + * `name` - Name of the layer4 listener. + * `port` - Port of the layer4 listener. + * `protocol` - Protocol of the layer4 listener. + * `proxy_id` - ID of the GAAP proxy. + * `realserver_type` - Type of the realserver. + * `scheduler` - Scheduling policy of the layer4 listener. + * `status` - Status of the layer4 listener. + + diff --git a/config/docs/d/gaap_layer7_listeners.html.markdown b/config/docs/d/gaap_layer7_listeners.html.markdown new file mode 100644 index 0000000..b24ec5c --- /dev/null +++ b/config/docs/d/gaap_layer7_listeners.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_layer7_listeners" +sidebar_current: "docs-tencentcloud-datasource-gaap_layer7_listeners" +description: |- + Use this data source to query gaap layer7 listeners. +--- + +# tencentcloud_gaap_layer7_listeners + +Use this data source to query gaap layer7 listeners. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_layer7_listener" "foo" { + protocol = "HTTP" + name = "ci-test-gaap-l7-listener" + port = 80 + proxy_id = tencentcloud_gaap_proxy.foo.id +} + +data "tencentcloud_gaap_layer7_listeners" "listenerId" { + protocol = "HTTP" + proxy_id = tencentcloud_gaap_proxy.foo.id + listener_id = tencentcloud_gaap_layer7_listener.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `protocol` - (Required, String) Protocol of the layer7 listener to be queried. Valid values: `HTTP` and `HTTPS`. +* `listener_id` - (Optional, String) ID of the layer7 listener to be queried. +* `listener_name` - (Optional, String) Name of the layer7 listener to be queried. +* `port` - (Optional, Int) Port of the layer7 listener to be queried. +* `proxy_id` - (Optional, String) ID of the GAAP proxy to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `listeners` - An information list of layer7 listeners. Each element contains the following attributes: + * `auth_type` - Authentication type of the layer7 listener. `0` is one-way authentication and `1` is mutual authentication. + * `certificate_id` - Certificate ID of the layer7 listener. + * `client_certificate_id` - (**Deprecated**) It has been deprecated from version 1.26.0. Use `client_certificate_ids` instead. ID of the client certificate. + * `client_certificate_ids` - ID list of the client certificate. + * `create_time` - Creation time of the layer7 listener. + * `forward_protocol` - Protocol type of the forwarding. + * `id` - ID of the layer7 listener. + * `name` - Name of the layer7 listener. + * `port` - Port of the layer7 listener. + * `protocol` - Protocol of the layer7 listener. + * `proxy_id` - ID of the GAAP proxy. + * `status` - Status of the layer7 listener. + + diff --git a/config/docs/d/gaap_listener_real_servers.html.markdown b/config/docs/d/gaap_listener_real_servers.html.markdown new file mode 100644 index 0000000..f8fecb6 --- /dev/null +++ b/config/docs/d/gaap_listener_real_servers.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_listener_real_servers" +sidebar_current: "docs-tencentcloud-datasource-gaap_listener_real_servers" +description: |- + Use this data source to query detailed information of gaap listener real servers +--- + +# tencentcloud_gaap_listener_real_servers + +Use this data source to query detailed information of gaap listener real servers + +## Example Usage + +```hcl +data "tencentcloud_gaap_listener_real_servers" "listener_real_servers" { + listener_id = "listener-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `listener_id` - (Required, String) listener ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `bind_real_server_set` - Bound real server Information List. + * `down_i_p_list` - When the real server is a domain name, the domain name is resolved to one or more IPs, and this field represents the list of abnormal IPs. When the status is abnormal, but the field is empty, it indicates that the domain name resolution is abnormal. + * `real_server_failover_role` - The primary and secondary roles of the real server, 'master' represents primary, 'slave' represents secondary, and this parameter must be in the active and standby mode of the real server when the listener is turned on. + * `real_server_i_p` - Real Server IP or domain. + * `real_server_id` - Real Server Id. + * `real_server_port` - The port number of the real serverNote: This field may return null, indicating that a valid value cannot be obtained. + * `real_server_status` - real server health check status, where:0 indicates normal;1 indicates an exception.When the health check status is not enabled, it is always normal.Note: This field may return null, indicating that a valid value cannot be obtained. + * `real_server_weight` - The weight of this real server. +* `real_server_set` - Real Server Set. + * `in_ban_blacklist` - Is it on the banned blacklist? 0 indicates not on the blacklist, and 1 indicates on the blacklist. + * `project_id` - Project Id. + * `real_server_i_p` - Real Server IP. + * `real_server_id` - Real Server Id. + * `real_server_name` - Real Server Name. + + diff --git a/config/docs/d/gaap_listener_statistics.html.markdown b/config/docs/d/gaap_listener_statistics.html.markdown new file mode 100644 index 0000000..51b24fb --- /dev/null +++ b/config/docs/d/gaap_listener_statistics.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_listener_statistics" +sidebar_current: "docs-tencentcloud-datasource-gaap_listener_statistics" +description: |- + Use this data source to query detailed information of gaap listener statistics +--- + +# tencentcloud_gaap_listener_statistics + +Use this data source to query detailed information of gaap listener statistics + +## Example Usage + +```hcl +data "tencentcloud_gaap_listener_statistics" "listener_statistics" { + listener_id = "listener-xxxxxx" + start_time = "2023-10-19 00:00:00" + end_time = "2023-10-19 23:59:59" + metric_names = ["InBandwidth", "OutBandwidth", "InPackets", "OutPackets", "Concurrent"] + granularity = 300 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) End Time. +* `granularity` - (Required, Int) Monitoring granularity, currently supporting 300 3600 86400, in seconds.The query time range does not exceed 1 day and supports a minimum granularity of 300 seconds;The query interval should not exceed 7 days and support a minimum granularity of 3600 seconds;The query interval exceeds 7 days and supports a minimum granularity of 86400 seconds. +* `listener_id` - (Required, String) Listener Id. +* `metric_names` - (Required, Set: [`String`]) List of statistical indicator names. Supporting: InBandwidth, OutBandwidth, Concurrent, InPackets, OutPackets. +* `start_time` - (Required, String) Start Time. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `statistics_data` - Channel Group Statistics. + * `metric_data` - Metric Data. + * `data` - Statistical data valueNote: This field may return null, indicating that a valid value cannot be obtained. + * `time` - Time. + * `metric_name` - Metric Name. + + diff --git a/config/docs/d/gaap_proxies.html.markdown b/config/docs/d/gaap_proxies.html.markdown new file mode 100644 index 0000000..0ad1724 --- /dev/null +++ b/config/docs/d/gaap_proxies.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_proxies" +sidebar_current: "docs-tencentcloud-datasource-gaap_proxies" +description: |- + Use this data source to query gaap proxies. +--- + +# tencentcloud_gaap_proxies + +Use this data source to query gaap proxies. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +data "tencentcloud_gaap_proxies" "foo" { + ids = [tencentcloud_gaap_proxy.foo.id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_region` - (Optional, String) Access region of the GAAP proxy to be queried. Conflict with `ids`. +* `ids` - (Optional, Set: [`String`]) ID of the GAAP proxy to be queried. Conflict with `project_id`, `access_region` and `realserver_region`. +* `project_id` - (Optional, Int) Project ID of the GAAP proxy to be queried. Conflict with `ids`. +* `realserver_region` - (Optional, String) Region of the GAAP realserver to be queried. Conflict with `ids`. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) Tags of the GAAP proxy to be queried. Support up to 5, display the information as long as it matches one. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `proxies` - An information list of GAAP proxy. Each element contains the following attributes: + * `access_region` - Access region of the GAAP proxy. + * `bandwidth` - Maximum bandwidth of the GAAP proxy, unit is Mbps. + * `concurrent` - Maximum concurrency of the GAAP proxy, unit is 10k. + * `create_time` - Creation time of the GAAP proxy. + * `domain` - Access domain of the GAAP proxy. + * `forward_ip` - Forwarding IP of the GAAP proxy. + * `id` - ID of the GAAP proxy. + * `ip` - Access domain of the GAAP proxy. + * `name` - Name of the GAAP proxy. + * `policy_id` - Security policy ID of the GAAP proxy. + * `project_id` - ID of the project within the GAAP proxy, '0' means is default project. + * `realserver_region` - Region of the GAAP realserver. + * `scalable` - Indicates whether GAAP proxy can scalable. + * `status` - Status of the GAAP proxy. + * `support_protocols` - Supported protocols of the GAAP proxy. + * `tags` - Tags of the GAAP proxy. + * `version` - Version of the GAAP proxy. + + diff --git a/config/docs/d/gaap_proxies_status.html.markdown b/config/docs/d/gaap_proxies_status.html.markdown new file mode 100644 index 0000000..79979ea --- /dev/null +++ b/config/docs/d/gaap_proxies_status.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_proxies_status" +sidebar_current: "docs-tencentcloud-datasource-gaap_proxies_status" +description: |- + Use this data source to query detailed information of gaap proxies status +--- + +# tencentcloud_gaap_proxies_status + +Use this data source to query detailed information of gaap proxies status + +## Example Usage + +```hcl +data "tencentcloud_gaap_proxies_status" "proxies_status" { + proxy_ids = ["link-xxxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `proxy_ids` - (Optional, Set: [`String`]) List of Proxy IDs. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_status_set` - Proxy status list. + * `instance_id` - proxy instance ID. + * `status` - proxy status.Among them: +- RUNNING indicates running; +- CREATING indicates being created; +- DESTROYING indicates being destroyed; +- OPENING indicates being opened; +- CLOSING indicates being closed; +- Closed indicates that it has been closed; +- ADJUSTING represents a configuration change in progress; +- ISOLATING indicates being isolated; +- ISOLATED indicates that it has been isolated; +- MOVING indicates that migration is in progress. + + diff --git a/config/docs/d/gaap_proxy_and_statistics_listeners.html.markdown b/config/docs/d/gaap_proxy_and_statistics_listeners.html.markdown new file mode 100644 index 0000000..2491484 --- /dev/null +++ b/config/docs/d/gaap_proxy_and_statistics_listeners.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_proxy_and_statistics_listeners" +sidebar_current: "docs-tencentcloud-datasource-gaap_proxy_and_statistics_listeners" +description: |- + Use this data source to query detailed information of gaap proxy and statistics listeners +--- + +# tencentcloud_gaap_proxy_and_statistics_listeners + +Use this data source to query detailed information of gaap proxy and statistics listeners + +## Example Usage + +```hcl +data "tencentcloud_gaap_proxy_and_statistics_listeners" "proxy_and_statistics_listeners" { + project_id = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Required, Int) Project Id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `proxy_set` - proxy information that can be counted. + * `listener_list` - Listener List. + * `listener_id` - Listener Id. + * `listener_name` - Listener Name. + * `port` - listerned port. + * `protocol` - Listener protocol type. + * `proxy_id` - Proxy Id. + * `proxy_name` - Proxy Name. + + diff --git a/config/docs/d/gaap_proxy_detail.html.markdown b/config/docs/d/gaap_proxy_detail.html.markdown new file mode 100644 index 0000000..c7e6e3c --- /dev/null +++ b/config/docs/d/gaap_proxy_detail.html.markdown @@ -0,0 +1,91 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_proxy_detail" +sidebar_current: "docs-tencentcloud-datasource-gaap_proxy_detail" +description: |- + Use this data source to query detailed information of gaap proxy detail +--- + +# tencentcloud_gaap_proxy_detail + +Use this data source to query detailed information of gaap proxy detail + +## Example Usage + +```hcl +data "tencentcloud_gaap_proxy_detail" "proxy_detail" { + proxy_id = "link-8lpyo88p" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `proxy_id` - (Required, String) Proxy Id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `proxy_detail` - Proxy Detail. + * `access_region_info` - Detailed information about the access region, including the region ID and domain name.Note: This field may return null, indicating that a valid value cannot be obtained. + * `feature_bitmap` - Property bitmap, where each bit represents a property, where:0 indicates that the feature is not supported;1, indicates support for this feature.The meaning of the feature bitmap is as follows (from right to left):The first bit supports 4-layer acceleration;The second bit supports 7-layer acceleration;The third bit supports Http3 access;The fourth bit supports IPv6;The fifth bit supports high-quality BGP access;The 6th bit supports three network access;The 7th bit supports QoS acceleration in the access segment.Note: This field may return null, indicating that a valid value cannot be obtained. + * `idc_type` - The type of computer room, where dc represents the DataCenter data center and ec represents the EdgeComputing edge node. + * `region_area_name` - Region name of the computer room. + * `region_area` - Region of the computer room. + * `region_id` - Region Id. + * `region_name` - Region Name. + * `support_feature` - Ability to access regional supportNote: This field may return null, indicating that a valid value cannot be obtained. + * `network_type` - A list of network types supported by the access area, with normal indicating support for regular BGP, cn2 indicating premium BGP, triple indicating three networks, and secure_EIP represents a custom secure EIP. + * `access_region` - Access Region. + * `ban_status` - Blocking and Unblocking Status: BANNED indicates that the ban has been lifted, RECOVER indicates that the ban has been lifted or not, BANNING indicates that the ban is in progress, RECOVERING indicates that the ban is being lifted, BAN_FAILED indicates that the ban has failed, RECOVER_FAILED indicates that the unblocking has failed.Note: This field may return null, indicating that a valid value cannot be obtained. + * `bandwidth` - Band width, in Mbps. + * `billing_type` - Billing type: 0 represents bandwidth based billing, and 1 represents traffic based billing.Note: This field may return null, indicating that a valid value cannot be obtained. + * `client_ip_method` - The method of obtaining client IP through proxys, where 0 represents TOA and 1 represents Proxy ProtocolNote: This field may return null, indicating that a valid value cannot be obtained. + * `concurrent` - Concurrent, in 10000 pieces/second. + * `create_time` - The creation time, using a Unix timestamp, represents the number of seconds that have passed since January 1, 1970 (midnight UTC/GMT). + * `domain` - Domain. + * `feature_bitmap` - Property bitmap, where each bit represents a property, where:0 indicates that the feature is not supported;1, indicates support for this feature.The meaning of the feature bitmap is as follows (from right to left):The first bit supports 4-layer acceleration;The second bit supports 7-layer acceleration;The third bit supports Http3 access;The fourth bit supports IPv6;The fifth bit supports high-quality BGP access;The 6th bit supports three network access;The 7th bit supports QoS acceleration in the access segment.Note: This field may return null, indicating that a valid value cannot be obtained.Note: This field may return null, indicating that a valid value cannot be obtained. + * `forward_ip` - proxy forwarding IP. + * `group_id` - proxy group ID, which exists when a proxy belongs to a certain proxy group.Note: This field may return null, indicating that a valid value cannot be obtained. + * `http3_supported` - Identification that supports the Http3 protocol, where:0 indicates shutdown;1 indicates enabled.Note: This field may return null, indicating that a valid value cannot be obtained. + * `in_ban_blacklist` - Is it on the banned blacklist? 0 indicates not on the blacklist, and 1 indicates on the blacklist.Note: This field may return null, indicating that a valid value cannot be obtained. + * `instance_id` - (Old parameter, please use ProxyId) Proxy instance ID.Note: This field may return null, indicating that a valid value cannot be obtained. + * `ip_address_version` - IP version: IPv4, IPv6Note: This field may return null, indicating that a valid value cannot be obtained. + * `ip_list` - IP ListNote: This field may return null, indicating that a valid value cannot be obtained. + * `bandwidth` - Band width. + * `ip` - IP. + * `provider` - Supplier, BGP represents default, CMCC represents China Mobile, CUCC represents China Unicom, and CTCC represents China Telecom. + * `ip` - IP. + * `modify_config_time` - Configuration change timeNote: This field may return null, indicating that a valid value cannot be obtained. + * `network_type` - Network type: normal represents regular BGP, cn2 represents premium BGP, triple represents triple network, secure_EIP represents customized security EIPNote: This field may return null, indicating that a valid value cannot be obtained. + * `package_type` - proxy package type: Thunder represents standard proxy, Accelerator represents silver acceleration proxy,CrossBorder represents a cross-border proxy.Note: This field may return null, indicating that a valid value cannot be obtained. + * `policy_id` - Security policy ID, which exists when a security policy is set.Note: This field may return null, indicating that a valid value cannot be obtained. + * `project_id` - Project Id. + * `proxy_id` - (New parameter) proxy instance ID.Note: This field may return null, indicating that a valid value cannot be obtained. + * `proxy_name` - Proxy Name. + * `proxy_type` - proxy type, 100 represents THUNDER proxy, 103 represents Microsoft cooperation proxyNote: This field may return null, indicating that a valid value cannot be obtained. + * `real_server_region_info` - Detailed information of the real server region, including the region ID and domain name.Note: This field may return null, indicating that a valid value cannot be obtained. + * `feature_bitmap` - Property bitmap, where each bit represents a property, where:0 indicates that the feature is not supported;1, indicates support for this feature.The meaning of the feature bitmap is as follows (from right to left):The first bit supports 4-layer acceleration;The second bit supports 7-layer acceleration;The third bit supports Http3 access;The fourth bit supports IPv6;The fifth bit supports high-quality BGP access;The 6th bit supports three network access;The 7th bit supports QoS acceleration in the access segment.Note: This field may return null, indicating that a valid value cannot be obtained. + * `idc_type` - The type of computer room, where dc represents the DataCenter data center and ec represents the EdgeComputing edge node. + * `region_area_name` - Region name of the computer room. + * `region_area` - Region of the computer room. + * `region_id` - Region Id. + * `region_name` - Region Name. + * `support_feature` - Ability to access regional supportNote: This field may return null, indicating that a valid value cannot be obtained. + * `network_type` - A list of network types supported by the access area, with normal indicating support for regular BGP, cn2 indicating premium BGP, triple indicating three networks, and secure_EIP represents a custom secure EIP. + * `real_server_region` - Real Server Region. + * `related_global_domains` - List of domain names associated with resolutionNote: This field may return null, indicating that a valid value cannot be obtained. + * `scalarable` - 1. This proxy can be scaled and expanded; 0, this proxy cannot be scaled or expanded. + * `status` - proxy status. Among them:RUNNING indicates running;CREATING indicates being created;DESTROYING indicates being destroyed;OPENING indicates being opened;CLOSING indicates being closed;Closed indicates that it has been closed;ADJUSTING represents a configuration change in progress;ISOLATING indicates being isolated;ISOLATED indicates that it has been isolated;CLONING indicates copying;RECOVERING indicates that the proxy is being maintained;MOVING indicates that migration is in progress. + * `support_protocols` - Supported protocol types. + * `support_security` - Does it support security group configurationNote: This field may return null, indicating that a valid value cannot be obtained. + * `tag_set` - tag list, when there are no labels, this field is an empty list.Note: This field may return null, indicating that a valid value cannot be obtained. + * `tag_key` - Tag Key. + * `tag_value` - Tag Value. + * `version` - Version 1.0, 2.0, 3.0. + + diff --git a/config/docs/d/gaap_proxy_group_statistics.html.markdown b/config/docs/d/gaap_proxy_group_statistics.html.markdown new file mode 100644 index 0000000..e25000d --- /dev/null +++ b/config/docs/d/gaap_proxy_group_statistics.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_proxy_group_statistics" +sidebar_current: "docs-tencentcloud-datasource-gaap_proxy_group_statistics" +description: |- + Use this data source to query detailed information of gaap proxy group statistics +--- + +# tencentcloud_gaap_proxy_group_statistics + +Use this data source to query detailed information of gaap proxy group statistics + +## Example Usage + +```hcl +data "tencentcloud_gaap_proxy_group_statistics" "proxy_group_statistics" { + group_id = "link-8lpyo88p" + start_time = "2023-10-09 00:00:00" + end_time = "2023-10-09 23:59:59" + metric_names = ["InBandwidth", "OutBandwidth", "InFlow", "OutFlow"] + granularity = 300 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) End Time. +* `granularity` - (Required, Int) Monitoring granularity, currently supporting 60 300 3600 86400, in seconds.When the time range does not exceed 1 day, support a minimum granularity of 60 seconds;When the time range does not exceed 7 days, support a minimum granularity of 3600 seconds;When the time range does not exceed 30 days, the minimum granularity supported is 86400 seconds. +* `group_id` - (Required, String) Group Id. +* `metric_names` - (Required, Set: [`String`]) Metric Names. support, InBandwidth, OutBandwidth, Concurrent, InPackets, OutPackets. +* `start_time` - (Required, String) Start Time. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `statistics_data` - proxy Group Statistics. + * `metric_data` - Metric Data. + * `data` - DataNote: This field may return null, indicating that a valid value cannot be obtained. + * `time` - Time. + * `metric_name` - Metric Name. + + diff --git a/config/docs/d/gaap_proxy_groups.html.markdown b/config/docs/d/gaap_proxy_groups.html.markdown new file mode 100644 index 0000000..2cc9eb0 --- /dev/null +++ b/config/docs/d/gaap_proxy_groups.html.markdown @@ -0,0 +1,73 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_proxy_groups" +sidebar_current: "docs-tencentcloud-datasource-gaap_proxy_groups" +description: |- + Use this data source to query detailed information of gaap proxy groups +--- + +# tencentcloud_gaap_proxy_groups + +Use this data source to query detailed information of gaap proxy groups + +## Example Usage + +```hcl +data "tencentcloud_gaap_proxy_groups" "proxy_groups" { + project_id = 0 + filters { + name = "GroupId" + values = ["lg-5anbbou5"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Required, Int) Project ID. Value range:-1, All projects under this user0, default projectOther values, specified items. +* `filters` - (Optional, List) Filter conditions,The upper limit of Filter.Values per request is 5.RealServerRegion - String - Required: No - (filtering criteria) Filter by real server region, refer to the RegionId in the returned results of the DescribeDestRegions interface.PackageType - String - Required: No - (Filter condition) proxy group type, where &#39;Thunder&#39; represents the standard proxy group and &#39;Accelerator&#39; represents the silver acceleration proxy group. +* `result_output_file` - (Optional, String) Used to save results. +* `tag_set` - (Optional, List) Tag list, when this field exists, pulls the resource list under the corresponding tag.Supports a maximum of 5 labels. When there are two or more labels and any one of them is met, the proxy group will be pulled out. + +The `filters` object supports the following: + +* `name` - (Required, String) Filter conditions. +* `values` - (Required, Set) filtering value. + +The `tag_set` object supports the following: + +* `tag_key` - (Required, String) Tag Key. +* `tag_value` - (Required, String) Tag Value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `proxy_group_list` - List of proxy groups.Note: This field may return null, indicating that a valid value cannot be obtained. + * `create_time` - Create TimeNote: This field may return null, indicating that a valid value cannot be obtained. + * `domain` - proxy group domain nameNote: This field may return null, indicating that a valid value cannot be obtained. + * `feature_bitmap` - Property bitmap, where each bit represents a property, where:0, indicates that the feature is not supported;1, indicates support for this feature.The meaning of the feature bitmap is as follows (from right to left):The first bit supports 4-layer acceleration;The second bit supports 7-layer acceleration;The third bit supports Http3 access;The fourth bit supports IPv6;The fifth bit supports high-quality BGP access;The 6th bit supports three network access;The 7th bit supports QoS acceleration in the access segment.Note: This field may return null, indicating that a valid value cannot be obtained. + * `group_id` - proxy group Id. + * `group_name` - proxy Group NameNote: This field may return null, indicating that a valid value cannot be obtained. + * `http3_supported` - Supports the identification of Http3 features, where:0 indicates shutdown;1 indicates enabled.Note: This field may return null, indicating that a valid value cannot be obtained. + * `project_id` - Project Id. + * `proxy_type` - Does the proxy group include Microsoft proxysNote: This field may return null, indicating that a valid value cannot be obtained. + * `real_server_region_info` - Real Server Region Info. + * `feature_bitmap` - Property bitmap, where each bit represents a property, where:0, indicates that the feature is not supported;1, indicates support for this feature.The meaning of the feature bitmap is as follows (from right to left):The first bit supports 4-layer acceleration;The second bit supports 7-layer acceleration;The third bit supports Http3 access;The fourth bit supports IPv6;The fifth bit supports high-quality BGP access;The 6th bit supports three network access;The 7th bit supports QoS acceleration in the access segment.Note: This field may return null, indicating that a valid value cannot be obtained. + * `idc_type` - The type of computer room, where 'dc' represents the DataCenter data center and 'ec' represents the EdgeComputing edge node. + * `region_area_name` - Region name of the computer room. + * `region_area` - Region of the computer room. + * `region_id` - Region Id. + * `region_name` - Region Name. + * `support_feature` - Ability to access regional supportNote: This field may return null, indicating that a valid value cannot be obtained. + * `network_type` - A list of network types supported by the access area, with 'normal' indicating support for regular BGP, 'cn2' indicating premium BGP, 'triple' indicating three networks, and 'secure_EIP' represents a custom secure EIP. + * `status` - proxy group status.Among them,'RUNNING' indicates running;'CREATING' indicates being created;'DESTROYING' indicates being destroyed;'MOVING' indicates that the proxy is being migrated;'CHANGING' indicates partial deployment. + * `tag_set` - Tag Set. + * `tag_key` - Tag Key. + * `tag_value` - Tag Value. + * `version` - proxy Group VersionNote: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/gaap_proxy_statistics.html.markdown b/config/docs/d/gaap_proxy_statistics.html.markdown new file mode 100644 index 0000000..626e1a0 --- /dev/null +++ b/config/docs/d/gaap_proxy_statistics.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_proxy_statistics" +sidebar_current: "docs-tencentcloud-datasource-gaap_proxy_statistics" +description: |- + Use this data source to query detailed information of gaap proxy statistics +--- + +# tencentcloud_gaap_proxy_statistics + +Use this data source to query detailed information of gaap proxy statistics + +## Example Usage + +```hcl +data "tencentcloud_gaap_proxy_statistics" "proxy_statistics" { + proxy_id = "link-8lpyo88p" + start_time = "2023-10-09 00:00:00" + end_time = "2023-10-09 23:59:59" + metric_names = ["InBandwidth", "OutBandwidth", "InFlow", "OutFlow", "InPackets", "OutPackets", "Concurrent", "HttpQPS", "HttpsQPS", "Latency", "PacketLoss"] + granularity = 300 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) End Time(2019-03-25 12:00:00). +* `granularity` - (Required, Int) Monitoring granularity, currently supporting 60 300 3600 86400, in seconds.When the time range does not exceed 3 days, support a minimum granularity of 60 seconds;When the time range does not exceed 7 days, support a minimum granularity of 300 seconds;When the time range does not exceed 30 days, the minimum granularity supported is 3600 seconds. +* `metric_names` - (Required, Set: [`String`]) Metric Names. Valid values: InBandwidth,OutBandwidth, Concurrent, InPackets, OutPackets, PacketLoss, Latency, HttpQPS, HttpsQPS. +* `proxy_id` - (Required, String) Proxy Id. +* `start_time` - (Required, String) Start Time(2019-03-25 12:00:00). +* `isp` - (Optional, String) Operator (valid when the proxy is a three network proxy), supports CMCC, CUCC, CTCC, and merges data from the three operators if null values are passed or not passed. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `statistics_data` - proxy Statistics. + * `metric_data` - Metric Data. + * `data` - DataNote: This field may return null, indicating that a valid value cannot be obtained. + * `time` - Time. + * `metric_name` - Metric Name. + + diff --git a/config/docs/d/gaap_real_servers_status.html.markdown b/config/docs/d/gaap_real_servers_status.html.markdown new file mode 100644 index 0000000..77055e1 --- /dev/null +++ b/config/docs/d/gaap_real_servers_status.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_real_servers_status" +sidebar_current: "docs-tencentcloud-datasource-gaap_real_servers_status" +description: |- + Use this data source to query detailed information of gaap real servers status +--- + +# tencentcloud_gaap_real_servers_status + +Use this data source to query detailed information of gaap real servers status + +## Example Usage + +```hcl +data "tencentcloud_gaap_real_servers_status" "real_servers_status" { + real_server_ids = ["rs-qcygnwpd"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `real_server_ids` - (Required, Set: [`String`]) Real Server Ids. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `real_server_status_set` - Real Server Status Set. + * `bind_status` - Bind Status, 0 indicates unbound, 1 indicates bound by rules or listeners. + * `group_id` - Bind the group ID of this real server, which is an empty string when not bound.Note: This field may return null, indicating that a valid value cannot be obtained. + * `proxy_id` - Bind the proxy ID of this real server, which is an empty string when not bound. + * `real_server_id` - Real Server Id. + + diff --git a/config/docs/d/gaap_realservers.html.markdown b/config/docs/d/gaap_realservers.html.markdown new file mode 100644 index 0000000..a9db9b0 --- /dev/null +++ b/config/docs/d/gaap_realservers.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_realservers" +sidebar_current: "docs-tencentcloud-datasource-gaap_realservers" +description: |- + Use this data source to query gaap realservers. +--- + +# tencentcloud_gaap_realservers + +Use this data source to query gaap realservers. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_realserver" "foo" { + ip = "1.1.1.1" + name = "ci-test-gaap-realserver" +} + +data "tencentcloud_gaap_realservers" "foo" { + ip = tencentcloud_gaap_realserver.foo.ip +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Optional, String) Domain of the GAAP realserver to be queried, conflict with `ip`. +* `ip` - (Optional, String) IP of the GAAP realserver to be queried, conflict with `domain`. +* `name` - (Optional, String) Name of the GAAP realserver to be queried, the maximum length is 30. +* `project_id` - (Optional, Int) ID of the project within the GAAP realserver to be queried, default value is `-1`, no set means all projects. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) Tags of the GAAP proxy to be queried. Support up to 5, display the information as long as it matches one. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `realservers` - An information list of GAAP realserver. Each element contains the following attributes: + * `domain` - Domain of the GAAP realserver. + * `id` - ID of the GAAP realserver. + * `ip` - IP of the GAAP realserver. + * `name` - Name of the GAAP realserver. + * `project_id` - ID of the project within the GAAP realserver. + * `tags` - Tags of the GAAP realserver. + + diff --git a/config/docs/d/gaap_region_and_price.html.markdown b/config/docs/d/gaap_region_and_price.html.markdown new file mode 100644 index 0000000..e00b806 --- /dev/null +++ b/config/docs/d/gaap_region_and_price.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_region_and_price" +sidebar_current: "docs-tencentcloud-datasource-gaap_region_and_price" +description: |- + Use this data source to query detailed information of gaap region and price +--- + +# tencentcloud_gaap_region_and_price + +Use this data source to query detailed information of gaap region and price + +## Example Usage + +```hcl +data "tencentcloud_gaap_region_and_price" "region_and_price" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ip_address_version` - (Optional, String) IP version. Available values: IPv4, IPv6. Default is IPv4. +* `package_type` - (Optional, String) Type of channel package. `Thunder` represents standard channel group, `Accelerator` represents game accelerator channel, and `CrossBorder` represents cross-border channel. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `bandwidth_unit_price` - proxy bandwidth cost gradient price. + * `bandwidth_range` - Band width Range. + * `bandwidth_unit_price` - Band width Unit Price, Unit:yuan/Mbps/day. + * `discount_bandwidth_unit_price` - Bandwidth discount price, unit:yuan/Mbps/day. +* `currency` - Bandwidth Price Currency Type:CNYUSD. +* `dest_region_set` - Source Site Area Details List. + * `feature_bitmap` - Property bitmap, where each bit represents a property, where:0, indicates that the feature is not supported;1, indicates support for this feature.The meaning of the feature bitmap is as follows (from right to left):The first bit supports 4-layer acceleration;The second bit supports 7-layer acceleration;The third bit supports Http3 access;The fourth bit supports IPv6;The fifth bit supports high-quality BGP access;The 6th bit supports three network access;The 7th bit supports QoS acceleration in the access segment.Note: This field may return null, indicating that a valid value cannot be obtained. + * `idc_type` - Type of computer room, dc represents DataCenter data center, ec represents EdgeComputing edge node. + * `region_area_name` - Region name of the computer room. + * `region_area` - Region of the computer room. + * `region_id` - Region Id. + * `region_name` - Region Name. + * `support_feature` - Ability to access regional supportNote: This field may return null, indicating that a valid value cannot be obtained. + * `network_type` - A list of network types supported by the access area, with `normal` indicating support for regular BGP, `cn2` indicating premium BGP, `triple` indicating three networks, and `secure_eip` represents a custom secure EIP. + + diff --git a/config/docs/d/gaap_resources_by_tag.html.markdown b/config/docs/d/gaap_resources_by_tag.html.markdown new file mode 100644 index 0000000..cd21b7d --- /dev/null +++ b/config/docs/d/gaap_resources_by_tag.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_resources_by_tag" +sidebar_current: "docs-tencentcloud-datasource-gaap_resources_by_tag" +description: |- + Use this data source to query detailed information of gaap resources by tag +--- + +# tencentcloud_gaap_resources_by_tag + +Use this data source to query detailed information of gaap resources by tag + +## Example Usage + +```hcl +data "tencentcloud_gaap_resources_by_tag" "resources_by_tag" { + tag_key = "tagKey" + tag_value = "tagValue" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `tag_key` - (Required, String) Tag key. +* `tag_value` - (Required, String) Tag value. +* `resource_type` - (Optional, String) Resource type, where:Proxy represents the proxy;ProxyGroup represents a proxy group;RealServer represents the Real Server.If this field is not specified, all resources under the label will be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `resource_set` - List of resources corresponding to labels. + * `resource_id` - Resource Id. + * `resource_type` - Resource type, where:Proxy represents the proxy,ProxyGroup represents a proxy group,RealServer represents the real server. + + diff --git a/config/docs/d/gaap_rule_real_servers.html.markdown b/config/docs/d/gaap_rule_real_servers.html.markdown new file mode 100644 index 0000000..59b8682 --- /dev/null +++ b/config/docs/d/gaap_rule_real_servers.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_rule_real_servers" +sidebar_current: "docs-tencentcloud-datasource-gaap_rule_real_servers" +description: |- + Use this data source to query detailed information of gaap rule real servers +--- + +# tencentcloud_gaap_rule_real_servers + +Use this data source to query detailed information of gaap rule real servers + +## Example Usage + +```hcl +data "tencentcloud_gaap_rule_real_servers" "rule_real_servers" { + rule_id = "rule-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `rule_id` - (Required, String) Rule Id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `bind_real_server_set` - Bind Real Server info. + * `down_ip_list` - When the real server is a domain name, the domain name is resolved to one or more IPs, and this field represents the list of abnormal IPs. When the status is abnormal, but the field is empty, it indicates that the domain name resolution is abnormal. + * `real_server_failover_role` - The primary and secondary roles of the real server:master represents primary, slave represents secondary, and this parameter must be in the active and standby mode of the real server when the listener is turned on. + * `real_server_id` - Real Server Id. + * `real_server_ip` - Real Server Ip or domain. + * `real_server_port` - Real Server PortNote: This field may return null, indicating that a valid value cannot be obtained. + * `real_server_status` - RealServerStatus: 0 indicates normal;1 indicates an exception.When the health check status is not enabled, it is always normal.Note: This field may return null, indicating that a valid value cannot be obtained. + * `real_server_weight` - Real Server Weight. +* `real_server_set` - Real Server Set. + * `in_ban_blacklist` - Is it on the banned blacklist? 0 indicates not on the blacklist, and 1 indicates on the blacklist. + * `project_id` - Project Id. + * `real_server_id` - Real Server Id. + * `real_server_ip` - Real Server IP or domain. + * `real_server_name` - Real Server Name. + + diff --git a/config/docs/d/gaap_security_policies.html.markdown b/config/docs/d/gaap_security_policies.html.markdown new file mode 100644 index 0000000..00756ef --- /dev/null +++ b/config/docs/d/gaap_security_policies.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_security_policies" +sidebar_current: "docs-tencentcloud-datasource-gaap_security_policies" +description: |- + Use this data source to query security policies of GAAP proxy. +--- + +# tencentcloud_gaap_security_policies + +Use this data source to query security policies of GAAP proxy. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_security_policy" "foo" { + proxy_id = tencentcloud_gaap_proxy.foo.id + action = "ACCEPT" +} + +data "tencentcloud_gaap_security_policies" "foo" { + id = tencentcloud_gaap_security_policy.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Required, String) ID of the security policy to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `action` - Default policy. +* `proxy_id` - ID of the GAAP proxy. +* `status` - Status of the security policy. + + diff --git a/config/docs/d/gaap_security_rules.html.markdown b/config/docs/d/gaap_security_rules.html.markdown new file mode 100644 index 0000000..00d6fb0 --- /dev/null +++ b/config/docs/d/gaap_security_rules.html.markdown @@ -0,0 +1,70 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_security_rules" +sidebar_current: "docs-tencentcloud-datasource-gaap_security_rules" +description: |- + Use this data source to query security policy rule. +--- + +# tencentcloud_gaap_security_rules + +Use this data source to query security policy rule. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_security_policy" "foo" { + proxy_id = tencentcloud_gaap_proxy.foo.id + action = "ACCEPT" +} + +resource "tencentcloud_gaap_security_rule" "foo" { + policy_id = tencentcloud_gaap_security_policy.foo.id + name = "ci-test-gaap-s-rule" + cidr_ip = "1.1.1.1" + action = "ACCEPT" + protocol = "TCP" + port = "80" +} + +data "tencentcloud_gaap_security_rules" "protocol" { + policy_id = tencentcloud_gaap_security_policy.foo.id + protocol = tencentcloud_gaap_security_rule.foo.protocol +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy_id` - (Required, String) ID of the security policy to be queried. +* `action` - (Optional, String) Policy of the rule to be queried. +* `cidr_ip` - (Optional, String) A network address block of the request source to be queried. +* `name` - (Optional, String) Name of the security policy rule to be queried. +* `port` - (Optional, String) Port of the security policy rule to be queried. +* `protocol` - (Optional, String) Protocol of the security policy rule to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `rule_id` - (Optional, String) ID of the security policy rules to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `rules` - An information list of security policy rule. Each element contains the following attributes: + * `action` - Policy of the rule. + * `cidr_ip` - A network address block of the request source. + * `id` - ID of the security policy rule. + * `name` - Name of the security policy rule. + * `port` - Port of the security policy rule. + * `protocol` - Protocol of the security policy rule. + + diff --git a/config/docs/d/ha_vip_eip_attachments.html.markdown b/config/docs/d/ha_vip_eip_attachments.html.markdown new file mode 100644 index 0000000..ec762e0 --- /dev/null +++ b/config/docs/d/ha_vip_eip_attachments.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ha_vip_eip_attachments" +sidebar_current: "docs-tencentcloud-datasource-ha_vip_eip_attachments" +description: |- + Use this data source to query detailed information of HA VIP EIP attachments +--- + +# tencentcloud_ha_vip_eip_attachments + +Use this data source to query detailed information of HA VIP EIP attachments + +## Example Usage + +```hcl +data "tencentcloud_ha_vip_eip_attachments" "foo" { + havip_id = "havip-kjqwe4ba" + address_ip = "1.1.1.1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `havip_id` - (Required, String) ID of the attached HA VIP to be queried. +* `address_ip` - (Optional, String) Public IP address of EIP to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `ha_vip_eip_attachment_list` - A list of HA VIP EIP attachments. Each element contains the following attributes: + * `address_ip` - Public IP address of EIP. + * `havip_id` - ID of the attached HA VIP. + + diff --git a/config/docs/d/ha_vips.html.markdown b/config/docs/d/ha_vips.html.markdown new file mode 100644 index 0000000..9c6fcee --- /dev/null +++ b/config/docs/d/ha_vips.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ha_vips" +sidebar_current: "docs-tencentcloud-datasource-ha_vips" +description: |- + Use this data source to query detailed information of HA VIPs. +--- + +# tencentcloud_ha_vips + +Use this data source to query detailed information of HA VIPs. + +## Example Usage + +```hcl +data "tencentcloud_ha_vips" "havips" { + id = "havip-kjqwe4ba" + name = "test" + vpc_id = "vpc-gzea3dd7" + subnet_id = "subnet-4d4m4cd4" + address_ip = "10.0.4.16" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `address_ip` - (Optional, String) EIP of the HA VIP to be queried. +* `id` - (Optional, String) ID of the HA VIP to be queried. +* `name` - (Optional, String) Name of the HA VIP. The length of character is limited to 1-60. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) Subnet id of the HA VIP to be queried. +* `vpc_id` - (Optional, String) VPC id of the HA VIP to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `ha_vip_list` - Information list of the dedicated HA VIPs. + * `address_ip` - EIP that is associated. + * `create_time` - Create time of the HA VIP. + * `id` - ID of the HA VIP. + * `instance_id` - Instance id that is associated. + * `name` - Name of the HA VIP. + * `network_interface_id` - Network interface id that is associated. + * `state` - State of the HA VIP. Valid values: `AVAILABLE`, `UNBIND`. + * `subnet_id` - Subnet id. + * `vip` - Virtual IP address, it must not be occupied and in this VPC network segment. If not set, it will be assigned after resource created automatically. + * `vpc_id` - VPC id. + + diff --git a/config/docs/d/image.html.markdown b/config/docs/d/image.html.markdown new file mode 100644 index 0000000..6ee4a6a --- /dev/null +++ b/config/docs/d/image.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_image" +sidebar_current: "docs-tencentcloud-datasource-image" +description: |- + Provides an available image for the user. +--- + +# tencentcloud_image + +Provides an available image for the user. + +The Images data source fetch proper image, which could be one of the private images of the user and images of system resources provided by TencentCloud, as well as other public images and those available on the image market. + +~> **NOTE:** This data source will be deprecated, please use `tencentcloud_images` instead. + +## Example Usage + +```hcl +data "tencentcloud_image" "my_favorate_image" { + os_name = "centos" + + filter { + name = "image-type" + values = ["PUBLIC_IMAGE"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filter` - (Optional, Set) One or more name/value pairs to filter. +* `image_name_regex` - (Optional, String) A regex string to apply to the image list returned by TencentCloud. **NOTE**: it is not wildcard, should look like `image_name_regex = "^CentOS\s+6\.8\s+64\w*"`. +* `os_name` - (Optional, String) A string to apply with fuzzy match to the os_name attribute on the image list returned by TencentCloud. **NOTE**: when os_name is provided, highest priority is applied in this field instead of `image_name_regex`. +* `result_output_file` - (Optional, String) Used to save results. + +The `filter` object supports the following: + +* `name` - (Required, String) Key of the filter, valid keys: `image-id`, `image-type`, `image-name`. +* `values` - (Required, List) Values of the filter. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `image_id` - An image id indicate the uniqueness of a certain image, which can be used for instance creation or resetting. +* `image_name` - Name of this image. + + diff --git a/config/docs/d/images.html.markdown b/config/docs/d/images.html.markdown new file mode 100644 index 0000000..c1c01b8 --- /dev/null +++ b/config/docs/d/images.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_images" +sidebar_current: "docs-tencentcloud-datasource-images" +description: |- + Use this data source to query images. +--- + +# tencentcloud_images + +Use this data source to query images. + +## Example Usage + +```hcl +data "tencentcloud_images" "foo" { + image_type = ["PUBLIC_IMAGE"] + os_name = "centos 7.5" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `image_id` - (Optional, String) ID of the image to be queried. +* `image_name_regex` - (Optional, String) A regex string to apply to the image list returned by TencentCloud, conflict with 'os_name'. **NOTE**: it is not wildcard, should look like `image_name_regex = "^CentOS\s+6\.8\s+64\w*"`. +* `image_type` - (Optional, List: [`String`]) A list of the image type to be queried. Valid values: 'PUBLIC_IMAGE', 'PRIVATE_IMAGE', 'SHARED_IMAGE', 'MARKET_IMAGE'. +* `instance_type` - (Optional, String) Instance type, such as `S1.SMALL1`. +* `os_name` - (Optional, String) A string to apply with fuzzy match to the os_name attribute on the image list returned by TencentCloud, conflict with 'image_name_regex'. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `images` - An information list of image. Each element contains the following attributes: + * `architecture` - Architecture of the image. + * `created_time` - Created time of the image. + * `image_creator` - Image creator of the image. + * `image_description` - Description of the image. + * `image_id` - ID of the image. + * `image_name` - Name of the image. + * `image_size` - Size of the image. + * `image_source` - Image source of the image. + * `image_state` - State of the image. + * `image_type` - Type of the image. + * `os_name` - OS name of the image. + * `platform` - Platform of the image. + * `snapshots` - List of snapshot details. + * `disk_size` - Size of the cloud disk used to create the snapshot; unit: GB. + * `disk_usage` - Type of the cloud disk used to create the snapshot. + * `snapshot_id` - Snapshot ID. + * `snapshot_name` - Snapshot name, the user-defined snapshot alias. + * `support_cloud_init` - Whether support cloud-init. + * `sync_percent` - Sync percent of the image. + + diff --git a/config/docs/d/instance_types.html.markdown b/config/docs/d/instance_types.html.markdown new file mode 100644 index 0000000..1d41be6 --- /dev/null +++ b/config/docs/d/instance_types.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_instance_types" +sidebar_current: "docs-tencentcloud-datasource-instance_types" +description: |- + Use this data source to query instances type. +--- + +# tencentcloud_instance_types + +Use this data source to query instances type. + +## Example Usage + +```hcl +data "tencentcloud_instance_types" "foo" { + availability_zone = "ap-guangzhou-2" + cpu_core_count = 2 + memory_size = 4 +} + +data tencentcloud_instance_types "t1c1g" { + cpu_core_count = 1 + memory_size = 1 + exclude_sold_out = true + filter { + name = "instance-charge-type" + values = ["POSTPAID_BY_HOUR"] + } + filter { + name = "zone" + values = ["ap-shanghai-2"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Optional, String) The available zone that the CVM instance locates at. This field is conflict with `filter`. +* `cpu_core_count` - (Optional, Int) The number of CPU cores of the instance. +* `exclude_sold_out` - (Optional, Bool) Indicate to filter instances types that is sold out or not, default is false. +* `filter` - (Optional, Set) One or more name/value pairs to filter. This field is conflict with `availability_zone`. +* `gpu_core_count` - (Optional, Int) The number of GPU cores of the instance. +* `memory_size` - (Optional, Int) Instance memory capacity, unit in GB. +* `result_output_file` - (Optional, String) Used to save results. + +The `filter` object supports the following: + +* `name` - (Required, String) The filter name. Valid values: `zone`, `instance-family` and `instance-charge-type`. +* `values` - (Required, List) The filter values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_types` - An information list of cvm instance. Each element contains the following attributes: + * `availability_zone` - The available zone that the CVM instance locates at. + * `cpu_core_count` - The number of CPU cores of the instance. + * `family` - Type series of the instance. + * `gpu_core_count` - The number of GPU cores of the instance. + * `instance_charge_type` - Charge type of the instance. + * `instance_type` - Type of the instance. + * `memory_size` - Instance memory capacity, unit in GB. + * `status` - Sell status of the instance. + + diff --git a/config/docs/d/instances.html.markdown b/config/docs/d/instances.html.markdown new file mode 100644 index 0000000..abad8d0 --- /dev/null +++ b/config/docs/d/instances.html.markdown @@ -0,0 +1,73 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_instances" +sidebar_current: "docs-tencentcloud-datasource-instances" +description: |- + Use this data source to query cvm instances. +--- + +# tencentcloud_instances + +Use this data source to query cvm instances. + +## Example Usage + +```hcl +data "tencentcloud_instances" "foo" { + instance_id = "ins-da412f5a" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Optional, String) The available zone that the CVM instance locates at. +* `instance_id` - (Optional, String) ID of the instances to be queried. +* `instance_name` - (Optional, String) Name of the instances to be queried. +* `instance_set_ids` - (Optional, List: [`String`]) Instance set ids, max length is 100, conflict with other field. +* `project_id` - (Optional, Int) The project CVM belongs to. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) ID of a vpc subnetwork. +* `tags` - (Optional, Map) Tags of the instance. +* `vpc_id` - (Optional, String) ID of the vpc to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - An information list of cvm instance. Each element contains the following attributes: + * `allocate_public_ip` - Indicates whether public ip is assigned. + * `availability_zone` - The available zone that the CVM instance locates at. + * `cam_role_name` - CAM role name authorized to access. + * `cpu` - The number of CPU cores of the instance. + * `create_time` - Creation time of the instance. + * `data_disks` - An information list of data disk. Each element contains the following attributes: + * `data_disk_id` - Image ID of the data disk. + * `data_disk_size` - Size of the data disk. + * `data_disk_type` - Type of the data disk. + * `delete_with_instance` - Indicates whether the data disk is destroyed with the instance. + * `expired_time` - Expired time of the instance. + * `image_id` - ID of the image. + * `instance_charge_type_prepaid_renew_flag` - The way that CVM instance will be renew automatically or not when it reach the end of the prepaid tenancy. + * `instance_charge_type` - The charge type of the instance. + * `instance_id` - ID of the instances. + * `instance_name` - Name of the instances. + * `instance_type` - Type of the instance. + * `internet_charge_type` - The charge type of the instance. + * `internet_max_bandwidth_out` - Public network maximum output bandwidth of the instance. + * `memory` - Instance memory capacity, unit in GB. + * `private_ip` - Private IP of the instance. + * `project_id` - The project CVM belongs to. + * `public_ip` - Public IP of the instance. + * `security_groups` - Security groups of the instance. + * `status` - Status of the instance. + * `subnet_id` - ID of a vpc subnetwork. + * `system_disk_id` - Image ID of the system disk. + * `system_disk_size` - Size of the system disk. + * `system_disk_type` - Type of the system disk. + * `tags` - Tags of the instance. + * `vpc_id` - ID of the vpc. + + diff --git a/config/docs/d/instances_set.html.markdown b/config/docs/d/instances_set.html.markdown new file mode 100644 index 0000000..8cf2e71 --- /dev/null +++ b/config/docs/d/instances_set.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_instances_set" +sidebar_current: "docs-tencentcloud-datasource-instances_set" +description: |- + Use this data source to query cvm instances in parallel. +--- + +# tencentcloud_instances_set + +Use this data source to query cvm instances in parallel. + +## Example Usage + +```hcl +data "tencentcloud_instances_set" "foo" { + vpc_id = "vpc-4owdpnwr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Optional, String) The available zone that the CVM instance locates at. +* `instance_id` - (Optional, String) ID of the instances to be queried. +* `instance_name` - (Optional, String) Name of the instances to be queried. +* `project_id` - (Optional, Int) The project CVM belongs to. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) ID of a vpc subnetwork. +* `tags` - (Optional, Map) Tags of the instance. +* `vpc_id` - (Optional, String) ID of the vpc to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - An information list of cvm instance. Each element contains the following attributes: + * `allocate_public_ip` - Indicates whether public ip is assigned. + * `availability_zone` - The available zone that the CVM instance locates at. + * `cam_role_name` - CAM role name authorized to access. + * `cpu` - The number of CPU cores of the instance. + * `create_time` - Creation time of the instance. + * `data_disks` - An information list of data disk. Each element contains the following attributes: + * `data_disk_id` - Image ID of the data disk. + * `data_disk_size` - Size of the data disk. + * `data_disk_type` - Type of the data disk. + * `delete_with_instance` - Indicates whether the data disk is destroyed with the instance. + * `expired_time` - Expired time of the instance. + * `image_id` - ID of the image. + * `instance_charge_type_prepaid_renew_flag` - The way that CVM instance will be renew automatically or not when it reach the end of the prepaid tenancy. + * `instance_charge_type` - The charge type of the instance. + * `instance_id` - ID of the instances. + * `instance_name` - Name of the instances. + * `instance_type` - Type of the instance. + * `internet_charge_type` - The charge type of the instance. + * `internet_max_bandwidth_out` - Public network maximum output bandwidth of the instance. + * `memory` - Instance memory capacity, unit in GB. + * `private_ip` - Private IP of the instance. + * `project_id` - The project CVM belongs to. + * `public_ip` - Public IP of the instance. + * `security_groups` - Security groups of the instance. + * `status` - Status of the instance. + * `subnet_id` - ID of a vpc subnetwork. + * `system_disk_id` - Image ID of the system disk. + * `system_disk_size` - Size of the system disk. + * `system_disk_type` - Type of the system disk. + * `tags` - Tags of the instance. + * `vpc_id` - ID of the vpc. + + diff --git a/config/docs/d/key_pairs.html.markdown b/config/docs/d/key_pairs.html.markdown new file mode 100644 index 0000000..8bcff11 --- /dev/null +++ b/config/docs/d/key_pairs.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_key_pairs" +sidebar_current: "docs-tencentcloud-datasource-key_pairs" +description: |- + Use this data source to query key pairs. +--- + +# tencentcloud_key_pairs + +Use this data source to query key pairs. + +## Example Usage + +```hcl +data "tencentcloud_key_pairs" "foo" { + key_id = "skey-ie97i3ml" +} + +data "tencentcloud_key_pairs" "name" { + key_name = "^test$" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_id` - (Optional, String) ID of the key pair to be queried. +* `key_name` - (Optional, String) Name of the key pair to be queried. Support regular expression search, only `^` and `$` are supported. +* `project_id` - (Optional, Int) Project ID of the key pair to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `key_pair_list` - An information list of key pair. Each element contains the following attributes: + * `create_time` - Creation time of the key pair. + * `key_id` - ID of the key pair. + * `key_name` - Name of the key pair. + * `project_id` - Project ID of the key pair. + * `public_key` - public key of the key pair. + + diff --git a/config/docs/d/kms_describe_keys.html.markdown b/config/docs/d/kms_describe_keys.html.markdown new file mode 100644 index 0000000..cfda85c --- /dev/null +++ b/config/docs/d/kms_describe_keys.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_describe_keys" +sidebar_current: "docs-tencentcloud-datasource-kms_describe_keys" +description: |- + Use this data source to query detailed information of kms key_lists +--- + +# tencentcloud_kms_describe_keys + +Use this data source to query detailed information of kms key_lists + +## Example Usage + +```hcl +data "tencentcloud_kms_describe_keys" "example" { + key_ids = [ + "9ffacc8b-6461-11ee-a54e-525400dd8a7d", + "bffae4ed-6465-11ee-90b2-5254000ef00e" + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_ids` - (Required, Set: [`String`]) Query the ID list of CMK, batch query supports up to 100 KeyIds at a time. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `key_list` - A list of KMS keys. + * `alias` - Name of CMK. + * `create_time` - Create time of CMK. + * `creator_uin` - Uin of CMK Creator. + * `deletion_date` - Delete time of CMK. + * `description` - Description of CMK. + * `key_id` - ID of CMK. + * `key_rotation_enabled` - Specify whether to enable key rotation. + * `key_state` - State of CMK. + * `key_usage` - Usage of CMK. + * `next_rotate_time` - Next rotate time of CMK when key_rotation_enabled is true. + * `origin` - Origin of CMK. `TENCENT_KMS` - CMK created by KMS, `EXTERNAL` - CMK imported by user. + * `owner` - Creator of CMK. + * `valid_to` - Valid when origin is `EXTERNAL`, it means the effective date of the key material. + + diff --git a/config/docs/d/kms_get_parameters_for_import.html.markdown b/config/docs/d/kms_get_parameters_for_import.html.markdown new file mode 100644 index 0000000..672d131 --- /dev/null +++ b/config/docs/d/kms_get_parameters_for_import.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_get_parameters_for_import" +sidebar_current: "docs-tencentcloud-datasource-kms_get_parameters_for_import" +description: |- + Use this data source to query detailed information of kms get_parameters_for_import +--- + +# tencentcloud_kms_get_parameters_for_import + +Use this data source to query detailed information of kms get_parameters_for_import + +## Example Usage + +```hcl +data "tencentcloud_kms_get_parameters_for_import" "example" { + key_id = "786aea8c-4aec-11ee-b601-525400281a45" + wrapping_algorithm = "RSAES_OAEP_SHA_1" + wrapping_key_spec = "RSA_2048" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_id` - (Required, String) CMK unique identifier. +* `wrapping_algorithm` - (Required, String) Specifies the algorithm for encrypting key material, currently supports RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256. +* `wrapping_key_spec` - (Required, String) Specifies the type of encryption key material, currently only supports RSA_2048. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `import_token` - The token required for importing key material is used as the parameter of ImportKeyMaterial. +* `parameters_valid_to` - The validity period of the exported token and public key cannot be imported after this period, and you need to call GetParametersForImport again to obtain it. +* `public_key` - Base64-encoded public key content. + + diff --git a/config/docs/d/kms_keys.html.markdown b/config/docs/d/kms_keys.html.markdown new file mode 100644 index 0000000..69655fd --- /dev/null +++ b/config/docs/d/kms_keys.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_keys" +sidebar_current: "docs-tencentcloud-datasource-kms_keys" +description: |- + Use this data source to query detailed information of KMS key +--- + +# tencentcloud_kms_keys + +Use this data source to query detailed information of KMS key + +## Example Usage + +```hcl +data "tencentcloud_kms_keys" "example" { + search_key_alias = "tf_example" + key_state = 0 + origin = "TENCENT_KMS" + key_usage = "ALL" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_state` - (Optional, Int) Filter by state of CMK. `0` - all CMKs are queried, `1` - only Enabled CMKs are queried, `2` - only Disabled CMKs are queried, `3` - only PendingDelete CMKs are queried, `4` - only PendingImport CMKs are queried, `5` - only Archived CMKs are queried. +* `key_usage` - (Optional, String) Filter by usage of CMK. Available values include `ALL`, `ENCRYPT_DECRYPT`, `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, `ASYMMETRIC_SIGN_VERIFY_ECC`. Default value is `ENCRYPT_DECRYPT`. +* `order_type` - (Optional, Int) Order to sort the CMK create time. `0` - desc, `1` - asc. Default value is `0`. +* `origin` - (Optional, String) Filter by origin of CMK. `TENCENT_KMS` - CMK created by KMS, `EXTERNAL` - CMK imported by user, `ALL` - all CMKs. Default value is `ALL`. +* `result_output_file` - (Optional, String) Used to save results. +* `role` - (Optional, Int) Filter by role of the CMK creator. `0` - created by user, `1` - created by cloud product. Default value is `0`. +* `search_key_alias` - (Optional, String) Words used to match the results, and the words can be: key_id and alias. +* `tags` - (Optional, Map) Tags to filter CMK. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `key_list` - A list of KMS keys. + * `alias` - Name of CMK. + * `create_time` - Create time of CMK. + * `creator_uin` - Uin of CMK Creator. + * `deletion_date` - Delete time of CMK. + * `description` - Description of CMK. + * `key_id` - ID of CMK. + * `key_rotation_enabled` - Specify whether to enable key rotation. + * `key_state` - State of CMK. + * `key_usage` - Usage of CMK. + * `next_rotate_time` - Next rotate time of CMK when key_rotation_enabled is true. + * `origin` - Origin of CMK. `TENCENT_KMS` - CMK created by KMS, `EXTERNAL` - CMK imported by user. + * `owner` - Creator of CMK. + * `valid_to` - Valid when origin is `EXTERNAL`, it means the effective date of the key material. + + diff --git a/config/docs/d/kms_list_algorithms.html.markdown b/config/docs/d/kms_list_algorithms.html.markdown new file mode 100644 index 0000000..a891776 --- /dev/null +++ b/config/docs/d/kms_list_algorithms.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_list_algorithms" +sidebar_current: "docs-tencentcloud-datasource-kms_list_algorithms" +description: |- + Use this data source to query detailed information of kms list_algorithms +--- + +# tencentcloud_kms_list_algorithms + +Use this data source to query detailed information of kms list_algorithms + +## Example Usage + +```hcl +data "tencentcloud_kms_list_algorithms" "example" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `asymmetric_algorithms` - Asymmetric encryption algorithms supported in this region. + * `algorithm` - Algorithm. + * `key_usage` - Key usage. +* `asymmetric_sign_verify_algorithms` - Asymmetric signature verification algorithms supported in this region. + * `algorithm` - Algorithm. + * `key_usage` - Key usage. +* `symmetric_algorithms` - Symmetric encryption algorithms supported in this region. + * `algorithm` - Algorithm. + * `key_usage` - Key usage. + + diff --git a/config/docs/d/kms_list_keys.html.markdown b/config/docs/d/kms_list_keys.html.markdown new file mode 100644 index 0000000..5881c4c --- /dev/null +++ b/config/docs/d/kms_list_keys.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_list_keys" +sidebar_current: "docs-tencentcloud-datasource-kms_list_keys" +description: |- + Use this data source to query detailed information of kms list_keys +--- + +# tencentcloud_kms_list_keys + +Use this data source to query detailed information of kms list_keys + +## Example Usage + +```hcl +data "tencentcloud_kms_list_keys" "example" { + role = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `hsm_cluster_id` - (Optional, String) HSM cluster ID (only valid for KMS exclusive/managed service instances). +* `result_output_file` - (Optional, String) Used to save results. +* `role` - (Optional, Int) Filter based on the creator role. The default value is 0, which indicates the cmk created by the user himself, and 1, which indicates the cmk automatically created by authorizing other cloud products. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `keys` - A list of KMS keys. + * `key_id` - ID of CMK. + + diff --git a/config/docs/d/kms_public_key.html.markdown b/config/docs/d/kms_public_key.html.markdown new file mode 100644 index 0000000..0d9c18a --- /dev/null +++ b/config/docs/d/kms_public_key.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_public_key" +sidebar_current: "docs-tencentcloud-datasource-kms_public_key" +description: |- + Use this data source to query detailed information of kms public_key +--- + +# tencentcloud_kms_public_key + +Use this data source to query detailed information of kms public_key + +## Example Usage + +```hcl +data "tencentcloud_kms_public_key" "example" { + key_id = tencentcloud_kms_key.example.id +} + +resource "tencentcloud_kms_key" "example" { + alias = "tf-example-kms-key" + description = "example of kms key" + key_usage = "ASYMMETRIC_DECRYPT_RSA_2048" + is_enabled = true + pending_delete_window_in_days = 7 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_id` - (Required, String) CMK unique identifier. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `public_key_pem` - Public key content in PEM format. +* `public_key` - Base64-encoded public key content. + + diff --git a/config/docs/d/kms_white_box_decrypt_key.html.markdown b/config/docs/d/kms_white_box_decrypt_key.html.markdown new file mode 100644 index 0000000..addb179 --- /dev/null +++ b/config/docs/d/kms_white_box_decrypt_key.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_white_box_decrypt_key" +sidebar_current: "docs-tencentcloud-datasource-kms_white_box_decrypt_key" +description: |- + Use this data source to query detailed information of kms white_box_decrypt_key +--- + +# tencentcloud_kms_white_box_decrypt_key + +Use this data source to query detailed information of kms white_box_decrypt_key + +## Example Usage + +```hcl +data "tencentcloud_kms_white_box_decrypt_key" "example" { + key_id = "244dab8c-6dad-11ea-80c6-5254006d0810" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_id` - (Required, String) Globally unique identifier for the white box key. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `decrypt_key` - White box decryption key, base64 encoded. + + diff --git a/config/docs/d/kms_white_box_device_fingerprints.html.markdown b/config/docs/d/kms_white_box_device_fingerprints.html.markdown new file mode 100644 index 0000000..d10c3b6 --- /dev/null +++ b/config/docs/d/kms_white_box_device_fingerprints.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_white_box_device_fingerprints" +sidebar_current: "docs-tencentcloud-datasource-kms_white_box_device_fingerprints" +description: |- + Use this data source to query detailed information of kms white_box_device_fingerprints +--- + +# tencentcloud_kms_white_box_device_fingerprints + +Use this data source to query detailed information of kms white_box_device_fingerprints + +## Example Usage + +```hcl +data "tencentcloud_kms_white_box_device_fingerprints" "example" { + key_id = "244dab8c-6dad-11ea-80c6-5254006d0810" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_id` - (Required, String) Globally unique identifier for the white box key. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - Device fingerprint list. + * `description` - Description. + * `identity` - identity. + + diff --git a/config/docs/d/kms_white_box_key_details.html.markdown b/config/docs/d/kms_white_box_key_details.html.markdown new file mode 100644 index 0000000..5a6d3d9 --- /dev/null +++ b/config/docs/d/kms_white_box_key_details.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_white_box_key_details" +sidebar_current: "docs-tencentcloud-datasource-kms_white_box_key_details" +description: |- + Use this data source to query detailed information of kms white_box_key_details +--- + +# tencentcloud_kms_white_box_key_details + +Use this data source to query detailed information of kms white_box_key_details + +## Example Usage + +```hcl +data "tencentcloud_kms_white_box_key_details" "example" { + key_status = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_status` - (Optional, Int) Filter condition: status of the key, 0: disabled, 1: enabled. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `key_infos` - List of white box key information. + * `algorithm` - The type of algorithm used by the key. + * `alias` - As an alias for a key that is easier to identify and easier to understand, it cannot be empty and is a combination of 1-60 alphanumeric characters - _. The first character must be a letter or number. It cannot be repeated. + * `create_time` - Key creation time, Unix timestamp. + * `creator_uin` - Creator. + * `decrypt_key` - White box decryption key, base64 encoded. + * `description` - Description of the key. + * `device_fingerprint_bind` - Is there a device fingerprint bound to the current key?. + * `encrypt_key` - White box encryption key, base64 encoded. + * `key_id` - Globally unique identifier for the white box key. + * `owner_uin` - Creator. + * `resource_id` - Resource ID, format: creatorUin/$creatorUin/$keyId. + * `status` - The status of the white box key, the value is: Enabled | Disabled. + + diff --git a/config/docs/d/kubernetes_available_cluster_versions.html.markdown b/config/docs/d/kubernetes_available_cluster_versions.html.markdown new file mode 100644 index 0000000..6303261 --- /dev/null +++ b/config/docs/d/kubernetes_available_cluster_versions.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_available_cluster_versions" +sidebar_current: "docs-tencentcloud-datasource-kubernetes_available_cluster_versions" +description: |- + Use this data source to query detailed information of kubernetes available_cluster_versions +--- + +# tencentcloud_kubernetes_available_cluster_versions + +Use this data source to query detailed information of kubernetes available_cluster_versions + +## Example Usage + +```hcl +data "tencentcloud_kubernetes_available_cluster_versions" "query_by_id" { + cluster_id = "xxx" +} + +output "versions_id" { + description = "Query versions from id." + value = data.tencentcloud_kubernetes_available_cluster_versions.query_by_id.versions +} + +data "tencentcloud_kubernetes_available_cluster_versions" "query_by_ids" { + cluster_ids = ["xxx"] +} + +output "versions_ids" { + description = "Query versions from ids." + value = data.tencentcloud_kubernetes_available_cluster_versions.query_by_ids.clusters +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Optional, String) Cluster Id. +* `cluster_ids` - (Optional, Set: [`String`]) list of cluster IDs. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `clusters` - cluster information. Note: This field may return null, indicating that no valid value can be obtained. + * `cluster_id` - Cluster ID. + * `versions` - list of cluster major version numbers, for example 1.18.4. +* `versions` - Upgradable cluster version number. Note: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/kubernetes_charts.html.markdown b/config/docs/d/kubernetes_charts.html.markdown new file mode 100644 index 0000000..195e18f --- /dev/null +++ b/config/docs/d/kubernetes_charts.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_charts" +sidebar_current: "docs-tencentcloud-datasource-kubernetes_charts" +description: |- + Use this data source to query detailed information of kubernetes cluster addons. +--- + +# tencentcloud_kubernetes_charts + +Use this data source to query detailed information of kubernetes cluster addons. + +## Example Usage + +```hcl +data "tencentcloud_kubernetes_charts" "name" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `arch` - (Optional, String) Operation system app supported. Available values: `arm32`, `arm64`, `amd64`. +* `cluster_type` - (Optional, String) Cluster type. Available values: `tke`, `eks`. +* `kind` - (Optional, String) Kind of app chart. Available values: `log`, `scheduler`, `network`, `storage`, `monitor`, `dns`, `image`, `other`, `invisible`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `chart_list` - App chart list. + * `label` - Label of chart. + * `latest_version` - Chart latest version. + * `name` - Name of chart. + + diff --git a/config/docs/d/kubernetes_cluster_authentication_options.html.markdown b/config/docs/d/kubernetes_cluster_authentication_options.html.markdown new file mode 100644 index 0000000..4889f9e --- /dev/null +++ b/config/docs/d/kubernetes_cluster_authentication_options.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_cluster_authentication_options" +sidebar_current: "docs-tencentcloud-datasource-kubernetes_cluster_authentication_options" +description: |- + Use this data source to query detailed information of kubernetes cluster_authentication_options +--- + +# tencentcloud_kubernetes_cluster_authentication_options + +Use this data source to query detailed information of kubernetes cluster_authentication_options + +## Example Usage + +```hcl +data "tencentcloud_kubernetes_cluster_authentication_options" "cluster_authentication_options" { + cluster_id = "cls-kzilgv5m" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `latest_operation_state` - Result of the last modification. Values: `Updating`, `Success`, `Failed` or `TimeOut`. Note: this field may return `null`, indicating that no valid values can be obtained. +* `oidc_config` - OIDC authentication configurations. Note: This field may return `null`, indicating that no valid value can be obtained. + * `auto_create_client_id` - Creating ClientId of the identity provider. Note: This field may return `null`, indicating that no valid value can be obtained. + * `auto_create_oidc_config` - Creating an identity provider. Note: This field may return `null`, indicating that no valid value can be obtained. + * `auto_install_pod_identity_webhook_addon` - Creating the PodIdentityWebhook component. Note: This field may return `null`, indicating that no valid value can be obtained. +* `service_accounts` - ServiceAccount authentication configuration. Note: this field may return `null`, indicating that no valid values can be obtained. + * `auto_create_discovery_anonymous_auth` - If it is set to `true`, a RABC rule is automatically created to allow anonymous users to access `/.well-known/openid-configuration` and `/openid/v1/jwks`. Note: this field may return `null`, indicating that no valid values can be obtained. + * `issuer` - service-account-issuer. Note: this field may return `null`, indicating that no valid values can be obtained. + * `jwks_uri` - service-account-jwks-uri. Note: this field may return `null`, indicating that no valid values can be obtained. + * `use_tke_default` - Use TKE default issuer and jwksuri. Note: This field may return `null`, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/kubernetes_cluster_common_names.html.markdown b/config/docs/d/kubernetes_cluster_common_names.html.markdown new file mode 100644 index 0000000..865aece --- /dev/null +++ b/config/docs/d/kubernetes_cluster_common_names.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_cluster_common_names" +sidebar_current: "docs-tencentcloud-datasource-kubernetes_cluster_common_names" +description: |- + Provide a datasource to query cluster CommonNames. +--- + +# tencentcloud_kubernetes_cluster_common_names + +Provide a datasource to query cluster CommonNames. + +## Example Usage + +```hcl +data "tencentcloud_kubernetes_cluster_common_names" "foo" { + cluster_id = "cls-12345678" + subaccount_uins = ["1234567890", "0987654321"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Optional, String) Cluster ID. +* `result_output_file` - (Optional, String) Used for save result. +* `role_ids` - (Optional, List: [`String`]) List of Role ID. Up to 50 sub-accounts can be passed in at a time. +* `subaccount_uins` - (Optional, List: [`String`]) List of sub-account. Up to 50 sub-accounts can be passed in at a time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - List of the CommonName in the certificate of the client corresponding to the sub-account UIN. + * `common_names` - The CommonName in the certificate of the client corresponding to the sub-account. + * `subaccount_uin` - User UIN. + + diff --git a/config/docs/d/kubernetes_cluster_instances.html.markdown b/config/docs/d/kubernetes_cluster_instances.html.markdown new file mode 100644 index 0000000..e1f24ec --- /dev/null +++ b/config/docs/d/kubernetes_cluster_instances.html.markdown @@ -0,0 +1,96 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_cluster_instances" +sidebar_current: "docs-tencentcloud-datasource-kubernetes_cluster_instances" +description: |- + Use this data source to query detailed information of kubernetes cluster_instances +--- + +# tencentcloud_kubernetes_cluster_instances + +Use this data source to query detailed information of kubernetes cluster_instances + +## Example Usage + +```hcl +data "tencentcloud_kubernetes_cluster_instances" "cluster_instances" { + cluster_id = "cls-ely08ic4" + instance_ids = ["ins-kqmx8dm2"] + instance_role = "WORKER" + filters { + name = "nodepool-id" + values = ["np-p4e6whqu"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) ID of the cluster. +* `filters` - (Optional, List) List of filter conditions. The optional values of Name are `nodepool-id` and `nodepool-instance-type`. Name is `nodepool-id`, which means filtering machines based on node pool id, and Value is the specific node pool id. Name is `nodepool-instance-type`, which indicates how the node is added to the node pool. Value is MANUALLY_ADDED (manually added to the node pool), AUTOSCALING_ADDED (joined by scaling group expansion method), ALL (manually join the node pool and join the node pool through scaling group expansion). +* `instance_ids` - (Optional, Set: [`String`]) List of node instance IDs to be obtained. If it is empty, it means pulling all node instances in the cluster. +* `instance_role` - (Optional, String) Node role, MASTER, WORKER, ETCD, MASTER_ETCD,ALL, default is WORKER. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) The attribute name, if there are multiple filters, the relationship between the filters is a logical AND relationship. +* `values` - (Required, Set) Attribute values, if there are multiple values in the same filter, the relationship between values under the same filter is a logical OR relationship. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_set` - List of instances in the cluster. + * `autoscaling_group_id` - Auto scaling group ID. + * `created_time` - Add time. + * `drain_status` - Whether the instance is blocked. + * `failed_reason` - Reasons for instance exception (or being initialized). + * `instance_advanced_settings` - Node configuration. + * `data_disks` - Multi-disk data disk mounting information. + * `auto_format_and_mount` - Whether to automatically format the disk and mount it. + * `disk_partition` - Mount device name or partition name, required when and only when adding an existing node. + * `disk_size` - Cloud disk size (G). + * `disk_type` - Cloud disk type. + * `file_system` - File system (ext3/ext4/xfs). + * `mount_target` - Mount directory. + * `desired_pod_number` - When the node belongs to the podCIDR size customization mode, you can specify the upper limit of the number of pods running on the node. + * `docker_graph_path` - Dockerd --graph specifies the value, the default is /var/lib/docker. + * `extra_args` - Node-related custom parameter information. + * `kubelet` - Kubelet custom parameters. + * `gpu_args` - GPU driver related parameters, obtain related GPU parameters: https://cloud.tencent.com/document/api/213/15715. + * `cuda` - CUDA version information. + * `name` - The name of the GPU driver or CUDA. + * `version` - GPU driver or CUDA version. + * `cudnn` - CuDNN version information. + * `dev_name` - Dev name of cuDNN. + * `doc_name` - Doc name of cuDNN. + * `name` - CuDNN name. + * `version` - Version of cuDNN. + * `custom_driver` - Custom GPU driver information. + * `address` - Custom GPU driver address link. + * `driver` - GPU driver version information. + * `name` - The name of the GPU driver or CUDA. + * `version` - GPU driver or CUDA version. + * `mig_enable` - Whether to enable MIG features. + * `labels` - Node Label array. + * `name` - Name in the map table. + * `value` - Value in map table. + * `mount_target` - Data disk mount point, the data disk is not mounted by default. Formatted ext3, ext4, xfs file system data disks will be mounted directly. Other file systems or unformatted data disks will be automatically formatted as ext4 (tlinux system formatted as xfs) and mounted. Please pay attention to backing up the data. This setting does not take effect for cloud hosts that have no data disks or multiple data disks. + * `pre_start_user_script` - Base64 encoded user script, executed before initializing the node, currently only effective for adding existing nodes. + * `taints` - Node taint. + * `effect` - Effect of taints mark. + * `key` - Key of taints mark. + * `value` - Value of taints mark. + * `unschedulable` - Set whether the added node participates in scheduling. The default value is 0, which means participating in scheduling; non-0 means not participating in scheduling. After the node initialization is completed, you can execute kubectl uncordon nodename to join the node in scheduling. + * `user_script` - Base64 encoded userscript. + * `instance_id` - Instance ID. + * `instance_role` - Node role, MASTER, WORKER, ETCD, MASTER_ETCD,ALL, default is WORKER. + * `instance_state` - The status of the instance (running, initializing, failed). + * `lan_ip` - Node intranet IP. + * `node_pool_id` - Resource pool ID. + + diff --git a/config/docs/d/kubernetes_cluster_levels.html.markdown b/config/docs/d/kubernetes_cluster_levels.html.markdown new file mode 100644 index 0000000..79b9074 --- /dev/null +++ b/config/docs/d/kubernetes_cluster_levels.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_cluster_levels" +sidebar_current: "docs-tencentcloud-datasource-kubernetes_cluster_levels" +description: |- + Provide a datasource to query TKE cluster levels. +--- + +# tencentcloud_kubernetes_cluster_levels + +Provide a datasource to query TKE cluster levels. + +## Example Usage + +```hcl +data "tencentcloud_kubernetes_cluster_levels" "foo" {} + +output "level5" { + value = data.tencentcloud_kubernetes_cluster_levels.foo.list.0.alias +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Optional, String) Specify cluster Id, if set will only query current cluster's available levels. +* `result_output_file` - (Optional, String) Used for save result. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - List of level information. + * `alias` - Alias used for pass to cluster level arguments. + * `config_map_count` - Number of ConfigMaps. + * `crd_count` - Number of CRDs. + * `enable` - Indicates whether the current level enabled. + * `name` - Level name. + * `node_count` - Number of nodes. + * `other_count` - Number of others. + * `pod_count` - Number of pods. + + diff --git a/config/docs/d/kubernetes_cluster_node_pools.html.markdown b/config/docs/d/kubernetes_cluster_node_pools.html.markdown new file mode 100644 index 0000000..d48d0b9 --- /dev/null +++ b/config/docs/d/kubernetes_cluster_node_pools.html.markdown @@ -0,0 +1,113 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_cluster_node_pools" +sidebar_current: "docs-tencentcloud-datasource-kubernetes_cluster_node_pools" +description: |- + Use this data source to query detailed information of kubernetes cluster_node_pools +--- + +# tencentcloud_kubernetes_cluster_node_pools + +Use this data source to query detailed information of kubernetes cluster_node_pools + +## Example Usage + +```hcl +data "tencentcloud_kubernetes_cluster_node_pools" "cluster_node_pools" { + cluster_id = "cls-kzilgv5m" + filters { + name = "NodePoolsName" + values = ["mynodepool_xxxx"] + } + filters { + name = "NodePoolsId" + values = ["np-ngjwhdv4"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) ID of the cluster. +* `filters` - (Optional, List) NodePoolsName, Filter according to the node pool name, type: String, required: no. NodePoolsId, Filter according to the node pool ID, type: String, required: no. tags, Filter according to the label key value pairs, type: String, required: no. tag:tag-key, Filter according to the label key value pairs, type: String, required: no. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) The attribute name, if there are multiple filters, the relationship between the filters is a logical AND relationship. +* `values` - (Required, Set) Attribute values, if there are multiple values in the same filter, the relationship between values under the same filter is a logical OR relationship. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `node_pool_set` - Node Pool List. + * `autoscaling_group_id` - ID of autoscaling group. + * `autoscaling_group_status` - Status information. + * `cluster_instance_id` - ID of the cluster. + * `data_disks` - Multi disk data disk mounting information. + * `auto_format_and_mount` - Whether to automate the format disk and mount it. + * `disk_partition` - Mount device name or partition name. + * `disk_size` - Cloud disk size(G). + * `disk_type` - Cloud disk type. + * `file_system` - File system(ext3/ext4/xfs). + * `mount_target` - Mount directory. + * `deletion_protection` - Remove protection switch. + * `desired_nodes_num` - Expected number of nodes. + * `desired_pod_num` - When the cluster belongs to the node podCIDR size customization mode, the node pool needs to have the pod number attribute. + * `docker_graph_path` - Dockerd --graph specified value, default to /var/lib/docker. + * `extra_args` - Node configuration. + * `kubelet` - Kubelet custom parameters. + * `gpu_args` - GPU driver related parameters. + * `cuda` - CUDA version information. + * `name` - GPU driver or CUDA name. + * `version` - GPU driver or CUDA version. + * `cudnn` - CuDNN version information. + * `dev_name` - Dev name of cuDNN. + * `doc_name` - Doc name of cuDNN. + * `name` - Name of cuDNN. + * `version` - Version of cuDNN. + * `custom_driver` - Custom GPU driver information. + * `address` - Custom GPU driver address link. + * `driver` - GPU driver version information. + * `name` - GPU driver or CUDA name. + * `version` - GPU driver or CUDA version. + * `mig_enable` - Is the MIG feature enabled. + * `image_id` - ID of image. + * `labels` - Labels of the node pool. + * `name` - Name in the map table. + * `value` - Value in the map table. + * `launch_configuration_id` - ID of launch configuration. + * `life_state` - Life cycle state of the node pool, include: creating, normal, updating, deleting, deleted. + * `max_nodes_num` - Maximum number of nodes. + * `min_nodes_num` - Minimum number of nodes. + * `name` - Name of the node pool. + * `node_count_summary` - Node List. + * `autoscaling_added` - Automatically managed nodes. + * `initializing` - Number of nodes in initialization. + * `joining` - Number of nodes joining. + * `normal` - Normal number of nodes. + * `total` - Total number of nodes. + * `manually_added` - Manually managed nodes. + * `initializing` - Number of nodes in initialization. + * `joining` - Number of nodes joining. + * `normal` - Normal number of nodes. + * `total` - Total number of nodes. + * `node_pool_id` - ID of the node pool. + * `node_pool_os` - Node Pool OS Name. + * `os_customize_type` - Mirror version of container. + * `pre_start_user_script` - User defined script, executed before User Script. + * `tags` - Resource tags. + * `key` - Label key. + * `value` - Label value. + * `taints` - Labels of the node pool. + * `effect` - Effect of taints mark. + * `key` - Key of taints mark. + * `value` - Value of taints mark. + * `unschedulable` - Is it not schedulable. + * `user_script` - User defined scripts. + + diff --git a/config/docs/d/kubernetes_clusters.html.markdown b/config/docs/d/kubernetes_clusters.html.markdown new file mode 100644 index 0000000..14e976f --- /dev/null +++ b/config/docs/d/kubernetes_clusters.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_clusters" +sidebar_current: "docs-tencentcloud-datasource-kubernetes_clusters" +description: |- + Use this data source to query detailed information of kubernetes clusters. +--- + +# tencentcloud_kubernetes_clusters + +Use this data source to query detailed information of kubernetes clusters. + +## Example Usage + +```hcl +data "tencentcloud_kubernetes_clusters" "name" { + cluster_name = "terraform" +} + +data "tencentcloud_kubernetes_clusters" "id" { + cluster_id = "cls-godovr32" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Optional, String) ID of the cluster. Conflict with cluster_name, can not be set at the same time. +* `cluster_name` - (Optional, String) Name of the cluster. Conflict with cluster_id, can not be set at the same time. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) Tags of the cluster. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - An information list of kubernetes clusters. Each element contains the following attributes: + * `certification_authority` - The certificate used for access. + * `claim_expired_seconds` - The expired seconds to recycle ENI. + * `cluster_as_enabled` - Indicates whether to enable cluster node auto scaler. + * `cluster_cidr` - A network address block of the cluster. Different from vpc cidr and cidr of other clusters within this VPC. + * `cluster_deploy_type` - Deployment type of the cluster. + * `cluster_desc` - Description of the cluster. + * `cluster_external_endpoint` - External network address to access. + * `cluster_extra_args` - Customized parameters for master component. + * `kube_apiserver` - The customized parameters for kube-apiserver. + * `kube_controller_manager` - The customized parameters for kube-controller-manager. + * `kube_scheduler` - The customized parameters for kube-scheduler. + * `cluster_id` - ID of cluster. + * `cluster_ipvs` - Indicates whether ipvs is enabled. + * `cluster_max_pod_num` - The maximum number of Pods per node in the cluster. + * `cluster_max_service_num` - The maximum number of services in the cluster. + * `cluster_name` - Name of the cluster. + * `cluster_node_num` - Number of nodes in the cluster. + * `cluster_os` - Operating system of the cluster. + * `cluster_version` - Version of the cluster. + * `container_runtime` - (**Deprecated**) It has been deprecated from version 1.18.1. Container runtime of the cluster. + * `deletion_protection` - Indicates whether cluster deletion protection is enabled. + * `domain` - Domain name for access. + * `eni_subnet_ids` - Subnet IDs for cluster with VPC-CNI network mode. + * `ignore_cluster_cidr_conflict` - Indicates whether to ignore the cluster cidr conflict error. + * `is_non_static_ip_mode` - Indicates whether non-static ip mode is enabled. + * `kube_config_intranet` - Kubernetes config of private network. + * `kube_config` - Kubernetes config. + * `kube_proxy_mode` - Cluster kube-proxy mode. + * `network_type` - Cluster network type. + * `node_name_type` - Node name type of cluster. + * `password` - Password of account. + * `pgw_endpoint` - The Intranet address used for access. + * `project_id` - Project ID of the cluster. + * `security_policy` - Access policy. + * `service_cidr` - The network address block of the cluster. + * `tags` - Tags of the cluster. + * `user_name` - User name of account. + * `vpc_cni_type` - Distinguish between shared network card multi-IP mode and independent network card mode. + * `vpc_id` - Vpc ID of the cluster. + * `worker_instances_list` - An information list of cvm within the WORKER clusters. Each element contains the following attributes. + * `failed_reason` - Information of the cvm when it is failed. + * `instance_id` - ID of the cvm. + * `instance_role` - Role of the cvm. + * `instance_state` - State of the cvm. + * `lan_ip` - LAN IP of the cvm. + + diff --git a/config/docs/d/lighthouse_all_scene.html.markdown b/config/docs/d/lighthouse_all_scene.html.markdown new file mode 100644 index 0000000..7c623ab --- /dev/null +++ b/config/docs/d/lighthouse_all_scene.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_all_scene" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_all_scene" +description: |- + Use this data source to query detailed information of all region lighthouse scene +--- + +# tencentcloud_lighthouse_all_scene + +Use this data source to query detailed information of all region lighthouse scene + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_all_scene" "scene" { + offset = 0 + limit = 20 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `limit` - (Optional, Int) Number of returned results. Default value is 20. Maximum value is 100. +* `offset` - (Optional, Int) Offset. Default value is 0. +* `result_output_file` - (Optional, String) Used to save results. +* `scene_ids` - (Optional, Set: [`String`]) List of scene IDs. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `scene_set` - List of scene info. + * `description` - Use scene description. + * `display_name` - Use the scene presentation name. + * `scene_id` - Use scene Id. + + diff --git a/config/docs/d/lighthouse_bundle.html.markdown b/config/docs/d/lighthouse_bundle.html.markdown new file mode 100644 index 0000000..b46d19f --- /dev/null +++ b/config/docs/d/lighthouse_bundle.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_bundle" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_bundle" +description: |- + Use this data source to query detailed information of lighthouse bundle +--- + +# tencentcloud_lighthouse_bundle + +Use this data source to query detailed information of lighthouse bundle + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_bundle" "bundle" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bundle_ids` - (Optional, Set: [`String`]) Bundle ID list. +* `filters` - (Optional, List) Filter list. +- `bundle-id`: filter by the bundle ID. +- `support-platform-type`: filter by system type, valid values: `LINUX_UNIX`, `WINDOWS`. +- `bundle-type`: filter according to package type, valid values: `GENERAL_BUNDLE`, `STORAGE_BUNDLE`, `ENTERPRISE_BUNDLE`, `EXCLUSIVE_BUNDLE`, `BEFAST_BUNDLE`. +- `bundle-state`: filter according to package status, valid values: `ONLINE`, `OFFLINE`. +NOTE: The upper limit of Filters per request is 10. The upper limit of Filter.Values is 5. Parameter does not support specifying both BundleIds and Filters. +* `limit` - (Optional, Int) Number of returned results. Default value is 20. Maximum value is 100. +* `offset` - (Optional, Int) Offset. Default value is 0. +* `result_output_file` - (Optional, String) Used to save results. +* `zones` - (Optional, Set: [`String`]) Zone list, which contains all zones by default. + +The `filters` object supports the following: + +* `name` - (Required, String) Field to be filtered. +* `values` - (Required, Set) Filter value of field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `bundle_set` - List of bundle details. + * `bundle_display_label` - Package tag.Valid values:ACTIVITY: promotional packageNORMAL: regular packageCAREFREE: carefree package. + * `bundle_id` - Package ID. + * `bundle_sales_state` - Package sale status. Valid values are AVAILABLE, SOLD_OUT. + * `bundle_type` - Package type.Valid values:GENERAL_BUNDLE: generalSTORAGE_BUNDLE: Storage. + * `cpu` - CPU. + * `internet_charge_type` - Network billing mode. + * `internet_max_bandwidth_out` - Peak bandwidth in Mbps. + * `memory` - Memory size in GB. + * `monthly_traffic` - Monthly network traffic in Gb. + * `price` - Current package unit price information. + * `instance_price` - Instance price. + * `currency` - Currency unit. Valid values: CNY and USD. + * `discount_price` - Discounted price. + * `discount` - Discount. + * `original_bundle_price` - Original package unit price. + * `original_price` - Original price. + * `support_linux_unix_platform` - Whether Linux/Unix is supported. + * `support_windows_platform` - Whether Windows is supported. + * `system_disk_size` - System disk size. + * `system_disk_type` - System disk type. + + diff --git a/config/docs/d/lighthouse_disk_config.html.markdown b/config/docs/d/lighthouse_disk_config.html.markdown new file mode 100644 index 0000000..093641a --- /dev/null +++ b/config/docs/d/lighthouse_disk_config.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_disk_config" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_disk_config" +description: |- + Use this data source to query detailed information of lighthouse disk_config +--- + +# tencentcloud_lighthouse_disk_config + +Use this data source to query detailed information of lighthouse disk_config + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_disk_config" "disk_config" { + filters { + name = "zone" + values = ["ap-guangzhou-3"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter list.zoneFilter by availability zone.Type: StringRequired: no. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Field to be filtered. +* `values` - (Required, Set) Filter value of field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `disk_config_set` - List of cloud disk configurations. + * `disk_sales_state` - Cloud disk sale status. + * `disk_step_size` - Cloud disk increment. + * `disk_type` - Cloud disk type. + * `max_disk_size` - Maximum cloud disk size. + * `min_disk_size` - Minimum cloud disk size. + * `zone` - Availability zone. + + diff --git a/config/docs/d/lighthouse_disks.html.markdown b/config/docs/d/lighthouse_disks.html.markdown new file mode 100644 index 0000000..d0f421c --- /dev/null +++ b/config/docs/d/lighthouse_disks.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_disks" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_disks" +description: |- + Use this data source to query detailed information of lighthouse disk +--- + +# tencentcloud_lighthouse_disks + +Use this data source to query detailed information of lighthouse disk + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_disks" "disks" { + disk_ids = ["lhdisk-xxxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `disk_ids` - (Optional, Set: [`String`]) List of disk ids. +* `filters` - (Optional, List) Filter list. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Fields to be filtered. Valid names: `disk-id`: Filters by disk id; `instance-id`: Filter by instance id; `disk-name`: Filter by disk name; `zone`: Filter by zone; `disk-usage`: Filter by disk usage(Values: `SYSTEM_DISK` or `DATA_DISK`); `disk-state`: Filter by disk state. +* `values` - (Required, Set) Value of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `disk_list` - Cloud disk information list. + * `attached` - Disk attach state. + * `created_time` - Created time. Expressed according to the ISO8601 standard, and using UTC time. The format is `YYYY-MM-DDThh:mm:ssZ`. + * `delete_with_instance` - Whether to release with the instance. + * `disk_backup_count` - Number of existing backup points of cloud disk. + * `disk_backup_quota` - Number of backup points quota for cloud disk. + * `disk_charge_type` - Disk charge type. + * `disk_id` - Disk id. + * `disk_name` - Disk name. + * `disk_size` - Disk size. + * `disk_state` - Disk state. Valid values:`PENDING`, `UNATTACHED`, `ATTACHING`, `ATTACHED`, `DETACHING`, `SHUTDOWN`, `CREATED_FAILED`, `TERMINATING`, `DELETING`, `FREEZING`. + * `disk_type` - Disk type. + * `disk_usage` - Disk usage. + * `expired_time` - Expired time. Expressed according to the ISO8601 standard, and using UTC time. The format is `YYYY-MM-DDThh:mm:ssZ`. + * `instance_id` - Instance id. + * `isolated_time` - Isolated time. Expressed according to the ISO8601 standard, and using UTC time. The format is `YYYY-MM-DDThh:mm:ssZ`. + * `latest_operation_request_id` - Latest operation request id. + * `latest_operation_state` - Latest operation state. + * `latest_operation` - Latest operation. + * `renew_flag` - Renew flag. + * `zone` - Availability zone. + + diff --git a/config/docs/d/lighthouse_firewall_rules_template.html.markdown b/config/docs/d/lighthouse_firewall_rules_template.html.markdown new file mode 100644 index 0000000..59f63f0 --- /dev/null +++ b/config/docs/d/lighthouse_firewall_rules_template.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_firewall_rules_template" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_firewall_rules_template" +description: |- + Use this data source to query detailed information of lighthouse firewall_rules_template +--- + +# tencentcloud_lighthouse_firewall_rules_template + +Use this data source to query detailed information of lighthouse firewall_rules_template + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_firewall_rules_template" "firewall_rules_template" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `firewall_rule_set` - Firewall rule details list. + * `action` - Valid values are (ACCEPT, DROP). Default value is ACCEPT. + * `app_type` - Application type. Valid values are custom, HTTP (80), HTTPS (443), Linux login (22), Windows login (3389), MySQL (3306), SQL Server (1433), all TCP ports, all UDP ports, Ping-ICMP, ALL. + * `cidr_block` - IP range or IP (mutually exclusive). Default value is 0.0.0.0/0, which indicates all sources. + * `firewall_rule_description` - Firewall rule description. + * `port` - Port. Valid values are ALL, one single port, multiple ports separated by commas, or port range indicated by a minus sign. + * `protocol` - Protocol. Valid values are TCP, UDP, ICMP, ALL. + + diff --git a/config/docs/d/lighthouse_instance_blueprint.html.markdown b/config/docs/d/lighthouse_instance_blueprint.html.markdown new file mode 100644 index 0000000..11efb72 --- /dev/null +++ b/config/docs/d/lighthouse_instance_blueprint.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_instance_blueprint" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_instance_blueprint" +description: |- + Use this data source to query detailed information of lighthouse instance_blueprint +--- + +# tencentcloud_lighthouse_instance_blueprint + +Use this data source to query detailed information of lighthouse instance_blueprint + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_instance_blueprint" "instance_blueprint" { + instance_ids = ["lhins-xxxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_ids` - (Required, Set: [`String`]) Instance ID list, which currently can contain only one instance. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `blueprint_instance_set` - Blueprint instance list information. + * `blueprint` - Blueprint instance information. + * `blueprint_id` - Blueprint ID, which is the unique identifier of Blueprint. + * `blueprint_name` - Blueprint name. + * `blueprint_state` - Blueprint status. + * `blueprint_type` - Blueprint type, such as APP_OS, PURE_OS, and PRIVATE. + * `community_url` - URL of official website of the open-source project. + * `created_time` - Creation time according to ISO 8601 standard. UTC time is used. Format is YYYY-MM-DDThh:mm:ssZ. + * `description` - Image description information. + * `display_title` - Blueprint title to be displayed. + * `display_version` - Blueprint version to be displayed. + * `docker_version` - Docker version.Note: This field may return null, indicating that no valid values can be obtained. + * `guide_url` - Guide documentation URL. + * `image_id` - ID of the Lighthouse blueprint shared from a CVM imageNote: this field may return null, indicating that no valid values can be obtained. + * `image_url` - Blueprint picture URL. + * `os_name` - OS name. + * `platform_type` - OS type, such as LINUX_UNIX and WINDOWS. + * `platform` - OS type. + * `required_memory_size` - Memory size required by blueprint in GB. + * `required_system_disk_size` - System disk size required by blueprint in GB. + * `scene_id_set` - Array of IDs of scenes associated with a blueprintNote: This field may return null, indicating that no valid values can be obtained. + * `support_automation_tools` - Whether the blueprint supports automation tools. + * `instance_id` - Instance ID. + * `software_set` - Software list. + * `detail_set` - List of software details. + * `key` - Unique detail key. + * `title` - Detail title. + * `value` - Detail value. + * `image_url` - Software picture URL. + * `install_dir` - Software installation directory. + * `name` - Software name. + * `version` - Software version. + + diff --git a/config/docs/d/lighthouse_instance_disk_num.html.markdown b/config/docs/d/lighthouse_instance_disk_num.html.markdown new file mode 100644 index 0000000..a7246ec --- /dev/null +++ b/config/docs/d/lighthouse_instance_disk_num.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_instance_disk_num" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_instance_disk_num" +description: |- + Use this data source to query detailed information of lighthouse instance_disk_num +--- + +# tencentcloud_lighthouse_instance_disk_num + +Use this data source to query detailed information of lighthouse instance_disk_num + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_instance_disk_num" "instance_disk_num" { + instance_ids = ["lhins-xxxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_ids` - (Required, Set: [`String`]) List of instance IDs. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `attach_detail_set` - Mount information list. + * `attached_disk_count` - Number of elastic cloud disks mounted to the instance. + * `instance_id` - Instance Id. + * `max_attach_count` - Number of elastic cloud disks that can be mounted. + + diff --git a/config/docs/d/lighthouse_instance_traffic_package.html.markdown b/config/docs/d/lighthouse_instance_traffic_package.html.markdown new file mode 100644 index 0000000..6d8c7b0 --- /dev/null +++ b/config/docs/d/lighthouse_instance_traffic_package.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_instance_traffic_package" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_instance_traffic_package" +description: |- + Use this data source to query detailed information of lighthouse instance_traffic_package +--- + +# tencentcloud_lighthouse_instance_traffic_package + +Use this data source to query detailed information of lighthouse instance_traffic_package + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_instance_traffic_package" "instance_traffic_package" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_ids` - (Optional, Set: [`String`]) Instance ID list. +* `limit` - (Optional, Int) Number of returned results. Default value is 20. Maximum value is 100. +* `offset` - (Optional, Int) Offset. Default value is 0. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_traffic_package_set` - List of details of instance traffic packages. + * `instance_id` - Instance ID. + * `traffic_package_set` - List of traffic package details. + * `deadline` - The expiration time of the traffic package. Expressed according to the ISO8601 standard, and using UTC time. The format is YYYY-MM-DDThh:mm:ssZ.. + * `end_time` - The end time of the effective period of the traffic packet. Expressed according to the ISO8601 standard, and using UTC time. The format is YYYY-MM-DDThh:mm:ssZ. + * `start_time` - The start time of the effective cycle of the traffic packet. Expressed according to the ISO8601 standard, and using UTC time. The format is YYYY-MM-DDThh:mm:ssZ. + * `status` - Traffic packet status:- `NETWORK_NORMAL`: normal.- `OVERDUE_NETWORK_DISABLED`: network disconnection due to arrears. + * `traffic_overflow` - The amount of traffic that exceeds the quota of the traffic packet during the effective period of the traffic packet, in bytes. + * `traffic_package_id` - Traffic packet ID. + * `traffic_package_remaining` - The remaining traffic during the effective period of the traffic packet, in bytes. + * `traffic_package_total` - The total traffic in bytes during the effective period of the traffic packet. + * `traffic_used` - Traffic has been used during the effective period of the traffic packet, in bytes. + + diff --git a/config/docs/d/lighthouse_instance_vnc_url.html.markdown b/config/docs/d/lighthouse_instance_vnc_url.html.markdown new file mode 100644 index 0000000..14edb99 --- /dev/null +++ b/config/docs/d/lighthouse_instance_vnc_url.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_instance_vnc_url" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_instance_vnc_url" +description: |- + Use this data source to query detailed information of lighthouse instance_vnc_url +--- + +# tencentcloud_lighthouse_instance_vnc_url + +Use this data source to query detailed information of lighthouse instance_vnc_url + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_instance_vnc_url" "instance_vnc_url" { + instance_id = "lhins-123456" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_vnc_url` - Instance VNC URL. + + diff --git a/config/docs/d/lighthouse_modify_instance_bundle.html.markdown b/config/docs/d/lighthouse_modify_instance_bundle.html.markdown new file mode 100644 index 0000000..d2c4ec5 --- /dev/null +++ b/config/docs/d/lighthouse_modify_instance_bundle.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_modify_instance_bundle" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_modify_instance_bundle" +description: |- + Use this data source to query detailed information of lighthouse modify_instance_bundle +--- + +# tencentcloud_lighthouse_modify_instance_bundle + +Use this data source to query detailed information of lighthouse modify_instance_bundle + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_modify_instance_bundle" "modify_instance_bundle" { + instance_id = "lhins-xxxxxx" + filters { + name = "bundle-id" + values = ["bundle_gen_mc_med2_02"] + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `filters` - (Optional, List) Filter list. +- `bundle-id`: filter by the bundle ID. +- `support-platform-type`: filter by system type, valid values: `LINUX_UNIX`, `WINDOWS`. +- `bundle-type`: filter according to package type, valid values: `GENERAL_BUNDLE`, `STORAGE_BUNDLE`, `ENTERPRISE_BUNDLE`, `EXCLUSIVE_BUNDLE`, `BEFAST_BUNDLE`. +- `bundle-state`: filter according to package status, valid values: `ONLINE`, `OFFLINE`. +NOTE: The upper limit of Filters per request is 10. The upper limit of Filter.Values is 5. Parameter does not support specifying both BundleIds and Filters. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Field to be filtered. +* `values` - (Required, Set) Filter value of field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `modify_bundle_set` - Change package details. + * `bundle` - Package information. + * `bundle_display_label` - Package tag.Valid values:ACTIVITY: promotional packageNORMAL: regular packageCAREFREE: carefree package. + * `bundle_id` - Package ID. + * `bundle_sales_state` - Package sale status. Valid values are AVAILABLE, SOLD_OUT. + * `bundle_type_description` - Package type description information. + * `bundle_type` - Package type.Valid values:GENERAL_BUNDLE: generalSTORAGE_BUNDLE: Storage. + * `cpu` - CPU. + * `internet_charge_type` - Network billing mode. + * `internet_max_bandwidth_out` - Peak bandwidth in Mbps. + * `memory` - Memory size in GB. + * `monthly_traffic` - Monthly network traffic in Gb. + * `price` - Current package unit price information. + * `instance_price` - Instance price. + * `currency` - Currency unit. Valid values: CNY and USD. + * `discount_price` - Discounted price. + * `discount` - Discount. + * `original_bundle_price` - Original package unit price. + * `original_price` - Original price. + * `support_linux_unix_platform` - Whether Linux/Unix is supported. + * `support_windows_platform` - Whether Windows is supported. + * `system_disk_size` - System disk size. + * `system_disk_type` - System disk type. + * `modify_bundle_state` - Change the status of the package. Value: +- SOLD_OUT: the package is sold out; +- AVAILABLE: support package changes; +- UNAVAILABLE: package changes are not supported for the time being. + * `modify_price` - Change the price difference to be made up after the instance package. + * `instance_price` - Instance price. + * `currency` - A monetary unit of price. Value range CNY: RMB. USD: us dollar. + * `discount_price` - Discounted price. + * `discount` - Discount. + * `original_bundle_price` - Original unit price of the package. + * `original_price` - Original price. + * `not_support_modify_message` - Package change reason information is not supported. When the package status is changed to `AVAILABLE`, the information is empty. + + diff --git a/config/docs/d/lighthouse_region.html.markdown b/config/docs/d/lighthouse_region.html.markdown new file mode 100644 index 0000000..276a8fc --- /dev/null +++ b/config/docs/d/lighthouse_region.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_region" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_region" +description: |- + Use this data source to query detailed information of lighthouse region +--- + +# tencentcloud_lighthouse_region + +Use this data source to query detailed information of lighthouse region + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_region" "region" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `region_set` - Region information list. + * `is_china_mainland` - Whether the region is in the Chinese mainland. + * `region_name` - Region description. + * `region_state` - Region availability status. + * `region` - Region name. + + diff --git a/config/docs/d/lighthouse_reset_instance_blueprint.html.markdown b/config/docs/d/lighthouse_reset_instance_blueprint.html.markdown new file mode 100644 index 0000000..93670f1 --- /dev/null +++ b/config/docs/d/lighthouse_reset_instance_blueprint.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_reset_instance_blueprint" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_reset_instance_blueprint" +description: |- + Use this data source to query detailed information of lighthouse reset_instance_blueprint +--- + +# tencentcloud_lighthouse_reset_instance_blueprint + +Use this data source to query detailed information of lighthouse reset_instance_blueprint + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_reset_instance_blueprint" "reset_instance_blueprint" { + instance_id = "lhins-123456" + offset = 0 + limit = 20 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `filters` - (Optional, List) Filter listblueprint-idFilter by image ID.Type: StringRequired: noblueprint-typeFilter by image type.Valid values: APP_OS: application image; PURE_OS: system image; PRIVATE: custom imageType: StringRequired: noplatform-typeFilter by image platform type.Valid values: LINUX_UNIX: Linux or Unix; WINDOWS: WindowsType: StringRequired: noblueprint-nameFilter by image name.Type: StringRequired: noblueprint-stateFilter by image status.Type: StringRequired: noEach request can contain up to 10 Filters and 5 Filter.Values. BlueprintIds and Filters cannot be specified at the same time. +* `limit` - (Optional, Int) Number of returned results. Default value is 20. Maximum value is 100. +* `offset` - (Optional, Int) Offset. Default value is 0. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Field to be filtered. +* `values` - (Required, Set) Filter value of field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `reset_instance_blueprint_set` - List of scene info. + * `blueprint_info` - Mirror details. + * `blueprint_id` - Image ID, which is the unique identity of Blueprint. + * `blueprint_name` - Mirror name. + * `blueprint_state` - Mirror status. + * `blueprint_type` - Image type, such as APP_OS, PURE_OS, PRIVATE. + * `community_url` - The official website Url. + * `created_time` - Creation time. Expressed according to the ISO8601 standard, and using UTC time. The format is YYYY-MM-DDThh:mm:ssZ. + * `description` - Mirror description information. + * `display_title` - The mirror image shows the title to the public. + * `display_version` - The image shows the version to the public. + * `docker_version` - Docker version number. + * `guide_url` - Guide article Url. + * `image_id` - CVM image ID after sharing the CVM image to the lightweight application server. + * `image_url` - Mirror image URL. + * `os_name` - Operating system name. + * `platform_type` - Operating system platform type, such as LINUX_UNIX, WINDOWS. + * `platform` - Operating system platform. + * `required_memory_size` - Memory required for mirroring (in GB). + * `required_system_disk_size` - The size of the system disk required for image (in GB). + * `scene_id_set` - The mirror association uses the scene Id list. + * `support_automation_tools` - Whether the image supports automation helper. + * `is_resettable` - Whether the instance image can be reset to the target image. + * `non_resettable_message` - The information cannot be reset. when the mirror can be reset ''. + + diff --git a/config/docs/d/lighthouse_scene.html.markdown b/config/docs/d/lighthouse_scene.html.markdown new file mode 100644 index 0000000..5a7d5d7 --- /dev/null +++ b/config/docs/d/lighthouse_scene.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_scene" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_scene" +description: |- + Use this data source to query detailed information of lighthouse scene with region +--- + +# tencentcloud_lighthouse_scene + +Use this data source to query detailed information of lighthouse scene with region + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_scene" "scene" { + offset = 0 + limit = 20 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `limit` - (Optional, Int) Number of returned results. Default value is 20. Maximum value is 100. +* `offset` - (Optional, Int) Offset. Default value is 0. +* `result_output_file` - (Optional, String) Used to save results. +* `scene_ids` - (Optional, Set: [`String`]) List of scene IDs. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `scene_set` - List of scene info. + * `description` - Use scene description. + * `display_name` - Use the scene presentation name. + * `scene_id` - Use scene Id. + + diff --git a/config/docs/d/lighthouse_zone.html.markdown b/config/docs/d/lighthouse_zone.html.markdown new file mode 100644 index 0000000..7e2dca4 --- /dev/null +++ b/config/docs/d/lighthouse_zone.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_zone" +sidebar_current: "docs-tencentcloud-datasource-lighthouse_zone" +description: |- + Use this data source to query detailed information of lighthouse zone +--- + +# tencentcloud_lighthouse_zone + +Use this data source to query detailed information of lighthouse zone + +## Example Usage + +```hcl +data "tencentcloud_lighthouse_zone" "zone" { + order_field = "ZONE" + order = "ASC" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `order_field` - (Optional, String) Sorting field. Valid values: +- ZONE: Sort by the availability zone. +- INSTANCE_DISPLAY_LABEL: Sort by visibility labels (HIDDEN, NORMAL and SELECTED). Default: [HIDDEN, NORMAL, SELECTED]. +Sort by availability zone by default. +* `order` - (Optional, String) Specifies how availability zones are listed. Valid values: +- ASC: Ascending sort. +- DESC: Descending sort. +The default value is ASC. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `zone_info_set` - List of zone info. + * `instance_display_label` - Instance purchase page availability zone display label. + * `zone_name` - Chinese name of availability zone. + * `zone` - Availability zone. + + diff --git a/config/docs/d/mariadb_accounts.html.markdown b/config/docs/d/mariadb_accounts.html.markdown new file mode 100644 index 0000000..16cecfa --- /dev/null +++ b/config/docs/d/mariadb_accounts.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_accounts" +sidebar_current: "docs-tencentcloud-datasource-mariadb_accounts" +description: |- + Use this data source to query detailed information of mariadb accounts +--- + +# tencentcloud_mariadb_accounts + +Use this data source to query detailed information of mariadb accounts + +## Example Usage + +```hcl +data "tencentcloud_mariadb_accounts" "accounts" { + instance_id = "tdsql-4pzs5b67" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - account list. + * `create_time` - creation time. + * `delay_thresh` - This field is meaningful for read-only accounts, indicating that the standby machine with the active-standby delay less than this value is selected. + * `description` - User remarks. + * `host` - The host from which the user can log in (corresponding to the host field of MySQL users, UserName + Host uniquely identifies a user, in the form of IP, and the IP segment ends with %; supports filling in %; if it is empty, it defaults to %). + * `read_only` - Read-only flag, `0`: No, `1`: The SQL request of this account is preferentially executed on the standby machine, and the host machine is selected for execution when the standby machine is unavailable, `2`: The standby machine is preferentially selected for execution, and the operation fails when the standby machine is unavailable. + * `slave_const` - For read-only accounts, set whether the policy is to fix the standby machine, `0`: The standby machine is not fixed, that is, the standby machine does not meet the conditions and will not disconnect from the client, and the Proxy selects other available standby machines, `1`: The standby machine does not meet the conditions Disconnect, make sure one connection secures the standby. + * `update_time` - Update time. + * `user_name` - username. + + diff --git a/config/docs/d/mariadb_database_objects.html.markdown b/config/docs/d/mariadb_database_objects.html.markdown new file mode 100644 index 0000000..4993c79 --- /dev/null +++ b/config/docs/d/mariadb_database_objects.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_database_objects" +sidebar_current: "docs-tencentcloud-datasource-mariadb_database_objects" +description: |- + Use this data source to query detailed information of mariadb database_objects +--- + +# tencentcloud_mariadb_database_objects + +Use this data source to query detailed information of mariadb database_objects + +## Example Usage + +```hcl +data "tencentcloud_mariadb_database_objects" "database_objects" { + instance_id = "tdsql-n2fw7pn3" + db_name = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_name` - (Required, String) database name. +* `instance_id` - (Required, String) instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `funcs` - func list. + * `func` - func name. +* `procs` - proc list. + * `proc` - proc name. +* `tables` - table list. + * `table` - table name. +* `views` - view list. + * `view` - view name. + + diff --git a/config/docs/d/mariadb_database_table.html.markdown b/config/docs/d/mariadb_database_table.html.markdown new file mode 100644 index 0000000..3acc611 --- /dev/null +++ b/config/docs/d/mariadb_database_table.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_database_table" +sidebar_current: "docs-tencentcloud-datasource-mariadb_database_table" +description: |- + Use this data source to query detailed information of mariadb database_table +--- + +# tencentcloud_mariadb_database_table + +Use this data source to query detailed information of mariadb database_table + +## Example Usage + +```hcl +data "tencentcloud_mariadb_database_table" "database_table" { + instance_id = "tdsql-e9tklsgz" + db_name = "mysql" + table = "server_cost" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_name` - (Required, String) database name. +* `instance_id` - (Required, String) instance id. +* `table` - (Required, String) table name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cols` - column list. + * `col` - column name. + * `type` - column type. + + diff --git a/config/docs/d/mariadb_databases.html.markdown b/config/docs/d/mariadb_databases.html.markdown new file mode 100644 index 0000000..a1dd579 --- /dev/null +++ b/config/docs/d/mariadb_databases.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_databases" +sidebar_current: "docs-tencentcloud-datasource-mariadb_databases" +description: |- + Use this data source to query detailed information of mariadb databases +--- + +# tencentcloud_mariadb_databases + +Use this data source to query detailed information of mariadb databases + +## Example Usage + +```hcl +data "tencentcloud_mariadb_databases" "databases" { + instance_id = "tdsql-e9tklsgz" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `databases` - The database list of this instance. + * `db_name` - Database name. + + diff --git a/config/docs/d/mariadb_db_instances.html.markdown b/config/docs/d/mariadb_db_instances.html.markdown new file mode 100644 index 0000000..b68a482 --- /dev/null +++ b/config/docs/d/mariadb_db_instances.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_db_instances" +sidebar_current: "docs-tencentcloud-datasource-mariadb_db_instances" +description: |- + Use this data source to query detailed information of mariadb dbInstances +--- + +# tencentcloud_mariadb_db_instances + +Use this data source to query detailed information of mariadb dbInstances + +## Example Usage + +```hcl +data "tencentcloud_mariadb_db_instances" "dbInstances" { + instance_ids = ["tdsql-ijxtqk5p"] + project_ids = ["0"] + vpc_id = "5556791" + subnet_id = "3454730" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_ids` - (Optional, Set: [`String`]) instance ids. +* `project_ids` - (Optional, Set: [`Int`]) project ids. +* `result_output_file` - (Optional, String) Used to save results. +* `search_name` - (Optional, String) instance name or vip. +* `subnet_id` - (Optional, String) subnet id. +* `vpc_id` - (Optional, String) vpc id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instances` - instances info. + * `db_version_id` - db version id. + * `instance_id` - instance id. + * `instance_name` - instance name. + * `memory` - meory of instance. + * `project_id` - project id. + * `region` - region. + * `resource_tags` - resource tags. + * `tag_key` - tag key. + * `tag_value` - tag value. + * `storage` - storage of instance. + * `subnet_id` - subnet id. + * `vpc_id` - vpc id. + * `zone` - available zone. + + diff --git a/config/docs/d/mariadb_dcn_detail.html.markdown b/config/docs/d/mariadb_dcn_detail.html.markdown new file mode 100644 index 0000000..bbe8664 --- /dev/null +++ b/config/docs/d/mariadb_dcn_detail.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_dcn_detail" +sidebar_current: "docs-tencentcloud-datasource-mariadb_dcn_detail" +description: |- + Use this data source to query detailed information of mariadb dcn_detail +--- + +# tencentcloud_mariadb_dcn_detail + +Use this data source to query detailed information of mariadb dcn_detail + +## Example Usage + +```hcl +data "tencentcloud_mariadb_dcn_detail" "dcn_detail" { + instance_id = "tdsql-9vqvls95" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `dcn_details` - DCN synchronization details. + * `cpu` - Number of CPU cores of the instance. + * `create_time` - Creation time of the instance in the format of 2006-01-02 15:04:05. + * `dcn_flag` - DCN flag. Valid values: `1` (primary), `2` (disaster recovery). + * `dcn_status` - DCN status. Valid values: `0` (none), `1` (creating), `2` (syncing), `3` (disconnected). + * `encrypt_status` - Whether KMS is enabled. + * `instance_id` - Instance ID. + * `instance_name` - Instance name. + * `instance_type` - Instance type. Valid values: `1` (dedicated primary instance), `2` (non-dedicated primary instance), `3` (non-dedicated disaster recovery instance), `4` (dedicated disaster recovery instance). + * `memory` - Instance memory capacity in GB. + * `pay_mode` - Billing mode. + * `period_end_time` - Expiration time of the instance in the format of 2006-01-02 15:04:05. + * `region` - Region where the instance resides. + * `replica_config` - Configuration information of DCN replication. This field is null for a primary instance.Note: This field may return null, indicating that no valid values can be obtained. + * `delay_replication_type` - Delayed replication type. Valid values: `DEFAULT` (no delay), `DUE_TIME` (specified replication time)Note: This field may return null, indicating that no valid values can be obtained. + * `due_time` - Specified time for delayed replicationNote: This field may return null, indicating that no valid values can be obtained. + * `replication_delay` - The number of seconds to delay the replicationNote: This field may return null, indicating that no valid values can be obtained. + * `ro_replication_mode` - DCN running status. Valid values: `START` (running), `STOP` (pause)Note: This field may return null, indicating that no valid values can be obtained. + * `replica_status` - DCN replication status. This field is null for the primary instance.Note: This field may return null, indicating that no valid values can be obtained. + * `delay` - The current delay, which takes the delay value of the replica instance. + * `status` - DCN running status. Valid values: `START` (running), `STOP` (pause).Note: This field may return null, indicating that no valid values can be obtained. + * `status_desc` - Instance status description. + * `status` - Instance status. + * `storage` - Instance storage capacity in GB. + * `vip` - Instance IP address. + * `vipv6` - Instance IPv6 address. + * `vport` - Instance port. + * `zone` - Availability zone where the instance resides. + + diff --git a/config/docs/d/mariadb_file_download_url.html.markdown b/config/docs/d/mariadb_file_download_url.html.markdown new file mode 100644 index 0000000..043f5ba --- /dev/null +++ b/config/docs/d/mariadb_file_download_url.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_file_download_url" +sidebar_current: "docs-tencentcloud-datasource-mariadb_file_download_url" +description: |- + Use this data source to query detailed information of mariadb file_download_url +--- + +# tencentcloud_mariadb_file_download_url + +Use this data source to query detailed information of mariadb file_download_url + +## Example Usage + +```hcl +data "tencentcloud_mariadb_file_download_url" "file_download_url" { + instance_id = "tdsql-9vqvls95" + file_path = "/cos_backup/test.txt" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `file_path` - (Required, String) Unsigned file path. +* `instance_id` - (Required, String) Instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `pre_signed_url` - Signed download URL. + + diff --git a/config/docs/d/mariadb_flow.html.markdown b/config/docs/d/mariadb_flow.html.markdown new file mode 100644 index 0000000..2edb724 --- /dev/null +++ b/config/docs/d/mariadb_flow.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_flow" +sidebar_current: "docs-tencentcloud-datasource-mariadb_flow" +description: |- + Use this data source to query detailed information of mariadb flow +--- + +# tencentcloud_mariadb_flow + +Use this data source to query detailed information of mariadb flow + +## Example Usage + +```hcl +data "tencentcloud_mariadb_flow" "flow" { + flow_id = 1307 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `flow_id` - (Required, Int) Flow ID returned by async request API. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `status` - Flow status. 0: succeeded, 1: failed, 2: running. + + diff --git a/config/docs/d/mariadb_instance_specs.html.markdown b/config/docs/d/mariadb_instance_specs.html.markdown new file mode 100644 index 0000000..02902ad --- /dev/null +++ b/config/docs/d/mariadb_instance_specs.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_instance_specs" +sidebar_current: "docs-tencentcloud-datasource-mariadb_instance_specs" +description: |- + Use this data source to query detailed information of mariadb instance_specs +--- + +# tencentcloud_mariadb_instance_specs + +Use this data source to query detailed information of mariadb instance_specs + +## Example Usage + +```hcl +data "tencentcloud_mariadb_instance_specs" "instance_specs" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `specs` - list of instance specifications. + * `machine` - machine type. + * `spec_infos` - list of machine specifications. + * `cpu` - CPU cores. + * `machine` - machine type. + * `max_storage` - maximum storage size, in GB. + * `memory` - memory, in GB. + * `min_storage` - minimum storage size, in GB. + * `node_count` - node count. + * `pid` - product price id. + * `qps` - maximum QPS. + * `suit_info` - recommended usage scenarios. + + diff --git a/config/docs/d/mariadb_log_files.html.markdown b/config/docs/d/mariadb_log_files.html.markdown new file mode 100644 index 0000000..d1d2802 --- /dev/null +++ b/config/docs/d/mariadb_log_files.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_log_files" +sidebar_current: "docs-tencentcloud-datasource-mariadb_log_files" +description: |- + Use this data source to query detailed information of mariadb log_files +--- + +# tencentcloud_mariadb_log_files + +Use this data source to query detailed information of mariadb log_files + +## Example Usage + +```hcl +data "tencentcloud_mariadb_log_files" "log_files" { + instance_id = "tdsql-9vqvls95" + type = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID in the format of `tdsql-ow728lmc`. +* `type` - (Required, Int) Requested log type. Valid values: 1 (binlog), 2 (cold backup), 3 (errlog), 4 (slowlog). +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `files` - Information such as `uri`, `length`, and `mtime` (modification time). + * `file_name` - Filename. + * `length` - File length. + * `mtime` - Last modified time of log. + * `uri` - Uniform resource identifier (URI) used during log download. +* `normal_prefix` - For an instance in a common network, this prefix plus URI can be used as the download address. +* `vpc_prefix` - For an instance in a VPC, this prefix plus URI can be used as the download address. + + diff --git a/config/docs/d/mariadb_orders.html.markdown b/config/docs/d/mariadb_orders.html.markdown new file mode 100644 index 0000000..2d764f8 --- /dev/null +++ b/config/docs/d/mariadb_orders.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_orders" +sidebar_current: "docs-tencentcloud-datasource-mariadb_orders" +description: |- + Use this data source to query detailed information of mariadb orders +--- + +# tencentcloud_mariadb_orders + +Use this data source to query detailed information of mariadb orders + +## Example Usage + +```hcl +data "tencentcloud_mariadb_orders" "orders" { + deal_name = "20230607164033835942781" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `deal_name` - (Required, String) List of long order numbers to be queried, which are returned for the APIs for creating, renewing, or scaling instances. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `deals` - Order information list. + * `count` - Number of items. + * `deal_name` - Order number. + * `flow_id` - ID of the associated process, which can be used to query the process execution status. + * `instance_ids` - The ID of the created instance, which is required only for the order that creates an instance.Note: This field may return null, indicating that no valid values can be obtained. + * `owner_uin` - Account. + * `pay_mode` - Payment mode. Valid values: 0 (postpaid), 1 (prepaid). + + diff --git a/config/docs/d/mariadb_price.html.markdown b/config/docs/d/mariadb_price.html.markdown new file mode 100644 index 0000000..9230c6c --- /dev/null +++ b/config/docs/d/mariadb_price.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_price" +sidebar_current: "docs-tencentcloud-datasource-mariadb_price" +description: |- + Use this data source to query detailed information of mariadb price +--- + +# tencentcloud_mariadb_price + +Use this data source to query detailed information of mariadb price + +## Example Usage + +```hcl +data "tencentcloud_mariadb_price" "price" { + zone = "ap-guangzhou-3" + node_count = 2 + memory = 2 + storage = 20 + buy_count = 1 + period = 1 + paymode = "prepaid" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `buy_count` - (Required, Int) The quantity you want to purchase is queried by default for the price of purchasing 1 instance. +* `memory` - (Required, Int) Memory size in GB, which can be obtained by querying the instance specification through the `DescribeDBInstanceSpecs` API. +* `node_count` - (Required, Int) Number of instance nodes, which can be obtained by querying the instance specification through the `DescribeDBInstanceSpecs` API. +* `storage` - (Required, Int) Storage capacity in GB. The maximum and minimum storage space can be obtained by querying instance specification through the `DescribeDBInstanceSpecs` API. +* `zone` - (Required, String) AZ ID of the purchased instance. +* `amount_unit` - (Optional, String) Price unit. Valid values: `* pent` (cent), `* microPent` (microcent). +* `paymode` - (Optional, String) Billing type. Valid values: `postpaid` (pay-as-you-go), `prepaid` (monthly subscription). +* `period` - (Optional, Int) Purchase period in months. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `original_price` - Original price * Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. * Currency: CNY (Chinese site), USD (international site). +* `price` - The actual price may be different from the original price due to discounts. * Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. * Currency: CNY (Chinese site), USD (international site). + + diff --git a/config/docs/d/mariadb_project_security_groups.html.markdown b/config/docs/d/mariadb_project_security_groups.html.markdown new file mode 100644 index 0000000..7f0a569 --- /dev/null +++ b/config/docs/d/mariadb_project_security_groups.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_project_security_groups" +sidebar_current: "docs-tencentcloud-datasource-mariadb_project_security_groups" +description: |- + Use this data source to query detailed information of mariadb project_security_groups +--- + +# tencentcloud_mariadb_project_security_groups + +Use this data source to query detailed information of mariadb project_security_groups + +## Example Usage + +```hcl +data "tencentcloud_mariadb_project_security_groups" "project_security_groups" { + product = "mariadb" + project_id = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `product` - (Required, String) Database engine name. Valid value: `mariadb`. +* `project_id` - (Optional, Int) Project ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `groups` - Security group details. + * `create_time` - Creation time in the format of yyyy-mm-dd hh:mm:ss. + * `inbound` - Inbound rule. + * `action` - Policy, which can be `ACCEPT` or `DROP`. + * `cidr_ip` - Source IP or source IP range, such as 192.168.0.0/16. + * `ip_protocol` - Network protocol. UDP and TCP are supported. + * `port_range` - Port. + * `outbound` - Outbound rule. + * `action` - Policy, which can be `ACCEPT` or `DROP`. + * `cidr_ip` - Source IP or source IP range, such as 192.168.0.0/16. + * `ip_protocol` - Network protocol. UDP and TCP are supported. + * `port_range` - Port. + * `project_id` - Project ID. + * `security_group_id` - Security group ID. + * `security_group_name` - Security group name. + * `security_group_remark` - Security group remarks. + + diff --git a/config/docs/d/mariadb_renewal_price.html.markdown b/config/docs/d/mariadb_renewal_price.html.markdown new file mode 100644 index 0000000..a454626 --- /dev/null +++ b/config/docs/d/mariadb_renewal_price.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_renewal_price" +sidebar_current: "docs-tencentcloud-datasource-mariadb_renewal_price" +description: |- + Use this data source to query detailed information of mariadb renewal_price +--- + +# tencentcloud_mariadb_renewal_price + +Use this data source to query detailed information of mariadb renewal_price + +## Example Usage + +```hcl +data "tencentcloud_mariadb_renewal_price" "renewal_price" { + instance_id = "tdsql-9vqvls95" + period = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `amount_unit` - (Optional, String) Price unit. Valid values: `* pent` (cent), `* microPent` (microcent). +* `period` - (Optional, Int) Renewal duration, default: 1 month. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `original_price` - Original price * Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. * Currency: CNY (Chinese site), USD (international site). +* `price` - The actual price may be different from the original price due to discounts. * Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. * Currency: CNY (Chinese site), USD (international site). + + diff --git a/config/docs/d/mariadb_sale_info.html.markdown b/config/docs/d/mariadb_sale_info.html.markdown new file mode 100644 index 0000000..1a2f2fc --- /dev/null +++ b/config/docs/d/mariadb_sale_info.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_sale_info" +sidebar_current: "docs-tencentcloud-datasource-mariadb_sale_info" +description: |- + Use this data source to query detailed information of mariadb sale_info +--- + +# tencentcloud_mariadb_sale_info + +Use this data source to query detailed information of mariadb sale_info + +## Example Usage + +```hcl +data "tencentcloud_mariadb_sale_info" "sale_info" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `region_list` - list of sale region info. + * `available_choice` - available zone choice. + * `master_zone` - master zone. + * `on_sale` - is zone on sale. + * `zone_id` - zone id. + * `zone_name` - zone name(zh). + * `zone` - zone name(en). + * `slave_zones` - slave zones. + * `on_sale` - is zone on sale. + * `zone_id` - zone id. + * `zone_name` - zone name(zh). + * `zone` - zone name(en). + * `region_id` - region id. + * `region_name` - region name(zh). + * `region` - region name(en). + * `zone_list` - list of az zone. + * `on_sale` - is zone on sale. + * `zone_id` - zone id. + * `zone_name` - zone name(zh). + * `zone` - zone name(en). + + diff --git a/config/docs/d/mariadb_security_groups.html.markdown b/config/docs/d/mariadb_security_groups.html.markdown new file mode 100644 index 0000000..40a9844 --- /dev/null +++ b/config/docs/d/mariadb_security_groups.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_security_groups" +sidebar_current: "docs-tencentcloud-datasource-mariadb_security_groups" +description: |- + Use this data source to query detailed information of mariadb securityGroups +--- + +# tencentcloud_mariadb_security_groups + +Use this data source to query detailed information of mariadb securityGroups + +## Example Usage + +```hcl +data "tencentcloud_mariadb_security_groups" "securityGroups" { + instance_id = "tdsql-4pzs5b67" + product = "mariadb" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `product` - (Required, String) product name, fixed to mariadb. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - SecurityGroup list. + * `create_time` - Creation time, time format: `yyyy-mm-dd hh:mm:ss`. + * `inbound` - Inbound rules. + * `action` - Policy, ACCEPT or DROP. + * `cidr_ip` - Source IP or IP range, such as 192.168.0.0/16. + * `ip_protocol` - Network protocols, support `UDP`, `TCP`, etc. + * `port_range` - port. + * `outbound` - Outbound Rules. + * `action` - Policy, ACCEPT or DROP. + * `cidr_ip` - Source IP or IP range, such as 192.168.0.0/16. + * `ip_protocol` - Network protocols, support `UDP`, `TCP`, etc. + * `port_range` - port. + * `project_id` - Project ID. + * `security_group_id` - Security group ID. + * `security_group_name` - security group name. + * `security_group_remark` - Security Group Notes. + + diff --git a/config/docs/d/mariadb_slow_logs.html.markdown b/config/docs/d/mariadb_slow_logs.html.markdown new file mode 100644 index 0000000..168d83f --- /dev/null +++ b/config/docs/d/mariadb_slow_logs.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_slow_logs" +sidebar_current: "docs-tencentcloud-datasource-mariadb_slow_logs" +description: |- + Use this data source to query detailed information of mariadb slow_logs +--- + +# tencentcloud_mariadb_slow_logs + +Use this data source to query detailed information of mariadb slow_logs + +## Example Usage + +```hcl +data "tencentcloud_mariadb_slow_logs" "slow_logs" { + instance_id = "tdsql-9vqvls95" + start_time = "2023-06-01 14:55:20" + order_by = "query_time_sum" + order_by_type = "desc" + slave = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID in the format of `tdsql-ow728lmc`. +* `start_time` - (Required, String) Query start time in the format of 2016-07-23 14:55:20. +* `db` - (Optional, String) Specific name of the database to be queried. +* `end_time` - (Optional, String) Query end time in the format of 2016-08-22 14:55:20. +* `order_by_type` - (Optional, String) Sorting order. Valid values: desc, asc. +* `order_by` - (Optional, String) Sorting metric. Valid values: query_time_sum, query_count. +* `result_output_file` - (Optional, String) Used to save results. +* `slave` - (Optional, Int) Query slow queries from either the primary or the replica. Valid values: 0 (primary), 1 (replica). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Slow query log data. + * `check_sum` - Statement checksum for querying details. + * `db` - Database name. + * `example_sql` - Sample SQLNote: This field may return null, indicating that no valid values can be obtained. + * `finger_print` - Abstracted SQL statement. + * `host` - Host address of account. + * `lock_time_avg` - Average lock time. + * `lock_time_max` - Maximum lock time. + * `lock_time_min` - Minimum lock time. + * `lock_time_sum` - Total lock time. + * `query_count` - Number of queries. + * `query_time_avg` - Average query time. + * `query_time_max` - Maximum query time. + * `query_time_min` - Minimum query time. + * `query_time_sum` - Total query time. + * `rows_examined_sum` - Number of scanned rows. + * `rows_sent_sum` - Number of sent rows. + * `ts_max` - Last execution time. + * `ts_min` - First execution time. + * `user` - Account. +* `lock_time_sum` - Total statement lock time. +* `query_count` - Total number of statement queries. +* `query_time_sum` - Total statement query time. + + diff --git a/config/docs/d/mariadb_upgrade_price.html.markdown b/config/docs/d/mariadb_upgrade_price.html.markdown new file mode 100644 index 0000000..7c9befa --- /dev/null +++ b/config/docs/d/mariadb_upgrade_price.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_upgrade_price" +sidebar_current: "docs-tencentcloud-datasource-mariadb_upgrade_price" +description: |- + Use this data source to query detailed information of mariadb upgrade_price +--- + +# tencentcloud_mariadb_upgrade_price + +Use this data source to query detailed information of mariadb upgrade_price + +## Example Usage + +```hcl +data "tencentcloud_mariadb_upgrade_price" "upgrade_price" { + instance_id = "tdsql-9vqvls95" + memory = 4 + storage = 40 + node_count = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `memory` - (Required, Int) Memory size in GB, which can be obtained by querying the instance specification through the `DescribeDBInstanceSpecs` API. +* `storage` - (Required, Int) Storage capacity in GB. The maximum and minimum storage space can be obtained by querying instance specification through the `DescribeDBInstanceSpecs` API. +* `amount_unit` - (Optional, String) Price unit. Valid values: `* pent` (cent), `* microPent` (microcent). +* `node_count` - (Optional, Int) New instance nodes, zero means not change. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `formula` - Price calculation formula. +* `original_price` - Original price * Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. * Currency: CNY (Chinese site), USD (international site). +* `price` - The actual price may be different from the original price due to discounts. * Unit: Cent (default). If the request parameter contains `AmountUnit`, see `AmountUnit` description. * Currency: CNY (Chinese site), USD (international site). + + diff --git a/config/docs/d/mongodb_instance_backups.html.markdown b/config/docs/d/mongodb_instance_backups.html.markdown new file mode 100644 index 0000000..6b48c19 --- /dev/null +++ b/config/docs/d/mongodb_instance_backups.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_instance_backups" +sidebar_current: "docs-tencentcloud-datasource-mongodb_instance_backups" +description: |- + Use this data source to query detailed information of mongodb instance_backups +--- + +# tencentcloud_mongodb_instance_backups + +Use this data source to query detailed information of mongodb instance_backups + +## Example Usage + +```hcl +data "tencentcloud_mongodb_instance_backups" "instance_backups" { + instance_id = "cmgo-9d0p6umb" + backup_method = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page. +* `backup_method` - (Optional, Int) Backup mode, currently supported: 0-logic backup, 1-physical backup, 2-all backups.The default is logical backup. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `backup_list` - backup list. + * `backup_desc` - Remark of backup. + * `backup_method` - Backup method. + * `backup_name` - Backup mode name. + * `backup_size` - Size of backup(KN). + * `backup_type` - Backup mode type. + * `end_time` - end time of backup. + * `instance_id` - Instance ID. + * `start_time` - start time of backup. + * `status` - Backup status. + + diff --git a/config/docs/d/mongodb_instance_connections.html.markdown b/config/docs/d/mongodb_instance_connections.html.markdown new file mode 100644 index 0000000..08d0b1b --- /dev/null +++ b/config/docs/d/mongodb_instance_connections.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_instance_connections" +sidebar_current: "docs-tencentcloud-datasource-mongodb_instance_connections" +description: |- + Use this data source to query detailed information of mongodb instance_connections +--- + +# tencentcloud_mongodb_instance_connections + +Use this data source to query detailed information of mongodb instance_connections + +## Example Usage + +```hcl +data "tencentcloud_mongodb_instance_connections" "instance_connections" { + instance_id = "cmgo-9d0p6umb" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `clients` - Client connection info. + * `count` - client connection count. + * `internal_service` - is internal. + * `ip` - client connection ip. + + diff --git a/config/docs/d/mongodb_instance_current_op.html.markdown b/config/docs/d/mongodb_instance_current_op.html.markdown new file mode 100644 index 0000000..ff75076 --- /dev/null +++ b/config/docs/d/mongodb_instance_current_op.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_instance_current_op" +sidebar_current: "docs-tencentcloud-datasource-mongodb_instance_current_op" +description: |- + Use this data source to query detailed information of mongodb instance_current_op +--- + +# tencentcloud_mongodb_instance_current_op + +Use this data source to query detailed information of mongodb instance_current_op + +## Example Usage + +```hcl +data "tencentcloud_mongodb_instance_current_op" "instance_current_op" { + instance_id = "cmgo-b43i3wkj" + op = "command" + order_by_type = "desc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page. +* `millisecond_running` - (Optional, Int) Filter condition, the time that the operation has been executed (unit: millisecond),the result will return the operation that exceeds the set time, the default value is 0,and the value range is [0, 3600000]. +* `ns` - (Optional, String) Filter condition, the namespace namespace to which the operation belongs, in the format of db.collection. +* `op` - (Optional, String) Filter condition, operation type, possible values: none, update, insert, query, command, getmore,remove and killcursors. +* `order_by_type` - (Optional, String) Returns the sorting method of the result set, possible values: ASC/asc or DESC/desc. +* `order_by` - (Optional, String) Returns the sorted field of the result set, currently supports: MicrosecsRunning/microsecsrunning,the default is ascending sort. +* `replica_set_name` - (Optional, String) filter condition, shard name. +* `result_output_file` - (Optional, String) Used to save results. +* `state` - (Optional, String) Filter condition, node status, possible value: primary, secondary. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `current_ops` - current operation list. + * `microsecs_running` - running time(ms). + * `node_name` - Node name. + * `ns` - operation namespace. + * `op_id` - operation id. + * `op` - operation value. + * `operation` - operation info. + * `query` - operation query. + * `replica_set_name` - Replication name. + * `state` - operation state. + + diff --git a/config/docs/d/mongodb_instance_params.html.markdown b/config/docs/d/mongodb_instance_params.html.markdown new file mode 100644 index 0000000..5cffc80 --- /dev/null +++ b/config/docs/d/mongodb_instance_params.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_instance_params" +sidebar_current: "docs-tencentcloud-datasource-mongodb_instance_params" +description: |- + Use this data source to query detailed information of mongodb instance_params +--- + +# tencentcloud_mongodb_instance_params + +Use this data source to query detailed information of mongodb instance_params + +## Example Usage + +```hcl +data "tencentcloud_mongodb_instance_params" "instance_params" { + instance_id = "cmgo-gwqk8669" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) InstanceId. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_enum_param` - Enum parameter. + * `current_value` - current value. + * `default_value` - default value. + * `enum_value` - enumvalue. + * `need_restart` - if need restart. + * `param_name` - name of parameter. + * `status` - if is running. + * `tips` - descripition of parameter. + * `value_type` - value type. +* `instance_integer_param` - Integer parameter. + * `current_value` - current value. + * `default_value` - default value. + * `max` - max value. + * `min` - min value. + * `need_restart` - if need restart. + * `param_name` - name of parameter. + * `status` - if is running. + * `tips` - descripition of parameter. + * `value_type` - value type. +* `instance_multi_param` - multi parameter. + * `current_value` - current value. + * `default_value` - default value. + * `enum_value` - enum value. + * `need_restart` - if need restart. + * `param_name` - name of parameter. + * `status` - if is running. + * `tips` - descripition of parameter. + * `value_type` - value type. +* `instance_text_param` - text parameter. + * `current_value` - current value. + * `default_value` - default value. + * `need_restart` - if need restart. + * `param_name` - name of parameter. + * `status` - if is running. + * `text_value` - text value. + * `tips` - descripition of parameter. + * `value_type` - value type. + + diff --git a/config/docs/d/mongodb_instance_slow_log.html.markdown b/config/docs/d/mongodb_instance_slow_log.html.markdown new file mode 100644 index 0000000..2e50f12 --- /dev/null +++ b/config/docs/d/mongodb_instance_slow_log.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_instance_slow_log" +sidebar_current: "docs-tencentcloud-datasource-mongodb_instance_slow_log" +description: |- + Use this data source to query detailed information of mongodb instance_slow_log +--- + +# tencentcloud_mongodb_instance_slow_log + +Use this data source to query detailed information of mongodb instance_slow_log + +## Example Usage + +```hcl +data "tencentcloud_mongodb_instance_slow_log" "instance_slow_log" { + instance_id = "cmgo-9d0p6umb" + start_time = "2019-06-01 10:00:00" + end_time = "2019-06-02 12:00:00" + slow_m_s = 100 + format = "json" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) Slow log termination time, format: yyyy-mm-dd hh:mm:ss, such as: 2019-06-02 12:00:00.The time interval between the start and end of the query cannot exceed 24 hours,and only slow logs within the last 7 days are allowed to be queried. +* `instance_id` - (Required, String) Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page. +* `slow_ms` - (Required, Int) Slow log execution time threshold, return slow logs whose execution time exceeds this threshold,the unit is milliseconds (ms), and the minimum is 100 milliseconds. +* `start_time` - (Required, String) Slow log start time, format: yyyy-mm-dd hh:mm:ss, such as: 2019-06-01 10:00:00. The time intervalbetween the start and end of the query cannot exceed 24 hours,and only slow logs within the last 7 days are allowed to be queried. +* `format` - (Optional, String) Slow log return format. By default, the original slow log format is returned,and versions 4.4 and above can be set to json. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `slow_logs` - details of slow logs. + + diff --git a/config/docs/d/mongodb_instances.html.markdown b/config/docs/d/mongodb_instances.html.markdown new file mode 100644 index 0000000..dda160e --- /dev/null +++ b/config/docs/d/mongodb_instances.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_instances" +sidebar_current: "docs-tencentcloud-datasource-mongodb_instances" +description: |- + Use this data source to query detailed information of Mongodb instances. +--- + +# tencentcloud_mongodb_instances + +Use this data source to query detailed information of Mongodb instances. + +## Example Usage + +```hcl +data "tencentcloud_mongodb_instances" "mongodb" { + instance_id = "cmgo-l6lwdsel" + cluster_type = "REPLSET" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_type` - (Optional, String) Type of Mongodb cluster, and available values include replica set cluster(expressed with `REPLSET`), sharding cluster(expressed with `SHARD`). +* `instance_id` - (Optional, String) ID of the Mongodb instance to be queried. +* `instance_name_prefix` - (Optional, String) Name prefix of the Mongodb instance. +* `result_output_file` - (Optional, String) Used to store results. +* `tags` - (Optional, Map) Tags of the Mongodb instance to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - A list of instances. Each element contains the following attributes: + * `auto_renew_flag` - Auto renew flag. + * `available_zone` - The available zone of the Mongodb. + * `charge_type` - The charge type of instance. + * `cluster_type` - Type of Mongodb cluster. + * `cpu` - Number of cpu's core. + * `create_time` - Creation time of the Mongodb instance. + * `engine_version` - Version of the Mongodb engine. + * `instance_id` - ID of the Mongodb instance. + * `instance_name` - Name of the Mongodb instance. + * `machine_type` - Type of Mongodb instance. + * `memory` - Memory size. + * `project_id` - ID of the project which the instance belongs. + * `shard_quantity` - Number of sharding. + * `status` - Status of the Mongodb, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2). + * `subnet_id` - ID of the subnet. + * `tags` - Tags of the Mongodb instance. + * `vip` - IP of the Mongodb instance. + * `volume` - Disk size. + * `vpc_id` - ID of the VPC. + * `vport` - IP port of the Mongodb instance. + + diff --git a/config/docs/d/mongodb_zone_config.html.markdown b/config/docs/d/mongodb_zone_config.html.markdown new file mode 100644 index 0000000..5d8b418 --- /dev/null +++ b/config/docs/d/mongodb_zone_config.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_zone_config" +sidebar_current: "docs-tencentcloud-datasource-mongodb_zone_config" +description: |- + Use this data source to query the available mongodb specifications for different zone. +--- + +# tencentcloud_mongodb_zone_config + +Use this data source to query the available mongodb specifications for different zone. + +## Example Usage + +```hcl +data "tencentcloud_mongodb_zone_config" "mongodb" { + available_zone = "ap-guangzhou-2" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `available_zone` - (Optional, String) The available zone of the Mongodb. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of zone config. Each element contains the following attributes: + * `available_zone` - The available zone of the Mongodb. + * `cluster_type` - Type of Mongodb cluster. + * `cpu` - Number of cpu's core. + * `default_storage` - Default disk size. + * `engine_version` - Version of the Mongodb version. + * `machine_type` - Type of Mongodb instance. + * `max_replicate_set_num` - Maximum replicate set num for sharding cluster. + * `max_storage` - Maximum size of the disk. + * `memory` - Memory size. + * `min_replicate_set_num` - Minimum replicate set num for sharding cluster. + * `min_storage` - Minimum sie of the disk. + + diff --git a/config/docs/d/monitor_alarm_all_namespaces.html.markdown b/config/docs/d/monitor_alarm_all_namespaces.html.markdown new file mode 100644 index 0000000..a9aee13 --- /dev/null +++ b/config/docs/d/monitor_alarm_all_namespaces.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_all_namespaces" +sidebar_current: "docs-tencentcloud-datasource-monitor_alarm_all_namespaces" +description: |- + Use this data source to query detailed information of monitor alarm_all_namespaces +--- + +# tencentcloud_monitor_alarm_all_namespaces + +Use this data source to query detailed information of monitor alarm_all_namespaces + +## Example Usage + +```hcl +data "tencentcloud_monitor_alarm_all_namespaces" "alarm_all_namespaces" { + scene_type = "ST_ALARM" + module = "monitor" + monitor_types = ["MT_QCE"] + ids = ["qaap_tunnel_l4_listeners"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `module` - (Required, String) Fixed value, as `monitor`. +* `scene_type` - (Required, String) Currently, only ST_ALARM=alarm type is filtered based on usage scenarios. +* `ids` - (Optional, Set: [`String`]) Filter based on the Id of the namespace without filling in the default query for all. +* `monitor_types` - (Optional, Set: [`String`]) Filter based on monitoring type, do not fill in default, check all types MT_QCE=cloud product monitoring. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `common_namespaces` - General alarm strategy types (including: application performance monitoring, front-end performance monitoring, cloud dial testing). + * `dimensions` - Dimension Information. + * `can_filter_history` - Can it be used to filter alarm history. + * `can_filter_policy` - Can it be used to filter the policy list. + * `can_group_by` - Can it be used as an aggregation dimension. + * `is_multiple` - Do you support multiple selections. + * `is_mutable` - Can I modify it after creation. + * `is_required` - Required or not. + * `is_visible` - Whether to display to users. + * `key` - Dimension key identifier, backend English name. + * `must_group_by` - Must it be used as an aggregation dimension. + * `name` - Dimension key name, Chinese and English frontend display name. + * `operators` - List of supported operators. + * `id` - Operator identification. + * `name` - Operator Display Name. + * `show_value_replace` - Key to replace in front-end translation. + * `id` - Namespace labeling. + * `monitor_type` - Monitoring type. + * `name` - Namespace name. +* `custom_namespaces_new` - Other alarm strategy types are currently not supported. + * `available_regions` - List of supported regions. + * `config` - Configuration information. + * `dashboard_id` - Unique representation in dashboard. + * `id` - Namespace labeling. + * `name` - Namespace name. + * `product_name` - Product Name. + * `sort_id` - Sort Id. + * `value` - Namespace value. +* `qce_namespaces_new` - Types of alarm strategies for cloud products. + * `available_regions` - List of supported regions. + * `config` - Configuration information. + * `dashboard_id` - Unique representation in dashboard. + * `id` - Namespace labeling. + * `name` - Namespace name. + * `product_name` - Product Name. + * `sort_id` - Sort Id. + * `value` - Namespace value. + + diff --git a/config/docs/d/monitor_alarm_basic_alarms.html.markdown b/config/docs/d/monitor_alarm_basic_alarms.html.markdown new file mode 100644 index 0000000..cb4d902 --- /dev/null +++ b/config/docs/d/monitor_alarm_basic_alarms.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_basic_alarms" +sidebar_current: "docs-tencentcloud-datasource-monitor_alarm_basic_alarms" +description: |- + Use this data source to query detailed information of monitor basic_alarms +--- + +# tencentcloud_monitor_alarm_basic_alarms + +Use this data source to query detailed information of monitor basic_alarms + +## Example Usage + +```hcl +data "tencentcloud_monitor_alarm_basic_alarms" "alarms" { + module = "monitor" + start_time = 1696990903 + end_time = 1697098903 + occur_time_order = "DESC" + project_ids = [0] + view_names = ["cvm_device"] + alarm_status = [1] + instance_group_ids = [5497073] + metric_names = ["cpu_usage"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `module` - (Required, String) Interface module name, current value monitor. +* `alarm_status` - (Optional, Set: [`Int`]) Filter based on alarm status. +* `end_time` - (Optional, Int) End time, default to current timestamp. +* `instance_group_ids` - (Optional, Set: [`Int`]) Filter based on instance group ID. +* `metric_names` - (Optional, Set: [`String`]) Filter by indicator name. +* `obj_like` - (Optional, String) Filter based on alarm objects. +* `occur_time_order` - (Optional, String) Sort by occurrence time, taking ASC or DESC values. +* `project_ids` - (Optional, Set: [`Int`]) Filter based on project ID. +* `result_output_file` - (Optional, String) Used to save results. +* `start_time` - (Optional, Int) Start time, default to one day is timestamp. +* `view_names` - (Optional, Set: [`String`]) Filter based on policy type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `alarms` - Alarm List. + * `alarm_status` - Alarm status, ALARM indicates not recovered; OK indicates that it has been restored; NO_ DATA indicates insufficient data; NO_ CONF indicates that it has expired. + * `alarm_type` - Alarm type, 0 represents indicator alarm, 2 represents product event alarm, and 3 represents platform event alarm. + * `content` - Alarm content. + * `dimensions` - Alarm object dimension information. + * `duration` - Duration in seconds. + * `first_occur_time` - Time of occurrence. + * `group_id` - Policy Group ID. + * `group_name` - Policy Group Name. + * `id` - The ID of this alarm. + * `instance_group` - Instance Group Information. + * `instance_group_id` - Instance Group ID. + * `instance_group_name` - Instance Group Name. + * `last_occur_time` - End time. + * `metric_id` - Indicator ID. + * `metric_name` - Indicator Name. + * `notify_way` - Notification method. + * `obj_id` - Alarm object ID. + * `obj_name` - Alarm Object. + * `project_id` - Project ID. + * `project_name` - Entry name. + * `region` - Region. + * `status` - Alarm status ID, 0 indicates not recovered; 1 indicates that it has been restored; 2,3,5 indicates insufficient data; 4 indicates it has expired. + * `view_name` - Policy Type. + * `vpc` - VPC, only CVM has. +* `warning` - Remarks. + + diff --git a/config/docs/d/monitor_alarm_basic_metric.html.markdown b/config/docs/d/monitor_alarm_basic_metric.html.markdown new file mode 100644 index 0000000..e42dab2 --- /dev/null +++ b/config/docs/d/monitor_alarm_basic_metric.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_basic_metric" +sidebar_current: "docs-tencentcloud-datasource-monitor_alarm_basic_metric" +description: |- + Use this data source to query detailed information of monitor basic_metric +--- + +# tencentcloud_monitor_alarm_basic_metric + +Use this data source to query detailed information of monitor basic_metric + +## Example Usage + +```hcl +data "tencentcloud_monitor_alarm_basic_metric" "alarm_metric" { + namespace = "qce/cvm" + metric_name = "WanOuttraffic" + dimensions = ["uuid"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `namespace` - (Required, String) The business namespace is different for each cloud product. To obtain the business namespace, please go to the product monitoring indicator documents, such as the namespace of the cloud server, which can be found in [Cloud Server Monitoring Indicators](https://cloud.tencent.com/document/product/248/6843 ). +* `dimensions` - (Optional, Set: [`String`]) Optional parameters, filtered by dimension. +* `metric_name` - (Optional, String) Indicator names are different for each cloud product. To obtain indicator names, please go to the monitoring indicator documents of each product, such as the indicator names of cloud servers, which can be found in [Cloud Server Monitoring Indicators]( https://cloud.tencent.com/document/product/248/6843). +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `metric_set` - List of indicator descriptions obtained from query. + * `dimensions` - Dimension description information. + * `dimensions` - Dimension name array. + * `meaning` - Explanation of the meaning of statistical indicators. + * `en` - Explanation of indicators in English. + * `zh` - Chinese interpretation of indicators. + * `metric_c_name` - Indicator Chinese Name. + * `metric_e_name` - Indicator English name. + * `metric_name` - Indicator Name. + * `namespace` - Namespaces, each cloud product will have a namespace. + * `period` - The statistical period supported by the indicator, in seconds, such as 60, 300. + * `periods` - Indicator method within the statistical cycle. + * `period` - Cycle. + * `stat_type` - Statistical methods. + * `unit_cname` - Units used for indicators. + * `unit` - Units used for indicators. + + diff --git a/config/docs/d/monitor_alarm_conditions_template.html.markdown b/config/docs/d/monitor_alarm_conditions_template.html.markdown new file mode 100644 index 0000000..2541a1d --- /dev/null +++ b/config/docs/d/monitor_alarm_conditions_template.html.markdown @@ -0,0 +1,103 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_conditions_template" +sidebar_current: "docs-tencentcloud-datasource-monitor_alarm_conditions_template" +description: |- + Use this data source to query detailed information of monitor alarm_conditions_template +--- + +# tencentcloud_monitor_alarm_conditions_template + +Use this data source to query detailed information of monitor alarm_conditions_template + +## Example Usage + +```hcl +data "tencentcloud_monitor_alarm_conditions_template" "alarm_conditions_template" { + module = "monitor" + view_name = "cvm_device" + group_name = "keep-template" + group_id = "7803070" + update_time_order = "desc=descending" + policy_count_order = "asc=ascending" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `module` - (Required, String) Fixed value, as&amp;#39; monitor &amp;#39;. +* `group_id` - (Optional, String) Filter queries based on trigger condition template ID. +* `group_name` - (Optional, String) Filter queries based on trigger condition template names. +* `policy_count_order` - (Optional, String) Specify the sorting method based on the number of binding policies, asc=ascending, desc=descending. +* `result_output_file` - (Optional, String) Used to save results. +* `update_time_order` - (Optional, String) Specify the sorting method by update time, asc=ascending, desc=descending. +* `view_name` - (Optional, String) View name, composed of [DescribeAllNamespaces]( https://cloud.tencent.com/document/product/248/48683 )Obtain. For cloud product monitoring, retrieve the QceNamespacesNew. N.ID parameter from the interface, such as cvm_ Device. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `template_group_list` - Template List. + * `conditions` - Indicator alarm rules. + * `alarm_notify_period` - Alarm notification frequency. + * `alarm_notify_type` - Predefined repeated notification strategy (0- alarm only once, 1- exponential alarm, 2- connection alarm). + * `calc_type` - Detection method. + * `calc_value` - Detection value. + * `continue_time` - Duration in seconds. + * `is_advanced` - Whether it is an advanced indicator, 0: No; 1: Yes. + * `is_open` - Whether to activate advanced indicators, 0: No; 1: Yes. + * `metric_display_name` - Indicator display name (external). + * `metric_id` - Indicator ID. + * `period` - Cycle. + * `product_id` - Product ID. + * `rule_id` - Rule ID. + * `unit` - Indicator unit. + * `event_conditions` - Event alarm rules. + * `alarm_notify_period` - Alarm notification frequency. + * `alarm_notify_type` - Predefined repeated notification strategy (0- alarm only once, 1- exponential alarm, 2- connection alarm). + * `event_display_name` - Event Display Name (External). + * `event_id` - Event ID. + * `rule_id` - Rule ID. + * `group_id` - Template Policy Group ID. + * `group_name` - Template Policy Group Name. + * `insert_time` - Creation time. + * `is_union_rule` - Is it a relationship with. + * `last_edit_uin` - Last modified by UIN. + * `policy_groups` - Associate Alert Policy Group. + * `can_set_default` - Can it be set as the default alarm strategy. + * `enable` - Alarm Policy Enable Status. + * `group_id` - Alarm Policy Group ID. + * `group_name` - Alarm Policy Group Name. + * `insert_time` - Creation time. + * `is_default` - Is it the default alarm policy. + * `is_union_rule` - Is it a relationship rule with. + * `last_edit_uin` - Last modified by UIN. + * `no_shielded_instance_count` - Number of unshielded instances. + * `parent_group_id` - Parent Policy Group ID. + * `project_id` - Project ID. + * `receiver_infos` - Alarm receiving object information. + * `end_time` - Effective period end time. + * `need_send_notice` - Do you need to send a notification. + * `notify_way` - Alarm reception channel. + * `person_interval` - Telephone alarm to personal interval (seconds). + * `receiver_group_list` - Message receiving group list. + * `receiver_type` - Receiver type. + * `receiver_user_list` - Recipient list. List of recipient IDs queried through the platform interface. + * `recover_notify` - Alarm recovery notification method. + * `round_interval` - Telephone alarm interval per round (seconds). + * `round_number` - Number of phone alarm rounds. + * `send_for` - Timing of telephone alarm notification. Optional OCCUR (notification during alarm), RECOVER (notification during recovery). + * `start_time` - Effective period start time. + * `uid_list` - Telephone alarm receiver uid. + * `remark` - Remarks. + * `total_instance_count` - Total number of bound instances. + * `update_time` - Modification time. + * `view_name` - View. + * `remark` - Remarks. + * `update_time` - Update time. + * `view_name` - View. + + diff --git a/config/docs/d/monitor_alarm_history.html.markdown b/config/docs/d/monitor_alarm_history.html.markdown new file mode 100644 index 0000000..770eb95 --- /dev/null +++ b/config/docs/d/monitor_alarm_history.html.markdown @@ -0,0 +1,100 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_history" +sidebar_current: "docs-tencentcloud-datasource-monitor_alarm_history" +description: |- + Use this data source to query detailed information of monitor alarm_history +--- + +# tencentcloud_monitor_alarm_history + +Use this data source to query detailed information of monitor alarm_history + +## Example Usage + +```hcl +data "tencentcloud_monitor_alarm_history" "alarm_history" { + module = "monitor" + order = "DESC" + start_time = 1696608000 + end_time = 1697212799 + monitor_types = ["MT_QCE"] + project_ids = [0] + namespaces { + monitor_type = "CpuUsage" + namespace = "cvm_device" + } + policy_name = "terraform_test" + content = "CPU利用率 > 3%" + policy_ids = ["policy-iejtp4ue"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `module` - (Required, String) Value fixed at monitor. +* `alarm_levels` - (Optional, Set: [`String`]) Alarm levels. +* `alarm_object` - (Optional, String) Filter by alarm object. Fuzzy search with string is supported. +* `alarm_status` - (Optional, Set: [`String`]) Filter by alarm status. Valid values: ALARM (not resolved), OK (resolved), NO_CONF (expired), NO_DATA (insufficient data). If this parameter is left empty, all will be queried by default. +* `content` - (Optional, String) Fuzzy search by alarm content. +* `end_time` - (Optional, Int) End time, which is the current timestamp and the time when the alarm FirstOccurTime first occurs. An alarm record can be searched only if its FirstOccurTime is earlier than the EndTime. +* `instance_group_ids` - (Optional, Set: [`Int`]) Filter by instance group ID. +* `metric_names` - (Optional, Set: [`String`]) Filter by metric name. +* `monitor_types` - (Optional, Set: [`String`]) Filter by monitor type. Valid values: MT_QCE (Tencent Cloud service monitoring), MT_TAW (application performance monitoring), MT_RUM (frontend performance monitoring), MT_PROBE (cloud automated testing). If this parameter is left empty, all types will be queried by default. +* `namespaces` - (Optional, List) Filter by policy type. Monitoring type and policy type are first-level and second-level filters respectively and both need to be passed in. For example, [{MonitorType: MT_QCE, Namespace: cvm_device}]. +* `order` - (Optional, String) Sort by the first occurrence time in descending order by default. Valid values: ASC (ascending), DESC (descending). +* `policy_ids` - (Optional, Set: [`String`]) Search by alarm policy ID list. +* `policy_name` - (Optional, String) Fuzzy search by policy name. +* `project_ids` - (Optional, Set: [`Int`]) Filter by project ID. Valid values: -1 (no project), 0 (default project). +* `receiver_groups` - (Optional, Set: [`Int`]) Search by recipient group. +* `receiver_uids` - (Optional, Set: [`Int`]) Search by recipient. +* `result_output_file` - (Optional, String) Used to save results. +* `start_time` - (Optional, Int) Start time, which is the timestamp one day ago by default and the time when the alarm FirstOccurTime first occurs. An alarm record can be searched only if its FirstOccurTime is later than the StartTime. + +The `namespaces` object supports the following: + +* `monitor_type` - (Required, String) Monitor type. +* `namespace` - (Required, String) Policy type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `histories` - Alarm record list. + * `alarm_id` - Alarm record ID. + * `alarm_level` - Alarm level.Note: this field may return null, indicating that no valid values can be obtained. + * `alarm_object` - Alarm object. + * `alarm_status` - Alarm status. Valid values: ALARM (not resolved), OK (resolved), NO_CONF (expired), NO_DATA (insufficient data). + * `alarm_type` - Alarm type. + * `content` - Alarm content. + * `dimensions` - Dimension information of an instance that triggered alarms.Note: this field may return null, indicating that no valid values can be obtained. + * `event_id` - Event ID. + * `first_occur_time` - Timestamp of the first occurrence. + * `instance_group` - Instance group of alarm object. + * `id` - Instance group ID. + * `name` - Instance group name. + * `last_occur_time` - Timestamp of the last occurrence. + * `metrics_info` - Metric informationNote: this field may return null, indicating that no valid values can be obtained. + * `description` - Metric display name. + * `metric_name` - Metric name. + * `period` - Statistical period. + * `qce_namespace` - Namespace used to query data by Tencent Cloud service monitoring type. + * `value` - Value triggering alarm. + * `monitor_type` - Monitor type. + * `namespace` - Policy type. + * `notice_ways` - Alarm channel list. Valid values: SMS (SMS), EMAIL (email), CALL (phone), WECHAT (WeChat). + * `origin_id` - Alarm policy ID, which can be used when you call APIs (BindingPolicyObject, UnBindingAllPolicyObject, UnBindingPolicyObject) to bind/unbind instances or instance groups to/from an alarm policy. + * `policy_exists` - Whether the policy exists. Valid values: 0 (no), 1 (yes). + * `policy_id` - Alarm policy ID. + * `policy_name` - Policy name. + * `project_id` - Project ID. + * `project_name` - Project name. + * `receiver_groups` - Recipient group list. + * `receiver_uids` - Recipient list. + * `region` - Region. + * `vpc` - VPC of alarm object for basic product alarm. + + diff --git a/config/docs/d/monitor_alarm_metric.html.markdown b/config/docs/d/monitor_alarm_metric.html.markdown new file mode 100644 index 0000000..9ec773a --- /dev/null +++ b/config/docs/d/monitor_alarm_metric.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_metric" +sidebar_current: "docs-tencentcloud-datasource-monitor_alarm_metric" +description: |- + Use this data source to query detailed information of monitor alarm_metric +--- + +# tencentcloud_monitor_alarm_metric + +Use this data source to query detailed information of monitor alarm_metric + +## Example Usage + +```hcl +data "tencentcloud_monitor_alarm_metric" "alarm_metric" { + module = "monitor" + monitor_type = "Monitoring" + namespace = "cvm_device" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `module` - (Required, String) Fixed value, as `monitor`. +* `monitor_type` - (Required, String) Monitoring Type Filter MT_QCE=Cloud Product Monitoring. +* `namespace` - (Required, String) Alarm policy type, obtained from DescribeAllNamespaces, such as cvm_device. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `metrics` - Alarm indicator list. + * `description` - Indicator display name. + * `dimensions` - Dimension List. + * `is_advanced` - Is it a high-level indicator. 1 Yes 0 No. + * `is_open` - Is the advanced indicator activated. 1 Yes 0 No. + * `max` - Maximum value. + * `metric_config` - Indicator configuration. + * `continue_period` - Number of allowed duration cycles for configuration. + * `operator` - Allowed Operators. + * `period` - The data period allowed for configuration, in seconds. + * `metric_name` - Indicator Name. + * `min` - Minimum value. + * `namespace` - Alarm strategy type. + * `operators` - Matching operator. + * `id` - Operator identification. + * `name` - Operator Display Name. + * `periods` - Indicator trigger. + * `product_id` - Integration Center Product ID. + * `unit` - Unit. + + diff --git a/config/docs/d/monitor_alarm_monitor_type.html.markdown b/config/docs/d/monitor_alarm_monitor_type.html.markdown new file mode 100644 index 0000000..7c40b31 --- /dev/null +++ b/config/docs/d/monitor_alarm_monitor_type.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_monitor_type" +sidebar_current: "docs-tencentcloud-datasource-monitor_alarm_monitor_type" +description: |- + Use this data source to query detailed information of monitor alarm_monitor_type +--- + +# tencentcloud_monitor_alarm_monitor_type + +Use this data source to query detailed information of monitor alarm_monitor_type + +## Example Usage + +```hcl +data "tencentcloud_monitor_alarm_monitor_type" "alarm_monitor_type" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `monitor_type_infos` - Monitoring type details. + * `id` - Monitoring type ID. + * `name` - Monitoring type. + * `sort_id` - Sort order. +* `monitor_types` - Monitoring type, cloud product monitoring is MT_ QCE. + + diff --git a/config/docs/d/monitor_alarm_notice_callbacks.html.markdown b/config/docs/d/monitor_alarm_notice_callbacks.html.markdown new file mode 100644 index 0000000..c8e8cc4 --- /dev/null +++ b/config/docs/d/monitor_alarm_notice_callbacks.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_notice_callbacks" +sidebar_current: "docs-tencentcloud-datasource-monitor_alarm_notice_callbacks" +description: |- + Use this data source to query detailed information of monitor alarm_notice_callbacks +--- + +# tencentcloud_monitor_alarm_notice_callbacks + +Use this data source to query detailed information of monitor alarm_notice_callbacks + +## Example Usage + +```hcl +data "tencentcloud_monitor_alarm_notice_callbacks" "alarm_notice_callbacks" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `url_notices` - Alarm callback notification. + * `end_time` - The number of seconds from the end of the notification day. + * `is_valid` - Verified 0=No 1=Yes. + * `start_time` - The number of seconds starting from the day of notification start time. + * `url` - Callback URL (limited to 256 characters). + * `validation_code` - Verification code. + * `weekday` - Notification period 1-7 represents Monday to Sunday. + + diff --git a/config/docs/d/monitor_alarm_notices.html.markdown b/config/docs/d/monitor_alarm_notices.html.markdown new file mode 100644 index 0000000..70fa9d2 --- /dev/null +++ b/config/docs/d/monitor_alarm_notices.html.markdown @@ -0,0 +1,80 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_notices" +sidebar_current: "docs-tencentcloud-datasource-monitor_alarm_notices" +description: |- + Use this data source to Interlude notification list. +--- + +# tencentcloud_monitor_alarm_notices + +Use this data source to Interlude notification list. + +## Example Usage + +```hcl +data "tencentcloud_monitor_alarm_notices" "notices" { + order = "DESC" + owner_uid = 1 + name = "" + receiver_type = "" + user_ids = [] + group_ids = [] + notice_ids = [] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_ids` - (Optional, Set: [`Int`]) Receive group list. +* `name` - (Optional, String) Alarm notification template name Used for fuzzy search. +* `notice_ids` - (Optional, Set: [`String`]) Receive group list. +* `order` - (Optional, String) Sort by update time ASC=forward order DESC=reverse order. +* `owner_uid` - (Optional, Int) The primary account uid is used to create a preset notification. +* `receiver_type` - (Optional, String) To filter alarm notification templates according to recipients, you need to select the notification user type. USER=user GROUP=user group Leave blank = not filter by recipient. +* `result_output_file` - (Optional, String) Used to store results. +* `user_ids` - (Optional, Set: [`Int`]) List of recipients. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `alarm_notice` - Alarm notification template list. + * `amp_consumer_id` - AMP consumer ID. + * `cls_notices` - A maximum of one alarm notification can be pushed to the CLS service. + * `enable` - Start-stop status, can not be transmitted, default enabled. 0= Disabled, 1= enabled. + * `log_set_id` - Log collection Id. + * `region` - Regional. + * `topic_id` - Theme Id. + * `id` - Alarm notification template ID. + * `is_preset` - Whether it is the system default notification template 0=No 1=Yes. + * `name` - Alarm notification template name. + * `notice_language` - Notification language zh-CN=Chinese en-US=English. + * `notice_type` - Alarm notification type ALARM=Notification not restored OK=Notification restored ALL. + * `policy_ids` - List of alarm policy IDs bound to the alarm notification template. + * `updated_at` - Last modified time. + * `updated_by` - Last Modified By. + * `url_notices` - The maximum number of callback notifications is 3. + * `end_time` - Notification End Time Seconds at the start of a day. + * `start_time` - Notification Start Time Number of seconds at the start of a day. + * `url` - Callback URL (limited to 256 characters). + * `weekday` - Notification period 1-7 indicates Monday to Sunday. + * `user_notices` - Alarm notification template list.(At most five). + * `end_time` - The number of seconds since the notification end time 00:00:00 (value range 0-86399). + * `group_ids` - User group ID list. + * `need_phone_arrive_notice` - Contact notification required 0= No 1= Yes. + * `notice_way` - Notification Channel List EMAIL=Mail SMS=SMS CALL=Telephone WECHAT=WeChat RTX=Enterprise WeChat. + * `phone_call_type` - Call type SYNC= Simultaneous call CIRCLE= Round call If this parameter is not specified, the default value is round call. + * `phone_circle_interval` - Number of seconds between polls (value range: 60-900). + * `phone_circle_times` - Number of telephone polls (value range: 1-5). + * `phone_inner_interval` - Number of seconds between calls in a polling session (value range: 60-900). + * `phone_order` - Telephone polling list. + * `receiver_type` - Recipient Type USER=User GROUP=User Group. + * `start_time` - The number of seconds since the notification start time 00:00:00 (value range 0-86399). + * `user_ids` - User UID List. + * `weekday` - Notification period 1-7 indicates Monday to Sunday. + + diff --git a/config/docs/d/monitor_alarm_policy.html.markdown b/config/docs/d/monitor_alarm_policy.html.markdown new file mode 100644 index 0000000..cfab3e8 --- /dev/null +++ b/config/docs/d/monitor_alarm_policy.html.markdown @@ -0,0 +1,253 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_policy" +sidebar_current: "docs-tencentcloud-datasource-monitor_alarm_policy" +description: |- + Use this data source to query detailed information of monitor alarm_policy +--- + +# tencentcloud_monitor_alarm_policy + +Use this data source to query detailed information of monitor alarm_policy + +## Example Usage + +```hcl +data "tencentcloud_monitor_alarm_policy" "alarm_policy" { + module = "monitor" + policy_name = "terraform" + monitor_types = ["MT_QCE"] + namespaces = ["cvm_device"] + project_ids = [0] + notice_ids = ["notice-f2svbu3w"] + rule_types = ["STATIC"] + enable = [1] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `module` - (Required, String) Value fixed at monitor. +* `dimensions` - (Optional, String) The alarm object list, which is a JSON string. The outer array corresponds to multiple instances, and the inner array is the dimension of an object.For example, 'CVM - Basic Monitor' can be written as: [ {Dimensions: {unInstanceId: ins-qr8d555g}}, {Dimensions: {unInstanceId: ins-qr8d555h}} ]You can also refer to the 'Example 2' below.For more information on the parameter samples of different Tencent Cloud services, see [Product Policy Type and Dimension Information](https://www.tencentcloud.com/document/product/248/39565?has_map=1).Note: If 1 is passed in for NeedCorrespondence, the relationship between a policy and an instance needs to be returned. You can pass in up to 20 alarm object dimensions to avoid request timeout. +* `enable` - (Optional, Set: [`Int`]) Filter by alarm status. Valid values: [1]: enabled; [0]: disabled; [0, 1]: all. +* `field` - (Optional, String) Sort by field. For example, to sort by the last modification time, use Field: UpdateTime. +* `instance_group_id` - (Optional, Int) Instance group ID. +* `monitor_types` - (Optional, Set: [`String`]) Filter by monitor type. Valid values: MT_QCE (Tencent Cloud service monitoring). If this parameter is left empty, all will be queried by default. +* `namespaces` - (Optional, Set: [`String`]) Filter by namespace. For the values of different policy types, please see:[Poicy Type List](https://www.tencentcloud.com/document/product/248/39565?has_map=1). +* `need_correspondence` - (Optional, Int) Whether the relationship between a policy and the input parameter filter dimension is required. 1: Yes. 0: No. Default value: 0. +* `not_bind_all` - (Optional, Int) Whether the returned result needs to filter policies associated with all objects. Valid values: 1 (Yes), 0 (No). +* `not_binding_notice_rule` - (Optional, Int) If 1 is passed in, alarm policies with no notification rules configured are queried. If it is left empty or other values are passed in, all alarm policies are queried. +* `not_instance_group` - (Optional, Int) Whether the returned result needs to filter policies associated with instance groups. Valid values: 1 (Yes), 0 (No). +* `notice_ids` - (Optional, Set: [`String`]) List of the notification template IDs, which can be obtained by querying the notification template list.It can be queried with the API [DescribeAlarmNotices](https://www.tencentcloud.com/document/product/248/39300). +* `one_click_policy_type` - (Optional, Set: [`String`]) Filter by quick alarm policy. If this parameter is left empty, all policies are displayed. ONECLICK: Display quick alarm policies; NOT_ONECLICK: Display non-quick alarm policies. +* `order` - (Optional, String) Sort order. Valid values: ASC (ascending), DESC (descending). +* `policy_name` - (Optional, String) Fuzzy search by policy name. +* `policy_type` - (Optional, Set: [`String`]) Filter by default policy. Valid values: DEFAULT (display default policy), NOT_DEFAULT (display non-default policies). If this parameter is left empty, all policies will be displayed. +* `project_ids` - (Optional, Set: [`Int`]) ID array of the policy project, which can be viewed on the following page: [Project Management](https://console.tencentcloud.com/project). +* `prom_ins_id` - (Optional, String) ID of the TencentCloud Managed Service for Prometheus instance, which is used for customizing a metric policy. +* `receiver_groups` - (Optional, Set: [`Int`]) Search by recipient group. You can get the user group list with the API [ListGroups](https://www.tencentcloud.com/document/product/598/34589?from_cn_redirect=1) in 'Cloud Access Management' or query the user group list where a sub-user is in with the API [ListGroupsForUser](https://www.tencentcloud.com/document/product/598/34588?from_cn_redirect=1). The GroupId field in the returned result should be entered here. +* `receiver_on_call_form_ids` - (Optional, Set: [`String`]) Search by schedule. +* `receiver_uids` - (Optional, Set: [`Int`]) Search by recipient. You can get the user list with the API [ListUsers](https://www.tencentcloud.com/document/product/598/34587?from_cn_redirect=1) in 'Cloud Access Management' or query the sub-user information with the API [GetUser](https://www.tencentcloud.com/document/product/598/34590?from_cn_redirect=1). The Uid field in the returned result should be entered here. +* `result_output_file` - (Optional, String) Used to save results. +* `rule_types` - (Optional, Set: [`String`]) Filter by trigger condition. Valid values: STATIC (display policies with static threshold), DYNAMIC (display policies with dynamic threshold). If this parameter is left empty, all policies will be displayed. +* `trigger_tasks` - (Optional, List) Filter alarm policy by triggered task (such as auto scaling task). Up to 10 tasks can be specified. + +The `trigger_tasks` object supports the following: + +* `task_config` - (Required, String) Configuration information in JSON format, such as {Key1:Value1,Key2:Value2}Note: this field may return null, indicating that no valid values can be obtained. +* `type` - (Required, String) Triggered task type. Valid value: AS (auto scaling)Note: this field may return null, indicating that no valid values can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `policies` - Policy array. + * `advanced_metric_number` - The number of advanced metrics.Note: This field may return null, indicating that no valid values can be obtained. + * `can_set_default` - Whether the default policy can be set. Valid values: 1 (yes), 0 (no)Note: this field may return null, indicating that no valid values can be obtained. + * `condition_template_id` - Trigger condition template IDNote: this field may return null, indicating that no valid values can be obtained. + * `condition` - Metric trigger conditionNote: this field may return null, indicating that no valid values can be obtained. + * `complex_expression` - The judgment expression of composite alarm trigger conditions, which is valid when the value of IsUnionRule is 2. This parameter is used to determine that an alarm condition is met only when the expression values are True for multiple trigger conditionsNote: This field may return null, indicating that no valid values can be obtained. + * `is_union_rule` - Judgment condition of an alarm trigger condition (0: Any; 1: All; 2: Composite). When the value is set to 2 (i.e., composite trigger conditions), this parameter should be used together with ComplexExpression.Note: This field may return null, indicating that no valid values can be obtained. + * `rules` - Alarm trigger condition listNote: this field may return null, indicating that no valid values can be obtained. + * `continue_period` - Number of periods. 1: continue for one period; 2: continue for two periods; and so on. The valid values can be queried via [DescribeAlarmMetrics](https://www.tencentcloud.com/document/product/248/39322)Note: this field may return null, indicating that no valid value is obtained. + * `description` - Metric display name, which is used in the output parameteNote: this field may return null, indicating that no valid values can be obtained. + * `filter` - Filter condition for one single trigger rulNote: this field may return null, indicating that no valid values can be obtained. + * `dimensions` - JSON string generated by serializing the AlarmPolicyDimension two-dimensional array. The one-dimensional arrays are in OR relationship, and the elements in a one-dimensional array are in AND relationshiNote: this field may return null, indicating that no valid values can be obtained. + * `type` - Filter condition type. Valid values: DIMENSION (uses dimensions for filteringNote: this field may return null, indicating that no valid values can be obtained. + * `hierarchical_value` - The configuration of alarm level thresholNote: This field may return null, indicating that no valid values can be obtained. + * `remind` - Threshold for the Remind leveNote: This field may return null, indicating that no valid values can be obtained. + * `serious` - Threshold for the Serious leveNote: This field may return null, indicating that no valid values can be obtained. + * `warn` - Threshold for the Warn leveNote: This field may return null, indicating that no valid values can be obtained. + * `is_advanced` - Whether it is an advanced metric. 0: No; 1: YesNote: This field may return null, indicating that no valid values can be obtained. + * `is_open` - Whether the advanced metric feature is enabled. 0: No; 1: YesNote: This field may return null, indicating that no valid values can be obtained. + * `is_power_notice` - Whether the alarm frequency increases exponentially. Valid values: 0 (no), 1 (yesNote: this field may return null, indicating that no valid values can be obtained. + * `metric_name` - Metric name or event name. The supported metrics can be queried via [DescribeAlarmMetrics](https://www.tencentcloud.com/document/product/248/39322) and the supported events via [DescribeAlarmEvents](https://www.tencentcloud.com/document/product/248/39324).Note: this field may return null, indicating that no valid value is obtained. + * `notice_frequency` - Alarm interval in seconds. Valid values: 0 (do not repeat), 300 (alarm once every 5 minutes), 600 (alarm once every 10 minutes), 900 (alarm once every 15 minutes), 1800 (alarm once every 30 minutes), 3600 (alarm once every hour), 7200 (alarm once every 2 hours), 10800 (alarm once every 3 hours), 21600 (alarm once every 6 hours), 43200 (alarm once every 12 hours), 86400 (alarm once every dayNote: this field may return null, indicating that no valid values can be obtained. + * `operator` - Operatorintelligent = intelligent detection without thresholdeq = equal toge = greater than or equal togt = greater thanle = less than or equal tolt = less thanne = not equal today_increase = day-on-day increaseday_decrease = day-on-day decreaseday_wave = day-on-day fluctuationweek_increase = week-on-week increaseweek_decrease = week-on-week decreaseweek_wave = week-on-week fluctuationcycle_increase = cyclical increasecycle_decrease = cyclical decreasecycle_wave = cyclical fluctuationre = regex matchThe valid values can be queried via [DescribeAlarmMetrics](https://www.tencentcloud.com/document/product/248/39322)Note: this field may return null, indicating that no valid value is obtained. + * `period` - Statistical period in seconds. The valid values can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `product_id` - Integration center product IDNote: This field may return null, indicating that no valid values can be obtained. + * `rule_type` - Trigger condition type. STATIC: static threshold; dynamic: dynamic threshold. If you do not specify this parameter when creating or editing a policy, STATIC is used by defaultNote: this field may return null, indicating that no valid value is obtained. + * `unit` - Unit, which is used in the output parameteNote: this field may return null, indicating that no valid values can be obtained. + * `value_max` - Maximum valuNote: This field may return null, indicating that no valid values can be obtained. + * `value_min` - Minimum valuNote: This field may return null, indicating that no valid values can be obtained. + * `value` - Threshold. The valid value range can be queried via [DescribeAlarmMetrics](https://www.tencentcloud.com/document/product/248/39322)Note: this field may return null, indicating that no valid value is obtained. + * `conditions_temp` - Template policy groupNote: this field may return null, indicating that no valid values can be obtained. + * `condition` - Metric trigger conditionNote: this field may return null, indicating that no valid values can be obtained. + * `complex_expression` - The judgment expression of composite alarm trigger conditions, which is valid when the value of IsUnionRule is 2. This parameter is used to determine that an alarm condition is met only when the expression values are True for multiple trigger conditions.Note: This field may return null, indicating that no valid values can be obtained. + * `is_union_rule` - Judgment condition of an alarm trigger condition (0: Any; 1: All; 2: Composite). When the value is set to 2 (i.e., composite trigger conditions), this parameter should be used together with ComplexExpression.Note: This field may return null, indicating that no valid values can be obtained. + * `rules` - Alarm trigger condition listNote: this field may return null, indicating that no valid values can be obtained. + * `continue_period` - Number of periods. 1: continue for one period; 2: continue for two periods; and so on. The valid values can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `description` - Metric display name, which is used in the output parameterNote: this field may return null, indicating that no valid values can be obtained. + * `filter` - Filter condition for one single trigger ruleNote: this field may return null, indicating that no valid values can be obtained. + * `dimensions` - JSON string generated by serializing the AlarmPolicyDimension two-dimensional array. The one-dimensional arrays are in OR relationship, and the elements in a one-dimensional array are in AND relationshipNote: this field may return null, indicating that no valid values can be obtained. + * `type` - Filter condition type. Valid values: DIMENSION (uses dimensions for filtering)Note: this field may return null, indicating that no valid values can be obtained. + * `hierarchical_value` - The configuration of alarm level thresholdNote: This field may return null, indicating that no valid values can be obtained. + * `remind` - Threshold for the Remind levelNote: This field may return null, indicating that no valid values can be obtained. + * `serious` - Threshold for the Serious levelNote: This field may return null, indicating that no valid values can be obtained. + * `warn` - Threshold for the Warn levelNote: This field may return null, indicating that no valid values can be obtained. + * `is_advanced` - Whether it is an advanced metric. 0: No; 1: Yes.Note: This field may return null, indicating that no valid values can be obtained. + * `is_open` - Whether the advanced metric feature is enabled. 0: No; 1: Yes.Note: This field may return null, indicating that no valid values can be obtained. + * `is_power_notice` - Whether the alarm frequency increases exponentially. Valid values: 0 (no), 1 (yes)Note: this field may return null, indicating that no valid values can be obtained. + * `metric_name` - Metric name or event name. The supported metrics can be queried via DescribeAlarmMetrics and the supported events via DescribeAlarmEvents.Note: this field may return null, indicating that no valid value is obtained. + * `notice_frequency` - Alarm interval in seconds. Valid values: 0 (do not repeat), 300 (alarm once every 5 minutes), 600 (alarm once every 10 minutes), 900 (alarm once every 15 minutes), 1800 (alarm once every 30 minutes), 3600 (alarm once every hour), 7200 (alarm once every 2 hours), 10800 (alarm once every 3 hours), 21600 (alarm once every 6 hours), 43200 (alarm once every 12 hours), 86400 (alarm once every day)Note: this field may return null, indicating that no valid values can be obtained. + * `operator` - Operatorintelligent = intelligent detection without thresholdeq = equal toge = greater than or equal togt = greater thanle = less than or equal tolt = less thanne = not equal today_increase = day-on-day increaseday_decrease = day-on-day decreaseday_wave = day-on-day fluctuationweek_increase = week-on-week increaseweek_decrease = week-on-week decreaseweek_wave = week-on-week fluctuationcycle_increase = cyclical increasecycle_decrease = cyclical decreasecycle_wave = cyclical fluctuationre = regex matchThe valid values can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `period` - Statistical period in seconds. The valid values can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `product_id` - Integration center product ID.Note: This field may return null, indicating that no valid values can be obtained. + * `rule_type` - Trigger condition type. STATIC: static threshold; dynamic: dynamic threshold. If you do not specify this parameter when creating or editing a policy, STATIC is used by default.Note: this field may return null, indicating that no valid value is obtained. + * `unit` - Unit, which is used in the output parameterNote: this field may return null, indicating that no valid values can be obtained. + * `value_max` - Maximum valueNote: This field may return null, indicating that no valid values can be obtained. + * `value_min` - Minimum valueNote: This field may return null, indicating that no valid values can be obtained. + * `value` - Threshold. The valid value range can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `event_condition` - Event trigger conditionNote: this field may return null, indicating that no valid values can be obtained. + * `rules` - Alarm trigger condition listNote: this field may return null, indicating that no valid values can be obtained. + * `continue_period` - Number of periods. 1: continue for one period; 2: continue for two periods; and so on. The valid values can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `description` - Metric display name, which is used in the output parameterNote: this field may return null, indicating that no valid values can be obtained. + * `filter` - Filter condition for one single trigger ruleNote: this field may return null, indicating that no valid values can be obtained. + * `dimensions` - JSON string generated by serializing the AlarmPolicyDimension two-dimensional array. The one-dimensional arrays are in OR relationship, and the elements in a one-dimensional array are in AND relationshipNote: this field may return null, indicating that no valid values can be obtained. + * `type` - Filter condition type. Valid values: DIMENSION (uses dimensions for filtering)Note: this field may return null, indicating that no valid values can be obtained. + * `hierarchical_value` - The configuration of alarm level thresholdNote: This field may return null, indicating that no valid values can be obtained. + * `remind` - Threshold for the Remind levelNote: This field may return null, indicating that no valid values can be obtained. + * `serious` - Threshold for the Serious levelNote: This field may return null, indicating that no valid values can be obtained. + * `warn` - Threshold for the Warn levelNote: This field may return null, indicating that no valid values can be obtained. + * `is_advanced` - Whether it is an advanced metric. 0: No; 1: Yes.Note: This field may return null, indicating that no valid values can be obtained. + * `is_open` - Whether the advanced metric feature is enabled. 0: No; 1: Yes.Note: This field may return null, indicating that no valid values can be obtained. + * `is_power_notice` - Whether the alarm frequency increases exponentially. Valid values: 0 (no), 1 (yes)Note: this field may return null, indicating that no valid values can be obtained. + * `metric_name` - Metric name or event name. The supported metrics can be queried via DescribeAlarmMetrics and the supported events via DescribeAlarmEvents.Note: this field may return null, indicating that no valid value is obtained. + * `notice_frequency` - Alarm interval in seconds. Valid values: 0 (do not repeat), 300 (alarm once every 5 minutes), 600 (alarm once every 10 minutes), 900 (alarm once every 15 minutes), 1800 (alarm once every 30 minutes), 3600 (alarm once every hour), 7200 (alarm once every 2 hours), 10800 (alarm once every 3 hours), 21600 (alarm once every 6 hours), 43200 (alarm once every 12 hours), 86400 (alarm once every day)Note: this field may return null, indicating that no valid values can be obtained. + * `operator` - Operatorintelligent = intelligent detection without thresholdeq = equal toge = greater than or equal togt = greater thanle = less than or equal tolt = less thanne = not equal today_increase = day-on-day increaseday_decrease = day-on-day decreaseday_wave = day-on-day fluctuationweek_increase = week-on-week increaseweek_decrease = week-on-week decreaseweek_wave = week-on-week fluctuationcycle_increase = cyclical increasecycle_decrease = cyclical decreasecycle_wave = cyclical fluctuationre = regex matchThe valid values can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `period` - Statistical period in seconds. The valid values can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `product_id` - Integration center product ID.Note: This field may return null, indicating that no valid values can be obtained. + * `rule_type` - Trigger condition type. STATIC: static threshold; dynamic: dynamic threshold. If you do not specify this parameter when creating or editing a policy, STATIC is used by default.Note: this field may return null, indicating that no valid value is obtained. + * `unit` - Unit, which is used in the output parameterNote: this field may return null, indicating that no valid values can be obtained. + * `value_max` - Maximum valueNote: This field may return null, indicating that no valid values can be obtained. + * `value_min` - Minimum valueNote: This field may return null, indicating that no valid values can be obtained. + * `value` - Threshold. The valid value range can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `template_name` - Template nameNote: u200dThis field may return null, indicating that no valid values can be obtained. + * `enable` - Status. Valid values: 0 (disabled), 1 (enabled)Note: this field may return null, indicating that no valid values can be obtained. + * `event_condition` - Event trigger conditioNote: this field may return null, indicating that no valid values can be obtained. + * `rules` - Alarm trigger condition lisNote: this field may return null, indicating that no valid values can be obtained. + * `continue_period` - Number of periods. 1: continue for one period; 2: continue for two periods; and so on. The valid values can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `description` - Metric display name, which is used in the output parameterNote: this field may return null, indicating that no valid values can be obtained. + * `filter` - Filter condition for one single trigger ruleNote: this field may return null, indicating that no valid values can be obtained. + * `dimensions` - JSON string generated by serializing the AlarmPolicyDimension two-dimensional array. The one-dimensional arrays are in OR relationship, and the elements in a one-dimensional array are in AND relationshipNote: this field may return null, indicating that no valid values can be obtained. + * `type` - Filter condition type. Valid values: DIMENSION (uses dimensions for filtering)Note: this field may return null, indicating that no valid values can be obtained. + * `hierarchical_value` - The configuration of alarm level thresholdNote: This field may return null, indicating that no valid values can be obtained. + * `remind` - Threshold for the Remind levelNote: This field may return null, indicating that no valid values can be obtained. + * `serious` - Threshold for the Serious levelNote: This field may return null, indicating that no valid values can be obtained. + * `warn` - Threshold for the Warn levelNote: This field may return null, indicating that no valid values can be obtained. + * `is_advanced` - Whether it is an advanced metric. 0: No; 1: Yes.Note: This field may return null, indicating that no valid values can be obtained. + * `is_open` - Whether the advanced metric feature is enabled. 0: No; 1: Yes.Note: This field may return null, indicating that no valid values can be obtained. + * `is_power_notice` - Whether the alarm frequency increases exponentially. Valid values: 0 (no), 1 (yes)Note: this field may return null, indicating that no valid values can be obtained. + * `metric_name` - Metric name or event name. The supported metrics can be queried via DescribeAlarmMetrics and the supported events via DescribeAlarmEventsNote: this field may return null, indicating that no valid value is obtained. + * `notice_frequency` - Alarm interval in seconds. Valid values: 0 (do not repeat), 300 (alarm once every 5 minutes), 600 (alarm once every 10 minutes), 900 (alarm once every 15 minutes), 1800 (alarm once every 30 minutes), 3600 (alarm once every hour), 7200 (alarm once every 2 hours), 10800 (alarm once every 3 hours), 21600 (alarm once every 6 hours), 43200 (alarm once every 12 hours), 86400 (alarm once every day)Note: this field may return null, indicating that no valid values can be obtained. + * `operator` - Statistical period in seconds. The valid values can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained.Operator String No Operatorintelligent = intelligent detection without thresholdeq = equal toge = greater than or equal togt = greater thanle = less than or equal tolt = less thanne = not equal today_increase = day-on-day increaseday_decrease = day-on-day decreaseday_wave = day-on-day fluctuationweek_increase = week-on-week increaseweek_decrease = week-on-week decreaseweek_wave = week-on-week fluctuationcycle_increase = cyclical increasecycle_decrease = cyclical decreasecycle_wave = cyclical fluctuationre = regex matchThe valid values can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `period` - Statistical period in seconds. The valid values can be queried via DescribeAlarmMetricsNote: this field may return null, indicating that no valid value is obtained. + * `product_id` - Integration center product ID.Note: This field may return null, indicating that no valid values can be obtained. + * `rule_type` - Trigger condition type. STATIC: static threshold; dynamic: dynamic threshold. If you do not specify this parameter when creating or editing a policy, STATIC is used by default.Note: this field may return null, indicating that no valid value is obtained. + * `unit` - Unit, which is used in the output parameterNote: this field may return null, indicating that no valid values can be obtained. + * `value_max` - Maximum valueNote: This field may return null, indicating that no valid values can be obtained. + * `value_min` - Minimum valueNote: This field may return null, indicating that no valid values can be obtained. + * `value` - Threshold. The valid value range can be queried via DescribeAlarmMetrics.Note: this field may return null, indicating that no valid value is obtained. + * `filter_dimensions_param` - Information on the filter dimension associated with a policy.Note: This field may return null, indicating that no valid values can be obtained. + * `insert_time` - Creation timeNote: this field may return null, indicating that no valid values can be obtained. + * `instance_group_id` - Instance group IDNote: this field may return null, indicating that no valid values can be obtained. + * `instance_group_name` - Instance group nameNote: this field may return null, indicating that no valid values can be obtained. + * `instance_sum` - Total number of instances in instance groupNote: this field may return null, indicating that no valid values can be obtained. + * `is_bind_all` - Whether the policy is associated with all objectsNote: This field may return null, indicating that no valid values can be obtained. + * `is_default` - Whether it is the default policy. Valid values: 1 (yes), 0 (no)Note: this field may return null, indicating that no valid values can be obtained. + * `is_one_click` - Whether it is a quick alarm policy.Note: This field may return null, indicating that no valid values can be obtained. + * `last_edit_uin` - Uin of the last modifying userNote: this field may return null, indicating that no valid values can be obtained. + * `monitor_type` - Monitor type. Valid values: MT_QCE (Tencent Cloud service monitoring)Note: this field may return null, indicating that no valid values can be obtained. + * `namespace_show_name` - Namespace display nameNote: this field may return null, indicating that no valid values can be obtained. + * `namespace` - Alarm policy typeNote: this field may return null, indicating that no valid values can be obtained. + * `notice_ids` - Notification rule ID listNote: this field may return null, indicating that no valid values can be obtained. + * `notices` - Notification rule listNote: this field may return null, indicating that no valid values can be obtained. + * `amp_consumer_id` - Backend AMP consumer ID.Note: This field may return null, indicating that no valid values can be obtained. + * `cls_notices` - Channel to push alarm notifications to CLS.Note: This field may return null, indicating that no valid values can be obtained. + * `enable` - Status. Valid values: 0 (disabled), 1 (enabled). Default value: 1 (enabled). This parameter can be left empty. + * `log_set_id` - Logset ID. + * `region` - Region. + * `topic_id` - Topic ID. + * `id` - Alarm notification template IDNote: this field may return null, indicating that no valid values can be obtained. + * `is_preset` - Whether it is the system default notification template. Valid values: 0 (no), 1 (yes)Note: this field may return null, indicating that no valid values can be obtained. + * `name` - Alarm notification template nameNote: this field may return null, indicating that no valid values can be obtained. + * `notice_language` - Notification language. Valid values: zh-CN (Chinese), en-US (English)Note: this field may return null, indicating that no valid values can be obtained. + * `notice_type` - Alarm notification type. Valid values: ALARM (for unresolved alarms), OK (for resolved alarms), ALL (for all alarms)Note: this field may return null, indicating that no valid values can be obtained. + * `policy_ids` - List of IDs of the alarm policies bound to alarm notification templateNote: this field may return null, indicating that no valid values can be obtained. + * `tags` - Tags bound to a notification templateNote: This field may return null, indicating that no valid values can be obtained. + * `key` - Tag key. + * `value` - Tag value. + * `updated_at` - Last modified timeNote: this field may return null, indicating that no valid values can be obtained. + * `updated_by` - Last modified byNote: this field may return null, indicating that no valid values can be obtained. + * `url_notices` - Callback notification listNote: this field may return null, indicating that no valid values can be obtained. + * `end_time` - End time of the notification in seconds, which is calculated from 00:00:00.Note: this field may return null, indicating that no valid values can be obtained. + * `is_valid` - Whether verification is passed. Valid values: 0 (no), 1 (yes)Note: this field may return null, indicating that no valid values can be obtained. + * `start_time` - Start time of the notification in seconds, which is calculated from 00:00:00.Note: this field may return null, indicating that no valid values can be obtained. + * `url` - Callback URL, which can contain up to 256 charactersNote: this field may return null, indicating that no valid values can be obtained. + * `validation_code` - Verification codeNote: this field may return null, indicating that no valid values can be obtained. + * `weekday` - Notification cycle. The values 1-7 indicate Monday to Sunday.Note: This field may return null, indicating that no valid values can be obtained. + * `user_notices` - User notification listNote: this field may return null, indicating that no valid values can be obtained. + * `end_time` - Notification end time, which is expressed by the number of seconds since 00:00:00. Value range: 0-86399Note: this field may return null, indicating that no valid values can be obtained. + * `group_ids` - User group ID listNote: this field may return null, indicating that no valid values can be obtained. + * `need_phone_arrive_notice` - Whether receipt notification is required. Valid values: 0 (no), 1 (yes)Note: this field may return null, indicating that no valid values can be obtained. + * `notice_way` - Notification channel list. Valid values: EMAIL (email), SMS (SMS), CALL (phone), WECHAT (WeChat), RTX (WeCom)Note: This field may return null, indicating that no valid values can be obtained. + * `on_call_form_ids` - List of schedule IDsNote: u200dThis field may return null, indicating that no valid values can be obtained. + * `phone_call_type` - Dial type. SYNC (simultaneous dial), CIRCLE (polled dial). Default value: CIRCLE.Note: This field may return null, indicating that no valid values can be obtained. + * `phone_circle_interval` - Polling interval in seconds. Value range: 60-900Note: this field may return null, indicating that no valid values can be obtained. + * `phone_circle_times` - Number of phone pollings. Value range: 1-5Note: this field may return null, indicating that no valid values can be obtained. + * `phone_inner_interval` - Call interval in seconds within one polling. Value range: 60-900Note: this field may return null, indicating that no valid values can be obtained. + * `phone_order` - Phone polling listNote: this field may return null, indicating that no valid values can be obtained. + * `receiver_type` - Recipient type. Valid values: USER (user), GROUP (user group)Note: this field may return null, indicating that no valid values can be obtained. + * `start_time` - Notification start time, which is expressed by the number of seconds since 00:00:00. Value range: 0-86399Note: this field may return null, indicating that no valid values can be obtained. + * `user_ids` - User uid listNote: this field may return null, indicating that no valid values can be obtained. + * `weekday` - Notification cycle. The values 1-7 indicate Monday to Sunday.Note: This field may return null, indicating that no valid values can be obtained. + * `one_click_status` - Whether the quick alarm policy is enabled.Note: This field may return null, indicating that no valid values can be obtained. + * `origin_id` - Policy ID for instance/instance group binding and unbinding APIs (BindingPolicyObject, UnBindingAllPolicyObject, UnBindingPolicyObject)Note: this field may return null, indicating that no valid values can be obtained. + * `policy_id` - Alarm policy IDNote: this field may return null, indicating that no valid values can be obtained. + * `policy_name` - Alarm policy nameNote: this field may return null, indicating that no valid values can be obtained. + * `project_id` - Project ID. Valid values: -1 (no project), 0 (default project)Note: this field may return null, indicating that no valid values can be obtained. + * `project_name` - Project nameNote: this field may return null, indicating that no valid values can be obtained. + * `region` - RegionNote: this field may return null, indicating that no valid values can be obtained. + * `remark` - RemarksNote: this field may return null, indicating that no valid values can be obtained. + * `rule_type` - Trigger condition type. Valid values: STATIC (static threshold), DYNAMIC (dynamic)Note: this field may return null, indicating that no valid values can be obtained. + * `tag_instances` - TagNote: This field may return null, indicating that no valid values can be obtained. + * `binding_status` - Binding status. 2: bound; 1: bindingNote: This field may return null, indicating that no valid values can be obtained. + * `instance_sum` - Number of instancesNote: This field may return null, indicating that no valid values can be obtained. + * `key` - Tag keyNote: This field may return null, indicating that no valid values can be obtained. + * `region_id` - Region IDNote: This field may return null, indicating that no valid values can be obtained. + * `service_type` - Service type, for example, CVMNote: This field may return null, indicating that no valid values can be obtained. + * `tag_status` - Tag status. 2: existent; 1: nonexistentNote: This field may return null, indicating that no valid values can be obtained. + * `value` - Tag valueNote: This field may return null, indicating that no valid values can be obtained. + * `tags` - Policy tagNote: This field may return null, indicating that no valid values can be obtained. + * `key` - Tag key. + * `value` - Tag value. + * `trigger_tasks` - Triggered task listNote: this field may return null, indicating that no valid values can be obtained. + * `task_config` - Configuration information in JSON format, such as {Key1:Value1,Key2:Value2}Note: this field may return null, indicating that no valid values can be obtained. + * `type` - Triggered task type. Valid value: AS (auto scaling)Note: this field may return null, indicating that no valid values can be obtained. + * `update_time` - Update timeNote: this field may return null, indicating that no valid values can be obtained. + * `use_sum` - Number of instances bound to policy groupNote: this field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/monitor_binding_objects.html.markdown b/config/docs/d/monitor_binding_objects.html.markdown new file mode 100644 index 0000000..a71fa1a --- /dev/null +++ b/config/docs/d/monitor_binding_objects.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_binding_objects" +sidebar_current: "docs-tencentcloud-datasource-monitor_binding_objects" +description: |- + Use this data source to query policy group binding objects. +--- + +# tencentcloud_monitor_binding_objects + +Use this data source to query policy group binding objects. + +## Example Usage + +```hcl +data "tencentcloud_monitor_policy_groups" "name" { + name = "test" +} + +data "tencentcloud_monitor_binding_objects" "objects" { + group_id = data.tencentcloud_monitor_policy_groups.name.list[0].group_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, Int) Policy group ID for query. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list objects. Each element contains the following attributes: + * `dimensions_json` - Represents a collection of dimensions of an object instance, json format. + * `is_shielded` - Whether the object is shielded or not, `0` means unshielded and `1` means shielded. + * `region` - The region where the object is located. + * `unique_id` - Object unique ID. + + diff --git a/config/docs/d/monitor_data.html.markdown b/config/docs/d/monitor_data.html.markdown new file mode 100644 index 0000000..6897363 --- /dev/null +++ b/config/docs/d/monitor_data.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_data" +sidebar_current: "docs-tencentcloud-datasource-monitor_data" +description: |- + Use this data source to query monitor data. for complex queries, use (https://github.com/tencentyun/tencentcloud-exporter) +--- + +# tencentcloud_monitor_data + +Use this data source to query monitor data. for complex queries, use (https://github.com/tencentyun/tencentcloud-exporter) + +## Example Usage + +```hcl +data "tencentcloud_instances" "instances" { +} + +#cvm +data "tencentcloud_monitor_data" "cvm_monitor_data" { + namespace = "QCE/CVM" + metric_name = "CPUUsage" + dimensions { + name = "InstanceId" + value = data.tencentcloud_instances.instances.instance_list[0].instance_id + } + period = 300 + start_time = "2020-04-28T18:45:00+08:00" + end_time = "2020-04-28T19:00:00+08:00" +} + +#cos +data "tencentcloud_monitor_data" "cos_monitor_data" { + namespace = "QCE/COS" + metric_name = "InternetTraffic" + dimensions { + name = "appid" + value = "1258798060" + } + dimensions { + name = "bucket" + value = "test-1258798060" + } + + period = 300 + start_time = "2020-04-28T18:30:00+08:00" + end_time = "2020-04-28T19:00:00+08:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dimensions` - (Required, List) Dimensional composition of instance objects. +* `end_time` - (Required, String) End time for this query, eg:`2018-09-22T20:00:00+08:00`. +* `metric_name` - (Required, String) Metric name, please refer to the documentation of monitor interface of each product. +* `namespace` - (Required, String) Namespace of each cloud product in monitor system, refer to `data.tencentcloud_monitor_product_namespace`. +* `start_time` - (Required, String) Start time for this query, eg:`2018-09-22T19:51:23+08:00`. +* `period` - (Optional, Int) Statistical period. +* `result_output_file` - (Optional, String) Used to store results. + +The `dimensions` object supports the following: + +* `name` - (Required, String) Instance dimension name, eg: `InstanceId` for cvm. +* `value` - (Required, String) Instance dimension value, eg: `ins-j0hk02zo` for cvm. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list data point. Each element contains the following attributes: + * `timestamp` - Statistical timestamp. + * `value` - Statistical value. + + diff --git a/config/docs/d/monitor_grafana_plugin_overviews.html.markdown b/config/docs/d/monitor_grafana_plugin_overviews.html.markdown new file mode 100644 index 0000000..ea4bf73 --- /dev/null +++ b/config/docs/d/monitor_grafana_plugin_overviews.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_plugin_overviews" +sidebar_current: "docs-tencentcloud-datasource-monitor_grafana_plugin_overviews" +description: |- + Use this data source to query detailed information of monitor grafana_plugin_overviews +--- + +# tencentcloud_monitor_grafana_plugin_overviews + +Use this data source to query detailed information of monitor grafana_plugin_overviews + +## Example Usage + +```hcl +data "tencentcloud_monitor_grafana_plugin_overviews" "grafana_plugin_overviews" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `plugin_set` - Plugin set. + * `plugin_id` - Grafana plugin ID. + * `version` - Grafana plugin version. + + diff --git a/config/docs/d/monitor_policy_conditions.html.markdown b/config/docs/d/monitor_policy_conditions.html.markdown new file mode 100644 index 0000000..914c20a --- /dev/null +++ b/config/docs/d/monitor_policy_conditions.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_policy_conditions" +sidebar_current: "docs-tencentcloud-datasource-monitor_policy_conditions" +description: |- + Use this data source to query monitor policy conditions(There is a lot of data and it is recommended to output to a file) +--- + +# tencentcloud_monitor_policy_conditions + +Use this data source to query monitor policy conditions(There is a lot of data and it is recommended to output to a file) + +## Example Usage + +```hcl +data "tencentcloud_monitor_policy_conditions" "monitor_policy_conditions" { + name = "Cloud Virtual Machine" + result_output_file = "./tencentcloud_monitor_policy_conditions.txt" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Optional, String) Name of the policy name, support partial matching, eg:`Cloud Virtual Machine`,`Virtual`,`Cloud Load Banlancer-Private CLB Listener`. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list policy condition. Each element contains the following attributes: + * `event_metrics` - A list of event condition metrics. Each element contains the following attributes: + * `event_id` - The ID of this event metric. + * `event_show_name` - The name of this event metric. + * `need_recovered` - Whether to recover. + * `is_support_multi_region` - Whether to support multi region. + * `metrics` - A list of event condition metrics. Each element contains the following attributes: + * `calc_type_keys` - Calculate type of this metric. + * `calc_type_need` - Whether `calc_type` required in the configuration. + * `calc_value_default` - The default calculate value of this metric. + * `calc_value_fixed` - The fixed calculate value of this metric. + * `calc_value_max` - The max calculate value of this metric. + * `calc_value_min` - The min calculate value of this metric. + * `calc_value_need` - Whether `calc_value` required in the configuration. + * `continue_time_default` - The default continue time(seconds) config for this metric. + * `continue_time_keys` - The continue time(seconds) keys for this metric. + * `continue_time_need` - Whether `continue_time` required in the configuration. + * `metric_id` - The ID of this metric. + * `metric_show_name` - The name of this metric. + * `metric_unit` - The unit of this metric. + * `period_default` - The default data time(seconds) config for this metric. + * `period_keys` - The data time(seconds) keys for this metric. + * `period_need` - Whether `period` required in the configuration. + * `period_num_default` - The default period number config for this metric. + * `period_num_keys` - The period number keys for this metric. + * `period_num_need` - Whether `period_num` required in the configuration. + * `stat_type_p10` - Data aggregation mode, cycle of 10 seconds. + * `stat_type_p1800` - Data aggregation mode, cycle of 1800 seconds. + * `stat_type_p300` - Data aggregation mode, cycle of 300 seconds. + * `stat_type_p3600` - Data aggregation mode, cycle of 3600 seconds. + * `stat_type_p5` - Data aggregation mode, cycle of 5 seconds. + * `stat_type_p600` - Data aggregation mode, cycle of 600 seconds. + * `stat_type_p60` - Data aggregation mode, cycle of 60 seconds. + * `stat_type_p86400` - Data aggregation mode, cycle of 86400 seconds. + * `name` - Name of this policy name. + * `policy_view_name` - Policy view name, eg:`cvm_device`,`BANDWIDTHPACKAGE`, refer to `data.tencentcloud_monitor_policy_conditions(policy_view_name)`. + * `support_regions` - Support regions of this policy view. + + diff --git a/config/docs/d/monitor_policy_groups.html.markdown b/config/docs/d/monitor_policy_groups.html.markdown new file mode 100644 index 0000000..9694871 --- /dev/null +++ b/config/docs/d/monitor_policy_groups.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_policy_groups" +sidebar_current: "docs-tencentcloud-datasource-monitor_policy_groups" +description: |- + Use this data source to query monitor policy groups (There is a lot of data and it is recommended to output to a file) +--- + +# tencentcloud_monitor_policy_groups + +Use this data source to query monitor policy groups (There is a lot of data and it is recommended to output to a file) + +## Example Usage + +```hcl +data "tencentcloud_monitor_policy_groups" "groups" { + policy_view_names = ["REDIS-CLUSTER", "cvm_device"] +} + +data "tencentcloud_monitor_policy_groups" "name" { + name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Optional, String) Policy group name for query. +* `policy_view_names` - (Optional, List: [`String`]) The policy view for query. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list policy groups. Each element contains the following attributes: + * `can_set_default` - Whether it can be set as the default policy. + * `conditions` - A list of threshold rules. Each element contains the following attributes: + * `alarm_notify_period` - Alarm sending cycle per second. `<0` does not fire, `0` only fires once, and `>0` fires every triggerTime second. + * `alarm_notify_type` - Alarm sending convergence type. `0` continuous alarm, `1` index alarm. + * `calc_type` - Compare type, `1` means more than, `2` means greater than or equal, `3` means less than, `4` means less than or equal to, `5` means equal, `6` means not equal, `7` means days rose, `8` means days fell, `9` means weeks rose, `10` means weeks fell, `11` means period rise, `12` means period fell. + * `calc_value` - Threshold value. + * `continue_time` - How long does the triggering rule last (per second). + * `metric_id` - The ID of this metric. + * `metric_show_name` - The name of this metric. + * `metric_unit` - The unit of this metric. + * `period` - Data aggregation cycle (unit second). + * `rule_id` - Threshold rule ID. + * `event_conditions` - A list of event rules. Each element contains the following attributes: + * `alarm_notify_period` - Alarm sending cycle per second. `<0` does not fire, `0` only fires once, and `>0` fires every triggerTime second. + * `alarm_notify_type` - Alarm sending convergence type. `0` continuous alarm, `1` index alarm. + * `event_id` - The ID of this event metric. + * `event_show_name` - The name of this event metric. + * `rule_id` - Threshold rule ID. + * `group_id` - The policy group id. + * `group_name` - The policy group name. + * `insert_time` - The policy group create timestamp. + * `is_default` - If is default policy group or not, `0` represents the non-default policy, and `1` represents the default policy. + * `is_open` - Whether open or not. + * `last_edit_uin` - Recently edited user uin. + * `no_shielded_sum` - Number of unmasked instances of policy group bindings. + * `parent_group_id` - Parent policy group ID. + * `policy_view_name` - The policy group view name. + * `project_id` - The project ID to which the policy group belongs. + * `receivers` - A list of receivers. Each element contains the following attributes: + * `end_time` - End of alarm period. Meaning with `start_time`. + * `need_send_notice` - Do need a telephone alarm contact prompt.You don't need 0, you need 1. + * `notify_way` - Method of warning notification.Optional `CALL`,`EMAIL`,`SITE`,`SMS`,`WECHAT`. + * `person_interval` - Telephone warning to individual interval (seconds). + * `receive_language` - Alert sending language. + * `receiver_group_list` - Alarm receive group ID list. + * `receiver_type` - Receive type. Optional 'group' or 'user'. + * `receiver_user_list` - Alarm receiver ID list. + * `recover_notify` - Restore notification mode. Optional "SMS". + * `round_interval` - Telephone alarm interval per round (seconds). + * `round_number` - Telephone alarm number. + * `send_for` - Telephone warning time.Option "OCCUR", "RECOVER". + * `start_time` - Alarm period start time.Range [0,86399], which removes the date after it is converted to Beijing time as a Unix timestamp, for example 7200 means '10:0:0'. + * `uid_list` - The phone alerts the receiver uid. + * `remark` - Policy group remarks. + * `update_time` - The policy group update timestamp. + * `use_sum` - Number of instances of policy group bindings. + + diff --git a/config/docs/d/monitor_product_event.html.markdown b/config/docs/d/monitor_product_event.html.markdown new file mode 100644 index 0000000..f259586 --- /dev/null +++ b/config/docs/d/monitor_product_event.html.markdown @@ -0,0 +1,80 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_product_event" +sidebar_current: "docs-tencentcloud-datasource-monitor_product_event" +description: |- + Use this data source to query monitor events(There is a lot of data and it is recommended to output to a file) +--- + +# tencentcloud_monitor_product_event + +Use this data source to query monitor events(There is a lot of data and it is recommended to output to a file) + +## Example Usage + +```hcl +data "tencentcloud_monitor_product_event" "cvm_event_data" { + start_time = 1588700283 + is_alarm_config = 0 + product_name = ["cvm"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dimensions` - (Optional, List) Dimensional composition of instance objects. +* `end_time` - (Optional, Int) End timestamp for this query, eg:`1588232111`. Default start time is `now-3000`. +* `event_name` - (Optional, List: [`String`]) Event name filtering, such as `guest_reboot` indicates that the machine restart. +* `instance_id` - (Optional, List: [`String`]) Affect objects, such as `ins-19708ino`. +* `is_alarm_config` - (Optional, Int) Alarm status configuration filter, 1means configured, 0(default) means not configured. +* `product_name` - (Optional, List: [`String`]) Product type filtering, such as `cvm` for cloud server. +* `project_id` - (Optional, List: [`String`]) Project ID filter. +* `region_list` - (Optional, List: [`String`]) Region filter, such as `gz`. +* `result_output_file` - (Optional, String) Used to store results. +* `start_time` - (Optional, Int) Start timestamp for this query, eg:`1588230000`. Default start time is `now-3600`. +* `status` - (Optional, List: [`String`]) Event status filter, value range `-`,`alarm`,`recover`, indicating recovered, unrecovered and stateless. +* `type` - (Optional, List: [`String`]) Event type filtering, with value range `abnormal`,`status_change`, indicating state change and abnormal events. + +The `dimensions` object supports the following: + +* `name` - (Optional, String) Instance dimension name, eg: `deviceWanIp` for internet ip. +* `value` - (Optional, String) Instance dimension value, eg: `119.119.119.119` for internet ip. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list events. Each element contains the following attributes: + * `addition_msg` - A list of addition message. Each element contains the following attributes: + * `key` - The key of this addition message. + * `name` - The name of this addition message. + * `value` - The value of this addition message. + * `dimensions` - A list of event dimensions. Each element contains the following attributes: + * `key` - The key of this dimension. + * `name` - The name of this dimension. + * `value` - The value of this dimension. + * `event_cname` - Event chinese name. + * `event_ename` - Event english name. + * `event_id` - Event ID. + * `event_name` - Event short name. + * `group_info` - A list of group info. Each element contains the following attributes: + * `group_id` - Policy group ID. + * `group_name` - Policy group name. + * `instance_id` - The instance ID of this event. + * `instance_name` - The name of this instance. + * `is_alarm_config` - Whether to configure alarm. + * `product_cname` - Product chinese name. + * `product_ename` - Product english name. + * `product_name` - Product short name. + * `project_id` - Project ID of this instance. + * `region` - The region of this instance. + * `start_time` - The start timestamp of this event. + * `status` - The status of this event. + * `support_alarm` - Whether to support alarm. + * `type` - The type of this event. + * `update_time` - The update timestamp of this event. + + diff --git a/config/docs/d/monitor_product_namespace.html.markdown b/config/docs/d/monitor_product_namespace.html.markdown new file mode 100644 index 0000000..18dd200 --- /dev/null +++ b/config/docs/d/monitor_product_namespace.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_product_namespace" +sidebar_current: "docs-tencentcloud-datasource-monitor_product_namespace" +description: |- + Use this data source to query product namespace in monitor) +--- + +# tencentcloud_monitor_product_namespace + +Use this data source to query product namespace in monitor) + +## Example Usage + +```hcl +data "tencentcloud_monitor_product_namespace" "instances" { + name = "Redis" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Optional, String) Name for filter, eg:`Load Banlancer`. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list product namespaces. Each element contains the following attributes: + * `namespace` - Namespace of each cloud product in monitor system. + * `product_chinese_name` - Chinese name of this product. + * `product_name` - English name of this product. + + diff --git a/config/docs/d/monitor_tmp_regions.html.markdown b/config/docs/d/monitor_tmp_regions.html.markdown new file mode 100644 index 0000000..76d5de4 --- /dev/null +++ b/config/docs/d/monitor_tmp_regions.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Managed Service for Prometheus(TMP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_tmp_regions" +sidebar_current: "docs-tencentcloud-datasource-monitor_tmp_regions" +description: |- + Use this data source to query detailed information of monitor tmp_regions +--- + +# tencentcloud_monitor_tmp_regions + +Use this data source to query detailed information of monitor tmp_regions + +## Example Usage + +```hcl +data "tencentcloud_monitor_tmp_regions" "tmp_regions" { + pay_mode = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `pay_mode` - (Optional, Int) Pay mode. `1`-Prepaid, `2`-Postpaid, `3`-All regions (default is all regions if not filled in). +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `region_set` - Region set. + * `area` - Region area. + * `region_id` - Region ID. + * `region_name` - Region name. + * `region_pay_mode` - Region pay mode. + * `region_short_name` - Region short name. + * `region_state` - Region status (0-unavailable; 1-available). + * `region` - Region. + + diff --git a/config/docs/d/mps_media_meta_data.html.markdown b/config/docs/d/mps_media_meta_data.html.markdown new file mode 100644 index 0000000..900a863 --- /dev/null +++ b/config/docs/d/mps_media_meta_data.html.markdown @@ -0,0 +1,98 @@ +--- +subcategory: "Media Processing Service(MPS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mps_media_meta_data" +sidebar_current: "docs-tencentcloud-datasource-mps_media_meta_data" +description: |- + Use this data source to query detailed information of mps media_meta_data +--- + +# tencentcloud_mps_media_meta_data + +Use this data source to query detailed information of mps media_meta_data + +## Example Usage + +### Query the mps media meta data through COS + +```hcl +data "tencentcloud_cos_bucket_object" "object" { + bucket = "keep-bucket-${local.app_id}" + key = "/mps-test/test.mov" +} + +data "tencentcloud_mps_media_meta_data" "metadata" { + input_info { + type = "COS" + cos_input_info { + bucket = data.tencentcloud_cos_bucket_object.object.bucket + region = "%s" + object = data.tencentcloud_cos_bucket_object.object.key + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `input_info` - (Required, List) Input information of file for metadata getting. +* `result_output_file` - (Optional, String) Used to save results. + +The `cos_input_info` object supports the following: + +* `bucket` - (Required, String) The COS bucket of the object to process, such as `TopRankVideo-125xxx88`. +* `object` - (Required, String) The path of the object to process, such as `/movie/201907/WildAnimal.mov`. +* `region` - (Required, String) The region of the COS bucket, such as `ap-chongqing`. + +The `input_info` object supports the following: + +* `type` - (Required, String) The input type. Valid values:`COS`: A COS bucket address.`URL`: A URL.`AWS-S3`: An AWS S3 bucket address. Currently, this type is only supported for transcoding tasks. +* `cos_input_info` - (Optional, List) The information of the COS object to process. This parameter is valid and required when `Type` is `COS`. +* `s3_input_info` - (Optional, List) The information of the AWS S3 object processed. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. +* `url_input_info` - (Optional, List) The URL of the object to process. This parameter is valid and required when `Type` is `URL`.Note: This field may return null, indicating that no valid value can be obtained. + +The `s3_input_info` object supports the following: + +* `s3_bucket` - (Required, String) The AWS S3 bucket. +* `s3_object` - (Required, String) The path of the AWS S3 object. +* `s3_region` - (Required, String) The region of the AWS S3 bucket. +* `s3_secret_id` - (Optional, String) The key ID required to access the AWS S3 object. +* `s3_secret_key` - (Optional, String) The key required to access the AWS S3 object. + +The `url_input_info` object supports the following: + +* `url` - (Required, String) URL of a video. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `meta_data` - Media metadata. + * `audio_duration` - Audio duration in seconds.Note: This field may return null, indicating that no valid values can be obtained. + * `audio_stream_set` - Audio stream information.Note: This field may return null, indicating that no valid values can be obtained. + * `bitrate` - Bitrate of an audio stream in bps.Note: This field may return null, indicating that no valid values can be obtained. + * `channel` - Number of sound channels, e.g., 2Note: this field may return `null`, indicating that no valid value was found. + * `codec` - Audio stream codec, such as aac.Note: This field may return null, indicating that no valid values can be obtained. + * `sampling_rate` - Sample rate of an audio stream in Hz.Note: This field may return null, indicating that no valid values can be obtained. + * `bitrate` - Sum of the average bitrate of a video stream and that of an audio stream in bps.Note: This field may return null, indicating that no valid values can be obtained. + * `container` - Container, such as m4a and mp4.Note: This field may return null, indicating that no valid values can be obtained. + * `duration` - Video duration in seconds.Note: This field may return null, indicating that no valid values can be obtained. + * `height` - Maximum value of the height of a video stream in px.Note: This field may return null, indicating that no valid values can be obtained. + * `rotate` - Selected angle during video recording in degrees.Note: This field may return null, indicating that no valid values can be obtained. + * `size` - Size of an uploaded media file in bytes (which is the sum of size of m3u8 and ts files if the video is in HLS format).Note: This field may return null, indicating that no valid values can be obtained. + * `video_duration` - Video duration in seconds.Note: This field may return null, indicating that no valid values can be obtained. + * `video_stream_set` - Video stream information.Note: This field may return null, indicating that no valid values can be obtained. + * `bitrate` - Bitrate of a video stream in bps.Note: This field may return null, indicating that no valid values can be obtained. + * `codec` - Video stream codec, such as h264.Note: This field may return null, indicating that no valid values can be obtained. + * `color_primaries` - Color primariesNote: this field may return `null`, indicating that no valid value was found. + * `color_space` - Color spaceNote: this field may return `null`, indicating that no valid value was found. + * `color_transfer` - Color transferNote: this field may return `null`, indicating that no valid value was found. + * `fps` - Frame rate in Hz.Note: This field may return null, indicating that no valid values can be obtained. + * `hdr_type` - HDR typeNote: This field may return `null`, indicating that no valid value was found. + * `height` - Height of a video stream in px.Note: This field may return null, indicating that no valid values can be obtained. + * `width` - Width of a video stream in px.Note: This field may return null, indicating that no valid values can be obtained. + * `width` - Maximum value of the width of a video stream in px.Note: This field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/mps_parse_live_stream_process_notification.html.markdown b/config/docs/d/mps_parse_live_stream_process_notification.html.markdown new file mode 100644 index 0000000..317c3d5 --- /dev/null +++ b/config/docs/d/mps_parse_live_stream_process_notification.html.markdown @@ -0,0 +1,29 @@ +--- +subcategory: "Media Processing Service(MPS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mps_parse_live_stream_process_notification" +sidebar_current: "docs-tencentcloud-datasource-mps_parse_live_stream_process_notification" +description: |- + Use this data source to query detailed information of mps parse_live_stream_process_notification +--- + +# tencentcloud_mps_parse_live_stream_process_notification + +Use this data source to query detailed information of mps parse_live_stream_process_notification + +## Example Usage + +```hcl +data "tencentcloud_mps_parse_live_stream_process_notification" "parse_live_stream_process_notification" { + content = "your_content" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `content` - (Required, String) Live stream event notification obtained from CMQ. +* `result_output_file` - (Optional, String) Used to save results. + + diff --git a/config/docs/d/mps_parse_notification.html.markdown b/config/docs/d/mps_parse_notification.html.markdown new file mode 100644 index 0000000..d7fab58 --- /dev/null +++ b/config/docs/d/mps_parse_notification.html.markdown @@ -0,0 +1,29 @@ +--- +subcategory: "Media Processing Service(MPS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mps_parse_notification" +sidebar_current: "docs-tencentcloud-datasource-mps_parse_notification" +description: |- + Use this data source to query detailed information of mps parse_notification +--- + +# tencentcloud_mps_parse_notification + +Use this data source to query detailed information of mps parse_notification + +## Example Usage + +```hcl +data "tencentcloud_mps_parse_notification" "parse_notification" { + content = "your_content" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `content` - (Required, String) Event notification obtained from CMQ. +* `result_output_file` - (Optional, String) Used to save results. + + diff --git a/config/docs/d/mps_schedules.html.markdown b/config/docs/d/mps_schedules.html.markdown new file mode 100644 index 0000000..af175d8 --- /dev/null +++ b/config/docs/d/mps_schedules.html.markdown @@ -0,0 +1,468 @@ +--- +subcategory: "Media Processing Service(MPS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mps_schedules" +sidebar_current: "docs-tencentcloud-datasource-mps_schedules" +description: |- + Use this data source to query detailed information of mps schedules +--- + +# tencentcloud_mps_schedules + +Use this data source to query detailed information of mps schedules + +## Example Usage + +### Query the enabled schedules. + +```hcl +data "tencentcloud_mps_schedules" "schedules" { + status = "Enabled" +} +``` + +### Query the specified one. + +```hcl +data "tencentcloud_mps_schedules" "schedules" { + schedule_ids = [% d] + trigger_type = "CosFileUpload" + status = "Enabled" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `schedule_ids` - (Optional, Set: [`Int`]) The IDs of the schemes to query. Array length limit: 100. +* `status` - (Optional, String) The scheme status. Valid values:`Enabled`, `Disabled`. If you do not specify this parameter, all schemes will be returned regardless of the status. +* `trigger_type` - (Optional, String) The trigger type. Valid values:`CosFileUpload`: The scheme is triggered when a file is uploaded to Tencent Cloud Object Storage (COS).`AwsS3FileUpload`: The scheme is triggered when a file is uploaded to AWS S3.If you do not specify this parameter or leave it empty, all schemes will be returned regardless of the trigger type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `schedule_info_set` - The information of the schemes. + * `activities` - The subtasks of the scheme.Note: This field may return null, indicating that no valid values can be obtained. + * `activity_para` - The parameters of a subtask.Note: This field may return null, indicating that no valid values can be obtained. + * `adaptive_dynamic_streaming_task` - An adaptive bitrate streaming task. + * `add_on_subtitles` - The subtitle file to add.Note: This field may return null, indicating that no valid values can be obtained. + * `subtitle` - The subtitle file.Note: This field may return null, indicating that no valid values can be obtained. + * `cos_input_info` - The information of the COS object to process. This parameter is valid and required when `Type` is `COS`. + * `bucket` - The COS bucket of the object to process, such as `TopRankVideo-125xxx88`. + * `object` - The path of the object to process, such as `/movie/201907/WildAnimal.mov`. + * `region` - The region of the COS bucket, such as `ap-chongqing`. + * `s3_input_info` - The information of the AWS S3 object processed. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_object` - The path of the AWS S3 object. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to access the AWS S3 object. + * `s3_secret_key` - The key required to access the AWS S3 object. + * `type` - The input type. Valid values:`COS`: A COS bucket address. `URL`: A URL. `AWS-S3`: An AWS S3 bucket address. Currently, this type is only supported for transcoding tasks. + * `url_input_info` - The URL of the object to process. This parameter is valid and required when `Type` is `URL`.Note: This field may return null, indicating that no valid value can be obtained. + * `url` - URL of a video. + * `type` - The mode. Valid values:`subtitle-stream`: Add a subtitle track.`close-caption-708`: Embed EA-708 subtitles in SEI frames.`close-caption-608`: Embed CEA-608 subtitles in SEI frames.Note: This field may return null, indicating that no valid values can be obtained. + * `definition` - Adaptive bitrate streaming template ID. + * `output_object_path` - The relative or absolute output path of the manifest file after being transcoded to adaptive bitrate streaming. If this parameter is left empty, a relative path in the following format will be used by default: `{inputName}_adaptiveDynamicStreaming_{definition}.{format}`. + * `output_storage` - Target bucket of an output file after being transcoded to adaptive bitrate streaming. If this parameter is left empty, the `OutputStorage` value of the upper folder will be inherited.Note: this field may return null, indicating that no valid values can be obtained. + * `cos_output_storage` - The location to save the output object in COS. This parameter is valid and required when `Type` is COS.Note: This field may return null, indicating that no valid value can be obtained. + * `bucket` - The bucket to which the output file of media processing is saved, such as `TopRankVideo-125xxx88`. If this parameter is left empty, the value of the upper layer will be inherited. + * `region` - The region of the output bucket, such as `ap-chongqing`. If this parameter is left empty, the value of the upper layer will be inherited. + * `s3_output_storage` - The AWS S3 bucket to save the output file. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to upload files to the AWS S3 object. + * `s3_secret_key` - The key required to upload files to the AWS S3 object. + * `type` - The storage type for a media processing output file. Valid values:`COS`: Tencent Cloud COS. `AWS-S3`: AWS S3. This type is only supported for AWS tasks, and the output bucket must be in the same region as the bucket of the source file. + * `segment_object_name` - The relative output path of the segment file after being transcoded to adaptive bitrate streaming (in HLS format only). If this parameter is left empty, a relative path in the following format will be used by default: `{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}`. + * `sub_stream_object_name` - The relative output path of the substream file after being transcoded to adaptive bitrate streaming. If this parameter is left empty, a relative path in the following format will be used by default: `{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}`. + * `watermark_set` - List of up to 10 image or text watermarks. + * `definition` - ID of a watermarking template. + * `end_time_offset` - End time offset of a watermark in seconds.If this parameter is left empty or 0 is entered, the watermark will exist till the last video frame;If this value is greater than 0 (e.g., n), the watermark will exist till second n;If this value is smaller than 0 (e.g., -n), the watermark will exist till second n before the last video frame. + * `raw_parameter` - Custom watermark parameter, which is valid if `Definition` is 0.This parameter is used in highly customized scenarios. We recommend you use `Definition` to specify the watermark parameter preferably.Custom watermark parameter is not available for screenshot. + * `coordinate_origin` - Origin position, which currently can only be:TopLeft: the origin of coordinates is in the top-left corner of the video, and the origin of the watermark is in the top-left corner of the image or text.Default value: TopLeft. + * `image_template` - Image watermark template. This field is required when `Type` is `image` and is invalid when `Type` is `text`. + * `height` - Watermark height. % and px formats are supported:If the string ends in %, the `Height` of the watermark will be the specified percentage of the video height; for example, `10%` means that `Height` is 10% of the video height;If the string ends in px, the `Height` of the watermark will be in px; for example, `100px` means that `Height` is 100 px.Default value: 0 px, which means that `Height` will be proportionally scaled according to the aspect ratio of the original watermark image. + * `image_content` - Input content of watermark image. JPEG and PNG images are supported. + * `cos_input_info` - The information of the COS object to process. This parameter is valid and required when `Type` is `COS`. + * `bucket` - The COS bucket of the object to process, such as `TopRankVideo-125xxx88`. + * `object` - The path of the object to process, such as `/movie/201907/WildAnimal.mov`. + * `region` - The region of the COS bucket, such as `ap-chongqing`. + * `s3_input_info` - The information of the AWS S3 object processed. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_object` - The path of the AWS S3 object. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to access the AWS S3 object. + * `s3_secret_key` - The key required to access the AWS S3 object. + * `type` - The input type. Valid values:`COS`: A COS bucket address. `URL`: A URL. `AWS-S3`: An AWS S3 bucket address. Currently, this type is only supported for transcoding tasks. + * `url_input_info` - The URL of the object to process. This parameter is valid and required when `Type` is `URL`.Note: This field may return null, indicating that no valid value can be obtained. + * `url` - URL of a video. + * `repeat_type` - Repeat type of an animated watermark. Valid values:`once`: no longer appears after watermark playback ends.`repeat_last_frame`: stays on the last frame after watermark playback ends.`repeat` (default): repeats the playback until the video ends. + * `width` - Watermark width. % and px formats are supported:If the string ends in %, the `Width` of the watermark will be the specified percentage of the video width; for example, `10%` means that `Width` is 10% of the video width;If the string ends in px, the `Width` of the watermark will be in px; for example, `100px` means that `Width` is 100 px.Default value: 10%. + * `type` - Watermark type. Valid values:image: image watermark. + * `x_pos` - The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:If the string ends in %, the `XPos` of the watermark will be the specified percentage of the video width; for example, `10%` means that `XPos` is 10% of the video width;If the string ends in px, the `XPos` of the watermark will be the specified px; for example, `100px` means that `XPos` is 100 px.Default value: 0 px. + * `y_pos` - The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:If the string ends in %, the `YPos` of the watermark will be the specified percentage of the video height; for example, `10%` means that `YPos` is 10% of the video height;If the string ends in px, the `YPos` of the watermark will be the specified px; for example, `100px` means that `YPos` is 100 px.Default value: 0 px. + * `start_time_offset` - Start time offset of a watermark in seconds. If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame.If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame;If this value is greater than 0 (e.g., n), the watermark will appear at second n after the first video frame;If this value is smaller than 0 (e.g., -n), the watermark will appear at second n before the last video frame. + * `svg_content` - SVG content of up to 2,000,000 characters. This field is required only when the watermark type is `SVG`.SVG watermark is not available for screenshot. + * `text_content` - Text content of up to 100 characters. This field is required only when the watermark type is text.Text watermark is not available for screenshot. + * `ai_analysis_task` - A content analysis task. + * `definition` - Video content analysis template ID. + * `extended_parameter` - An extended parameter, whose value is a stringfied JSON.Note: This parameter is for customers with special requirements. It needs to be customized offline.Note: This field may return null, indicating that no valid values can be obtained. + * `ai_content_review_task` - A content moderation task. + * `definition` - Video content audit template ID. + * `ai_recognition_task` - A content recognition task. + * `definition` - Intelligent video recognition template ID. + * `animated_graphic_task` - An animated screenshot generation task. + * `definition` - Animated image generating template ID. + * `end_time_offset` - End time of an animated image in a video in seconds. + * `output_object_path` - Output path to a generated animated image file, which can be a relative path or an absolute path. If this parameter is left empty, the following relative path will be used by default: `{inputName}_animatedGraphic_{definition}.{format}`. + * `output_storage` - Target bucket of a generated animated image file. If this parameter is left empty, the `OutputStorage` value of the upper folder will be inherited.Note: This field may return null, indicating that no valid values can be obtained. + * `cos_output_storage` - The location to save the output object in COS. This parameter is valid and required when `Type` is COS.Note: This field may return null, indicating that no valid value can be obtained. + * `bucket` - The bucket to which the output file of media processing is saved, such as `TopRankVideo-125xxx88`. If this parameter is left empty, the value of the upper layer will be inherited. + * `region` - The region of the output bucket, such as `ap-chongqing`. If this parameter is left empty, the value of the upper layer will be inherited. + * `s3_output_storage` - The AWS S3 bucket to save the output file. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to upload files to the AWS S3 object. + * `s3_secret_key` - The key required to upload files to the AWS S3 object. + * `type` - The storage type for a media processing output file. Valid values:`COS`: Tencent Cloud COS. `AWS-S3`: AWS S3. This type is only supported for AWS tasks, and the output bucket must be in the same region as the bucket of the source file. + * `start_time_offset` - Start time of an animated image in a video in seconds. + * `image_sprite_task` - An image sprite generation task. + * `definition` - ID of an image sprite generating template. + * `object_number_format` - Rule of the `{number}` variable in the image sprite output path.Note: This field may return null, indicating that no valid values can be obtained. + * `increment` - Increment of the `{number}` variable. Default value: 1. + * `initial_value` - Start value of the `{number}` variable. Default value: 0. + * `min_length` - Minimum length of the `{number}` variable. A placeholder will be used if the variable length is below the minimum requirement. Default value: 1. + * `place_holder` - Placeholder used when the `{number}` variable length is below the minimum requirement. Default value: 0. + * `output_object_path` - Output path to a generated image sprite file, which can be a relative path or an absolute path. If this parameter is left empty, the following relative path will be used by default: `{inputName}_imageSprite_{definition}_{number}.{format}`. + * `output_storage` - Target bucket of a generated image sprite. If this parameter is left empty, the `OutputStorage` value of the upper folder will be inherited.Note: This field may return null, indicating that no valid values can be obtained. + * `cos_output_storage` - The location to save the output object in COS. This parameter is valid and required when `Type` is COS.Note: This field may return null, indicating that no valid value can be obtained. + * `bucket` - The bucket to which the output file of media processing is saved, such as `TopRankVideo-125xxx88`. If this parameter is left empty, the value of the upper layer will be inherited. + * `region` - The region of the output bucket, such as `ap-chongqing`. If this parameter is left empty, the value of the upper layer will be inherited. + * `s3_output_storage` - The AWS S3 bucket to save the output file. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to upload files to the AWS S3 object. + * `s3_secret_key` - The key required to upload files to the AWS S3 object. + * `type` - The storage type for a media processing output file. Valid values:`COS`: Tencent Cloud COS. `AWS-S3`: AWS S3. This type is only supported for AWS tasks, and the output bucket must be in the same region as the bucket of the source file. + * `web_vtt_object_name` - Output path to the WebVTT file after an image sprite is generated, which can only be a relative path. If this parameter is left empty, the following relative path will be used by default: `{inputName}_imageSprite_{definition}.{format}`. + * `sample_snapshot_task` - A sampled screencapturing task. + * `definition` - Sampled screencapturing template ID. + * `object_number_format` - Rule of the `{number}` variable in the sampled screenshot output path.Note: This field may return null, indicating that no valid values can be obtained. + * `increment` - Increment of the `{number}` variable. Default value: 1. + * `initial_value` - Start value of the `{number}` variable. Default value: 0. + * `min_length` - Minimum length of the `{number}` variable. A placeholder will be used if the variable length is below the minimum requirement. Default value: 1. + * `place_holder` - Placeholder used when the `{number}` variable length is below the minimum requirement. Default value: 0. + * `output_object_path` - Output path to a generated sampled screenshot, which can be a relative path or an absolute path. If this parameter is left empty, the following relative path will be used by default: `{inputName}_sampleSnapshot_{definition}_{number}.{format}`. + * `output_storage` - Target bucket of a sampled screenshot. If this parameter is left empty, the `OutputStorage` value of the upper folder will be inherited.Note: This field may return null, indicating that no valid values can be obtained. + * `cos_output_storage` - The location to save the output object in COS. This parameter is valid and required when `Type` is COS.Note: This field may return null, indicating that no valid value can be obtained. + * `bucket` - The bucket to which the output file of media processing is saved, such as `TopRankVideo-125xxx88`. If this parameter is left empty, the value of the upper layer will be inherited. + * `region` - The region of the output bucket, such as `ap-chongqing`. If this parameter is left empty, the value of the upper layer will be inherited. + * `s3_output_storage` - The AWS S3 bucket to save the output file. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to upload files to the AWS S3 object. + * `s3_secret_key` - The key required to upload files to the AWS S3 object. + * `type` - The storage type for a media processing output file. Valid values:`COS`: Tencent Cloud COS. `AWS-S3`: AWS S3. This type is only supported for AWS tasks, and the output bucket must be in the same region as the bucket of the source file. + * `watermark_set` - List of up to 10 image or text watermarks.Note: This field may return null, indicating that no valid values can be obtained. + * `definition` - ID of a watermarking template. + * `end_time_offset` - End time offset of a watermark in seconds.If this parameter is left empty or 0 is entered, the watermark will exist till the last video frame;If this value is greater than 0 (e.g., n), the watermark will exist till second n;If this value is smaller than 0 (e.g., -n), the watermark will exist till second n before the last video frame. + * `raw_parameter` - Custom watermark parameter, which is valid if `Definition` is 0.This parameter is used in highly customized scenarios. We recommend you use `Definition` to specify the watermark parameter preferably.Custom watermark parameter is not available for screenshot. + * `coordinate_origin` - Origin position, which currently can only be:TopLeft: the origin of coordinates is in the top-left corner of the video, and the origin of the watermark is in the top-left corner of the image or text.Default value: TopLeft. + * `image_template` - Image watermark template. This field is required when `Type` is `image` and is invalid when `Type` is `text`. + * `height` - Watermark height. % and px formats are supported:If the string ends in %, the `Height` of the watermark will be the specified percentage of the video height; for example, `10%` means that `Height` is 10% of the video height;If the string ends in px, the `Height` of the watermark will be in px; for example, `100px` means that `Height` is 100 px.Default value: 0 px, which means that `Height` will be proportionally scaled according to the aspect ratio of the original watermark image. + * `image_content` - Input content of watermark image. JPEG and PNG images are supported. + * `cos_input_info` - The information of the COS object to process. This parameter is valid and required when `Type` is `COS`. + * `bucket` - The COS bucket of the object to process, such as `TopRankVideo-125xxx88`. + * `object` - The path of the object to process, such as `/movie/201907/WildAnimal.mov`. + * `region` - The region of the COS bucket, such as `ap-chongqing`. + * `s3_input_info` - The information of the AWS S3 object processed. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_object` - The path of the AWS S3 object. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to access the AWS S3 object. + * `s3_secret_key` - The key required to access the AWS S3 object. + * `type` - The input type. Valid values:`COS`: A COS bucket address. `URL`: A URL. `AWS-S3`: An AWS S3 bucket address. Currently, this type is only supported for transcoding tasks. + * `url_input_info` - The URL of the object to process. This parameter is valid and required when `Type` is `URL`.Note: This field may return null, indicating that no valid value can be obtained. + * `url` - URL of a video. + * `repeat_type` - Repeat type of an animated watermark. Valid values:`once`: no longer appears after watermark playback ends.`repeat_last_frame`: stays on the last frame after watermark playback ends.`repeat` (default): repeats the playback until the video ends. + * `width` - Watermark width. % and px formats are supported:If the string ends in %, the `Width` of the watermark will be the specified percentage of the video width; for example, `10%` means that `Width` is 10% of the video width;If the string ends in px, the `Width` of the watermark will be in px; for example, `100px` means that `Width` is 100 px.Default value: 10%. + * `type` - Watermark type. Valid values:image: image watermark. + * `x_pos` - The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:If the string ends in %, the `XPos` of the watermark will be the specified percentage of the video width; for example, `10%` means that `XPos` is 10% of the video width;If the string ends in px, the `XPos` of the watermark will be the specified px; for example, `100px` means that `XPos` is 100 px.Default value: 0 px. + * `y_pos` - The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:If the string ends in %, the `YPos` of the watermark will be the specified percentage of the video height; for example, `10%` means that `YPos` is 10% of the video height;If the string ends in px, the `YPos` of the watermark will be the specified px; for example, `100px` means that `YPos` is 100 px.Default value: 0 px. + * `start_time_offset` - Start time offset of a watermark in seconds. If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame.If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame;If this value is greater than 0 (e.g., n), the watermark will appear at second n after the first video frame;If this value is smaller than 0 (e.g., -n), the watermark will appear at second n before the last video frame. + * `svg_content` - SVG content of up to 2,000,000 characters. This field is required only when the watermark type is `SVG`.SVG watermark is not available for screenshot. + * `text_content` - Text content of up to 100 characters. This field is required only when the watermark type is text.Text watermark is not available for screenshot. + * `snapshot_by_time_offset_task` - A time point screencapturing task. + * `definition` - ID of a time point screencapturing template. + * `ext_time_offset_set` - List of screenshot time points in the format of `s` or `%`:If the string ends in `s`, it means that the time point is in seconds; for example, `3.5s` means that the time point is the 3.5th second;If the string ends in `%`, it means that the time point is the specified percentage of the video duration; for example, `10%` means that the time point is 10% of the video duration. + * `object_number_format` - Rule of the `{number}` variable in the time point screenshot output path.Note: This field may return null, indicating that no valid values can be obtained. + * `increment` - Increment of the `{number}` variable. Default value: 1. + * `initial_value` - Start value of the `{number}` variable. Default value: 0. + * `min_length` - Minimum length of the `{number}` variable. A placeholder will be used if the variable length is below the minimum requirement. Default value: 1. + * `place_holder` - Placeholder used when the `{number}` variable length is below the minimum requirement. Default value: 0. + * `output_object_path` - Output path to a generated time point screenshot, which can be a relative path or an absolute path. If this parameter is left empty, the following relative path will be used by default: `{inputName}_snapshotByTimeOffset_{definition}_{number}.{format}`. + * `output_storage` - Target bucket of a generated time point screenshot file. If this parameter is left empty, the `OutputStorage` value of the upper folder will be inherited.Note: This field may return null, indicating that no valid values can be obtained. + * `cos_output_storage` - The location to save the output object in COS. This parameter is valid and required when `Type` is COS.Note: This field may return null, indicating that no valid value can be obtained. + * `bucket` - The bucket to which the output file of media processing is saved, such as `TopRankVideo-125xxx88`. If this parameter is left empty, the value of the upper layer will be inherited. + * `region` - The region of the output bucket, such as `ap-chongqing`. If this parameter is left empty, the value of the upper layer will be inherited. + * `s3_output_storage` - The AWS S3 bucket to save the output file. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to upload files to the AWS S3 object. + * `s3_secret_key` - The key required to upload files to the AWS S3 object. + * `type` - The storage type for a media processing output file. Valid values:`COS`: Tencent Cloud COS. `AWS-S3`: AWS S3. This type is only supported for AWS tasks, and the output bucket must be in the same region as the bucket of the source file. + * `watermark_set` - List of up to 10 image or text watermarks.Note: This field may return null, indicating that no valid values can be obtained. + * `definition` - ID of a watermarking template. + * `end_time_offset` - End time offset of a watermark in seconds.If this parameter is left empty or 0 is entered, the watermark will exist till the last video frame;If this value is greater than 0 (e.g., n), the watermark will exist till second n;If this value is smaller than 0 (e.g., -n), the watermark will exist till second n before the last video frame. + * `raw_parameter` - Custom watermark parameter, which is valid if `Definition` is 0.This parameter is used in highly customized scenarios. We recommend you use `Definition` to specify the watermark parameter preferably.Custom watermark parameter is not available for screenshot. + * `coordinate_origin` - Origin position, which currently can only be:TopLeft: the origin of coordinates is in the top-left corner of the video, and the origin of the watermark is in the top-left corner of the image or text.Default value: TopLeft. + * `image_template` - Image watermark template. This field is required when `Type` is `image` and is invalid when `Type` is `text`. + * `height` - Watermark height. % and px formats are supported:If the string ends in %, the `Height` of the watermark will be the specified percentage of the video height; for example, `10%` means that `Height` is 10% of the video height;If the string ends in px, the `Height` of the watermark will be in px; for example, `100px` means that `Height` is 100 px.Default value: 0 px, which means that `Height` will be proportionally scaled according to the aspect ratio of the original watermark image. + * `image_content` - Input content of watermark image. JPEG and PNG images are supported. + * `cos_input_info` - The information of the COS object to process. This parameter is valid and required when `Type` is `COS`. + * `bucket` - The COS bucket of the object to process, such as `TopRankVideo-125xxx88`. + * `object` - The path of the object to process, such as `/movie/201907/WildAnimal.mov`. + * `region` - The region of the COS bucket, such as `ap-chongqing`. + * `s3_input_info` - The information of the AWS S3 object processed. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_object` - The path of the AWS S3 object. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to access the AWS S3 object. + * `s3_secret_key` - The key required to access the AWS S3 object. + * `type` - The input type. Valid values:`COS`: A COS bucket address. `URL`: A URL. `AWS-S3`: An AWS S3 bucket address. Currently, this type is only supported for transcoding tasks. + * `url_input_info` - The URL of the object to process. This parameter is valid and required when `Type` is `URL`.Note: This field may return null, indicating that no valid value can be obtained. + * `url` - URL of a video. + * `repeat_type` - Repeat type of an animated watermark. Valid values:`once`: no longer appears after watermark playback ends.`repeat_last_frame`: stays on the last frame after watermark playback ends.`repeat` (default): repeats the playback until the video ends. + * `width` - Watermark width. % and px formats are supported:If the string ends in %, the `Width` of the watermark will be the specified percentage of the video width; for example, `10%` means that `Width` is 10% of the video width;If the string ends in px, the `Width` of the watermark will be in px; for example, `100px` means that `Width` is 100 px.Default value: 10%. + * `type` - Watermark type. Valid values:image: image watermark. + * `x_pos` - The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:If the string ends in %, the `XPos` of the watermark will be the specified percentage of the video width; for example, `10%` means that `XPos` is 10% of the video width;If the string ends in px, the `XPos` of the watermark will be the specified px; for example, `100px` means that `XPos` is 100 px.Default value: 0 px. + * `y_pos` - The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:If the string ends in %, the `YPos` of the watermark will be the specified percentage of the video height; for example, `10%` means that `YPos` is 10% of the video height;If the string ends in px, the `YPos` of the watermark will be the specified px; for example, `100px` means that `YPos` is 100 px.Default value: 0 px. + * `start_time_offset` - Start time offset of a watermark in seconds. If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame.If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame;If this value is greater than 0 (e.g., n), the watermark will appear at second n after the first video frame;If this value is smaller than 0 (e.g., -n), the watermark will appear at second n before the last video frame. + * `svg_content` - SVG content of up to 2,000,000 characters. This field is required only when the watermark type is `SVG`.SVG watermark is not available for screenshot. + * `text_content` - Text content of up to 100 characters. This field is required only when the watermark type is text.Text watermark is not available for screenshot. + * `transcode_task` - A transcoding task. + * `definition` - ID of a video transcoding template. + * `end_time_offset` - End time offset of a transcoded video, in seconds.If this parameter is left empty or set to 0, the transcoded video will end at the same time as the original video.If this parameter is set to a positive number (n for example), the transcoded video will end at the nth second of the original video.If this parameter is set to a negative number (-n for example), the transcoded video will end at the nth second before the end of the original video. + * `head_tail_parameter` - Opening and closing credits parametersNote: this field may return `null`, indicating that no valid value was found. + * `head_set` - Opening credits list. + * `cos_input_info` - The information of the COS object to process. This parameter is valid and required when `Type` is `COS`. + * `bucket` - The COS bucket of the object to process, such as `TopRankVideo-125xxx88`. + * `object` - The path of the object to process, such as `/movie/201907/WildAnimal.mov`. + * `region` - The region of the COS bucket, such as `ap-chongqing`. + * `s3_input_info` - The information of the AWS S3 object processed. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_object` - The path of the AWS S3 object. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to access the AWS S3 object. + * `s3_secret_key` - The key required to access the AWS S3 object. + * `type` - The input type. Valid values:`COS`: A COS bucket address. `URL`: A URL. `AWS-S3`: An AWS S3 bucket address. Currently, this type is only supported for transcoding tasks. + * `url_input_info` - The URL of the object to process. This parameter is valid and required when `Type` is `URL`.Note: This field may return null, indicating that no valid value can be obtained. + * `url` - URL of a video. + * `tail_set` - Closing credits list. + * `cos_input_info` - The information of the COS object to process. This parameter is valid and required when `Type` is `COS`. + * `bucket` - The COS bucket of the object to process, such as `TopRankVideo-125xxx88`. + * `object` - The path of the object to process, such as `/movie/201907/WildAnimal.mov`. + * `region` - The region of the COS bucket, such as `ap-chongqing`. + * `s3_input_info` - The information of the AWS S3 object processed. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_object` - The path of the AWS S3 object. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to access the AWS S3 object. + * `s3_secret_key` - The key required to access the AWS S3 object. + * `type` - The input type. Valid values:`COS`: A COS bucket address. `URL`: A URL. `AWS-S3`: An AWS S3 bucket address. Currently, this type is only supported for transcoding tasks. + * `url_input_info` - The URL of the object to process. This parameter is valid and required when `Type` is `URL`.Note: This field may return null, indicating that no valid value can be obtained. + * `url` - URL of a video. + * `mosaic_set` - List of blurs. Up to 10 ones can be supported. + * `coordinate_origin` - Origin position, which currently can only be:TopLeft: the origin of coordinates is in the top-left corner of the video, and the origin of the blur is in the top-left corner of the image or text.Default value: TopLeft. + * `end_time_offset` - End time offset of blur in seconds.If this parameter is left empty or 0 is entered, the blur will exist till the last video frame;If this value is greater than 0 (e.g., n), the blur will exist till second n;If this value is smaller than 0 (e.g., -n), the blur will exist till second n before the last video frame. + * `height` - Blur height. % and px formats are supported:If the string ends in %, the `Height` of the blur will be the specified percentage of the video height; for example, `10%` means that `Height` is 10% of the video height;If the string ends in px, the `Height` of the blur will be in px; for example, `100px` means that `Height` is 100 px.Default value: 10%. + * `start_time_offset` - Start time offset of blur in seconds. If this parameter is left empty or 0 is entered, the blur will appear upon the first video frame.If this parameter is left empty or 0 is entered, the blur will appear upon the first video frame;If this value is greater than 0 (e.g., n), the blur will appear at second n after the first video frame;If this value is smaller than 0 (e.g., -n), the blur will appear at second n before the last video frame. + * `width` - Blur width. % and px formats are supported:If the string ends in %, the `Width` of the blur will be the specified percentage of the video width; for example, `10%` means that `Width` is 10% of the video width;If the string ends in px, the `Width` of the blur will be in px; for example, `100px` means that `Width` is 100 px.Default value: 10%. + * `x_pos` - The horizontal position of the origin of the blur relative to the origin of coordinates of the video. % and px formats are supported:If the string ends in %, the `XPos` of the blur will be the specified percentage of the video width; for example, `10%` means that `XPos` is 10% of the video width;If the string ends in px, the `XPos` of the blur will be the specified px; for example, `100px` means that `XPos` is 100 px.Default value: 0 px. + * `y_pos` - Vertical position of the origin of blur relative to the origin of coordinates of video. % and px formats are supported:If the string ends in %, the `YPos` of the blur will be the specified percentage of the video height; for example, `10%` means that `YPos` is 10% of the video height;If the string ends in px, the `YPos` of the blur will be the specified px; for example, `100px` means that `YPos` is 100 px.Default value: 0 px. + * `object_number_format` - Rule of the `{number}` variable in the output path after transcoding.Note: This field may return null, indicating that no valid values can be obtained. + * `increment` - Increment of the `{number}` variable. Default value: 1. + * `initial_value` - Start value of the `{number}` variable. Default value: 0. + * `min_length` - Minimum length of the `{number}` variable. A placeholder will be used if the variable length is below the minimum requirement. Default value: 1. + * `place_holder` - Placeholder used when the `{number}` variable length is below the minimum requirement. Default value: 0. + * `output_object_path` - Path to a primary output file, which can be a relative path or an absolute path. If this parameter is left empty, the following relative path will be used by default: `{inputName}_transcode_{definition}.{format}`. + * `output_storage` - Target bucket of an output file. If this parameter is left empty, the `OutputStorage` value of the upper folder will be inherited.Note: This field may return null, indicating that no valid values can be obtained. + * `cos_output_storage` - The location to save the output object in COS. This parameter is valid and required when `Type` is COS.Note: This field may return null, indicating that no valid value can be obtained. + * `bucket` - The bucket to which the output file of media processing is saved, such as `TopRankVideo-125xxx88`. If this parameter is left empty, the value of the upper layer will be inherited. + * `region` - The region of the output bucket, such as `ap-chongqing`. If this parameter is left empty, the value of the upper layer will be inherited. + * `s3_output_storage` - The AWS S3 bucket to save the output file. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to upload files to the AWS S3 object. + * `s3_secret_key` - The key required to upload files to the AWS S3 object. + * `type` - The storage type for a media processing output file. Valid values:`COS`: Tencent Cloud COS. `AWS-S3`: AWS S3. This type is only supported for AWS tasks, and the output bucket must be in the same region as the bucket of the source file. + * `override_parameter` - Video transcoding custom parameter, which is valid when `Definition` is not 0.When any parameters in this structure are entered, they will be used to override corresponding parameters in templates.This parameter is used in highly customized scenarios. We recommend you only use `Definition` to specify the transcoding parameter.Note: this field may return `null`, indicating that no valid value was found. + * `add_on_subtitles` - The subtitle file to add.Note: This field may return null, indicating that no valid values can be obtained. + * `subtitle` - The subtitle file.Note: This field may return null, indicating that no valid values can be obtained. + * `cos_input_info` - The information of the COS object to process. This parameter is valid and required when `Type` is `COS`. + * `bucket` - The COS bucket of the object to process, such as `TopRankVideo-125xxx88`. + * `object` - The path of the object to process, such as `/movie/201907/WildAnimal.mov`. + * `region` - The region of the COS bucket, such as `ap-chongqing`. + * `s3_input_info` - The information of the AWS S3 object processed. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_object` - The path of the AWS S3 object. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to access the AWS S3 object. + * `s3_secret_key` - The key required to access the AWS S3 object. + * `type` - The input type. Valid values:`COS`: A COS bucket address. `URL`: A URL. `AWS-S3`: An AWS S3 bucket address. Currently, this type is only supported for transcoding tasks. + * `url_input_info` - The URL of the object to process. This parameter is valid and required when `Type` is `URL`.Note: This field may return null, indicating that no valid value can be obtained. + * `url` - URL of a video. + * `type` - The mode. Valid values:`subtitle-stream`: Add a subtitle track.`close-caption-708`: Embed EA-708 subtitles in SEI frames.`close-caption-608`: Embed CEA-608 subtitles in SEI frames.Note: This field may return null, indicating that no valid values can be obtained. + * `addon_audio_stream` - The information of the external audio track to add.Note: This field may return null, indicating that no valid values can be obtained. + * `cos_input_info` - The information of the COS object to process. This parameter is valid and required when `Type` is `COS`. + * `bucket` - The COS bucket of the object to process, such as `TopRankVideo-125xxx88`. + * `object` - The path of the object to process, such as `/movie/201907/WildAnimal.mov`. + * `region` - The region of the COS bucket, such as `ap-chongqing`. + * `s3_input_info` - The information of the AWS S3 object processed. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_object` - The path of the AWS S3 object. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to access the AWS S3 object. + * `s3_secret_key` - The key required to access the AWS S3 object. + * `type` - The input type. Valid values:`COS`: A COS bucket address. `URL`: A URL. `AWS-S3`: An AWS S3 bucket address. Currently, this type is only supported for transcoding tasks. + * `url_input_info` - The URL of the object to process. This parameter is valid and required when `Type` is `URL`.Note: This field may return null, indicating that no valid value can be obtained. + * `url` - URL of a video. + * `audio_template` - Audio stream configuration parameter. + * `audio_channel` - Audio channel system. Valid values:1: Mono2: Dual6: StereoWhen the media is packaged in audio format (FLAC, OGG, MP3, M4A), the sound channel cannot be set to stereo. + * `bitrate` - Audio stream bitrate in Kbps. Value range: 0 and [26, 256]. If the value is 0, the bitrate of the audio stream will be the same as that of the original audio. + * `codec` - Audio stream codec.When the outer `Container` parameter is `mp3`, the valid value is:libmp3lame.When the outer `Container` parameter is `ogg` or `flac`, the valid value is:flac.When the outer `Container` parameter is `m4a`, the valid values include:libfdk_aac;libmp3lame;ac3.When the outer `Container` parameter is `mp4` or `flv`, the valid values include:libfdk_aac: More suitable for mp4;libmp3lame: More suitable for flv;mp2.When the outer `Container` parameter is `hls`, the valid values include:libfdk_aac;libmp3lame. + * `sample_rate` - Audio stream sample rate. Valid values:32,00044,10048,000In Hz. + * `stream_selects` - The audio tracks to retain. All audio tracks are retained by default. + * `container` - Container format. Valid values: mp4, flv, hls, mp3, flac, ogg, and m4a; mp3, flac, ogg, and m4a are formats of audio files. + * `remove_audio` - Whether to remove audio data. Valid values:0: retain1: remove. + * `remove_video` - Whether to remove video data. Valid values:0: retain1: remove. + * `std_ext_info` - An extended field for transcoding.Note: This field may return null, indicating that no valid values can be obtained. + * `subtitle_template` - The subtitle settings.Note: This field may return null, indicating that no valid values can be obtained. + * `font_alpha` - The text transparency. Value range: 0-1.`0`: Fully transparent.`1`: Fully opaque.Default value: 1.Note: This field may return null, indicating that no valid values can be obtained. + * `font_color` - The font color in 0xRRGGBB format. Default value: 0xFFFFFF (white).Note: This field may return null, indicating that no valid values can be obtained. + * `font_size` - The font size (pixels). If this is not specified, the font size in the subtitle file will be used.Note: This field may return null, indicating that no valid values can be obtained. + * `font_type` - The font. Valid values:`hei.ttf`: Heiti.`song.ttf`: Songti.`simkai.ttf`: Kaiti.`arial.ttf`: Arial.The default is `hei.ttf`.Note: This field may return null, indicating that no valid values can be obtained. + * `path` - The URL of the subtitles to add to the video.Note: This field may return null, indicating that no valid values can be obtained. + * `stream_index` - The subtitle track to add to the video. If both `Path` and `StreamIndex` are specified, `Path` will be used. You need to specify at least one of the two parameters.Note: This field may return null, indicating that no valid values can be obtained. + * `tehd_config` - The TSC transcoding parameters.Note: This field may return null, indicating that no valid values can be obtained. + * `max_video_bitrate` - The maximum video bitrate. If this parameter is not specified, no modifications will be made.Note: This field may return null, indicating that no valid values can be obtained. + * `type` - The TSC type. Valid values:`TEHD-100`: TSC-100 (video TSC). `TEHD-200`: TSC-200 (audio TSC). If this parameter is left blank, no modification will be made.Note: This field may return null, indicating that no valid values can be obtained. + * `video_template` - Video stream configuration parameter. + * `bitrate` - Bitrate of a video stream in Kbps. Value range: 0 and [128, 35,000].If the value is 0, the bitrate of the video will be the same as that of the source video. + * `codec` - The video codec. Valid values:libx264: H.264libx265: H.265av1: AOMedia Video 1Note: You must specify a resolution (not higher than 640 x 480) if the H.265 codec is used.Note: You can only use the AOMedia Video 1 codec for MP4 files. + * `content_adapt_stream` - Whether to enable adaptive encoding. Valid values:0: Disable1: EnableDefault value: 0. If this parameter is set to `1`, multiple streams with different resolutions and bitrates will be generated automatically. The highest resolution, bitrate, and quality of the streams are determined by the values of `width` and `height`, `Bitrate`, and `Vcrf` in `VideoTemplate` respectively. If these parameters are not set in `VideoTemplate`, the highest resolution generated will be the same as that of the source video, and the highest video quality will be close to VMAF 95. To use this parameter or learn about the billing details of adaptive encoding, please contact your sales rep. + * `fill_type` - Fill type. Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: stretch: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer;black: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks.white: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks.gauss: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur. + * `fps` - Video frame rate in Hz. Value range: [0, 100].If the value is 0, the frame rate will be the same as that of the source video. + * `gop` - Frame interval between I keyframes. Value range: 0 and [1,100000]. If this parameter is 0, the system will automatically set the GOP length. + * `height` - Maximum value of the height (or short side) of a video stream in px. Value range: 0 and [128, 4,096]. + * `resolution_adaptive` - Resolution adaption. Valid values:open: Enabled. When resolution adaption is enabled, `Width` indicates the long side of a video, while `Height` indicates the short side.close: Disabled. When resolution adaption is disabled, `Width` indicates the width of a video, while `Height` indicates the height.Note: When resolution adaption is enabled, `Width` cannot be smaller than `Height`. + * `vcrf` - The control factor of video constant bitrate. Value range: [0, 51]. This parameter will be disabled if you enter `0`.It is not recommended to specify this parameter if there are no special requirements. + * `width` - Maximum value of the width (or long side) of a video stream in px. Value range: 0 and [128, 4,096].If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;If both `Width` and `Height` are not 0, the custom resolution will be used. + * `raw_parameter` - Custom video transcoding parameter, which is valid if `Definition` is 0.This parameter is used in highly customized scenarios. We recommend you use `Definition` to specify the transcoding parameter preferably. + * `audio_template` - Audio stream configuration parameter. This field is required when `RemoveAudio` is 0. + * `audio_channel` - Audio channel system. Valid values:1: Mono2: Dual6: StereoWhen the media is packaged in audio format (FLAC, OGG, MP3, M4A), the sound channel cannot be set to stereo.Default value: 2. + * `bitrate` - Audio stream bitrate in Kbps. Value range: 0 and [26, 256].If the value is 0, the bitrate of the audio stream will be the same as that of the original audio. + * `codec` - Audio stream codec.When the outer `Container` parameter is `mp3`, the valid value is:libmp3lame.When the outer `Container` parameter is `ogg` or `flac`, the valid value is:flac.When the outer `Container` parameter is `m4a`, the valid values include:libfdk_aac;libmp3lame;ac3.When the outer `Container` parameter is `mp4` or `flv`, the valid values include:libfdk_aac: more suitable for mp4;libmp3lame: more suitable for flv.When the outer `Container` parameter is `hls`, the valid values include:libfdk_aac;libmp3lame. + * `sample_rate` - Audio stream sample rate. Valid values:32,00044,10048,000In Hz. + * `container` - Container. Valid values: mp4; flv; hls; mp3; flac; ogg; m4a. Among them, mp3, flac, ogg, and m4a are for audio files. + * `remove_audio` - Whether to remove audio data. Valid values:0: retain;1: remove.Default value: 0. + * `remove_video` - Whether to remove video data. Valid values:0: retain;1: remove.Default value: 0. + * `tehd_config` - TESHD transcoding parameter. + * `max_video_bitrate` - Maximum bitrate, which is valid when `Type` is `TESHD`. If this parameter is left empty or 0 is entered, there will be no upper limit for bitrate. + * `type` - TESHD type. Valid values:`TEHD-100`: TESHD-100. If this parameter is left empty, TESHD will not be enabled. + * `video_template` - Video stream configuration parameter. This field is required when `RemoveVideo` is 0. + * `bitrate` - The video bitrate (Kbps). Value range: 0 and [128, 35000].If the value is 0, the bitrate of the video will be the same as that of the source video. + * `codec` - The video codec. Valid values:`libx264`: H.264`libx265`: H.265`av1`: AOMedia Video 1Note: You must specify a resolution (not higher than 640 x 480) if the H.265 codec is used.Note: You can only use the AOMedia Video 1 codec for MP4 files. + * `fill_type` - The fill mode, which indicates how a video is resized when the video's original aspect ratio is different from the target aspect ratio. Valid values:stretch: Stretch the image frame by frame to fill the entire screen. The video image may become squashed or stretched after transcoding.black: Keep the image's original aspect ratio and fill the blank space with black bars.white: Keep the image's original aspect ratio and fill the blank space with white bars.gauss: Keep the image's original aspect ratio and apply Gaussian blur to the blank space.Default value: black.Note: Only `stretch` and `black` are supported for adaptive bitrate streaming. + * `fps` - The video frame rate (Hz). Value range: [0, 100].If the value is 0, the frame rate will be the same as that of the source video.Note: For adaptive bitrate streaming, the value range of this parameter is [0, 60]. + * `gop` - Frame interval between I keyframes. Value range: 0 and [1,100000].If this parameter is 0 or left empty, the system will automatically set the GOP length. + * `height` - Maximum value of the height (or short side) of a video stream in px. Value range: 0 and [128, 4,096].If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;If both `Width` and `Height` are not 0, the custom resolution will be used.Default value: 0. + * `resolution_adaptive` - Resolution adaption. Valid values:open: Enabled. When resolution adaption is enabled, `Width` indicates the long side of a video, while `Height` indicates the short side.close: Disabled. When resolution adaption is disabled, `Width` indicates the width of a video, while `Height` indicates the height.Default value: open.Note: When resolution adaption is enabled, `Width` cannot be smaller than `Height`. + * `vcrf` - The control factor of video constant bitrate. Value range: [1, 51]If this parameter is specified, CRF (a bitrate control method) will be used for transcoding. (Video bitrate will no longer take effect.)It is not recommended to specify this parameter if there are no special requirements. + * `width` - Maximum value of the width (or long side) of a video stream in px. Value range: 0 and [128, 4,096].If both `Width` and `Height` are 0, the resolution will be the same as that of the source video;If `Width` is 0, but `Height` is not 0, `Width` will be proportionally scaled;If `Width` is not 0, but `Height` is 0, `Height` will be proportionally scaled;If both `Width` and `Height` are not 0, the custom resolution will be used.Default value: 0. + * `segment_object_name` - Path to an output file part (the path to ts during transcoding to HLS), which can only be a relative path. If this parameter is left empty, the following relative path will be used by default: `{inputName}_transcode_{definition}_{number}.{format}`. + * `start_time_offset` - Start time offset of a transcoded video, in seconds.If this parameter is left empty or set to 0, the transcoded video will start at the same time as the original video.If this parameter is set to a positive number (n for example), the transcoded video will start at the nth second of the original video.If this parameter is set to a negative number (-n for example), the transcoded video will start at the nth second before the end of the original video. + * `watermark_set` - List of up to 10 image or text watermarks.Note: This field may return null, indicating that no valid values can be obtained. + * `definition` - ID of a watermarking template. + * `end_time_offset` - End time offset of a watermark in seconds.If this parameter is left empty or 0 is entered, the watermark will exist till the last video frame;If this value is greater than 0 (e.g., n), the watermark will exist till second n;If this value is smaller than 0 (e.g., -n), the watermark will exist till second n before the last video frame. + * `raw_parameter` - Custom watermark parameter, which is valid if `Definition` is 0.This parameter is used in highly customized scenarios. We recommend you use `Definition` to specify the watermark parameter preferably.Custom watermark parameter is not available for screenshot. + * `coordinate_origin` - Origin position, which currently can only be:TopLeft: the origin of coordinates is in the top-left corner of the video, and the origin of the watermark is in the top-left corner of the image or text.Default value: TopLeft. + * `image_template` - Image watermark template. This field is required when `Type` is `image` and is invalid when `Type` is `text`. + * `height` - Watermark height. % and px formats are supported:If the string ends in %, the `Height` of the watermark will be the specified percentage of the video height; for example, `10%` means that `Height` is 10% of the video height;If the string ends in px, the `Height` of the watermark will be in px; for example, `100px` means that `Height` is 100 px.Default value: 0 px, which means that `Height` will be proportionally scaled according to the aspect ratio of the original watermark image. + * `image_content` - Input content of watermark image. JPEG and PNG images are supported. + * `cos_input_info` - The information of the COS object to process. This parameter is valid and required when `Type` is `COS`. + * `bucket` - The COS bucket of the object to process, such as `TopRankVideo-125xxx88`. + * `object` - The path of the object to process, such as `/movie/201907/WildAnimal.mov`. + * `region` - The region of the COS bucket, such as `ap-chongqing`. + * `s3_input_info` - The information of the AWS S3 object processed. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_object` - The path of the AWS S3 object. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to access the AWS S3 object. + * `s3_secret_key` - The key required to access the AWS S3 object. + * `type` - The input type. Valid values:`COS`: A COS bucket address. `URL`: A URL. `AWS-S3`: An AWS S3 bucket address. Currently, this type is only supported for transcoding tasks. + * `url_input_info` - The URL of the object to process. This parameter is valid and required when `Type` is `URL`.Note: This field may return null, indicating that no valid value can be obtained. + * `url` - URL of a video. + * `repeat_type` - Repeat type of an animated watermark. Valid values:`once`: no longer appears after watermark playback ends.`repeat_last_frame`: stays on the last frame after watermark playback ends.`repeat` (default): repeats the playback until the video ends. + * `width` - Watermark width. % and px formats are supported:If the string ends in %, the `Width` of the watermark will be the specified percentage of the video width; for example, `10%` means that `Width` is 10% of the video width;If the string ends in px, the `Width` of the watermark will be in px; for example, `100px` means that `Width` is 100 px.Default value: 10%. + * `type` - Watermark type. Valid values:image: image watermark. + * `x_pos` - The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:If the string ends in %, the `XPos` of the watermark will be the specified percentage of the video width; for example, `10%` means that `XPos` is 10% of the video width;If the string ends in px, the `XPos` of the watermark will be the specified px; for example, `100px` means that `XPos` is 100 px.Default value: 0 px. + * `y_pos` - The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:If the string ends in %, the `YPos` of the watermark will be the specified percentage of the video height; for example, `10%` means that `YPos` is 10% of the video height;If the string ends in px, the `YPos` of the watermark will be the specified px; for example, `100px` means that `YPos` is 100 px.Default value: 0 px. + * `start_time_offset` - Start time offset of a watermark in seconds. If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame.If this parameter is left empty or 0 is entered, the watermark will appear upon the first video frame;If this value is greater than 0 (e.g., n), the watermark will appear at second n after the first video frame;If this value is smaller than 0 (e.g., -n), the watermark will appear at second n before the last video frame. + * `svg_content` - SVG content of up to 2,000,000 characters. This field is required only when the watermark type is `SVG`.SVG watermark is not available for screenshot. + * `text_content` - Text content of up to 100 characters. This field is required only when the watermark type is text.Text watermark is not available for screenshot. + * `activity_type` - The subtask type.`input`: The start.`output`: The end.`action-trans`: Transcoding.`action-samplesnapshot`: Sampled screencapturing.`action-AIAnalysis`: Content analysis.`action-AIRecognition`: Content recognition.`action-aiReview`: Content moderation.`action-animated-graphics`: Animated screenshot generation.`action-image-sprite`: Image sprite generation.`action-snapshotByTimeOffset`: Time point screencapturing.`action-adaptive-substream`: Adaptive bitrate streaming.Note: This field may return null, indicating that no valid values can be obtained. + * `reardrive_index` - The indexes of the subsequent actions.Note: This field may return null, indicating that no valid values can be obtained. + * `create_time` - The creation time in [ISO date format](https://intl.cloud.tencent.com/document/product/862/37710?from_cn_redirect=1#52).Note: This field may return null, indicating that no valid values can be obtained. + * `output_dir` - The directory to save the output file.Note: This field may return null, indicating that no valid values can be obtained. + * `output_storage` - The bucket to save the output file.Note: This field may return null, indicating that no valid values can be obtained. + * `cos_output_storage` - The location to save the output object in COS. This parameter is valid and required when `Type` is COS.Note: This field may return null, indicating that no valid value can be obtained. + * `bucket` - The bucket to which the output file of media processing is saved, such as `TopRankVideo-125xxx88`. If this parameter is left empty, the value of the upper layer will be inherited. + * `region` - The region of the output bucket, such as `ap-chongqing`. If this parameter is left empty, the value of the upper layer will be inherited. + * `s3_output_storage` - The AWS S3 bucket to save the output file. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained. + * `s3_bucket` - The AWS S3 bucket. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID required to upload files to the AWS S3 object. + * `s3_secret_key` - The key required to upload files to the AWS S3 object. + * `type` - The storage type for a media processing output file. Valid values:`COS`: Tencent Cloud COS. `AWS-S3`: AWS S3. This type is only supported for AWS tasks, and the output bucket must be in the same region as the bucket of the source file. + * `schedule_id` - The scheme ID. + * `schedule_name` - The scheme name.Note: This field may return null, indicating that no valid values can be obtained. + * `status` - The scheme status. Valid values:`Enabled``Disabled`Note: This field may return null, indicating that no valid values can be obtained. + * `task_notify_config` - The notification configuration.Note: This field may return null, indicating that no valid values can be obtained. + * `aws_sqs` - The AWS SQS queue. This parameter is required if `NotifyType` is `AWS-SQS`.Note: This field may return null, indicating that no valid values can be obtained. + * `s3_secret_id` - The key ID required to read from/write to the SQS queue. + * `s3_secret_key` - The key required to read from/write to the SQS queue. + * `sqs_queue_name` - The name of the SQS queue. + * `sqs_region` - The region of the SQS queue. + * `cmq_model` - The CMQ or TDMQ-CMQ model. Valid values: Queue, Topic. + * `cmq_region` - The CMQ or TDMQ-CMQ region, such as `sh` (Shanghai) or `bj` (Beijing). + * `notify_mode` - Workflow notification method. Valid values: Finish, Change. If this parameter is left empty, `Finish` will be used. + * `notify_type` - The notification type. Valid values:`CMQ`: This value is no longer used. Please use `TDMQ-CMQ` instead.`TDMQ-CMQ`: Message queue`URL`: If `NotifyType` is set to `URL`, HTTP callbacks are sent to the URL specified by `NotifyUrl`. HTTP and JSON are used for the callbacks. The packet contains the response parameters of the `ParseNotification` API.`SCF`: This notification type is not recommended. You need to configure it in the SCF console.`AWS-SQS`: AWS queue. This type is only supported for AWS tasks, and the queue must be in the same region as the AWS bucket.Note: If you do not pass this parameter or pass in an empty string, `CMQ` will be used. To use a different notification type, specify this parameter accordingly. + * `notify_url` - HTTP callback URL, required if `NotifyType` is set to `URL`. + * `queue_name` - The CMQ or TDMQ-CMQ queue to receive notifications. This parameter is valid when `CmqModel` is `Queue`. + * `topic_name` - The CMQ or TDMQ-CMQ topic to receive notifications. This parameter is valid when `CmqModel` is `Topic`. + * `trigger` - The trigger of the scheme.Note: This field may return null, indicating that no valid values can be obtained. + * `aws_s3_file_upload_trigger` - The AWS S3 trigger. This parameter is valid and required if `Type` is `AwsS3FileUpload`.Note: Currently, the key for the AWS S3 bucket, the trigger SQS queue, and the callback SQS queue must be the same.Note: This field may return null, indicating that no valid values can be obtained. + * `aws_sqs` - The SQS queue of the AWS S3 bucket.Note: The queue must be in the same region as the bucket.Note: This field may return null, indicating that no valid values can be obtained. + * `s3_secret_id` - The key ID required to read from/write to the SQS queue. + * `s3_secret_key` - The key required to read from/write to the SQS queue. + * `sqs_queue_name` - The name of the SQS queue. + * `sqs_region` - The region of the SQS queue. + * `dir` - The bucket directory bound. It must be an absolute path that starts and ends with `/`, such as `/movie/201907/`. If you do not specify this, the root directory will be bound. . + * `formats` - The file formats that will trigger the scheme, such as [mp4, flv, mov]. If you do not specify this, the upload of files in any format will trigger the scheme. . + * `s3_bucket` - The AWS S3 bucket bound to the scheme. + * `s3_region` - The region of the AWS S3 bucket. + * `s3_secret_id` - The key ID of the AWS S3 bucket.Note: This field may return null, indicating that no valid values can be obtained. + * `s3_secret_key` - The key of the AWS S3 bucket.Note: This field may return null, indicating that no valid values can be obtained. + * `cos_file_upload_trigger` - This parameter is required and valid when `Type` is `CosFileUpload`, indicating the COS trigger rule.Note: This field may return null, indicating that no valid values can be obtained. + * `bucket` - Name of the COS bucket bound to a workflow, such as `TopRankVideo-125xxx88`. + * `dir` - Input path directory bound to a workflow, such as `/movie/201907/`. If this parameter is left empty, the `/` root directory will be used. + * `formats` - Format list of files that can trigger a workflow, such as [mp4, flv, mov]. If this parameter is left empty, files in all formats can trigger the workflow. + * `region` - Region of the COS bucket bound to a workflow, such as `ap-chongiqng`. + * `type` - The trigger type. Valid values:`CosFileUpload`: Tencent Cloud COS trigger.`AwsS3FileUpload`: AWS S3 trigger. Currently, this type is only supported for transcoding tasks and schemes (not supported for workflows). + * `update_time` - The last updated time in [ISO date format](https://intl.cloud.tencent.com/document/product/862/37710?from_cn_redirect=1#52).Note: This field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/mps_tasks.html.markdown b/config/docs/d/mps_tasks.html.markdown new file mode 100644 index 0000000..7e7d870 --- /dev/null +++ b/config/docs/d/mps_tasks.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Media Processing Service(MPS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mps_tasks" +sidebar_current: "docs-tencentcloud-datasource-mps_tasks" +description: |- + Use this data source to query detailed information of mps tasks +--- + +# tencentcloud_mps_tasks + +Use this data source to query detailed information of mps tasks + +## Example Usage + +```hcl +data "tencentcloud_mps_tasks" "tasks" { + status = "FINISH" + limit = 20 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `status` - (Required, String) Filter condition: task status, optional values: WAITING, PROCESSING, FINISH. +* `limit` - (Optional, Int) Return the number of records, default value: 10, maximum value: 100. +* `result_output_file` - (Optional, String) Used to save results. +* `scroll_token` - (Optional, String) Page turning flag, used when pulling in batches: when a single request cannot pull all the data, the interface will return a ScrollToken, and the next request will carry this Token, and it will be obtained from the next record. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `task_set` - Task list. + * `begin_process_time` - Begin process time, in ISO date format. Refer to https://cloud.tencent.com/document/product/862/37710#52. If the task has not started yet, this field is: 0000-00-00T00:00:00Z. + * `create_time` - Creation time, in ISO date format. Refer to https://cloud.tencent.com/document/product/862/37710#52. + * `finish_time` - Task finish time, in ISO date format. Refer to https://cloud.tencent.com/document/product/862/37710#52. If the task has not been completed, this field is: 0000-00-00T00:00:00Z. + * `sub_task_types` - Sub task types. + * `task_id` - Task ID. + * `task_type` - Task type, including:WorkflowTask, EditMediaTask, LiveProcessTask. + + diff --git a/config/docs/d/mysql_backup_list.html.markdown b/config/docs/d/mysql_backup_list.html.markdown new file mode 100644 index 0000000..7aca0e3 --- /dev/null +++ b/config/docs/d/mysql_backup_list.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_backup_list" +sidebar_current: "docs-tencentcloud-datasource-mysql_backup_list" +description: |- + Use this data source to query the list of backup databases. +--- + +# tencentcloud_mysql_backup_list + +Use this data source to query the list of backup databases. + +## Example Usage + +```hcl +data "tencentcloud_mysql_backup_list" "default" { + mysql_id = "terraform-test-local-database" + max_number = 10 + result_output_file = "mytestpath" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `mysql_id` - (Required, String) Instance ID, such as `cdb-c1nl9rpv`. It is identical to the instance ID displayed in the database console page. +* `max_number` - (Optional, Int) The latest files to list, rang from 1 to 10000. And the default value is `10`. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of MySQL backup. Each element contains the following attributes: + * `backup_id` - ID of Backup task. + * `backup_model` - Backup method. Supported values include: `physical` - physical backup, and `logical` - logical backup. + * `creator` - The owner of the backup files. + * `finish_time` - The time at which the backup finishes. + * `internet_url` - URL for downloads externally. + * `intranet_url` - URL for downloads internally. + * `size` - the size of backup file. + * `time` - The earliest time at which the backup starts. For example, `2` indicates 2:00 am. + + diff --git a/config/docs/d/mysql_backup_overview.html.markdown b/config/docs/d/mysql_backup_overview.html.markdown new file mode 100644 index 0000000..e0ffb22 --- /dev/null +++ b/config/docs/d/mysql_backup_overview.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_backup_overview" +sidebar_current: "docs-tencentcloud-datasource-mysql_backup_overview" +description: |- + Use this data source to query detailed information of mysql backup_overview +--- + +# tencentcloud_mysql_backup_overview + +Use this data source to query detailed information of mysql backup_overview + +## Example Usage + +```hcl +data "tencentcloud_mysql_backup_overview" "backup_overview" { + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `product` - (Required, String) The type of cloud database product to be queried, currently only supports `mysql`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `backup_archive_volume` - Archive backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained. +* `backup_count` - The total number of user backups in the current region (including data backups and log backups). +* `backup_standby_volume` - Standard storage backup capacity, including data backup and log backup. Note: This field may return null, indicating that no valid value can be obtained. +* `backup_volume` - The total backup capacity of the user in the current region. +* `billing_volume` - The billable capacity of the user&#39;s backup in the current region, that is, the part that exceeds the gifted capacity. +* `free_volume` - The free backup capacity obtained by the user in the current region. +* `remote_backup_volume` - The total capacity of off-site backup of the user in the current region. Note: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/mysql_backup_summaries.html.markdown b/config/docs/d/mysql_backup_summaries.html.markdown new file mode 100644 index 0000000..e1423d8 --- /dev/null +++ b/config/docs/d/mysql_backup_summaries.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_backup_summaries" +sidebar_current: "docs-tencentcloud-datasource-mysql_backup_summaries" +description: |- + Use this data source to query detailed information of mysql backup_summaries +--- + +# tencentcloud_mysql_backup_summaries + +Use this data source to query detailed information of mysql backup_summaries + +## Example Usage + +```hcl +data "tencentcloud_mysql_backup_summaries" "backup_summaries" { + product = "mysql" + order_by = "BackupVolume" + order_direction = "ASC" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `product` - (Required, String) The type of cloud database product to be queried, currently only supports `mysql`. +* `order_by` - (Optional, String) Specify to sort by a certain item, the optional values include: BackupVolume: backup volume, DataBackupVolume: data backup volume, BinlogBackupVolume: log backup volume, AutoBackupVolume: automatic backup volume, ManualBackupVolume: manual backup volume. By default, they are sorted by BackupVolume. +* `order_direction` - (Optional, String) Specify the sorting direction, optional values include: ASC: forward order, DESC: reverse order. The default is ASC. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Instance backup statistics entries. + * `auto_backup_count` - The number of automatic data backups for this instance. + * `auto_backup_volume` - The automatic data backup capacity of this instance. + * `backup_volume` - The total backup (including data backup and log backup) of the instance occupies capacity. + * `binlog_backup_count` - The number of log backups for this instance. + * `binlog_backup_volume` - The capacity of the instance log backup. + * `data_backup_count` - The total number of data backups (including automatic backups and manual backups) of the instance. + * `data_backup_volume` - The total data backup capacity of this instance. + * `instance_id` - Instance ID. + * `manual_backup_count` - The number of manual data backups for this instance. + * `manual_backup_volume` - The capacity of manual data backup for this instance. + + diff --git a/config/docs/d/mysql_bin_log.html.markdown b/config/docs/d/mysql_bin_log.html.markdown new file mode 100644 index 0000000..f8eb950 --- /dev/null +++ b/config/docs/d/mysql_bin_log.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_bin_log" +sidebar_current: "docs-tencentcloud-datasource-mysql_bin_log" +description: |- + Use this data source to query detailed information of mysql bin_log +--- + +# tencentcloud_mysql_bin_log + +Use this data source to query detailed information of mysql bin_log + +## Example Usage + +```hcl +data "tencentcloud_mysql_bin_log" "bin_log" { + instance_id = "cdb-fitq5t9h" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, in the format: cdb-c1nl9rpv. Same instance ID as displayed in the ApsaraDB for Console page. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Details of binary log files that meet the query conditions. + * `binlog_finish_time` - binlog file deadline. + * `binlog_start_time` - Binlog file start time. + * `cos_storage_type` - Storage method, 0-regular storage, 1-archive storage, the default is 0. + * `date` - File storage time, time format: 2016-03-17 02:10:37. + * `instance_id` - Instance ID, in the format: cdb-c1nl9rpv. Same instance ID as displayed in the ApsaraDB for Console page. + * `internet_url` - download link. + * `intranet_url` - download link. + * `name` - binlog log backup file name. + * `region` - The region where the local binlog file is located. + * `remote_info` - Binlog remote backup details. + * `finish_time` - End time of remote backup task. + * `region` - The region where remote backup is located. + * `start_time` - Start time of remote backup task. + * `status` - Backup task status. Possible values are `SUCCESS`: backup succeeded, `FAILED`: backup failed, `RUNNING`: backup in progress. + * `sub_backup_id` - The ID of the remote backup subtask. + * `url` - download link. + * `size` - Backup file size, unit: Byte. + * `status` - Backup task status. Possible values are `SUCCESS`: backup succeeded, `FAILED`: backup failed, `RUNNING`: backup in progress. + * `type` - Specific log type, possible values are: binlog - binary log. + + diff --git a/config/docs/d/mysql_binlog_backup_overview.html.markdown b/config/docs/d/mysql_binlog_backup_overview.html.markdown new file mode 100644 index 0000000..c67496c --- /dev/null +++ b/config/docs/d/mysql_binlog_backup_overview.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_binlog_backup_overview" +sidebar_current: "docs-tencentcloud-datasource-mysql_binlog_backup_overview" +description: |- + Use this data source to query detailed information of mysql binlog_backup_overview +--- + +# tencentcloud_mysql_binlog_backup_overview + +Use this data source to query detailed information of mysql binlog_backup_overview + +## Example Usage + +```hcl +data "tencentcloud_mysql_binlog_backup_overview" "binlog_backup_overview" { + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `product` - (Required, String) The type of cloud database product to be queried, currently only supports `mysql`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `binlog_archive_count` - The number of archived log backups. +* `binlog_archive_volume` - Archived log backup capacity (in bytes). +* `binlog_backup_count` - The total number of log backups, including remote log backups. +* `binlog_backup_volume` - Total log backup capacity, including off-site log backup (unit is byte). +* `binlog_standby_count` - The number of standard storage log backups. +* `binlog_standby_volume` - Standard storage log backup capacity (in bytes). +* `remote_binlog_count` - The number of remote log backups. +* `remote_binlog_volume` - Remote log backup capacity (in bytes). + + diff --git a/config/docs/d/mysql_clone_list.html.markdown b/config/docs/d/mysql_clone_list.html.markdown new file mode 100644 index 0000000..b9bb821 --- /dev/null +++ b/config/docs/d/mysql_clone_list.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_clone_list" +sidebar_current: "docs-tencentcloud-datasource-mysql_clone_list" +description: |- + Use this data source to query detailed information of mysql clone_list +--- + +# tencentcloud_mysql_clone_list + +Use this data source to query detailed information of mysql clone_list + +## Example Usage + +```hcl +data "tencentcloud_mysql_clone_list" "clone_list" { + instance_id = "cdb-fitq5t9h" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Query the list of cloning tasks for the specified source instance. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Clone task list. + * `clone_job_id` - Id of the task list corresponding to the clone task. + * `dst_instance_id` - The newly spawned instance Id of the clone task. + * `end_time` - Task end time. + * `new_region_id` - Id of the region where the cloned instance is located. + * `rollback_strategy` - The strategy used by the clone instance includes the following types: timepoint: specify the point-in-time rollback, backupset: specify the backup file rollback. + * `rollback_target_time` - The time point when the clone instance is rolled back. + * `src_instance_id` - The source instance Id of the clone task. + * `src_region_id` - Id of the region where the source instance is located. + * `start_time` - Task start time. + * `task_status` - Task status, including the following status: initial, running, wait_complete, success, failed. + + diff --git a/config/docs/d/mysql_data_backup_overview.html.markdown b/config/docs/d/mysql_data_backup_overview.html.markdown new file mode 100644 index 0000000..abfad3c --- /dev/null +++ b/config/docs/d/mysql_data_backup_overview.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_data_backup_overview" +sidebar_current: "docs-tencentcloud-datasource-mysql_data_backup_overview" +description: |- + Use this data source to query detailed information of mysql data_backup_overview +--- + +# tencentcloud_mysql_data_backup_overview + +Use this data source to query detailed information of mysql data_backup_overview + +## Example Usage + +```hcl +data "tencentcloud_mysql_data_backup_overview" "data_backup_overview" { + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `product` - (Required, String) The type of cloud database product to be queried, currently only supports `mysql`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `auto_backup_count` - The total number of automatic backups in the current region. +* `auto_backup_volume` - The total automatic backup capacity of the current region. +* `data_backup_archive_count` - The total number of archive backups in the current region. +* `data_backup_archive_volume` - The total capacity of the current regional archive backup. +* `data_backup_count` - The total number of data backups in the current region. +* `data_backup_standby_count` - The total number of standard storage backups in the current region. +* `data_backup_standby_volume` - The total backup capacity of the current regional standard storage. +* `data_backup_volume` - Total data backup capacity of the current region (including automatic backup and manual backup, in bytes). +* `manual_backup_count` - The total number of manual backups in the current region. +* `manual_backup_volume` - The total manual backup capacity of the current region. +* `remote_backup_count` - The total number of remote backups. +* `remote_backup_volume` - The total capacity of remote backup. + + diff --git a/config/docs/d/mysql_databases.html.markdown b/config/docs/d/mysql_databases.html.markdown new file mode 100644 index 0000000..1f2ccc6 --- /dev/null +++ b/config/docs/d/mysql_databases.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_databases" +sidebar_current: "docs-tencentcloud-datasource-mysql_databases" +description: |- + Use this data source to query detailed information of mysql databases +--- + +# tencentcloud_mysql_databases + +Use this data source to query detailed information of mysql databases + +## Example Usage + +```hcl +data "tencentcloud_mysql_databases" "databases" { + instance_id = "cdb-c1nl9rpv" + database_regexp = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of instance. +* `database_regexp` - (Optional, String) Regular expression to match database library names. +* `limit` - (Optional, Int) The number of single requests, the default value is 20, the minimum value is 1, and the maximum value is 100. +* `offset` - (Optional, Int) Page offset. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `database_list` - Database name and character set. + * `character_set` - character set type. + * `database_name` - The name of database. +* `items` - Returned instance information. + + diff --git a/config/docs/d/mysql_db_features.html.markdown b/config/docs/d/mysql_db_features.html.markdown new file mode 100644 index 0000000..dcac7f5 --- /dev/null +++ b/config/docs/d/mysql_db_features.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_db_features" +sidebar_current: "docs-tencentcloud-datasource-mysql_db_features" +description: |- + Use this data source to query detailed information of mysql db_features +--- + +# tencentcloud_mysql_db_features + +Use this data source to query detailed information of mysql db_features + +## Example Usage + +```hcl +data "tencentcloud_mysql_db_features" "db_features" { + instance_id = "cdb-fitq5t9h" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, the format is: cdb-c1nl9rpv or cdbro-c1nl9rpv, which is the same as the instance ID displayed on the cloud database console page. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `audit_need_upgrade` - Whether to enable auditing needs to upgrade the kernel version. +* `current_sub_version` - Current kernel version. +* `encryption_need_upgrade` - Whether to enable encryption needs to upgrade the kernel version. +* `is_remote_ro` - Whether it is a remote read-only instance. +* `is_support_audit` - Whether to support the database audit function. +* `is_support_encryption` - Whether to support the database encryption function. +* `is_support_update_sub_version` - Whether to support minor version upgrades. +* `master_region` - The region where the master instance is located. +* `target_sub_version` - Available kernel versions for upgrade. + + diff --git a/config/docs/d/mysql_default_params.html.markdown b/config/docs/d/mysql_default_params.html.markdown new file mode 100644 index 0000000..20f1f94 --- /dev/null +++ b/config/docs/d/mysql_default_params.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_default_params" +sidebar_current: "docs-tencentcloud-datasource-mysql_default_params" +description: |- + Provide a datasource to query default mysql parameters. +--- + +# tencentcloud_mysql_default_params + +Provide a datasource to query default mysql parameters. + +## Example Usage + +```hcl +resource "tencentcloud_mysql_default_params" "mysql_57" { + db_version = "5.7" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_version` - (Optional, String) MySQL database version. +* `result_output_file` - (Optional, String) Used for save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `param_list` - List of param detail. + * `current_value` - Param current value. + * `default` - Param default value. + * `description` - Param description. + * `enum_value` - Params available values if type of param is enum. + * `max` - Param maximum value if type of param is integer. + * `min` - Param minimum value if type of param is integer. + * `name` - Param key name. + * `need_reboot` - Indicates weather the database instance reboot if param modified. + * `param_type` - Type of param. + + diff --git a/config/docs/d/mysql_error_log.html.markdown b/config/docs/d/mysql_error_log.html.markdown new file mode 100644 index 0000000..e51835b --- /dev/null +++ b/config/docs/d/mysql_error_log.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_error_log" +sidebar_current: "docs-tencentcloud-datasource-mysql_error_log" +description: |- + Use this data source to query detailed information of mysql error_log +--- + +# tencentcloud_mysql_error_log + +Use this data source to query detailed information of mysql error_log + +## Example Usage + +```hcl +data "tencentcloud_mysql_error_log" "error_log" { + instance_id = "cdb-fitq5t9h" + start_time = 1683538307 + end_time = 1686043908 + key_words = ["Shutting"] + inst_type = "slave" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End timestamp. For example 1585142640. +* `instance_id` - (Required, String) instance id. +* `start_time` - (Required, Int) Start timestamp. For example 1585142640. +* `inst_type` - (Optional, String) Only valid when the instance is the master instance or disaster recovery instance, the optional value: slave, which means to pull the log of the slave machine. +* `key_words` - (Optional, Set: [`String`]) A list of keywords to match, up to 15 keywords are supported. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - The records returned. + * `content` - error details. + * `timestamp` - The time the error occurred. + + diff --git a/config/docs/d/mysql_inst_tables.html.markdown b/config/docs/d/mysql_inst_tables.html.markdown new file mode 100644 index 0000000..7adc2b1 --- /dev/null +++ b/config/docs/d/mysql_inst_tables.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_inst_tables" +sidebar_current: "docs-tencentcloud-datasource-mysql_inst_tables" +description: |- + Use this data source to query detailed information of mysql inst_tables +--- + +# tencentcloud_mysql_inst_tables + +Use this data source to query detailed information of mysql inst_tables + +## Example Usage + +```hcl +data "tencentcloud_mysql_inst_tables" "inst_tables" { + instance_id = "cdb-fitq5t9h" + database = "tf_ci_test" + # table_regexp = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `database` - (Required, String) The name of the database. +* `instance_id` - (Required, String) The instance ID, in the format: cdb-c1nl9rpv, is the same as the instance ID displayed on the cloud database console page. +* `result_output_file` - (Optional, String) Used to save results. +* `table_regexp` - (Optional, String) Match the regular expression of the database table name, the rules are the same as MySQL official website. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - The returned database table information. + + diff --git a/config/docs/d/mysql_instance.html.markdown b/config/docs/d/mysql_instance.html.markdown new file mode 100644 index 0000000..3e56da8 --- /dev/null +++ b/config/docs/d/mysql_instance.html.markdown @@ -0,0 +1,79 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_instance" +sidebar_current: "docs-tencentcloud-datasource-mysql_instance" +description: |- + Use this data source to get information about a MySQL instance. +--- + +# tencentcloud_mysql_instance + +Use this data source to get information about a MySQL instance. + +## Example Usage + +```hcl +data "tencentcloud_mysql_instance" "mysql" { + mysql_id = "cdb-fitq5t9h" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `charge_type` - (Optional, String) Pay type of instance, valid values are `PREPAID` and `POSTPAID`. +* `engine_version` - (Optional, String) The version number of the database engine to use. Supported versions include 5.5/5.6/5.7/8.0. +* `init_flag` - (Optional, Int) Initialization mark. Available values: `0` - Uninitialized; `1` - Initialized. +* `instance_name` - (Optional, String) Name of mysql instance. +* `instance_role` - (Optional, String) Instance type. Supported values include: `master` - master instance, `dr` - disaster recovery instance, and `ro` - read-only instance. +* `limit` - (Optional, Int) Number of results returned for a single request. Default is `20`, and maximum is 2000. +* `mysql_id` - (Optional, String) Instance ID, such as `cdb-c1nl9rpv`. It is identical to the instance ID displayed in the database console page. +* `offset` - (Optional, Int) Record offset. Default is 0. +* `pay_type` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.36.0. Please use `charge_type` instead. Pay type of instance, `0`: prepay, `1`: postpaid. +* `result_output_file` - (Optional, String) Used to store results. +* `security_group_id` - (Optional, String) Security groups ID of instance. +* `status` - (Optional, Int) Instance status. Available values: `0` - Creating; `1` - Running; `4` - Isolating; `5` - Isolated. +* `with_dr` - (Optional, Int) Indicates whether to query disaster recovery instances. +* `with_master` - (Optional, Int) Indicates whether to query master instances. +* `with_ro` - (Optional, Int) Indicates whether to query read-only instances. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - A list of instances. Each element contains the following attributes: + * `auto_renew_flag` - Auto renew flag. NOTES: Only supported prepay instance. + * `charge_type` - Pay type of instance. + * `cpu_core_count` - CPU count. + * `create_time` - The time at which a instance is created. + * `dead_line_time` - Expire date of instance. NOTES: Only supported prepay instance. + * `device_type` - Supported instance model. `HA` - high available version; `Basic` - basic version. + * `dr_instance_ids` - ID list of disaster-recovery type associated with the current instance. + * `engine_version` - The version number of the database engine to use. Supported versions include `5.5`/`5.6`/`5.7`/`8.0`. + * `init_flag` - Initialization mark. Available values: `0` - Uninitialized; `1` - Initialized. + * `instance_name` - Name of mysql instance. + * `instance_role` - Instance type. Supported values include: `master` - master instance, `dr` - disaster recovery instance, and `ro` - read-only instance. + * `internet_host` - Public network domain name. + * `internet_port` - Public network port. + * `internet_status` - Status of public network. + * `intranet_ip` - Instance IP for internal access. + * `intranet_port` - Transport layer port number for internal purpose. + * `master_instance_id` - Indicates the master instance ID of recovery instances. + * `memory_size` - Memory size (in MB). + * `mysql_id` - Instance ID, such as `cdb-c1nl9rpv`. It is identical to the instance ID displayed in the database console page. + * `pay_type` - Pay type of instance, `0`: prepaid, `1`: postpaid. + * `project_id` - Project ID to which the current instance belongs. + * `ro_groups` - read-only instance group. + * `group_id` - Group ID, such as `cdbrg-pz7vg37p`. + * `instance_ids` - ID list of read-only type associated with the current instance. + * `ro_instance_ids` - ID list of read-only type associated with the current instance. + * `slave_sync_mode` - Data replication mode. `0` - Async replication; `1` - Semisync replication; `2` - Strongsync replication. + * `status` - Instance status. Available values: `0` - Creating; `1` - Running; `4` - Isolating; `5` - Isolated. + * `subnet_id` - ID of subnet to which the current instance belongs. + * `volume_size` - Disk capacity (in GB). + * `vpc_id` - ID of Virtual Private Cloud. + * `zone` - Information of available zone. + + diff --git a/config/docs/d/mysql_instance_charset.html.markdown b/config/docs/d/mysql_instance_charset.html.markdown new file mode 100644 index 0000000..9f6145a --- /dev/null +++ b/config/docs/d/mysql_instance_charset.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_instance_charset" +sidebar_current: "docs-tencentcloud-datasource-mysql_instance_charset" +description: |- + Use this data source to query detailed information of mysql instance_charset +--- + +# tencentcloud_mysql_instance_charset + +Use this data source to query detailed information of mysql instance_charset + +## Example Usage + +```hcl +data "tencentcloud_mysql_instance_charset" "instance_charset" { + instance_id = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, the format is: cdb-c1nl9rpv, which is the same as the instance ID displayed on the cloud database console page, and you can use the [query instance list] (https://cloud.tencent.com/document/api/236/15872) interface Gets the value of the field InstanceId in the output parameter. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `charset` - The default character set of the instance, such as `latin1`, `utf8` etc. + + diff --git a/config/docs/d/mysql_instance_info.html.markdown b/config/docs/d/mysql_instance_info.html.markdown new file mode 100644 index 0000000..be59516 --- /dev/null +++ b/config/docs/d/mysql_instance_info.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_instance_info" +sidebar_current: "docs-tencentcloud-datasource-mysql_instance_info" +description: |- + Use this data source to query detailed information of mysql instance_info +--- + +# tencentcloud_mysql_instance_info + +Use this data source to query detailed information of mysql instance_info + +## Example Usage + +```hcl +data "tencentcloud_mysql_instance_info" "instance_info" { + instance_id = "cdb-fitq5t9h" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `default_kms_region` - The default region of the KMS service used by the current CDB backend service. +* `encryption` - Whether to enable encryption, YES is enabled, NO is not enabled. +* `instance_name` - instance name. +* `key_id` - The key ID used for encryption. +* `key_region` - The region where the key is located. + + diff --git a/config/docs/d/mysql_instance_param_record.html.markdown b/config/docs/d/mysql_instance_param_record.html.markdown new file mode 100644 index 0000000..30572b2 --- /dev/null +++ b/config/docs/d/mysql_instance_param_record.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_instance_param_record" +sidebar_current: "docs-tencentcloud-datasource-mysql_instance_param_record" +description: |- + Use this data source to query detailed information of mysql instance_param_record +--- + +# tencentcloud_mysql_instance_param_record + +Use this data source to query detailed information of mysql instance_param_record + +## Example Usage + +```hcl +data "tencentcloud_mysql_instance_param_record" "instance_param_record" { + instance_id = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, the format is: cdb-c1nl9rpv, which is the same as the instance ID displayed on the cloud database console page, and you can use the [query instance list] (https://cloud.tencent.com/document/api/236/15872) interface Gets the value of the field InstanceId in the output parameter. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Parameter modification record. + * `instance_id` - instance id. + * `is_success` - Whether the parameter is modified successfully. + * `modify_time` - Change the time. + * `new_value` - The modified value of the parameter. + * `old_value` - The value of the parameter before modification. + * `param_name` - parameter name. + + diff --git a/config/docs/d/mysql_instance_reboot_time.html.markdown b/config/docs/d/mysql_instance_reboot_time.html.markdown new file mode 100644 index 0000000..bf31ca0 --- /dev/null +++ b/config/docs/d/mysql_instance_reboot_time.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_instance_reboot_time" +sidebar_current: "docs-tencentcloud-datasource-mysql_instance_reboot_time" +description: |- + Use this data source to query detailed information of mysql instance_reboot_time +--- + +# tencentcloud_mysql_instance_reboot_time + +Use this data source to query detailed information of mysql instance_reboot_time + +## Example Usage + +```hcl +data "tencentcloud_mysql_instance_reboot_time" "instance_reboot_time" { + instance_ids = ["cdb-fitq5t9h"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_ids` - (Required, Set: [`String`]) The instance ID, in the format: cdb-c1nl9rpv, is the same as the instance ID displayed on the cloud database console page. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Returned parameter information. + * `instance_id` - Instance ID, the format is: cdb-c1nl9rpv, which is the same as the instance ID displayed on the cloud database console page. + * `time_in_seconds` - expected restart time. + + diff --git a/config/docs/d/mysql_parameter_list.html.markdown b/config/docs/d/mysql_parameter_list.html.markdown new file mode 100644 index 0000000..37a7712 --- /dev/null +++ b/config/docs/d/mysql_parameter_list.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_parameter_list" +sidebar_current: "docs-tencentcloud-datasource-mysql_parameter_list" +description: |- + Use this data source to get information about a parameter group of a database instance. +--- + +# tencentcloud_mysql_parameter_list + +Use this data source to get information about a parameter group of a database instance. + +## Example Usage + +```hcl +data "tencentcloud_mysql_parameter_list" "mysql" { + mysql_id = "terraform-test-local-database" + engine_version = "5.5" + result_output_file = "mytestpath" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `engine_version` - (Optional, String) The version number of the database engine to use. Supported versions include 5.5/5.6/5.7/8.0. +* `mysql_id` - (Optional, String) Instance ID. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `parameter_list` - A list of parameters. Each element contains the following attributes: + * `current_value` - Current value. + * `default_value` - Default value. + * `description` - Parameter specification description. + * `enum_value` - Enumerated value. + * `max` - Maximum value for the parameter. + * `min` - Minimum value for the parameter. + * `need_reboot` - Indicates whether reboot is needed to enable the new parameters. + * `parameter_name` - Parameter name. + * `parameter_type` - Parameter type. + + diff --git a/config/docs/d/mysql_project_security_group.html.markdown b/config/docs/d/mysql_project_security_group.html.markdown new file mode 100644 index 0000000..32cb2c6 --- /dev/null +++ b/config/docs/d/mysql_project_security_group.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_project_security_group" +sidebar_current: "docs-tencentcloud-datasource-mysql_project_security_group" +description: |- + Use this data source to query detailed information of mysql project_security_group +--- + +# tencentcloud_mysql_project_security_group + +Use this data source to query detailed information of mysql project_security_group + +## Example Usage + +```hcl +data "tencentcloud_mysql_project_security_group" "project_security_group" { + project_id = 1250480 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Optional, Int) project id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `groups` - Security group details. + * `create_time` - Creation time, time format: yyyy-mm-dd hh:mm:sss. + * `inbound` - inbound rules. + * `action` - Policy, ACCEPT or DROPs. + * `cidr_ip` - Source IP or IP range, such as 192.168.0.0/16. + * `desc` - Rule description. + * `dir` - The direction defined by the rule, the inbound rule is INPUT. + * `ip_protocol` - Network protocol, support UDP, TCP, etc. + * `port_range` - port. + * `outbound` - outbound rules. + * `action` - Policy, ACCEPT or DROP. + * `cidr_ip` - Destination IP or IP segment, such as 172.16.0.0/12. + * `desc` - Rule description. + * `dir` - The direction defined by the rule, the inbound rule is OUTPUT. + * `ip_protocol` - Network protocol, support UDP, TCP, etc. + * `port_range` - port or port range. + * `project_id` - project id. + * `security_group_id` - Security group ID. + * `security_group_name` - Security group name. + * `security_group_remark` - Security group remark. + + diff --git a/config/docs/d/mysql_ro_min_scale.html.markdown b/config/docs/d/mysql_ro_min_scale.html.markdown new file mode 100644 index 0000000..247d686 --- /dev/null +++ b/config/docs/d/mysql_ro_min_scale.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_ro_min_scale" +sidebar_current: "docs-tencentcloud-datasource-mysql_ro_min_scale" +description: |- + Use this data source to query detailed information of mysql ro_min_scale +--- + +# tencentcloud_mysql_ro_min_scale + +Use this data source to query detailed information of mysql ro_min_scale + +## Example Usage + +```hcl +data "tencentcloud_mysql_ro_min_scale" "ro_min_scale" { + # ro_instance_id = "" + master_instance_id = "cdb-fitq5t9h" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `master_instance_id` - (Optional, String) The primary instance ID, in the format: cdb-c1nl9rpv, is the same as the instance ID displayed on the cloud database console page. This parameter and the RoInstanceId parameter cannot be empty at the same time. Note that when the input parameter contains RoInstanceId, the return value is the minimum specification when the read-only instance is upgraded; when the input parameter only contains MasterInstanceId, the return value is the minimum specification when the read-only instance is purchased. +* `result_output_file` - (Optional, String) Used to save results. +* `ro_instance_id` - (Optional, String) The read-only instance ID, in the format: cdbro-c1nl9rpv, is the same as the instance ID displayed on the cloud database console page. This parameter and the MasterInstanceId parameter cannot be empty at the same time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `memory` - Memory specification size, unit: MB. +* `volume` - Disk specification size, unit: GB. + + diff --git a/config/docs/d/mysql_rollback_range_time.html.markdown b/config/docs/d/mysql_rollback_range_time.html.markdown new file mode 100644 index 0000000..823dda4 --- /dev/null +++ b/config/docs/d/mysql_rollback_range_time.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_rollback_range_time" +sidebar_current: "docs-tencentcloud-datasource-mysql_rollback_range_time" +description: |- + Use this data source to query detailed information of mysql rollback_range_time +--- + +# tencentcloud_mysql_rollback_range_time + +Use this data source to query detailed information of mysql rollback_range_time + +## Example Usage + +```hcl +data "tencentcloud_mysql_rollback_range_time" "rollback_range_time" { + instance_ids = ["cdb-fitq5t9h"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_ids` - (Required, Set: [`String`]) A list of instance IDs, the format of a single instance ID is: cdb-c1nl9rpv. Same instance ID as displayed in the ApsaraDB for Console page. +* `backup_region` - (Optional, String) If the clone instance is not in the same region as the source instance, fill in the region where the clone instance is located, for example: ap-guangzhou. +* `is_remote_zone` - (Optional, String) Whether the clone instance is in the same zone as the source instance, yes: `false`, no: `true`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Returned parameter information. + * `code` - Query database error code. + * `instance_id` - A list of instance IDs. The format of a single instance ID is: cdb-c1nl9rpv. Same as the instance ID displayed in the cloud database console page. + * `message` - Query database error information. + * `times` - Retrievable time range. + * `begin` - Instance rollback start time, time format: 2016-10-29 01:06:04. + * `end` - End time of instance rollback, time format: 2016-11-02 11:44:47. + + diff --git a/config/docs/d/mysql_slow_log.html.markdown b/config/docs/d/mysql_slow_log.html.markdown new file mode 100644 index 0000000..a1bfb1b --- /dev/null +++ b/config/docs/d/mysql_slow_log.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_slow_log" +sidebar_current: "docs-tencentcloud-datasource-mysql_slow_log" +description: |- + Use this data source to query detailed information of mysql slow_log +--- + +# tencentcloud_mysql_slow_log + +Use this data source to query detailed information of mysql slow_log + +## Example Usage + +```hcl +data "tencentcloud_mysql_slow_log" "slow_log" { + instance_id = "cdb-fitq5t9h" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, in the format: cdb-c1nl9rpv. Same instance ID as displayed in the ApsaraDB for Console page. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Details of slow query logs that meet the query conditions. + * `date` - Backup snapshot time, time format: 2016-03-17 02:10:37. + * `internet_url` - External network download address. + * `intranet_url` - Intranet download address. + * `name` - backup file name. + * `size` - Backup file size, unit: Byte. + * `type` - Log specific type, possible values: slowlog - slow log. + + diff --git a/config/docs/d/mysql_slow_log_data.html.markdown b/config/docs/d/mysql_slow_log_data.html.markdown new file mode 100644 index 0000000..888b1db --- /dev/null +++ b/config/docs/d/mysql_slow_log_data.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_slow_log_data" +sidebar_current: "docs-tencentcloud-datasource-mysql_slow_log_data" +description: |- + Use this data source to query detailed information of mysql slow_log_data +--- + +# tencentcloud_mysql_slow_log_data + +Use this data source to query detailed information of mysql slow_log_data + +## Example Usage + +```hcl +data "tencentcloud_mysql_slow_log_data" "slow_log_data" { + instance_id = "cdb-fitq5t9h" + start_time = 1682664459 + end_time = 1684392459 + user_hosts = ["169.254.128.158"] + user_names = ["keep_dts"] + data_bases = ["tf_ci_test"] + sort_by = "Timestamp" + order_by = "ASC" + inst_type = "slave" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End timestamp. For example 1585142640. +* `instance_id` - (Required, String) instance id. +* `start_time` - (Required, Int) Start timestamp. For example 1585142640. +* `data_bases` - (Optional, Set: [`String`]) List of databases accessed. +* `inst_type` - (Optional, String) Only valid when the instance is the master instance or disaster recovery instance, the optional value: slave, which means to pull the log of the slave machine. +* `order_by` - (Optional, String) Sort in ascending or descending order. Currently supported: ASC,DESC. +* `result_output_file` - (Optional, String) Used to save results. +* `sort_by` - (Optional, String) Sort field. Currently supported: Timestamp, QueryTime, LockTime, RowsExamined, RowsSent. +* `user_hosts` - (Optional, Set: [`String`]) List of client hosts. +* `user_names` - (Optional, Set: [`String`]) A list of client usernames. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Query records. + * `database` - database name. + * `lock_time` - Lock duration (seconds). + * `md5` - The md5 of the Sql statement. + * `query_time` - Sql execution time (seconds). + * `rows_examined` - The number of rows to scan. + * `rows_sent` - The number of rows in the result set. + * `sql_template` - Sql template. + * `sql_text` - Sql statement. + * `timestamp` - Sql execution time. + * `user_host` - client address. + * `user_name` - user name. + + diff --git a/config/docs/d/mysql_supported_privileges.html.markdown b/config/docs/d/mysql_supported_privileges.html.markdown new file mode 100644 index 0000000..9f8b50e --- /dev/null +++ b/config/docs/d/mysql_supported_privileges.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_supported_privileges" +sidebar_current: "docs-tencentcloud-datasource-mysql_supported_privileges" +description: |- + Use this data source to query detailed information of mysql supported_privileges +--- + +# tencentcloud_mysql_supported_privileges + +Use this data source to query detailed information of mysql supported_privileges + +## Example Usage + +```hcl +data "tencentcloud_mysql_supported_privileges" "supported_privileges" { + instance_id = "cdb-fitq5t9h" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The instance ID, in the format: cdb-c1nl9rpv, is the same as the instance ID displayed on the cloud database console page. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `column_supported_privileges` - The database column permissions supported by the instance. +* `database_supported_privileges` - Database permissions supported by the instance. +* `global_supported_privileges` - Global permissions supported by the instance. +* `table_supported_privileges` - Database table permissions supported by the instance. + + diff --git a/config/docs/d/mysql_switch_record.html.markdown b/config/docs/d/mysql_switch_record.html.markdown new file mode 100644 index 0000000..698497b --- /dev/null +++ b/config/docs/d/mysql_switch_record.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_switch_record" +sidebar_current: "docs-tencentcloud-datasource-mysql_switch_record" +description: |- + Use this data source to query detailed information of mysql switch_record +--- + +# tencentcloud_mysql_switch_record + +Use this data source to query detailed information of mysql switch_record + +## Example Usage + +```hcl +data "tencentcloud_mysql_switch_record" "switch_record" { + instance_id = "cdb-fitq5t9h" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, the format is: cdb-c1nl9rpv or cdbro-c1nl9rpv, which is the same as the instance ID displayed on the cloud database console page. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Instance switching record details. + * `switch_time` - Switching time, the format is: 2017-09-03 01:34:31. + * `switch_type` - Switch type, possible return values: TRANSFER - data migration; MASTER2SLAVE - master-standby switch; RECOVERY - master-slave recovery. + + diff --git a/config/docs/d/mysql_user_task.html.markdown b/config/docs/d/mysql_user_task.html.markdown new file mode 100644 index 0000000..ff56f7b --- /dev/null +++ b/config/docs/d/mysql_user_task.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_user_task" +sidebar_current: "docs-tencentcloud-datasource-mysql_user_task" +description: |- + Use this data source to query detailed information of mysql user_task +--- + +# tencentcloud_mysql_user_task + +Use this data source to query detailed information of mysql user_task + +## Example Usage + +```hcl +data "tencentcloud_mysql_user_task" "user_task" { + instance_id = "cdb-fitq5t9h" + async_request_id = "f2fe828c-773af816-0a08f542-94bb2a9c" + task_types = [5] + task_status = [2] + start_time_begin = "2017-12-31 10:40:01" + start_time_end = "2017-12-31 10:40:01" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `async_request_id` - (Optional, String) Asynchronous task request ID, the AsyncRequestId returned by executing cloud database-related operations. +* `instance_id` - (Optional, String) Instance ID, the format is: cdb-c1nl9rpv, which is the same as the instance ID displayed on the cloud database console page, and you can use the [query instance list] (https://cloud.tencent.com/document/api/236/15872) interface Gets the value of the field InstanceId in the output parameter. +* `result_output_file` - (Optional, String) Used to save results. +* `start_time_begin` - (Optional, String) The start time of the first task, used for range query, the time format is as follows: 2017-12-31 10:40:01. +* `start_time_end` - (Optional, String) The start time of the last task, used for range query, the time format is as follows: 2017-12-31 10:40:01. +* `task_status` - (Optional, Set: [`String`]) Task status. If no value is passed, all task statuses will be queried. Supported values include: `UNDEFINED` - undefined; `INITIAL` - initialization; `RUNNING` - running; `SUCCEED` - the execution was successful; `FAILED` - execution failed; `KILLED` - terminated; `REMOVED` - removed; `PAUSED` - Paused. +* `task_types` - (Optional, Set: [`String`]) Task type. If no value is passed, all task types will be queried. Supported values include: `ROLLBACK` - database rollback; `SQL OPERATION` - SQL operation; `IMPORT DATA` - data import; `MODIFY PARAM` - parameter setting; `INITIAL` - initialize the cloud database instance; `REBOOT` - restarts the cloud database instance; `OPEN GTID` - open the cloud database instance GTID; `UPGRADE RO` - read-only instance upgrade; `BATCH ROLLBACK` - database batch rollback; `UPGRADE MASTER` - master upgrade; `DROP TABLES` - delete cloud database tables; `SWITCH DR TO MASTER` - The disaster recovery instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - The returned instance task information. + * `async_request_id` - The request ID of the asynchronous task. + * `code` - error code. + * `end_time` - Instance task end time. + * `instance_ids` - The instance ID associated with the task. Note: This field may return null, indicating that no valid value can be obtained. + * `job_id` - Instance task ID. + * `message` - error message. + * `progress` - Instance task progress. + * `start_time` - Instance task start time. + * `task_status` - Instance task status, possible values include:UNDEFINED - undefined;INITIAL - initialization;RUNNING - running;SUCCEED - the execution was successful;FAILED - execution failed;KILLED - terminated;REMOVED - removed;PAUSED - Paused.WAITING - waiting (cancellable). + * `task_type` - Instance task type, possible values include:ROLLBACK - database rollback;SQL OPERATION - SQL operation;IMPORT DATA - data import;MODIFY PARAM - parameter setting;INITIAL - initialize the cloud database instance;REBOOT - restarts the cloud database instance;OPEN GTID - open the cloud database instance GTID;UPGRADE RO - read-only instance upgrade;BATCH ROLLBACK - database batch rollback;UPGRADE MASTER - master upgrade;DROP TABLES - delete cloud database tables;SWITCH DR TO MASTER - The disaster recovery instance. + + diff --git a/config/docs/d/mysql_zone_config.html.markdown b/config/docs/d/mysql_zone_config.html.markdown new file mode 100644 index 0000000..28ccb55 --- /dev/null +++ b/config/docs/d/mysql_zone_config.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_zone_config" +sidebar_current: "docs-tencentcloud-datasource-mysql_zone_config" +description: |- + Use this data source to query the available database specifications for different regions. And a maximum of 20 requests can be initiated per second for this query. +--- + +# tencentcloud_mysql_zone_config + +Use this data source to query the available database specifications for different regions. And a maximum of 20 requests can be initiated per second for this query. + +## Example Usage + +```hcl +data "tencentcloud_mysql_zone_config" "mysql" { + region = "ap-guangzhou" + result_output_file = "mytestpath" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `region` - (Optional, String) Region parameter, which is used to identify the region to which the data you want to work with belongs. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of zone config. Each element contains the following attributes: + * `disaster_recovery_zones` - Information about available zones of recovery. + * `engine_versions` - The version number of the database engine to use. Supported versions include `5.5`/`5.6`/`5.7`. + * `first_slave_zones` - Zone information about first slave instance. + * `is_default` - Indicates whether the current DC is the default DC for the region. Possible returned values: `0` - no; `1` - yes. + * `is_support_disaster_recovery` - Indicates whether recovery is supported: `0` - No; `1` - Yes. + * `is_support_vpc` - Indicates whether VPC is supported: `0` - No; `1` - Yes. + * `name` - The name of available zone which is equal to a specific datacenter. + * `remote_ro_zones` - Zone information about remote ro instance. + * `second_slave_zones` - Zone information about second slave instance. + * `sells` - A list of supported instance types for sell: + * `cdb_type` - Instance type, the possible value ranges are: `UNIVERSAL` (universal type), `EXCLUSIVE` (exclusive type), `BASIC` (basic type), `BASIC_V2` (basic type v2). + * `cpu` - Number of CPU cores. + * `info` - Application Scenario Description. + * `max_volume_size` - Maximum disk size (in GB). + * `mem_size` - Memory size (in MB). + * `min_volume_size` - Minimum disk size (in GB). + * `qps` - Queries per second. + * `volume_step` - Disk increment (in GB). + * `slave_deploy_modes` - Availability zone deployment method. Available values: `0` - Single availability zone; `1` - Multiple availability zones. + * `support_slave_sync_modes` - Data replication mode. `0` - Async replication; `1` - Semisync replication; `2` - Strongsync replication. + + diff --git a/config/docs/d/nat_dc_route.html.markdown b/config/docs/d/nat_dc_route.html.markdown new file mode 100644 index 0000000..0f8c11e --- /dev/null +++ b/config/docs/d/nat_dc_route.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_nat_dc_route" +sidebar_current: "docs-tencentcloud-datasource-nat_dc_route" +description: |- + Use this data source to query detailed information of vpc nat_dc_route +--- + +# tencentcloud_nat_dc_route + +Use this data source to query detailed information of vpc nat_dc_route + +## Example Usage + +```hcl +data "tencentcloud_nat_dc_route" "nat_dc_route" { + nat_gateway_id = "nat-gnxkey2e" + vpc_id = "vpc-pyyv5k3v" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `nat_gateway_id` - (Required, String) Unique identifier of Nat Gateway. +* `vpc_id` - (Required, String) Unique identifier of Vpc. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `nat_direct_connect_gateway_route_set` - Data of route. + * `create_time` - Create time of route. + * `destination_cidr_block` - IPv4 CIDR of subnet. + * `gateway_id` - Id of next-hop gateway. + * `gateway_type` - Type of next-hop gateway, valid values: DIRECTCONNECT. + * `update_time` - Update time of route. + + diff --git a/config/docs/d/nat_gateway_snats.html.markdown b/config/docs/d/nat_gateway_snats.html.markdown new file mode 100644 index 0000000..9ede1ef --- /dev/null +++ b/config/docs/d/nat_gateway_snats.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_nat_gateway_snats" +sidebar_current: "docs-tencentcloud-datasource-nat_gateway_snats" +description: |- + Use this data source to query detailed information of VPN gateways. +--- + +# tencentcloud_nat_gateway_snats + +Use this data source to query detailed information of VPN gateways. + +## Example Usage + +```hcl +data "tencentcloud_nat_gateway_snats" "snat" { + nat_gateway_id = tencentcloud_nat_gateway.my_nat.id + subnet_id = tencentcloud_nat_gateway_snat.my_subnet.id + public_ip_addr = ["50.29.23.234"] + description = "snat demo" + result_output_file = "./snat.txt" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `nat_gateway_id` - (Required, String) NAT gateway ID. +* `description` - (Optional, String) Description. +* `instance_id` - (Optional, String) Instance ID. +* `public_ip_addr` - (Optional, List: [`String`]) Elastic IP address pool. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) Subnet instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `snat_list` - Information list of the nat gateway snat. + * `create_time` - Create time. + * `snat_id` - SNAT rule ID. + + diff --git a/config/docs/d/nat_gateways.html.markdown b/config/docs/d/nat_gateways.html.markdown new file mode 100644 index 0000000..b4775b0 --- /dev/null +++ b/config/docs/d/nat_gateways.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_nat_gateways" +sidebar_current: "docs-tencentcloud-datasource-nat_gateways" +description: |- + Use this data source to query detailed information of NAT gateways. +--- + +# tencentcloud_nat_gateways + +Use this data source to query detailed information of NAT gateways. + +## Example Usage + +```hcl +data "tencentcloud_nat_gateways" "foo" { + name = "main" + vpc_id = "vpc-xfqag" + id = "nat-xfaq1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the NAT gateway. +* `name` - (Optional, String) Name of the NAT gateway. +* `result_output_file` - (Optional, String) Used to save results. +* `vpc_id` - (Optional, String) ID of the VPC. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `nats` - Information list of the dedicated NATs. + * `assigned_eip_set` - EIP IP address set bound to the gateway. The value of at least 1. + * `bandwidth` - The maximum public network output bandwidth of NAT gateway (unit: Mbps), the available values include: 20,50,100,200,500,1000,2000,5000. Default is 100. + * `create_time` - Create time of the NAT gateway. + * `id` - ID of the NAT gateway. + * `max_concurrent` - The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000. + * `name` - Name of the NAT gateway. + * `state` - State of the NAT gateway. + * `tags` - The available tags within this NAT gateway. + * `vpc_id` - ID of the VPC. + + diff --git a/config/docs/d/nats.html.markdown b/config/docs/d/nats.html.markdown new file mode 100644 index 0000000..9dfe84e --- /dev/null +++ b/config/docs/d/nats.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_nats" +sidebar_current: "docs-tencentcloud-datasource-nats" +description: |- + The NATs data source lists a number of NATs resource information owned by an TencentCloud account. +--- + +# tencentcloud_nats + +The NATs data source lists a number of NATs resource information owned by an TencentCloud account. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_nat_gateways. + +## Example Usage + +```hcl +# Query the NAT gateway by ID +data "tencentcloud_nats" "anat" { + id = "nat-k6ualnp2" +} + +# Query the list of normal NAT gateways +data "tencentcloud_nats" "nat_state" { + state = 0 +} + +# Multi conditional query NAT gateway list +data "tencentcloud_nats" "multi_nat" { + name = "terraform test" + vpc_id = "vpc-ezij4ltv" + max_concurrent = 3000000 + bandwidth = 500 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bandwidth` - (Optional, Int) The maximum public network output bandwidth of the gateway (unit: Mbps), for example: `10`, `20`, `50`, `100`, `200`, `500`, `1000`, `2000`, `5000`. +* `id` - (Optional, String) The ID for NAT Gateway. +* `max_concurrent` - (Optional, Int) The upper limit of concurrent connection of NAT gateway, for example: `1000000`, `3000000`, `10000000`. +* `name` - (Optional, String) The name for NAT Gateway. +* `state` - (Optional, Int) NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service. +* `vpc_id` - (Optional, String) The VPC ID for NAT Gateway. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `nats` - Information list of the dedicated tunnels. + * `assigned_eip_set` - Elastic IP arrays bound to the gateway. + * `bandwidth` - The maximum public network output bandwidth of the gateway (unit: Mbps), for example: `10`, `20`, `50`, `100`, `200`, `500`, `1000`, `2000`, `5000`. + * `create_time` - The create time of the NAT gateway. + * `id` - The ID for NAT Gateway. + * `max_concurrent` - The upper limit of concurrent connection of NAT gateway, for example: `1000000`, `3000000`, `10000000`. + * `name` - The name for NAT Gateway. + * `state` - NAT gateway status, `0`: Running, `1`: Unavailable, `2`: Be in arrears and out of service. + * `vpc_id` - The VPC ID for NAT Gateway. + + diff --git a/config/docs/d/oceanus_check_savepoint.html.markdown b/config/docs/d/oceanus_check_savepoint.html.markdown new file mode 100644 index 0000000..7854b59 --- /dev/null +++ b/config/docs/d/oceanus_check_savepoint.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_check_savepoint" +sidebar_current: "docs-tencentcloud-datasource-oceanus_check_savepoint" +description: |- + Use this data source to query detailed information of oceanus check_savepoint +--- + +# tencentcloud_oceanus_check_savepoint + +Use this data source to query detailed information of oceanus check_savepoint + +## Example Usage + +```hcl +data "tencentcloud_oceanus_check_savepoint" "example" { + job_id = "cql-314rw6w0" + serial_id = "svp-52xkpymp" + record_type = 1 + savepoint_path = "cosn://52xkpymp-12345/12345/10000/cql-12345/2/flink-savepoints/savepoint-000000-12334" + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String) Job id. +* `record_type` - (Required, Int) Snapshot type. 1:savepoint; 2:checkpoint; 3:cancelWithSavepoint. +* `savepoint_path` - (Required, String) Snapshot path, currently only supports COS path. +* `serial_id` - (Required, String) Snapshot resource ID. +* `work_space_id` - (Required, String) Workspace ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `savepoint_status` - 1=available, 2=unavailable. + + diff --git a/config/docs/d/oceanus_clusters.html.markdown b/config/docs/d/oceanus_clusters.html.markdown new file mode 100644 index 0000000..7b27102 --- /dev/null +++ b/config/docs/d/oceanus_clusters.html.markdown @@ -0,0 +1,132 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_clusters" +sidebar_current: "docs-tencentcloud-datasource-oceanus_clusters" +description: |- + Use this data source to query detailed information of oceanus clusters +--- + +# tencentcloud_oceanus_clusters + +Use this data source to query detailed information of oceanus clusters + +## Example Usage + +### Query all clusters + +```hcl +data "tencentcloud_oceanus_clusters" "example" {} +``` + +### Query the specified cluster + +```hcl +data "tencentcloud_oceanus_clusters" "example" { + cluster_ids = ["cluster-5c42n3a5"] + order_type = 1 + filters { + name = "name" + values = ["tf_example"] + } + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_ids` - (Optional, Set: [`String`]) Query one or more clusters by their ID. The maximum number of clusters that can be queried at once is 100. +* `filters` - (Optional, List) The filtering rules. +* `order_type` - (Optional, Int) The sorting rule of the cluster information results. Possible values are 1 (sort by time in descending order), 2 (sort by time in ascending order), and 3 (sort by status). +* `result_output_file` - (Optional, String) Used to save results. +* `work_space_id` - (Optional, String) Workspace SerialId. + +The `filters` object supports the following: + +* `name` - (Required, String) The field to be filtered. +* `values` - (Required, Set) The filtering values of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cluster_set` - Cluster list. + * `app_id` - The user AppID. + * `arch_generation` - V3 version = 2.Note: This field may return null, indicating that no valid values can be obtained. + * `auto_renew_flag` - The auto-renewal flag. 0 indicates the default state (the user has not set it, which is the initial state; if the user has enabled the prepaid non-stop privilege, the cluster will be automatically renewed), 1 indicates automatic renewal, and 2 indicates no automatic renewal (set by the user).Note: This field may return null, indicating that no valid values can be obtained. + * `ccns` - The network. + * `ccn_id` - The ID of the Cloud Connect Network (CCN), such as ccn-rahigzjd. + * `subnet_id` - The ID of the subnet. + * `vpc_id` - The ID of the VPC. + * `cls_log_name` - The name of the CLS logset of the cluster.Note: This field may return null, indicating that no valid values can be obtained. + * `cls_log_set` - The CLS logset of the cluster.Note: This field may return null, indicating that no valid values can be obtained. + * `cls_topic_id` - The CLS topic ID of the cluster.Note: This field may return null, indicating that no valid values can be obtained. + * `cls_topic_name` - The name of the CLS topic of the cluster.Note: This field may return null, indicating that no valid values can be obtained. + * `cluster_id` - The ID of the cluster. + * `cluster_sessions` - Session cluster information.Note: This field may return null, indicating that no valid values can be obtained. + * `cluster_type` - 0: TKE, 1: EKS.Note: This field may return null, indicating that no valid values can be obtained. + * `correlations` - Space information.Note: This field may return null, indicating that no valid values can be obtained. + * `cluster_group_id` - Cluster ID. + * `cluster_group_serial_id` - Cluster SerialId. + * `cluster_name` - Cluster name. + * `project_id_str` - Project ID in string format.Note: This field may return null, indicating that no valid values can be obtained. + * `project_id` - Project ID. + * `status` - Binding status. 2 - bound, 1 - unbound. + * `work_space_id` - Workspace SerialId. + * `work_space_name` - Workspace name. + * `create_time` - The time when the cluster was created. + * `creator_uin` - The creator UIN. + * `cu_mem` - The memory specification of the CU. + * `cu_num` - The number of CUs. + * `customized_dns_enabled` - Value: 0 - not set, 1 - set, 2 - not allowed to set.Note: This field may return null, indicating that no valid values can be obtained. + * `default_cos_bucket` - The default COS bucket of the cluster.Note: This field may return null, indicating that no valid values can be obtained. + * `default_log_collect_conf` - The default log collection configuration of the cluster.Note: This field may return null, indicating that no valid values can be obtained. + * `expire_time` - The expiration time of the cluster. If the cluster does not have an expiration time, this field will be -.Note: This field may return null, indicating that no valid values can be obtained. + * `free_cu_num` - The number of free CUs. + * `free_cu` - The number of free CUs at the granularity level.Note: This field may return null, indicating that no valid values can be obtained. + * `is_need_manage_node` - Front-end distinguishes whether the cluster needs 2CU logic, because historical clusters do not need to be changed. Default is 1. All new clusters need to be changed.Note: This field may return null, indicating that no valid values can be obtained. + * `isolated_time` - The time when the cluster was isolated. If the cluster has not been isolated, this field will be -.Note: This field may return null, indicating that no valid values can be obtained. + * `name` - The name of the cluster. + * `net_environment_type` - The network. + * `orders` - Order information.Note: This field may return null, indicating that no valid values can be obtained. + * `auto_renew_flag` - 1 - auto-renewal.Note: This field may return null, indicating that no valid values can be obtained. + * `compute_cu` - The number of CUs in the final cluster.Note: This field may return null, indicating that no valid values can be obtained. + * `operate_uin` - UIN of the operator.Note: This field may return null, indicating that no valid values can be obtained. + * `order_time` - The time of the order.Note: This field may return null, indicating that no valid values can be obtained. + * `type` - 1 - create, 2 - renew, 3 - scale.Note: This field may return null, indicating that no valid values can be obtained. + * `owner_uin` - The main account UIN. + * `pay_mode` - 0 - postpaid, 1 - prepaid.Note: This field may return null, indicating that no valid values can be obtained. + * `region` - The region where the cluster is located. + * `remark` - A description of the cluster. + * `running_cu` - Running CU.Note: This field may return null, indicating that no valid values can be obtained. + * `seconds_until_expiry` - The number of seconds until the cluster expires. If the cluster does not have an expiration time, this field will be -.Note: This field may return null, indicating that no valid values can be obtained. + * `sql_gateways` - Gateway information.Note: This field may return null, indicating that no valid values can be obtained. + * `create_time` - Creation time.Note: This field may return null, indicating that no valid values can be obtained. + * `creator_uin` - Creator.Note: This field may return null, indicating that no valid values can be obtained. + * `cu_spec` - CU specification.Note: This field may return null, indicating that no valid values can be obtained. + * `flink_version` - Flink kernel version.Note: This field may return null, indicating that no valid values can be obtained. + * `properties` - Configuration parameters.Note: This field may return null, indicating that no valid values can be obtained. + * `key` - Key of the system configuration. + * `value` - Value of the system configuration. + * `resource_refs` - Reference resources.Note: This field may return null, indicating that no valid values can be obtained. + * `resource_id` - Unique identifier of the resource. + * `type` - Reference type. 0: user resource.Note: This field may return null, indicating that no valid values can be obtained. + * `version` - Version number. + * `workspace_id` - Unique identifier of the space. + * `serial_id` - Unique identifier.Note: This field may return null, indicating that no valid values can be obtained. + * `status` - Status. 1 - stopped, 2 - starting, 3 - started, 4 - start failed, 5 - stopping.Note: This field may return null, indicating that no valid values can be obtained. + * `update_time` - Update time.Note: This field may return null, indicating that no valid values can be obtained. + * `status_desc` - The status description. + * `status` - The status of the cluster. Possible values are 1 (uninitialized), 3 (initializing), and 2 (running). + * `tags` - The tags bound to the cluster.Note: This field may return null, indicating that no valid values can be obtained. + * `tag_key` - The tag key.Note: This field may return null, indicating that no valid values can be obtained. + * `tag_value` - The tag value.Note: This field may return null, indicating that no valid values can be obtained. + * `update_time` - The time of the last operation on the cluster. + * `version` - The version information of the cluster.Note: This field may return null, indicating that no valid values can be obtained. + * `flink` - The Flink version of the cluster.Note: This field may return null, indicating that no valid values can be obtained. + * `supported_flink` - The Flink versions supported by the cluster.Note: This field may return null, indicating that no valid values can be obtained. + * `zone` - The availability zone. + + diff --git a/config/docs/d/oceanus_job_submission_log.html.markdown b/config/docs/d/oceanus_job_submission_log.html.markdown new file mode 100644 index 0000000..e978ab8 --- /dev/null +++ b/config/docs/d/oceanus_job_submission_log.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_job_submission_log" +sidebar_current: "docs-tencentcloud-datasource-oceanus_job_submission_log" +description: |- + Use this data source to query detailed information of oceanus job_submission_log +--- + +# tencentcloud_oceanus_job_submission_log + +Use this data source to query detailed information of oceanus job_submission_log + +## Example Usage + +```hcl +data "tencentcloud_oceanus_job_submission_log" "example" { + job_id = "cql-314rw6w0" + start_time = 1696130964345 + end_time = 1698118169241 + running_order_id = 0 + order_type = "desc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time, unix timestamp, in milliseconds. +* `job_id` - (Required, String) Job ID. +* `start_time` - (Required, Int) Start time, unix timestamp, in milliseconds. +* `cursor` - (Optional, String) Cursor, default empty, first request does not need to pass in. +* `keyword` - (Optional, String) Keyword, default empty. +* `order_type` - (Optional, String) Sorting method, default asc, asc: ascending, desc: descending. +* `result_output_file` - (Optional, String) Used to save results. +* `running_order_id` - (Optional, Int) Job instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `job_instance_list` - Job instance list during the specified time period. + * `job_instance_start_time` - The startup time of the instance. + * `running_order_id` - The ID of the instance, starting from 1 in the order of startup time. + * `starting_millis` - The startup time of the instance in milliseconds. +* `job_request_id` - Request ID of starting job. +* `list_over` - Whether the list is over. +* `log_content_list` - The list of log contents. + * `container_name` - The name of the container to which the log belongs. + * `log` - The content of the log. + * `pkg_id` - The ID of the log group. + * `pkg_log_id` - The ID of the log, which is unique within the log group. + * `time` - The timestamp in milliseconds. +* `log_list` - Log list, deprecated. + + diff --git a/config/docs/d/oceanus_resource_related_job.html.markdown b/config/docs/d/oceanus_resource_related_job.html.markdown new file mode 100644 index 0000000..9300aae --- /dev/null +++ b/config/docs/d/oceanus_resource_related_job.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_resource_related_job" +sidebar_current: "docs-tencentcloud-datasource-oceanus_resource_related_job" +description: |- + Use this data source to query detailed information of oceanus resource_related_job +--- + +# tencentcloud_oceanus_resource_related_job + +Use this data source to query detailed information of oceanus resource_related_job + +## Example Usage + +```hcl +data "tencentcloud_oceanus_resource_related_job" "example" { + resource_id = "resource-8y9lzcuz" + desc_by_job_config_create_time = 0 + resource_config_version = 1 + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_id` - (Required, String) Resource ID. +* `desc_by_job_config_create_time` - (Optional, Int) Default:0; 1:sort by job version creation time in descending order. +* `resource_config_version` - (Optional, Int) Resource version number. +* `result_output_file` - (Optional, String) Used to save results. +* `work_space_id` - (Optional, String) Workspace SerialId. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `ref_job_infos` - Associated job information. + * `job_config_version` - Job configuration version. + * `job_id` - Job ID. + * `resource_version` - Resource version. + + diff --git a/config/docs/d/oceanus_savepoint_list.html.markdown b/config/docs/d/oceanus_savepoint_list.html.markdown new file mode 100644 index 0000000..11ab166 --- /dev/null +++ b/config/docs/d/oceanus_savepoint_list.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_savepoint_list" +sidebar_current: "docs-tencentcloud-datasource-oceanus_savepoint_list" +description: |- + Use this data source to query detailed information of oceanus savepoint_list +--- + +# tencentcloud_oceanus_savepoint_list + +Use this data source to query detailed information of oceanus savepoint_list + +## Example Usage + +```hcl +data "tencentcloud_oceanus_savepoint_list" "example" { + job_id = "cql-314rw6w0" + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String) Job SerialId. +* `result_output_file` - (Optional, String) Used to save results. +* `work_space_id` - (Optional, String) Workspace SerialId. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `savepoint` - Snapshot listNote: This field may return null, indicating that no valid value was found. + * `create_time` - Creation timeNote: This field may return null, indicating that no valid value was found. + * `description` - DescriptionNote: This field may return null, indicating that no valid value was found. + * `id` - Primary keyNote: This field may return null, indicating that no valid value was found. + * `job_runtime_id` - Sequential ID of the running job instanceNote: This field may return null, indicating that no valid value was found. + * `path_status` - Snapshot path status: 1=available; 2=unavailable;Note: This field may return null, indicating that no valid value was found. + * `path` - PathNote: This field may return null, indicating that no valid value was found. + * `record_type` - Snapshot type: 1=savepoint; 2=checkpoint; 3=cancelWithSavepointNote: This field may return null, indicating that no valid value was found. + * `serial_id` - Snapshot SerialIdNote: This field may return null, indicating that no valid value was found. + * `size` - SizeNote: This field may return null, indicating that no valid value was found. + * `status` - Status: 1=Active; 2=Expired; 3=InProgress; 4=Failed; 5=TimeoutNote: This field may return null, indicating that no valid value was found. + * `time_consuming` - Time consumptionNote: This field may return null, indicating that no valid value was found. + * `timeout` - Fixed timeoutNote: This field may return null, indicating that no valid value was found. + * `update_time` - Update timeNote: This field may return null, indicating that no valid value was found. + * `version_id` - Version numberNote: This field may return null, indicating that no valid value was found. + + diff --git a/config/docs/d/oceanus_system_resource.html.markdown b/config/docs/d/oceanus_system_resource.html.markdown new file mode 100644 index 0000000..127734e --- /dev/null +++ b/config/docs/d/oceanus_system_resource.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_system_resource" +sidebar_current: "docs-tencentcloud-datasource-oceanus_system_resource" +description: |- + Use this data source to query detailed information of oceanus system_resource +--- + +# tencentcloud_oceanus_system_resource + +Use this data source to query detailed information of oceanus system_resource + +## Example Usage + +```hcl +data "tencentcloud_oceanus_system_resource" "example" { + resource_ids = ["resource-abd503yt"] + filters { + name = "Name" + values = ["tf_example"] + } + cluster_id = "cluster-n8yaia0p" + flink_version = "Flink-1.11" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Optional, String) Cluster ID. +* `filters` - (Optional, List) Query the resource configuration list. If not specified, return all job configuration lists under ResourceIds.N. +* `flink_version` - (Optional, String) Query built-in connectors for the corresponding Flink version. +* `resource_ids` - (Optional, Set: [`String`]) Array of resource IDs to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Field to be filtered. +* `values` - (Required, Set) Filter values for the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `resource_set` - Collection of resource details. + * `latest_resource_config_version` - Latest version of the resource. + * `name` - Resource name. + * `region` - Region to which the resource belongs. + * `remark` - Resource remarks. + * `resource_id` - Resource ID. + * `resource_type` - Resource type. 1 indicates JAR package, which is currently the only supported value. + + diff --git a/config/docs/d/oceanus_tree_jobs.html.markdown b/config/docs/d/oceanus_tree_jobs.html.markdown new file mode 100644 index 0000000..d7b280d --- /dev/null +++ b/config/docs/d/oceanus_tree_jobs.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_tree_jobs" +sidebar_current: "docs-tencentcloud-datasource-oceanus_tree_jobs" +description: |- + Use this data source to query detailed information of oceanus tree_jobs +--- + +# tencentcloud_oceanus_tree_jobs + +Use this data source to query detailed information of oceanus tree_jobs + +## Example Usage + +```hcl +data "tencentcloud_oceanus_tree_jobs" "example" { + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter rules. +* `result_output_file` - (Optional, String) Used to save results. +* `work_space_id` - (Optional, String) Workspace SerialId. + +The `filters` object supports the following: + +* `name` - (Required, String) Field to be filtered. Can only be set `Zone` or `JobType` or `JobStatus`. +* `values` - (Required, Set) Filter values for the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `tree_info` - Tree structure information. + * `children` - Subdirectory Information. + * `id` - ID. + * `job_set` - List of jobs. + * `job_id` - Job ID. + * `job_type` - Job Type. + * `name` - Job Name. + * `running_cu` - Resources occupied by homework. + * `status` - Job status. + * `name` - Name. + * `parent_id` - Parent Id. + + diff --git a/config/docs/d/oceanus_tree_resources.html.markdown b/config/docs/d/oceanus_tree_resources.html.markdown new file mode 100644 index 0000000..bd0fd30 --- /dev/null +++ b/config/docs/d/oceanus_tree_resources.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_tree_resources" +sidebar_current: "docs-tencentcloud-datasource-oceanus_tree_resources" +description: |- + Use this data source to query detailed information of oceanus tree_resources +--- + +# tencentcloud_oceanus_tree_resources + +Use this data source to query detailed information of oceanus tree_resources + +## Example Usage + +```hcl +data "tencentcloud_oceanus_tree_resources" "example" { + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `work_space_id` - (Required, String) Workspace SerialId. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `tree_info` - Tree structure information. + * `children` - Subdirectory Information. + * `id` - ID. + * `items` - List of items. + * `file_name` - File name. + * `folder_id` - Folder id. + * `name` - Name. + * `ref_job_status_count_set` - Counting the number of associated tasks by state. + * `count` - Job count. + * `job_status` - Job status. + * `remark` - Remark. + * `resource_id` - Resource Id. + * `resource_type` - Resource Type. + * `name` - Name. + * `parent_id` - Parent Id. + + diff --git a/config/docs/d/oceanus_work_spaces.html.markdown b/config/docs/d/oceanus_work_spaces.html.markdown new file mode 100644 index 0000000..cc6a2fe --- /dev/null +++ b/config/docs/d/oceanus_work_spaces.html.markdown @@ -0,0 +1,91 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_work_spaces" +sidebar_current: "docs-tencentcloud-datasource-oceanus_work_spaces" +description: |- + Use this data source to query detailed information of oceanus work_spaces +--- + +# tencentcloud_oceanus_work_spaces + +Use this data source to query detailed information of oceanus work_spaces + +## Example Usage + +```hcl +data "tencentcloud_oceanus_work_spaces" "example" { + order_type = 1 + filters { + name = "WorkSpaceName" + values = ["tf_example"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter rules. +* `order_type` - (Optional, Int) 1:sort by creation time in descending order (default); 2:sort by creation time in ascending order; 3:sort by status in descending order; 4:sort by status in ascending order; default is 0. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Field to be filtered. +* `values` - (Required, Set) Filter values for the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `work_space_set_item` - List of workspace detailsNote: This field may return null, indicating that no valid values can be obtained. + * `app_id` - User APPID. + * `cluster_group_set_item` - Workspace cluster information. + * `app_id` - Account APPID. + * `cluster_id` - SerialId of the clusterGroup. + * `create_time` - Cluster creation time. + * `creator_uin` - Creator account UIN. + * `cu_mem` - CU memory specification. + * `cu_num` - CU quantity. + * `free_cu_num` - Free CU. + * `free_cu` - Free CU under fine-grained resources. + * `name` - Cluster name. + * `net_environment_type` - Network. + * `owner_uin` - Main account UIN. + * `pay_mode` - Payment mode. + * `region` - Region. + * `remark` - Description. + * `running_cu` - Running CU. + * `status_desc` - Status description. + * `status` - Cluster status, 1:uninitialized, 3:initializing, 2:running. + * `update_time` - Last operation time on the cluster. + * `zone` - Zone. + * `create_time` - Creation time. + * `creator_uin` - Creator UIN. + * `description` - Workspace description. + * `jobs_count` - Note: This field may return null, indicating that no valid values can be obtained. + * `owner_uin` - Main account UIN. + * `region` - Region. + * `role_auth_count` - Workspace member count. + * `role_auth` - Workspace role information. + * `app_id` - User AppID. + * `auth_sub_account_uin` - Bound authorized UIN. + * `create_time` - Creation time. + * `creator_uin` - Creator UIN. + * `id` - IDNote: This field may return null, indicating that no valid values can be obtained. + * `owner_uin` - Main account UIN. + * `permission` - Corresponding to the ID in the role table. + * `role_name` - Permission nameNote: This field may return null, indicating that no valid values can be obtained. + * `status` - 2:enabled, 1:disabled. + * `update_time` - Last operation time. + * `work_space_id` - Workspace IDNote: This field may return null, indicating that no valid values can be obtained. + * `work_space_serial_id` - Workspace SerialId. + * `serial_id` - Workspace SerialId. + * `status` - 1:uninitialized; 2:available; -1:deleted. + * `update_time` - Update time. + * `work_space_id` - Workspace SerialId. + * `work_space_name` - Workspace name. + + diff --git a/config/docs/d/organization_members.html.markdown b/config/docs/d/organization_members.html.markdown new file mode 100644 index 0000000..2d2fb25 --- /dev/null +++ b/config/docs/d/organization_members.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_members" +sidebar_current: "docs-tencentcloud-datasource-organization_members" +description: |- + Use this data source to query detailed information of organization members +--- + +# tencentcloud_organization_members + +Use this data source to query detailed information of organization members + +## Example Usage + +```hcl +data "tencentcloud_organization_members" "members" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `auth_name` - (Optional, String) Entity name. +* `lang` - (Optional, String) Valid values: `en` (Tencent Cloud International); `zh` (Tencent Cloud). +* `product` - (Optional, String) Abbreviation of the trusted service, which is required during querying the trusted service admin. +* `result_output_file` - (Optional, String) Used to save results. +* `search_key` - (Optional, String) Search by member name or ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Member list. + * `bind_status` - Security information binding status. Valid values: `Unbound`, `Valid`, `Success`, `Failed`.Note: This field may return null, indicating that no valid values can be obtained. + * `create_time` - Creation timeNote: This field may return null, indicating that no valid values can be obtained. + * `is_allow_quit` - Whether the member is allowed to leave. Valid values: `Allow`, `Denied`.Note: This field may return null, indicating that no valid values can be obtained. + * `member_type` - Member type. Valid values: `Invite` (invited); `Create` (created).Note: This field may return null, indicating that no valid values can be obtained. + * `member_uin` - Member UINNote: This field may return null, indicating that no valid values can be obtained. + * `name` - Member nameNote: This field may return null, indicating that no valid values can be obtained. + * `node_id` - Node IDNote: This field may return null, indicating that no valid values can be obtained. + * `node_name` - Node nameNote: This field may return null, indicating that no valid values can be obtained. + * `org_identity` - Management identityNote: This field may return null, indicating that no valid values can be obtained. + * `identity_alias_name` - Identity name.Note: This field may return null, indicating that no valid values can be obtained. + * `identity_id` - Identity ID.Note: This field may return null, indicating that no valid values can be obtained. + * `org_permission` - Relationship policy permissionNote: This field may return null, indicating that no valid values can be obtained. + * `id` - Permission ID. + * `name` - Permission name. + * `org_policy_name` - Relationship policy nameNote: This field may return null, indicating that no valid values can be obtained. + * `org_policy_type` - Relationship policy typeNote: This field may return null, indicating that no valid values can be obtained. + * `pay_name` - Payer nameNote: This field may return null, indicating that no valid values can be obtained. + * `pay_uin` - Payer UINNote: This field may return null, indicating that no valid values can be obtained. + * `permission_status` - Member permission status. Valid values: `Confirmed`, `UnConfirmed`.Note: This field may return null, indicating that no valid values can be obtained. + * `remark` - RemarksNote: This field may return null, indicating that no valid values can be obtained. + * `update_time` - Update timeNote: This field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/organization_org_auth_node.html.markdown b/config/docs/d/organization_org_auth_node.html.markdown new file mode 100644 index 0000000..c2376f1 --- /dev/null +++ b/config/docs/d/organization_org_auth_node.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_org_auth_node" +sidebar_current: "docs-tencentcloud-datasource-organization_org_auth_node" +description: |- + Use this data source to query detailed information of organization org_auth_node +--- + +# tencentcloud_organization_org_auth_node + +Use this data source to query detailed information of organization org_auth_node + +## Example Usage + +```hcl +data "tencentcloud_organization_org_auth_node" "org_auth_node" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auth_name` - (Optional, String) Verified company name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Organization auth node list. + * `auth_name` - Verified company name. + * `manager` - Organization auth manager. + * `member_name` - Member name. + * `member_uin` - Member uin. + * `relation_id` - Relationship Id. + + diff --git a/config/docs/d/organization_org_financial_by_member.html.markdown b/config/docs/d/organization_org_financial_by_member.html.markdown new file mode 100644 index 0000000..d64b96f --- /dev/null +++ b/config/docs/d/organization_org_financial_by_member.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_org_financial_by_member" +sidebar_current: "docs-tencentcloud-datasource-organization_org_financial_by_member" +description: |- + Use this data source to query detailed information of organization org_financial_by_member +--- + +# tencentcloud_organization_org_financial_by_member + +Use this data source to query detailed information of organization org_financial_by_member + +## Example Usage + +```hcl +data "tencentcloud_organization_org_financial_by_member" "org_financial_by_member" { + month = "2023-05" + end_month = "2023-10" + member_uins = [100015591986, 100029796005] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `month` - (Required, String) Query for the start month. Format:yyyy-mm, for example:2021-01. +* `end_month` - (Optional, String) Query for the end month. Format:yyyy-mm, for example:2021-01.The default value is the `Month`. +* `member_uins` - (Optional, Set: [`Int`]) Member uin list. Up to 100. +* `product_codes` - (Optional, Set: [`String`]) Product code list. Up to 100. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Member financial detail. + * `member_name` - Member name. + * `member_uin` - Member uin. + * `ratio` - The percentage of the organization total cost that is accounted for by the member. + * `total_cost` - Total cost of the member. +* `total_cost` - Total cost of the member. + + diff --git a/config/docs/d/organization_org_financial_by_month.html.markdown b/config/docs/d/organization_org_financial_by_month.html.markdown new file mode 100644 index 0000000..48d0c17 --- /dev/null +++ b/config/docs/d/organization_org_financial_by_month.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_org_financial_by_month" +sidebar_current: "docs-tencentcloud-datasource-organization_org_financial_by_month" +description: |- + Use this data source to query detailed information of organization org_financial_by_month +--- + +# tencentcloud_organization_org_financial_by_month + +Use this data source to query detailed information of organization org_financial_by_month + +## Example Usage + +```hcl +data "tencentcloud_organization_org_financial_by_month" "org_financial_by_month" { + end_month = "2023-05" + member_uins = [100026517717] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_month` - (Optional, String) Query for the end month. Format:yyyy-mm, for example:2021-01. +* `member_uins` - (Optional, Set: [`Int`]) Member uin list. Up to 100. +* `product_codes` - (Optional, Set: [`String`]) Product code list. Up to 100. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Organization financial info by month. + * `growth_rate` - Growth rate compared to last month. + * `id` - Record ID. + * `month` - Month. + * `total_cost` - Total cost of the month. + + diff --git a/config/docs/d/organization_org_financial_by_product.html.markdown b/config/docs/d/organization_org_financial_by_product.html.markdown new file mode 100644 index 0000000..229477e --- /dev/null +++ b/config/docs/d/organization_org_financial_by_product.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_org_financial_by_product" +sidebar_current: "docs-tencentcloud-datasource-organization_org_financial_by_product" +description: |- + Use this data source to query detailed information of organization org_financial_by_product +--- + +# tencentcloud_organization_org_financial_by_product + +Use this data source to query detailed information of organization org_financial_by_product + +## Example Usage + +```hcl +data "tencentcloud_organization_org_financial_by_product" "org_financial_by_product" { + month = "2023-05" + end_month = "2023-09" + product_codes = ["p_eip"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `month` - (Required, String) Query for the start month. Format:yyyy-mm, for example:2021-01. +* `end_month` - (Optional, String) Query for the end month. Format:yyyy-mm, for example:2021-01.The default value is the `Month`. +* `member_uins` - (Optional, Set: [`Int`]) Member uin list. Up to 100. +* `product_codes` - (Optional, Set: [`String`]) Product code list. Up to 100. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Organization financial info by products. + * `product_code` - Product code. + * `product_name` - Product name. + * `ratio` - The percentage of the organization total cost that is accounted for by the product. + * `total_cost` - Total cost of the product. +* `total_cost` - Total cost of the product. + + diff --git a/config/docs/d/placement_groups.html.markdown b/config/docs/d/placement_groups.html.markdown new file mode 100644 index 0000000..af89260 --- /dev/null +++ b/config/docs/d/placement_groups.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_placement_groups" +sidebar_current: "docs-tencentcloud-datasource-placement_groups" +description: |- + Use this data source to query placement groups. +--- + +# tencentcloud_placement_groups + +Use this data source to query placement groups. + +## Example Usage + +```hcl +data "tencentcloud_placement_groups" "foo" { + placement_group_id = "ps-21q9ibvr" + name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Optional, String) Name of the placement group to be queried. +* `placement_group_id` - (Optional, String) ID of the placement group to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `placement_group_list` - An information list of placement group. Each element contains the following attributes: + * `create_time` - Creation time of the placement group. + * `current_num` - Number of hosts in the placement group. + * `cvm_quota_total` - Maximum number of hosts in the placement group. + * `instance_ids` - Host IDs in the placement group. + * `name` - Name of the placement group. + * `placement_group_id` - ID of the placement group. + * `type` - Type of the placement group. + + diff --git a/config/docs/d/postgresql_backup_download_urls.html.markdown b/config/docs/d/postgresql_backup_download_urls.html.markdown new file mode 100644 index 0000000..fb7bb91 --- /dev/null +++ b/config/docs/d/postgresql_backup_download_urls.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_backup_download_urls" +sidebar_current: "docs-tencentcloud-datasource-postgresql_backup_download_urls" +description: |- + Use this data source to query detailed information of postgresql backup_download_urls +--- + +# tencentcloud_postgresql_backup_download_urls + +Use this data source to query detailed information of postgresql backup_download_urls + +## Example Usage + +```hcl +data "tencentcloud_postgresql_log_backups" "log_backups" { + min_finish_time = "%s" + max_finish_time = "%s" + filters { + name = "db-instance-id" + values = [local.pgsql_id] + } + order_by = "StartTime" + order_by_type = "desc" + +} + +data "tencentcloud_postgresql_backup_download_urls" "backup_download_urls" { + db_instance_id = local.pgsql_id + backup_type = "LogBackup" + backup_id = data.tencentcloud_postgresql_log_backups.log_backups.log_backup_set.0.id + url_expire_time = 12 + backup_download_restriction { + restriction_type = "NONE" + vpc_restriction_effect = "ALLOW" + vpc_id_set = [local.vpc_id] + ip_restriction_effect = "ALLOW" + ip_set = ["0.0.0.0"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_id` - (Required, String) Unique backup ID. +* `backup_type` - (Required, String) Backup type. Valid values: `LogBackup`, `BaseBackup`. +* `db_instance_id` - (Required, String) Instance ID. +* `backup_download_restriction` - (Optional, List) Backup download restriction. +* `result_output_file` - (Optional, String) Used to save results. +* `url_expire_time` - (Optional, Int) Validity period of a URL, which is 12 hours by default. + +The `backup_download_restriction` object supports the following: + +* `ip_restriction_effect` - (Optional, String) Whether IP is allowed. Valid values: `ALLOW` (allow), `DENY` (deny). +* `ip_set` - (Optional, Set) Whether it is allowed to download IP list of the backup files. +* `restriction_type` - (Optional, String) Type of the network restrictions for downloading backup files. Valid values: `NONE` (backups can be downloaded over both private and public networks), `INTRANET` (backups can only be downloaded over the private network), `CUSTOMIZE` (backups can be downloaded over specified VPCs or at specified IPs). +* `vpc_id_set` - (Optional, Set) Whether it is allowed to download the VPC ID list of the backup files. +* `vpc_restriction_effect` - (Optional, String) Whether VPC is allowed. Valid values: `ALLOW` (allow), `DENY` (deny). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `backup_download_url` - Backup download URL. + + diff --git a/config/docs/d/postgresql_base_backups.html.markdown b/config/docs/d/postgresql_base_backups.html.markdown new file mode 100644 index 0000000..2c4d69d --- /dev/null +++ b/config/docs/d/postgresql_base_backups.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_base_backups" +sidebar_current: "docs-tencentcloud-datasource-postgresql_base_backups" +description: |- + Use this data source to query detailed information of postgresql base_backups +--- + +# tencentcloud_postgresql_base_backups + +Use this data source to query detailed information of postgresql base_backups + +## Example Usage + +```hcl +data "tencentcloud_postgresql_base_backups" "base_backups" { + min_finish_time = "%s" + max_finish_time = "%s" + + order_by = "StartTime" + order_by_type = "asc" +} + +data "tencentcloud_postgresql_base_backups" "base_backups" { + filters { + name = "db-instance-id" + values = [local.pgsql_id] + } + + order_by = "Size" + order_by_type = "asc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter instances using one or more criteria. Valid filter names: `db-instance-id`: Filter by instance ID (in string format). `db-instance-name`: Filter by instance name (in string format). `db-instance-ip`: Filter by instance VPC IP (in string format). `base-backup-id`: Filter by base backup ID (in string format). +* `max_finish_time` - (Optional, String) Maximum end time of a backup in the format of `2018-01-01 00:00:00`. It is the current time by default. +* `min_finish_time` - (Optional, String) Minimum end time of a backup in the format of `2018-01-01 00:00:00`. It is 7 days ago by default. +* `order_by_type` - (Optional, String) Sorting order. Valid values: `asc` (ascending), `desc` (descending). +* `order_by` - (Optional, String) Sorting field. Valid values: `StartTime`, `FinishTime`, `Size`. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Optional, String) Filter name. +* `values` - (Optional, Set) One or more filter values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `base_backup_set` - List of full backup details. + * `backup_method` - Backup method, including physical and logical. + * `backup_mode` - Backup mode, including automatic and manual. + * `db_instance_id` - Instance ID. + * `expire_time` - Backup expiration time. + * `finish_time` - Backup end time. + * `id` - Unique ID of a backup file. + * `name` - Backup file name. + * `size` - Backup set size in bytes. + * `start_time` - Backup start time. + * `state` - Backup task status. + + diff --git a/config/docs/d/postgresql_db_instance_classes.html.markdown b/config/docs/d/postgresql_db_instance_classes.html.markdown new file mode 100644 index 0000000..43b0bd4 --- /dev/null +++ b/config/docs/d/postgresql_db_instance_classes.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_db_instance_classes" +sidebar_current: "docs-tencentcloud-datasource-postgresql_db_instance_classes" +description: |- + Use this data source to query detailed information of postgresql db_instance_classes +--- + +# tencentcloud_postgresql_db_instance_classes + +Use this data source to query detailed information of postgresql db_instance_classes + +## Example Usage + +```hcl +data "tencentcloud_postgresql_db_instance_classes" "db_instance_classes" { + zone = "ap-guangzhou-7" + db_engine = "postgresql" + db_major_version = "13" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_engine` - (Required, String) Database engines. Valid values: 1. `postgresql` (TencentDB for PostgreSQL) 2. `mssql_compatible` (MSSQL compatible-TencentDB for PostgreSQL). +* `db_major_version` - (Required, String) Major version of a database, such as 12 or 13, which can be obtained through the `DescribeDBVersions` API. +* `zone` - (Required, String) AZ ID, which can be obtained through the `DescribeZones` API. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `class_info_set` - List of database specifications. + * `cpu` - Number of CPU cores. + * `max_storage` - Maximum storage capacity in GB supported by this specification. + * `memory` - Memory size in MB. + * `min_storage` - Minimum storage capacity in GB supported by this specification. + * `qps` - Estimated QPS for this specification. + * `spec_code` - Specification ID. + + diff --git a/config/docs/d/postgresql_db_instance_versions.html.markdown b/config/docs/d/postgresql_db_instance_versions.html.markdown new file mode 100644 index 0000000..2f67c11 --- /dev/null +++ b/config/docs/d/postgresql_db_instance_versions.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_db_instance_versions" +sidebar_current: "docs-tencentcloud-datasource-postgresql_db_instance_versions" +description: |- + Use this data source to query detailed information of postgresql db_instance_versions +--- + +# tencentcloud_postgresql_db_instance_versions + +Use this data source to query detailed information of postgresql db_instance_versions + +## Example Usage + +```hcl +data "tencentcloud_postgresql_db_instance_versions" "db_instance_versions" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `version_set` - List of database versions. + * `available_upgrade_target` - List of versions to which this database version (`DBKernelVersion`) can be upgraded. + * `db_engine` - Database engines. Valid values:1. `postgresql` (TencentDB for PostgreSQL)2. `mssql_compatible` (MSSQL compatible-TencentDB for PostgreSQL). + * `db_kernel_version` - Database kernel version, such as v12.4_r1.3. + * `db_major_version` - Database major version, such as 12. + * `db_version` - Database version, such as 12.4. + * `status` - Database version status. Valid values:`AVAILABLE`.`DEPRECATED`. + * `supported_feature_names` - List of features supported by the database kernel, such as:TDE: Supports data encryption. + + diff --git a/config/docs/d/postgresql_default_parameters.html.markdown b/config/docs/d/postgresql_default_parameters.html.markdown new file mode 100644 index 0000000..8368263 --- /dev/null +++ b/config/docs/d/postgresql_default_parameters.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_default_parameters" +sidebar_current: "docs-tencentcloud-datasource-postgresql_default_parameters" +description: |- + Use this data source to query detailed information of postgresql default_parameters +--- + +# tencentcloud_postgresql_default_parameters + +Use this data source to query detailed information of postgresql default_parameters + +## Example Usage + +```hcl +data "tencentcloud_postgresql_default_parameters" "default_parameters" { + db_major_version = "13" + db_engine = "postgresql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_engine` - (Required, String) Database engine, such as postgresql, mssql_compatible. +* `db_major_version` - (Required, String) The major database version number, such as 11, 12, 13. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `param_info_set` - Parameter informationNote: This field may return null, indicating that no valid values can be obtained. + * `advanced` - Whether it is a key parameter. Valid values: `true` (yes, and modifying it may affect instance performance), `false` (no)Note: this field may return `null`, indicating that no valid values can be obtained. + * `classification_cn` - Parameter category in ChineseNote: this field may return `null`, indicating that no valid values can be obtained. + * `classification_en` - Parameter category in EnglishNote: this field may return `null`, indicating that no valid values can be obtained. + * `current_value` - Current value of the parameter, which is returned as a stringNote: this field may return `null`, indicating that no valid values can be obtained. + * `default_value` - Default value of the parameter, which is returned as a stringNote: this field may return `null`, indicating that no valid values can be obtained. + * `enum_value` - Value range of the enum parameterNote: this field may return `null`, indicating that no valid values can be obtained. + * `id` - Parameter IDNote: this field may return `null`, indicating that no valid values can be obtained. + * `last_modify_time` - The last modified time of the parameterNote: this field may return `null`, indicating that no valid values can be obtained. + * `max` - The maximum value of the `integer` or `real` parameterNote: this field may return `null`, indicating that no valid values can be obtained. + * `min` - The minimum value of the `integer` or `real` parameterNote: this field may return `null`, indicating that no valid values can be obtained. + * `name` - Parameter nameNote: this field may return `null`, indicating that no valid values can be obtained. + * `need_reboot` - Whether to restart the instance for the modified parameter to take effect. Valid values: `true` (yes), `false` (no)Note: this field may return `null`, indicating that no valid values can be obtained. + * `param_description_ch` - Parameter description in ChineseNote: this field may return `null`, indicating that no valid values can be obtained. + * `param_description_en` - Parameter description in EnglishNote: this field may return `null`, indicating that no valid values can be obtained. + * `param_value_type` - Value type of the parameter. Valid values: `integer`, `real` (floating-point), `bool`, `enum`, `mutil_enum` (this type of parameter can be set to multiple enumerated values).For an `integer` or `real` parameter, the `Min` field represents the minimum value and the `Max` field the maximum value. For a `bool` parameter, the valid values include `true` and `false`; For an `enum` or `mutil_enum` parameter, the `EnumValue` field represents the valid values.Note: this field may return `null`, indicating that no valid values can be obtained. + * `spec_related` - Whether the parameter is related to specifications. Valid values: `true` (yes), `false` (no)Note: this field may return `null`, indicating that no valid values can be obtained. + * `spec_relation_set` - Associated parameter specification information, which refers to the detailed parameter information of the specifications.Note: This field may return null, indicating that no valid values can be obtained. + * `enum_value` - Value range of the enum parameterNote: This field may return null, indicating that no valid values can be obtained. + * `max` - The maximum value of the `integer` or `real` parameterNote: This field may return null, indicating that no valid values can be obtained. + * `memory` - The specification that corresponds to the parameter informationNote: This field may return null, indicating that no valid values can be obtained. + * `min` - The minimum value of the `integer` or `real` parameterNote: This field may return null, indicating that no valid values can be obtained. + * `name` - Parameter nameNote: This field may return null, indicating that no valid values can be obtained. + * `unit` - Unit of the parameter value. If the parameter has no unit, this field will return null.Note: This field may return null, indicating that no valid values can be obtained. + * `value` - The default parameter value under this specificationNote: This field may return null, indicating that no valid values can be obtained. + * `standby_related` - Primary-standby constraint. Valid values: `0` (no constraint), `1` (The parameter value of the standby server must be greater than that of the primary server), `2` (The parameter value of the primary server must be greater than that of the standby server.)Note: This field may return null, indicating that no valid values can be obtained. + * `unit` - Unit of the parameter value. If the parameter has no unit, this field will return null.Note: This field may return null, indicating that no valid values can be obtained. + * `version_relation_set` - Associated parameter version information, which refers to the detailed parameter information of the kernel version.Note: This field may return null, indicating that no valid values can be obtained. + * `db_kernel_version` - The kernel version that corresponds to the parameter informationNote: This field may return null, indicating that no valid values can be obtained. + * `enum_value` - Value range of the enum parameterNote: This field may return null, indicating that no valid values can be obtained. + * `max` - The maximum value of the `integer` or `real` parameterNote: This field may return null, indicating that no valid values can be obtained. + * `min` - The minimum value of the `integer` or `real` parameterNote: This field may return null, indicating that no valid values can be obtained. + * `name` - Parameter nameNote: This field may return null, indicating that no valid values can be obtained. + * `unit` - Unit of the parameter value. If the parameter has no unit, this field will return null.Note: This field may return null, indicating that no valid values can be obtained. + * `value` - Default parameter value under the kernel version and specification of the instanceNote: This field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/postgresql_instances.html.markdown b/config/docs/d/postgresql_instances.html.markdown new file mode 100644 index 0000000..3967e0d --- /dev/null +++ b/config/docs/d/postgresql_instances.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_instances" +sidebar_current: "docs-tencentcloud-datasource-postgresql_instances" +description: |- + Use this data source to query postgresql instances +--- + +# tencentcloud_postgresql_instances + +Use this data source to query postgresql instances + +## Example Usage + +```hcl +data "tencentcloud_postgresql_instances" "name" { + name = "test" +} + +data "tencentcloud_postgresql_instances" "project" { + project_id = 0 +} + +data "tencentcloud_postgresql_instances" "id" { + id = "postgres-h9t4fde1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the postgresql instance to be query. +* `name` - (Optional, String) Name of the postgresql instance to be query. +* `project_id` - (Optional, Int) Project ID of the postgresql instance to be query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - A list of postgresql instances. Each element contains the following attributes. + * `auto_renew_flag` - Auto renew flag. + * `availability_zone` - Availability zone. + * `charge_type` - Pay type of the postgresql instance. + * `charset` - Charset of the postgresql instance. + * `create_time` - Create time of the postgresql instance. + * `engine_version` - Version of the postgresql database engine. + * `id` - ID of the postgresql instance. + * `memory` - Memory size(in GB). + * `name` - Name of the postgresql instance. + * `private_access_ip` - IP address for private access. + * `private_access_port` - Port for private access. + * `project_id` - Project id, default value is 0. + * `public_access_host` - Host for public access. + * `public_access_port` - Port for public access. + * `public_access_switch` - Indicates whether to enable the access to an instance from public network or not. + * `root_user` - Instance root account name, default value is `root`. + * `storage` - Volume size(in GB). + * `subnet_id` - ID of subnet. + * `tags` - The available tags within this postgresql. + * `vpc_id` - ID of VPC. + + diff --git a/config/docs/d/postgresql_log_backups.html.markdown b/config/docs/d/postgresql_log_backups.html.markdown new file mode 100644 index 0000000..f64cdc0 --- /dev/null +++ b/config/docs/d/postgresql_log_backups.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_log_backups" +sidebar_current: "docs-tencentcloud-datasource-postgresql_log_backups" +description: |- + Use this data source to query detailed information of postgresql log_backups +--- + +# tencentcloud_postgresql_log_backups + +Use this data source to query detailed information of postgresql log_backups + +## Example Usage + +```hcl +data "tencentcloud_postgresql_log_backups" "log_backups" { + min_finish_time = "%s" + max_finish_time = "%s" + filters { + name = "db-instance-id" + values = [local.pgsql_id] + } + order_by = "StartTime" + order_by_type = "desc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter instances using one or more criteria. Valid filter names:db-instance-id: Filter by instance ID (in string format).db-instance-name: Filter by instance name (in string format).db-instance-ip: Filter by instance VPC IP (in string format). +* `max_finish_time` - (Optional, String) Maximum end time of a backup in the format of `2018-01-01 00:00:00`. It is the current time by default. +* `min_finish_time` - (Optional, String) Minimum end time of a backup in the format of `2018-01-01 00:00:00`. It is 7 days ago by default. +* `order_by_type` - (Optional, String) Sorting order. Valid values: `asc` (ascending), `desc` (descending). +* `order_by` - (Optional, String) Sorting field. Valid values: `StartTime`, `FinishTime`, `Size`. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Optional, String) Filter name. +* `values` - (Optional, Set) One or more filter values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `log_backup_set` - List of log backup details. + * `backup_method` - Backup method, including physical and logical. + * `backup_mode` - Backup mode, including automatic and manual. + * `db_instance_id` - Instance ID. + * `expire_time` - Backup expiration time. + * `finish_time` - Backup end time. + * `id` - Unique ID of a backup file. + * `name` - Backup file name. + * `size` - Backup set size in bytes. + * `start_time` - Backup start time. + * `state` - Backup task status. + + diff --git a/config/docs/d/postgresql_parameter_templates.html.markdown b/config/docs/d/postgresql_parameter_templates.html.markdown new file mode 100644 index 0000000..cb89180 --- /dev/null +++ b/config/docs/d/postgresql_parameter_templates.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_parameter_templates" +sidebar_current: "docs-tencentcloud-datasource-postgresql_parameter_templates" +description: |- + Use this data source to query detailed information of postgresql parameter_templates +--- + +# tencentcloud_postgresql_parameter_templates + +Use this data source to query detailed information of postgresql parameter_templates + +## Example Usage + +```hcl +data "tencentcloud_postgresql_parameter_templates" "parameter_templates" { + filters { + name = "TemplateName" + values = ["temp_name"] + } + filters { + name = "DBEngine" + values = ["postgresql"] + } + order_by = "CreateTime" + order_by_type = "desc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter conditions. Valid values:TemplateName, TemplateId, DBMajorVersion, DBEngine. +* `order_by_type` - (Optional, String) Sorting order. Valid values:asc (ascending order),desc (descending order). +* `order_by` - (Optional, String) Sorting metric. Valid values:CreateTime, TemplateName, DBMajorVersion. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Optional, String) Filter name. +* `values` - (Optional, Set) One or more filter values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - list of parameter templates. + * `db_engine` - the database engine for which the parameter template applies. + * `db_major_version` - the database version to which the parameter template applies. + * `template_description` - parameter template description. + * `template_id` - parameter template ID. + * `template_name` - parameter template name. + + diff --git a/config/docs/d/postgresql_readonly_groups.html.markdown b/config/docs/d/postgresql_readonly_groups.html.markdown new file mode 100644 index 0000000..5a84bff --- /dev/null +++ b/config/docs/d/postgresql_readonly_groups.html.markdown @@ -0,0 +1,153 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_readonly_groups" +sidebar_current: "docs-tencentcloud-datasource-postgresql_readonly_groups" +description: |- + Use this data source to query detailed information of postgresql read_only_groups +--- + +# tencentcloud_postgresql_readonly_groups + +Use this data source to query detailed information of postgresql read_only_groups + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_readonly_group" "group" { + master_db_instance_id = "postgres-gzg9jb2n" + name = "test-datasource" + project_id = 0 + vpc_id = "vpc-86v957zb" + subnet_id = "subnet-enm92y0m" + replay_lag_eliminate = 1 + replay_latency_eliminate = 1 + max_replay_lag = 100 + max_replay_latency = 512 + min_delay_eliminate_reserve = 1 +} + +data "tencentcloud_postgresql_readonly_groups" "read_only_groups" { + filters { + name = "db-master-instance-id" + values = [tencentcloud_postgresql_readonly_group.group.master_db_instance_id] + } + order_by = "CreateTime" + order_by_type = "asc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter condition. The primary ID must be specified in the format of db-master-instance-id to filter results, or else null will be returned. +* `order_by_type` - (Optional, String) Sorting order. Valid values:desc, asc. +* `order_by` - (Optional, String) Sorting criterion. Valid values:ROGroupId, CreateTime, Name. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Optional, String) Filter name. +* `values` - (Optional, Set) One or more filter values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `read_only_group_list` - list of read-only groups. + * `db_instance_net_info` - network information. + * `address` - DNS domain name. + * `ip` - IP address. + * `net_type` - network type, 1. inner (intranet address of the basic network); 2. private (intranet address of the private network); 3. public (extranet address of the basic network or private network);. + * `port` - connection port address. + * `protocol_type` - The protocol type for connecting to the database, currently supported: postgresql, mssql (MSSQL compatible syntax)Note: This field may return null, indicating that no valid value can be obtained. + * `status` - network connection status, 1. initing (unopened); 2. opened (opened); 3. closed (closed); 4. opening (opening); 5. closing (closed);. + * `subnet_id` - subnet IDNote: This field may return null, indicating that no valid value can be obtained. + * `vpc_id` - private network IDNote: This field may return null, indicating that no valid value can be obtained. + * `master_db_instance_id` - master instance idNote: This field may return null, indicating that no valid value can be obtained. + * `max_replay_lag` - delay time size threshold. + * `max_replay_latency` - delay space size threshold. + * `min_delay_eliminate_reserve` - Minimum Number of Reserved InstancesNote: This field may return null, indicating that no valid value can be obtained. + * `network_access_list` - Read-only list of group network information (this field is obsolete)Note: This field may return null, indicating that no valid value can be obtained. + * `resource_id` - Network resource id, instance id or RO group idNote: This field may return null, indicating that no valid value can be obtained. + * `resource_type` - Resource type, 1-instance 2-RO groupNote: This field may return null, indicating that no valid value can be obtained. + * `subnet_id` - subnet IDNote: This field may return null, indicating that no valid value can be obtained. + * `vip6` - IPV6 addressNote: This field may return null, indicating that no valid value can be obtained. + * `vip` - IPV4 addressNote: This field may return null, indicating that no valid value can be obtained. + * `vpc_id` - private network IDNote: This field may return null, indicating that no valid value can be obtained. + * `vpc_status` - Network status, 1-applying, 2-using, 3-deleting, 4-deletedNote: This field may return null, indicating that no valid value can be obtained. + * `vport` - access portNote: This field may return null, indicating that no valid value can be obtained. + * `project_id` - project idNote: This field may return null, indicating that no valid value can be obtained. + * `read_only_db_instance_list` - instance details. + * `app_id` - user's AppId. + * `auto_renew` - auto-renew, 1: auto-renew, 0: no auto-renew. + * `create_time` - instance creation time. + * `db_charset` - instance DB character set. + * `db_engine_config` - Configuration information for the database engineNote: This field may return null, indicating that no valid value can be obtained. + * `db_engine` - Database engine that supports:1. postgresql (cloud database PostgreSQL);2. mssql_compatible (MSSQL compatible - cloud database PostgreSQL);Note: This field may return null, indicating that no valid value can be obtained. + * `db_instance_class` - sales specification ID. + * `db_instance_cpu` - the number of CPUs allocated by the instance. + * `db_instance_id` - instance ID. + * `db_instance_memory` - the memory size allocated by the instance, unit: GB. + * `db_instance_name` - instance name. + * `db_instance_net_info` - instance network connection information. + * `address` - DNS domain name. + * `ip` - IP address. + * `net_type` - network type, 1. inner (intranet address of the basic network); 2. private (intranet address of the private network); 3. public (extranet address of the basic network or private network);. + * `port` - connection port address. + * `protocol_type` - The protocol type for connecting to the database, currently supported: postgresql, mssql (MSSQL compatible syntax)Note: This field may return null, indicating that no valid value can be obtained. + * `status` - network connection status, 1. initing (unopened); 2. opened (opened); 3. closed (closed); 4. opening (opening); 5. closing (closed);. + * `subnet_id` - subnet IDNote: This field may return null, indicating that no valid value can be obtained. + * `vpc_id` - private network IDNote: This field may return null, indicating that no valid value can be obtained. + * `db_instance_status` - Instance status, respectively: applying (applying), init (to be initialized), initing (initializing), running (running), limited run (limited run), isolated (isolated), recycling (recycling ), recycled (recycled), job running (task execution), offline (offline), migrating (migration), expanding (expanding), waitSwitch (waiting for switching), switching (switching), readonly (read-only ), restarting (restarting), network changing (network changing), upgrading (kernel version upgrade). + * `db_instance_storage` - the size of the storage space allocated by the instance, unit: GB. + * `db_instance_type` - instance type, the types are: 1. primary (primary instance); 2. readonly (read-only instance); 3. guard (disaster recovery instance); 4. temp (temporary instance). + * `db_instance_version` - instance version, currently only supports standard (dual machine high availability version, one master and one slave). + * `db_kernel_version` - Database kernel versionNote: This field may return null, indicating that no valid value can be obtained. + * `db_major_version` - PostgreSQL major versionNote: This field may return null, indicating that no valid value can be obtained. + * `db_node_set` - Instance node informationNote: This field may return null, indicating that no valid value can be obtained. + * `role` - Node type, the value can be:Primary, representing the primary node;Standby, stands for standby node. + * `zone` - Availability zone where the node is located, such as ap-guangzhou-1. + * `db_version` - PostgreSQL version. + * `expire_time` - instance expiration time. + * `is_support_t_d_e` - Whether the instance supports TDE data encryption 0: not supported, 1: supportedNote: This field may return null, indicating that no valid value can be obtained. + * `isolated_time` - instance isolation time. + * `master_db_instance_id` - Master instance information, only returned when the instance is read-onlyNote: This field may return null, indicating that no valid value can be obtained. + * `network_access_list` - Instance network information list (this field is obsolete)Note: This field may return null, indicating that no valid value can be obtained. + * `resource_id` - Network resource id, instance id or RO group idNote: This field may return null, indicating that no valid value can be obtained. + * `resource_type` - Resource type, 1-instance 2-RO groupNote: This field may return null, indicating that no valid value can be obtained. + * `subnet_id` - subnet IDNote: This field may return null, indicating that no valid value can be obtained. + * `vip6` - IPV6 addressNote: This field may return null, indicating that no valid value can be obtained. + * `vip` - IPV4 addressNote: This field may return null, indicating that no valid value can be obtained. + * `vpc_id` - private network IDNote: This field may return null, indicating that no valid value can be obtained. + * `vpc_status` - Network status, 1-applying, 2-using, 3-deleting, 4-deletedNote: This field may return null, indicating that no valid value can be obtained. + * `vport` - access portNote: This field may return null, indicating that no valid value can be obtained. + * `offline_time` - offline timeNote: This field may return null, indicating that no valid value can be obtained. + * `pay_type` - billing mode, 1. prepaid (subscription, prepaid); 2. postpaid (billing by volume, postpaid). + * `project_id` - project ID. + * `read_only_instance_num` - Number of read-only instancesNote: This field may return null, indicating that no valid value can be obtained. + * `region` - The region to which the instance belongs, such as: ap-guangzhou, corresponding to the Region field of the RegionSet. + * `status_in_readonly_group` - Status of the read-only instance in the read-only groupNote: This field may return null, indicating that no valid value can be obtained. + * `subnet_id` - subnet ID. + * `support_ipv6` - Whether the instance supports Ipv6, 1: support, 0: not support. + * `tag_list` - Label information bound to the instanceNote: This field may return null, indicating that no valid value can be obtained. + * `tag_key` - label key. + * `tag_value` - tag value. + * `type` - machine type. + * `uid` - Uid of the instance. + * `update_time` - The time when the instance performed the last update. + * `vpc_id` - private network ID. + * `zone` - Availability zone to which the instance belongs, such as: ap-guangzhou-3, corresponding to the Zone field of ZoneSet. + * `read_only_group_id` - read-only group idNote: This field may return null, indicating that no valid value can be obtained. + * `read_only_group_name` - read-only group nameNote: This field may return null, indicating that no valid value can be obtained. + * `rebalance` - automatic load balancing switch. + * `region` - region id. + * `replay_lag_eliminate` - delay time switch. + * `replay_latency_eliminate` - delay size switch. + * `status` - state. + * `subnet_id` - subnet-idNote: This field may return null, indicating that no valid value can be obtained. + * `vpc_id` - virtual network id. + * `zone` - region id. + + diff --git a/config/docs/d/postgresql_recovery_time.html.markdown b/config/docs/d/postgresql_recovery_time.html.markdown new file mode 100644 index 0000000..5d04972 --- /dev/null +++ b/config/docs/d/postgresql_recovery_time.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_recovery_time" +sidebar_current: "docs-tencentcloud-datasource-postgresql_recovery_time" +description: |- + Use this data source to query detailed information of postgresql recovery_time +--- + +# tencentcloud_postgresql_recovery_time + +Use this data source to query detailed information of postgresql recovery_time + +## Example Usage + +```hcl +data "tencentcloud_postgresql_recovery_time" "recovery_time" { + db_instance_id = local.pgsql_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String) Instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `recovery_begin_time` - The earliest restoration time (UTC+8). +* `recovery_end_time` - The latest restoration time (UTC+8). + + diff --git a/config/docs/d/postgresql_regions.html.markdown b/config/docs/d/postgresql_regions.html.markdown new file mode 100644 index 0000000..0e35eb7 --- /dev/null +++ b/config/docs/d/postgresql_regions.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_regions" +sidebar_current: "docs-tencentcloud-datasource-postgresql_regions" +description: |- + Use this data source to query detailed information of postgresql regions +--- + +# tencentcloud_postgresql_regions + +Use this data source to query detailed information of postgresql regions + +## Example Usage + +```hcl +data "tencentcloud_postgresql_regions" "regions" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `region_set` - Region information set. + * `region_id` - Region number. + * `region_name` - Region name. + * `region_state` - Availability status. UNAVAILABLE: unavailable, AVAILABLE: available. + * `region` - Region abbreviation. + * `support_international` - Whether the resource can be purchased in this region. Valid values: `0` (no), `1` (yes).Note: this field may return `null`, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/postgresql_specinfos.html.markdown b/config/docs/d/postgresql_specinfos.html.markdown new file mode 100644 index 0000000..1f8326d --- /dev/null +++ b/config/docs/d/postgresql_specinfos.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_specinfos" +sidebar_current: "docs-tencentcloud-datasource-postgresql_specinfos" +description: |- + Use this data source to get the available product configs of the postgresql instance. +--- + +# tencentcloud_postgresql_specinfos + +Use this data source to get the available product configs of the postgresql instance. + +## Example Usage + +```hcl +data "tencentcloud_postgresql_specinfos" "foo" { + availability_zone = "ap-shanghai-2" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Required, String) The zone of the postgresql instance to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of zones will be exported and its every element contains the following attributes: + * `cpu` - The CPU number of the postgresql instance. + * `engine_version_name` - Version name of the postgresql database engine. + * `engine_version` - Version of the postgresql database engine. + * `id` - ID of the postgresql instance speccode. + * `memory` - Memory size(in GB). + * `qps` - The QPS of the postgresql instance. + * `storage_max` - The maximum volume size(in GB). + * `storage_min` - The minimum volume size(in GB). + + diff --git a/config/docs/d/postgresql_xlogs.html.markdown b/config/docs/d/postgresql_xlogs.html.markdown new file mode 100644 index 0000000..b010bfc --- /dev/null +++ b/config/docs/d/postgresql_xlogs.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_xlogs" +sidebar_current: "docs-tencentcloud-datasource-postgresql_xlogs" +description: |- + Provide a datasource to query PostgreSQL Xlogs. +--- + +# tencentcloud_postgresql_xlogs + +Provide a datasource to query PostgreSQL Xlogs. + +## Example Usage + +```hcl +data "tencentcloud_postgresql_xlogs" "foo" { + instance_id = "postgres-xxxxxxxx" + start_time = "2022-01-01 00:00:00" + end_time = "2022-01-07 01:02:03" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) PostgreSQL instance id. +* `end_time` - (Optional, String) Xlog end time, format `yyyy-MM-dd hh:mm:ss`. +* `result_output_file` - (Optional, String) Used for save results. +* `start_time` - (Optional, String) Xlog start time, format `yyyy-MM-dd hh:mm:ss`, start time cannot before 7 days ago. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - List of Xlog query result. + * `end_time` - Xlog file created end time. + * `external_addr` - Xlog external download address. + * `id` - Xlog id. + * `internal_addr` - Xlog internal download address. + * `size` - Xlog file size. + * `start_time` - Xlog file created start time. + + diff --git a/config/docs/d/postgresql_zones.html.markdown b/config/docs/d/postgresql_zones.html.markdown new file mode 100644 index 0000000..d55b18b --- /dev/null +++ b/config/docs/d/postgresql_zones.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_zones" +sidebar_current: "docs-tencentcloud-datasource-postgresql_zones" +description: |- + Use this data source to query detailed information of postgresql zones +--- + +# tencentcloud_postgresql_zones + +Use this data source to query detailed information of postgresql zones + +## Example Usage + +```hcl +data "tencentcloud_postgresql_zones" "zones" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `zone_set` - AZ information set. + * `standby_zone_set` - AZs that can be used as standby when this AZ is primaryNote: this field may return `null`, indicating that no valid values can be obtained. + * `zone_id` - AZ number. + * `zone_name` - AZ name. + * `zone_state` - Availability status. Valid values:`UNAVAILABLE`.`AVAILABLE`.`SELLOUT`.`SUPPORTMODIFYONLY` (supports configuration adjustment). + * `zone_support_ipv6` - Whether the AZ supports IPv6 address access. + * `zone` - AZ abbreviation. + + diff --git a/config/docs/d/private_dns_records.html.markdown b/config/docs/d/private_dns_records.html.markdown new file mode 100644 index 0000000..7b2212c --- /dev/null +++ b/config/docs/d/private_dns_records.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "PrivateDNS" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_private_dns_records" +sidebar_current: "docs-tencentcloud-datasource-private_dns_records" +description: |- + Use this data source to query detailed information of private dns records +--- + +# tencentcloud_private_dns_records + +Use this data source to query detailed information of private dns records + +## Example Usage + +```hcl +data "tencentcloud_private_dns_records" "private_dns_record" { + zone_id = "zone-xxxxxx" + filters { + name = "Value" + values = ["8.8.8.8"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `zone_id` - (Required, String) Private zone id: zone-xxxxxx. +* `filters` - (Optional, List) Filter parameters (Value and RecordType filtering are supported). +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Parameter name. +* `values` - (Required, Set) Parameter values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `record_set` - Parse record list. + * `created_on` - Record creation time. + * `enabled` - Enabled. 0 meaning paused, 1 meaning senabled. + * `extra` - Additional information. + * `mx` - MX priority: required if the record type is MX. Value range: 5,10,15,20,30,40,50. + * `record_id` - Record sid. + * `record_type` - Record type, optional record type are: A, AAAA, CNAME, MX, TXT, PTR. + * `record_value` - Record value. + * `status` - Record status. + * `sub_domain` - Subdomain name. + * `ttl` - Record cache time, the smaller the value, the faster it takes effect. The value is 1-86400s. The default is 600. + * `updated_on` - Record update time. + * `weight` - Record weight, value is 1-100. + * `zone_id` - Private zone id: zone-xxxxxx. + + diff --git a/config/docs/d/projects.html.markdown b/config/docs/d/projects.html.markdown new file mode 100644 index 0000000..7bde152 --- /dev/null +++ b/config/docs/d/projects.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Project" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_projects" +sidebar_current: "docs-tencentcloud-datasource-projects" +description: |- + Use this data source to query detailed information of tag project +--- + +# tencentcloud_projects + +Use this data source to query detailed information of tag project + +## Example Usage + +```hcl +data "tencentcloud_projects" "project" { + all_list = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `all_list` - (Required, Int) 1 means to list all project, 0 means to list visible project. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `projects` - List of projects. + * `create_time` - Create time. + * `creator_uin` - Uin of Creator. + * `project_id` - ID of Project. + * `project_info` - Description of project. + * `project_name` - Name of Project. + + diff --git a/config/docs/d/protocol_template_groups.html.markdown b/config/docs/d/protocol_template_groups.html.markdown new file mode 100644 index 0000000..3ea6da0 --- /dev/null +++ b/config/docs/d/protocol_template_groups.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_protocol_template_groups" +sidebar_current: "docs-tencentcloud-datasource-protocol_template_groups" +description: |- + Use this data source to query detailed information of protocol template groups. +--- + +# tencentcloud_protocol_template_groups + +Use this data source to query detailed information of protocol template groups. + +## Example Usage + +```hcl +data "tencentcloud_protocol_template_groups" "name" { + name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the protocol template group to query. +* `name` - (Optional, String) Name of the protocol template group to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `group_list` - Information list of the dedicated protocol template groups. + * `id` - Id of the protocol template group. + * `name` - Name of protocol template group. + * `template_ids` - ID set of the protocol template. + + diff --git a/config/docs/d/protocol_templates.html.markdown b/config/docs/d/protocol_templates.html.markdown new file mode 100644 index 0000000..485088e --- /dev/null +++ b/config/docs/d/protocol_templates.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_protocol_templates" +sidebar_current: "docs-tencentcloud-datasource-protocol_templates" +description: |- + Use this data source to query detailed information of protocol templates. +--- + +# tencentcloud_protocol_templates + +Use this data source to query detailed information of protocol templates. + +## Example Usage + +```hcl +data "tencentcloud_protocol_templates" "name" { + name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the protocol template to query. +* `name` - (Optional, String) Name of the protocol template to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `template_list` - Information list of the dedicated protocol templates. + * `id` - ID of the protocol template. + * `name` - Name of protocol template. + * `protocols` - Set of the protocols. + + diff --git a/config/docs/d/pts_scenario_with_jobs.html.markdown b/config/docs/d/pts_scenario_with_jobs.html.markdown new file mode 100644 index 0000000..82db22c --- /dev/null +++ b/config/docs/d/pts_scenario_with_jobs.html.markdown @@ -0,0 +1,282 @@ +--- +subcategory: "Performance Testing Service(PTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_pts_scenario_with_jobs" +sidebar_current: "docs-tencentcloud-datasource-pts_scenario_with_jobs" +description: |- + Use this data source to query detailed information of pts scenario_with_jobs +--- + +# tencentcloud_pts_scenario_with_jobs + +Use this data source to query detailed information of pts scenario_with_jobs + +## Example Usage + +```hcl +data "tencentcloud_pts_scenario_with_jobs" "scenario_with_jobs" { + project_ids = ["project-45vw7v82"] + scenario_ids = ["scenario-koakp3h6"] + scenario_name = "pts-jmeter" + ascend = true + ignore_script = true + ignore_dataset = true + scenario_type = "pts-jmeter" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_ids` - (Required, Set: [`String`]) Project ID list. +* `ascend` - (Optional, Bool) Whether to use ascending order. +* `ignore_dataset` - (Optional, Bool) Whether to ignore the dataset. +* `ignore_script` - (Optional, Bool) Whether to ignore the script content. +* `order_by` - (Optional, String) The field column used for ordering. +* `owner` - (Optional, String) The job owner. +* `result_output_file` - (Optional, String) Used to save results. +* `scenario_ids` - (Optional, Set: [`String`]) Scenario ID list. +* `scenario_name` - (Optional, String) Scenario name. +* `scenario_type` - (Optional, String) Scenario type, e.g.: pts-http, pts-js, pts-trpc, pts-jmeter. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `scenario_with_jobs_set` - The scenario configuration and its jobs. + * `jobs` - Jobs related to the scenario. + * `abort_reason` - The reason for aborting the job. + * `configs` - Deprecated. + * `created_at` - The job creation time. + * `cron_id` - Cron job ID. + * `datasets` - The test data sets. + * `file_id` - File ID. + * `head_lines` - The header lines of the file. + * `header_columns` - The parameter name list. + * `header_in_file` - Whether the first line contains the parameter names. + * `line_count` - The line count of the file. + * `name` - Test data set name. + * `size` - File size. + * `split` - Whether to split the test data. + * `tail_lines` - The tail lines of the file. + * `type` - File type. + * `updated_at` - The time of the most recent update. + * `debug` - Whether to run the job in the debug mode. The default value is false. + * `domain_name_config` - The configuration for parsing domain names. + * `dns_config` - The DNS configuration. + * `nameservers` - DNS IP list. + * `host_aliases` - The configuration for host aliases. + * `host_names` - Host names. + * `ip` - IP. + * `duration` - Job running duration. + * `end_time` - The job ending time. + * `error_rate` - Error rate. + * `extensions` - Deprecated. + * `job_id` - Job ID. + * `job_owner` - Job owner. + * `load_source_infos` - The load source information. + * `ip` - The IP of the load source. + * `pod_name` - The pod name of the load source. + * `region` - Region. + * `load_sources` - Deprecated. + * `ip` - The IP of the load source. + * `pod_name` - The pod name of the load source. + * `region` - Region. + * `load` - The configuration of the load. + * `geo_regions_load_distribution` - The geographical distribution of the load source. + * `percentage` - Percentage. + * `region_id` - Region ID. + * `region` - Region. + * `load_spec` - The specification of the load configuration. + * `concurrency` - The configuration of the concurrency load test mode. + * `graceful_stop_seconds` - The waiting period for a graceful shutdown. + * `iteration_count` - The iteration count. + * `max_requests_per_second` - The maximum RPS. + * `resources` - The count of the load test resource. + * `stages` - The multi-stage configuration. + * `duration_seconds` - The execution time. + * `target_virtual_users` - The target count of the virtual users. + * `requests_per_second` - The configuration of the RPS mode load test. + * `duration_seconds` - The execution time. + * `graceful_stop_seconds` - The waiting period for a gracefulshutdown. + * `max_requests_per_second` - The maximum RPS. + * `resources` - The count of the load test resource. + * `start_requests_per_second` - The starting minimum RPS. + * `target_requests_per_second` - The target RPS. + * `target_virtual_users` - Deprecated. + * `script_origin` - The script origin. + * `duration_seconds` - The execution time. + * `machine_number` - Machine number. + * `machine_specification` - Machine specification. + * `vpc_load_distribution` - The distribution of the load source. + * `region_id` - Region ID. + * `region` - Region. + * `subnet_ids` - The subnet ID list. + * `vpc_id` - VPC ID. + * `max_requests_per_second` - The maximum RPS. + * `max_virtual_user_count` - The maximum VU of the job. + * `message` - The message describing the job running status. + * `network_receive_rate` - The rate of receiving bytes. + * `network_send_rate` - The rate of sending bytes. + * `note` - The note of the job. + * `notification_hooks` - Notification hooks. + * `events` - Notification hook. + * `url` - The callback URL. + * `plugins` - Plugins. + * `file_id` - File ID. + * `name` - File name. + * `size` - File size. + * `type` - File type. + * `updated_at` - The time of the most recent update. + * `project_id` - Project ID. + * `project_name` - Project name. + * `protocols` - The protocol file. + * `file_id` - File ID. + * `name` - File name. + * `size` - File size. + * `type` - File type. + * `updated_at` - The time of the most recent update. + * `request_files` - The files in the request. + * `file_id` - File ID. + * `name` - File name. + * `size` - File size. + * `type` - File type. + * `updated_at` - The time of the most recent update. + * `request_total` - The total reqeust count. + * `requests_per_second` - RPS. + * `response_time_average` - The average response time. + * `response_time_max` - The maximum response time. + * `response_time_min` - The minimum response time. + * `response_time_p90` - The 90 percentile of the response time. + * `response_time_p95` - The 95 percentile of the response time. + * `response_time_p99` - The 99 percentile of the response time. + * `scenario_id` - Scenario ID. + * `scenario_name` - Scenario name. + * `scripts` - Deprecated. + * `start_time` - The job starting time. + * `status` - Job running status. JobUnknown: 0,JobCreated:1,JobPending:2, JobPreparing:3,JobSelectClustering:4,JobCreateTasking:5,JobSyncTasking:6 JobRunning:11,JobFinished:12,JobPrepareException:13,JobFinishException:14,JobAborting:15,JobAborted:16,JobAbortException:17,JobDeleted:18, JobSelectClusterException:19,JobCreateTaskException:20,JobSyncTaskException:21. + * `test_scripts` - Test scripts. + * `encoded_content` - The base64 encoded content. + * `encoded_http_archive` - The base64 encoded HAR. + * `file_id` - File ID. + * `load_weight` - The weight of the script, ranging from 1 to 100. + * `name` - File name. + * `size` - File size. + * `type` - File type. + * `updated_at` - The time of the most recent update. + * `type` - Scenario type. + * `scenario` - The returned scenario. + * `app_id` - AppId. + * `configs` - Deprecated. + * `created_at` - The creation time of the scenario. + * `cron_id` - The cron job ID. + * `datasets` - The test data sets for the load test. + * `file_id` - The file ID. + * `head_lines` - The header lines of the file. + * `header_columns` - The parameter name list. + * `header_in_file` - Whether the first line contains the parameter names. + * `line_count` - The line count of the file. + * `name` - The file name of the test data sets. + * `size` - The byte count of the file. + * `split` - Whether to split the test data. + * `tail_lines` - The tail lines of the file. + * `type` - The file type. + * `updated_at` - The update time of the file. + * `description` - Scenario description. + * `domain_name_config` - The configuration for parsing domain names. + * `dns_config` - The DNS configuration. + * `nameservers` - DNS IP list. + * `host_aliases` - The configuration for host aliases. + * `host_names` - Host names. + * `ip` - IP. + * `encoded_scripts` - Deprecated. + * `extensions` - Deprecated. + * `load` - Scenario is load test configuration. + * `geo_regions_load_distribution` - The geographical distribution of the load source. + * `percentage` - Percentage. + * `region_id` - Region ID. + * `region` - Region. + * `load_spec` - Scenario is load specification. + * `concurrency` - The configuration for the concurrency mode. + * `graceful_stop_seconds` - The waiting period for a graceful shutdown. + * `iteration_count` - The iteration count of the load test. + * `max_requests_per_second` - The maximum RPS. + * `resources` - The resource count of the load test. + * `stages` - The configuration for the multi-stage load test. + * `duration_seconds` - The execution time for the load test. + * `target_virtual_users` - The number of the target virtual users. + * `requests_per_second` - The configuration of the RPS mode load test. + * `duration_seconds` - The execution time of the load test. + * `graceful_stop_seconds` - The waiting period for a graceful shutdown. + * `max_requests_per_second` - The maximum RPS. + * `resources` - The recource count of the load test. + * `start_requests_per_second` - The starting minimum RPS. + * `target_requests_per_second` - The target RPS. + * `target_virtual_users` - Deprecated. + * `script_origin` - The script origin. + * `duration_seconds` - The load test execution time. + * `machine_number` - The load test machine number. + * `machine_specification` - The load test machine specification. + * `vpc_load_distribution` - The distribution of the load source. + * `region_id` - Region ID. + * `region` - Region. + * `subnet_ids` - The subnet ID list. + * `vpc_id` - The VPC ID. + * `name` - Scenario name. + * `notification_hooks` - The notification hooks. + * `events` - The notification hook. + * `url` - The callback URL. + * `owner` - The owner. + * `plugins` - Plugins. + * `file_id` - File ID. + * `name` - File name. + * `size` - File size. + * `type` - File type. + * `updated_at` - The time of the most recent update. + * `project_id` - Project ID. + * `project_name` - Project name. + * `protocols` - The protocol file. + * `file_id` - File ID. + * `name` - File name. + * `size` - File size. + * `type` - File type. + * `updated_at` - The time of the most recent update. + * `request_files` - The files in the request. + * `file_id` - File ID. + * `name` - File name. + * `size` - File size. + * `type` - File type. + * `updated_at` - The time of the most recent update. + * `scenario_id` - Scenario ID. + * `sla_id` - The ID of the SLA policy. + * `sla_policy` - The SLA policy. + * `alert_channel` - The alert channel. + * `amp_consumer_id` - AMP consumer ID. + * `notice_id` - The notice ID bound with this alert channel. + * `sla_rules` - The SLA rules. + * `abort_flag` - Whether to abort the load test job. + * `aggregation` - The aggregation method of the metrics. + * `condition` - The operator for checking the condition. + * `for` - The duration for checking the condition. + * `label_filter` - The label filter. + * `label_name` - Label name. + * `label_value` - Label value. + * `metric` - The load test metrics. + * `value` - The threshold in the condition. + * `status` - Scenario status. + * `sub_account_uin` - SubAccountUin. + * `test_scripts` - The script of the load test. + * `encoded_content` - The base64 encoded content. + * `encoded_http_archive` - The base64 encoded HAR. + * `file_id` - File ID. + * `load_weight` - The weight of the script, ranging from 1 to 100. + * `name` - File name. + * `size` - File size. + * `type` - File type. + * `updated_at` - The time of the most recent update. + * `type` - Scenario type, e.g.: pts-http, pts-js, pts-trpc, pts-jmeter. + * `uin` - Uin. + * `updated_at` - The updating time of the scenario. + + diff --git a/config/docs/d/redis_backup.html.markdown b/config/docs/d/redis_backup.html.markdown new file mode 100644 index 0000000..8ed5fb0 --- /dev/null +++ b/config/docs/d/redis_backup.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_backup" +sidebar_current: "docs-tencentcloud-datasource-redis_backup" +description: |- + Use this data source to query detailed information of redis backup +--- + +# tencentcloud_redis_backup + +Use this data source to query detailed information of redis backup + +## Example Usage + +```hcl +data "tencentcloud_redis_backup" "backup" { + instance_id = "crs-c1nl9rpv" + begin_time = "2023-04-07 03:57:30" + end_time = "2023-04-07 03:57:56" + status = [2] + instance_name = "Keep-terraform" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `begin_time` - (Optional, String) start time, such as 2017-02-08 19:09:26.Query the list of backups that the instance started backing up during the [beginTime, endTime] time period. +* `end_time` - (Optional, String) End time, such as 2017-02-08 19:09:26.Query the list of backups that the instance started backing up during the [beginTime, endTime] time period. +* `instance_id` - (Optional, String) The ID of instance. +* `instance_name` - (Optional, String) Instance name, which supports fuzzy search based on instance name. +* `result_output_file` - (Optional, String) Used to save results. +* `status` - (Optional, Set: [`Int`]) Status of the backup task:1: Backup is in the process.2: The backup is normal.3: Backup to RDB file processing.4: RDB conversion completed.-1: The backup has expired.-2: Backup deleted. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `backup_set` - An array of backups for the instance. + * `backup_id` - Backup ID. + * `backup_size` - Internal fields, which can be ignored by the user. + * `backup_type` - Backup type.1: User-initiated manual backup.0: System-initiated backup in the early morning. + * `end_time` - Backup end time. + * `expire_time` - Backup file expiration time. + * `file_type` - Back up file types. + * `full_backup` - Internal fields, which can be ignored by the user. + * `instance_id` - The ID of instance. + * `instance_name` - The name of instance. + * `instance_type` - Internal fields, which can be ignored by the user. + * `locked` - Whether the backup is locked.0: Not locked.1: Has been locked. + * `region` - The region where the backup is located. + * `remark` - Notes information for the backup. + * `start_time` - Backup start time. + * `status` - Backup status.1: The backup is locked by another process.2: The backup is normal and not locked by any process.-1: The backup has expired.3: The backup is being exported.4: The backup export is successful. + + diff --git a/config/docs/d/redis_backup_download_info.html.markdown b/config/docs/d/redis_backup_download_info.html.markdown new file mode 100644 index 0000000..9c6afd3 --- /dev/null +++ b/config/docs/d/redis_backup_download_info.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_backup_download_info" +sidebar_current: "docs-tencentcloud-datasource-redis_backup_download_info" +description: |- + Use this data source to query detailed information of redis backup_download_info +--- + +# tencentcloud_redis_backup_download_info + +Use this data source to query detailed information of redis backup_download_info + +## Example Usage + +```hcl +data "tencentcloud_redis_backup_download_info" "backup_download_info" { + instance_id = "crs-iw7d9wdd" + backup_id = "641186639-8362913-1516672770" + # limit_type = "NoLimit" + # vpc_comparison_symbol = "In" + # ip_comparison_symbol = "In" + # limit_vpc { + # region = "ap-guangzhou" + # vpc_list = [""] + # } + # limit_ip = [""] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_id` - (Required, String) The backup ID, which can be accessed via [DescribeInstanceBackups](https://cloud.tencent.com/document/product/239/20011) interface returns the parameter RedisBackupSet to get. +* `instance_id` - (Required, String) The ID of instance. +* `ip_comparison_symbol` - (Optional, String) Identifies whether the customized LimitIP address can download the backup file.- In: Custom IP addresses are available for download.- NotIn: Custom IPs are not available for download. +* `limit_ip` - (Optional, Set: [`String`]) A custom VPC IP address for downloadable backup files.If the parameter LimitType is **Customize**, you need to configure this parameter. +* `limit_type` - (Optional, String) Types of network restrictions for downloading backup files:- NoLimit: There is no limit, and backup files can be downloaded from both Tencent Cloud and internal and external networks.- LimitOnlyIntranet: Only intranet addresses automatically assigned by Tencent Cloud can download backup files.- Customize: refers to a user-defined private network downloadable backup file. +* `limit_vpc` - (Optional, List) A custom VPC ID for a downloadable backup file.If the parameter LimitType is **Customize**, you need to configure this parameter. +* `result_output_file` - (Optional, String) Used to save results. +* `vpc_comparison_symbol` - (Optional, String) This parameter only supports entering In, which means that the custom LimitVpc can download the backup file. + +The `limit_vpc` object supports the following: + +* `region` - (Required, String) Customize the region of the VPC to which the backup file is downloaded. +* `vpc_list` - (Required, Set) Customize the list of VPCs to download backup files. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `backup_infos` - A list of backup file information. + * `download_url` - Backup file download address on the Internet (6 hours). + * `file_name` - Backup file name. + * `file_size` - The backup file size is in unit B, if it is 0, it is invalid. + * `inner_download_url` - Backup file intranet download address (6 hours). + + diff --git a/config/docs/d/redis_instance_node_info.html.markdown b/config/docs/d/redis_instance_node_info.html.markdown new file mode 100644 index 0000000..a7a0953 --- /dev/null +++ b/config/docs/d/redis_instance_node_info.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_instance_node_info" +sidebar_current: "docs-tencentcloud-datasource-redis_instance_node_info" +description: |- + Use this data source to query detailed information of redis instance_node_info +--- + +# tencentcloud_redis_instance_node_info + +Use this data source to query detailed information of redis instance_node_info + +## Example Usage + +```hcl +data "tencentcloud_redis_instance_node_info" "instance_node_info" { + instance_id = "crs-c1nl9rpv" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of instance. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `proxy_count` - Number of proxy nodes. +* `proxy` - Proxy node information. + * `node_id` - Node ID. + * `zone_id` - Zone ID. +* `redis_count` - Number of redis nodes. +* `redis` - Redis node information. + * `cluster_id` - Shard ID. + * `node_id` - Node ID. + * `node_role` - Node role. + * `zone_id` - Zone ID. + + diff --git a/config/docs/d/redis_instance_shards.html.markdown b/config/docs/d/redis_instance_shards.html.markdown new file mode 100644 index 0000000..bebe88d --- /dev/null +++ b/config/docs/d/redis_instance_shards.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_instance_shards" +sidebar_current: "docs-tencentcloud-datasource-redis_instance_shards" +description: |- + Use this data source to query detailed information of redis instance_shards +--- + +# tencentcloud_redis_instance_shards + +Use this data source to query detailed information of redis instance_shards + +## Example Usage + +```hcl +data "tencentcloud_redis_instance_shards" "instance_shards" { + instance_id = "crs-c1nl9rpv" + filter_slave = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of instance. +* `filter_slave` - (Optional, Bool) Whether to filter out slave information. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_shards` - Instance shard list information. + * `connected` - Service status: 0-down;1-on. + * `keys` - Number of keys. + * `role` - role. + * `runid` - The node ID of the instance runtime. + * `shard_id` - Shard node ID. + * `shard_name` - Shard node name. + * `slots` - Slot information. + * `storage_slope` - Capacity tilt. + * `storage` - Used capacity. + + diff --git a/config/docs/d/redis_instance_task_list.html.markdown b/config/docs/d/redis_instance_task_list.html.markdown new file mode 100644 index 0000000..fb6701a --- /dev/null +++ b/config/docs/d/redis_instance_task_list.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_instance_task_list" +sidebar_current: "docs-tencentcloud-datasource-redis_instance_task_list" +description: |- + Use this data source to query detailed information of redis instance_task_list +--- + +# tencentcloud_redis_instance_task_list + +Use this data source to query detailed information of redis instance_task_list + +## Example Usage + +```hcl +data "tencentcloud_redis_instance_task_list" "instance_task_list" { + instance_id = "crs-c1nl9rpv" + instance_name = "" + project_ids = [""] + task_types = [""] + begin_time = "2021-12-30 00:00:00" + end_time = "2021-12-30 00:00:00" + task_status = [""] + result = [""] + operate_uin = [""] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `begin_time` - (Optional, String) Start time. +* `end_time` - (Optional, String) Termination time. +* `instance_id` - (Optional, String) The ID of instance. +* `instance_name` - (Optional, String) Instance name. +* `operate_uin` - (Optional, Set: [`String`]) Operator Uin. +* `project_ids` - (Optional, Set: [`Int`]) Project Id. +* `result_output_file` - (Optional, String) Used to save results. +* `result` - (Optional, Set: [`Int`]) Task status. +* `task_status` - (Optional, Set: [`Int`]) Task status. +* `task_types` - (Optional, Set: [`String`]) Task type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `tasks` - Task details. + * `end_time` - The end time. + * `instance_id` - The ID of instance. + * `instance_name` - The name of instance. + * `progress` - Task progress. + * `project_id` - The project ID. + * `result` - Task status. + * `start_time` - Start time. + * `task_id` - Task ID. + * `task_type` - Task type. + + diff --git a/config/docs/d/redis_instance_zone_info.html.markdown b/config/docs/d/redis_instance_zone_info.html.markdown new file mode 100644 index 0000000..b81cbf4 --- /dev/null +++ b/config/docs/d/redis_instance_zone_info.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_instance_zone_info" +sidebar_current: "docs-tencentcloud-datasource-redis_instance_zone_info" +description: |- + Use this data source to query detailed information of redis instance_zone_info +--- + +# tencentcloud_redis_instance_zone_info + +Use this data source to query detailed information of redis instance_zone_info + +## Example Usage + +```hcl +data "tencentcloud_redis_instance_zone_info" "instance_zone_info" { + instance_id = "crs-c1nl9rpv" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Optional, String) The ID of instance. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `replica_groups` - List of instance node groups. + * `group_id` - Node group ID. + * `group_name` - Node group Name. + * `redis_nodes` - Node group node list. + * `keys` - The number of node keys. + * `node_id` - Node ID. + * `role` - Node role. + * `slot` - Node slot distribution. + * `status` - Node status. + * `role` - The node group type, master is the primary node, and replica is the replica node. + * `zone_id` - he availability zone ID of the node, such as ap-guangzhou-1. + + diff --git a/config/docs/d/redis_instances.html.markdown b/config/docs/d/redis_instances.html.markdown new file mode 100644 index 0000000..444bc3a --- /dev/null +++ b/config/docs/d/redis_instances.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_instances" +sidebar_current: "docs-tencentcloud-datasource-redis_instances" +description: |- + Use this data source to query the detail information of redis instance. +--- + +# tencentcloud_redis_instances + +Use this data source to query the detail information of redis instance. + +## Example Usage + +```hcl +data "tencentcloud_redis_instances" "redislab" { + zone = "ap-hongkong-1" + search_key = "myredis" + project_id = 0 + limit = 20 + result_output_file = "/tmp/redis_instances" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `limit` - (Optional, Int) The number limitation of results for a query. +* `project_id` - (Optional, Int) ID of the project to which redis instance belongs. +* `result_output_file` - (Optional, String) Used to save results. +* `search_key` - (Optional, String) Key words used to match the results, and the key words can be: instance ID, instance name and IP address. +* `tags` - (Optional, Map) Tags of redis instance. +* `zone` - (Optional, String) ID of an available zone. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - A list of redis instance. Each element contains the following attributes: + * `charge_type` - The charge type of instance. Valid values are `POSTPAID` and `PREPAID`. + * `create_time` - The time when the instance is created. + * `ip` - IP address of an instance. + * `mem_size` - Memory size in MB. + * `name` - Name of a redis instance. + * `node_info` - List of instance node information. Currently, information about the node type (master or replica) and node availability zone can be passed in. + * `id` - ID of the master or replica node. + * `master` - Indicates whether the node is master. + * `zone_id` - ID of the availability zone of the master or replica node. + * `port` - The port used to access a redis instance. + * `project_id` - ID of the project to which a redis instance belongs. + * `redis_id` - ID of a redis instance. + * `redis_replicas_num` - The number of instance copies. + * `redis_shard_num` - The number of instance shard. + * `status` - Current status of an instance, maybe: `init`, `processing`, `online`, `isolate` and `todelete`. + * `subnet_id` - ID of the vpc subnet. + * `tags` - Tags of an instance. + * `type_id` - Instance type. Refer to `data.tencentcloud_redis_zone_config.list.type_id` get available values. + * `type` - (**Deprecated**) It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: `master_slave_redis`, `master_slave_ckv`, `cluster_ckv`, `cluster_redis` and `standalone_redis`. + * `vpc_id` - ID of the vpc with which the instance is associated. + * `zone` - Available zone to which a redis instance belongs. + + diff --git a/config/docs/d/redis_param_records.html.markdown b/config/docs/d/redis_param_records.html.markdown new file mode 100644 index 0000000..d07af0e --- /dev/null +++ b/config/docs/d/redis_param_records.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_param_records" +sidebar_current: "docs-tencentcloud-datasource-redis_param_records" +description: |- + Use this data source to query detailed information of redis param records +--- + +# tencentcloud_redis_param_records + +Use this data source to query detailed information of redis param records + +## Example Usage + +```hcl +data "tencentcloud_redis_param_records" "param_records" { + instance_id = "crs-c1nl9rpv" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of instance. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_param_history` - The parameter name. + * `modify_time` - Modification time. + * `new_value` - The modified value. + * `param_name` - The parameter name. + * `pre_value` - Modify the previous value. + * `status` - Parameter status:1: parameter configuration modification.2: The parameter configuration is modified successfully.3: Parameter configuration modification failed. + + diff --git a/config/docs/d/redis_zone_config.html.markdown b/config/docs/d/redis_zone_config.html.markdown new file mode 100644 index 0000000..07f1444 --- /dev/null +++ b/config/docs/d/redis_zone_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_zone_config" +sidebar_current: "docs-tencentcloud-datasource-redis_zone_config" +description: |- + Use this data source to query which instance types of Redis are available in a specific region. +--- + +# tencentcloud_redis_zone_config + +Use this data source to query which instance types of Redis are available in a specific region. + +## Example Usage + +```hcl +data "tencentcloud_redis_zone_config" "redislab" { + region = "ap-hongkong" + result_output_file = "/temp/mytestpath" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `region` - (Optional, String) Name of a region. If this value is not set, the current region getting from provider's configuration will be used. +* `result_output_file` - (Optional, String) Used to save results. +* `type_id` - (Optional, Int) Instance type ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of zone. Each element contains the following attributes: + * `mem_sizes` - (**Deprecated**) It has been deprecated from version 1.26.0. Use `shard_memories` instead. The memory volume of an available instance(in MB). + * `redis_replicas_nums` - The support numbers of instance copies. + * `redis_shard_nums` - The support numbers of instance shard. + * `shard_memories` - The memory volume list of an available instance shard(in MB). + * `type_id` - Instance type. Which redis type supports in this zone. + * `type` - (**Deprecated**) It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: `master_slave_redis`, `master_slave_ckv`, `cluster_ckv`, `cluster_redis` and `standalone_redis`. + * `version` - Version description of an available instance. Possible values: `Redis 3.2`, `Redis 4.0`. + * `zone` - ID of available zone. + + diff --git a/config/docs/d/reserved_instance_configs.html.markdown b/config/docs/d/reserved_instance_configs.html.markdown new file mode 100644 index 0000000..3fd3ca6 --- /dev/null +++ b/config/docs/d/reserved_instance_configs.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_reserved_instance_configs" +sidebar_current: "docs-tencentcloud-datasource-reserved_instance_configs" +description: |- + Use this data source to query reserved instances configuration. +--- + +# tencentcloud_reserved_instance_configs + +Use this data source to query reserved instances configuration. + +## Example Usage + +```hcl +data "tencentcloud_reserved_instance_configs" "config" { + availability_zone = "na-siliconvalley-1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Optional, String) The available zone that the reserved instance locates at. +* `duration` - (Optional, Int) Validity period of the reserved instance. Valid values are `31536000`(1 year) and `94608000`(3 years). +* `instance_type` - (Optional, String) The type of reserved instance. +* `offering_type` - (Optional, String) Filter by Payment Type. Such as All Upfront. +* `product_description` - (Optional, String) Filter by the Platform Description (that is, operating system) for Reserved Instance billing. Shaped like: linux. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `config_list` - An information list of reserved instance configuration. Each element contains the following attributes: + * `availability_zone` - Availability zone of the purchasable reserved instance. + * `config_id` - Configuration ID of the purchasable reserved instance. + * `currency_code` - Settlement currency of the reserved instance, which is a standard currency code as listed in ISO 4217. + * `duration` - Validity period of the reserved instance. + * `instance_type` - Instance type of the reserved instance. + * `offering_type` - OfferingType of the reserved instance. + * `platform` - Platform of the reserved instance. + * `price` - Purchase price of the reserved instance. + * `usage_price` - UsagePrice of the reserved instance. + + diff --git a/config/docs/d/reserved_instances.html.markdown b/config/docs/d/reserved_instances.html.markdown new file mode 100644 index 0000000..08250aa --- /dev/null +++ b/config/docs/d/reserved_instances.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_reserved_instances" +sidebar_current: "docs-tencentcloud-datasource-reserved_instances" +description: |- + Use this data source to query reserved instances. +--- + +# tencentcloud_reserved_instances + +Use this data source to query reserved instances. + +## Example Usage + +```hcl +data "tencentcloud_reserved_instances" "instances" { + availability_zone = "na-siliconvalley-1" + instance_type = "S2.MEDIUM8" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Optional, String) The available zone that the reserved instance locates at. +* `instance_type` - (Optional, String) The type of reserved instance. +* `reserved_instance_id` - (Optional, String) ID of the reserved instance to be query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `reserved_instance_list` - An information list of reserved instance. Each element contains the following attributes: + * `availability_zone` - Availability zone of the reserved instance. + * `end_time` - Expiry time of the reserved instance. + * `instance_count` - Number of reserved instance. + * `instance_type` - The type of reserved instance. + * `reserved_instance_id` - ID of the reserved instance. + * `start_time` - Start time of the reserved instance. + * `status` - Status of the reserved instance. + + diff --git a/config/docs/d/route_table.html.markdown b/config/docs/d/route_table.html.markdown new file mode 100644 index 0000000..e67ca76 --- /dev/null +++ b/config/docs/d/route_table.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_route_table" +sidebar_current: "docs-tencentcloud-datasource-route_table" +description: |- + Provides details about a specific Route Table. +--- + +# tencentcloud_route_table + +Provides details about a specific Route Table. + +This resource can prove useful when a module accepts a Subnet id as an input variable and needs to, for example, add a route in the Route Table. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_vpc_route_tables. + +## Example Usage + +```hcl +variable "route_table_id" {} + +data "tencentcloud_route_table" "selected" { + route_table_id = var.route_table_id +} + +resource "tencentcloud_route_entry" "rtb_entry_instance" { + vpc_id = "{data.tencentcloud_route_table.selected.vpc_id}" + route_table_id = var.route_table_id + cidr_block = "10.4.8.0/24" + next_type = "instance" + next_hub = "10.16.1.7" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `route_table_id` - (Required, String) The Route Table ID. +* `name` - (Optional, String) The Route Table name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `create_time` - Creation time of routing table. +* `routes` - The information list of the VPC route table. + * `cidr_block` - The RouteEntry's target network segment. + * `description` - The RouteEntry's description. + * `next_hub` - The RouteEntry's next hub. + * `next_type` - The `next_hub` type. +* `subnet_num` - Number of associated subnets. +* `vpc_id` - The VPC ID. + + diff --git a/config/docs/d/rum_custom_url.html.markdown b/config/docs/d/rum_custom_url.html.markdown new file mode 100644 index 0000000..2935c61 --- /dev/null +++ b/config/docs/d/rum_custom_url.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_custom_url" +sidebar_current: "docs-tencentcloud-datasource-rum_custom_url" +description: |- + Use this data source to query detailed information of rum custom_url +--- + +# tencentcloud_rum_custom_url + +Use this data source to query detailed information of rum custom_url + +## Example Usage + +```hcl +data "tencentcloud_rum_custom_url" "custom_url" { + start_time = 1625444040 + type = "top" + end_time = 1625454840 + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Query Data Type. `top`: CostType Sorting order by top, `nettype`: CostType Sorting order by nettype, `allcount`: CostType allcount, `day`: CostType group by day, `condition`: CostType Sorting in condition, `pagepv`: CostType Sorting order by pagepv, `area`: CostType query in area, `version`: CostType sort by version, `platform`: CostType sort by platform, `isp`: CostType sort by isp, `region`: region, `device`: CostType sort by device, `browser`: CostType sort by browser, `ext1`: CostType sort by ext1, `ext2`: CostType sort by ext2, `ext3`: CostType sort by ext3, `ret`: CostType sort by ret, `status`: CostType sort by status, `from`: CostType sort by from, `url`: CostType sort by url, `env`: CostType sort by env. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `cost_type` - (Optional, String) The method used for calculating the elapsed time `50`: 50th percentile, `75`: 75th percentile, `90`: 90th percentile, `95`: 95th percentile, `99`: 99th percentile, `99.5`: 99.5th percentile, `avg`: Mean. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `url` - (Optional, String) The URL Key where the data reporting takes place. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_event_url.html.markdown b/config/docs/d/rum_event_url.html.markdown new file mode 100644 index 0000000..b8a509c --- /dev/null +++ b/config/docs/d/rum_event_url.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_event_url" +sidebar_current: "docs-tencentcloud-datasource-rum_event_url" +description: |- + Use this data source to query detailed information of rum event_url +--- + +# tencentcloud_rum_event_url + +Use this data source to query detailed information of rum event_url + +## Example Usage + +```hcl +data "tencentcloud_rum_event_url" "event_url" { + start_time = 1625444040 + type = "allcount" + end_time = 1625454840 + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Query Data Type. `allcount`:CostType allcount, `day`:CostType group by day, `condition`:CostType group by condition, `ckuv`:CostType group by uv, `ckpv`:CostType group by pv, `nettype`: CostType sort by nettype, `version`: CostType sort by version, `platform`: CostType sort by platform, `isp`: CostType sort by isp, `region`: CostType sort by region, `device`: CostType sort by device, `browser`: CostType sort by browser, `ext1`: CostType sort by ext1, `ext2`: CostType sort by ext2, `ext3`: CostType sort by ext3, `ret`: CostType sort by ret, `status`: CostType sort by status, `from`: CostType sort by from, `url`: CostType sort by url, `env`: CostType sort by env. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `name` - (Optional, String) Event name for data reporting. +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_fetch_url.html.markdown b/config/docs/d/rum_fetch_url.html.markdown new file mode 100644 index 0000000..d60c18d --- /dev/null +++ b/config/docs/d/rum_fetch_url.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_fetch_url" +sidebar_current: "docs-tencentcloud-datasource-rum_fetch_url" +description: |- + Use this data source to query detailed information of rum fetch_url +--- + +# tencentcloud_rum_fetch_url + +Use this data source to query detailed information of rum fetch_url + +## Example Usage + +```hcl +data "tencentcloud_rum_fetch_url" "fetch_url" { + start_time = 1625444040 + type = "allcount" + end_time = 1625454840 + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Query Data Type. `allcount`:CostType allcount, `day`:CostType group by day, `count40x`: CostType Sorting order by statusCode(40x) count, `count50x`: CostType Sorting order by statusCode(50x) count, `count5xand4x`: CostType Sorting order by statusCode(40x) count and statusCode(50x) count, `top`:CostType Sorting order by top, `nettype`: CostType sort by nettype, `version`: CostType sort by version, `platform`: CostType sort by platform, `isp`: CostType sort by isp, `region`: CostType sort by region, `device`: CostType sort by device, `browser`: CostType sort by browser, `ext1`: CostType sort by ext1, `ext2`: CostType sort by ext2, `ext3`: CostType sort by ext3, `ret`: CostType sort by ret, `status`: CostType sort by status, `from`: CostType sort by from, `url`: CostType sort by url, `env`: CostType sort by env. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `cost_type` - (Optional, String) The method used for calculating the elapsed time `50`: 50th percentile, `75`: 75th percentile., `90`: 90th percentile., `95`: 95th percentile., `99`: 99th percentile., `99.5`: 99.5th percentile., `avg`: Mean. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_status` - (Optional, String) The network status where the data reporting takes place.`0`: noraml, `1`: week, `2`: disconnection, `3`: unknown. +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `ret` - (Optional, String) Remote request response body code. +* `status` - (Optional, String) HTTP protocol response code. +* `url` - (Optional, String) The URL Key where the data reporting takes place. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_fetch_url_info.html.markdown b/config/docs/d/rum_fetch_url_info.html.markdown new file mode 100644 index 0000000..f34e621 --- /dev/null +++ b/config/docs/d/rum_fetch_url_info.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_fetch_url_info" +sidebar_current: "docs-tencentcloud-datasource-rum_fetch_url_info" +description: |- + Use this data source to query detailed information of rum fetch_url_info +--- + +# tencentcloud_rum_fetch_url_info + +Use this data source to query detailed information of rum fetch_url_info + +## Example Usage + +```hcl +data "tencentcloud_rum_fetch_url_info" "fetch_url_info" { + start_time = 1625444040 + type = "top" + end_time = 1625454840 + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Query Data type. `top`: CostType Sorting order by top. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `cost_type` - (Optional, String) The method used for calculating the elapsed time `50`: 50th percentile, `75`: 75th percentile., `90`: 90th percentile., `95`: 95th percentile., `99`: 99th percentile., `99.5`: 99.5th percentile., `avg`: Mean. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `url` - (Optional, String) The URL Key where the data reporting takes place. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_group_log.html.markdown b/config/docs/d/rum_group_log.html.markdown new file mode 100644 index 0000000..be96404 --- /dev/null +++ b/config/docs/d/rum_group_log.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_group_log" +sidebar_current: "docs-tencentcloud-datasource-rum_group_log" +description: |- + Use this data source to query detailed information of rum group_log +--- + +# tencentcloud_rum_group_log + +Use this data source to query detailed information of rum group_log + +## Example Usage + +```hcl +data "tencentcloud_rum_group_log" "group_log" { + order_by = "desc" + start_time = 1625444040000 + query = "id:123 AND type:\"log\"" + end_time = 1625454840000 + project_id = 1 + group_field = "level" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) End time but is represented using a timestamp in milliseconds. +* `group_field` - (Required, String) The field used for group. +* `order_by` - (Required, String) Sorting method. `desc`:Descending order; `asc`: Ascending order. +* `project_id` - (Required, Int) Project ID. +* `query` - (Required, String) Log Query syntax statement. +* `start_time` - (Required, String) Start time but is represented using a timestamp in milliseconds. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_log_export.html.markdown b/config/docs/d/rum_log_export.html.markdown new file mode 100644 index 0000000..f8cd703 --- /dev/null +++ b/config/docs/d/rum_log_export.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_log_export" +sidebar_current: "docs-tencentcloud-datasource-rum_log_export" +description: |- + Use this data source to query detailed information of rum log_export +--- + +# tencentcloud_rum_log_export + +Use this data source to query detailed information of rum log_export + +## Example Usage + +```hcl +data "tencentcloud_rum_log_export" "log_export" { + name = "log" + start_time = "1692594840000" + query = "id:123 AND type: \"log\"" + end_time = "1692609240000" + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) End timestamp, in milliseconds. +* `name` - (Required, String) Export flag name. +* `project_id` - (Required, Int) Project ID. +* `query` - (Required, String) Log Query syntax statement. +* `start_time` - (Required, String) Start timestamp, in milliseconds. +* `fields` - (Optional, Set: [`String`]) Log fields. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return result. + + diff --git a/config/docs/d/rum_log_export_list.html.markdown b/config/docs/d/rum_log_export_list.html.markdown new file mode 100644 index 0000000..9ba00d2 --- /dev/null +++ b/config/docs/d/rum_log_export_list.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_log_export_list" +sidebar_current: "docs-tencentcloud-datasource-rum_log_export_list" +description: |- + Use this data source to query detailed information of rum log_export_list +--- + +# tencentcloud_rum_log_export_list + +Use this data source to query detailed information of rum log_export_list + +## Example Usage + +```hcl +data "tencentcloud_rum_log_export_list" "log_export_list" { + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Required, Int) Project ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return result. + + diff --git a/config/docs/d/rum_log_url_statistics.html.markdown b/config/docs/d/rum_log_url_statistics.html.markdown new file mode 100644 index 0000000..55b5cb9 --- /dev/null +++ b/config/docs/d/rum_log_url_statistics.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_log_url_statistics" +sidebar_current: "docs-tencentcloud-datasource-rum_log_url_statistics" +description: |- + Use this data source to query detailed information of rum log_url_statistics +--- + +# tencentcloud_rum_log_url_statistics + +Use this data source to query detailed information of rum log_url_statistics + +## Example Usage + +```hcl +data "tencentcloud_rum_log_url_statistics" "log_url_statistics" { + start_time = 1625444040 + type = "analysis" + end_time = 1625454840 + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Query Data Type. `analysis`:query analysis data, `compare`:query compare data, `allcount`:query allcount, `condition`:query in condition, `nettype`: CostType sort by nettype, `version`: CostType sort by version, `platform`: CostType sort by platform, `isp`: CostType sort by isp, `region`: CostType sort by region, `device`: CostType sort by device, `browser`: CostType sort by browser, `ext1`: CostType sort by ext1, `ext2`: CostType sort by ext2, `ext3`: CostType sort by ext3, `ret`: CostType sort by ret, `status`: CostType sort by status, `from`: CostType sort by from, `url`: CostType sort by url, `env`: CostType sort by env. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_offline_log_config.html.markdown b/config/docs/d/rum_offline_log_config.html.markdown new file mode 100644 index 0000000..04f6460 --- /dev/null +++ b/config/docs/d/rum_offline_log_config.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_offline_log_config" +sidebar_current: "docs-tencentcloud-datasource-rum_offline_log_config" +description: |- + Use this data source to query detailed information of rum offlineLogConfig +--- + +# tencentcloud_rum_offline_log_config + +Use this data source to query detailed information of rum offlineLogConfig + +## Example Usage + +```hcl +data "tencentcloud_rum_offline_log_config" "offlineLogConfig" { + project_key = "ZEYrYfvaYQ30jRdmPx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_key` - (Required, String) Unique project key for reporting. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `msg` - API call information. +* `unique_id_set` - Unique identifier of the user to be listened on(aid or uin). + + diff --git a/config/docs/d/rum_performance_page.html.markdown b/config/docs/d/rum_performance_page.html.markdown new file mode 100644 index 0000000..5482036 --- /dev/null +++ b/config/docs/d/rum_performance_page.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_performance_page" +sidebar_current: "docs-tencentcloud-datasource-rum_performance_page" +description: |- + Use this data source to query detailed information of rum performance_page +--- + +# tencentcloud_rum_performance_page + +Use this data source to query detailed information of rum performance_page + +## Example Usage + +```hcl +data "tencentcloud_rum_performance_page" "performance_page" { + project_id = 1 + start_time = 1625444040 + end_time = 1625454840 + type = "pagepv" + level = "1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Query Data Type. `pagepv`: CostType query by pagepv, `allcount`: CostType query allcount, `falls`: CostType query by falls, `samp`: CostType query by samp, `day`: CostType query by day, `nettype`: CostType query by nettype, `performance`: CostType query by performance `version`: CostType sort by version, `platform`: CostType sort by platform, `isp`: CostType sort by isp, `region`: CostType sort by region, `device`: CostType sort by device, `browser`: CostType sort by browser, `ext1`: CostType sort by ext1, `ext2`: CostType sort by ext2, `ext3`: CostType sort by ext3, `ret`: CostType sort by ret, `status`: CostType sort by status, `from`: CostType sort by from, `url`: CostType sort by url, `env`: CostType sort by env. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `cost_type` - (Optional, String) The method used for calculating the elapsed time `50`: 50th percentile, `75`: 75th percentile., `90`: 90th percentile., `95`: 95th percentile., `99`: 99th percentile., `99.5`: 99.5th percentile., `avg`: Mean. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_status` - (Optional, String) The network status where the data reporting takes place.`0`: noraml, `1`: week, `2`: disconnection, `3`: unknown. +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_project.html.markdown b/config/docs/d/rum_project.html.markdown new file mode 100644 index 0000000..20c0697 --- /dev/null +++ b/config/docs/d/rum_project.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_project" +sidebar_current: "docs-tencentcloud-datasource-rum_project" +description: |- + Use this data source to query detailed information of rum project +--- + +# tencentcloud_rum_project + +Use this data source to query detailed information of rum project + +## Example Usage + +```hcl +data "tencentcloud_rum_project" "project" { + instance_id = "rum-pasZKEI3RLgakj" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `project_set` - Project list. + * `create_time` - CreateTime. + * `creator` - Creator ID. + * `desc` - Project description. + * `enable_url_group` - Whether to enable URL aggregation. + * `instance_id` - Instance ID. + * `instance_key` - Instance key. + * `instance_name` - Instance name. + * `is_star` - Starred status. `1`: yes; `0`: no. + * `key` - Unique project key (12 characters). + * `name` - Project name. + * `pid` - Project ID. + * `project_status` - Project status (`1`: Creating; `2`: Running; `3`: Abnormal; `4`: Restarting; `5`: Stopping; `6`: Stopped; `7`: Terminating; `8`: Terminated). + * `rate` - Project sample rate. + * `repo` - Project repository address. + * `type` - Project type. + * `url` - Project URL. + + diff --git a/config/docs/d/rum_pv_url_info.html.markdown b/config/docs/d/rum_pv_url_info.html.markdown new file mode 100644 index 0000000..2ee155f --- /dev/null +++ b/config/docs/d/rum_pv_url_info.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_pv_url_info" +sidebar_current: "docs-tencentcloud-datasource-rum_pv_url_info" +description: |- + Use this data source to query detailed information of rum pv_url_info +--- + +# tencentcloud_rum_pv_url_info + +Use this data source to query detailed information of rum pv_url_info + +## Example Usage + +```hcl +data "tencentcloud_rum_pv_url_info" "pv_url_info" { + start_time = 1625444040 + type = "pagepv" + end_time = 1625454840 + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Type value is fixed, please always pass `pagepv`. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_pv_url_statistics.html.markdown b/config/docs/d/rum_pv_url_statistics.html.markdown new file mode 100644 index 0000000..c8d1fbd --- /dev/null +++ b/config/docs/d/rum_pv_url_statistics.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_pv_url_statistics" +sidebar_current: "docs-tencentcloud-datasource-rum_pv_url_statistics" +description: |- + Use this data source to query detailed information of rum pv_url_statistics +--- + +# tencentcloud_rum_pv_url_statistics + +Use this data source to query detailed information of rum pv_url_statistics + +## Example Usage + +```hcl +data "tencentcloud_rum_pv_url_statistics" "pv_url_statistics" { + start_time = 1625444040 + type = "allcount" + end_time = 1625454840 + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Query Date Type. `allcount`:CostType allcount, `day`:CostType group by day, `vp`: CostType group by vp, `ckuv`:CostType group by uv, `ckpv`:CostType group by pv, `ckwau`:CostType group by ckwau, `ckmau`:CostType group by ckmau, `condition`:CostType group by condition, `nettype`: CostType sort by nettype, `version`: CostType sort by version, `platform`: CostType sort by platform, `isp`: CostType sort by isp, `region`: CostType sort by region, `device`: CostType sort by device, `browser`: CostType sort by browser, `ext1`: CostType sort by ext1, `ext2`: CostType sort by ext2, `ext3`: CostType sort by ext3, `ret`: CostType sort by ret, `status`: CostType sort by status, `from`: CostType sort by from, `url`: CostType sort by url, `env`: CostType sort by env. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `group_by_type` - (Optional, Int) Query groupby type `1`: 1m, `2`: 5m, `3`: 30m, `4`: 1h, `5`: 1d. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_report_count.html.markdown b/config/docs/d/rum_report_count.html.markdown new file mode 100644 index 0000000..f3bf59a --- /dev/null +++ b/config/docs/d/rum_report_count.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_report_count" +sidebar_current: "docs-tencentcloud-datasource-rum_report_count" +description: |- + Use this data source to query detailed information of rum report_count +--- + +# tencentcloud_rum_report_count + +Use this data source to query detailed information of rum report_count + +## Example Usage + +```hcl +data "tencentcloud_rum_report_count" "report_count" { + start_time = 1625444040 + end_time = 1625454840 + project_id = 1 + report_type = "log" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `instance_id` - (Optional, String) Instance ID. +* `report_type` - (Optional, String) Report type, empty is meaning all type count. `log`:log report count, `pv`:pv report count, `event`:event report count, `speed`:speed report count, `performance`:performance report count, `custom`:custom report count, `webvitals`:webvitals report count, `miniProgramData`:miniProgramData report count. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_scores.html.markdown b/config/docs/d/rum_scores.html.markdown new file mode 100644 index 0000000..87214f5 --- /dev/null +++ b/config/docs/d/rum_scores.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_scores" +sidebar_current: "docs-tencentcloud-datasource-rum_scores" +description: |- + Use this data source to query detailed information of rum scores +--- + +# tencentcloud_rum_scores + +Use this data source to query detailed information of rum scores + +## Example Usage + +```hcl +data "tencentcloud_rum_scores" "scores" { + end_time = "2023082215" + start_time = "2023082214" + project_id = 1 + is_demo = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) End time. +* `start_time` - (Required, String) Start time. +* `is_demo` - (Optional, Int) Get data from demo. This parameter is deprecated. +* `project_id` - (Optional, Int) Project ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `score_set` - Score list. + * `api_duration` - The mean duration of api request. + * `api_fail` - The number of failed api. + * `api_num` - The number of all request api. + * `create_time` - Project record created time. + * `page_duration` - The duration of page load. + * `page_error` - The number of exception which happened on page. + * `page_pv` - Pv. + * `page_uv` - User view. + * `project_id` - Project ID. + * `record_num` - The number of record. + * `score` - The score of project. + * `static_duration` - Duration. + * `static_fail` - The number of failed request static resource. + * `static_num` - The number of static resource on page. + + diff --git a/config/docs/d/rum_set_url_statistics.html.markdown b/config/docs/d/rum_set_url_statistics.html.markdown new file mode 100644 index 0000000..652711c --- /dev/null +++ b/config/docs/d/rum_set_url_statistics.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_set_url_statistics" +sidebar_current: "docs-tencentcloud-datasource-rum_set_url_statistics" +description: |- + Use this data source to query detailed information of rum set_url_statistics +--- + +# tencentcloud_rum_set_url_statistics + +Use this data source to query detailed information of rum set_url_statistics + +## Example Usage + +```hcl +data "tencentcloud_rum_set_url_statistics" "set_url_statistics" { + start_time = 1625444040 + type = "allcount" + end_time = 1625454840 + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Query Data Type. `allcount`:CostType allcount, `data`: CostType group by data, `component`:miniProgram component, `day`:query data in day, `nettype`:query data group by nettype, `performance`:query data group by performance, `version`: CostType sort by version, `platform`: CostType sort by platform, `isp`: CostType sort by isp, `region`: CostType sort by region, `device`: CostType sort by device, `browser`: CostType sort by browser, `ext1`: CostType sort by ext1, `ext2`: CostType sort by ext2, `ext3`: CostType sort by ext3, `ret`: CostType sort by ret, `status`: CostType sort by status, `from`: CostType sort by from, `url`: CostType sort by url, `env`: CostType sort by env. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `cost_type` - (Optional, String) The method used for calculating the elapsed time `50`: 50th percentile, `75`: 75th percentile., `90`: 90th percentile., `95`: 95th percentile., `99`: 99th percentile., `99.5`: 99.5th percentile., `avg`: Mean. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `package_type` - (Optional, String) Package Type. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_sign.html.markdown b/config/docs/d/rum_sign.html.markdown new file mode 100644 index 0000000..b9e4a72 --- /dev/null +++ b/config/docs/d/rum_sign.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_sign" +sidebar_current: "docs-tencentcloud-datasource-rum_sign" +description: |- + Use this data source to query detailed information of rum sign +--- + +# tencentcloud_rum_sign + +Use this data source to query detailed information of rum sign + +## Example Usage + +```hcl +data "tencentcloud_rum_sign" "sign" { + timeout = 1800 + file_type = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `file_type` - (Optional, Int) Bucket type. `1`:web project; `2`:app project. +* `result_output_file` - (Optional, String) Used to save results. +* `timeout` - (Optional, Int) Timeout duration. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `expired_time` - Expiration timestamp. +* `secret_id` - Temporary access key ID. +* `secret_key` - Temporary access key. +* `session_token` - Temporary access key token. +* `start_time` - Start timestamp. + + diff --git a/config/docs/d/rum_static_project.html.markdown b/config/docs/d/rum_static_project.html.markdown new file mode 100644 index 0000000..9062292 --- /dev/null +++ b/config/docs/d/rum_static_project.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_static_project" +sidebar_current: "docs-tencentcloud-datasource-rum_static_project" +description: |- + Use this data source to query detailed information of rum static_project +--- + +# tencentcloud_rum_static_project + +Use this data source to query detailed information of rum static_project + +## Example Usage + +```hcl +data "tencentcloud_rum_static_project" "static_project" { + start_time = 1625444040 + type = "allcount" + end_time = 1625454840 + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Query Data Type. `allcount`: CostType allcount, `day`: CostType group by day, `condition`: CostType Sorting in condition, `area`: CostType query in area, `nettype`: CostType sort by nettype, `version`: CostType sort by version, `platform`: CostType sort by platform, `isp`: CostType sort by isp, `region`: CostType sort by region, `device`: CostType sort by device, `browser`: CostType sort by browser, `ext1`: CostType sort by ext1, `ext2`: CostType sort by ext2, `ext3`: CostType sort by ext3, `ret`: CostType sort by ret, `status`: CostType sort by status, `from`: CostType sort by from, `url`: CostType sort by url, `env`: CostType sort by env. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `cost_type` - (Optional, String) The method used for calculating the elapsed time `50`: 50th percentile, `75`: 75th percentile., `90`: 90th percentile., `95`: 95th percentile., `99`: 99th percentile., `99.5`: 99.5th percentile., `avg`: Mean. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `url` - (Optional, String) The URL Key where the data reporting takes place. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_static_resource.html.markdown b/config/docs/d/rum_static_resource.html.markdown new file mode 100644 index 0000000..f14e5b9 --- /dev/null +++ b/config/docs/d/rum_static_resource.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_static_resource" +sidebar_current: "docs-tencentcloud-datasource-rum_static_resource" +description: |- + Use this data source to query detailed information of rum static_resource +--- + +# tencentcloud_rum_static_resource + +Use this data source to query detailed information of rum static_resource + +## Example Usage + +```hcl +data "tencentcloud_rum_static_resource" "static_resource" { + start_time = 1625444040 + type = "top" + end_time = 1625454840 + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Query Data Type. `top`: CostType Sorting order by top, `count40x`: CostType Sorting order by statusCode(40x) count, `nettype`: CostType Sorting order by nettype, `allcount`: CostType allcount, `day`: CostType group by day, `condition`: CostType Sorting in condition, `pagepv`: CostType Sorting order by pagepv, `area`: CostType query in area, `version`: CostType sort by version, `platform`: CostType sort by platform, `isp`: CostType sort by isp, `region`: region, `device`: CostType sort by device, `browser`: CostType sort by browser, `ext1`: CostType sort by ext1, `ext2`: CostType sort by ext2, `ext3`: CostType sort by ext3, `ret`: CostType sort by ret, `status`: CostType sort by status, `from`: CostType sort by from, `url`: CostType sort by url, `env`: CostType sort by env. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `cost_type` - (Optional, String) The method used for calculating the elapsed time `50`: 50th percentile, `75`: 75th percentile., `90`: 90th percentile., `95`: 95th percentile., `99`: 99th percentile., `99.5`: 99.5th percentile., `avg`: Mean. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `url` - (Optional, String) The URL Key where the data reporting takes place. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_static_url.html.markdown b/config/docs/d/rum_static_url.html.markdown new file mode 100644 index 0000000..0c5c3cc --- /dev/null +++ b/config/docs/d/rum_static_url.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_static_url" +sidebar_current: "docs-tencentcloud-datasource-rum_static_url" +description: |- + Use this data source to query detailed information of rum static_url +--- + +# tencentcloud_rum_static_url + +Use this data source to query detailed information of rum static_url + +## Example Usage + +```hcl +data "tencentcloud_rum_static_url" "static_url" { + start_time = 1625444040 + type = "pagepv" + end_time = 1625454840 + project_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `type` - (Required, String) Query Data Type. `pagepv`: CostType query by pagepv, `nettype`: CostType group by nettype, `version`: CostType group by version, `platform`: CostType group by platform, `isp`: CostType group by isp, `region`: CostType group by region, `device`: CostType group by device, `browser`: CostType group by browser, `ext1`: CostType group by ext1, `ext2`: CostType group by ext2, `ext3`: CostType group by ext3, `ret`: CostType group by ret, `status`: CostType group by status, `from`: CostType group by from, `url`: CostType group by url, `env`: CostType group by env. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `cost_type` - (Optional, String) The method used for calculating the elapsed time `50`: 50th percentile, `75`: 75th percentile., `90`: 90th percentile., `95`: 95th percentile., `99`: 99th percentile., `99.5`: 99.5th percentile., `avg`: Mean. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `url` - (Optional, String) The URL Key where the data reporting takes place. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_taw_instance.html.markdown b/config/docs/d/rum_taw_instance.html.markdown new file mode 100644 index 0000000..12a280f --- /dev/null +++ b/config/docs/d/rum_taw_instance.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_taw_instance" +sidebar_current: "docs-tencentcloud-datasource-rum_taw_instance" +description: |- + Use this data source to query detailed information of rum tawInstance +--- + +# tencentcloud_rum_taw_instance + +Use this data source to query detailed information of rum tawInstance + +## Example Usage + +```hcl +data "tencentcloud_rum_taw_instance" "taw_instance" { + charge_statuses = [1, ] + charge_types = [1, ] + area_ids = [1, ] + instance_statuses = [2, ] + instance_ids = ["rum-pasZKEI3RLgakj", ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `area_ids` - (Optional, Set: [`Int`]) Region ID. +* `charge_statuses` - (Optional, Set: [`Int`]) Billing status. +* `charge_types` - (Optional, Set: [`Int`]) Billing type. +* `instance_ids` - (Optional, Set: [`String`]) Instance ID. +* `instance_statuses` - (Optional, Set: [`Int`]) Instance status (`1`: creating; `2`: running; `3`: exceptional; `4`: restarting; `5`: stopping; `6`: stopped; `7`: terminating; `8`: terminated). +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_set` - Instance list. + * `area_id` - Area ID. + * `charge_status` - Billing status (`1` = in use, `2` = expired, `3` = destroyed, `4` = assigning, `5` = failed). + * `charge_type` - Billing type (`1` = free version, `2` = prepaid, `3` = postpaid). + * `cluster_id` - Cluster ID. + * `created_at` - Create time. + * `data_retention_days` - Data retention time (days). + * `instance_desc` - Instance Desc. + * `instance_id` - Instance ID. + * `instance_name` - Instance name. + * `instance_status` - Instance status (`1` = creating, `2` = running, `3` = exception, `4` = restarting, `5` = stopping, `6` = stopped, `7` = deleted). + * `tags` - Tag List. + * `key` - Tag Key. + * `value` - Tag Value. + * `updated_at` - Update time. + + diff --git a/config/docs/d/rum_web_vitals_page.html.markdown b/config/docs/d/rum_web_vitals_page.html.markdown new file mode 100644 index 0000000..210c2d5 --- /dev/null +++ b/config/docs/d/rum_web_vitals_page.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_web_vitals_page" +sidebar_current: "docs-tencentcloud-datasource-rum_web_vitals_page" +description: |- + Use this data source to query detailed information of rum web_vitals_page +--- + +# tencentcloud_rum_web_vitals_page + +Use this data source to query detailed information of rum web_vitals_page + +## Example Usage + +```hcl +data "tencentcloud_rum_web_vitals_page" "web_vitals_page" { + start_time = 1625444040 + end_time = 1625454840 + project_id = 1 + type = "from" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, Int) End time but is represented using a timestamp in seconds. +* `project_id` - (Required, Int) Project ID. +* `start_time` - (Required, Int) Start time but is represented using a timestamp in seconds. +* `area` - (Optional, String) The region where the data reporting takes place. +* `brand` - (Optional, String) The mobile phone brand used for data reporting. +* `browser` - (Optional, String) The browser type used for data reporting. +* `cost_type` - (Optional, String) The method used for calculating the elapsed time `50`: 50th percentile, `75`: 75th percentile., `90`: 90th percentile., `95`: 95th percentile., `99`: 99th percentile., `99.5`: 99.5th percentile., `avg`: Mean. +* `device` - (Optional, String) The device used for data reporting. +* `engine` - (Optional, String) The browser engine used for data reporting. +* `env` - (Optional, String) The code environment where the data reporting takes place.(`production`: production env, `development`: development env, `gray`: gray env, `pre`: pre env, `daily`: daily env, `local`: local env, `others`: others env). +* `ext_first` - (Optional, String) First Expansion parameter. +* `ext_second` - (Optional, String) Second Expansion parameter. +* `ext_third` - (Optional, String) Third Expansion parameter. +* `from` - (Optional, String) The source page of the data reporting. +* `is_abroad` - (Optional, String) Whether it is non-China region.`1`: yes; `0`: no. +* `isp` - (Optional, String) The internet service provider used for data reporting. +* `level` - (Optional, String) Log level for data reporting(`1`: whitelist, `2`: normal, `4`: error, `8`: promise error, `16`: ajax request error, `32`: js resource load error, `64`: image resource load error, `128`: css resource load error, `256`: console.error, `512`: video resource load error, `1024`: request retcode error, `2048`: sdk self monitor error, `4096`: pv log, `8192`: event log). +* `net_type` - (Optional, String) The network type used for data reporting.(`1`: Wifi, `2`: 2G, `3`: 3G, `4`: 4G, `5`: 5G, `6`: 6G, `100`: Unknown). +* `os` - (Optional, String) The operating system used for data reporting. +* `platform` - (Optional, String) The platform where the data reporting takes place.(`1`: Android, `2`: IOS, `3`: Windows, `4`: Mac, `5`: Linux, `100`: Other). +* `result_output_file` - (Optional, String) Used to save results. +* `type` - (Optional, String) Query Data Type(from or empty). `from`: CostType query by from. +* `version_num` - (Optional, String) The SDK version used for data reporting. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Return value. + + diff --git a/config/docs/d/rum_whitelist.html.markdown b/config/docs/d/rum_whitelist.html.markdown new file mode 100644 index 0000000..55a29bb --- /dev/null +++ b/config/docs/d/rum_whitelist.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_whitelist" +sidebar_current: "docs-tencentcloud-datasource-rum_whitelist" +description: |- + Use this data source to query detailed information of rum whitelist +--- + +# tencentcloud_rum_whitelist + +Use this data source to query detailed information of rum whitelist + +## Example Usage + +```hcl +data "tencentcloud_rum_whitelist" "whitelist" { + instance_id = "rum-pasZKEI3RLgakj" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, such as taw-123. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `whitelist_set` - While list. + * `aid` - Business identifier. + * `create_time` - Creation time. + * `create_user` - Creator ID. + * `remark` - Remarks. + * `ttl` - End time. + * `whitelist_uin` - uin: business identifier. + * `wid` - Auto-Increment allowlist ID. + + diff --git a/config/docs/d/scf_account_info.html.markdown b/config/docs/d/scf_account_info.html.markdown new file mode 100644 index 0000000..4bea5ea --- /dev/null +++ b/config/docs/d/scf_account_info.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_account_info" +sidebar_current: "docs-tencentcloud-datasource-scf_account_info" +description: |- + Use this data source to query detailed information of scf account_info +--- + +# tencentcloud_scf_account_info + +Use this data source to query detailed information of scf account_info + +## Example Usage + +```hcl +data "tencentcloud_scf_account_info" "account_info" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `account_limit` - Namespace limit information. + * `namespace` - Namespace limit information. + * `concurrent_executions` - Concurrency. + * `functions_count` - Total number of functions. + * `init_timeout_limit` - Initialization timeout limit. + * `max_msg_ttl` - Upper limit of message retention time for async retry. + * `min_msg_ttl` - Lower limit of message retention time for async retry. + * `namespace` - Namespace name. + * `retry_num_limit` - Limit of async retry attempt quantity. + * `test_model_limit` - Test event limit Note: this field may return null, indicating that no valid values can be obtained. + * `timeout_limit` - Timeout limit. + * `trigger` - Trigger information. + * `apigw` - Number of API Gateway triggers. + * `ckafka` - Number of CKafka triggers. + * `clb` - Number of CLB triggers. + * `cls` - Number of CLS triggers. + * `cm` - Number of CM triggers. + * `cmq` - Number of CMQ triggers. + * `cos` - Number of COS triggers. + * `eb` - Number of EventBridge triggers Note: This field may return null, indicating that no valid values can be obtained. + * `mps` - Number of MPS triggers. + * `timer` - Number of timer triggers. + * `total` - Total number of triggers. + * `vod` - Number of VOD triggers. + * `namespaces_count` - Limit of namespace quantity. +* `account_usage` - Namespace usage information. + * `namespace` - Namespace details. + * `functions_count` - Number of functions in namespace. + * `functions` - Function array. + * `namespace` - Namespace name. + * `total_allocated_concurrency_mem` - Concurrency usage of the namespace Note: This field may return null, indicating that no valid value can be obtained. + * `total_allocated_provisioned_mem` - Provisioned concurrency usage of the namespace Note: This field may return null, indicating that no valid value can be obtained. + * `total_concurrency_mem` - Total memory quota of the namespace Note: This field may return null, indicating that no valid values can be obtained. + * `namespaces_count` - Number of namespaces. + * `total_allocated_concurrency_mem` - Quota of configured user concurrency memory in the current region. + * `total_concurrency_mem` - Upper limit of user concurrency memory in the current region. + * `user_concurrency_mem_limit` - Quota of account concurrency actually configured by user. + + diff --git a/config/docs/d/scf_async_event_management.html.markdown b/config/docs/d/scf_async_event_management.html.markdown new file mode 100644 index 0000000..ab8209e --- /dev/null +++ b/config/docs/d/scf_async_event_management.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_async_event_management" +sidebar_current: "docs-tencentcloud-datasource-scf_async_event_management" +description: |- + Use this data source to query detailed information of scf async_event_management +--- + +# tencentcloud_scf_async_event_management + +Use this data source to query detailed information of scf async_event_management + +## Example Usage + +```hcl +data "tencentcloud_scf_async_event_management" "async_event_management" { + function_name = "keep-1676351130" + namespace = "default" + qualifier = "$LATEST" + order = "ASC" + orderby = "StartTime" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String) Function name. +* `invoke_request_id` - (Optional, String) Filter (event invocation request ID). +* `invoke_type` - (Optional, Set: [`String`]) Filter (invocation type list), Values: CMQ, CKAFKA_TRIGGER, APIGW, COS, TRIGGER_TIMER, MPS_TRIGGER, CLS_TRIGGER, OTHERS. +* `namespace` - (Optional, String) Function namespace. +* `order` - (Optional, String) Valid values: ASC, DESC. Default value: DESC. +* `orderby` - (Optional, String) Valid values: StartTime, EndTime. Default value: StartTime. +* `qualifier` - (Optional, String) Filter (function version). +* `result_output_file` - (Optional, String) Used to save results. +* `status` - (Optional, Set: [`String`]) Filter (event status list), Values: RUNNING, FINISHED, ABORTED, FAILED. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `event_list` - Async event list. + * `end_time` - Invocation end time in the format of %Y-%m-%d %H:%M:%S.%f. + * `invoke_request_id` - Invocation request ID. + * `invoke_type` - Invocation type. + * `qualifier` - Function version. + * `start_time` - Invocation start time in the format of %Y-%m-%d %H:%M:%S.%f. + * `status` - Event status. Values: `RUNNING`; `FINISHED` (invoked successfully); `ABORTED` (invocation ended); `FAILED` (invocation failed). + + diff --git a/config/docs/d/scf_async_event_status.html.markdown b/config/docs/d/scf_async_event_status.html.markdown new file mode 100644 index 0000000..0a4f2d8 --- /dev/null +++ b/config/docs/d/scf_async_event_status.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_async_event_status" +sidebar_current: "docs-tencentcloud-datasource-scf_async_event_status" +description: |- + Use this data source to query detailed information of scf async_event_status +--- + +# tencentcloud_scf_async_event_status + +Use this data source to query detailed information of scf async_event_status + +## Example Usage + +```hcl +data "tencentcloud_scf_async_event_status" "async_event_status" { + invoke_request_id = "9de9405a-e33a-498d-bb59-e80b7bed1191" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `invoke_request_id` - (Required, String) ID of the async execution request. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Async event status. + * `invoke_request_id` - Async execution request ID. + * `status_code` - Request status code. + * `status` - Async event status. Values: `RUNNING` (running); `FINISHED` (invoked successfully); `ABORTED` (invocation ended); `FAILED` (invocation failed). + + diff --git a/config/docs/d/scf_function_address.html.markdown b/config/docs/d/scf_function_address.html.markdown new file mode 100644 index 0000000..4a0d69e --- /dev/null +++ b/config/docs/d/scf_function_address.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_function_address" +sidebar_current: "docs-tencentcloud-datasource-scf_function_address" +description: |- + Use this data source to query detailed information of scf function_address +--- + +# tencentcloud_scf_function_address + +Use this data source to query detailed information of scf function_address + +## Example Usage + +```hcl +data "tencentcloud_scf_function_address" "function_address" { + function_name = "keep-1676351130" + namespace = "default" + qualifier = "$LATEST" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String) Function name. +* `namespace` - (Optional, String) Function namespace. +* `qualifier` - (Optional, String) Function version. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `code_sha256` - SHA256 code of the function. +* `url` - Cos address of the function. + + diff --git a/config/docs/d/scf_function_aliases.html.markdown b/config/docs/d/scf_function_aliases.html.markdown new file mode 100644 index 0000000..9c05deb --- /dev/null +++ b/config/docs/d/scf_function_aliases.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_function_aliases" +sidebar_current: "docs-tencentcloud-datasource-scf_function_aliases" +description: |- + Use this data source to query detailed information of scf function_aliases +--- + +# tencentcloud_scf_function_aliases + +Use this data source to query detailed information of scf function_aliases + +## Example Usage + +```hcl +data "tencentcloud_scf_function_aliases" "function_aliases" { + function_name = "keep-1676351130" + namespace = "default" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String) Function name. +* `function_version` - (Optional, String) If this parameter is provided, only aliases associated with this function version will be returned. +* `namespace` - (Optional, String) Function namespace. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `aliases` - Alias list. + * `add_time` - Creation timeNote: this field may return null, indicating that no valid values can be obtained. + * `description` - DescriptionNote: this field may return null, indicating that no valid values can be obtained. + * `function_version` - Master version pointed to by the alias. + * `mod_time` - Update timeNote: this field may return null, indicating that no valid values can be obtained. + * `name` - Alias name. + * `routing_config` - Routing information of aliasNote: this field may return null, indicating that no valid values can be obtained. + * `addition_version_matchs` - Additional version with rule-based routing. + * `expression` - Rule requirements for range match:It should be described in an open or closed range, i.e., `(a,b)` or `[a,b]`, where both a and b are integersRule requirements for exact match:Exact string match. + * `key` - Matching rule key. When the API is called, pass in the `key` to route the request to the specified version based on the matching ruleHeader method:Enter invoke.headers.User for `key` and pass in `RoutingKey:{User:value}` when invoking a function through `invoke` for invocation based on rule matching. + * `method` - Match method. Valid values:range: range matchexact: exact string match. + * `version` - Function version name. + * `additional_version_weights` - Additional version with random weight-based routing. + * `version` - Function version name. + * `weight` - Version weight. + + diff --git a/config/docs/d/scf_function_versions.html.markdown b/config/docs/d/scf_function_versions.html.markdown new file mode 100644 index 0000000..e1fbf46 --- /dev/null +++ b/config/docs/d/scf_function_versions.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_function_versions" +sidebar_current: "docs-tencentcloud-datasource-scf_function_versions" +description: |- + Use this data source to query detailed information of scf function_versions +--- + +# tencentcloud_scf_function_versions + +Use this data source to query detailed information of scf function_versions + +## Example Usage + +```hcl +data "tencentcloud_scf_function_versions" "function_versions" { + function_name = "keep-1676351130" + namespace = "default" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String) Function Name. +* `namespace` - (Optional, String) The namespace where the function locates. +* `order_by` - (Optional, String) It specifies the sorting order of the results according to a specified field, such as `AddTime`, `ModTime`. +* `order` - (Optional, String) It specifies whether to return the results in ascending or descending order. The value is `ASC` or `DESC`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `versions` - Function version listNote: This field may return null, indicating that no valid values is found. + * `add_time` - The creation timeNote: This field may return null, indicating that no valid value was found. + * `description` - Version descriptionNote: This field may return null, indicating that no valid values is found. + * `mod_time` - Update timeNote: This field may return null, indicating that no valid value was found. + * `status` - Version statusNote: this field may return `null`, indicating that no valid values can be obtained. + * `version` - Function version name. + + diff --git a/config/docs/d/scf_functions.html.markdown b/config/docs/d/scf_functions.html.markdown new file mode 100644 index 0000000..01064b4 --- /dev/null +++ b/config/docs/d/scf_functions.html.markdown @@ -0,0 +1,100 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_functions" +sidebar_current: "docs-tencentcloud-datasource-scf_functions" +description: |- + Use this data source to query SCF functions. +--- + +# tencentcloud_scf_functions + +Use this data source to query SCF functions. + +## Example Usage + +```hcl +resource "tencentcloud_scf_function" "foo" { + name = "ci-test-function" + handler = "main.do_it" + runtime = "Python3.6" + + cos_bucket_name = "scf-code-1234567890" + cos_object_name = "code.zip" + cos_bucket_region = "ap-guangzhou" +} + +data "tencentcloud_scf_functions" "foo" { + name = tencentcloud_scf_function.foo.name +} +``` + +## Argument Reference + +The following arguments are supported: + +* `description` - (Optional, String) Description of the SCF function to be queried. +* `name` - (Optional, String) Name of the SCF function to be queried. +* `namespace` - (Optional, String) Namespace of the SCF function to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) Tags of the SCF function to be queried, can use up to 10 tags. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `functions` - An information list of functions. Each element contains the following attributes: + * `async_run_enable` - Whether asynchronous attribute is enabled. + * `cls_logset_id` - CLS logset ID of the SCF function. + * `cls_topic_id` - CLS topic ID of the SCF function. + * `code_error` - Code error of the SCF function. + * `code_result` - Code result of the SCF function. + * `code_size` - Code size of the SCF function. + * `create_time` - Create time of the SCF function. + * `description` - Description of the SCF function. + * `dns_cache` - Whether to enable Dns caching capability, only the EVENT function is supported. Default is false. + * `eip_fixed` - Whether EIP is a fixed IP. + * `eips` - EIP list of the SCF function. + * `enable_eip_config` - Whether the EIP enabled. + * `enable_public_net` - Whether the public net enabled. + * `environment` - Environment variable of the SCF function. + * `err_no` - Errno of the SCF function. + * `handler` - Handler of the SCF function. + * `host` - Host of the SCF function. + * `image_config` - Image of the SCF function, conflict with `cos_bucket_name`, `cos_object_name`, `cos_bucket_region`, `zip_file`. + * `args` - the parameters of command. + * `command` - The command of entrypoint. + * `container_image_accelerate` - Image accelerate switch. + * `entry_point` - The entrypoint of app. + * `image_port` - Image function port setting. Default is `9000`, -1 indicates no port mirroring function. Other value ranges 0 ~ 65535. + * `image_type` - The image type. personal or enterprise. + * `image_uri` - The uri of image. + * `registry_id` - The registry id of TCR. When image type is enterprise, it must be set. + * `install_dependency` - Whether to automatically install dependencies. + * `intranet_config` - Intranet access configuration. + * `ip_address` - If fixed intranet IP is enabled, this field returns the IP list used. + * `ip_fixed` - Whether to enable fixed intranet IP, ENABLE is enabled, DISABLE is disabled. + * `l5_enable` - Whether to enable L5. + * `mem_size` - Memory size of the SCF function runtime, unit is M. + * `modify_time` - Modify time of the SCF function. + * `name` - Name of the SCF function. + * `namespace` - Namespace of the SCF function. + * `role` - CAM role of the SCF function. + * `runtime` - Runtime of the SCF function. + * `status_desc` - Status description of the SCF function. + * `status` - Status of the SCF function. + * `subnet_id` - Subnet ID of the SCF function. + * `tags` - Tags of the SCF function. + * `timeout` - Timeout of the SCF function maximum execution time, unit is second. + * `trigger_info` - Trigger details list the SCF function. Each element contains the following attributes: + * `create_time` - Create time of the SCF function trigger. + * `custom_argument` - user-defined parameter of the SCF function trigger. + * `enable` - Whether to enable SCF function trigger. + * `modify_time` - Modify time of the SCF function trigger. + * `name` - Name of the SCF function trigger. + * `trigger_desc` - TriggerDesc of the SCF function trigger. + * `type` - Type of the SCF function trigger. + * `vip` - Vip of the SCF function. + * `vpc_id` - VPC ID of the SCF function. + + diff --git a/config/docs/d/scf_layer_versions.html.markdown b/config/docs/d/scf_layer_versions.html.markdown new file mode 100644 index 0000000..c2ae6c1 --- /dev/null +++ b/config/docs/d/scf_layer_versions.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_layer_versions" +sidebar_current: "docs-tencentcloud-datasource-scf_layer_versions" +description: |- + Use this data source to query detailed information of scf layer_versions +--- + +# tencentcloud_scf_layer_versions + +Use this data source to query detailed information of scf layer_versions + +## Example Usage + +```hcl +data "tencentcloud_scf_layer_versions" "layer_versions" { + layer_name = "tf-test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `layer_name` - (Required, String) Layer name. +* `compatible_runtime` - (Optional, Set: [`String`]) Compatible runtimes. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `layer_versions` - Layer version list. + * `add_time` - Creation time. + * `compatible_runtimes` - Runtime applicable to a versionNote: This field may return null, indicating that no valid values can be obtained. + * `description` - Version descriptionNote: This field may return null, indicating that no valid values can be obtained. + * `layer_name` - Layer name. + * `layer_version` - Version number. + * `license_info` - License informationNote: This field may return null, indicating that no valid values can be obtained. + * `stamp` - StampNote: This field may return null, indicating that no valid values can be obtained. + * `status` - Current status of specific layer version. For valid values, please see [here](https://intl.cloud.tencent.com/document/product/583/47175?from_cn_redirect=1#.E5.B1.82.EF.BC.88layer.EF.BC.89.E7.8A.B6.E6.80.81). + + diff --git a/config/docs/d/scf_layers.html.markdown b/config/docs/d/scf_layers.html.markdown new file mode 100644 index 0000000..66038d1 --- /dev/null +++ b/config/docs/d/scf_layers.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_layers" +sidebar_current: "docs-tencentcloud-datasource-scf_layers" +description: |- + Use this data source to query detailed information of scf layers +--- + +# tencentcloud_scf_layers + +Use this data source to query detailed information of scf layers + +## Example Usage + +```hcl +data "tencentcloud_scf_layers" "layers" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `compatible_runtime` - (Optional, String) Compatible runtimes. +* `result_output_file` - (Optional, String) Used to save results. +* `search_key` - (Optional, String) Query key, which fuzzily matches the name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `layers` - Layer list. + * `add_time` - Creation time. + * `compatible_runtimes` - Runtime applicable to a versionNote: This field may return null, indicating that no valid values can be obtained. + * `description` - Version descriptionNote: This field may return null, indicating that no valid values can be obtained. + * `layer_name` - Layer name. + * `layer_version` - Version number. + * `license_info` - License informationNote: This field may return null, indicating that no valid values can be obtained. + * `stamp` - StampNote: This field may return null, indicating that no valid values can be obtained. + * `status` - Current status of specific layer version. For valid values, please see [here](https://intl.cloud.tencent.com/document/product/583/47175?from_cn_redirect=1#.E5.B1.82.EF.BC.88layer.EF.BC.89.E7.8A.B6.E6.80.81). + + diff --git a/config/docs/d/scf_logs.html.markdown b/config/docs/d/scf_logs.html.markdown new file mode 100644 index 0000000..301008b --- /dev/null +++ b/config/docs/d/scf_logs.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_logs" +sidebar_current: "docs-tencentcloud-datasource-scf_logs" +description: |- + Use this data source to query SCF function logs. +--- + +# tencentcloud_scf_logs + +Use this data source to query SCF function logs. + +## Example Usage + +```hcl +resource "tencentcloud_scf_function" "foo" { + name = "ci-test-function" + handler = "main.do_it" + runtime = "Python3.6" + + cos_bucket_name = "scf-code-1234567890" + cos_object_name = "code.zip" + cos_bucket_region = "ap-guangzhou" +} + +data "tencentcloud_scf_logs" "foo" { + function_name = tencentcloud_scf_function.foo.name +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String) Name of the SCF function to be queried. +* `end_time` - (Optional, String) The end time of the query, the format is `2017-05-16 20:00:00`, which can only be within one day from `start_time`. +* `invoke_request_id` - (Optional, String) Corresponding requestId when executing function. +* `limit` - (Optional, Int) Number of logs, the default is `10000`, offset+limit cannot be greater than 10000. +* `namespace` - (Optional, String) Namespace of the SCF function to be queried. +* `offset` - (Optional, Int) Log offset, default is `0`, offset+limit cannot be greater than 10000. +* `order_by` - (Optional, String) Sort the logs according to the following fields: `function_name`, `duration`, `mem_usage`, `start_time`, default `start_time`. +* `order` - (Optional, String) Order to sort the log, optional values `desc` and `asc`, default `desc`. +* `result_output_file` - (Optional, String) Used to save results. +* `ret_code` - (Optional, String) Use to filter log, optional value: `not0` only returns the error log. `is0` only returns the correct log. `TimeLimitExceeded` returns the log of the function call timeout. `ResourceLimitExceeded` returns the function call generation resource overrun log. `UserCodeException` returns logs of the user code error that occurred in the function call. Not passing the parameter means returning all logs. +* `start_time` - (Optional, String) The start time of the query, the format is `2017-05-16 20:00:00`, which can only be within one day from `end_time`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `logs` - An information list of logs. Each element contains the following attributes: + * `bill_duration` - Function billing time, according to duration up to the last 100ms, unit is ms. + * `duration` - Function execution time-consuming, unit is ms. + * `function_name` - Name of the SCF function. + * `invoke_finished` - Whether the function call ends, `1` means the execution ends, other values indicate the call exception. + * `level` - Log level. + * `log` - Log output during function execution. + * `mem_usage` - The actual memory size consumed in the execution of the function, unit is Byte. + * `request_id` - Execute the requestId corresponding to the function. + * `ret_code` - Execution result of function, `0` means the execution is successful, other values indicate failure. + * `ret_msg` - Return value after function execution is completed. + * `source` - Log source. + * `start_time` - Point in time at which the function begins execution. + + diff --git a/config/docs/d/scf_namespaces.html.markdown b/config/docs/d/scf_namespaces.html.markdown new file mode 100644 index 0000000..35eca29 --- /dev/null +++ b/config/docs/d/scf_namespaces.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_namespaces" +sidebar_current: "docs-tencentcloud-datasource-scf_namespaces" +description: |- + Use this data source to query SCF namespaces. +--- + +# tencentcloud_scf_namespaces + +Use this data source to query SCF namespaces. + +## Example Usage + +```hcl +resource "tencentcloud_scf_namespace" "foo" { + namespace = "ci-test-scf" +} + +data "tencentcloud_scf_namespaces" "foo" { + namespace = tencentcloud_scf_namespace.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `description` - (Optional, String) Description of the SCF namespace to be queried. +* `namespace` - (Optional, String) Name of the SCF namespace to be queried. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `namespaces` - An information list of namespace. Each element contains the following attributes: + * `create_time` - Create time of the SCF namespace. + * `description` - Description of the SCF namespace. + * `modify_time` - Modify time of the SCF namespace. + * `namespace` - Name of the SCF namespace. + * `type` - Type of the SCF namespace. + + diff --git a/config/docs/d/scf_request_status.html.markdown b/config/docs/d/scf_request_status.html.markdown new file mode 100644 index 0000000..5e4df3d --- /dev/null +++ b/config/docs/d/scf_request_status.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_request_status" +sidebar_current: "docs-tencentcloud-datasource-scf_request_status" +description: |- + Use this data source to query detailed information of scf request_status +--- + +# tencentcloud_scf_request_status + +Use this data source to query detailed information of scf request_status + +## Example Usage + +```hcl +data "tencentcloud_scf_request_status" "request_status" { + function_name = "keep-1676351130" + function_request_id = "9de9405a-e33a-498d-bb59-e80b7bed1191" + namespace = "default" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String) Function name. +* `function_request_id` - (Required, String) ID of the request to be queried. +* `end_time` - (Optional, String) End time of the query. such as `2017-05-16 20:59:59`. If `StartTime` is not specified, `EndTime` defaults to the current time. If `StartTime` is specified, `EndTime` is required, and it need to be later than the `StartTime`. +* `namespace` - (Optional, String) Function namespace. +* `result_output_file` - (Optional, String) Used to save results. +* `start_time` - (Optional, String) Start time of the query, for example `2017-05-16 20:00:00`. If it's left empty, it defaults to 15 minutes before the current time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Details of the function running statusNote: this field may return `null`, indicating that no valid values can be obtained. + * `duration` - Time consumed for the request in ms. + * `function_name` - Function name. + * `mem_usage` - Time consumed by the request in MB. + * `request_id` - Request ID. + * `ret_code` - Result of the request. `0`: succeeded, `1`: running, `-1`: exception. + * `ret_msg` - Return value after the function is executed. + * `retry_num` - Retry Attempts. + * `start_time` - Request start time. + + diff --git a/config/docs/d/scf_triggers.html.markdown b/config/docs/d/scf_triggers.html.markdown new file mode 100644 index 0000000..fa37d97 --- /dev/null +++ b/config/docs/d/scf_triggers.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_triggers" +sidebar_current: "docs-tencentcloud-datasource-scf_triggers" +description: |- + Use this data source to query detailed information of scf triggers +--- + +# tencentcloud_scf_triggers + +Use this data source to query detailed information of scf triggers + +## Example Usage + +```hcl +data "tencentcloud_scf_triggers" "triggers" { + function_name = "keep-1676351130" + namespace = "default" + order_by = "add_time" + order = "DESC" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String) Function name. +* `filters` - (Optional, List) * Qualifier:Function version, alias. +* `namespace` - (Optional, String) Namespace. Default value: default. +* `order_by` - (Optional, String) Indicates by which field to sort the returned results. Valid values: add_time, mod_time. Default value: mod_time. +* `order` - (Optional, String) Indicates whether the returned results are sorted in ascending or descending order. Valid values: ASC, DESC. Default value: DESC. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Fields to be filtered. Up to 10 conditions allowed.Values of Name: VpcId, SubnetId, ClsTopicId, ClsLogsetId, Role, CfsId, CfsMountInsId, Eip. Values limit: 1.Name options: Status, Runtime, FunctionType, PublicNetStatus, AsyncRunEnable, TraceEnable. Values limit: 20.When Name is Runtime, CustomImage refers to the image type function. +* `values` - (Required, Set) Filter values of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `triggers` - Trigger list. + * `add_time` - Trigger creation time. + * `available_status` - Whether the trigger is available. + * `bind_status` - Trigger-Function binding status. + * `custom_argument` - Custom parameterNote: this field may return null, indicating that no valid values can be obtained. + * `enable` - Whether to enable. + * `mod_time` - Trigger last modified time. + * `qualifier` - Function version or alias. + * `resource_id` - Minimum resource ID of trigger. + * `trigger_attribute` - Trigger type. Two-way means that the trigger can be manipulated in both consoles, while one-way means that the trigger can be created only in the SCF Console. + * `trigger_desc` - Detailed configuration of trigger. + * `trigger_name` - Trigger name. + * `type` - Trigger type. + + diff --git a/config/docs/d/security_group.html.markdown b/config/docs/d/security_group.html.markdown new file mode 100644 index 0000000..d804f8e --- /dev/null +++ b/config/docs/d/security_group.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_security_group" +sidebar_current: "docs-tencentcloud-datasource-security_group" +description: |- + Use this data source to query detailed information of security group. +--- + +# tencentcloud_security_group + +Use this data source to query detailed information of security group. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_security_groups. + +## Example Usage + +```hcl +data "tencentcloud_security_group" "sglab" { + security_group_id = tencentcloud_security_group.sglab.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Optional, String) Name of the security group to be queried. Conflict with `security_group_id`. +* `security_group_id` - (Optional, String) ID of the security group to be queried. Conflict with `name`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `be_associate_count` - Number of security group binding resources. +* `create_time` - Creation time of security group. +* `description` - Description of the security group. +* `project_id` - Project ID of the security group. + + diff --git a/config/docs/d/security_groups.html.markdown b/config/docs/d/security_groups.html.markdown new file mode 100644 index 0000000..c42a652 --- /dev/null +++ b/config/docs/d/security_groups.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_security_groups" +sidebar_current: "docs-tencentcloud-datasource-security_groups" +description: |- + Use this data source to query detailed information of security groups. +--- + +# tencentcloud_security_groups + +Use this data source to query detailed information of security groups. + +## Example Usage + +```hcl +data "tencentcloud_security_groups" "sglab" { + security_group_id = tencentcloud_security_group.sglab.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Optional, String) Name of the security group to be queried. Conflict with `security_group_id`. +* `project_id` - (Optional, Int) Project ID of the security group to be queried. Conflict with `security_group_id`. +* `result_output_file` - (Optional, String) Used to save results. +* `security_group_id` - (Optional, String) ID of the security group to be queried. Conflict with `name` and `project_id`. +* `tags` - (Optional, Map) Tags of the security group to be queried. Conflict with `security_group_id`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `security_groups` - Information list of security group. + * `be_associate_count` - Number of security group binding resources. + * `create_time` - Creation time of security group. + * `description` - Description of the security group. + * `egress` - Egress rules set. For items like `[action]#[cidr_ip]#[port]#[protocol]`, it means a regular rule; for items like `sg-XXXX`, it means a nested security group. + * `ingress` - Ingress rules set. For items like `[action]#[cidr_ip]#[port]#[protocol]`, it means a regular rule; for items like `sg-XXXX`, it means a nested security group. + * `name` - Name of the security group. + * `project_id` - Project ID of the security group. + * `security_group_id` - ID of the security group. + * `tags` - Tags of the security group. + + diff --git a/config/docs/d/ses_black_email_address.html.markdown b/config/docs/d/ses_black_email_address.html.markdown new file mode 100644 index 0000000..71bda75 --- /dev/null +++ b/config/docs/d/ses_black_email_address.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_black_email_address" +sidebar_current: "docs-tencentcloud-datasource-ses_black_email_address" +description: |- + Use this data source to query detailed information of ses black_email_address +--- + +# tencentcloud_ses_black_email_address + +Use this data source to query detailed information of ses black_email_address + +## Example Usage + +```hcl +data "tencentcloud_ses_black_email_address" "black_email_address" { + start_date = "2020-09-22" + end_date = "2020-09-23" + email_address = "xxx@mail.qcloud.com" + task_id = "7000" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_date` - (Required, String) End date in the format of `YYYY-MM-DD`. +* `start_date` - (Required, String) Start date in the format of `YYYY-MM-DD`. +* `email_address` - (Optional, String) You can specify an email address to query. +* `result_output_file` - (Optional, String) Used to save results. +* `task_id` - (Optional, String) You can specify a task ID to query. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `black_list` - List of blocklisted addresses. + * `bounce_time` - Time when the email address is blocklisted. + * `email_address` - Blocklisted email address. + + diff --git a/config/docs/d/ses_email_identities.html.markdown b/config/docs/d/ses_email_identities.html.markdown new file mode 100644 index 0000000..9a26cc2 --- /dev/null +++ b/config/docs/d/ses_email_identities.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_email_identities" +sidebar_current: "docs-tencentcloud-datasource-ses_email_identities" +description: |- + Use this data source to query detailed information of ses email_identities +--- + +# tencentcloud_ses_email_identities + +Use this data source to query detailed information of ses email_identities + +## Example Usage + +```hcl +data "tencentcloud_ses_email_identities" "email_identities" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `email_identities` - Sending domain name list. + * `current_reputation_level` - Current credit rating. + * `daily_quota` - Highest number of letters of the day. + * `identity_name` - Sending domain name. + * `identity_type` - Authentication type, fixed as DOMAIN. + * `sending_enabled` - Is it verified. +* `max_daily_quota` - Maximum daily sending volume for a single domain name. +* `max_reputation_level` - Maximum credit rating. + + diff --git a/config/docs/d/ses_receivers.html.markdown b/config/docs/d/ses_receivers.html.markdown new file mode 100644 index 0000000..10312c3 --- /dev/null +++ b/config/docs/d/ses_receivers.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_receivers" +sidebar_current: "docs-tencentcloud-datasource-ses_receivers" +description: |- + Use this data source to query detailed information of ses receivers +--- + +# tencentcloud_ses_receivers + +Use this data source to query detailed information of ses receivers + +## Example Usage + +```hcl +data "tencentcloud_ses_receivers" "receivers" { + status = 3 + key_word = "keep" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_word` - (Optional, String) Group name keyword for fuzzy query. +* `result_output_file` - (Optional, String) Used to save results. +* `status` - (Optional, Int) Group status (`1`: to be uploaded; `2`: uploading; `3`: uploaded). To query groups in all states, do not pass in this parameter. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Data record. + * `count` - Total number of recipient email addresses. + * `create_time` - Creation time, such as 2021-09-28 16:40:35. + * `desc` - Recipient group descriptionNote: This field may return `null`, indicating that no valid value can be found. + * `receiver_id` - Recipient group ID. + * `receivers_name` - Recipient group name. + * `receivers_status` - Group status (`1`: to be uploaded; `2` uploading; `3` uploaded)Note: This field may return `null`, indicating that no valid value can be found. + + diff --git a/config/docs/d/ses_send_email_status.html.markdown b/config/docs/d/ses_send_email_status.html.markdown new file mode 100644 index 0000000..dcdc7aa --- /dev/null +++ b/config/docs/d/ses_send_email_status.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_send_email_status" +sidebar_current: "docs-tencentcloud-datasource-ses_send_email_status" +description: |- + Use this data source to query detailed information of ses send_email_status +--- + +# tencentcloud_ses_send_email_status + +Use this data source to query detailed information of ses send_email_status + +## Example Usage + +```hcl +data "tencentcloud_ses_send_email_status" "send_email_status" { + request_date = "2020-09-22" + message_id = "qcloudses-30-4123414323-date-20210101094334-syNARhMTbKI1" + to_email_address = "example@cloud.com" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `request_date` - (Required, String) Date sent. This parameter is required. You can only query the sending status for a single date at a time. +* `message_id` - (Optional, String) The MessageId field returned by the SendMail API. +* `result_output_file` - (Optional, String) Used to save results. +* `to_email_address` - (Optional, String) Recipient email address. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `email_status_list` - Status of sent emails. + * `deliver_message` - Description of the recipient processing status. + * `deliver_status` - Recipient processing status0: Tencent Cloud has accepted the request and added it to the send queue.1: The email is delivered successfully. DeliverTime indicates the time when the email is delivered successfully.2: The email is discarded. DeliverMessage indicates the reason for discarding.3: The recipient&#39;s ESP rejects the email, probably because the email address does not exist or due to other reasons.8: The email is delayed by the ESP. DeliverMessage indicates the reason for delay. + * `deliver_time` - Timestamp when Tencent Cloud delivers the email. + * `from_email_address` - Sender email address. + * `message_id` - The MessageId field returned by the SendEmail API. + * `request_time` - Timestamp when the request arrives at Tencent Cloud. + * `send_status` - Tencent Cloud processing status: `0`: Successful. `1001`: Internal system exception. `1002`: Internal system exception. `1003`: Internal system exception. `1003`: Internal system exception. `1004`: Email sending timed out. `1005`: Internal system exception. `1006`: You have sent too many emails to the same address in a short period. `1007`: The email address is in the blocklist. `1008`: The sender domain is rejected by the recipient. `1009`: Internal system exception. `1010`: The daily email sending limit is exceeded. `1011`: You have no permission to send custom content. Use a template. `1013`: The sender domain is unsubscribed from by the recipient. `2001`: No results were found. `3007`: The template ID is invalid or the template is unavailable. `3008`: The sender domain is temporarily blocked by the recipient domain. `3009`: You have no permission to use this template. `3010`: The format of the TemplateData field is incorrect. `3014`: The email cannot be sent because the sender domain is not verified. `3020`: The recipient email address is in the blocklist. `3024`: Failed to precheck the email address format. `3030`: Email sending is restricted temporarily due to a high bounce rate. `3033`: The account has insufficient balance or overdue payment. + * `to_email_address` - Recipient email address. + * `user_clicked` - Whether the recipient has clicked the links in the email. + * `user_complainted` - Whether the recipient has reported the sender. + * `user_opened` - Whether the recipient has opened the email. + * `user_unsubscribed` - Whether the recipient has unsubscribed from the email sent by the sender. + + diff --git a/config/docs/d/ses_send_tasks.html.markdown b/config/docs/d/ses_send_tasks.html.markdown new file mode 100644 index 0000000..2276964 --- /dev/null +++ b/config/docs/d/ses_send_tasks.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_send_tasks" +sidebar_current: "docs-tencentcloud-datasource-ses_send_tasks" +description: |- + Use this data source to query detailed information of ses send_tasks +--- + +# tencentcloud_ses_send_tasks + +Use this data source to query detailed information of ses send_tasks + +## Example Usage + +```hcl +data "tencentcloud_ses_send_tasks" "send_tasks" { + status = 10 + receiver_id = 1063742 + task_type = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `receiver_id` - (Optional, Int) Recipient group ID. +* `result_output_file` - (Optional, String) Used to save results. +* `status` - (Optional, Int) Task status. `1`: to start; `5`: sending; `6`: sending suspended today; `7`: sending error; `10`: sent. To query tasks in all states, do not pass in this parameter. +* `task_type` - (Optional, Int) Task type. `1`: immediate; `2`: scheduled; `3`: recurring. To query tasks of all types, do not pass in this parameter. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Data record. + * `cache_count` - Number of emails cached. + * `create_time` - Task creation time. + * `cycle_param` - Parameters of a recurring taskNote: This field may return `null`, indicating that no valid value can be found. + * `begin_time` - Start time of the task. + * `interval_time` - Task recurrence in hours. + * `term_cycle` - Specifies whether to end the cycle. This parameter is used to update the task. Valid values: 0: No; 1: Yes. + * `err_msg` - Task exception informationNote: This field may return `null`, indicating that no valid value can be found. + * `from_email_address` - Sender address. + * `receiver_id` - Recipient group ID. + * `receivers_name` - Recipient group name. + * `request_count` - Number of emails requested to be sent. + * `send_count` - Number of emails sent. + * `subject` - Email subject. + * `task_id` - Task ID. + * `task_status` - Task status. `1`: to start; `5`: sending; `6`: sending suspended today; `7`: sending error; `10`: sent. + * `task_type` - Task type. `1`: immediate; `2`: scheduled; `3`: recurring. + * `template` - Template and template dataNote: This field may return `null`, indicating that no valid value can be found. + * `template_data` - Variable parameters in the template. Please use `json.dump` to format the JSON object into a string type. The object is a set of key-value pairs. Each key denotes a variable, which is represented by {{key}}. The key will be replaced with the corresponding value (represented by {{value}}) when sending the email.Note: The parameter value cannot be data of a complex type such as HTML.Example: {name:xxx,age:xx}. + * `template_id` - Template ID. If you do not have any template, please create one. + * `timed_param` - Parameters of a scheduled taskNote: This field may return `null`, indicating that no valid value can be found. + * `begin_time` - Start time of a scheduled sending task. + * `update_time` - Task update time. + + diff --git a/config/docs/d/ses_statistics_report.html.markdown b/config/docs/d/ses_statistics_report.html.markdown new file mode 100644 index 0000000..8bdd39d --- /dev/null +++ b/config/docs/d/ses_statistics_report.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_statistics_report" +sidebar_current: "docs-tencentcloud-datasource-ses_statistics_report" +description: |- + Use this data source to query detailed information of ses statistics_report +--- + +# tencentcloud_ses_statistics_report + +Use this data source to query detailed information of ses statistics_report + +## Example Usage + +```hcl +data "tencentcloud_ses_statistics_report" "statistics_report" { + start_date = "2020-10-01" + end_date = "2023-09-05" + domain = "iac-tf.cloud" + receiving_mailbox_type = "gmail.com" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_date` - (Required, String) End date. +* `start_date` - (Required, String) Start date. +* `domain` - (Optional, String) Sender domain. +* `receiving_mailbox_type` - (Optional, String) Recipient address type, for example, gmail.com. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `daily_volumes` - Daily email sending statistics. + * `accepted_count` - Number of email requests accepted by Tencent Cloud. + * `bounce_count` - Number of bounced emails. + * `clicked_count` - Number of recipients who clicked on links in emails. + * `delivered_count` - Number of delivered emails. + * `opened_count` - Number of users (deduplicated) who opened emails. + * `request_count` - Number of email requests. + * `send_date` - Date Note: this field may return null, indicating that no valid values can be obtained. + * `unsubscribe_count` - Number of users who canceled subscriptions. Note: this field may return null, indicating that no valid values can be obtained. +* `overall_volume` - Overall email sending statistics. + * `accepted_count` - Number of email requests accepted by Tencent Cloud. + * `bounce_count` - Number of bounced emails. + * `clicked_count` - Number of recipients who clicked on links in emails. + * `delivered_count` - Number of delivered emails. + * `opened_count` - Number of users (deduplicated) who opened emails. + * `request_count` - Number of email requests. + * `send_date` - Date Note: this field may return null, indicating that no valid values can be obtained. + * `unsubscribe_count` - Number of users who canceled subscriptions. Note: this field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/sqlserver_account_db_attachments.html.markdown b/config/docs/d/sqlserver_account_db_attachments.html.markdown new file mode 100644 index 0000000..aeb32ec --- /dev/null +++ b/config/docs/d/sqlserver_account_db_attachments.html.markdown @@ -0,0 +1,102 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_account_db_attachments" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_account_db_attachments" +description: |- + Use this data source to query the list of SQL Server account DB privileges. +--- + +# tencentcloud_sqlserver_account_db_attachments + +Use this data source to query the list of SQL Server account DB privileges. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +data "tencentcloud_sqlserver_account_db_attachments" "test" { + instance_id = tencentcloud_sqlserver_instance.example.id + account_name = tencentcloud_sqlserver_account_db_attachment.example.account_name +} + +resource "tencentcloud_vpc" "vpc" { + name = "example-vpc" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + name = "example-vpc" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "example-sg" + description = "desc." +} + +resource "tencentcloud_sqlserver_instance" "example" { + name = "tf_example_sql" + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + charge_type = "POSTPAID_BY_HOUR" + period = 1 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.security_group.id] + project_id = 0 + memory = 2 + storage = 20 + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "01:00" + maintenance_time_span = 3 + tags = { + "createBy" = "tfExample" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_instance.example.id + name = "tfExampleDb" + charset = "Chinese_PRC_BIN" + remark = "remark desc." +} + +resource "tencentcloud_sqlserver_account" "example" { + instance_id = tencentcloud_sqlserver_instance.example.id + name = "tf_example_account" + password = "PassWord@123" + remark = "remark desc." +} + +resource "tencentcloud_sqlserver_account_db_attachment" "example" { + instance_id = tencentcloud_sqlserver_instance.example.id + account_name = tencentcloud_sqlserver_account.example.name + db_name = tencentcloud_sqlserver_db.example.name + privilege = "ReadWrite" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) SQL Server instance ID that the account belongs to. +* `account_name` - (Optional, String) Name of the SQL Server account to be queried. +* `db_name` - (Optional, String) Name of the DB to be queried. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of SQL Server account. Each element contains the following attributes: + * `account_name` - SQL Server account name. + * `db_name` - SQL Server DB name. + * `instance_id` - SQL Server instance ID that the account belongs to. + * `privilege` - Privilege of the account on DB. Valid value are `ReadOnly`, `ReadWrite`. + + diff --git a/config/docs/d/sqlserver_accounts.html.markdown b/config/docs/d/sqlserver_accounts.html.markdown new file mode 100644 index 0000000..953758c --- /dev/null +++ b/config/docs/d/sqlserver_accounts.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_accounts" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_accounts" +description: |- + Use this data source to query the list of SQL Server accounts. +--- + +# tencentcloud_sqlserver_accounts + +Use this data source to query the list of SQL Server accounts. + +## Example Usage + +### Pull instance account list + +```hcl +data "tencentcloud_sqlserver_accounts" "example" { + instance_id = "mssql-3cdq7kx5" +} +``` + +### Pull instance account list Filter by name + +```hcl +data "tencentcloud_sqlserver_accounts" "example" { + instance_id = "mssql-3cdq7kx5" + name = "myaccount" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) SQL server instance ID that the account belongs to. +* `name` - (Optional, String) Name of the SQL server account to be queried. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of SQL Server account. Each element contains the following attributes: + * `create_time` - Create time of the SQL Server account. + * `instance_id` - SQL server instance ID that the account belongs to. + * `name` - Name of the SQL server account. + * `remark` - Remark of the SQL Server account. + * `status` - Status of the SQL Server account. `1` for creating, `2` for running, `3` for modifying, 4 for resetting password, -1 for deleting. + * `update_time` - Last updated time of the SQL Server account. + + diff --git a/config/docs/d/sqlserver_backup_by_flow_id.html.markdown b/config/docs/d/sqlserver_backup_by_flow_id.html.markdown new file mode 100644 index 0000000..f6ff67d --- /dev/null +++ b/config/docs/d/sqlserver_backup_by_flow_id.html.markdown @@ -0,0 +1,103 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_backup_by_flow_id" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_backup_by_flow_id" +description: |- + Use this data source to query detailed information of sqlserver datasource_backup_by_flow_id +--- + +# tencentcloud_sqlserver_backup_by_flow_id + +Use this data source to query detailed information of sqlserver datasource_backup_by_flow_id + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +data "tencentcloud_sqlserver_backup_by_flow_id" "example" { + instance_id = tencentcloud_sqlserver_general_backup.example.instance_id + flow_id = tencentcloud_sqlserver_general_backup.example.flow_id +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_db" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_general_backup" "example" { + instance_id = tencentcloud_sqlserver_db.example.id + backup_name = "tf_example_backup" + strategy = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `flow_id` - (Required, String) Create a backup process ID, which can be obtained through the [CreateBackup](https://cloud.tencent.com/document/product/238/19946) interface. +* `instance_id` - (Required, String) Instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `backup_name` - Backup task name, customizable. +* `backup_way` - Backup method, 0-scheduled backup; 1-manual temporary backup; instance status is 0-creating, this field is the default value 0, meaningless. +* `dbs` - For the DB list, only the library name contained in the first record is returned for a single-database backup file; for a single-database backup file, the library names of all records need to be obtained through the DescribeBackupFiles interface. +* `end_time` - backup end time. +* `external_addr` - External network download address, for a single database backup file, only the external network download address of the first record is returned; single database backup files need to obtain the download addresses of all records through the DescribeBackupFiles interface. +* `file_name` - File name. For a single-database backup file, only the file name of the first record is returned; for a single-database backup file, the file names of all records need to be obtained through the DescribeBackupFiles interface. +* `group_id` - Aggregate Id, this value is not returned for packaged backup files. Use this value to call the DescribeBackupFiles interface to obtain the detailed information of a single database backup file. +* `internal_addr` - Intranet download address, for a single database backup file, only the intranet download address of the first record is returned; single database backup files need to obtain the download addresses of all records through the DescribeBackupFiles interface. +* `start_time` - backup start time. +* `status` - Backup file status, 0-creating; 1-success; 2-failure. +* `strategy` - Backup strategy, 0-instance backup; 1-multi-database backup; when the instance status is 0-creating, this field is the default value 0, meaningless. + + diff --git a/config/docs/d/sqlserver_backup_commands.html.markdown b/config/docs/d/sqlserver_backup_commands.html.markdown new file mode 100644 index 0000000..cda34d6 --- /dev/null +++ b/config/docs/d/sqlserver_backup_commands.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_backup_commands" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_backup_commands" +description: |- + Use this data source to query detailed information of sqlserver datasource_backup_command +--- + +# tencentcloud_sqlserver_backup_commands + +Use this data source to query detailed information of sqlserver datasource_backup_command + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_backup_commands" "example" { + backup_file_type = "FULL" + data_base_name = "keep-publish-instance" + is_recovery = "NO" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_file_type` - (Required, String) Backup file type. Full: full backup. FULL_LOG: full backup which needs log increments. FULL_DIFF: full backup which needs differential increments. LOG: log backup. DIFF: differential backup. +* `data_base_name` - (Required, String) Database name. +* `is_recovery` - (Required, String) Whether restoration is required. No: not required. Yes: required. +* `local_path` - (Optional, String) Storage path of backup files. If this parameter is left empty, the default storage path will be D:. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - Command list. + * `command` - Create backup command. + * `request_id` - Request ID. + + diff --git a/config/docs/d/sqlserver_backup_upload_size.html.markdown b/config/docs/d/sqlserver_backup_upload_size.html.markdown new file mode 100644 index 0000000..d80ca1c --- /dev/null +++ b/config/docs/d/sqlserver_backup_upload_size.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_backup_upload_size" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_backup_upload_size" +description: |- + Use this data source to query detailed information of sqlserver datasource_backup_upload_size +--- + +# tencentcloud_sqlserver_backup_upload_size + +Use this data source to query detailed information of sqlserver datasource_backup_upload_size + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_backup_upload_size" "example" { + instance_id = "mssql-4gmc5805" + backup_migration_id = "mssql-backup-migration-9tj0sxnz" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_migration_id` - (Required, String) Backup import task ID, which is returned through the API CreateBackupMigration. +* `instance_id` - (Required, String) ID of imported target instance. +* `incremental_migration_id` - (Optional, String) Incremental import task ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cos_upload_backup_file_set` - Information of uploaded backups. + * `file_name` - Backup name. + * `size` - Backup size. + + diff --git a/config/docs/d/sqlserver_backups.html.markdown b/config/docs/d/sqlserver_backups.html.markdown new file mode 100644 index 0000000..f51690b --- /dev/null +++ b/config/docs/d/sqlserver_backups.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_backups" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_backups" +description: |- + Use this data source to query the list of SQL Server backups. +--- + +# tencentcloud_sqlserver_backups + +Use this data source to query the list of SQL Server backups. + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_backups" "foo" { + instance_id = "mssql-3cdq7kx5" + start_time = "2020-06-17 00:00:00" + end_time = "2020-06-22 00:00:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) End time of the instance list, like yyyy-MM-dd HH:mm:ss. +* `instance_id` - (Required, String) Instance ID. +* `start_time` - (Required, String) Start time of the instance list, like yyyy-MM-dd HH:mm:ss. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of SQL Server backup. Each element contains the following attributes: + * `db_list` - Database name list of the backup. + * `end_time` - End time of the backup. + * `file_name` - File name of the backup. + * `id` - ID of the backup. + * `instance_id` - Instance ID. + * `internet_url` - URL for downloads externally. + * `intranet_url` - URL for downloads internally. + * `size` - The size of backup file. Unit is KB. + * `start_time` - Start time of the backup. + * `status` - Status of the backup. `1` for creating, `2` for successfully created, 3 for failed. + * `strategy` - Strategy of the backup. `0` for instance backup, `1` for multi-databases backup. + * `trigger_model` - The way to trigger backup. `0` for timed trigger, `1` for manual trigger. + + diff --git a/config/docs/d/sqlserver_basic_instances.html.markdown b/config/docs/d/sqlserver_basic_instances.html.markdown new file mode 100644 index 0000000..ef74156 --- /dev/null +++ b/config/docs/d/sqlserver_basic_instances.html.markdown @@ -0,0 +1,75 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_basic_instances" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_basic_instances" +description: |- + Use this data source to query SQL Server basic instances +--- + +# tencentcloud_sqlserver_basic_instances + +Use this data source to query SQL Server basic instances + +## Example Usage + +### Filter instance by Id + +```hcl +data "tencentcloud_sqlserver_basic_instances" "example_id" { + id = "mssql-3l3fgqn7" +} +``` + +### Filter instance by project Id + +```hcl +data "tencentcloud_sqlserver_basic_instances" "example_project" { + project_id = 0 +} +``` + +### Filter instance by VPC/Subnet + +```hcl +data "tencentcloud_sqlserver_basic_instances" "example_vpc" { + vpc_id = "vpc-409mvdvv" + subnet_id = "subnet-nf9n81ps" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the SQL Server basic instance to be query. +* `name` - (Optional, String) Name of the SQL Server basic instance to be query. +* `project_id` - (Optional, Int) Project ID of the SQL Server basic instance to be query. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) Subnet ID of the SQL Server basic instance to be query. +* `vpc_id` - (Optional, String) Vpc ID of the SQL Server basic instance to be query. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - A list of SQL Server basic instances. Each element contains the following attributes. + * `availability_zone` - Availability zone. + * `charge_type` - Pay type of the SQL Server basic instance. For now, only `POSTPAID_BY_HOUR` is valid. + * `cpu` - The CPU number of the SQL Server basic instance. + * `create_time` - Create time of the SQL Server basic instance. + * `engine_version` - Version of the SQL Server basic database engine. Allowed values are `2008R2`(SQL Server 2008 Enterprise), `2012SP3`(SQL Server 2012 Enterprise), `2016SP1` (SQL Server 2016 Enterprise), `201602`(SQL Server 2016 Standard) and `2017`(SQL Server 2017 Enterprise). Default is `2008R2`. + * `id` - ID of the SQL Server basic instance. + * `memory` - Memory size (in GB). Allowed value must be larger than `memory` that data source `tencentcloud_sqlserver_specinfos` provides. + * `name` - Name of the SQL Server basic instance. + * `project_id` - Project ID, default value is `0`. + * `status` - Status of the SQL Server basic instance. `1` for applying, `2` for running, `3` for running with limit, `4` for isolated, `5` for recycling, `6` for recycled, `7` for running with task, `8` for off-line, `9` for expanding, `10` for migrating, `11` for readonly, `12` for rebooting. + * `storage` - Disk size (in GB). Allowed value must be a multiple of 10. The storage must be set with the limit of `storage_min` and `storage_max` which data source `tencentcloud_sqlserver_specinfos` provides. + * `subnet_id` - ID of subnet. + * `tags` - Tags of the SQL Server basic instance. + * `used_storage` - Used storage. + * `vip` - IP for private access. + * `vpc_id` - ID of VPC. + * `vport` - Port for private access. + + diff --git a/config/docs/d/sqlserver_cross_region_zone.html.markdown b/config/docs/d/sqlserver_cross_region_zone.html.markdown new file mode 100644 index 0000000..7acc139 --- /dev/null +++ b/config/docs/d/sqlserver_cross_region_zone.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_cross_region_zone" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_cross_region_zone" +description: |- + Use this data source to query detailed information of sqlserver datasource_cross_region_zone +--- + +# tencentcloud_sqlserver_cross_region_zone + +Use this data source to query detailed information of sqlserver datasource_cross_region_zone + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_cross_region_zone" "example" { + instance_id = "mssql-qelbzgwf" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID in the format of mssql-j8kv137v. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `region` - The string ID of the region where the standby machine is located, such as: ap-guangzhou. +* `zone` - The string ID of the availability zone where the standby machine is located, such as: ap-guangzhou-1. + + diff --git a/config/docs/d/sqlserver_datasource_ins_attribute.html.markdown b/config/docs/d/sqlserver_datasource_ins_attribute.html.markdown new file mode 100644 index 0000000..4127dd3 --- /dev/null +++ b/config/docs/d/sqlserver_datasource_ins_attribute.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_datasource_ins_attribute" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_datasource_ins_attribute" +description: |- + Use this data source to query detailed information of sqlserver datasource_ins_attribute +--- + +# tencentcloud_sqlserver_datasource_ins_attribute + +Use this data source to query detailed information of sqlserver datasource_ins_attribute + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_datasource_ins_attribute" "datasource_ins_attribute" { + instance_id = "mssql-gyg9xycl" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `blocked_threshold` - Block process threshold in milliseconds. +* `event_save_days` - Retention period for the files of slow SQL, blocking, deadlock, and extended events. +* `regular_backup_counts` - The number of retained archive backups. +* `regular_backup_enable` - Archive backup status. Valid values: enable (enabled), disable (disabled). +* `regular_backup_save_days` - Archive backup retention period: [90-3650] days. +* `regular_backup_start_time` - Archive backup start date in YYYY-MM-DD format, which is the current time by default. +* `regular_backup_strategy` - Archive backup policy. Valid values: years (yearly); quarters (quarterly);months` (monthly). +* `tde_config` - TDE Transparent Data Encryption Configuration. + * `certificate_attribution` - Certificate ownership. Self - indicates using the account's own certificate, others - indicates referencing certificates from other accounts, and none - indicates no certificate. + * `encryption` - TDE encryption, 'enable' - enabled, 'disable' - not enabled. + * `quote_uin` - Other primary account IDs referenced when activating TDE encryption +Note: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/sqlserver_db_charsets.html.markdown b/config/docs/d/sqlserver_db_charsets.html.markdown new file mode 100644 index 0000000..d5891ad --- /dev/null +++ b/config/docs/d/sqlserver_db_charsets.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_db_charsets" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_db_charsets" +description: |- + Use this data source to query detailed information of sqlserver datasource_d_b_charsets +--- + +# tencentcloud_sqlserver_db_charsets + +Use this data source to query detailed information of sqlserver datasource_d_b_charsets + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_db_charsets" "example" { + instance_id = "mssql-qelbzgwf" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID in the format of mssql-j8kv137v. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `database_charsets` - Database character set list. + + diff --git a/config/docs/d/sqlserver_dbs.html.markdown b/config/docs/d/sqlserver_dbs.html.markdown new file mode 100644 index 0000000..d96aca3 --- /dev/null +++ b/config/docs/d/sqlserver_dbs.html.markdown @@ -0,0 +1,91 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_dbs" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_dbs" +description: |- + Use this data source to query DB resources for the specific SQL Server instance. +--- + +# tencentcloud_sqlserver_dbs + +Use this data source to query DB resources for the specific SQL Server instance. + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_dbs" "example" { + instance_id = tencentcloud_sqlserver_db.example.instance_id +} + +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_db" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) SQL Server instance ID which DB belongs to. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `db_list` - A list of dbs belong to the specific instance. Each element contains the following attributes: + * `charset` - Character set DB uses, could be `Chinese_PRC_CI_AS`, `Chinese_PRC_CS_AS`, `Chinese_PRC_BIN`, `Chinese_Taiwan_Stroke_CI_AS`, `SQL_Latin1_General_CP1_CI_AS`, and `SQL_Latin1_General_CP1_CS_AS`. + * `create_time` - Database creation time. + * `instance_id` - SQL Server instance ID which DB belongs to. + * `name` - Name of DB. + * `remark` - Remark of the DB. + * `status` - Database status. Valid values are `creating`, `running`, `modifying`, `dropping`. + + diff --git a/config/docs/d/sqlserver_ins_attribute.html.markdown b/config/docs/d/sqlserver_ins_attribute.html.markdown new file mode 100644 index 0000000..19871d9 --- /dev/null +++ b/config/docs/d/sqlserver_ins_attribute.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_ins_attribute" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_ins_attribute" +description: |- + Use this data source to query detailed information of sqlserver_ins_attribute +--- + +# tencentcloud_sqlserver_ins_attribute + +Use this data source to query detailed information of sqlserver_ins_attribute + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_ins_attribute" "example" { + instance_id = "mssql-gyg9xycl" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `blocked_threshold` - Block process threshold in milliseconds. +* `event_save_days` - Retention period for the files of slow SQL, blocking, deadlock, and extended events. +* `regular_backup_counts` - The number of retained archive backups. +* `regular_backup_enable` - Archive backup status. Valid values: enable (enabled), disable (disabled). +* `regular_backup_save_days` - Archive backup retention period: [90-3650] days. +* `regular_backup_start_time` - Archive backup start date in YYYY-MM-DD format, which is the current time by default. +* `regular_backup_strategy` - Archive backup policy. Valid values: years (yearly); quarters (quarterly);months` (monthly). +* `tde_config` - TDE Transparent Data Encryption Configuration. + * `certificate_attribution` - Certificate ownership. Self - indicates using the account's own certificate, others - indicates referencing certificates from other accounts, and none - indicates no certificate. + * `encryption` - TDE encryption, 'enable' - enabled, 'disable' - not enabled. + * `quote_uin` - Other primary account IDs referenced when activating TDE encryption +Note: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/sqlserver_instance_param_records.html.markdown b/config/docs/d/sqlserver_instance_param_records.html.markdown new file mode 100644 index 0000000..f14fbb3 --- /dev/null +++ b/config/docs/d/sqlserver_instance_param_records.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_instance_param_records" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_instance_param_records" +description: |- + Use this data source to query detailed information of sqlserver instance_param_records +--- + +# tencentcloud_sqlserver_instance_param_records + +Use this data source to query detailed information of sqlserver instance_param_records + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_instance_param_records" "example" { + instance_id = "mssql-qelbzgwf" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID in the format of mssql-dj5i29c5n. It is the same as the instance ID displayed in the TencentDB console and the response parameter InstanceId of the DescribeDBInstances API. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `items` - Parameter modification records. + * `instance_id` - Instance ID. + * `modify_time` - Modification time. + * `new_value` - Parameter value after modification. + * `old_value` - Parameter value before modification. + * `param_name` - Parameter name. + * `status` - Parameter modification status. Valid values: 1 (initializing and waiting for modification), 2 (modification succeed), 3 (modification failed), 4 (modifying). + + diff --git a/config/docs/d/sqlserver_instances.html.markdown b/config/docs/d/sqlserver_instances.html.markdown new file mode 100644 index 0000000..d0111ec --- /dev/null +++ b/config/docs/d/sqlserver_instances.html.markdown @@ -0,0 +1,76 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_instances" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_instances" +description: |- + Use this data source to query SQL Server instances +--- + +# tencentcloud_sqlserver_instances + +Use this data source to query SQL Server instances + +## Example Usage + +### Filter instance by Id + +```hcl +data "tencentcloud_sqlserver_instances" "example_id" { + id = "mssql-3l3fgqn7" +} +``` + +### Filter instance by project Id + +```hcl +data "tencentcloud_sqlserver_instances" "example_project" { + project_id = 0 +} +``` + +### Filter instance by VPC/Subnet + +```hcl +data "tencentcloud_sqlserver_instances" "example_vpc" { + vpc_id = "vpc-409mvdvv" + subnet_id = "subnet-nf9n81ps" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the SQL Server instance to be query. +* `name` - (Optional, String) Name of the SQL Server instance to be query. +* `project_id` - (Optional, Int) Project ID of the SQL Server instance to be query. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) Subnet ID of the SQL Server instance to be query. +* `vpc_id` - (Optional, String) Vpc ID of the SQL Server instance to be query. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - A list of SQL Server instances. Each element contains the following attributes. + * `availability_zone` - Availability zone. + * `charge_type` - Pay type of the SQL Server instance. For now, only `POSTPAID_BY_HOUR` is valid. + * `create_time` - Create time of the SQL Server instance. + * `engine_version` - Version of the SQL Server database engine. Allowed values are `2008R2`(SQL Server 2008 Enterprise), `2012SP3`(SQL Server 2012 Enterprise), `2016SP1` (SQL Server 2016 Enterprise), `201602`(SQL Server 2016 Standard) and `2017`(SQL Server 2017 Enterprise). Default is `2008R2`. + * `ha_type` - Instance type. `DUAL` (dual-server high availability), `CLUSTER` (cluster). + * `id` - ID of the SQL Server instance. + * `memory` - Memory size (in GB). Allowed value must be larger than `memory` that data source `tencentcloud_sqlserver_specinfos` provides. + * `name` - Name of the SQL Server instance. + * `project_id` - Project ID, default value is 0. + * `ro_flag` - Readonly flag. `RO` (read-only instance), `MASTER` (primary instance with read-only instances). If it is left empty, it refers to an instance which is not read-only and has no RO group. + * `status` - Status of the SQL Server instance. 1 for applying, 2 for running, 3 for running with limit, 4 for isolated, 5 for recycling, 6 for recycled, 7 for running with task, 8 for off-line, 9 for expanding, 10 for migrating, 11 for readonly, 12 for rebooting. + * `storage` - Disk size (in GB). Allowed value must be a multiple of 10. The storage must be set with the limit of `storage_min` and `storage_max` which data source `tencentcloud_sqlserver_specinfos` provides. + * `subnet_id` - ID of subnet. + * `tags` - Tags of the SQL Server instance. + * `used_storage` - Used storage. + * `vip` - IP for private access. + * `vpc_id` - ID of VPC. + * `vport` - Port for private access. + + diff --git a/config/docs/d/sqlserver_project_security_groups.html.markdown b/config/docs/d/sqlserver_project_security_groups.html.markdown new file mode 100644 index 0000000..5d5a6d9 --- /dev/null +++ b/config/docs/d/sqlserver_project_security_groups.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_project_security_groups" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_project_security_groups" +description: |- + Use this data source to query detailed information of sqlserver project_security_groups +--- + +# tencentcloud_sqlserver_project_security_groups + +Use this data source to query detailed information of sqlserver project_security_groups + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_project_security_groups" "example" { + project_id = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Required, Int) Project ID, which can be viewed through the console project management. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `security_group_set` - Security group details. + * `create_time` - Creation time, time format: yyyy-mm-dd hh:mm:ss. + * `inbound_set` - inbound rules. + * `action` - Policy, ACCEPT or DROP. + * `cidr_ip` - Destination IP or IP segment, such as 172.16.0.0/12. + * `dir` - The direction defined by the rules, OUTPUT-outgoing rules INPUT-inbound rules. + * `ip_protocol` - Network protocol, support UDP, TCP, etc. + * `port_range` - port or port range. + * `outbound_set` - outbound rules. + * `action` - Policy, ACCEPT or DROP. + * `cidr_ip` - Destination IP or IP segment, such as 172.16.0.0/12. + * `dir` - The direction defined by the rules, OUTPUT-outgoing rules INPUT-inbound rules. + * `ip_protocol` - Network protocol, support UDP, TCP, etc. + * `port_range` - port or port range. + * `project_id` - project ID. + * `security_group_id` - Security group ID. + * `security_group_name` - security group name. + * `security_group_remark` - Security Group Remarks. + + diff --git a/config/docs/d/sqlserver_publish_subscribes.html.markdown b/config/docs/d/sqlserver_publish_subscribes.html.markdown new file mode 100644 index 0000000..1bd60f6 --- /dev/null +++ b/config/docs/d/sqlserver_publish_subscribes.html.markdown @@ -0,0 +1,149 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_publish_subscribes" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_publish_subscribes" +description: |- + Use this data source to query Publish Subscribe resources for the specific SQL Server instance. +--- + +# tencentcloud_sqlserver_publish_subscribes + +Use this data source to query Publish Subscribe resources for the specific SQL Server instance. + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_publish_subscribes" "example" { + instance_id = tencentcloud_sqlserver_publish_subscribe.example.publish_instance_id +} + +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_general_cloud_instance" "example_pub" { + name = "tf-example-pub" + zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_HSSD" + instance_charge_type = "POSTPAID" + project_id = 0 + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + db_version = "2008R2" + security_group_list = [tencentcloud_security_group.security_group.id] + weekly = [1, 2, 3, 5, 6, 7] + start_time = "00:00" + span = 6 + resource_tags { + tag_key = "test" + tag_value = "test" + } + collation = "Chinese_PRC_CI_AS" + time_zone = "China Standard Time" +} + +resource "tencentcloud_sqlserver_general_cloud_instance" "example_sub" { + name = "tf-example-sub" + zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_HSSD" + instance_charge_type = "POSTPAID" + project_id = 0 + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + db_version = "2008R2" + security_group_list = [tencentcloud_security_group.security_group.id] + weekly = [1, 2, 3, 5, 6, 7] + start_time = "00:00" + span = 6 + resource_tags { + tag_key = "test" + tag_value = "test" + } + collation = "Chinese_PRC_CI_AS" + time_zone = "China Standard Time" +} + +resource "tencentcloud_sqlserver_db" "example_pub" { + instance_id = tencentcloud_sqlserver_general_cloud_instance.example_pub.id + name = "tf_example_db_pub" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_db" "example_sub" { + instance_id = tencentcloud_sqlserver_general_cloud_instance.example_sub.id + name = "tf_example_db_sub" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_publish_subscribe" "example" { + publish_instance_id = tencentcloud_sqlserver_general_cloud_instance.example_pub.id + subscribe_instance_id = tencentcloud_sqlserver_general_cloud_instance.example_sub.id + publish_subscribe_name = "example" + delete_subscribe_db = false + database_tuples { + publish_database = tencentcloud_sqlserver_db.example_pub.name + subscribe_database = tencentcloud_sqlserver_db.example_sub.name + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) ID of the SQL Server instance. +* `pub_or_sub_instance_id` - (Optional, String) The subscribe/publish instance ID. It is related to whether the `instance_id` is a publish instance or a subscribe instance. when `instance_id` is a publish instance, this field is filtered according to the subscribe instance ID; when `instance_id` is a subscribe instance, this field is filtering according to the publish instance ID. +* `pub_or_sub_instance_ip` - (Optional, String) The intranet IP of the subscribe/publish instance. It is related to whether the `instance_id` is a publish instance or a subscribe instance. when `instance_id` is a publish instance, this field is filtered according to the intranet IP of the subscribe instance; when `instance_id` is a subscribe instance, this field is based on the publish instance intranet IP filter. +* `publish_database` - (Optional, String) Name of publish database. +* `publish_subscribe_id` - (Optional, Int) The id of the Publish and Subscribe. +* `publish_subscribe_name` - (Optional, String) The name of the Publish and Subscribe. +* `result_output_file` - (Optional, String) Used to store results. +* `subscribe_database` - (Optional, String) Name of subscribe database. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `publish_subscribe_list` - Publish and subscribe list. Each element contains the following attributes. + * `database_tuples` - Database Publish and Publish relationship list. + * `last_sync_time` - Last sync time. + * `publish_database` - Name of the publish SQL Server instance. + * `status` - Publish and subscribe status between databases, valid values are `running`, `success`, `fail`, `unknow`. + * `subscribe_database` - Name of the subscribe SQL Server instance. + * `publish_instance_id` - ID of the SQL Server instance which publish. + * `publish_instance_ip` - IP of the the SQL Server instance which publish. + * `publish_instance_name` - Name of the SQL Server instance which publish. + * `publish_subscribe_id` - The id of the Publish and Subscribe. + * `publish_subscribe_name` - The name of the Publish and Subscribe. + * `subscribe_instance_id` - ID of the SQL Server instance which subscribe. + * `subscribe_instance_ip` - IP of the SQL Server instance which subscribe. + * `subscribe_instance_name` - Name of the SQL Server instance which subscribe. + + diff --git a/config/docs/d/sqlserver_query_xevent.html.markdown b/config/docs/d/sqlserver_query_xevent.html.markdown new file mode 100644 index 0000000..31a13a3 --- /dev/null +++ b/config/docs/d/sqlserver_query_xevent.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_query_xevent" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_query_xevent" +description: |- + Use this data source to query detailed information of sqlserver query_xevent +--- + +# tencentcloud_sqlserver_query_xevent + +Use this data source to query detailed information of sqlserver query_xevent + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_query_xevent" "example" { + instance_id = "mssql-gyg9xycl" + event_type = "blocked" + start_time = "2023-08-01 00:00:00" + end_time = "2023-08-10 00:00:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) Generation end time of an extended file. +* `event_type` - (Required, String) Event type. Valid values: slow (Slow SQL event), blocked (blocking event), deadlock` (deadlock event). +* `instance_id` - (Required, String) Instance ID. +* `start_time` - (Required, String) Generation start time of an extended file. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `events` - List of extended events. + * `end_time` - Generation end time of an extended file. + * `event_type` - Event type. Valid values: slow (Slow SQL event), blocked (blocking event), deadlock (deadlock event). + * `external_addr` - Download address on the public network. + * `file_name` - File name of an extended event. + * `id` - ID. + * `internal_addr` - Download address on the private network. + * `size` - File size of an extended event. + * `start_time` - Generation start time of an extended file. + * `status` - Event record status. Valid values: 1 (succeeded), 2 (failed). + + diff --git a/config/docs/d/sqlserver_readonly_groups.html.markdown b/config/docs/d/sqlserver_readonly_groups.html.markdown new file mode 100644 index 0000000..26beb24 --- /dev/null +++ b/config/docs/d/sqlserver_readonly_groups.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_readonly_groups" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_readonly_groups" +description: |- + Use this data source to query the list of SQL Server readonly groups. +--- + +# tencentcloud_sqlserver_readonly_groups + +Use this data source to query the list of SQL Server readonly groups. + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_dbs" "example" { + instance_id = "mssql-ds1xhnt9" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `master_instance_id` - (Optional, String) Master SQL Server instance ID. +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of SQL Server readonly group. Each element contains the following attributes: + * `id` - ID of the readonly group. + * `is_offline_delay` - Indicate whether to offline delayed readonly instances. + * `master_instance_id` - Master instance id. + * `max_delay_time` - Maximum delay time of the readonly instances. + * `min_instances` - Minimum readonly instances that stays in the group. + * `name` - Name of the readonly group. + * `readonly_instance_set` - Readonly instance ID set of the readonly group. + * `status` - Status of the readonly group. `1` for running, `5` for applying. + * `vip` - Virtual IP address of the readonly group. + * `vport` - Virtual port of the readonly group. + + diff --git a/config/docs/d/sqlserver_regions.html.markdown b/config/docs/d/sqlserver_regions.html.markdown new file mode 100644 index 0000000..ed9c0c9 --- /dev/null +++ b/config/docs/d/sqlserver_regions.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_regions" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_regions" +description: |- + Use this data source to query detailed information of sqlserver datasource_regions +--- + +# tencentcloud_sqlserver_regions + +Use this data source to query detailed information of sqlserver datasource_regions + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_regions" "example" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `region_set` - Region information array. + * `region_id` - Numeric ID of region. + * `region_name` - Region name. + * `region_state` - Current purchasability of this region. UNAVAILABLE: not purchasable, AVAILABLE: purchasable. + * `region` - Region ID in the format of ap-guangzhou. + + diff --git a/config/docs/d/sqlserver_rollback_time.html.markdown b/config/docs/d/sqlserver_rollback_time.html.markdown new file mode 100644 index 0000000..ecacea7 --- /dev/null +++ b/config/docs/d/sqlserver_rollback_time.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_rollback_time" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_rollback_time" +description: |- + Use this data source to query detailed information of sqlserver rollback_time +--- + +# tencentcloud_sqlserver_rollback_time + +Use this data source to query detailed information of sqlserver rollback_time + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_rollback_time" "example" { + instance_id = "mssql-qelbzgwf" + dbs = ["keep_pubsub_db"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dbs` - (Required, Set: [`String`]) List of databases to be queried. +* `instance_id` - (Required, String) Instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `details` - Information of time range available for database rollback. + * `db_name` - Database name. + * `end_time` - End time of time range available for rollback. + * `start_time` - Start time of time range available for rollback. + + diff --git a/config/docs/d/sqlserver_slowlogs.html.markdown b/config/docs/d/sqlserver_slowlogs.html.markdown new file mode 100644 index 0000000..095bb1e --- /dev/null +++ b/config/docs/d/sqlserver_slowlogs.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_slowlogs" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_slowlogs" +description: |- + Use this data source to query detailed information of sqlserver slowlogs +--- + +# tencentcloud_sqlserver_slowlogs + +Use this data source to query detailed information of sqlserver slowlogs + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_slowlogs" "example" { + instance_id = "mssql-qelbzgwf" + start_time = "2023-08-01 00:00:00" + end_time = "2023-08-07 00:00:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) Query end time. +* `instance_id` - (Required, String) Instance ID. +* `start_time` - (Required, String) Query start time. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `slowlogs` - Information list of slow query logs. + * `count` - Number of logs in file. + * `end_time` - File generation end time. + * `external_addr` - Download address for public network. + * `id` - Unique ID of slow query log file. + * `internal_addr` - Download address for private network. + * `size` - File size in KB. + * `start_time` - File generation start time. + * `status` - Status (1: success, 2: failure) Note: this field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/sqlserver_upload_backup_info.html.markdown b/config/docs/d/sqlserver_upload_backup_info.html.markdown new file mode 100644 index 0000000..b2078fc --- /dev/null +++ b/config/docs/d/sqlserver_upload_backup_info.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_upload_backup_info" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_upload_backup_info" +description: |- + Use this data source to query detailed information of sqlserver upload_backup_info +--- + +# tencentcloud_sqlserver_upload_backup_info + +Use this data source to query detailed information of sqlserver upload_backup_info + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_upload_backup_info" "example" { + instance_id = "mssql-qelbzgwf" + backup_migration_id = "mssql-backup-migration-8a0f3eht" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_migration_id` - (Required, String) Backup import task ID, which is returned through the API CreateBackupMigration. +* `instance_id` - (Required, String) Instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `bucket_name` - Bucket name. +* `expired_time` - Temporary key expiration time. +* `path` - Storage path. +* `region` - Bucket location information. +* `start_time` - Temporary key start time. +* `tmp_secret_id` - Temporary key ID. +* `tmp_secret_key` - Temporary key (Key). +* `x_cos_security_token` - Temporary key (Token). + + diff --git a/config/docs/d/sqlserver_upload_incremental_info.html.markdown b/config/docs/d/sqlserver_upload_incremental_info.html.markdown new file mode 100644 index 0000000..fadf37b --- /dev/null +++ b/config/docs/d/sqlserver_upload_incremental_info.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_upload_incremental_info" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_upload_incremental_info" +description: |- + Use this data source to query detailed information of sqlserver upload_incremental_info +--- + +# tencentcloud_sqlserver_upload_incremental_info + +Use this data source to query detailed information of sqlserver upload_incremental_info + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_upload_incremental_info" "example" { + instance_id = "mssql-4tgeyeeh" + backup_migration_id = "mssql-backup-migration-83t5u3tv" + incremental_migration_id = "mssql-incremental-migration-h36gkdxn" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_migration_id` - (Required, String) Backup import task ID, which is returned through the API CreateBackupMigration. +* `incremental_migration_id` - (Required, String) ID of the incremental import task. +* `instance_id` - (Required, String) Instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `bucket_name` - Bucket name. +* `expired_time` - Temporary key expiration time. +* `path` - Storage path. +* `region` - Bucket location information. +* `start_time` - Temporary key start time. +* `tmp_secret_id` - Temporary key ID. +* `tmp_secret_key` - Temporary key (Key). +* `x_cos_security_token` - Temporary key (Token). + + diff --git a/config/docs/d/sqlserver_zone_config.html.markdown b/config/docs/d/sqlserver_zone_config.html.markdown new file mode 100644 index 0000000..6145a95 --- /dev/null +++ b/config/docs/d/sqlserver_zone_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_zone_config" +sidebar_current: "docs-tencentcloud-datasource-sqlserver_zone_config" +description: |- + Use this data source to query purchasable specification configuration for each availability zone in this specific region. +--- + +# tencentcloud_sqlserver_zone_config + +Use this data source to query purchasable specification configuration for each availability zone in this specific region. + +## Example Usage + +```hcl +data "tencentcloud_sqlserver_zone_config" "example" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to store results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `zone_list` - A list of availability zones. Each element contains the following attributes: + * `availability_zone` - Alphabet ID of availability zone. + * `specinfo_list` - A list of specinfo configurations for the specific availability zone. Each element contains the following attributes: + * `charge_type` - Billing mode under this specification. Valid values are `POSTPAID_BY_HOUR`, `PREPAID` and `ALL`. `ALL` means both POSTPAID_BY_HOUR and PREPAID. + * `cpu` - Number of CPU cores. + * `db_version_name` - Version name corresponding to the `db_version` field. + * `db_version` - Database version information. Valid values: `2008R2 (SQL Server 2008 Enterprise)`, `2012SP3 (SQL Server 2012 Enterprise)`, `2016SP1 (SQL Server 2016 Enterprise)`, `201602 (SQL Server 2016 Standard)`, `2017 (SQL Server 2017 Enterprise)`. + * `machine_type` - Model ID. + * `max_storage_size` - Maximum disk size under this specification in GB. + * `memory` - Memory size in GB. + * `min_storage_size` - Minimum disk size under this specification in GB. + * `qps` - QPS of this specification. + * `spec_id` - Instance specification ID. + * `zone_id` - Number ID of availability zone. + + diff --git a/config/docs/d/ssl_certificates.html.markdown b/config/docs/d/ssl_certificates.html.markdown new file mode 100644 index 0000000..b4dbec5 --- /dev/null +++ b/config/docs/d/ssl_certificates.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_certificates" +sidebar_current: "docs-tencentcloud-datasource-ssl_certificates" +description: |- + Use this data source to query SSL certificate. +--- + +# tencentcloud_ssl_certificates + +Use this data source to query SSL certificate. + +## Example Usage + +```hcl +data "tencentcloud_ssl_certificates" "foo" { + name = "certificate" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the SSL certificate to be queried. +* `name` - (Optional, String) Name of the SSL certificate to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `type` - (Optional, String) Type of the SSL certificate to be queried. Available values includes: `CA` and `SVR`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `certificates` - An information list of certificate. Each element contains the following attributes: + * `begin_time` - Beginning time of the SSL certificate. + * `cert` - Content of the SSL certificate. + * `create_time` - Creation time of the SSL certificate. + * `domain` - Primary domain of the SSL certificate. + * `dv_auths` - DV certification information. + * `dv_auth_key` - DV authentication key. + * `dv_auth_value` - DV authentication value. + * `dv_auth_verify_type` - DV authentication type. + * `end_time` - Ending time of the SSL certificate. + * `id` - ID of the SSL certificate. + * `key` - Key of the SSL certificate. + * `name` - Name of the SSL certificate. + * `order_id` - Order ID returned. + * `product_zh_name` - Certificate authority. + * `project_id` - Project ID of the SSL certificate. + * `status` - Status of the SSL certificate. + * `subject_names` - ALL domains included in the SSL certificate. Including the primary domain name. + * `type` - Type of the SSL certificate. + + diff --git a/config/docs/d/ssl_describe_certificate.html.markdown b/config/docs/d/ssl_describe_certificate.html.markdown new file mode 100644 index 0000000..9eb0215 --- /dev/null +++ b/config/docs/d/ssl_describe_certificate.html.markdown @@ -0,0 +1,118 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_certificate" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_certificate" +description: |- + Use this data source to query detailed information of ssl describe_certificate +--- + +# tencentcloud_ssl_describe_certificate + +Use this data source to query detailed information of ssl describe_certificate + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_certificate" "describe_certificate" { + certificate_id = "8cj4g8h8" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - result list. + * `alias` - Remark name.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `c_a_common_names` - All general names of the CA certificateNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `c_a_encrypt_algorithms` - All encryption methods of CA certificateNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `c_a_end_times` - CA certificate all maturity timeNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_begin_time` - Certificate takes effect time.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_end_time` - The certificate is invalid time.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `certificate_extra` - Certificate extension information.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `domain_number` - Certificate can be configured in the number of domain names.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `origin_certificate_id` - Original certificate ID.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `renew_order` - New order certificate ID.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `replaced_by` - Re -issue the original ID of the certificate.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `replaced_for` - Re -issue a new ID.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `s_m_cert` - Is it a national secret certificateNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `certificate_type` - Certificate type: CA = CA certificate, SVR = server certificate.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `deployable` - Whether it can be deployed.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `domain` - domain name.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_detail` - DV certification information.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_domain` - DV authentication value domain name.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_key_sub_domain` - DV certification sub -domain name.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_key` - DV certification key.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_path` - DV authentication value path.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_value` - DV certification value.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auths` - DV certification information.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_domain` - DV authentication value domain name.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_key` - DV certification key.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_path` - DV authentication value path.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_sub_domain` - DV certification sub -domain name,Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_value` - DV certification value.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_verify_type` - DV certification type.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_revoke_auth_detail` - DV certificate revoking verification valueNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_domain` - DV authentication value domain name.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_key` - DV certification key.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_path` - DV authentication value path.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_sub_domain` - DV certification sub -domain name,Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_value` - DV certification value.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `dv_auth_verify_type` - DV certification type.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `from` - Certificate source: Trustasia,uploadNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `insert_time` - application time.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `is_dv` - Whether it is the DV version.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `is_vip` - Whether it is a VIP customer.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `is_vulnerability` - Whether the vulnerability scanning function is enabled.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `is_wildcard` - Whether it is a pan -domain certificate certificate.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `order_id` - Order ID.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `owner_uin` - Account UIN.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `package_type_name` - Certificate type name.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `package_type` - Types of Certificate Package: 1 = Geotrust DV SSL CA -G3, 2 = Trustasia TLS RSA CA, 3 = SecureSite Enhanced Enterprise Edition (EV Pro), 4 = SecureSite enhanced (EV), 5 = SecureSite Enterprise Professional Edition (OVPro), 6 = SecureSite Enterprise (OV), 7 = SecureSite Enterprise (OV) compatriots, 8 = Geotrust enhanced type (EV), 9 = Geotrust Enterprise (OV), 10 = Geotrust Enterprise (OV) pass,11 = Trustasia Domain Multi -domain SSL certificate, 12 = Trustasia domain model (DV) passing, 13 = Trustasia Enterprise Passing Character (OV) SSL certificate (D3), 14 = Trustasia Enterprise (OV) SSL certificate (D3), 15= Trustasia Enterprise Multi -domain name (OV) SSL certificate (D3), 16 = Trustasia enhanced (EV) SSL certificate (D3), 17 = Trustasia enhanced multi -domain name (EV) SSL certificate (D3), 18 = GlobalSign enterprise type enterprise type(OV) SSL certificate, 19 = GlobalSign Enterprise Type -type STL Certificate, 20 = GlobalSign enhanced (EV) SSL certificate, 21 = Trustasia Enterprise Tongzhi Multi -domain name (OV) SSL certificate (D3), 22 = GlobalSignignMulti -domain name (OV) SSL certificate, 23 = GlobalSign Enterprise Type -type multi -domain name (OV) SSL certificate, 24 = GlobalSign enhanced multi -domain name (EV) SSL certificate.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `product_zh_name` - Certificate issuer name.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `project_id` - Project ID.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `renew_able` - Whether you can issue a certificate.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `status_msg` - status information.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `status_name` - status description.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `status` - = Submitted information, to be uploaded to confirmation letter, 9 = Certificate is revoked, 10 = revoked, 11 = Re -issuance, 12 = Upload and revoke the confirmation letter.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `subject_alt_name` - The certificate contains multiple domain names (containing the main domain name).Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `submitted_data` - Submitted information information.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `admin_email` - Administrator mailbox address.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `admin_first_name` - Administrator name.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `admin_last_name` - The surname of the administrator.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `admin_phone_num` - Administrator phone number.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `admin_position` - Administrator position.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `certificate_domain` - Domain information.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `contact_email` - Contact mailbox address,Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `contact_first_name` - Contact name.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `contact_last_name` - Contact surname.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `contact_number` - Contact phone number.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `contact_position` - Contact position.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `csr_content` - CSR content.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `csr_type` - CSR type, (online = online CSR, PARSE = paste CSR).Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `domain_list` - DNS information.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `key_password` - Private key password.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `organization_address` - address.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `organization_city` - city.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `organization_country` - nation.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `organization_division` - department.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `organization_name` - Enterprise or unit name.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `organization_region` - Province.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `phone_area_code` - Local region code.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `phone_number` - Landline number.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `postal_code` - Postal code.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `verify_type` - Verification type.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `validity_period` - Validity period: unit (month).Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `verify_type` - Verification type: DNS_AUTO = Automatic DNS verification, DNS = manual DNS verification, file = file verification, email = email verification.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `vulnerability_report` - Vulnerability scanning evaluation report.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `vulnerability_status` - Vulnerability scanning status.Note: This field may return NULL, indicating that the valid value cannot be obtained. + + diff --git a/config/docs/d/ssl_describe_companies.html.markdown b/config/docs/d/ssl_describe_companies.html.markdown new file mode 100644 index 0000000..244cfe9 --- /dev/null +++ b/config/docs/d/ssl_describe_companies.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_companies" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_companies" +description: |- + Use this data source to query detailed information of ssl describe_companies +--- + +# tencentcloud_ssl_describe_companies + +Use this data source to query detailed information of ssl describe_companies + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_companies" "describe_companies" { + company_id = 122 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `company_id` - (Optional, Int) Company ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `companies` - Company list. + * `company_address` - Detailed address where the company is located. + * `company_city` - The city where the company is. + * `company_country` - Company country. + * `company_id` - Company ID. + * `company_name` - Company Name. + * `company_phone` - company phone. + * `company_province` - Province where the company is located. + * `id_number` - ID numberNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `id_type` - typeNote: This field may return NULL, indicating that the valid value cannot be obtained. + + diff --git a/config/docs/d/ssl_describe_host_api_gateway_instance_list.html.markdown b/config/docs/d/ssl_describe_host_api_gateway_instance_list.html.markdown new file mode 100644 index 0000000..4fdedc0 --- /dev/null +++ b/config/docs/d/ssl_describe_host_api_gateway_instance_list.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_api_gateway_instance_list" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_api_gateway_instance_list" +description: |- + Use this data source to query detailed information of ssl describe_host_api_gateway_instance_list +--- + +# tencentcloud_ssl_describe_host_api_gateway_instance_list + +Use this data source to query detailed information of ssl describe_host_api_gateway_instance_list + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_api_gateway_instance_list" "describe_host_api_gateway_instance_list" { + certificate_id = "9Bpk7XOu" + resource_type = "apiGateway" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `resource_type` - (Required, String) Deploy resource type. +* `filters` - (Optional, List) List of filtering parameters; Filterkey: domainmatch. +* `is_cache` - (Optional, Int) Whether to query the cache, 1: Yes; 0: No, the default is the query cache, the cache is half an hour. +* `old_certificate_id` - (Optional, String) Deployed certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `filter_key` - (Required, String) Filter parameter key. +* `filter_value` - (Required, String) Filter parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - Apigateway instance listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Certificate IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `domain` - domain name. + * `protocol` - Use Agreement. + * `service_id` - Instance ID. + * `service_name` - Example name. + + diff --git a/config/docs/d/ssl_describe_host_cdn_instance_list.html.markdown b/config/docs/d/ssl_describe_host_cdn_instance_list.html.markdown new file mode 100644 index 0000000..c34af68 --- /dev/null +++ b/config/docs/d/ssl_describe_host_cdn_instance_list.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_cdn_instance_list" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_cdn_instance_list" +description: |- + Use this data source to query detailed information of ssl describe_host_cdn_instance_list +--- + +# tencentcloud_ssl_describe_host_cdn_instance_list + +Use this data source to query detailed information of ssl describe_host_cdn_instance_list + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_cdn_instance_list" "describe_host_cdn_instance_list" { + certificate_id = "8u8DII0l" + resource_type = "cdn" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `resource_type` - (Required, String) Deploy resource type. +* `async_cache` - (Optional, Int) Whether. +* `filters` - (Optional, List) List of filtering parameters; Filterkey: domainmatch. +* `is_cache` - (Optional, Int) Whether to query the cache, 1: Yes; 0: No, the default is the query cache, the cache is half an hour. +* `old_certificate_id` - (Optional, String) Original certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `filter_key` - (Required, String) Filter parameter key. +* `filter_value` - (Required, String) Filter parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `async_cache_time` - Current cache read timeNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `async_offset` - Asynchronous refresh current execution numberNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `async_total_num` - The total number of asynchronous refreshNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `instance_list` - CDN instance listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Deployment certificate ID. + * `domain` - domain name. + * `https_billing_switch` - Domain name billing status. + * `status` - Domain name. + + diff --git a/config/docs/d/ssl_describe_host_clb_instance_list.html.markdown b/config/docs/d/ssl_describe_host_clb_instance_list.html.markdown new file mode 100644 index 0000000..183a013 --- /dev/null +++ b/config/docs/d/ssl_describe_host_clb_instance_list.html.markdown @@ -0,0 +1,70 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_clb_instance_list" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_clb_instance_list" +description: |- + Use this data source to query detailed information of ssl describe_host_clb_instance_list +--- + +# tencentcloud_ssl_describe_host_clb_instance_list + +Use this data source to query detailed information of ssl describe_host_clb_instance_list + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_clb_instance_list" "describe_host_clb_instance_list" { + certificate_id = "8u8DII0l" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `async_cache` - (Optional, Int) Whether to cache asynchronous. +* `filters` - (Optional, List) List of filtering parameters; Filterkey: domainmatch. +* `is_cache` - (Optional, Int) Whether to query the cache, 1: Yes; 0: No, the default is the query cache, the cache is half an hour. +* `old_certificate_id` - (Optional, String) Original certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `filter_key` - (Required, String) Filter parameter key. +* `filter_value` - (Required, String) Filter parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `async_cache_time` - Current cache read timeNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `async_offset` - Asynchronous refresh current execution numberNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `async_total_num` - The total number of asynchronous refreshNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `instance_list` - CLB instance listener listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `listeners` - CLB listener listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `certificate` - Certificate data binding of listenersNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_ca_id` - Root certificate IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Certificate ID. + * `dns_names` - Domain name binding of certificates. + * `s_s_l_mode` - Certificate certification mode: unidirectional unidirectional authentication, Mutual two -way certificationNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `listener_id` - Listener ID. + * `listener_name` - Name of listeners. + * `no_match_domains` - List of non -matching fieldsNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `protocol` - Type of listener protocol, https | TCP_SSL. + * `rules` - List of listeners' rulesNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `certificate` - Certificate data that has been bound to the rulesNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_ca_id` - Root certificate IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Certificate ID. + * `dns_names` - Domain name binding of certificates. + * `s_s_l_mode` - Certificate certification mode: unidirectional unidirectional authentication, Mutual two -way certificationNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `domain` - Domain name binding. + * `is_match` - Whether the rules match the domain name to be bound to the certificate. + * `location_id` - Rule ID. + * `no_match_domains` - List of non -matching fieldsNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `sni_switch` - Whether to turn on SNI, 1 to open, 0 to close. + * `load_balancer_id` - CLB instance ID. + * `load_balancer_name` - CLB instance name name. + + diff --git a/config/docs/d/ssl_describe_host_cos_instance_list.html.markdown b/config/docs/d/ssl_describe_host_cos_instance_list.html.markdown new file mode 100644 index 0000000..bebe91f --- /dev/null +++ b/config/docs/d/ssl_describe_host_cos_instance_list.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_cos_instance_list" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_cos_instance_list" +description: |- + Use this data source to query detailed information of ssl describe_host_cos_instance_list +--- + +# tencentcloud_ssl_describe_host_cos_instance_list + +Use this data source to query detailed information of ssl describe_host_cos_instance_list + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_cos_instance_list" "describe_host_cos_instance_list" { + certificate_id = "8u8DII0l" + resource_type = "cos" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `resource_type` - (Required, String) Deploy resource type cos. +* `filters` - (Optional, List) List of filter parameters. +* `is_cache` - (Optional, Int) Whether to query the cache, 1: Yes; 0: No, the default is the query cache, the cache is half an hour. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `filter_key` - (Required, String) Filter parameter key. +* `filter_value` - (Required, String) Filter parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `async_cache_time` - Current cache read timeNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `async_offset` - Asynchronous refresh current execution numberNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `async_total_num` - The total number of asynchronous refreshNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `instance_list` - COS instance listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `bucket` - Reserve bucket nameNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Binded certificate IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `domain` - domain name. + * `region` - Barrel areaNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `status` - Enabled: domain name online statusDisabled: Domain name offline status. + + diff --git a/config/docs/d/ssl_describe_host_ddos_instance_list.html.markdown b/config/docs/d/ssl_describe_host_ddos_instance_list.html.markdown new file mode 100644 index 0000000..1a17609 --- /dev/null +++ b/config/docs/d/ssl_describe_host_ddos_instance_list.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_ddos_instance_list" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_ddos_instance_list" +description: |- + Use this data source to query detailed information of ssl describe_host_ddos_instance_list +--- + +# tencentcloud_ssl_describe_host_ddos_instance_list + +Use this data source to query detailed information of ssl describe_host_ddos_instance_list + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_ddos_instance_list" "describe_host_ddos_instance_list" { + certificate_id = "8u8DII0l" + resource_type = "ddos" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `resource_type` - (Required, String) Deploy resource type. +* `filters` - (Optional, List) List of filtering parameters; Filterkey: domainmatch. +* `is_cache` - (Optional, Int) Whether to query the cache, 1: Yes; 0: No, the default is the query cache, the cache is half an hour. +* `old_certificate_id` - (Optional, String) Deployed certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `filter_key` - (Required, String) Filter parameter key. +* `filter_value` - (Required, String) Filter parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - DDOS example listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Certificate IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `domain` - domain name. + * `instance_id` - Instance ID. + * `protocol` - agreement type. + * `virtual_port` - Forwarding port. + + diff --git a/config/docs/d/ssl_describe_host_deploy_record.html.markdown b/config/docs/d/ssl_describe_host_deploy_record.html.markdown new file mode 100644 index 0000000..afe8856 --- /dev/null +++ b/config/docs/d/ssl_describe_host_deploy_record.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_deploy_record" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_deploy_record" +description: |- + Use this data source to query detailed information of ssl describe_host_deploy_record +--- + +# tencentcloud_ssl_describe_host_deploy_record + +Use this data source to query detailed information of ssl describe_host_deploy_record + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_deploy_record" "describe_host_deploy_record" { + certificate_id = "8u8DII0l" + resource_type = "ddos" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `resource_type` - (Optional, String) Resource Type. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `deploy_record_list` - Certificate deployment record listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Deployment certificate ID. + * `create_time` - Deployment time. + * `id` - Deployment record ID. + * `region` - Deployment. + * `resource_type` - Deploy resource type. + * `status` - Deployment state. + * `update_time` - Recent update time. + + diff --git a/config/docs/d/ssl_describe_host_deploy_record_detail.html.markdown b/config/docs/d/ssl_describe_host_deploy_record_detail.html.markdown new file mode 100644 index 0000000..61a49c9 --- /dev/null +++ b/config/docs/d/ssl_describe_host_deploy_record_detail.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_deploy_record_detail" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_deploy_record_detail" +description: |- + Use this data source to query detailed information of ssl describe_host_deploy_record_detail +--- + +# tencentcloud_ssl_describe_host_deploy_record_detail + +Use this data source to query detailed information of ssl describe_host_deploy_record_detail + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_deploy_record_detail" "describe_host_deploy_record_detail" { + deploy_record_id = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `deploy_record_id` - (Required, String) Deployment record ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `deploy_record_detail_list` - Certificate deployment record listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `bucket` - COS storage barrel nameNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Deployment certificate ID. + * `create_time` - Deployment record details Create time. + * `domains` - List of deployment domain. + * `env_id` - TCB environment IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `error_msg` - Deployment error messageNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `id` - Deployment record details ID. + * `instance_id` - Deployment instance ID. + * `instance_name` - Deployment example name. + * `listener_id` - Deployment monitor IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `listener_name` - Delicate monitor name. + * `namespace` - Named space nameNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `old_cert_id` - Original binding certificate IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `port` - portNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `protocol` - Deployment monitoring protocolNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `region` - Deployed TCB regionNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `secret_name` - Secret nameNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `sni_switch` - Whether to turn on SNI. + * `status` - Deployment state. + * `tcb_type` - Deployed TCB typeNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `update_time` - Deployment record details last update time. +* `failed_total_count` - Total number of failuresNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `running_total_count` - Total number of deploymentNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `success_total_count` - Total successNote: This field may return NULL, indicating that the valid value cannot be obtained. + + diff --git a/config/docs/d/ssl_describe_host_lighthouse_instance_list.html.markdown b/config/docs/d/ssl_describe_host_lighthouse_instance_list.html.markdown new file mode 100644 index 0000000..50773c6 --- /dev/null +++ b/config/docs/d/ssl_describe_host_lighthouse_instance_list.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_lighthouse_instance_list" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_lighthouse_instance_list" +description: |- + Use this data source to query detailed information of ssl describe_host_lighthouse_instance_list +--- + +# tencentcloud_ssl_describe_host_lighthouse_instance_list + +Use this data source to query detailed information of ssl describe_host_lighthouse_instance_list + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_lighthouse_instance_list" "describe_host_lighthouse_instance_list" { + certificate_id = "8tvMCvGF" + resource_type = "lighthouse" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `resource_type` - (Required, String) Deploy resource type Lighthous. +* `filters` - (Optional, List) List of filter parameters. +* `is_cache` - (Optional, Int) Whether to query the cache, 1: Yes; 0: No, the default is the query cache, the cache is half an hour. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `filter_key` - (Required, String) Filter parameter key. +* `filter_value` - (Required, String) Filter parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - Lighthouse instance listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `domain` - Optional domain name. + * `instance_id` - Instance ID. + * `instance_name` - Example name. + * `ip` - IP address. + + diff --git a/config/docs/d/ssl_describe_host_live_instance_list.html.markdown b/config/docs/d/ssl_describe_host_live_instance_list.html.markdown new file mode 100644 index 0000000..e166085 --- /dev/null +++ b/config/docs/d/ssl_describe_host_live_instance_list.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_live_instance_list" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_live_instance_list" +description: |- + Use this data source to query detailed information of ssl describe_host_live_instance_list +--- + +# tencentcloud_ssl_describe_host_live_instance_list + +Use this data source to query detailed information of ssl describe_host_live_instance_list + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_live_instance_list" "describe_host_live_instance_list" { + certificate_id = "8u8DII0l" + resource_type = "live" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `resource_type` - (Required, String) Deploy resource type. +* `filters` - (Optional, List) List of filtering parameters; Filterkey: domainmatch. +* `is_cache` - (Optional, Int) Whether to query the cache, 1: Yes; 0: No, the default is the query cache, the cache is half an hour. +* `old_certificate_id` - (Optional, String) Deployed certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `filter_key` - (Required, String) Filter parameter key. +* `filter_value` - (Required, String) Filter parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - Live instance listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Binded certificate IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `domain` - domain name. + * `status` - -1: Unrelated certificate of domain name.1: The domain name HTTPS has been opened.0: The domain name HTTPS has been closed. + + diff --git a/config/docs/d/ssl_describe_host_teo_instance_list.html.markdown b/config/docs/d/ssl_describe_host_teo_instance_list.html.markdown new file mode 100644 index 0000000..739cde1 --- /dev/null +++ b/config/docs/d/ssl_describe_host_teo_instance_list.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_teo_instance_list" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_teo_instance_list" +description: |- + Use this data source to query detailed information of ssl describe_host_teo_instance_list +--- + +# tencentcloud_ssl_describe_host_teo_instance_list + +Use this data source to query detailed information of ssl describe_host_teo_instance_list + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_teo_instance_list" "describe_host_teo_instance_list" { + certificate_id = "8u8DII0l" + resource_type = "teo" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `resource_type` - (Required, String) Deploy resource type. +* `filters` - (Optional, List) List of filtering parameters; Filterkey: domainmatch. +* `is_cache` - (Optional, Int) Whether to query the cache, 1: Yes; 0: No, the default is the query cache, the cache is half an hour. +* `old_certificate_id` - (Optional, String) Deployed certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `filter_key` - (Required, String) Filter parameter key. +* `filter_value` - (Required, String) Filter parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - Teo instance listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Certificate ID. + * `host` - domain name. + * `status` - Domain name. + * `zone_id` - Regional IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + + diff --git a/config/docs/d/ssl_describe_host_tke_instance_list.html.markdown b/config/docs/d/ssl_describe_host_tke_instance_list.html.markdown new file mode 100644 index 0000000..0885609 --- /dev/null +++ b/config/docs/d/ssl_describe_host_tke_instance_list.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_tke_instance_list" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_tke_instance_list" +description: |- + Use this data source to query detailed information of ssl describe_host_tke_instance_list +--- + +# tencentcloud_ssl_describe_host_tke_instance_list + +Use this data source to query detailed information of ssl describe_host_tke_instance_list + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_tke_instance_list" "describe_host_tke_instance_list" { + certificate_id = "8u8DII0l" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `async_cache` - (Optional, Int) Whether to cache asynchronous. +* `filters` - (Optional, List) List of filtering parameters; Filterkey: domainmatch. +* `is_cache` - (Optional, Int) Whether to query the cache, 1: Yes; 0: No, the default is the query cache, the cache is half an hour. +* `old_certificate_id` - (Optional, String) Original certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `filter_key` - (Required, String) Filter parameter key. +* `filter_value` - (Required, String) Filter parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `async_cache_time` - Current cache read timeNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `async_offset` - Asynchronous refresh current execution numberNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `async_total_num` - The total number of asynchronous refreshNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `instance_list` - CLB instance listener listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cluster_id` - Cluster ID. + * `cluster_name` - Cluster name. + * `cluster_type` - Cluster. + * `cluster_version` - Cluster. + * `namespace_list` - Cluster Naming Space List. + * `name` - namespace name. + * `secret_list` - Secret list. + * `cert_id` - Certificate ID. + * `ingress_list` - Ingress list. + * `domains` - Ingress domain name list. + * `ingress_name` - Ingress name. + * `tls_domains` - TLS domain name list. + * `name` - Secret name. + * `no_match_domains` - List of domain names that are not matched with the new certificateNote: This field may return NULL, indicating that the valid value cannot be obtained. + + diff --git a/config/docs/d/ssl_describe_host_update_record.html.markdown b/config/docs/d/ssl_describe_host_update_record.html.markdown new file mode 100644 index 0000000..162493b --- /dev/null +++ b/config/docs/d/ssl_describe_host_update_record.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_update_record" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_update_record" +description: |- + Use this data source to query detailed information of ssl describe_host_update_record +--- + +# tencentcloud_ssl_describe_host_update_record + +Use this data source to query detailed information of ssl describe_host_update_record + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_update_record" "describe_host_update_record" { + old_certificate_id = "8u8DII0l" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Optional, String) New certificate ID. +* `old_certificate_id` - (Optional, String) Original certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `deploy_record_list` - Certificate deployment record listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - New certificate ID. + * `create_time` - Deployment time. + * `id` - Record ID. + * `old_cert_id` - Original certificate ID. + * `regions` - List of regional deploymentNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `resource_types` - List of resource types. + * `status` - Deployment state. + * `update_time` - Last update time. + + diff --git a/config/docs/d/ssl_describe_host_update_record_detail.html.markdown b/config/docs/d/ssl_describe_host_update_record_detail.html.markdown new file mode 100644 index 0000000..b210d41 --- /dev/null +++ b/config/docs/d/ssl_describe_host_update_record_detail.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_update_record_detail" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_update_record_detail" +description: |- + Use this data source to query detailed information of ssl describe_host_update_record_detail +--- + +# tencentcloud_ssl_describe_host_update_record_detail + +Use this data source to query detailed information of ssl describe_host_update_record_detail + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_update_record_detail" "describe_host_update_record_detail" { + deploy_record_id = "35364" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `deploy_record_id` - (Required, String) One -click update record ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `failed_total_count` - Total number of failuresNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `record_detail_list` - Certificate deployment record listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `list` - List of deployment resources details. + * `bucket` - BUCKET name (COS dedicated)Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - New certificate ID. + * `create_time` - Deployment time. + * `domains` - List of deployment domainNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `env_id` - Environment IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `error_msg` - Deployment error messageNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `id` - Detailed record ID. + * `instance_id` - Deployment instance IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `instance_name` - Deployment example nameNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `listener_id` - Deploy listener ID (CLB for CLB)Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `listener_name` - Deploy listener name (CLB for CLB)Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `namespace` - Naming Space (TKE)Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `old_cert_id` - Old certificate ID. + * `port` - portNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `protocol` - protocolNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `region` - DeploymentNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `resource_type` - Deploy resource type. + * `secret_name` - Secret Name (TKE for TKE)Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `sni_switch` - Whether to turn on SNI (CLB dedicated)Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `status` - Deployment state. + * `t_c_b_type` - TCB deployment typeNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `update_time` - Last update time. + * `resource_type` - Deploy resource type. + * `total_count` - The total number of deployment resources. +* `running_total_count` - Total number of deploymentNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `success_total_count` - Total successNote: This field may return NULL, indicating that the valid value cannot be obtained. + + diff --git a/config/docs/d/ssl_describe_host_vod_instance_list.html.markdown b/config/docs/d/ssl_describe_host_vod_instance_list.html.markdown new file mode 100644 index 0000000..7fe30bf --- /dev/null +++ b/config/docs/d/ssl_describe_host_vod_instance_list.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_vod_instance_list" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_vod_instance_list" +description: |- + Use this data source to query detailed information of ssl describe_host_vod_instance_list +--- + +# tencentcloud_ssl_describe_host_vod_instance_list + +Use this data source to query detailed information of ssl describe_host_vod_instance_list + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_vod_instance_list" "describe_host_vod_instance_list" { + certificate_id = "8u8DII0l" + resource_type = "vod" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `resource_type` - (Required, String) Deploy resource type VOD. +* `filters` - (Optional, List) List of filter parameters. +* `is_cache` - (Optional, Int) Whether to query the cache, 1: Yes; 0: No, the default is the query cache, the cache is half an hour. +* `old_certificate_id` - (Optional, String) Deployed certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `filter_key` - (Required, String) Filter parameter key. +* `filter_value` - (Required, String) Filter parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - VOD example listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Certificate ID. + * `domain` - domain name. + + diff --git a/config/docs/d/ssl_describe_host_waf_instance_list.html.markdown b/config/docs/d/ssl_describe_host_waf_instance_list.html.markdown new file mode 100644 index 0000000..d125c5a --- /dev/null +++ b/config/docs/d/ssl_describe_host_waf_instance_list.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_host_waf_instance_list" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_host_waf_instance_list" +description: |- + Use this data source to query detailed information of ssl describe_host_waf_instance_list +--- + +# tencentcloud_ssl_describe_host_waf_instance_list + +Use this data source to query detailed information of ssl describe_host_waf_instance_list + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_host_waf_instance_list" "describe_host_waf_instance_list" { + certificate_id = "8u8DII0l" + resource_type = "waf" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String) Certificate ID to be deployed. +* `resource_type` - (Required, String) Deploy resource type. +* `filters` - (Optional, List) List of filtering parameters; Filterkey: domainmatch. +* `is_cache` - (Optional, Int) Whether to query the cache, 1: Yes; 0: No, the default is the query cache, the cache is half an hour. +* `old_certificate_id` - (Optional, String) Deployed certificate ID. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `filter_key` - (Required, String) Filter parameter key. +* `filter_value` - (Required, String) Filter parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - WAF instance listNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `cert_id` - Binded certificate IDNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `domain` - domain name. + * `status` - -1: Unrelated certificate of domain name.1: The domain name HTTPS has been opened.0: The domain name HTTPS has been closed. + + diff --git a/config/docs/d/ssl_describe_manager_detail.html.markdown b/config/docs/d/ssl_describe_manager_detail.html.markdown new file mode 100644 index 0000000..9c17e78 --- /dev/null +++ b/config/docs/d/ssl_describe_manager_detail.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_manager_detail" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_manager_detail" +description: |- + Use this data source to query detailed information of ssl describe_manager_detail +--- + +# tencentcloud_ssl_describe_manager_detail + +Use this data source to query detailed information of ssl describe_manager_detail + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_manager_detail" "describe_manager_detail" { + manager_id = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `manager_id` - (Required, Int) Manager ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `company_id` - Manager Company ID. +* `company_info` - Manager&#39;s company information. + * `company_address` - Detailed address where the company is located. + * `company_city` - The city where the company is. + * `company_country` - Company country. + * `company_id` - Company ID. + * `company_name` - Company Name. + * `company_phone` - company phone. + * `company_province` - Province where the company is located. + * `id_number` - ID numberNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `id_type` - typeNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `contact_first_name` - Contact name. +* `contact_last_name` - Contact name. +* `contact_mail` - Contact mailbox. +* `contact_phone` - contact number. +* `contact_position` - Contact position. +* `create_time` - Creation time. +* `expire_time` - Verify expiration timeNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `manager_department` - Administrator department. +* `manager_first_name` - Manager name. +* `manager_last_name` - Manager name. +* `manager_mail` - Manager mailbox. +* `manager_phone` - Manager phone call. +* `manager_position` - Manager position. +* `status` - Status: Audit: OK during the review: review passed inValid: expired expiRing: is about to expire Expired: expired. +* `verify_time` - Verify timeNote: This field may return NULL, indicating that the valid value cannot be obtained. + + diff --git a/config/docs/d/ssl_describe_managers.html.markdown b/config/docs/d/ssl_describe_managers.html.markdown new file mode 100644 index 0000000..0c02805 --- /dev/null +++ b/config/docs/d/ssl_describe_managers.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_describe_managers" +sidebar_current: "docs-tencentcloud-datasource-ssl_describe_managers" +description: |- + Use this data source to query detailed information of ssl describe_managers +--- + +# tencentcloud_ssl_describe_managers + +Use this data source to query detailed information of ssl describe_managers + +## Example Usage + +```hcl +data "tencentcloud_ssl_describe_managers" "describe_managers" { + company_id = "11772" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `company_id` - (Required, Int) Company ID. +* `manager_mail` - (Optional, String) Vague query manager email (will be abandoned), please use Searchkey. +* `manager_name` - (Optional, String) Manager&#39;s name (will be abandoned), please use Searchkey. +* `result_output_file` - (Optional, String) Used to save results. +* `search_key` - (Optional, String) Manager&#39;s surname/Manager name/mailbox/department precise matching. +* `status` - (Optional, String) Filter according to the status of the manager, and the value is available&#39;None&#39; Unable to submit review&#39;Audit&#39;, Asian Credit Review&#39;Caaudit&#39; CA review&#39;OK&#39; has been reviewed&#39;Invalid&#39; review failed&#39;Expiring&#39; is about to expire&#39;Expired&#39; expired. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `managers` - Company Manager List. + * `cert_count` - Number of administrative certificates. + * `create_time` - Creation timeNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `domain_count` - Number of administrators. + * `expire_time` - Examine the validity expiration timeNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `manager_department` - Administrator department. + * `manager_first_name` - Manager name. + * `manager_id` - Manager ID. + * `manager_last_name` - Manager name. + * `manager_mail` - Manager mailbox. + * `manager_phone` - Manager phone call. + * `manager_position` - Manager position. + * `status` - Status: Audit: OK during the review: review passed inValid: expired expiRing: is about to expire Expired: expired. + * `submit_audit_time` - The last time the review timeNote: This field may return NULL, indicating that the valid value cannot be obtained. + * `verify_time` - Examination timeNote: This field may return NULL, indicating that the valid value cannot be obtained. + + diff --git a/config/docs/d/ssm_products.html.markdown b/config/docs/d/ssm_products.html.markdown new file mode 100644 index 0000000..d8a77d3 --- /dev/null +++ b/config/docs/d/ssm_products.html.markdown @@ -0,0 +1,32 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_products" +sidebar_current: "docs-tencentcloud-datasource-ssm_products" +description: |- + Use this data source to query detailed information of ssm products +--- + +# tencentcloud_ssm_products + +Use this data source to query detailed information of ssm products + +## Example Usage + +```hcl +data "tencentcloud_ssm_products" "products" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `products` - List of supported services. + + diff --git a/config/docs/d/ssm_rotation_detail.html.markdown b/config/docs/d/ssm_rotation_detail.html.markdown new file mode 100644 index 0000000..0eca560 --- /dev/null +++ b/config/docs/d/ssm_rotation_detail.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_rotation_detail" +sidebar_current: "docs-tencentcloud-datasource-ssm_rotation_detail" +description: |- + Use this data source to query detailed information of ssm rotation_detail +--- + +# tencentcloud_ssm_rotation_detail + +Use this data source to query detailed information of ssm rotation_detail + +## Example Usage + +```hcl +data "tencentcloud_ssm_rotation_detail" "example" { + secret_name = "tf_example" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `secret_name` - (Required, String) Secret name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `enable_rotation` - Whether to allow rotation. +* `frequency` - The rotation frequency, in days, defaults to 1 day. +* `latest_rotate_time` - Time of last rotation. +* `next_rotate_begin_time` - The time to start the next rotation. + + diff --git a/config/docs/d/ssm_rotation_history.html.markdown b/config/docs/d/ssm_rotation_history.html.markdown new file mode 100644 index 0000000..aeba022 --- /dev/null +++ b/config/docs/d/ssm_rotation_history.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_rotation_history" +sidebar_current: "docs-tencentcloud-datasource-ssm_rotation_history" +description: |- + Use this data source to query detailed information of ssm rotation_history +--- + +# tencentcloud_ssm_rotation_history + +Use this data source to query detailed information of ssm rotation_history + +## Example Usage + +```hcl +data "tencentcloud_ssm_rotation_history" "example" { + secret_name = "keep_terraform" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `secret_name` - (Required, String) Secret name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `version_ids` - The number of version numbers. The maximum number of version numbers that can be displayed to users is 10. + + diff --git a/config/docs/d/ssm_secret_versions.html.markdown b/config/docs/d/ssm_secret_versions.html.markdown new file mode 100644 index 0000000..10a0138 --- /dev/null +++ b/config/docs/d/ssm_secret_versions.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_secret_versions" +sidebar_current: "docs-tencentcloud-datasource-ssm_secret_versions" +description: |- + Use this data source to query detailed information of SSM secret version +--- + +# tencentcloud_ssm_secret_versions + +Use this data source to query detailed information of SSM secret version + +## Example Usage + +```hcl +data "tencentcloud_ssm_secret_versions" "example" { + secret_name = tencentcloud_ssm_secret_version.v1.secret_name + version_id = tencentcloud_ssm_secret_version.v1.version_id +} + +resource "tencentcloud_ssm_secret" "example" { + secret_name = "tf-example" + description = "desc." + + tags = { + createdBy = "terraform" + } +} + +resource "tencentcloud_ssm_secret_version" "v1" { + secret_name = tencentcloud_ssm_secret.example.secret_name + version_id = "v1" + secret_binary = "MTIzMTIzMTIzMTIzMTIzQQ==" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `secret_name` - (Required, String) Secret name used to filter result. +* `result_output_file` - (Optional, String) Used to save results. +* `version_id` - (Optional, String) VersionId used to filter result. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `secret_version_list` - A list of SSM secret versions. When secret status is `Disabled`, this field will not update anymore. + * `secret_binary` - The base64-encoded binary secret. + * `secret_string` - The string text of secret. + * `version_id` - Version of secret. + + diff --git a/config/docs/d/ssm_secrets.html.markdown b/config/docs/d/ssm_secrets.html.markdown new file mode 100644 index 0000000..7568b7f --- /dev/null +++ b/config/docs/d/ssm_secrets.html.markdown @@ -0,0 +1,82 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_secrets" +sidebar_current: "docs-tencentcloud-datasource-ssm_secrets" +description: |- + Use this data source to query detailed information of SSM secret +--- + +# tencentcloud_ssm_secrets + +Use this data source to query detailed information of SSM secret + +## Example Usage + +```hcl +data "tencentcloud_ssm_secrets" "example" { + secret_name = tencentcloud_ssm_secret.example.secret_name + state = 1 +} + +resource "tencentcloud_ssm_secret" "example" { + secret_name = "tf_example" + description = "desc." + + tags = { + createdBy = "terraform" + } +} +``` + +### OR you can filter by tags + +```hcl +data "tencentcloud_ssm_secrets" "example" { + secret_name = tencentcloud_ssm_secret.example.secret_name + state = 1 + + tags = { + createdBy = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `order_type` - (Optional, Int) The order to sort the create time of secret. `0` - desc, `1` - asc. Default value is `0`. +* `product_name` - (Optional, String) This parameter only takes effect when the SecretType parameter value is 1. When the SecretType value is 1, if the Product Name value is empty, it means to query all types of cloud product credentials. If the Product Name value is MySQL, it means to query MySQL database credentials. If the Product Name value is Tdsql mysql, it means to query Tdsql (MySQL version) credentials. +* `result_output_file` - (Optional, String) Used to save results. +* `secret_name` - (Optional, String) Secret name used to filter result. +* `secret_type` - (Optional, Int) 0- represents user-defined credentials, defaults to 0. 1- represents the user's cloud product credentials. 2- represents SSH key pair credentials. 3- represents cloud API key pair credentials. +* `state` - (Optional, Int) Filter by state of secret. `0` - all secrets are queried, `1` - only Enabled secrets are queried, `2` - only Disabled secrets are queried, `3` - only PendingDelete secrets are queried. +* `tags` - (Optional, Map) Tags to filter secret. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `secret_list` - A list of SSM secrets. + * `associated_instance_ids` - When the credential type is SSH key pair credential, this field is valid and is used to represent the CVM instance ID associated with the SSH key pair. + * `create_time` - Create time of secret. + * `create_uin` - Uin of Creator. + * `delete_time` - Delete time of CMK. + * `description` - Description of secret. + * `kms_key_id` - KMS keyId used to encrypt secret. + * `kms_key_type` - KMS CMK type used to encrypt credentials, DEFAULT represents the default key created by SecretsManager, and CUSTOMER represents the user specified key. + * `next_rotation_time` - Next rotation start time, uinx timestamp. + * `product_name` - Cloud product name, only effective when SecretType is 1, which means the credential type is cloud product credential. + * `project_id` - When the credential type is SSH key pair credential, this field is valid and represents the item ID to which the SSH key pair belongs. + * `resource_id` - The cloud product instance ID number corresponding to the cloud product credentials. + * `resource_name` - When the credential type is SSH key pair credential, this field is valid and is used to represent the name of the SSH key pair credential. + * `rotation_begin_time` - The user specified rotation start time. + * `rotation_frequency` - The frequency of rotation, in days, takes effect when rotation is on. + * `rotation_status` - 1: - Turn on the rotation; 0- No rotation Note: This field may return null, indicating that a valid value cannot be obtained. + * `secret_name` - Name of secret. + * `secret_type` - 0- User defined credentials; 1- Cloud product credentials; 2- SSH key pair credentials; 3- Cloud API key pair credentials. + * `status` - Status of secret. + * `target_uin` - When the credential type is a cloud API key pair credential, this field is valid and is used to represent the user UIN to which the cloud API key pair belongs. + + diff --git a/config/docs/d/ssm_service_status.html.markdown b/config/docs/d/ssm_service_status.html.markdown new file mode 100644 index 0000000..effa7b0 --- /dev/null +++ b/config/docs/d/ssm_service_status.html.markdown @@ -0,0 +1,34 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_service_status" +sidebar_current: "docs-tencentcloud-datasource-ssm_service_status" +description: |- + Use this data source to query detailed information of ssm service_status +--- + +# tencentcloud_ssm_service_status + +Use this data source to query detailed information of ssm service_status + +## Example Usage + +```hcl +data "tencentcloud_ssm_service_status" "example" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `access_key_escrow_enabled` - True means that the user can already use the key safe hosting function, false means that the user cannot use the key safe hosting function temporarily. +* `invalid_type` - Service unavailability type: 0-Not purchased, 1-Normal, 2-Service suspended due to arrears, 3-Resource release. +* `service_enabled` - True means the service has been activated, false means the service has not been activated yet. + + diff --git a/config/docs/d/ssm_ssh_key_pair_value.html.markdown b/config/docs/d/ssm_ssh_key_pair_value.html.markdown new file mode 100644 index 0000000..deb4f4c --- /dev/null +++ b/config/docs/d/ssm_ssh_key_pair_value.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_ssh_key_pair_value" +sidebar_current: "docs-tencentcloud-datasource-ssm_ssh_key_pair_value" +description: |- + Use this data source to query detailed information of ssm ssh_key_pair_value +--- + +# tencentcloud_ssm_ssh_key_pair_value + +Use this data source to query detailed information of ssm ssh_key_pair_value + +~> **NOTE:** Must set at least one of `secret_name` or `ssh_key_id`. + +## Example Usage + +```hcl +data "tencentcloud_ssm_ssh_key_pair_value" "example" { + secret_name = "keep_terraform" + ssh_key_id = "skey-2ae2snwd" +} +``` + +### Or + +```hcl +data "tencentcloud_ssm_ssh_key_pair_value" "example" { + secret_name = "keep_terraform" +} +``` + +### Or + +```hcl +data "tencentcloud_ssm_ssh_key_pair_value" "example" { + ssh_key_id = "skey-2ae2snwd" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `secret_name` - (Optional, String) Secret name. +* `ssh_key_id` - (Optional, String) The key pair ID is the unique identifier of the key pair in the cloud server. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `private_key` - Private key plain text, encoded using base64. +* `project_id` - The project ID to which this key pair belongs. +* `public_key` - Public key plain text, encoded using base64. +* `ssh_key_description` - Description of the SSH key pair. Users can modify the description information of the key pair in the CVM console. +* `ssh_key_name` - SSH key name. + + diff --git a/config/docs/d/sts_caller_identity.html.markdown b/config/docs/d/sts_caller_identity.html.markdown new file mode 100644 index 0000000..cdcafed --- /dev/null +++ b/config/docs/d/sts_caller_identity.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Security Token Service(STS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sts_caller_identity" +sidebar_current: "docs-tencentcloud-datasource-sts_caller_identity" +description: |- + Use this data source to query detailed information of sts callerIdentity +--- + +# tencentcloud_sts_caller_identity + +Use this data source to query detailed information of sts callerIdentity + +## Example Usage + +```hcl +data "tencentcloud_sts_caller_identity" "callerIdentity" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `account_id` - The primary account Uin to which the current caller belongs. +* `arn` - Current caller ARN. +* `principal_id` - Account Uin to which the key belongs:- The caller is a cloud account, and the returned current account Uin- The caller is a role, and the returned account Uin that applies for the role key. +* `type` - Identity type. +* `user_id` - Identity:- When the caller is a cloud account, the current account `Uin` is returned.- When the caller is a role, it returns `roleId:roleSessionName`- When the caller is a federated identity, it returns `uin:federatedUserName`. + + diff --git a/config/docs/d/subnet.html.markdown b/config/docs/d/subnet.html.markdown new file mode 100644 index 0000000..de4e0b4 --- /dev/null +++ b/config/docs/d/subnet.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_subnet" +sidebar_current: "docs-tencentcloud-datasource-subnet" +description: |- + Provides details about a specific VPC subnet. +--- + +# tencentcloud_subnet + +Provides details about a specific VPC subnet. + +This resource can prove useful when a module accepts a subnet id as an input variable and needs to, for example, determine the id of the VPC that the subnet belongs to. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_vpc_subnets. + +## Example Usage + +```hcl +variable "subnet_id" {} +variable "vpc_id" {} + +data "tencentcloud_subnet" "selected" { + vpc_id = var.vpc_id + subnet_id = var.subnet_id +} + +resource "tencentcloud_security_group" "default" { + name = "test subnet data" + description = "test subnet data description" +} + +resource "tencentcloud_security_group_rule" "subnet" { + security_group_id = tencentcloud_security_group.default.id + type = "ingress" + cidr_ip = data.tencentcloud_subnet.selected.cidr_block + ip_protocol = "tcp" + port_range = "80,8080" + policy = "accept" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `subnet_id` - (Required, String) The ID of the Subnet. +* `vpc_id` - (Required, String) The VPC ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `availability_zone` - The AZ for the subnet. +* `cidr_block` - The CIDR block of the Subnet. +* `name` - The name for the Subnet. +* `route_table_id` - The Route Table ID. + + diff --git a/config/docs/d/tat_agent.html.markdown b/config/docs/d/tat_agent.html.markdown new file mode 100644 index 0000000..6de9ed5 --- /dev/null +++ b/config/docs/d/tat_agent.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "TencentCloud Automation Tools(TAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tat_agent" +sidebar_current: "docs-tencentcloud-datasource-tat_agent" +description: |- + Use this data source to query detailed information of tat agent +--- + +# tencentcloud_tat_agent + +Use this data source to query detailed information of tat agent + +## Example Usage + +```hcl +data "tencentcloud_tat_agent" "agent" { + # instance_ids = ["ins-f9jr4bd2"] + filters { + name = "environment" + values = ["Linux"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter conditions. agent-status - String - Required: No - (Filter condition) Filter by agent status. Valid values: Online, Offline. environment - String - Required: No - (Filter condition) Filter by the agent environment. Valid value: Linux. instance-id - String - Required: No - (Filter condition) Filter by the instance ID. Up to 10 Filters allowed in one request. For each filter, five Filter.Values can be specified. InstanceIds and Filters cannot be specified at the same time. +* `instance_ids` - (Optional, Set: [`String`]) List of instance IDs for the query. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Field to be filtered. +* `values` - (Required, Set) Filter values of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `automation_agent_set` - List of agent message. + * `agent_status` - Agent status.Ranges:<li> Online:Online<li> Offline:Offline. + * `environment` - Environment for Agent.Ranges:<li> Linux:Linux instance<li> Windows:Windows instance. + * `instance_id` - InstanceId. + * `last_heartbeat_time` - Time of last heartbeat. + * `support_features` - List of feature Agent support. + * `version` - Agent version. + + diff --git a/config/docs/d/tat_command.html.markdown b/config/docs/d/tat_command.html.markdown new file mode 100644 index 0000000..d0cca6b --- /dev/null +++ b/config/docs/d/tat_command.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "TencentCloud Automation Tools(TAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tat_command" +sidebar_current: "docs-tencentcloud-datasource-tat_command" +description: |- + Use this data source to query detailed information of tat command +--- + +# tencentcloud_tat_command + +Use this data source to query detailed information of tat command + +## Example Usage + +```hcl +data "tencentcloud_tat_command" "command" { + # command_id = "" + # command_name = "" + command_type = "SHELL" + created_by = "TAT" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `command_id` - (Optional, String) Command ID. +* `command_name` - (Optional, String) Command name. +* `command_type` - (Optional, String) Command type, Value is `SHELL` or `POWERSHELL`. +* `created_by` - (Optional, String) Command creator. `TAT` indicates a public command and `USER` indicates a personal command. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `command_set` - List of command details. + * `command_id` - Command ID. + * `command_name` - Command name. + * `command_type` - Command type. + * `content` - command. + * `created_by` - Command creator. `TAT` indicates a public command and `USER` indicates a personal command. + * `created_time` - Command creation time. + * `default_parameters` - Default custom parameter value. + * `description` - Command description. + * `enable_parameter` - Whether to enable the custom parameter feature. + * `formatted_description` - Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands. + * `output_cos_bucket_url` - The COS bucket URL for uploading logs. + * `output_cos_key_prefix` - The COS bucket directory where the logs are saved. + * `tags` - Tags bound to the command. At most 10 tags are allowed. + * `key` - Tag key. + * `value` - Tag value. + * `timeout` - Command timeout period. + * `updated_time` - Command update time. + * `username` - The user who executes the command on the instance. + * `working_directory` - Command execution path. + + diff --git a/config/docs/d/tat_invocation_task.html.markdown b/config/docs/d/tat_invocation_task.html.markdown new file mode 100644 index 0000000..d94d22b --- /dev/null +++ b/config/docs/d/tat_invocation_task.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "TencentCloud Automation Tools(TAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tat_invocation_task" +sidebar_current: "docs-tencentcloud-datasource-tat_invocation_task" +description: |- + Use this data source to query detailed information of tat invocation_task +--- + +# tencentcloud_tat_invocation_task + +Use this data source to query detailed information of tat invocation_task + +## Example Usage + +```hcl +data "tencentcloud_tat_invocation_task" "invocation_task" { + # invocation_task_ids = ["invt-a8bv0ip7"] + filters { + name = "instance-id" + values = ["ins-p4pq4gaq"] + } + hide_output = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter conditions.invocation-id - String - Required: No - (Filter condition) Filter by the execution activity ID.invocation-task-id - String - Required: No - (Filter condition) Filter by the execution task ID.instance-id - String - Required: No - (Filter condition) Filter by the instance ID.command-id - String - Required: No - (Filter condition) Filter by the command ID.Up to 10 Filters are allowed for each request. Each filter can have up to five Filter.Values. InvocationTaskIds and Filters cannot be specified at the same time. +* `hide_output` - (Optional, Bool) Whether to hide the output. Valid values:True (default): Hide the outputFalse: Show the output. +* `invocation_task_ids` - (Optional, Set: [`String`]) List of execution task IDs. Up to 100 IDs are allowed for each request. InvocationTaskIds and Filters cannot be specified at the same time. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) Field to be filtered. +* `values` - (Required, Set) Filter values of the field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `invocation_task_set` - List of execution tasks. + * `command_document` - Command details of the execution task. + * `command_type` - Command type. + * `content` - Base64-encoded command. + * `output_cos_bucket_url` - URL of the COS bucket to store the output. + * `output_cos_key_prefix` - Prefix of the output file name. + * `timeout` - Timeout period. + * `username` - The user who executes the command. + * `working_directory` - Execution path. + * `command_id` - Command ID. + * `created_time` - Creation time. + * `end_time` - End time of the execution task. + * `error_info` - Error message displayed when the execution task fails. + * `instance_id` - Instance ID. + * `invocation_id` - Execution activity ID. + * `invocation_source` - Invocation source. + * `invocation_task_id` - Execution task ID. + * `start_time` - Start time of the execution task. + * `task_result` - Execution result. + * `dropped` - Dropped bytes of the command output. + * `exec_end_time` - Time when the execution is ended. + * `exec_start_time` - Time when the execution is started. + * `exit_code` - ExitCode of the execution. + * `output_upload_cos_error_info` - Error message for uploading logs to COS. + * `output_url` - COS URL of the logs. + * `output` - Base64-encoded command output. The maximum length is 24 KB. + * `task_status` - Execution task status. Valid values:PENDING: PendingDELIVERING: DeliveringDELIVER_DELAYED: Delivery delayedDELIVER_FAILED: Delivery failedSTART_FAILED: Failed to start the commandRUNNING: RunningSUCCESS: SuccessFAILED: Failed to execute the command. The exit code is not 0 after execution.TIMEOUT: Command timed outTASK_TIMEOUT: Task timed outCANCELLING: CancelingCANCELLED: Canceled (canceled before execution)TERMINATED: Terminated (canceled during execution). + * `updated_time` - Update time. + + diff --git a/config/docs/d/tat_invoker.html.markdown b/config/docs/d/tat_invoker.html.markdown new file mode 100644 index 0000000..aad721b --- /dev/null +++ b/config/docs/d/tat_invoker.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TencentCloud Automation Tools(TAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tat_invoker" +sidebar_current: "docs-tencentcloud-datasource-tat_invoker" +description: |- + Use this data source to query detailed information of tat invoker +--- + +# tencentcloud_tat_invoker + +Use this data source to query detailed information of tat invoker + +## Example Usage + +```hcl +data "tencentcloud_tat_invoker" "invoker" { + # invoker_id = "" + # command_id = "" + # type = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `command_id` - (Optional, String) Command ID. +* `invoker_id` - (Optional, String) Invoker ID. +* `result_output_file` - (Optional, String) Used to save results. +* `type` - (Optional, String) Invoker type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `invoker_set` - Invoker information. + * `command_id` - Command ID. + * `created_time` - Creation time. + * `enable` - Whether to enable the invoker. + * `instance_ids` - Instance ID list. + * `invoker_id` - Invoker ID. + * `name` - Invoker name. + * `parameters` - Custom parameters. + * `schedule_settings` - Execution schedule of the invoker. This field is returned for recurring invokers. + * `invoke_time` - The next execution time of the invoker. This field is required if Policy is ONCE. + * `policy` - Execution policy: `ONCE`: Execute once; `RECURRENCE`: Execute repeatedly. + * `recurrence` - Trigger the crontab expression. This field is required if `Policy` is `RECURRENCE`. The crontab expression is parsed in UTC+8. + * `type` - Invoker type. + * `updated_time` - Modification time. + * `username` - Username. + + diff --git a/config/docs/d/tat_invoker_records.html.markdown b/config/docs/d/tat_invoker_records.html.markdown new file mode 100644 index 0000000..1315bba --- /dev/null +++ b/config/docs/d/tat_invoker_records.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "TencentCloud Automation Tools(TAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tat_invoker_records" +sidebar_current: "docs-tencentcloud-datasource-tat_invoker_records" +description: |- + Use this data source to query detailed information of tat invoker_records +--- + +# tencentcloud_tat_invoker_records + +Use this data source to query detailed information of tat invoker_records + +## Example Usage + +```hcl +data "tencentcloud_tat_invoker_records" "invoker_records" { + invoker_ids = ["ivk-cas4upyf"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `invoker_ids` - (Optional, Set: [`String`]) List of invoker IDs. Up to 100 IDs are allowed. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `invoker_record_set` - Execution history of an invoker. + * `invocation_id` - Command execution ID. + * `invoke_time` - Execution time. + * `invoker_id` - Invoker ID. + * `reason` - Execution reason. + * `result` - Trigger result. + + diff --git a/config/docs/d/tcaplus_clusters.html.markdown b/config/docs/d/tcaplus_clusters.html.markdown new file mode 100644 index 0000000..4c4b4ef --- /dev/null +++ b/config/docs/d/tcaplus_clusters.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "TcaplusDB" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcaplus_clusters" +sidebar_current: "docs-tencentcloud-datasource-tcaplus_clusters" +description: |- + Use this data source to query TcaplusDB clusters. +--- + +# tencentcloud_tcaplus_clusters + +Use this data source to query TcaplusDB clusters. + +## Example Usage + +```hcl +data "tencentcloud_tcaplus_clusters" "name" { + cluster_name = "cluster" +} +data "tencentcloud_tcaplus_clusters" "id" { + cluster_id = tencentcloud_tcaplus_cluster.test.id +} +data "tencentcloud_tcaplus_clusters" "idname" { + cluster_id = tencentcloud_tcaplus_cluster.test.id + cluster_name = "cluster" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Optional, String) ID of the TcaplusDB cluster to be query. +* `cluster_name` - (Optional, String) Name of the TcaplusDB cluster to be query. +* `result_output_file` - (Optional, String) File for saving results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of TcaplusDB cluster. Each element contains the following attributes. + * `api_access_id` - Access id of the TcaplusDB cluster.For TcaplusDB SDK connect. + * `api_access_ip` - Access ip of the TcaplusDB cluster.For TcaplusDB SDK connect. + * `api_access_port` - Access port of the TcaplusDB cluster.For TcaplusDB SDK connect. + * `cluster_id` - ID of the TcaplusDB cluster. + * `cluster_name` - Name of the TcaplusDB cluster. + * `create_time` - Create time of the TcaplusDB cluster. + * `idl_type` - IDL type of the TcaplusDB cluster. + * `network_type` - Network type of the TcaplusDB cluster. + * `old_password_expire_time` - Expiration time of the old password. If `password_status` is `unmodifiable`, it means the old password has not yet expired. + * `password_status` - Password status of the TcaplusDB cluster. Valid values: `unmodifiable`, `modifiable`. `unmodifiable` means the password can not be changed in this moment; `modifiable` means the password can be changed in this moment. + * `password` - Access password of the TcaplusDB cluster. + * `subnet_id` - Subnet ID of the TcaplusDB cluster. + * `vpc_id` - VPC ID of the TcaplusDB cluster. + + diff --git a/config/docs/d/tcaplus_idls.html.markdown b/config/docs/d/tcaplus_idls.html.markdown new file mode 100644 index 0000000..0f35b11 --- /dev/null +++ b/config/docs/d/tcaplus_idls.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "TcaplusDB" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcaplus_idls" +sidebar_current: "docs-tencentcloud-datasource-tcaplus_idls" +description: |- + Use this data source to query IDL information of the TcaplusDB table. +--- + +# tencentcloud_tcaplus_idls + +Use this data source to query IDL information of the TcaplusDB table. + +## Example Usage + +```hcl +data "tencentcloud_tcaplus_idls" "id_test" { + cluster_id = "19162256624" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) ID of the TcaplusDB cluster to be query. +* `result_output_file` - (Optional, String) File for saving results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of TcaplusDB table IDL. Each element contains the following attributes. + * `idl_id` - ID of the IDL. + + diff --git a/config/docs/d/tcaplus_tablegroups.html.markdown b/config/docs/d/tcaplus_tablegroups.html.markdown new file mode 100644 index 0000000..b859ab4 --- /dev/null +++ b/config/docs/d/tcaplus_tablegroups.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "TcaplusDB" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcaplus_tablegroups" +sidebar_current: "docs-tencentcloud-datasource-tcaplus_tablegroups" +description: |- + Use this data source to query table groups of the TcaplusDB cluster. +--- + +# tencentcloud_tcaplus_tablegroups + +Use this data source to query table groups of the TcaplusDB cluster. + +## Example Usage + +```hcl +data "tencentcloud_tcaplus_tablegroups" "null" { + cluster_id = "19162256624" +} +data "tencentcloud_tcaplus_tablegroups" "id" { + cluster_id = "19162256624" + tablegroup_id = "19162256624:1" +} +data "tencentcloud_tcaplus_tablegroups" "name" { + cluster_id = "19162256624" + tablegroup_name = "test" +} +data "tencentcloud_tcaplus_tablegroups" "all" { + cluster_id = "19162256624" + tablegroup_id = "19162256624:1" + tablegroup_name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Id of the TcaplusDB cluster to be query. +* `result_output_file` - (Optional, String) File for saving results. +* `tablegroup_id` - (Optional, String) Id of the table group to be query. +* `tablegroup_name` - (Optional, String) Name of the table group to be query. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of table group. Each element contains the following attributes. + * `create_time` - Create time of the table group.. + * `table_count` - Number of tables. + * `tablegroup_id` - Id of the table group. + * `tablegroup_name` - Name of the table group. + * `total_size` - Total storage size (MB). + + diff --git a/config/docs/d/tcaplus_tables.html.markdown b/config/docs/d/tcaplus_tables.html.markdown new file mode 100644 index 0000000..8879a96 --- /dev/null +++ b/config/docs/d/tcaplus_tables.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "TcaplusDB" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcaplus_tables" +sidebar_current: "docs-tencentcloud-datasource-tcaplus_tables" +description: |- + Use this data source to query TcaplusDB tables. +--- + +# tencentcloud_tcaplus_tables + +Use this data source to query TcaplusDB tables. + +## Example Usage + +```hcl +data "tencentcloud_tcaplus_tables" "null" { + cluster_id = "19162256624" +} + +data "tencentcloud_tcaplus_tables" "tablegroup" { + cluster_id = "19162256624" + tablegroup_id = "19162256624:3" +} + +data "tencentcloud_tcaplus_tables" "name" { + cluster_id = "19162256624" + tablegroup_id = "19162256624:3" + table_name = "guagua" +} + +data "tencentcloud_tcaplus_tables" "id" { + cluster_id = "19162256624" + table_id = "tcaplus-faa65eb7" +} +data "tencentcloud_tcaplus_tables" "all" { + cluster_id = "19162256624" + tablegroup_id = "19162256624:3" + table_id = "tcaplus-faa65eb7" + table_name = "guagua" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) ID of the TcaplusDB cluster to be query. +* `result_output_file` - (Optional, String) File for saving results. +* `table_id` - (Optional, String) Table ID to be query. +* `table_name` - (Optional, String) Table name to be query. +* `tablegroup_id` - (Optional, String) ID of the table group to be query. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - A list of TcaplusDB tables. Each element contains the following attributes. + * `create_time` - Create time of the TcaplusDB table. + * `description` - Description of the TcaplusDB table. + * `error` - Error message for creating TcaplusDB table. + * `idl_id` - IDL file id of the TcaplusDB table. + * `reserved_read_cu` - Reserved read capacity units of the TcaplusDB table. + * `reserved_volume` - Reserved storage capacity of the TcaplusDB table (unit:GB). + * `reserved_write_cu` - Reserved write capacity units of the TcaplusDB table. + * `status` - Status of the TcaplusDB table. + * `table_id` - ID of the TcaplusDB table. + * `table_idl_type` - IDL type of the TcaplusDB table. + * `table_name` - Name of the TcaplusDB table. + * `table_size` - Size of the TcaplusDB table. + * `table_type` - Type of the TcaplusDB table. + * `tablegroup_id` - Table group id of the TcaplusDB table. + + diff --git a/config/docs/d/tcm_mesh.html.markdown b/config/docs/d/tcm_mesh.html.markdown new file mode 100644 index 0000000..f6e7382 --- /dev/null +++ b/config/docs/d/tcm_mesh.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "TencentCloud ServiceMesh(TCM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcm_mesh" +sidebar_current: "docs-tencentcloud-datasource-tcm_mesh" +description: |- + Use this data source to query detailed information of tcm mesh +--- + +# tencentcloud_tcm_mesh + +Use this data source to query detailed information of tcm mesh + +## Example Usage + +```hcl +data "tencentcloud_tcm_mesh" "mesh" { + mesh_id = ["mesh-xxxxxx"] + mesh_name = ["KEEP_MASH"] + tags = ["key"] + mesh_cluster = ["cls-xxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `mesh_cluster` - (Optional, Set: [`String`]) Mesh name. +* `mesh_id` - (Optional, Set: [`String`]) Mesh instance Id. +* `mesh_name` - (Optional, Set: [`String`]) Display name. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Set: [`String`]) tag key. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `mesh_list` - The mesh information is queriedNote: This field may return null, indicating that a valid value is not available. + * `config` - Mesh configuration. + * `istio` - Istio configuration. + * `disable_http_retry` - Disable http retry. + * `disable_policy_checks` - Disable policy checks. + * `enable_pilot_http` - Enable HTTP/1.0 support. + * `outbound_traffic_policy` - Outbound traffic policy. + * `smart_dns` - SmartDNS configuration. + * `istio_meta_dns_auto_allocate` - Enable auto allocate address. + * `istio_meta_dns_capture` - Enable dns proxy. + * `display_name` - Mesh name. + * `mesh_id` - Mesh instance Id. + * `tag_list` - A list of associated tags. + * `key` - Tag key. + * `passthrough` - Passthrough to other related product. + * `value` - Tag value. + * `type` - Mesh type. Value range:- `STANDALONE`: Standalone mesh- `HOSTED`: hosted the mesh. + * `version` - Mesh version. + + diff --git a/config/docs/d/tcmq_queue.html.markdown b/config/docs/d/tcmq_queue.html.markdown new file mode 100644 index 0000000..2f00725 --- /dev/null +++ b/config/docs/d/tcmq_queue.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "TDMQ for CMQ" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcmq_queue" +sidebar_current: "docs-tencentcloud-datasource-tcmq_queue" +description: |- + Use this data source to query detailed information of tcmq queue +--- + +# tencentcloud_tcmq_queue + +Use this data source to query detailed information of tcmq queue + +## Example Usage + +```hcl +data "tencentcloud_tcmq_queue" "queue" { + queue_name = "queue_name" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter. Currently, you can filter by tag. The tag name must be prefixed with `tag:`, such as `tag: owner`, `tag: environment`, or `tag: business`. +* `is_tag_filter` - (Optional, Bool) For filtering by tag, this parameter must be set to `true`. +* `limit` - (Optional, Int) The number of queues to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50. +* `offset` - (Optional, Int) Starting position of a queue list to be returned on the current page in case of paginated return. If a value is entered, limit must be specified. If this parameter is left empty, 0 will be used by default. +* `queue_name_list` - (Optional, Set: [`String`]) Filter by CMQ queue name. +* `queue_name` - (Optional, String) Filter by QueueName. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Optional, String) Filter parameter name. +* `values` - (Optional, Set) Value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `queue_list` - Queue list. + * `active_msg_num` - Total number of messages in `Active` status (i.e., unconsumed) in the queue, which is an approximate value. + * `bps` - Bandwidth limit. + * `create_time` - Queue creation time. A Unix timestamp accurate down to the millisecond will be returned. + * `create_uin` - Creator `Uin`. + * `dead_letter_policy` - Dead letter queue policy. + * `dead_letter_queue` - Dead letter queue. + * `max_receive_count` - Maximum number of receipts. + * `max_time_to_live` - Maximum period in seconds before an unconsumed message expires, which is required if `Policy` is 1. Value range: 300-43200. This value should be smaller than `MsgRetentionSeconds` (maximum message retention period). + * `policy` - Dead letter queue policy. + * `dead_letter_source` - Dead letter queue. + * `queue_id` - Message queue ID. + * `queue_name` - Message queue name. + * `delay_msg_num` - Number of delayed messages. + * `inactive_msg_num` - Total number of messages in `Inactive` status (i.e., being consumed) in the queue, which is an approximate value. + * `last_modify_time` - Time when the queue attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned. + * `max_delay_seconds` - Maximum retention period for inflight messages. + * `max_msg_backlog_size` - Maximum size of heaped messages in bytes. + * `max_msg_heap_num` - Maximum number of heaped messages. The value range is 1,000,000-10,000,000 during the beta test and can be 1,000,000-1,000,000,000 after the product is officially released. The default value is 10,000,000 during the beta test and will be 100,000,000 after the product is officially released. + * `max_msg_size` - Maximum message length. Value range: 1024-65536 bytes (i.e., 1-64 KB). Default value: 65536. + * `max_unacked_msg_num` - The maximum number of unacknowledged messages. + * `min_msg_time` - Minimum unconsumed time of message in seconds. + * `msg_retention_seconds` - The max period during which a message is retained before it is automatically acknowledged. Value range: 30-43,200 seconds (30 seconds to 12 hours). Default value: 3600 seconds (1 hour). + * `namespace_name` - Namespace name. + * `polling_wait_seconds` - Long polling wait time for message reception. Value range: 0-30 seconds. Default value: 0. + * `qps` - Limit of the number of messages produced per second. The value for consumed messages is 1.1 times this value. + * `queue_id` - Message queue ID. + * `queue_name` - Message queue name. + * `retention_size_in_mb` - Queue storage space configured for message rewind. Value range: 1,024-10,240 MB (if message rewind is enabled). The value `0` indicates that message rewind is not enabled. + * `rewind_msg_num` - Number of retained messages which have been deleted by the `DelMsg` API but are still within their rewind time range. + * `rewind_seconds` - Rewindable time of messages in the queue. Value range: 0-1,296,000s (if message rewind is enabled). The value `0` indicates that message rewind is not enabled. + * `status` - Cluster status. `0`: creating; `1`: normal; `2`: terminating; `3`: deleted; `4`: isolated; `5`: creation failed; `6`: deletion failed. + * `tags` - Associated tag. + * `tag_key` - Value of the tag key. + * `tag_value` - Value of the tag value. + * `tenant_id` - Tenant ID. + * `trace` - Message trace. true: enabled; false: not enabled. + * `transaction_policy` - Transaction message policy. + * `first_query_interval` - First lookback time. + * `max_query_count` - Maximum number of queries. + * `transaction` - 1: transaction queue; 0: general queue. + * `visibility_timeout` - Message visibility timeout period. Value range: 1-43200 seconds (i.e., 12 hours). Default value: 30. + + diff --git a/config/docs/d/tcmq_subscribe.html.markdown b/config/docs/d/tcmq_subscribe.html.markdown new file mode 100644 index 0000000..7c085c0 --- /dev/null +++ b/config/docs/d/tcmq_subscribe.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "TDMQ for CMQ" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcmq_subscribe" +sidebar_current: "docs-tencentcloud-datasource-tcmq_subscribe" +description: |- + Use this data source to query detailed information of tcmq subscribe +--- + +# tencentcloud_tcmq_subscribe + +Use this data source to query detailed information of tcmq subscribe + +## Example Usage + +```hcl +data "tencentcloud_tcmq_subscribe" "subscribe" { + topic_name = "topic_name" + subscription_name = "subscription_name" ; +} +``` + +## Argument Reference + +The following arguments are supported: + +* `topic_name` - (Required, String) Topic name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter. +* `limit` - (Optional, Int) Number of topics to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50. +* `offset` - (Optional, Int) Starting position of the list of topics to be returned on the current page in case of paginated return. If a value is entered, limit is required. If this parameter is left empty, 0 will be used by default. +* `result_output_file` - (Optional, String) Used to save results. +* `subscription_name` - (Optional, String) Fuzzy search by SubscriptionName. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `subscription_list` - Set of subscription attributes. + * `binding_key` - Filtering policy for subscribing to and receiving messages. + * `create_time` - Subscription creation time. A Unix timestamp accurate down to the millisecond will be returned. + * `endpoint` - Endpoint that receives notifications, which varies by `protocol`: for HTTP, the endpoint must start with `http://`, and the `host` can be a domain or IP; for `queue`, `queueName` should be entered. + * `filter_tags` - Filtering policy selected when a subscription is created:If `filterType` is 1, `filterTag` will be used for filtering. If `filterType` is 2, `bindingKey` will be used for filtering. + * `last_modify_time` - Time when the subscription attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned. + * `msg_count` - Number of messages to be delivered in the subscription. + * `notify_content_format` - Push content format. Valid values: 1. `JSON`; 2. `SIMPLIFIED`, i.e., the raw format. If `Protocol` is `queue`, this value must be `SIMPLIFIED`. If `Protocol` is `http`, both options are acceptable, and the default value is `JSON`. + * `notify_strategy` - CMQ push server retry policy in case an error occurs while pushing a message to `Endpoint`. Valid values: 1. `BACKOFF_RETRY`: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message; 2. `EXPONENTIAL_DECAY_RETRY`: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: `EXPONENTIAL_DECAY_RETRY`. + * `protocol` - Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently. + * `subscription_id` - Subscription ID, which will be used during monitoring data pull. + * `subscription_name` - Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter. + * `topic_owner` - Subscription owner APPID. + + diff --git a/config/docs/d/tcmq_topic.html.markdown b/config/docs/d/tcmq_topic.html.markdown new file mode 100644 index 0000000..d9f9652 --- /dev/null +++ b/config/docs/d/tcmq_topic.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "TDMQ for CMQ" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcmq_topic" +sidebar_current: "docs-tencentcloud-datasource-tcmq_topic" +description: |- + Use this data source to query detailed information of tcmq topic +--- + +# tencentcloud_tcmq_topic + +Use this data source to query detailed information of tcmq topic + +## Example Usage + +```hcl +data "tencentcloud_tcmq_topic" "topic" { + topic_name = "topic_name" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter. Currently, you can filter by tag. The tag name must be prefixed with `tag:`, such as `tag: owner`, `tag: environment`, or `tag: business`. +* `is_tag_filter` - (Optional, Bool) For filtering by tag, this parameter must be set to `true`. +* `limit` - (Optional, Int) Number of topics to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50. +* `offset` - (Optional, Int) Starting position of the list of topics to be returned on the current page in case of paginated return. If a value is entered, limit is required. If this parameter is left empty, 0 will be used by default. +* `result_output_file` - (Optional, String) Used to save results. +* `topic_name_list` - (Optional, Set: [`String`]) Filter by CMQ topic name. +* `topic_name` - (Optional, String) Fuzzy search by TopicName. + +The `filters` object supports the following: + +* `name` - (Optional, String) Filter parameter name. +* `values` - (Optional, Set) Value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `topic_list` - Topic list. + * `broker_type` - Valid values: `0` (Pulsar), `1` (RocketMQ). + * `create_time` - Topic creation time. A Unix timestamp accurate down to the millisecond will be returned. + * `create_uin` - Creator `Uin`. The `resource` field for CAM authentication is composed of this field. + * `filter_type` - Filtering policy selected when a subscription is created: If `filterType` is 1, `FilterTag` will be used for filtering. If `filterType` is 2, `BindingKey` will be used for filtering. + * `last_modify_time` - Time when the topic attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned. + * `max_msg_size` - Maximum message size, which ranges from 1,024 to 1,048,576 bytes (i.e., 1-1,024 KB). The default value is 65,536. + * `msg_count` - Number of current messages in the topic (number of retained messages). + * `msg_retention_seconds` - Maximum lifecycle of message in topic. After the period specified by this parameter has elapsed since a message is sent to the topic, the message will be deleted no matter whether it has been successfully pushed to the user. This parameter is measured in seconds and defaulted to one day (86,400 seconds), which cannot be modified. + * `namespace_name` - Namespace name. + * `qps` - Number of messages published per second. + * `status` - Cluster status. `0`: creating; `1`: normal; `2`: terminating; `3`: deleted; `4`: isolated; `5`: creation failed; `6`: deletion failed. + * `tags` - Associated tag. + * `tag_key` - Value of the tag key. + * `tag_value` - Value of the tag value. + * `tenant_id` - Tenant ID. + * `topic_id` - Topic ID. + * `topic_name` - Topic name. + * `trace` - Message trace. true: enabled; false: not enabled. + + diff --git a/config/docs/d/tcr_image_manifests.html.markdown b/config/docs/d/tcr_image_manifests.html.markdown new file mode 100644 index 0000000..5a4fc53 --- /dev/null +++ b/config/docs/d/tcr_image_manifests.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_image_manifests" +sidebar_current: "docs-tencentcloud-datasource-tcr_image_manifests" +description: |- + Use this data source to query detailed information of tcr image_manifests +--- + +# tencentcloud_tcr_image_manifests + +Use this data source to query detailed information of tcr image_manifests + +## Example Usage + +```hcl +data "tencentcloud_tcr_image_manifests" "image_manifests" { + registry_id = "%s" + namespace_name = "%s" + repository_name = "%s" + image_version = "v1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `image_version` - (Required, String) mirror version. +* `namespace_name` - (Required, String) namespace name. +* `registry_id` - (Required, String) instance ID. +* `repository_name` - (Required, String) mirror warehouse name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `config` - configuration information of the image. +* `manifest` - Manifest information of the image. + + diff --git a/config/docs/d/tcr_images.html.markdown b/config/docs/d/tcr_images.html.markdown new file mode 100644 index 0000000..a61a05f --- /dev/null +++ b/config/docs/d/tcr_images.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_images" +sidebar_current: "docs-tencentcloud-datasource-tcr_images" +description: |- + Use this data source to query detailed information of tcr images +--- + +# tencentcloud_tcr_images + +Use this data source to query detailed information of tcr images + +## Example Usage + +```hcl +data "tencentcloud_tcr_images" "images" { + registry_id = "tcr-xxx" + namespace_name = "ns" + repository_name = "repo" + image_version = "v1" + digest = "sha256:xxxxx" + exact_match = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `namespace_name` - (Required, String) namespace name. +* `registry_id` - (Required, String) instance id. +* `repository_name` - (Required, String) repository name. +* `digest` - (Optional, String) specify image digest for lookup. +* `exact_match` - (Optional, Bool) specifies whether it is an exact match, true is an exact match, and not filled is a fuzzy match. +* `image_version` - (Optional, String) image version name, default is fuzzy match. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `image_info_list` - container image information list. + * `digest` - hash value. + * `image_version` - tag name. + * `kind` - product type,note: this field may return null, indicating that no valid value can be obtained. + * `kms_signature` - kms signature information,note: this field may return null, indicating that no valid value can be obtained. + * `size` - image size (unit: byte). + * `update_time` - update time. + + diff --git a/config/docs/d/tcr_instances.html.markdown b/config/docs/d/tcr_instances.html.markdown new file mode 100644 index 0000000..189d80f --- /dev/null +++ b/config/docs/d/tcr_instances.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_instances" +sidebar_current: "docs-tencentcloud-datasource-tcr_instances" +description: |- + Use this data source to query detailed information of TCR instances. +--- + +# tencentcloud_tcr_instances + +Use this data source to query detailed information of TCR instances. + +## Example Usage + +```hcl +data "tencentcloud_tcr_instances" "name" { + name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Optional, String) ID of the TCR instance to query. +* `name` - (Optional, String) Name of the TCR instance to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - Information list of the dedicated TCR instances. + * `id` - ID of the TCR instance. + * `instance_type` - Instance type. + * `internal_end_point` - Internal address for access of the TCR instance. + * `name` - Name of TCR instance. + * `public_domain` - Public address for access of the TCR instance. + * `status` - Status of the TCR instance. + * `tags` - Tags of the TCR instance. + + diff --git a/config/docs/d/tcr_namespaces.html.markdown b/config/docs/d/tcr_namespaces.html.markdown new file mode 100644 index 0000000..2e367e3 --- /dev/null +++ b/config/docs/d/tcr_namespaces.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_namespaces" +sidebar_current: "docs-tencentcloud-datasource-tcr_namespaces" +description: |- + Use this data source to query detailed information of TCR namespaces. +--- + +# tencentcloud_tcr_namespaces + +Use this data source to query detailed information of TCR namespaces. + +## Example Usage + +```hcl +data "tencentcloud_tcr_namespaces" "name" { + instance_id = "cls-satg5125" + namespace_name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) ID of the instance that the namespace belongs to. +* `namespace_name` - (Optional, String) ID of the TCR namespace to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `namespace_list` - Information list of the dedicated TCR namespaces. + * `id` - ID of TCR namespace. + * `is_public` - Indicate that the namespace is public or not. + * `name` - Name of TCR namespace. + + diff --git a/config/docs/d/tcr_replication_instance_create_tasks.html.markdown b/config/docs/d/tcr_replication_instance_create_tasks.html.markdown new file mode 100644 index 0000000..565b30a --- /dev/null +++ b/config/docs/d/tcr_replication_instance_create_tasks.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_replication_instance_create_tasks" +sidebar_current: "docs-tencentcloud-datasource-tcr_replication_instance_create_tasks" +description: |- + Use this data source to query detailed information of tcr replication_instance_create_tasks +--- + +# tencentcloud_tcr_replication_instance_create_tasks + +Use this data source to query detailed information of tcr replication_instance_create_tasks + +## Example Usage + +```hcl +local { + src_registry_id = local.tcr_id + dst_registry_id = tencentcloud_tcr_manage_replication_operation.my_replica.destination_registry_id + dst_region_id = tencentcloud_tcr_manage_replication_operation.my_replica.destination_region_id +} + +data "tencentcloud_tcr_replication_instance_create_tasks" "create_tasks" { + replication_registry_id = local.dst_registry_id + replication_region_id = local.dst_region_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `replication_region_id` - (Required, Int) synchronization instance region Id, see ReplicationRegionId in DescribeReplicationInstances. +* `replication_registry_id` - (Required, String) synchronization instance Id, see RegistryId in DescribeReplicationInstances. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `status` - overall task status. +* `task_detail` - task details. + * `created_time` - task start name. + * `finished_time` - task end time. Note: This field may return null, indicating that no valid value can be obtained. + * `task_message` - Task status information. Note: This field may return null, indicating that no valid value can be obtained. + * `task_name` - task name. + * `task_status` - task status. + * `task_uuid` - task UUID. + + diff --git a/config/docs/d/tcr_replication_instance_sync_status.html.markdown b/config/docs/d/tcr_replication_instance_sync_status.html.markdown new file mode 100644 index 0000000..bf49527 --- /dev/null +++ b/config/docs/d/tcr_replication_instance_sync_status.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_replication_instance_sync_status" +sidebar_current: "docs-tencentcloud-datasource-tcr_replication_instance_sync_status" +description: |- + Use this data source to query detailed information of tcr replication_instance_sync_status +--- + +# tencentcloud_tcr_replication_instance_sync_status + +Use this data source to query detailed information of tcr replication_instance_sync_status + +## Example Usage + +```hcl +data "tencentcloud_tcr_replication_instance_sync_status" "sync_status" { + registry_id = local.src_registry_id + replication_registry_id = local.dst_registry_id + replication_region_id = local.dst_region_id + show_replication_log = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `registry_id` - (Required, String) master registry id. +* `replication_registry_id` - (Required, String) synchronization instance id. +* `replication_region_id` - (Optional, Int) synchronization instance region id. +* `result_output_file` - (Optional, String) Used to save results. +* `show_replication_log` - (Optional, Bool) whether to display the synchronization log. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `replication_log` - sync log. Note: This field may return null, indicating that no valid value can be obtained. + * `destination` - destination resource. Note: This field may return null, indicating that no valid value can be obtained. + * `end_time` - end time. Note: This field may return null, indicating that no valid value can be obtained. + * `resource_type` - resource type. Note: This field may return null, indicating that no valid value can be obtained. + * `source` - Source image. Note: This field may return null, indicating that no valid value can be obtained. + * `start_time` - start time. Note: This field may return null, indicating that no valid value can be obtained. + * `status` - sync status. Note: This field may return null, indicating that no valid value can be obtained. +* `replication_status` - sync status. +* `replication_time` - sync complete time. + + diff --git a/config/docs/d/tcr_repositories.html.markdown b/config/docs/d/tcr_repositories.html.markdown new file mode 100644 index 0000000..61cd908 --- /dev/null +++ b/config/docs/d/tcr_repositories.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_repositories" +sidebar_current: "docs-tencentcloud-datasource-tcr_repositories" +description: |- + Use this data source to query detailed information of TCR repositories. +--- + +# tencentcloud_tcr_repositories + +Use this data source to query detailed information of TCR repositories. + +## Example Usage + +```hcl +data "tencentcloud_tcr_repositories" "name" { + name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) ID of the TCR instance that the repository belongs to. +* `namespace_name` - (Required, String) Name of the namespace that the repository belongs to. +* `repository_name` - (Optional, String) ID of the TCR repositories to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `repository_list` - Information list of the dedicated TCR repositories. + * `brief_desc` - Brief description of the repository. + * `create_time` - Create time. + * `description` - Description of the repository. + * `is_public` - Indicate that the repository is public or not. + * `name` - Name of repository. + * `namespace_name` - Name of the namespace that the repository belongs to. + * `update_time` - Last update time. + * `url` - URL of the repository. + + diff --git a/config/docs/d/tcr_tag_retention_execution_tasks.html.markdown b/config/docs/d/tcr_tag_retention_execution_tasks.html.markdown new file mode 100644 index 0000000..b28375f --- /dev/null +++ b/config/docs/d/tcr_tag_retention_execution_tasks.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_tag_retention_execution_tasks" +sidebar_current: "docs-tencentcloud-datasource-tcr_tag_retention_execution_tasks" +description: |- + Use this data source to query detailed information of tcr tag_retention_execution_tasks +--- + +# tencentcloud_tcr_tag_retention_execution_tasks + +Use this data source to query detailed information of tcr tag_retention_execution_tasks + +## Example Usage + +```hcl +data "tencentcloud_tcr_tag_retention_execution_tasks" "tasks" { + registry_id = "tcr_ins_id" + retention_id = 1 + execution_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `execution_id` - (Required, Int) execution id. +* `registry_id` - (Required, String) instance id. +* `retention_id` - (Required, Int) retention id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `retention_task_list` - list of version retention tasks. + * `end_time` - task end time. + * `execution_id` - the rule execution id. + * `repository` - repository name. + * `retained` - Total number of retained tags. + * `start_time` - task start time. + * `status` - the execution status of the task: Failed, Succeed, Stopped, InProgress. + * `task_id` - task id. + * `total` - Total number of tags. + + diff --git a/config/docs/d/tcr_tag_retention_executions.html.markdown b/config/docs/d/tcr_tag_retention_executions.html.markdown new file mode 100644 index 0000000..09eca9b --- /dev/null +++ b/config/docs/d/tcr_tag_retention_executions.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_tag_retention_executions" +sidebar_current: "docs-tencentcloud-datasource-tcr_tag_retention_executions" +description: |- + Use this data source to query detailed information of tcr tag_retention_executions +--- + +# tencentcloud_tcr_tag_retention_executions + +Use this data source to query detailed information of tcr tag_retention_executions + +## Example Usage + +```hcl +data "tencentcloud_tcr_tag_retention_executions" "tag_retention_executions" { + registry_id = "tcr_ins_id" + retention_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `registry_id` - (Required, String) instance id. +* `retention_id` - (Required, Int) retention id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `retention_execution_list` - list of version retention execution records. + * `end_time` - execution end time. + * `execution_id` - execution id. + * `retention_id` - retention id. + * `start_time` - execution start time. + * `status` - execution status: Failed, Succeed, Stopped, InProgress. + + diff --git a/config/docs/d/tcr_tokens.html.markdown b/config/docs/d/tcr_tokens.html.markdown new file mode 100644 index 0000000..6709cbb --- /dev/null +++ b/config/docs/d/tcr_tokens.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_tokens" +sidebar_current: "docs-tencentcloud-datasource-tcr_tokens" +description: |- + Use this data source to query detailed information of TCR tokens. +--- + +# tencentcloud_tcr_tokens + +Use this data source to query detailed information of TCR tokens. + +## Example Usage + +```hcl +data "tencentcloud_tcr_tokens" "name" { + instance_id = "cls-satg5125" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) ID of the instance that the token belongs to. +* `result_output_file` - (Optional, String) Used to save results. +* `token_id` - (Optional, String) ID of the TCR token to query. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `token_list` - Information list of the dedicated TCR tokens. + * `create_time` - Create time. + * `description` - Description of the token. + * `enable` - Indicate that the token is enabled or not. + * `token_id` - Id of TCR token. + + diff --git a/config/docs/d/tcr_vpc_attachments.html.markdown b/config/docs/d/tcr_vpc_attachments.html.markdown new file mode 100644 index 0000000..c0d6061 --- /dev/null +++ b/config/docs/d/tcr_vpc_attachments.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_vpc_attachments" +sidebar_current: "docs-tencentcloud-datasource-tcr_vpc_attachments" +description: |- + Use this data source to query detailed information of TCR VPC attachment. +--- + +# tencentcloud_tcr_vpc_attachments + +Use this data source to query detailed information of TCR VPC attachment. + +## Example Usage + +```hcl +data "tencentcloud_tcr_vpc_attachments" "id" { + instance_id = "cls-satg5125" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) ID of the instance to query. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) ID of subnet to query. +* `vpc_id` - (Optional, String) ID of VPC to query. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `vpc_attachment_list` - Information list of the dedicated TCR namespaces. + * `access_ip` - IP address of this VPC access. + * `enable_public_domain_dns` - Whether to enable public domain dns. + * `enable_vpc_domain_dns` - Whether to enable vpc domain dns. + * `status` - Status of this VPC access. + * `subnet_id` - ID of subnet. + * `vpc_id` - ID of VPC. + + diff --git a/config/docs/d/tcr_webhook_trigger_logs.html.markdown b/config/docs/d/tcr_webhook_trigger_logs.html.markdown new file mode 100644 index 0000000..b12a05d --- /dev/null +++ b/config/docs/d/tcr_webhook_trigger_logs.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_webhook_trigger_logs" +sidebar_current: "docs-tencentcloud-datasource-tcr_webhook_trigger_logs" +description: |- + Use this data source to query detailed information of tencentcloud_tcr_webhook_trigger_logs +--- + +# tencentcloud_tcr_webhook_trigger_logs + +Use this data source to query detailed information of tencentcloud_tcr_webhook_trigger_logs + +## Example Usage + +```hcl +data "tencentcloud_tcr_webhook_trigger_logs" "my_logs" { + registry_id = local.tcr_id + namespace = var.tcr_namespace + trigger_id = var.trigger_id + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `namespace` - (Required, String) namespace. +* `registry_id` - (Required, String) instance Id. +* `trigger_id` - (Required, Int) trigger id. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `logs` - log list. + * `creation_time` - creation time. + * `detail` - webhook trigger detail. + * `event_type` - event type. + * `id` - log id. + * `notify_type` - notification type. + * `status` - status. + * `trigger_id` - trigger Id. + * `update_time` - update time. + + diff --git a/config/docs/d/tdcpg_clusters.html.markdown b/config/docs/d/tdcpg_clusters.html.markdown new file mode 100644 index 0000000..7916a28 --- /dev/null +++ b/config/docs/d/tdcpg_clusters.html.markdown @@ -0,0 +1,76 @@ +--- +subcategory: "TDSQL-C for PostgreSQL(TDCPG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdcpg_clusters" +sidebar_current: "docs-tencentcloud-datasource-tdcpg_clusters" +description: |- + Use this data source to query detailed information of tdcpg clusters. +--- + +# tencentcloud_tdcpg_clusters + +Use this data source to query detailed information of tdcpg clusters. + +~> **NOTE:** This data source is still in internal testing. To experience its functions, you need to apply for a whitelist from Tencent Cloud. + +## Example Usage + +```hcl +data "tencentcloud_tdcpg_clusters" "clusters" { + cluster_id = "" + cluster_name = "" + status = "" + pay_mode = "" + project_id = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Optional, String) cluster id. +* `cluster_name` - (Optional, String) cluster name. +* `pay_mode` - (Optional, String) pay mode. +* `project_id` - (Optional, Int) project id, default to 0, means default project. +* `result_output_file` - (Optional, String) Used to save results. +* `status` - (Optional, String) cluster status. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - cluster list. + * `auto_renew_flag` - auto renew flag. + * `cluster_id` - cluster id. + * `cluster_name` - cluster name. + * `create_time` - create time. + * `db_charset` - db charset. + * `db_kernel_version` - db kernel version. + * `db_major_version` - db major version. + * `db_version` - db version. + * `endpoint_set` - endpoint set. + * `cluster_id` - cluster id. + * `endpoint_id` - endpoint id. + * `endpoint_name` - endpoint name. + * `endpoint_type` - endpoint type. + * `private_ip` - private ip. + * `private_port` - private port. + * `subnet_id` - subnet id. + * `vpc_id` - vpc id. + * `wan_domain` - wan domain. + * `wan_ip` - wan ip. + * `wan_port` - wan port. + * `instance_count` - instance count. + * `pay_mode` - pay mode. + * `pay_period_end_time` - pay period expired time. + * `project_id` - project id. + * `region` - region. + * `status_desc` - status description. + * `status` - status. + * `storage_limit` - storage limit, unit is GB. + * `storage_pay_mode` - storage pay mode, optional value is PREPAID or POSTPAID_BY_HOUR. + * `storage_used` - storage used, unit is GB. + * `zone` - zone. + + diff --git a/config/docs/d/tdcpg_instances.html.markdown b/config/docs/d/tdcpg_instances.html.markdown new file mode 100644 index 0000000..ae43676 --- /dev/null +++ b/config/docs/d/tdcpg_instances.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "TDSQL-C for PostgreSQL(TDCPG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdcpg_instances" +sidebar_current: "docs-tencentcloud-datasource-tdcpg_instances" +description: |- + Use this data source to query detailed information of tdcpg instances. +--- + +# tencentcloud_tdcpg_instances + +Use this data source to query detailed information of tdcpg instances. + +~> **NOTE:** This data source is still in internal testing. To experience its functions, you need to apply for a whitelist from Tencent Cloud. + +## Example Usage + +```hcl +data "tencentcloud_tdcpg_instances" "instances" { + cluster_id = "" + instance_id = "" + instance_name = "" + status = "" + instance_type = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) instance id. +* `instance_id` - (Optional, String) instance id. +* `instance_name` - (Optional, String) instance name. +* `instance_type` - (Optional, String) instance type. +* `result_output_file` - (Optional, String) Used to save results. +* `status` - (Optional, String) instance status. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - instance list. + * `cluster_id` - cluster id. + * `cpu` - cpu cores. + * `create_time` - create time. + * `db_kernel_version` - db kernel version. + * `db_major_version` - db major version. + * `db_version` - db version. + * `endpoint_id` - endpoint id. + * `instance_id` - instance id. + * `instance_name` - instance name. + * `instance_type` - instance type. + * `memory` - memory size, unit is GiB. + * `pay_mode` - pay mode. + * `pay_period_end_time` - pay period expired time. + * `region` - region. + * `status_desc` - status description. + * `status` - status. + * `zone` - zone. + + diff --git a/config/docs/d/tdmq_environment_attributes.html.markdown b/config/docs/d/tdmq_environment_attributes.html.markdown new file mode 100644 index 0000000..9781562 --- /dev/null +++ b/config/docs/d/tdmq_environment_attributes.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "TDMQ for Pulsar(tpulsar)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_environment_attributes" +sidebar_current: "docs-tencentcloud-datasource-tdmq_environment_attributes" +description: |- + Use this data source to query detailed information of tdmq environment_attributes +--- + +# tencentcloud_tdmq_environment_attributes + +Use this data source to query detailed information of tdmq environment_attributes + +## Example Usage + +```hcl +data "tencentcloud_tdmq_environment_attributes" "example" { + environment_id = tencentcloud_tdmq_namespace.example.environ_name + cluster_id = tencentcloud_tdmq_instance.example.id +} + +resource "tencentcloud_tdmq_instance" "example" { + cluster_name = "tf_example" + remark = "remark." + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tdmq_namespace" "example" { + environ_name = "tf_example" + msg_ttl = 300 + cluster_id = tencentcloud_tdmq_instance.example.id + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `environment_id` - (Required, String) Environment (namespace) name. +* `cluster_id` - (Optional, String) ID of the Pulsar cluster. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `msg_ttl` - Expiration time of unconsumed messages, unit second, maximum 1296000 (15 days). +* `rate_in_byte` - Consumption rate limit, unit byte/second, 0 unlimited rate. +* `rate_in_size` - Consumption rate limit, unit number/second, 0 is unlimited. +* `remark` - Remark. +* `replicas` - Duplicate number. +* `retention_hours` - Consumed message storage policy, unit hour, 0 will be deleted immediately after consumption. +* `retention_size` - Consumed message storage strategy, unit G, 0 Delete immediately after consumption. + + diff --git a/config/docs/d/tdmq_pro_instance_detail.html.markdown b/config/docs/d/tdmq_pro_instance_detail.html.markdown new file mode 100644 index 0000000..e4db132 --- /dev/null +++ b/config/docs/d/tdmq_pro_instance_detail.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "TDMQ for Pulsar(tpulsar)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_pro_instance_detail" +sidebar_current: "docs-tencentcloud-datasource-tdmq_pro_instance_detail" +description: |- + Use this data source to query detailed information of tdmq pro_instance_detail +--- + +# tencentcloud_tdmq_pro_instance_detail + +Use this data source to query detailed information of tdmq pro_instance_detail + +## Example Usage + +```hcl +data "tencentcloud_tdmq_pro_instance_detail" "pro_instance_detail" { + cluster_id = "pulsar-9n95ax58b9vn" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster Id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cluster_info` - Cluster information. + * `can_edit_route` - Can the route be modifiedNote: This field may return null, indicating that no valid value can be obtained. + * `cluster_id` - Cluster Id. + * `cluster_name` - Cluster name. + * `create_time` - Creation time. + * `max_storage` - Maximum storage capacity, unit: MB. + * `node_distribution` - Node distributionNote: This field may return null, indicating that no valid value can be obtained. + * `node_count` - Number of nodes. + * `zone_id` - Availability zone ID. + * `zone_name` - Availability zone. + * `remark` - Descriptive information. + * `status` - Cluster status, 0: creating, 1: normal, 2: isolated. + * `version` - cluster version. +* `cluster_spec_info` - Cluster specification informationNote: This field may return null, indicating that no valid value can be obtained. + * `max_band_width` - peak bandwidth. Unit: mbps. + * `max_namespaces` - Maximum number of namespaces. + * `max_topics` - Maximum number of topic partitions. + * `max_tps` - peak tps. + * `scalable_tps` - Elastic TPS outside specificationNote: This field may return null, indicating that no valid value can be obtained. + * `spec_name` - Cluster specification name. +* `network_access_point_infos` - Cluster network access point informationNote: This field may return null, indicating that no valid value can be obtained. + * `endpoint` - access address. + * `instance_id` - instance id. + * `route_type` - Access point type: 0: support network access point 1: VPC access point 2: public network access point. + * `subnet_id` - Subnet id, support network and public network access point, this field is emptyNote: This field may return null, indicating that no valid value can be obtained. + * `vpc_id` - The id of the vpc, the supporting network and the access point of the public network, this field is emptyNote: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/tdmq_pro_instances.html.markdown b/config/docs/d/tdmq_pro_instances.html.markdown new file mode 100644 index 0000000..a1284c0 --- /dev/null +++ b/config/docs/d/tdmq_pro_instances.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "TDMQ for Pulsar(tpulsar)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_pro_instances" +sidebar_current: "docs-tencentcloud-datasource-tdmq_pro_instances" +description: |- + Use this data source to query detailed information of tdmq pro_instances +--- + +# tencentcloud_tdmq_pro_instances + +Use this data source to query detailed information of tdmq pro_instances + +## Example Usage + +```hcl +data "tencentcloud_tdmq_pro_instances" "pro_instances_filter" { + filters { + name = "InstanceName" + values = ["keep"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) query condition filter. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Optional, String) The name of the filter parameter. +* `values` - (Optional, Set) value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instances` - Instance information list. + * `auto_renew_flag` - Automatic renewal mark, 0 indicates the default state (the user has not set it, that is, the initial state is manual renewal), 1 indicates automatic renewal, 2 indicates that the automatic renewal is not specified (user setting). + * `config_display` - Instance configuration specification name. + * `expire_time` - Instance expiration time, in milliseconds. + * `instance_id` - Instance ID. + * `instance_name` - Instance name. + * `instance_version` - Instance version. + * `max_band_width` - Peak bandwidth. Unit: mbps. + * `max_storage` - Storage capacity, in GB. + * `max_tps` - Peak TPS. + * `pay_mode` - 0-postpaid, 1-prepaid. + * `remark` - RemarksNote: This field may return null, indicating that no valid value can be obtained. + * `scalable_tps` - Elastic TPS outside specificationNote: This field may return null, indicating that no valid value can be obtained. + * `spec_name` - Instance Configuration ID. + * `status` - Instance status, 0-creating, 1-normal, 2-isolating, 3-destroyed, 4-abnormal, 5-delivery failure, 6-allocation change, 7-allocation failure. + * `subnet_id` - Subnet idNote: This field may return null, indicating that no valid value can be obtained. + * `vpc_id` - Id of the VPCNote: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/tdmq_publisher_summary.html.markdown b/config/docs/d/tdmq_publisher_summary.html.markdown new file mode 100644 index 0000000..35d5f4b --- /dev/null +++ b/config/docs/d/tdmq_publisher_summary.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "TDMQ for Pulsar(tpulsar)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_publisher_summary" +sidebar_current: "docs-tencentcloud-datasource-tdmq_publisher_summary" +description: |- + Use this data source to query detailed information of tdmq publisher_summary +--- + +# tencentcloud_tdmq_publisher_summary + +Use this data source to query detailed information of tdmq publisher_summary + +## Example Usage + +```hcl +data "tencentcloud_tdmq_publisher_summary" "publisher_summary" { + cluster_id = "pulsar-9n95ax58b9vn" + namespace = "keep-ns" + topic = "keep-topic" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `namespace` - (Required, String) namespace name. +* `topic` - (Required, String) subject name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `msg_rate_in` - Production rate (units per second)Note: This field may return null, indicating that no valid value can be obtained. +* `msg_throughput_in` - Production rate (bytes per second)Note: This field may return null, indicating that no valid value can be obtained. +* `publisher_count` - number of producersNote: This field may return null, indicating that no valid value can be obtained. +* `storage_size` - Message store size in bytesNote: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/tdmq_publishers.html.markdown b/config/docs/d/tdmq_publishers.html.markdown new file mode 100644 index 0000000..868c10e --- /dev/null +++ b/config/docs/d/tdmq_publishers.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "TDMQ for Pulsar(tpulsar)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_publishers" +sidebar_current: "docs-tencentcloud-datasource-tdmq_publishers" +description: |- + Use this data source to query detailed information of tdmq publishers +--- + +# tencentcloud_tdmq_publishers + +Use this data source to query detailed information of tdmq publishers + +## Example Usage + +```hcl +data "tencentcloud_tdmq_publishers" "publishers" { + cluster_id = "pulsar-9n95ax58b9vn" + namespace = "keep-ns" + topic = "keep-topic" + filters { + name = "ProducerName" + values = ["test"] + } + sort { + name = "ProducerName" + order = "DESC" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `namespace` - (Required, String) namespace name. +* `topic` - (Required, String) topic name. +* `filters` - (Optional, List) Parameter filter, support ProducerName, Address field. +* `result_output_file` - (Optional, String) Used to save results. +* `sort` - (Optional, List) sorter. + +The `filters` object supports the following: + +* `name` - (Optional, String) The name of the filter parameter. +* `values` - (Optional, Set) value. + +The `sort` object supports the following: + +* `name` - (Required, String) sorter. +* `order` - (Required, String) Ascending ASC, descending DESC. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `publishers` - Producer Information ListNote: This field may return null, indicating that no valid value can be obtained. + * `address` - producer addressNote: This field may return null, indicating that no valid value can be obtained. + * `average_msg_size` - Average message size (bytes)Note: This field may return null, indicating that no valid value can be obtained. + * `client_version` - client versionNote: This field may return null, indicating that no valid value can be obtained. + * `connected_since` - connection timeNote: This field may return null, indicating that no valid value can be obtained. + * `msg_rate_in` - Message production rate (articles/second)Note: This field may return null, indicating that no valid value can be obtained. + * `msg_throughput_in` - Message production throughput rate (bytes/second)Note: This field may return null, indicating that no valid value can be obtained. + * `partition` - The topic partition number of the producer connectionNote: This field may return null, indicating that no valid value can be obtained. + * `producer_id` - producer idNote: This field may return null, indicating that no valid value can be obtained. + * `producer_name` - producer nameNote: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/tdmq_rocketmq_cluster.html.markdown b/config/docs/d/tdmq_rocketmq_cluster.html.markdown new file mode 100644 index 0000000..0d08011 --- /dev/null +++ b/config/docs/d/tdmq_rocketmq_cluster.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_cluster" +sidebar_current: "docs-tencentcloud-datasource-tdmq_rocketmq_cluster" +description: |- + Use this data source to query detailed information of tdmqRocketmq cluster +--- + +# tencentcloud_tdmq_rocketmq_cluster + +Use this data source to query detailed information of tdmqRocketmq cluster + +## Example Usage + +```hcl +data "tencentcloud_tdmq_rocketmq_cluster" "example" { + name_keyword = tencentcloud_tdmq_rocketmq_cluster.example.cluster_name +} + +resource "tencentcloud_tdmq_rocketmq_cluster" "example" { + cluster_name = "tf_example" + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id_list` - (Optional, Set: [`String`]) Filter by cluster ID. +* `id_keyword` - (Optional, String) Search by cluster ID. +* `name_keyword` - (Optional, String) Search by cluster name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cluster_list` - Cluster information. + * `config` - Cluster configuration information. + * `max_group_num` - Maximum number of groups. + * `max_latency_time` - Maximum message delay in millisecond. + * `max_namespace_num` - Maximum number of namespaces. + * `max_retention_time` - Maximum message retention period in milliseconds. + * `max_topic_num` - Maximum number of topics. + * `max_tps_per_namespace` - Maximum TPS per namespace. + * `used_group_num` - Number of used groups. + * `used_namespace_num` - Number of used namespaces. + * `used_topic_num` - Number of used topics. + * `info` - Basic cluster information. + * `cluster_id` - Cluster ID. + * `cluster_name` - Cluster name. + * `create_time` - Creation time in milliseconds. + * `is_vip` - Whether it is an exclusive instance. + * `public_end_point` - Public network access address. + * `region` - Region information. + * `remark` - Cluster description (up to 128 characters). + * `rocketmq_flag` - Rocketmq cluster identification. + * `support_namespace_endpoint` - Whether the namespace access point is supported. + * `vpc_end_point` - VPC access address. + * `vpcs` - Vpc list. + * `subnet_id` - Subnet ID. + * `vpc_id` - Vpc ID. + * `status` - Cluster status. `0`: Creating; `1`: Normal; `2`: Terminating; `3`: Deleted; `4`: Isolated; `5`: Creation failed; `6`: Deletion failed. + + diff --git a/config/docs/d/tdmq_rocketmq_group.html.markdown b/config/docs/d/tdmq_rocketmq_group.html.markdown new file mode 100644 index 0000000..27277e5 --- /dev/null +++ b/config/docs/d/tdmq_rocketmq_group.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_group" +sidebar_current: "docs-tencentcloud-datasource-tdmq_rocketmq_group" +description: |- + Use this data source to query detailed information of tdmqRocketmq group +--- + +# tencentcloud_tdmq_rocketmq_group + +Use this data source to query detailed information of tdmqRocketmq group + +## Example Usage + +```hcl +data "tencentcloud_tdmq_rocketmq_group" "example" { + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + namespace_id = tencentcloud_tdmq_rocketmq_namespace.example.namespace_name + filter_group = tencentcloud_tdmq_rocketmq_group.example.group_name +} + +resource "tencentcloud_tdmq_rocketmq_cluster" "example" { + cluster_name = "tf_example" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_namespace" "example" { + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + namespace_name = "tf_example" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_group" "example" { + group_name = "tf_example" + namespace = tencentcloud_tdmq_rocketmq_namespace.example.namespace_name + read_enable = true + broadcast_enable = true + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `namespace_id` - (Required, String) Namespace. +* `filter_group` - (Optional, String) Consumer group query by consumer group name. Fuzzy query is supported. +* `filter_one_group` - (Optional, String) Subscription group name. After it is specified, the information of only this subscription group will be returned. +* `filter_topic` - (Optional, String) Topic name, which can be used to query all subscription groups under the topic. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `groups` - List of subscription groups. + * `broadcast_enable` - Whether to enable broadcast consumption. + * `client_protocol` - Client protocol. + * `consumer_num` - The number of online consumers. + * `consumer_type` - Consumer type. Enumerated values: ACTIVELY or PASSIVELY. + * `consumption_mode` - `0`: Cluster consumption mode; `1`: Broadcast consumption mode; `-1`: Unknown. + * `create_time` - Creation time in milliseconds. + * `name` - Consumer group name. + * `read_enable` - Whether to enable consumption. + * `remark` - Remarks (up to 128 characters). + * `retry_partition_num` - The number of partitions in a retry topic. + * `total_accumulative` - The total number of heaped messages. + * `tps` - Consumption TPS. + * `update_time` - Modification time in milliseconds. + + diff --git a/config/docs/d/tdmq_rocketmq_messages.html.markdown b/config/docs/d/tdmq_rocketmq_messages.html.markdown new file mode 100644 index 0000000..db500b7 --- /dev/null +++ b/config/docs/d/tdmq_rocketmq_messages.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_messages" +sidebar_current: "docs-tencentcloud-datasource-tdmq_rocketmq_messages" +description: |- + Use this data source to query detailed information of tdmq message +--- + +# tencentcloud_tdmq_rocketmq_messages + +Use this data source to query detailed information of tdmq message + +## Example Usage + +```hcl +data "tencentcloud_tdmq_rocketmq_messages" "message" { + cluster_id = "rocketmq-rkrbm52djmro" + environment_id = "keep_ns" + topic_name = "keep-topic" + msg_id = "A9FE8D0567FE15DB97425FC08EEF0000" + query_dlq_msg = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster id. +* `environment_id` - (Required, String) Environment. +* `msg_id` - (Required, String) Message ID. +* `topic_name` - (Required, String) Topic, groupId is passed when querying dead letters. +* `query_dlq_msg` - (Optional, Bool) The value is true when querying dead letters, only valid for Rocketmq. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `body` - Message body. +* `message_tracks` - Consumer Group ConsumptionNote: This field may return null, indicating that no valid value can be obtained. + * `consume_status` - consumption status. + * `exception_desc` - Exception informationNote: This field may return null, indicating that no valid value can be obtained. + * `group` - consumer group. + * `track_type` - message track type. +* `produce_time` - Production time. +* `producer_addr` - Producer address. +* `properties` - Detailed parameters. +* `show_topic_name` - The topic name displayed on the details pageNote: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/tdmq_rocketmq_namespace.html.markdown b/config/docs/d/tdmq_rocketmq_namespace.html.markdown new file mode 100644 index 0000000..8c829ce --- /dev/null +++ b/config/docs/d/tdmq_rocketmq_namespace.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_namespace" +sidebar_current: "docs-tencentcloud-datasource-tdmq_rocketmq_namespace" +description: |- + Use this data source to query detailed information of tdmqRocketmq namespace +--- + +# tencentcloud_tdmq_rocketmq_namespace + +Use this data source to query detailed information of tdmqRocketmq namespace + +## Example Usage + +```hcl +data "tencentcloud_tdmq_rocketmq_namespace" "example" { + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + name_keyword = tencentcloud_tdmq_rocketmq_namespace.example.namespace_name +} + +resource "tencentcloud_tdmq_rocketmq_cluster" "example" { + cluster_name = "tf_example" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_namespace" "example" { + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + namespace_name = "tf_example" + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `name_keyword` - (Optional, String) Search by name. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `namespaces` - List of namespaces. + * `namespace_id` - Namespace name, which can contain 3-64 letters, digits, hyphens, and underscores. + * `public_endpoint` - Public network access point address. + * `remark` - Remarks (up to 128 characters). + * `retention_time` - Retention time of persisted messages in milliseconds. + * `ttl` - Retention time of unconsumed messages in milliseconds. Value range: 60 seconds-15 days. + * `vpc_endpoint` - VPC access point address. + + diff --git a/config/docs/d/tdmq_rocketmq_role.html.markdown b/config/docs/d/tdmq_rocketmq_role.html.markdown new file mode 100644 index 0000000..0a5e18f --- /dev/null +++ b/config/docs/d/tdmq_rocketmq_role.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_role" +sidebar_current: "docs-tencentcloud-datasource-tdmq_rocketmq_role" +description: |- + Use this data source to query detailed information of tdmqRocketmq role +--- + +# tencentcloud_tdmq_rocketmq_role + +Use this data source to query detailed information of tdmqRocketmq role + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_rocketmq_cluster" "cluster" { + cluster_name = "test_rocketmq_datasource_role" + remark = "test recket mq" +} + +resource "tencentcloud_tdmq_rocketmq_role" "role" { + role_name = "test_rocketmq_role" + remark = "test rocketmq role" + cluster_id = tencentcloud_tdmq_rocketmq_cluster.cluster.cluster_id +} + +data "tencentcloud_tdmq_rocketmq_role" "role" { + role_name = tencentcloud_tdmq_rocketmq_role.role.role_name + cluster_id = tencentcloud_tdmq_rocketmq_cluster.cluster.cluster_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID (required). +* `result_output_file` - (Optional, String) Used to save results. +* `role_name` - (Optional, String) Fuzzy query by role name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `role_sets` - Array of roles. + * `create_time` - Creation time. + * `remark` - Remarks. + * `role_name` - Role name. + * `token` - Value of the role token. + * `update_time` - Update time. + + diff --git a/config/docs/d/tdmq_rocketmq_topic.html.markdown b/config/docs/d/tdmq_rocketmq_topic.html.markdown new file mode 100644 index 0000000..832e157 --- /dev/null +++ b/config/docs/d/tdmq_rocketmq_topic.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_topic" +sidebar_current: "docs-tencentcloud-datasource-tdmq_rocketmq_topic" +description: |- + Use this data source to query detailed information of tdmqRocketmq topic +--- + +# tencentcloud_tdmq_rocketmq_topic + +Use this data source to query detailed information of tdmqRocketmq topic + +## Example Usage + +```hcl +data "tencentcloud_tdmq_rocketmq_topic" "example" { + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + namespace_id = tencentcloud_tdmq_rocketmq_namespace.example.namespace_name + filter_name = tencentcloud_tdmq_rocketmq_topic.example.topic_name +} + +resource "tencentcloud_tdmq_rocketmq_cluster" "example" { + cluster_name = "tf_example" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_namespace" "example" { + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + namespace_name = "tf_example" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_topic" "example" { + topic_name = "tf_example" + namespace_name = tencentcloud_tdmq_rocketmq_namespace.example.namespace_name + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + type = "Normal" + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `namespace_id` - (Required, String) Namespace. +* `filter_name` - (Optional, String) Search by topic name. Fuzzy query is supported. +* `filter_type` - (Optional, Set: [`String`]) Filter by topic type. Valid values: `Normal`, `GlobalOrder`, `PartitionedOrder`, `Transaction`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `topics` - List of topic information. + * `create_time` - Creation time in milliseconds. + * `name` - Topic name. + * `partition_num` - The number of read/write partitions. + * `remark` - Topic name. + * `update_time` - Update time in milliseconds. + + diff --git a/config/docs/d/teo_rule_engine_settings.html.markdown b/config/docs/d/teo_rule_engine_settings.html.markdown new file mode 100644 index 0000000..5d2a309 --- /dev/null +++ b/config/docs/d/teo_rule_engine_settings.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "TencentCloud EdgeOne(TEO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_teo_rule_engine_settings" +sidebar_current: "docs-tencentcloud-datasource-teo_rule_engine_settings" +description: |- + Use this data source to query detailed information of teo ruleEngineSettings +--- + +# tencentcloud_teo_rule_engine_settings + +Use this data source to query detailed information of teo ruleEngineSettings + +## Example Usage + +```hcl +data "tencentcloud_teo_rule_engine_settings" "ruleEngineSettings" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `actions` - Detail info of actions which can be used in rule engine. + * `action` - Action name. + * `properties` - Action properties. + * `choice_properties` - Associative properties of this property, they are all required. Note: This field may return null, indicating that no valid value can be obtained. + * `choices_value` - The choices which can bse used. This list may be empty. + * `extra_parameter` - Special parameter. Note: This field may return null, indicating that no valid value can be obtained. + * `choices` - A list of choices which can be used when `Type` is `CHOICE`. + * `id` - Parameter name. Valid values:- `Action`: this extra parameter is required when modify HTTP header, this action should be a `RewriteAction`.- `StatusCode`: this extra parameter is required when modify HTTP status code, this action should be a `CodeAction`.- `NULL`: this action should be a `NormalAction`. + * `type` - Parameter value type. Valid values:- `CHOICE`: select one value from `Choices`.- `CUSTOM_NUM`: integer value.- `CUSTOM_STRING`: string value. + * `is_allow_empty` - Whether this property is allowed to set empty. + * `is_multiple` - Whether this property is allowed to set multiple values. + * `max` - Max integer value can bse used when property type is `CUSTOM_NUM`. When `Min` and `Max` both are 0, this field is meaningless. + * `min` - Min integer value can bse used when property type is `CUSTOM_NUM`. When `Min` and `Max` both are 0, this field is meaningless. + * `name` - Property name. + * `type` - Property value type. Valid values:- `CHOICE`: enum type, must select one of the value in `ChoicesValue`.- `TOGGLE`: switch type, must select one of the value in `ChoicesValue`.- `CUSTOM_NUM`: integer type.- `CUSTOM_STRING`: string type. + * `choices_value` - The choices which can be used. This list may be empty. + * `extra_parameter` - Special parameter. Note: This field may return null, indicating that no valid value can be obtained. + * `choices` - A list of choices which can be used when `Type` is `CHOICE`. + * `id` - Parameter name. Valid values:- `Action`: this extra parameter is required when modify HTTP header, this action should be a `RewriteAction`.- `StatusCode`: this extra parameter is required when modify HTTP status code, this action should be a `CodeAction`.- `NULL`: this action should be a `NormalAction`. + * `type` - Parameter value type. Valid values:- `CHOICE`: select one value from `Choices`.- `CUSTOM_NUM`: integer value.- `CUSTOM_STRING`: string value. + * `is_allow_empty` - Whether this property is allowed to set empty. + * `is_multiple` - Whether this property is allowed to set multiple values. + * `max` - Max integer value can bse used when property type is `CUSTOM_NUM`. When `Min` and `Max` both are 0, this field is meaningless. + * `min` - Min integer value can bse used when property type is `CUSTOM_NUM`. When `Min` and `Max` both are 0, this field is meaningless. + * `name` - Property name. + * `type` - Property value type. Valid values:- `CHOICE`: enum type, must select one of the value in `ChoicesValue`.- `TOGGLE`: switch type, must select one of the value in `ChoicesValue`.- `OBJECT`: object type, the `ChoiceProperties` list all properties of the object.- `CUSTOM_NUM`: integer type.- `CUSTOM_STRING`: string type. + + diff --git a/config/docs/d/teo_zone_available_plans.html.markdown b/config/docs/d/teo_zone_available_plans.html.markdown new file mode 100644 index 0000000..9e75e1a --- /dev/null +++ b/config/docs/d/teo_zone_available_plans.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TencentCloud EdgeOne(TEO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_teo_zone_available_plans" +sidebar_current: "docs-tencentcloud-datasource-teo_zone_available_plans" +description: |- + Use this data source to query detailed information of teo zoneAvailablePlans +--- + +# tencentcloud_teo_zone_available_plans + +Use this data source to query detailed information of teo zoneAvailablePlans + +## Example Usage + +```hcl +data "tencentcloud_teo_zone_available_plans" "zoneAvailablePlans" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `plan_info_list` - Zone plans which current account can use. + * `area` - Acceleration area of the plan. Valid value: `mainland`, `overseas`. + * `currency` - Settlement Currency Type. Valid values: `CNY`, `USD`. + * `flux` - The number of fluxes included in the zone plan. Unit: Byte. + * `frequency` - Billing cycle. Valid values:- `y`: Billed by the year.- `m`: Billed by the month.- `h`: Billed by the hour.- `M`: Billed by the minute.- `s`: Billed by the second. + * `plan_type` - Plan type. + * `price` - Price of the plan. Unit: cent. + * `request` - The number of requests included in the zone plan. + * `site_number` - The number of zones this zone plan can bind. + + diff --git a/config/docs/d/tse_access_address.html.markdown b/config/docs/d/tse_access_address.html.markdown new file mode 100644 index 0000000..f5d3b00 --- /dev/null +++ b/config/docs/d/tse_access_address.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_access_address" +sidebar_current: "docs-tencentcloud-datasource-tse_access_address" +description: |- + Use this data source to query detailed information of tse access_address +--- + +# tencentcloud_tse_access_address + +Use this data source to query detailed information of tse access_address + +## Example Usage + +```hcl +data "tencentcloud_tse_access_address" "access_address" { + instance_id = "ins-7eb7eea7" + # vpc_id = "vpc-xxxxxx" + # subnet_id = "subnet-xxxxxx" + # workload = "pushgateway" + engine_region = "ap-guangzhou" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) engine instance Id. +* `engine_region` - (Optional, String) Deploy region. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) Subnet ID, Zookeeper does not need to pass vpcid and subnetid; nacos and Polaris need to pass vpcid and subnetid. +* `vpc_id` - (Optional, String) VPC ID, Zookeeper does not need to pass vpcid and subnetid; nacos and Polaris need to pass vpcid and subnetid. +* `workload` - (Optional, String) Name of other engine components(pushgateway, polaris-limiter). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `console_internet_address` - Console public network access addressNote: This field may return null, indicating that a valid value is not available. +* `console_internet_band_width` - Console public network bandwidthNote: This field may return null, indicating that a valid value is not available. +* `console_intranet_address` - Console Intranet access addressNote: This field may return null, indicating that a valid value is not available. +* `env_address_infos` - Apollo Multi-environment public ip address. + * `config_internet_service_ip` - config public network ip. + * `config_intranet_address` - config Intranet access addressNote: This field may return null, indicating that a valid value is not available. + * `enable_config_internet` - Whether to enable the config public network. + * `enable_config_intranet` - Whether to enable the config Intranet clbNote: This field may return null, indicating that a valid value is not available. + * `env_name` - env name. + * `internet_band_width` - Client public network bandwidthNote: This field may return null, indicating that a valid value is not available. +* `internet_address` - Public access address. +* `internet_band_width` - Client public network bandwidthNote: This field may return null, indicating that a valid value is not available. +* `intranet_address` - Intranet access address. +* `limiter_address_infos` - Access IP address of the Polaris traffic limiting server nodeNote: This field may return null, indicating that a valid value is not available. + * `intranet_address` - VPC access IP address listNote: This field may return null, indicating that a valid value is not available. + + diff --git a/config/docs/d/tse_gateway_canary_rules.html.markdown b/config/docs/d/tse_gateway_canary_rules.html.markdown new file mode 100644 index 0000000..09f4016 --- /dev/null +++ b/config/docs/d/tse_gateway_canary_rules.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_gateway_canary_rules" +sidebar_current: "docs-tencentcloud-datasource-tse_gateway_canary_rules" +description: |- + Use this data source to query detailed information of tse gateway_canary_rules +--- + +# tencentcloud_tse_gateway_canary_rules + +Use this data source to query detailed information of tse gateway_canary_rules + +## Example Usage + +```hcl +data "tencentcloud_tse_gateway_canary_rules" "gateway_canary_rules" { + gateway_id = "gateway-xxxxxx" + service_id = "451a9920-e67a-4519-af41-fccac0e72005" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) gateway ID. +* `service_id` - (Required, String) service ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - canary rule configuration. + * `canary_rule_list` - canary rule list. + * `balanced_service_list` - service weight configuration. + * `percent` - percent, 10 is 10%, valid values: 0 to 100. + * `service_id` - service ID. + * `service_name` - service name. + * `upstream_name` - upstream name. + * `condition_list` - parameter matching condition list. + * `delimiter` - delimiter. valid when operator is in or not in, reference value:`,`, `;`,`\n`. + * `global_config_id` - global configuration ID. + * `global_config_name` - global configuration name. + * `key` - parameter name. + * `operator` - operator.Reference value:`le`, `eq`, `lt`, `ne`, `ge`, `gt`, `regex`, `exists`, `in`, `not in`, `prefix`, `exact`, `regex`. + * `type` - type.Reference value:- path- method- query- header- cookie- body- system. + * `value` - parameter value. + * `enabled` - the status of canary rule. + * `priority` - priority. The value ranges from 0 to 100; the larger the value, the higher the priority; the priority cannot be repeated between different rules. + * `service_id` - service ID. + * `service_name` - service name. + * `total_count` - total count. + + diff --git a/config/docs/d/tse_gateway_certificates.html.markdown b/config/docs/d/tse_gateway_certificates.html.markdown new file mode 100644 index 0000000..facf769 --- /dev/null +++ b/config/docs/d/tse_gateway_certificates.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_gateway_certificates" +sidebar_current: "docs-tencentcloud-datasource-tse_gateway_certificates" +description: |- + Use this data source to query detailed information of tse gateway_certificates +--- + +# tencentcloud_tse_gateway_certificates + +Use this data source to query detailed information of tse gateway_certificates + +## Example Usage + +```hcl +data "tencentcloud_tse_gateway_certificates" "gateway_certificates" { + gateway_id = "gateway-ddbb709b" + filters { + key = "BindDomain" + value = "example.com" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) Gateway ID. +* `filters` - (Optional, List) Filter conditions, valid value: `BindDomain`, `Name`. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `key` - (Optional, String) Filter name. +* `value` - (Optional, String) Filter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Result. + * `certificates_list` - Certificate list of gateway. Note: This field may return null, indicating that a valid value is not available. + * `bind_domains` - Domains of the binding. Note: This field may return null, indicating that a valid value is not available. + * `cert_id` - Certificate ID of ssl platform. Note: This field may return null, indicating that a valid value is not available. + * `cert_source` - Source of certificate. Reference value:- native. Source: konga- ssl. Source: ssl platform. Note: This field may return null, indicating that a valid value is not available. + * `create_time` - Upload time of certificate. Note: This field may return null, indicating that a valid value is not available. + * `crt` - Pem format of certificate. Note: This field may return null, indicating that a valid value is not available. + * `expire_time` - Expiration time of certificate. Note: This field may return null, indicating that a valid value is not available. + * `id` - Certificate ID. Note: This field may return null, indicating that a valid value is not available. + * `issue_time` - Issuance time of certificateNote: This field may return null, indicating that a valid value is not available. + * `key` - Private key of certificate. Note: This field may return null, indicating that a valid value is not available. + * `name` - Certificate name. Note: This field may return null, indicating that a valid value is not available. + * `status` - Status of certificate. Reference value:- expired- active. Note: This field may return null, indicating that a valid value is not available. + * `total` - Total count. Note: This field may return null, indicating that a valid value is not available. + + diff --git a/config/docs/d/tse_gateway_nodes.html.markdown b/config/docs/d/tse_gateway_nodes.html.markdown new file mode 100644 index 0000000..2cb1e19 --- /dev/null +++ b/config/docs/d/tse_gateway_nodes.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_gateway_nodes" +sidebar_current: "docs-tencentcloud-datasource-tse_gateway_nodes" +description: |- + Use this data source to query detailed information of tse gateway_nodes +--- + +# tencentcloud_tse_gateway_nodes + +Use this data source to query detailed information of tse gateway_nodes + +## Example Usage + +```hcl +data "tencentcloud_tse_gateway_nodes" "gateway_nodes" { + gateway_id = "gateway-ddbb709b" + group_id = "group-013c0d8e" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) gateway ID. +* `group_id` - (Optional, String) gateway group ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `node_list` - nodes information. + * `group_id` - Group IDNote: This field may return null, indicating that a valid value is not available. + * `group_name` - Group nameNote: This field may return null, indicating that a valid value is not available. + * `node_id` - gateway node id. + * `node_ip` - gateway node ip. + * `status` - statusNote: This field may return null, indicating that a valid value is not available. + * `zone_id` - Zone idNote: This field may return null, indicating that a valid value is not available. + * `zone` - ZoneNote: This field may return null, indicating that a valid value is not available. + + diff --git a/config/docs/d/tse_gateway_routes.html.markdown b/config/docs/d/tse_gateway_routes.html.markdown new file mode 100644 index 0000000..c545f9d --- /dev/null +++ b/config/docs/d/tse_gateway_routes.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_gateway_routes" +sidebar_current: "docs-tencentcloud-datasource-tse_gateway_routes" +description: |- + Use this data source to query detailed information of tse gateway_routes +--- + +# tencentcloud_tse_gateway_routes + +Use this data source to query detailed information of tse gateway_routes + +## Example Usage + +```hcl +data "tencentcloud_tse_gateway_routes" "gateway_routes" { + gateway_id = "gateway-ddbb709b" + service_name = "test" + route_name = "keep-routes" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) gateway ID. +* `result_output_file` - (Optional, String) Used to save results. +* `route_name` - (Optional, String) route name. +* `service_name` - (Optional, String) service name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - result. + * `route_list` - route list. + * `created_time` - created time. + * `destination_ports` - destination port for Layer 4 matching. + * `force_https` - whether to enable forced HTTPS, no longer use. + * `headers` - the headers of route. + * `key` - key of header. + * `value` - value of header. + * `hosts` - host list. + * `https_redirect_status_code` - https redirection status code. + * `id` - service ID. + * `methods` - method list. + * `name` - service name. + * `paths` - path list. + * `preserve_host` - whether to keep the host when forwarding to the backend. + * `protocols` - protocol list. + * `service_id` - service ID. + * `service_name` - service name. + * `strip_path` - whether to strip path when forwarding to the backend. + * `total_count` - total count. + + diff --git a/config/docs/d/tse_gateway_services.html.markdown b/config/docs/d/tse_gateway_services.html.markdown new file mode 100644 index 0000000..4b85d40 --- /dev/null +++ b/config/docs/d/tse_gateway_services.html.markdown @@ -0,0 +1,79 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_gateway_services" +sidebar_current: "docs-tencentcloud-datasource-tse_gateway_services" +description: |- + Use this data source to query detailed information of tse gateway_services +--- + +# tencentcloud_tse_gateway_services + +Use this data source to query detailed information of tse gateway_services + +## Example Usage + +```hcl +data "tencentcloud_tse_gateway_services" "gateway_services" { + gateway_id = "gateway-ddbb709b" + filters { + key = "name" + value = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) gateway ID. +* `filters` - (Optional, List) filter conditions, valid value:name,upstreamType. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `key` - (Optional, String) filter name. +* `value` - (Optional, String) filter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - result. + * `service_list` - service list. + * `created_time` - created time. + * `editable` - editable status. + * `id` - service ID. + * `name` - service name. + * `tags` - tag list. + * `upstream_info` - upstream information. + * `algorithm` - load balance algorithm,default:round-robin,least-connections and consisten_hashing also support. + * `auto_scaling_cvm_port` - auto scaling group port of cvm. + * `auto_scaling_group_id` - auto scaling group ID of cvm. + * `auto_scaling_hook_status` - hook status in auto scaling group of cvm. + * `auto_scaling_tat_cmd_status` - tat cmd status in auto scaling group of cvm. + * `host` - an IP address or domain name. + * `namespace` - namespace. + * `port` - port. + * `real_source_type` - exact source service type. + * `scf_lambda_name` - scf lambda name. + * `scf_lambda_qualifier` - scf lambda version. + * `scf_namespace` - scf lambda namespace. + * `scf_type` - scf lambda type. + * `service_name` - the name of the service in registry or kubernetes. + * `slow_start` - slow start time, unit:second,when it's enabled, weight of the node is increased from 1 to the target value gradually. + * `source_id` - service source ID. + * `source_name` - the name of source service. + * `source_type` - source service type. + * `targets` - provided when service type is IPList. + * `created_time` - created time. + * `health` - health. + * `host` - Host. + * `port` - port. + * `source` - source of target. + * `weight` - weight. + * `upstream_type` - service type. + * `total_count` - total count. + + diff --git a/config/docs/d/tse_gateways.html.markdown b/config/docs/d/tse_gateways.html.markdown new file mode 100644 index 0000000..9fab419 --- /dev/null +++ b/config/docs/d/tse_gateways.html.markdown @@ -0,0 +1,78 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_gateways" +sidebar_current: "docs-tencentcloud-datasource-tse_gateways" +description: |- + Use this data source to query detailed information of tse gateways +--- + +# tencentcloud_tse_gateways + +Use this data source to query detailed information of tse gateways + +## Example Usage + +```hcl +data "tencentcloud_tse_gateways" "gateways" { + filters { + name = "GatewayId" + values = ["gateway-ddbb709b"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) filter conditions, valid value:Type,Name,GatewayId,Tag,TradeType,InternetPaymode,Region. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) filter name. +* `values` - (Required, Set) filter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - gateways information. + * `gateway_list` - gateway list. + * `auto_renew_flag` - auto renew flag, `0`: default status, `1`: auto renew, `2`: auto not renew. + * `create_time` - create time. + * `cur_deadline` - expire date, for prepaid type.Note: This field may return null, indicating that a valid value is not available. + * `description` - description of gateway. + * `enable_cls` - whether to enable CLS log. + * `enable_internet` - whether to open the public network of client.Note: This field may return null, indicating that a valid value is not available. + * `engine_region` - engine region of gateway. + * `feature_version` - product version. `TRIAL`, `STANDARD`(default value), `PROFESSIONAL`. + * `gateway_id` - gateway ID. + * `gateway_minor_version` - minor version of gateway. + * `gateway_version` - gateway version. Reference value: `2.4.1`, `2.5.1`. + * `ingress_class_name` - ingress class name. + * `instance_port` - the port information that the instance monitors. + * `http_port` - http port. + * `https_port` - https port. + * `internet_max_bandwidth_out` - public network outbound traffic bandwidth. + * `internet_pay_mode` - trade type of internet. `BANDWIDTH`, `TRAFFIC`. + * `isolate_time` - isolation time, used when the gateway is isolated. + * `load_balancer_type` - load balance type of public internet. + * `name` - gateway name. + * `node_config` - original node config. + * `number` - node number, 2-50. + * `specification` - specification, 1c2g|2c4g|4c8g|8c16g. + * `public_ip_addresses` - addresses of public internet. + * `status` - status of gateway. May return values: `Creating`, `CreateFailed`, `Running`, `Modifying`, `UpdatingSpec`, `UpdateFailed`, `Deleting`, `DeleteFailed`, `Isolating`. + * `tags` - tags information of gatewayNote: This field may return null, indicating that a valid value is not available. + * `tag_key` - tag key. + * `tag_value` - tag value. + * `trade_type` - trade type. `0`: postpaid, `1`: Prepaid. + * `type` - gateway type. + * `vpc_config` - vpc information. + * `subnet_id` - subnet ID. Assign an IP address to the engine in the VPC subnet. + * `vpc_id` - subnet ID. Assign an IP address to the engine in the VPC subnet. + * `total_count` - total count. + + diff --git a/config/docs/d/tse_groups.html.markdown b/config/docs/d/tse_groups.html.markdown new file mode 100644 index 0000000..14a8b18 --- /dev/null +++ b/config/docs/d/tse_groups.html.markdown @@ -0,0 +1,90 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_groups" +sidebar_current: "docs-tencentcloud-datasource-tse_groups" +description: |- + Use this data source to query detailed information of tse groups +--- + +# tencentcloud_tse_groups + +Use this data source to query detailed information of tse groups + +## Example Usage + +```hcl +data "tencentcloud_tse_groups" "groups" { + gateway_id = "gateway-ddbb709b" + filters { + name = "GroupId" + values = ["group-013c0d8e"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) gateway ID. +* `filters` - (Optional, List) filter conditions, valid value:Name,GroupId. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) filter name. +* `values` - (Required, Set) filter values. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - groups information. + * `gateway_group_list` - group list of gateway. + * `binding_strategy` - associated strategy informationNote: This field may return null, indicating that a valid value is not available. + * `config` - auto scaling configurationNote: This field may return null, indicating that a valid value is not available. + * `auto_scaler_id` - auto scaler IDNote: This field may return null, indicating that a valid value is not available. + * `create_time` - create timeNote: This field may return null, indicating that a valid value is not available. + * `enabled` - whether to enable metric auto scalingNote: This field may return null, indicating that a valid value is not available. + * `max_replicas` - maximum number of replicasNote: This field may return null, indicating that a valid value is not available. + * `metrics` - metric listNote: This field may return null, indicating that a valid value is not available. + * `resource_name` - metric resource nameNote: This field may return null, indicating that a valid value is not available. + * `target_type` - metric target typeNote: This field may return null, indicating that a valid value is not available. + * `target_value` - metric target valueNote: This field may return null, indicating that a valid value is not available. + * `type` - metric typeNote: This field may return null, indicating that a valid value is not available. + * `modify_time` - modify timeNote: This field may return null, indicating that a valid value is not available. + * `strategy_id` - strategy IDNote: This field may return null, indicating that a valid value is not available. + * `create_time` - create timeNote: This field may return null, indicating that a valid value is not available. + * `cron_config` - timing scaling configurationNote: This field may return null, indicating that a valid value is not available. + * `create_time` - create time. + * `enabled` - whether to enable timing auto scaling. + * `modify_time` - modify time. + * `params` - params of timing auto scaling. + * `crontab` - cron expression. + * `period` - period of timing auto scaling. + * `start_at` - start time. + * `target_replicas` - target replicas. + * `strategy_id` - strategy ID. + * `description` - description of strategyNote: This field may return null, indicating that a valid value is not available. + * `gateway_id` - gateway IDNote: This field may return null, indicating that a valid value is not available. + * `max_replicas` - maximum number of replicas. + * `modify_time` - modify timeNote: This field may return null, indicating that a valid value is not available. + * `strategy_id` - strategy ID. + * `strategy_name` - strategy nameNote: This field may return null, indicating that a valid value is not available. + * `create_time` - group create time. + * `description` - group description. + * `gateway_id` - gateway ID. + * `group_id` - group Id. + * `internet_max_bandwidth_out` - public network outbound traffic bandwidth. + * `is_first_group` - whether it is the default group- 0: false.- 1: yes. + * `modify_time` - modify time. + * `name` - group name. + * `node_config` - group node configration. + * `number` - group node number, 2-50. + * `specification` - group specification, 1c2g|2c4g|4c8g|8c16g. + * `status` - group status. + * `subnet_ids` - subnet IDs. + * `total_count` - total count. + + diff --git a/config/docs/d/tse_nacos_replicas.html.markdown b/config/docs/d/tse_nacos_replicas.html.markdown new file mode 100644 index 0000000..48abbf4 --- /dev/null +++ b/config/docs/d/tse_nacos_replicas.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_nacos_replicas" +sidebar_current: "docs-tencentcloud-datasource-tse_nacos_replicas" +description: |- + Use this data source to query detailed information of tse nacos_replicas +--- + +# tencentcloud_tse_nacos_replicas + +Use this data source to query detailed information of tse nacos_replicas + +## Example Usage + +```hcl +data "tencentcloud_tse_nacos_replicas" "nacos_replicas" { + instance_id = "ins-8078da86" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) engine instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `replicas` - Engine instance replica information. + * `name` - name. + * `role` - role. + * `status` - status. + * `subnet_id` - Subnet IDNote: This field may return null, indicating that a valid value is not available. + * `vpc_id` - VPC IDNote: This field may return null, indicating that a valid value is not available. + * `zone_id` - Available area IDNote: This field may return null, indicating that a valid value is not available. + * `zone` - Available area NameNote: This field may return null, indicating that a valid value is not available. + + diff --git a/config/docs/d/tse_nacos_server_interfaces.html.markdown b/config/docs/d/tse_nacos_server_interfaces.html.markdown new file mode 100644 index 0000000..4dab52c --- /dev/null +++ b/config/docs/d/tse_nacos_server_interfaces.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_nacos_server_interfaces" +sidebar_current: "docs-tencentcloud-datasource-tse_nacos_server_interfaces" +description: |- + Use this data source to query detailed information of tse nacos_server_interfaces +--- + +# tencentcloud_tse_nacos_server_interfaces + +Use this data source to query detailed information of tse nacos_server_interfaces + +## Example Usage + +```hcl +data "tencentcloud_tse_nacos_server_interfaces" "nacos_server_interfaces" { + instance_id = "ins-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Optional, String) engine instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `content` - interface list. + * `interface` - interface nameNote: This field may return null, indicating that a valid value is not available. + + diff --git a/config/docs/d/tse_zookeeper_replicas.html.markdown b/config/docs/d/tse_zookeeper_replicas.html.markdown new file mode 100644 index 0000000..e7216e6 --- /dev/null +++ b/config/docs/d/tse_zookeeper_replicas.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_zookeeper_replicas" +sidebar_current: "docs-tencentcloud-datasource-tse_zookeeper_replicas" +description: |- + Use this data source to query detailed information of tse zookeeper_replicas +--- + +# tencentcloud_tse_zookeeper_replicas + +Use this data source to query detailed information of tse zookeeper_replicas + +## Example Usage + +```hcl +data "tencentcloud_tse_zookeeper_replicas" "zookeeper_replicas" { + instance_id = "ins-7eb7eea7" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) engine instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `replicas` - Engine instance replica information. + * `alias_name` - aliasNote: This field may return null, indicating that a valid value is not available. + * `name` - name. + * `role` - role. + * `status` - status. + * `subnet_id` - Subnet IDNote: This field may return null, indicating that a valid value is not available. + * `vpc_id` - VPC IDNote: This field may return null, indicating that a valid value is not available. + * `zone_id` - Available area IDNote: This field may return null, indicating that a valid value is not available. + * `zone` - Available area IDNote: This field may return null, indicating that a valid value is not available. + + diff --git a/config/docs/d/tse_zookeeper_server_interfaces.html.markdown b/config/docs/d/tse_zookeeper_server_interfaces.html.markdown new file mode 100644 index 0000000..4005bc9 --- /dev/null +++ b/config/docs/d/tse_zookeeper_server_interfaces.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_zookeeper_server_interfaces" +sidebar_current: "docs-tencentcloud-datasource-tse_zookeeper_server_interfaces" +description: |- + Use this data source to query detailed information of tse zookeeper_server_interfaces +--- + +# tencentcloud_tse_zookeeper_server_interfaces + +Use this data source to query detailed information of tse zookeeper_server_interfaces + +## Example Usage + +```hcl +data "tencentcloud_tse_zookeeper_server_interfaces" "zookeeper_server_interfaces" { + instance_id = "ins-7eb7eea7" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) engine instance ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `content` - interface list. + * `interface` - interface nameNote: This field may return null, indicating that a valid value is not available. + + diff --git a/config/docs/d/tsf_api_detail.html.markdown b/config/docs/d/tsf_api_detail.html.markdown new file mode 100644 index 0000000..d47abad --- /dev/null +++ b/config/docs/d/tsf_api_detail.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_api_detail" +sidebar_current: "docs-tencentcloud-datasource-tsf_api_detail" +description: |- + Use this data source to query detailed information of tsf api_detail +--- + +# tencentcloud_tsf_api_detail + +Use this data source to query detailed information of tsf api_detail + +## Example Usage + +```hcl +data "tencentcloud_tsf_api_detail" "api_detail" { + microservice_id = "ms-yq3jo6jd" + path = "/printRequest" + method = "GET" + pkg_version = "20210625192923" + application_id = "application-a24x29xv" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Required, String) application id. +* `method` - (Required, String) request method. +* `microservice_id` - (Required, String) microservice id. +* `path` - (Required, String) api path. +* `pkg_version` - (Required, String) pkg version. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - api detail. + * `can_run` - can debug or not. + * `definitions` - api data struct. + * `name` - object name. + * `properties` - object property list. + * `description` - property description. + * `name` - property name. + * `type` - property type. + * `description` - API description. Note: This field may return null, indicating that no valid value can be obtained. + * `request_content_type` - api content type. + * `request` - api request description. + * `default_value` - default value. + * `description` - param description. + * `in` - param position. + * `name` - param name. + * `required` - require or not. + * `type` - type. + * `response` - api response. + * `description` - param description. + * `name` - param description. + * `type` - param type. + * `status` - API status 0: offline 1: online, default 0. Note: This section may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/tsf_api_group.html.markdown b/config/docs/d/tsf_api_group.html.markdown new file mode 100644 index 0000000..13129b2 --- /dev/null +++ b/config/docs/d/tsf_api_group.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_api_group" +sidebar_current: "docs-tencentcloud-datasource-tsf_api_group" +description: |- + Use this data source to query detailed information of tsf api_group +--- + +# tencentcloud_tsf_api_group + +Use this data source to query detailed information of tsf api_group + +## Example Usage + +```hcl +data "tencentcloud_tsf_api_group" "api_group" { + search_word = "xxx01" + group_type = "ms" + auth_type = "none" + status = "released" + order_by = "created_time" + order_type = 0 + gateway_instance_id = "gw-ins-lvdypq5k" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auth_type` - (Optional, String) Authentication type. secret: Secret key authentication; none: No authentication. +* `gateway_instance_id` - (Optional, String) Gateway Instance Id. +* `group_type` - (Optional, String) Group type. ms: Microservice group; external: External API group. +* `order_by` - (Optional, String) Sorting field: created_time or group_context. +* `order_type` - (Optional, Int) Sorting type: 0 (ASC) or 1 (DESC). +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) search word. +* `status` - (Optional, String) Publishing status. drafted: Not published. released: Published. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Pagination structure.Note: This field may return null, indicating that no valid values can be obtained. + * `content` - Api group info. + * `acl_mode` - Number of APIs.Note: This field may return null, indicating that no valid values can be obtained. + * `api_count` - api count. + * `auth_type` - Authentication type. secret: key authentication; none: no authentication.Note: This field may return null, indicating that no valid values can be obtained. + * `binded_gateway_deploy_groups` - The gateway group bind with the api group list. + * `application_id` - Application ID.Note: This field may return null, indicating that no valid values can be obtained. + * `application_name` - Application Name.Note: This field may return null, indicating that no valid values can be obtained. + * `application_type` - Application Name.Note: This field may return null, indicating that no valid values can be obtained. + * `cluster_type` - Cluster type, C: container, V: virtual machine.Note: This field may return null, indicating that no valid values can be obtained. + * `deploy_group_id` - Gateway deployment group bound to the API group.Note: This field may return null, indicating that no valid values can be obtained. + * `deploy_group_name` - Deploy group name.Note: This field may return null, indicating that no valid values can be obtained. + * `group_status` - Application category: V: virtual machine application, C: container application. Note: This field may return null, indicating that no valid values can be obtained. + * `created_time` - Group creation time.Note: This field may return null, indicating that no valid values can be obtained. + * `description` - Description.Note: This field may return null, indicating that no valid values can be obtained. + * `gateway_instance_id` - Gateway Instance Id.Note: This field may return null, indicating that no valid values can be obtained. + * `gateway_instance_type` - Gateway Instance Type.Note: This field may return null, indicating that no valid values can be obtained. + * `group_context` - Api Group Context.Note: This field may return null, indicating that no valid values can be obtained. + * `group_id` - Api Group Id.Note: This field may return null, indicating that no valid values can be obtained. + * `group_name` - Api Group Name.Note: This field may return null, indicating that no valid values can be obtained. + * `group_type` - Group type.Note: This field may return null, indicating that no valid values can be obtained. + * `namespace_name_key_position` - Namespace parameter location, path, header, or query, default is path. Note: This field may return null, indicating that no valid values can be obtained. + * `namespace_name_key` - Namespace name key.Note: This field may return null, indicating that no valid values can be obtained. + * `service_name_key_position` - Microservice name parameter location, path, header, or query, default is path.Note: This field may return null, indicating that no valid values can be obtained. + * `service_name_key` - Key value of microservice name parameter.Note: This field may return null, indicating that no valid values can be obtained. + * `status` - Release status. drafted: not released. released: released.Note: This field may return null, indicating that no valid values can be obtained. + * `updated_time` - Group creation time, such as: 2019-06-20 15:51:28.Note: This field may return null, indicating that no valid values can be obtained. + * `total_count` - record count. + + diff --git a/config/docs/d/tsf_application.html.markdown b/config/docs/d/tsf_application.html.markdown new file mode 100644 index 0000000..5cb7a81 --- /dev/null +++ b/config/docs/d/tsf_application.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application" +sidebar_current: "docs-tencentcloud-datasource-tsf_application" +description: |- + Use this data source to query detailed information of tsf application +--- + +# tencentcloud_tsf_application + +Use this data source to query detailed information of tsf application + +## Example Usage + +```hcl +data "tencentcloud_tsf_application" "application" { + application_type = "V" + microservice_type = "N" + # application_resource_type_list = [""] + application_id_list = ["application-a24x29xv"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id_list` - (Optional, Set: [`String`]) Id list. +* `application_resource_type_list` - (Optional, Set: [`String`]) An array of application resource types. +* `application_type` - (Optional, String) The application type. V OR C, V means VM, C means container. +* `microservice_type` - (Optional, String) The microservice type of the application. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - The application paging list information. + * `content` - The list of application information. + * `apigateway_service_id` - gateway service id. + * `application_desc` - The description of the application. + * `application_id` - The ID of the application. + * `application_name` - The name of the application. + * `application_remark_name` - remark name. + * `application_resource_type` - application resource type. + * `application_runtime_type` - application runtime type. + * `application_type` - The type of the application. + * `create_time` - create time. + * `ignore_create_image_repository` - whether ignore create image repository. + * `microservice_type` - The microservice type of the application. + * `prog_lang` - Programming language. + * `service_config_list` - service config list. + * `health_check` - health check setting. + * `path` - health check path. + * `name` - serviceName. + * `ports` - port list. + * `protocol` - protocol. + * `target_port` - service port. + * `update_time` - update time. + * `total_count` - The total number of applications. + + diff --git a/config/docs/d/tsf_application_attribute.html.markdown b/config/docs/d/tsf_application_attribute.html.markdown new file mode 100644 index 0000000..f23a3b4 --- /dev/null +++ b/config/docs/d/tsf_application_attribute.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application_attribute" +sidebar_current: "docs-tencentcloud-datasource-tsf_application_attribute" +description: |- + Use this data source to query detailed information of tsf application_attribute +--- + +# tencentcloud_tsf_application_attribute + +Use this data source to query detailed information of tsf application_attribute + +## Example Usage + +```hcl +data "tencentcloud_tsf_application_attribute" "application_attribute" { + application_id = "application-a24x29xv" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Required, String) application Id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - application list other attribute. + * `group_count` - Number of deployment groups under the application.Note: This field may return null, indicating that no valid values can be obtained. + * `instance_count` - Total number of instances.Note: This field may return null, indicating that no valid values can be obtained. + * `run_instance_count` - Number of running instances.Note: This field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/tsf_application_config.html.markdown b/config/docs/d/tsf_application_config.html.markdown new file mode 100644 index 0000000..94f88b0 --- /dev/null +++ b/config/docs/d/tsf_application_config.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application_config" +sidebar_current: "docs-tencentcloud-datasource-tsf_application_config" +description: |- + Use this data source to query detailed information of tsf application_config +--- + +# tencentcloud_tsf_application_config + +Use this data source to query detailed information of tsf application_config + +## Example Usage + +```hcl +data "tencentcloud_tsf_application_config" "application_config" { + application_id = "app-123456" + config_id = "config-123456" + config_id_list = + config_name = "test-config" + config_version = "1.0" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Optional, String) Application ID, query all when not provided. +* `config_id_list` - (Optional, Set: [`String`]) Configuration ID list, query all with lower priority when not provided. +* `config_id` - (Optional, String) Configuration ID, query all with higher priority when not provided. +* `config_name` - (Optional, String) Configuration name, precise query, query all when not provided. +* `config_version` - (Optional, String) Configuration version, precise query, query all when not provided. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Paginated configuration item list. Note: This field may return null, indicating that no valid values can be obtained. + * `content` - Configuration item list. + * `application_id` - application Id. Note: This field may return null, indicating that no valid values can be obtained. + * `application_name` - application Id. Note: This field may return null, indicating that no valid values can be obtained. + * `config_id` - Configuration ID. Note: This field may return null, indicating that no valid values can be obtained. + * `config_name` - Configuration name Note: This field may return null, indicating that no valid values can be obtained. + * `config_type` - Configuration type. Note: This field may return null, indicating that no valid values can be obtained. + * `config_value` - Configuration value. Note: This field may return null, indicating that no valid values can be obtained. + * `config_version_count` - config version count. Note: This field may return null, indicating that no valid values can be obtained. + * `config_version_desc` - Configuration version description. Note: This field may return null, indicating that no valid values can be obtained. + * `config_version` - Configuration version. Note: This field may return null, indicating that no valid values can be obtained. + * `creation_time` - CreationTime. Note: This field may return null, indicating that no valid values can be obtained. + * `delete_flag` - delete flag, true: allow delete; false: delete prohibit. + * `last_update_time` - last update time. Note: This field may return null, indicating that no valid values can be obtained. + * `total_count` - TsfPageConfig. + + diff --git a/config/docs/d/tsf_application_file_config.html.markdown b/config/docs/d/tsf_application_file_config.html.markdown new file mode 100644 index 0000000..33d4a32 --- /dev/null +++ b/config/docs/d/tsf_application_file_config.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application_file_config" +sidebar_current: "docs-tencentcloud-datasource-tsf_application_file_config" +description: |- + Use this data source to query detailed information of tsf application_file_config +--- + +# tencentcloud_tsf_application_file_config + +Use this data source to query detailed information of tsf application_file_config + +## Example Usage + +```hcl +data "tencentcloud_tsf_application_file_config" "application_file_config" { + config_id = "dcfg-f-4y4ekzqv" + # config_id_list = [""] + config_name = "file-log1" + application_id = "application-2vzk6n3v" + config_version = "1.2" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Optional, String) Application ID. +* `config_id_list` - (Optional, Set: [`String`]) List of configuration item ID. +* `config_id` - (Optional, String) Configuration ID. +* `config_name` - (Optional, String) Configuration item name. +* `config_version` - (Optional, String) Configuration item version. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - File configuration item list. Note: This field may return null, indicating that no valid values can be obtained. + * `content` - File configuration array. Note: This field may return null, indicating that no valid values can be obtained. + * `application_id` - application Id. Note: This field may return null, indicating that no valid values can be obtained. + * `application_name` - application name. Note: This field may return null, indicating that no valid values can be obtained. + * `config_file_code` - Configuration file code. Note: This field may return null, indicating that no valid values can be obtained. + * `config_file_name` - Configuration item file name. Note: This field may return null, indicating that no valid values can be obtained. + * `config_file_path` - file config path. Note: This field may return null, indicating that no valid values can be obtained. + * `config_file_value_length` - config item content length. Note: This field may return null, indicating that no valid values can be obtained. + * `config_file_value` - Configuration file content. Note: This field may return null, indicating that no valid values can be obtained. + * `config_id` - Config ID. Note: This field may return null, indicating that no valid values can be obtained. + * `config_name` - Configuration item name. Note: This field may return null, indicating that no valid values can be obtained. + * `config_post_cmd` - last update time. Note: This field may return null, indicating that no valid values can be obtained. + * `config_version_count` - config version count. Note: This field may return null, indicating that no valid values can be obtained. + * `config_version_desc` - Configuration item version description. Note: This field may return null, indicating that no valid values can be obtained. + * `config_version` - Configuration version. Note: This field may return null, indicating that no valid values can be obtained. + * `creation_time` - CreationTime. Note: This field may return null, indicating that no valid values can be obtained. + * `delete_flag` - delete flag, true: allow delete; false: delete prohibit. + * `last_update_time` - last update time. Note: This field may return null, indicating that no valid values can be obtained. + * `total_count` - total count. + + diff --git a/config/docs/d/tsf_application_public_config.html.markdown b/config/docs/d/tsf_application_public_config.html.markdown new file mode 100644 index 0000000..a1aaf4c --- /dev/null +++ b/config/docs/d/tsf_application_public_config.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application_public_config" +sidebar_current: "docs-tencentcloud-datasource-tsf_application_public_config" +description: |- + Use this data source to query detailed information of tsf application_public_config +--- + +# tencentcloud_tsf_application_public_config + +Use this data source to query detailed information of tsf application_public_config + +## Example Usage + +```hcl +data "tencentcloud_tsf_application_public_config" "application_public_config" { + config_id = "dcfg-p-evjrbgly" + # config_id_list = [""] + config_name = "dsadsa" + config_version = "123" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_id_list` - (Optional, Set: [`String`]) Config ID list. Query all items if not passed, low priority. +* `config_id` - (Optional, String) Config ID. Query all items if not passed, high priority. +* `config_name` - (Optional, String) Config name. Exact query. Query all items if not passed. +* `config_version` - (Optional, String) Config version. Exact query. Query all items if not passed. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Paginated global configuration list. Note: This field may return null, indicating that no valid value can be obtained. + * `content` - Config list. + * `application_id` - application Id. Note: This field may return null, indicating that no valid values can be obtained. + * `application_name` - application Id. Note: This field may return null, indicating that no valid values can be obtained. + * `config_id` - Config ID. Note: This field may return null, indicating that no valid value can be obtained. + * `config_name` - Config name. Note: This field may return null, indicating that no valid value can be obtained. + * `config_type` - Config type. Note: This field may return null, indicating that no valid value can be obtained. + * `config_value` - Config value. Note: This field may return null, indicating that no valid value can be obtained. + * `config_version_count` - config version count. Note: This field may return null, indicating that no valid values can be obtained. + * `config_version_desc` - Config version description. Note: This field may return null, indicating that no valid value can be obtained. + * `config_version` - Config version. Note: This field may return null, indicating that no valid value can be obtained. + * `creation_time` - CreationTime. Note: This field may return null, indicating that no valid values can be obtained. + * `delete_flag` - delete flag, true: allow delete; false: delete prohibit. + * `last_update_time` - last update time. Note: This field may return null, indicating that no valid values can be obtained. + * `total_count` - TsfPageConfig. + + diff --git a/config/docs/d/tsf_business_log_configs.html.markdown b/config/docs/d/tsf_business_log_configs.html.markdown new file mode 100644 index 0000000..311940d --- /dev/null +++ b/config/docs/d/tsf_business_log_configs.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_business_log_configs" +sidebar_current: "docs-tencentcloud-datasource-tsf_business_log_configs" +description: |- + Use this data source to query detailed information of tsf business_log_configs +--- + +# tencentcloud_tsf_business_log_configs + +Use this data source to query detailed information of tsf business_log_configs + +## Example Usage + +```hcl +data "tencentcloud_tsf_business_log_configs" "business_log_configs" { + search_word = "terraform" + disable_program_auth_check = true + config_id_list = ["apm-busi-log-cfg-qv3x3rdv"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_id_list` - (Optional, Set: [`String`]) Config Id list. +* `disable_program_auth_check` - (Optional, Bool) Disable Program auth check or not. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) wild search word. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - List of business log configurations.Note: This field may return null, indicating that no valid values can be obtained. + * `content` - Log configuration item list. Note: This field may return null, indicating that no valid values can be obtained. + * `config_associated_groups` - the associate group of Config.Note: This field may return null, indicating that no valid values can be obtained. + * `application_id` - Application Id of Group. Note: This field may return null, indicating that no valid values can be obtained. + * `application_name` - Application Name. Note: This field may return null, indicating that no valid values can be obtained. + * `application_type` - Application Type. Note: This field may return null, indicating that no valid values can be obtained. + * `associated_time` - Time when the deployment group is associated with the log configuration.Note: This field may return null, indicating that no valid values can be obtained. + * `cluster_id` - Cluster ID to which the deployment group belongs.Note: This field may return null, indicating that no valid values can be obtained. + * `cluster_name` - Cluster Name to which the deployment group belongs.Note: This field may return null, indicating that no valid values can be obtained. + * `cluster_type` - Cluster type to which the deployment group belongs.Note: This field may return null, indicating that no valid values can be obtained. + * `group_id` - Group Id. Note: This field may return null, indicating that no valid values can be obtained. + * `group_name` - Group Name. Note: This field may return null, indicating that no valid values can be obtained. + * `namespace_id` - Namespace ID to which the deployment group belongs.Note: This field may return null, indicating that no valid values can be obtained. + * `namespace_name` - Namespace Name to which the deployment group belongs.Note: This field may return null, indicating that no valid values can be obtained. + * `config_create_time` - Create time of configuration item.Note: This field may return null, indicating that no valid values can be obtained. + * `config_desc` - Description of configuration item.Note: This field may return null, indicating that no valid values can be obtained. + * `config_id` - ConfigId. + * `config_name` - ConfigName. + * `config_path` - Log path of configuration item.Note: This field may return null, indicating that no valid values can be obtained. + * `config_pipeline` - Pipeline of configuration item.Note: This field may return null, indicating that no valid values can be obtained. + * `config_schema` - ParserSchema of configuration item.Note: This field may return null, indicating that no valid values can be obtained. + * `schema_content` - content of schema. + * `schema_create_time` - Create time of configuration item.Note: This field may return null, indicating that no valid values can be obtained. + * `schema_date_format` - Schema format.Note: This field may return null, indicating that no valid values can be obtained. + * `schema_multiline_pattern` - Schema pattern of configuration item.Note: This field may return null, indicating that no valid values can be obtained. + * `schema_pattern_layout` - User-defined parsing rules.Note: This field may return null, indicating that no valid values can be obtained. + * `schema_type` - Schema type. + * `config_tags` - configuration Tag.Note: This field may return null, indicating that no valid values can be obtained. + * `config_update_time` - Update time of configuration item.Note: This field may return null, indicating that no valid values can be obtained. + * `total_count` - Total Count.Note: This field may return null, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/tsf_cluster.html.markdown b/config/docs/d/tsf_cluster.html.markdown new file mode 100644 index 0000000..627801c --- /dev/null +++ b/config/docs/d/tsf_cluster.html.markdown @@ -0,0 +1,83 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_cluster" +sidebar_current: "docs-tencentcloud-datasource-tsf_cluster" +description: |- + Use this data source to query detailed information of tsf cluster +--- + +# tencentcloud_tsf_cluster + +Use this data source to query detailed information of tsf cluster + +## Example Usage + +```hcl +data "tencentcloud_tsf_cluster" "cluster" { + cluster_id_list = ["cluster-vwgj5e6y"] + cluster_type = "V" + # search_word = "" + disable_program_auth_check = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id_list` - (Optional, Set: [`String`]) Cluster ID list to be queried, if not filled in or passed, all content will be queried. +* `cluster_type` - (Optional, String) The type of cluster to be queried, if left blank or not passed, all content will be queried. C: container, V: virtual machine. +* `disable_program_auth_check` - (Optional, Bool) Whether to disable dataset authentication. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) Filter by keywords for Cluster Id or name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - TSF cluster pagination object. Note: This field may return null, indicating no valid value. + * `content` - Cluster list. Note: This field may return null, indicating no valid values. + * `cluster_cidr` - cluster CIDR. Note: This field may return null, indicating no valid value. + * `cluster_desc` - Cluster description. Note: This field may return null, indicating no valid value. + * `cluster_id` - Cluster ID. Note: This field may return null, indicating no valid value. + * `cluster_limit_cpu` - Maximum CPU limit of the cluster, in cores. This field may return null, indicating that no valid value was found. + * `cluster_limit_mem` - Cluster maximum memory limit in GB. This field may return null, indicating that no valid value was found. + * `cluster_name` - Cluster name. Note: This field may return null, indicating no valid value. + * `cluster_status` - cluster status. Note: This field may return null, indicating no valid value. + * `cluster_total_cpu` - Total CPU of the cluster, unit: cores. Note: This field may return null, indicating that no valid value was found. + * `cluster_total_mem` - Total memory of the cluster, unit: G. Note: This field may return null, indicating that no valid value is obtained. + * `cluster_type` - Cluster type. Note: This field may return null, indicating no valid value. + * `cluster_used_cpu` - Used CPU of the cluster, in cores. This field may return null, indicating no valid value. + * `cluster_used_mem` - Cluster used memory in GB. This field may return null, indicating no valid value. + * `cluster_version` - The cluster version, may return null if not applicable. + * `create_time` - CreationTime. Note: This field may return null, indicating that no valid values can be obtained. + * `delete_flag_reason` - Reason why the cluster cannot be deleted. Note: This field may return null, indicating that no valid values can be obtained. + * `delete_flag` - Deletion tag: true means it can be deleted, false means it cannot be deleted. Note: This field may return null, indicating no valid value. + * `instance_count` - Cluster instance number. This field may return null, indicating no valid value. + * `normal_instance_count` - Cluster normal instance number. This field may return null, indicating no valid value. + * `operation_info` - Control information returned to the frontend. This field may return null, indicating no valid value. + * `add_instance` - Add instance button control information, Note: This field may return null, indicating that no valid value is obtained. + * `disabled_reason` - The reason why this button is not displayed, may return null if not applicable. + * `enabled` - Whether the button is clickable. Note: This field may return null, indicating that no valid value is obtained. + * `supported` - Whether the button is clickable. Note: This field may return null, indicating that no valid value was found. + * `destroy` - Control information for destroying machine, may return null if no valid value is obtained. + * `disabled_reason` - The reason why this button is not displayed, may return null if not applicable. + * `enabled` - Whether the button is clickable. Note: This field may return null, indicating that no valid value is obtained. + * `supported` - Whether the button is clickable. Note: This field may return null, indicating that no valid value was found. + * `init` - Control information of the initialization button returned to the front end. Note: This field may return null, indicating no valid value. + * `disabled_reason` - Reason for not displaying. Note: This field may return null, indicating no valid value. + * `enabled` - The availability of the button (whether it is clickable) may return null indicating that the information is not available. + * `supported` - Whether to display the button. Note: This field may return null, indicating that no valid value was found. + * `run_instance_count` - Cluster running instance number. This field may return null, indicating no valid value. + * `run_service_instance_count` - Number of available service instances in the cluster. Note: This field may return null, indicating no valid value. + * `subnet_id` - Cluster subnet ID. Note: This field may return null, indicating no valid values. + * `tsf_region_id` - region ID of TSF. Note: This field may return null, indicating that no valid values can be obtained. + * `tsf_region_name` - region name of TSF. Note: This field may return null, indicating that no valid values can be obtained. + * `tsf_zone_id` - Zone Id of TSF. Note: This field may return null, indicating that no valid values can be obtained. + * `tsf_zone_name` - Zone name of TSF. Note: This field may return null, indicating that no valid values can be obtained. + * `update_time` - last update time. Note: This field may return null, indicating that no valid values can be obtained. + * `vpc_id` - Private network ID of the cluster. Note: This field may return null, indicating no valid value. + * `total_count` - Total number of items. Note: This field may return null, indicating that no valid value was found. + + diff --git a/config/docs/d/tsf_config_summary.html.markdown b/config/docs/d/tsf_config_summary.html.markdown new file mode 100644 index 0000000..ebde4da --- /dev/null +++ b/config/docs/d/tsf_config_summary.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_config_summary" +sidebar_current: "docs-tencentcloud-datasource-tsf_config_summary" +description: |- + Use this data source to query detailed information of tsf config_summary +--- + +# tencentcloud_tsf_config_summary + +Use this data source to query detailed information of tsf config_summary + +## Example Usage + +```hcl +data "tencentcloud_tsf_config_summary" "config_summary" { + application_id = "application-a24x29xv" + search_word = "terraform" + order_by = "last_update_time" + order_type = 0 + disable_program_auth_check = true + config_id_list = ["dcfg-y54wzk3a"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Optional, String) Application ID. If not passed, the query will be for all. +* `config_id_list` - (Optional, Set: [`String`]) Config Id List. +* `config_tag_list` - (Optional, Set: [`String`]) config tag list. +* `disable_program_auth_check` - (Optional, Bool) Whether to disable dataset authentication. +* `order_by` - (Optional, String) Order term. support Sort by time: creation_time; or Sort by name: config_name. +* `order_type` - (Optional, Int) Pass 0 for ascending order and 1 for descending order. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) Query keyword, fuzzy query: application name, configuration item name. If not passed, the query will be for all. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - config Page Item. + * `content` - config list. + * `application_id` - Application ID.Note: This field may return null, indicating that no valid value was found. + * `application_name` - Application Name. Note: This field may return null, indicating that no valid value was found. + * `config_id` - Configuration item ID.Note: This field may return null, indicating that no valid value was found. + * `config_name` - Configuration name.Note: This field may return null, indicating that no valid value was found. + * `config_type` - Config type. Note: This field may return null, indicating that no valid value was found. + * `config_value` - Configuration value.Note: This field may return null, indicating that no valid value was found. + * `config_version_count` - Configure version count.Note: This field may return null, indicating that no valid value was found. + * `config_version_desc` - Configuration version description.Note: This field may return null, indicating that no valid value was found. + * `config_version` - Configuration version. Note: This field may return null, indicating that no valid value was found. + * `creation_time` - Create time.Note: This field may return null, indicating that no valid value was found. + * `delete_flag` - Deletion flag, true: deletable; false: not deletable.Note: This field may return null, indicating that no valid value was found. + * `last_update_time` - Last update time.Note: This field may return null, indicating that no valid value was found. + * `total_count` - total count. + + diff --git a/config/docs/d/tsf_container_group.html.markdown b/config/docs/d/tsf_container_group.html.markdown new file mode 100644 index 0000000..d8c3260 --- /dev/null +++ b/config/docs/d/tsf_container_group.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_container_group" +sidebar_current: "docs-tencentcloud-datasource-tsf_container_group" +description: |- + Use this data source to query detailed information of tsf container_group +--- + +# tencentcloud_tsf_container_group + +Use this data source to query detailed information of tsf container_group + +## Example Usage + +```hcl +data "tencentcloud_tsf_container_group" "container_group" { + application_id = "application-a24x29xv" + search_word = "keep" + order_by = "createTime" + order_type = 0 + cluster_id = "cluster-vwgj5e6y" + namespace_id = "namespace-aemrg36v" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Optional, String) ApplicationId, required. +* `cluster_id` - (Optional, String) Cluster Id. +* `namespace_id` - (Optional, String) Namespace Id. +* `order_by` - (Optional, String) The sorting field. By default, it is the createTime field. Supports id, name, createTime. +* `order_type` - (Optional, Int) The sorting order. By default, it is 1, indicating descending order. 0 indicates ascending order, and 1 indicates descending order. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) search word, support group name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - result list. + * `content` - List of deployment groups.Note: This field may return null, indicating that no valid value was found. + * `alias` - The Group description.Note: This field may return null, indicating that no valid value was found. + * `cluster_id` - Cluster Id.Note: This field may return null, indicating that no valid value was found. + * `cluster_name` - Cluster name.Note: This field may return null, indicating that no valid value was found. + * `cpu_limit` - The maximum amount of CPU, corresponding to K8S limit.Note: This field may return null, indicating that no valid value was found. + * `cpu_request` - The initial amount of CPU, corresponding to K8S request.Note: This field may return null, indicating that no valid value was found. + * `create_time` - Create time.Note: This field may return null, indicating that no valid value was found. + * `group_id` - Group Id.Note: This field may return null, indicating that no valid value was found. + * `group_name` - Group name.Note: This field may return null, indicating that no valid value was found. + * `kube_inject_enable` - The value of KubeInjectEnable.Note: This field may return null, indicating that no valid value was found. + * `mem_limit` - The maximum amount of memory allocated in MiB, corresponding to K8S limit.Note: This field may return null, indicating that no valid value was found. + * `mem_request` - The initial amount of memory allocated in MiB, corresponding to K8S request.Note: This field may return null, indicating that no valid value was found. + * `namespace_id` - Namespace Id.Note: This field may return null, indicating that no valid value was found. + * `namespace_name` - Namespace name.Note: This field may return null, indicating that no valid value was found. + * `repo_name` - Image name.Note: This field may return null, indicating that no valid value was found. + * `server` - Image server.Note: This field may return null, indicating that no valid value was found. + * `tag_name` - Image version Name.Note: This field may return null, indicating that no valid value was found. + * `updated_time` - Update type.Note: This field may return null, indicating that no valid value was found. + * `total_count` - Total count. + + diff --git a/config/docs/d/tsf_delivery_config_by_group_id.html.markdown b/config/docs/d/tsf_delivery_config_by_group_id.html.markdown new file mode 100644 index 0000000..6626fba --- /dev/null +++ b/config/docs/d/tsf_delivery_config_by_group_id.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_delivery_config_by_group_id" +sidebar_current: "docs-tencentcloud-datasource-tsf_delivery_config_by_group_id" +description: |- + Use this data source to query detailed information of tsf delivery_config_by_group_id +--- + +# tencentcloud_tsf_delivery_config_by_group_id + +Use this data source to query detailed information of tsf delivery_config_by_group_id + +## Example Usage + +```hcl +data "tencentcloud_tsf_delivery_config_by_group_id" "delivery_config_by_group_id" { + group_id = "group-yrjkln9v" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String) groupId. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - configuration item for deliver to a Kafka. + * `config_id` - Config ID. Note: This field may return null, which means that no valid value was obtained. + * `config_name` - Config Name. Note: This field may return null, which means that no valid value was obtained. + + diff --git a/config/docs/d/tsf_delivery_configs.html.markdown b/config/docs/d/tsf_delivery_configs.html.markdown new file mode 100644 index 0000000..6d0c871 --- /dev/null +++ b/config/docs/d/tsf_delivery_configs.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_delivery_configs" +sidebar_current: "docs-tencentcloud-datasource-tsf_delivery_configs" +description: |- + Use this data source to query detailed information of tsf delivery_configs +--- + +# tencentcloud_tsf_delivery_configs + +Use this data source to query detailed information of tsf delivery_configs + +## Example Usage + +```hcl +data "tencentcloud_tsf_delivery_configs" "delivery_configs" { + search_word = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) search word. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - deploy group information about the deployment group associated with a delivery item.Note: This field may return null, which means that no valid value was obtained. + * `content` - content. Note: This field may return null, which means that no valid value was obtained. + * `collect_path` - harvest log path. Note: This field may return null, which means that no valid value was obtained. + * `config_id` - config id. + * `config_name` - config name. + * `create_time` - Creation time.Note: This field may return null, indicating that no valid values can be obtained. + * `custom_rule` - CustomRule specifies a custom line separator rule.Note: This field may return null, which means that no valid value was obtained. + * `enable_auth` - whether use auth for kafka. Note: This field may return null, which means that no valid value was obtained. + * `enable_global_line_rule` - Indicates whether a single row rule should be applied.Note: This field may return null, which means that no valid value was obtained. + * `groups` - Associated deployment group information.Note: This field may return null, indicating that no valid values can be obtained. + * `associate_time` - Associate Time. Note: This field may return null, indicating that no valid values can be obtained. + * `cluster_id` - Cluster ID. Note: This field may return null, indicating that no valid values can be obtained. + * `cluster_name` - Cluster Name. Note: This field may return null, indicating that no valid values can be obtained. + * `cluster_type` - Cluster type. + * `group_id` - Group Id. + * `group_name` - Group Name. + * `namespace_name` - Namespace Name. Note: This field may return null, indicating that no valid values can be obtained. + * `kafka_address` - KafkaAddress refers to the address of a Kafka server.Note: This field may return null, which means that no valid value was obtained. + * `kafka_infos` - Kafka Infos. Note: This field may return null, which means that no valid value was obtained. + * `custom_rule` - Custom Line Rule. + * `line_rule` - Line rule specifies the type of line separator used in a file. It can have one of the following values: default: The default line separator is used to separate lines in the file. time: The lines in the file are separated based on time. custom: A custom line separator is used. In this case, the CustomRule field should be filled with the specific custom value. Note: This field may return null, which means that no valid value was obtained. + * `path` - harvest log path. Note: This field may return null, which means that no valid value was obtained. + * `topic` - Kafka topic. Note: This field may return null, which means that no valid value was obtained. + * `kafka_v_ip` - Kafka VIP. Note: This field may return null, which means that no valid value was obtained. + * `kafka_v_port` - Kafka VPort. Note: This field may return null, which means that no valid value was obtained. + * `line_rule` - Line Rule for log. Note: This field may return null, which means that no valid value was obtained. + * `password` - Password. Note: This field may return null, which means that no valid value was obtained. + * `topic` - Topic. Note: This field may return null, which means that no valid value was obtained. + * `username` - user Name. Note: This field may return null, which means that no valid value was obtained. + * `total_count` - total count. Note: This field may return null, which means that no valid value was obtained. + + diff --git a/config/docs/d/tsf_gateway_all_group_apis.html.markdown b/config/docs/d/tsf_gateway_all_group_apis.html.markdown new file mode 100644 index 0000000..e51293f --- /dev/null +++ b/config/docs/d/tsf_gateway_all_group_apis.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_gateway_all_group_apis" +sidebar_current: "docs-tencentcloud-datasource-tsf_gateway_all_group_apis" +description: |- + Use this data source to query detailed information of tsf gateway_all_group_apis +--- + +# tencentcloud_tsf_gateway_all_group_apis + +Use this data source to query detailed information of tsf gateway_all_group_apis + +## Example Usage + +```hcl +data "tencentcloud_tsf_gateway_all_group_apis" "gateway_all_group_apis" { + gateway_deploy_group_id = "group-aeoej4qy" + search_word = "user" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_deploy_group_id` - (Required, String) gateway group Id. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) Search keyword, supports api group name or API path. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Gateway group and API list information. + * `gateway_deploy_group_id` - Gateway deployment group ID.Note: This field may return null, which means no valid value was found. + * `gateway_deploy_group_name` - Gateway deployment group name.Note: This field may return null, which means no valid value was found. + * `group_num` - Gateway deployment api group number.Note: This field may return null, which means no valid value was found. + * `groups` - Gateway deployment api group list.Note: This field may return null, which means no valid value was found. + * `gateway_instance_id` - gateway instance id.Note: This field may return null, which means no valid value was found. + * `gateway_instance_type` - Type of the gateway instance.Note: This field may return null, which means no valid value was found. + * `group_api_count` - Number of APIs under the group. Note: This field may return null, which means no valid value was found. + * `group_apis` - List of APIs under the group.Note: This field may return null, which means no valid value was found. + * `api_id` - API ID. + * `method` - API method. + * `microservice_name` - API service name. + * `namespace_name` - namespace name. + * `path` - API path. + * `group_id` - api group id.Note: This field may return null, which means no valid value was found. + * `group_name` - api group name.Note: This field may return null, which means no valid value was found. + + diff --git a/config/docs/d/tsf_group_config_release.html.markdown b/config/docs/d/tsf_group_config_release.html.markdown new file mode 100644 index 0000000..a1ba768 --- /dev/null +++ b/config/docs/d/tsf_group_config_release.html.markdown @@ -0,0 +1,81 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_group_config_release" +sidebar_current: "docs-tencentcloud-datasource-tsf_group_config_release" +description: |- + Use this data source to query detailed information of tsf group_config_release +--- + +# tencentcloud_tsf_group_config_release + +Use this data source to query detailed information of tsf group_config_release + +## Example Usage + +```hcl +data "tencentcloud_tsf_group_config_release" "group_config_release" { + group_id = "group-yrjkln9v" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String) groupId. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Information related to the deployment group release.Note: This field may return null, which means no valid value was found. + * `config_release_list` - Configuration item release list.Note: This field may return null, which means no valid value was found. + * `application_id` - Configuration item release config ID.Note: This field may return null, which means no valid value was found. + * `cluster_id` - Configuration item release cluster ID.Note: This field may return null, which means no valid value was found. + * `cluster_name` - Configuration item release cluster name.Note: This field may return null, which means no valid value was found. + * `config_id` - Configuration item release config ID.Note: This field may return null, which means no valid value was found. + * `config_name` - Configuration item release config name.Note: This field may return null, which means no valid value was found. + * `config_release_id` - Configuration item release ID.Note: This field may return null, which means no valid value was found. + * `config_version` - Configuration item release config version.Note: This field may return null, which means no valid value was found. + * `group_id` - Configuration item release config group ID.Note: This field may return null, which means no valid value was found. + * `group_name` - Configuration item release config group name.Note: This field may return null, which means no valid value was found. + * `namespace_id` - Configuration item release namespace ID.Note: This field may return null, which means no valid value was found. + * `namespace_name` - Configuration item release namespace name.Note: This field may return null, which means no valid value was found. + * `release_desc` - Configuration item release description.Note: This field may return null, which means no valid value was found. + * `release_time` - Configuration item release time.Note: This field may return null, which means no valid value was found. + * `file_config_release_list` - File configuration item release list.Note: This field may return null, which means no valid value was found. + * `cluster_id` - Configuration item release cluster ID.Note: This field may return null, which means no valid value was found. + * `cluster_name` - Configuration item release cluster name.Note: This field may return null, which means no valid value was found. + * `config_id` - Configuration item release config ID.Note: This field may return null, which means no valid value was found. + * `config_name` - Configuration item release config name.Note: This field may return null, which means no valid value was found. + * `config_release_id` - Configuration item release ID.Note: This field may return null, which means no valid value was found. + * `config_version` - Configuration item release config version.Note: This field may return null, which means no valid value was found. + * `group_id` - Configuration item release config group ID.Note: This field may return null, which means no valid value was found. + * `group_name` - Configuration item release config group name.Note: This field may return null, which means no valid value was found. + * `namespace_id` - Configuration item release namespace ID.Note: This field may return null, which means no valid value was found. + * `namespace_name` - Configuration item release namespace name.Note: This field may return null, which means no valid value was found. + * `release_desc` - Configuration item release description.Note: This field may return null, which means no valid value was found. + * `release_time` - Configuration item release time.Note: This field may return null, which means no valid value was found. + * `package_id` - Package Id.Note: This field may return null, which means no valid value was found. + * `package_name` - Package name.Note: This field may return null, which means no valid value was found. + * `package_version` - Package version.Note: This field may return null, which means no valid value was found. + * `public_config_release_list` - Release public config list. + * `application_id` - Configuration item release application ID.Note: This field may return null, which means no valid value was found. + * `cluster_id` - Configuration item release cluster ID.Note: This field may return null, which means no valid value was found. + * `cluster_name` - Configuration item release cluster name.Note: This field may return null, which means no valid value was found. + * `config_id` - Configuration item ID.Note: This field may return null, which means no valid value was found. + * `config_name` - Configuration item name.Note: This field may return null, which means no valid value was found. + * `config_release_id` - Configuration item release ID.Note: This field may return null, which means no valid value was found. + * `config_version` - Configuration version.Note: This field may return null, which means no valid value was found. + * `group_id` - Configuration item release group ID.Note: This field may return null, which means no valid value was found. + * `group_name` - Configuration item release group name.Note: This field may return null, which means no valid value was found. + * `namespace_id` - Configuration item release namespace ID.Note: This field may return null, which means no valid value was found. + * `namespace_name` - Configuration item release namespace name.Note: This field may return null, which means no valid value was found. + * `release_desc` - Configuration item release description.Note: This field may return null, which means no valid value was found. + * `release_time` - Configuration item release time.Note: This field may return null, which means no valid value was found. + * `repo_name` - image name.Note: This field may return null, which means no valid value was found. + * `tag_name` - image tag name.Note: This field may return null, which means no valid value was found. + + diff --git a/config/docs/d/tsf_group_gateways.html.markdown b/config/docs/d/tsf_group_gateways.html.markdown new file mode 100644 index 0000000..13f2aae --- /dev/null +++ b/config/docs/d/tsf_group_gateways.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_group_gateways" +sidebar_current: "docs-tencentcloud-datasource-tsf_group_gateways" +description: |- + Use this data source to query detailed information of tsf group_gateways +--- + +# tencentcloud_tsf_group_gateways + +Use this data source to query detailed information of tsf group_gateways + +## Example Usage + +```hcl +data "tencentcloud_tsf_group_gateways" "group_gateways" { + gateway_deploy_group_id = "group-aeoej4qy" + search_word = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_deploy_group_id` - (Required, String) gateway group Id. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) search word. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - api group information. + * `content` - api group Info. + * `acl_mode` - ACL type for accessing the group.Note: This field may return null, which means no valid value was found. + * `api_count` - Number of APIs.Note: This field may return null, which means no valid value was found. + * `auth_type` - Authentication type. secret: key authentication; none: no authentication.Note: This field may return null, which means no valid value was found. + * `binded_gateway_deploy_groups` - Gateway deployment group bound to the API group.Note: This field may return null, which means no valid value was found. + * `application_id` - application ID.Note: This field may return null, which means no valid value was found. + * `application_name` - application name.Note: This field may return null, which means no valid value was found. + * `application_type` - Application category: V: virtual machine application, C: container application.Note: This field may return null, which means no valid value was found. + * `cluster_type` - Cluster type, with possible values: C: container, V: virtual machine.Note: This field may return null, which means no valid value was found. + * `deploy_group_id` - Gateway deployment group ID.Note: This field may return null, which means no valid value was found. + * `deploy_group_name` - Gateway deployment group name.Note: This field may return null, which means no valid value was found. + * `group_status` - Application status of the deployment group, with possible values: Running, Waiting, Paused, Updating, RollingBack, Abnormal, Unknown.Note: This field may return null, which means no valid value was found. + * `created_time` - Group creation time, such as: 2019-06-20 15:51:28.Note: This field may return null, which means no valid value was found. + * `description` - Description.Note: This field may return null, which means no valid value was found. + * `gateway_instance_id` - Gateway instance ID.Note: This field may return null, which means no valid value was found. + * `gateway_instance_type` - Gateway instance type.Note: This field may return null, which means no valid value was found. + * `group_context` - api group context.Note: This field may return null, which means no valid value was found. + * `group_id` - api group id.Note: This field may return null, which means no valid value was found. + * `group_name` - api group name.Note: This field may return null, which means no valid value was found. + * `group_type` - Group type. ms: microservice group; external: external API group.This field may return null, which means no valid value was found. + * `namespace_name_key_position` - Namespace parameter location, path, header, or query. The default is path.Note: This field may return null, which means no valid value was found. + * `namespace_name_key` - Namespace parameter key.Note: This field may return null, which means no valid value was found. + * `service_name_key_position` - Microservice name parameter location, path, header, or query. The default is path.Note: This field may return null, which means no valid value was found. + * `service_name_key` - Microservice name parameter key.Note: This field may return null, which means no valid value was found. + * `status` - Release status. drafted: not released. released: released.Note: This field may return null, which means no valid value was found. + * `updated_time` - Group update time, such as: 2019-06-20 15:51:28.Note: This field may return null, which means no valid value was found. + * `total_count` - total count. + + diff --git a/config/docs/d/tsf_group_instances.html.markdown b/config/docs/d/tsf_group_instances.html.markdown new file mode 100644 index 0000000..ee7666f --- /dev/null +++ b/config/docs/d/tsf_group_instances.html.markdown @@ -0,0 +1,82 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_group_instances" +sidebar_current: "docs-tencentcloud-datasource-tsf_group_instances" +description: |- + Use this data source to query detailed information of tsf group_instances +--- + +# tencentcloud_tsf_group_instances + +Use this data source to query detailed information of tsf group_instances + +## Example Usage + +```hcl +data "tencentcloud_tsf_group_instances" "group_instances" { + group_id = "group-yrjkln9v" + search_word = "testing" + order_by = "ASC" + order_type = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String) group id. +* `order_by` - (Optional, String) order term. +* `order_type` - (Optional, Int) order type. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) search word. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Machine information of the deployment group.Note: This field may return null, which means no valid value was found. + * `content` - List of machine instances.Note: This field may return null, which means no valid value was found. + * `agent_version` - Agent version.Note: This field may return null, which means no valid value was found. + * `application_id` - Application id.Note: This field may return null, which means no valid value was found. + * `application_name` - Application name. Note: This field may return null, which means no valid value was found. + * `application_resource_type` - application resource id.Note: This field may return null, which means no valid value was found. + * `application_type` - Application id.Note: This field may return null, which means no valid value was found. + * `cluster_id` - Cluster id.Note: This field may return null, which means no valid value was found. + * `cluster_name` - Cluster name. Note: This field may return null, which means no valid value was found. + * `cluster_type` - Cluster type.Note: This field may return null, which means no valid value was found. + * `count_in_tsf` - Indicates whether this instance has been added to the TSF.Note: This field may return null, which means no valid value was found. + * `group_id` - Group id.Note: This field may return null, which means no valid value was found. + * `group_name` - Group name.Note: This field may return null, which means no valid value was found. + * `instance_available_status` - VM availability status. For virtual machines, it indicates whether the virtual machine can be used as a resource. For containers, it indicates whether the virtual machine can be used to deploy pods.Note: This field may return null, which means no valid value was found. + * `instance_charge_type` - machine instance charge type.Note: This field may return null, which means no valid value was found. + * `instance_created_time` - Creation time of the machine instance in CVM.Note: This field may return null, which means no valid value was found. + * `instance_desc` - Description.Note: This field may return null, which means no valid value was found. + * `instance_expired_time` - Expire time of the machine instance in CVM.Note: This field may return null, which means no valid value was found. + * `instance_id` - Machine instance ID.Note: This field may return null, which means no valid value was found. + * `instance_import_mode` - InstanceImportMode import mode.Note: This field may return null, which means no valid value was found. + * `instance_limit_cpu` - Limit CPU information of the machine instance.Note: This field may return null, which means no valid value was found. + * `instance_limit_mem` - Limit memory information of the machine instance.Note: This field may return null, which means no valid value was found. + * `instance_name` - Machine name.Note: This field may return null, which means no valid value was found. + * `instance_pkg_version` - instance pkg version.Note: This field may return null, which means no valid value was found. + * `instance_status` - VM status. For virtual machines, it indicates the status of the virtual machine. For containers, it indicates the status of the virtual machine where the pod is located.Note: This field may return null, which means no valid value was found. + * `instance_total_cpu` - Total CPU information of the machine instance.Note: This field may return null, which means no valid value was found. + * `instance_total_mem` - Total memory information of the machine instance.Note: This field may return null, which means no valid value was found. + * `instance_used_cpu` - CPU information used by the machine instance.Note: This field may return null, which means no valid value was found. + * `instance_used_mem` - Memory information used by the machine instance.Note: This field may return null, which means no valid value was found. + * `instance_zone_id` - Instance zone id.Note: This field may return null, which means no valid value was found. + * `lan_ip` - Private IP address.Note: This field may return null, which means no valid value was found. + * `namespace_id` - Namespace id.Note: This field may return null, which means no valid value was found. + * `namespace_name` - Namespace name.Note: This field may return null, which means no valid value was found. + * `node_instance_id` - Container host instance ID.Note: This field may return null, which means no valid value was found. + * `operation_state` - Execution status of the instance.Note: This field may return null, which means no valid value was found. + * `reason` - Health checking reason.Note: This field may return null, which means no valid value was found. + * `restrict_state` - Business status of the machine instance.Note: This field may return null, which means no valid value was found. + * `service_instance_status` - Status of service instances under the service. For virtual machines, it indicates whether the application is available and the agent status. For containers, it indicates the status of the pod.Note: This field may return null, which means no valid value was found. + * `service_sidecar_status` - Sidecar status.Note: This field may return null, which means no valid value was found. + * `update_time` - Update time.Note: This field may return null, which means no valid value was found. + * `wan_ip` - Public IP address.Note: This field may return null, which means no valid value was found. + * `total_count` - Total number of machine instances.Note: This field may return null, which means no valid value was found. + + diff --git a/config/docs/d/tsf_groups.html.markdown b/config/docs/d/tsf_groups.html.markdown new file mode 100644 index 0000000..7086de3 --- /dev/null +++ b/config/docs/d/tsf_groups.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_groups" +sidebar_current: "docs-tencentcloud-datasource-tsf_groups" +description: |- + Use this data source to query detailed information of tsf groups +--- + +# tencentcloud_tsf_groups + +Use this data source to query detailed information of tsf groups + +## Example Usage + +```hcl +data "tencentcloud_tsf_groups" "groups" { + search_word = "keep" + application_id = "application-a24x29xv" + order_by = "createTime" + order_type = 0 + namespace_id = "namespace-aemrg36v" + cluster_id = "cluster-vwgj5e6y" + group_resource_type_list = ["DEF"] + status = "Running" + group_id_list = ["group-yrjkln9v"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Optional, String) applicationId. +* `cluster_id` - (Optional, String) clusterId. +* `group_id_list` - (Optional, Set: [`String`]) group Id list. +* `group_resource_type_list` - (Optional, Set: [`String`]) Group resourceType list. +* `namespace_id` - (Optional, String) namespace Id. +* `order_by` - (Optional, String) sort term. +* `order_type` - (Optional, Int) order type, 0 desc, 1 asc. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) searchWord, support groupName. +* `status` - (Optional, String) group status filter, `Running`: running, `Unknown`: unknown. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Pagination information of the virtual machine deployment group.Note: This field may return null, indicating that no valid value was found. + * `content` - Virtual machine deployment group list. Note: This field may return null, indicating that no valid value was found. + * `alias` - Group alias. Note: This field may return null, indicating that no valid value was found. + * `application_id` - Application ID. Note: This field may return null, indicating that no valid value was found. + * `application_name` - Application name. Note: This field may return null, indicating that no valid value was found. + * `application_type` - Application type. Note: This field may return null, indicating that no valid value was found. + * `cluster_id` - Cluster ID. Note: This field may return null, indicating that no valid value was found. + * `cluster_name` - Cluster name. Note: This field may return null, indicating that no valid value was found. + * `create_time` - Create Time. Note: This field may return null, indicating that no valid value was found. + * `deploy_desc` - Group description. Note: This field may return null, indicating that no valid value was found. + * `group_desc` - Group description. Note: This field may return null, indicating that no valid value was found. + * `group_id` - Group ID. Note: This field may return null, indicating that no valid value was found. + * `group_name` - Group ID. Note: This field may return null, indicating that no valid value was found. + * `group_resource_type` - Group resource type. Note: This field may return null, indicating that no valid value was found. + * `microservice_type` - Microservice type. Note: This field may return null, indicating that no valid value was found. + * `namespace_id` - Namespace ID. Note: This field may return null, indicating that no valid value was found. + * `namespace_name` - Namespace name. Note: This field may return null, indicating that no valid value was found. + * `startup_parameters` - Group start up Parameters. Note: This field may return null, indicating that no valid value was found. + * `update_time` - Group update time. Note: This field may return null, indicating that no valid value was found. + * `updated_time` - Update time. Note: This field may return null, indicating that no valid value was found. + * `total_count` - Total count virtual machine deployment group. Note: This field may return null, indicating that no valid value was found. + + diff --git a/config/docs/d/tsf_microservice.html.markdown b/config/docs/d/tsf_microservice.html.markdown new file mode 100644 index 0000000..c7b4f0c --- /dev/null +++ b/config/docs/d/tsf_microservice.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_microservice" +sidebar_current: "docs-tencentcloud-datasource-tsf_microservice" +description: |- + Use this data source to query detailed information of tsf microservice +--- + +# tencentcloud_tsf_microservice + +Use this data source to query detailed information of tsf microservice + +## Example Usage + +```hcl +data "tencentcloud_tsf_microservice" "microservice" { + namespace_id = var.namespace_id + # status = + microservice_id_list = ["ms-yq3jo6jd"] + microservice_name_list = ["provider-demo"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `namespace_id` - (Required, String) namespace id. +* `microservice_id_list` - (Optional, Set: [`String`]) microservice id list. +* `microservice_name_list` - (Optional, Set: [`String`]) List of service names for search. +* `result_output_file` - (Optional, String) Used to save results. +* `status` - (Optional, Set: [`String`]) status filter, online, offline, single_online. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Microservice paging list information. Note: This field may return null, indicating that no valid value can be obtained. + * `content` - Microservice list information. Note: This field may return null, indicating that no valid value can be obtained. + * `create_time` - CreationTime. Note: This field may return null, indicating that no valid values can be obtained. + * `critical_instance_count` - offline instance count. Note: This field may return null, indicating that no valid values can be obtained. + * `microservice_desc` - Microservice description. Note: This field may return null, indicating that no valid value can be obtained. + * `microservice_id` - Microservice Id. Note: This field may return null, indicating that no valid value can be obtained. + * `microservice_name` - Microservice name. Note: This field may return null, indicating that no valid value can be obtained. + * `namespace_id` - Namespace Id. Note: This field may return null, indicating that no valid values can be obtained. + * `run_instance_count` - run instance count in namespace. Note: This field may return null, indicating that no valid values can be obtained. + * `update_time` - last update time. Note: This field may return null, indicating that no valid values can be obtained. + * `total_count` - Microservice paging list information. Note: This field may return null, indicating that no valid value can be obtained. + + diff --git a/config/docs/d/tsf_microservice_api_version.html.markdown b/config/docs/d/tsf_microservice_api_version.html.markdown new file mode 100644 index 0000000..68df6a1 --- /dev/null +++ b/config/docs/d/tsf_microservice_api_version.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_microservice_api_version" +sidebar_current: "docs-tencentcloud-datasource-tsf_microservice_api_version" +description: |- + Use this data source to query detailed information of tsf microservice_api_version +--- + +# tencentcloud_tsf_microservice_api_version + +Use this data source to query detailed information of tsf microservice_api_version + +## Example Usage + +```hcl +data "tencentcloud_tsf_microservice_api_version" "microservice_api_version" { + microservice_id = "ms-yq3jo6jd" + path = "" + method = "get" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `microservice_id` - (Required, String) Microservice ID. +* `method` - (Optional, String) request method. +* `path` - (Optional, String) api path. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - api version list. + * `application_id` - Application ID. + * `application_name` - Application Name. + * `pkg_version` - application pkg version. + + diff --git a/config/docs/d/tsf_ms_api_list.html.markdown b/config/docs/d/tsf_ms_api_list.html.markdown new file mode 100644 index 0000000..0e95fc5 --- /dev/null +++ b/config/docs/d/tsf_ms_api_list.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_ms_api_list" +sidebar_current: "docs-tencentcloud-datasource-tsf_ms_api_list" +description: |- + Use this data source to query detailed information of tsf ms_api_list +--- + +# tencentcloud_tsf_ms_api_list + +Use this data source to query detailed information of tsf ms_api_list + +## Example Usage + +```hcl +data "tencentcloud_tsf_ms_api_list" "ms_api_list" { + microservice_id = "ms-yq3jo6jd" + search_word = "echo" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `microservice_id` - (Required, String) Microservice Id. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) search word, support service name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - result list. + * `content` - api list. + * `description` - Method description. Note: This field may return null, indicating that no valid value was found. + * `method` - api method. + * `path` - api path. + * `status` - API status. 0: offline, 1: online.Note: This field may return null, indicating that no valid value was found. + * `total_count` - Quantity. + + diff --git a/config/docs/d/tsf_pod_instances.html.markdown b/config/docs/d/tsf_pod_instances.html.markdown new file mode 100644 index 0000000..9f20192 --- /dev/null +++ b/config/docs/d/tsf_pod_instances.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_pod_instances" +sidebar_current: "docs-tencentcloud-datasource-tsf_pod_instances" +description: |- + Use this data source to query detailed information of tsf pod_instances +--- + +# tencentcloud_tsf_pod_instances + +Use this data source to query detailed information of tsf pod_instances + +## Example Usage + +```hcl +data "tencentcloud_tsf_pod_instances" "pod_instances" { + group_id = "group-ynd95rea" + pod_name_list = ["keep-terraform-6f8f977688-zvphm"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String) Instance&#39;s group ID. +* `pod_name_list` - (Optional, Set: [`String`]) Filter, pod name list. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - pod instance list. + * `content` - Content list.Note: This field may return null, which means no valid value was found. + * `created_at` - Instance start time.Note: This field may return null, which means no valid value was found. + * `instance_available_status` - Instance available status.Note: This field may return null, which means no valid value was found. + * `instance_status` - Instance status.Note: This field may return null, which means no valid value was found. + * `ip` - Instance ip.Note: This field may return null, which means no valid value was found. + * `node_instance_id` - Instance node id.Note: This field may return null, which means no valid value was found. + * `node_ip` - Instance node ip.Note: This field may return null, which means no valid value was found. + * `pod_id` - Instance id (corresponding to the pod instance id in Kubernetes).Note: This field may return null, which means no valid value was found. + * `pod_name` - Instance name (corresponding to the pod name in Kubernetes).Note: This field may return null, which means no valid value was found. + * `ready_count` - Instance ready count.Note: This field may return null, which means no valid value was found. + * `reason` - Instance reason for current status.Note: This field may return null, which means no valid value was found. + * `restart_count` - Instance restart count.Note: This field may return null, which means no valid value was found. + * `runtime` - Instance run time.Note: This field may return null, which means no valid value was found. + * `service_instance_status` - Instance serve status.Note: This field may return null, which means no valid value was found. + * `status` - Instance status. Please refer to the definition of instance and container status below. Starting (pod not ready): Starting; Running: Running; Abnormal: Abnormal; Stopped: Stopped;Note: This field may return null, which means no valid value was found. + * `total_count` - Total number of records.Note: This field may return null, which means no valid value was found. + + diff --git a/config/docs/d/tsf_public_config_summary.html.markdown b/config/docs/d/tsf_public_config_summary.html.markdown new file mode 100644 index 0000000..59355ef --- /dev/null +++ b/config/docs/d/tsf_public_config_summary.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_public_config_summary" +sidebar_current: "docs-tencentcloud-datasource-tsf_public_config_summary" +description: |- + Use this data source to query detailed information of tsf public_config_summary +--- + +# tencentcloud_tsf_public_config_summary + +Use this data source to query detailed information of tsf public_config_summary + +## Example Usage + +```hcl +data "tencentcloud_tsf_describe_public_config_summary" "describe_public_config_summary" { + search_word = "test" + order_by = "last_update_time" + order_type = 0 + # config_tag_list = [""] + disable_program_auth_check = true + config_id_list = ["dcfg-p-ygbdw5mv"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_id_list` - (Optional, Set: [`String`]) Config Id List. +* `config_tag_list` - (Optional, Set: [`String`]) config tag list. +* `disable_program_auth_check` - (Optional, Bool) Whether to disable dataset authentication. +* `order_by` - (Optional, String) Sort by time: creation_time; Sort by name: config_name. +* `order_type` - (Optional, Int) Pass 0 for ascending order and 1 for descending order. +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) Query keyword for fuzzy search: configuration item name. If not passed in, the full set will be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Public config Page Item. + * `content` - config list. + * `application_id` - Application ID.Note: This field may return null, indicating that no valid value was found. + * `application_name` - Application Name. Note: This field may return null, indicating that no valid value was found. + * `config_id` - Configuration item ID.Note: This field may return null, indicating that no valid value was found. + * `config_name` - Configuration name.Note: This field may return null, indicating that no valid value was found. + * `config_type` - Config type. Note: This field may return null, indicating that no valid value was found. + * `config_value` - Configuration value.Note: This field may return null, indicating that no valid value was found. + * `config_version_count` - Configure version count.Note: This field may return null, indicating that no valid value was found. + * `config_version_desc` - Configuration version description.Note: This field may return null, indicating that no valid value was found. + * `config_version` - Configuration version. Note: This field may return null, indicating that no valid value was found. + * `creation_time` - Create time.Note: This field may return null, indicating that no valid value was found. + * `delete_flag` - Deletion flag, true: deletable; false: not deletable.Note: This field may return null, indicating that no valid value was found. + * `last_update_time` - Last update time.Note: This field may return null, indicating that no valid value was found. + * `total_count` - total count. + + diff --git a/config/docs/d/tsf_repository.html.markdown b/config/docs/d/tsf_repository.html.markdown new file mode 100644 index 0000000..ea733df --- /dev/null +++ b/config/docs/d/tsf_repository.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_repository" +sidebar_current: "docs-tencentcloud-datasource-tsf_repository" +description: |- + Use this data source to query detailed information of tsf repository +--- + +# tencentcloud_tsf_repository + +Use this data source to query detailed information of tsf repository + +## Example Usage + +```hcl +data "tencentcloud_tsf_repository" "repository" { + search_word = "test" + repository_type = "default" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `repository_type` - (Optional, String) Repository type (default Repository: default, private Repository: private). +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) Query keywords (search by Repository name). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - A list of Repository information that meets the query criteria. + * `content` - Repository information list. Note: This field may return null, indicating that no valid value can be obtained. + * `bucket_name` - Repository bucket name. Note: This field may return null, indicating that no valid value can be obtained. + * `bucket_region` - Repository region. Note: This field may return null, indicating that no valid value can be obtained. + * `create_time` - CreationTime. Note: This field may return null, indicating that no valid values can be obtained. + * `directory` - Repository Directory. Note: This field may return null, indicating that no valid value can be obtained. + * `is_used` - Whether the repository is being used. Note: This field may return null, indicating that no valid value can be obtained. + * `repository_desc` - Repository description (default warehouse: default, private warehouse: private). + * `repository_id` - repository Id. + * `repository_name` - Repository Name. + * `repository_type` - Repository type (default Repository: default, private Repository: private). + * `total_count` - Total Repository. + + diff --git a/config/docs/d/tsf_unit_rules.html.markdown b/config/docs/d/tsf_unit_rules.html.markdown new file mode 100644 index 0000000..8c51764 --- /dev/null +++ b/config/docs/d/tsf_unit_rules.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_unit_rules" +sidebar_current: "docs-tencentcloud-datasource-tsf_unit_rules" +description: |- + Use this data source to query detailed information of tsf unit_rules +--- + +# tencentcloud_tsf_unit_rules + +Use this data source to query detailed information of tsf unit_rules + +## Example Usage + +```hcl +data "tencentcloud_tsf_unit_rules" "unit_rules" { + gateway_instance_id = "gw-ins-lvdypq5k" + status = "disabled" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_instance_id` - (Required, String) gateway instance id. +* `result_output_file` - (Optional, String) Used to save results. +* `status` - (Optional, String) Enabled state, disabled: unpublished, enabled: published. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - Pagination list information. + * `content` - record entity list. + * `created_time` - created time. + * `description` - Rule description. + * `gateway_instance_id` - Gateway Entity ID. + * `id` - rule ID. + * `name` - rule name. + * `status` - Use status: enabled/disabled. + * `unit_rule_item_list` - list of rule items. + * `description` - Rule description. + * `dest_namespace_id` - Destination Namespace ID. + * `dest_namespace_name` - destination namespace name. + * `id` - rule item ID. + * `name` - rule item name. + * `priority` - Rule order, the smaller the higher the priority: the default is 0. + * `relationship` - Logical relationship: AND/OR. + * `unit_rule_id` - Unitization rule ID. + * `unit_rule_tag_list` - List of rule labels. + * `id` - rule ID. + * `tag_field` - tag name. + * `tag_operator` - Operator: IN/NOT_IN/EQUAL/NOT_EQUAL/REGEX. + * `tag_type` - Tag Type: U(User Tag). + * `tag_value` - tag value. + * `unit_rule_item_id` - Unitization rule item ID. + * `updated_time` - Updated time. + * `total_count` - total number of records. + + diff --git a/config/docs/d/tsf_usable_unit_namespaces.html.markdown b/config/docs/d/tsf_usable_unit_namespaces.html.markdown new file mode 100644 index 0000000..4f1ca23 --- /dev/null +++ b/config/docs/d/tsf_usable_unit_namespaces.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_usable_unit_namespaces" +sidebar_current: "docs-tencentcloud-datasource-tsf_usable_unit_namespaces" +description: |- + Use this data source to query detailed information of tsf usable_unit_namespaces +--- + +# tencentcloud_tsf_usable_unit_namespaces + +Use this data source to query detailed information of tsf usable_unit_namespaces + +## Example Usage + +```hcl +data "tencentcloud_tsf_usable_unit_namespaces" "usable_unit_namespaces" { + search_word = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. +* `search_word` - (Optional, String) search by namespace id or namespace Name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `result` - namespace object list. + * `content` - namespace list. + * `created_time` - Create time. Note: This field may return null, indicating that no valid value was found. + * `gateway_instance_id` - Gateway instance id Note: This field may return null, indicating that no valid value was found. + * `id` - Unit namespace ID. Note: This field may return null, indicating that no valid value was found. + * `namespace_id` - namespace id. + * `namespace_name` - namespace name. + * `updated_time` - Update time. Note: This field may return null, indicating that no valid value was found. + * `total_count` - total count. + + diff --git a/config/docs/d/user_info.html.markdown b/config/docs/d/user_info.html.markdown new file mode 100644 index 0000000..ff6b9dc --- /dev/null +++ b/config/docs/d/user_info.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_user_info" +sidebar_current: "docs-tencentcloud-datasource-user_info" +description: |- + Use this data source to query user appid, uin and ownerUin. +--- + +# tencentcloud_user_info + +Use this data source to query user appid, uin and ownerUin. + +## Example Usage + +```hcl +data "tencentcloud_user_info" "foo" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used for save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `app_id` - Current account App ID. +* `name` - Current account Name. NOTE: only support subaccount. +* `owner_uin` - Current account OwnerUIN. +* `uin` - Current account UIN. + + diff --git a/config/docs/d/vod_adaptive_dynamic_streaming_templates.html.markdown b/config/docs/d/vod_adaptive_dynamic_streaming_templates.html.markdown new file mode 100644 index 0000000..c161b4c --- /dev/null +++ b/config/docs/d/vod_adaptive_dynamic_streaming_templates.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "Video on Demand(VOD)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vod_adaptive_dynamic_streaming_templates" +sidebar_current: "docs-tencentcloud-datasource-vod_adaptive_dynamic_streaming_templates" +description: |- + Use this data source to query detailed information of VOD adaptive dynamic streaming templates. +--- + +# tencentcloud_vod_adaptive_dynamic_streaming_templates + +Use this data source to query detailed information of VOD adaptive dynamic streaming templates. + +## Example Usage + +```hcl +resource "tencentcloud_vod_adaptive_dynamic_streaming_template" "foo" { + format = "HLS" + name = "tf-adaptive" + drm_type = "SimpleAES" + disable_higher_video_bitrate = false + disable_higher_video_resolution = false + comment = "test" + + stream_info { + video { + codec = "libx265" + fps = 4 + bitrate = 129 + resolution_adaptive = false + width = 128 + height = 128 + fill_type = "stretch" + } + audio { + codec = "libmp3lame" + bitrate = 129 + sample_rate = 44100 + audio_channel = "dual" + } + remove_audio = false + } + stream_info { + video { + codec = "libx264" + fps = 4 + bitrate = 256 + } + audio { + codec = "libfdk_aac" + bitrate = 256 + sample_rate = 44100 + } + remove_audio = true + } +} + +data "tencentcloud_vod_adaptive_dynamic_streaming_templates" "foo" { + type = "Custom" + definition = tencentcloud_vod_adaptive_dynamic_streaming_template.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `definition` - (Optional, String) Unique ID filter of adaptive dynamic streaming template. +* `result_output_file` - (Optional, String) Used to save results. +* `sub_app_id` - (Optional, Int) Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. +* `type` - (Optional, String) Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `template_list` - A list of adaptive dynamic streaming templates. Each element contains the following attributes: + * `comment` - Template description. + * `create_time` - Creation time of template in ISO date format. + * `definition` - Unique ID of adaptive dynamic streaming template. + * `disable_higher_video_bitrate` - Whether to prohibit transcoding video from low bitrate to high bitrate. `false`: no, `true`: yes. + * `disable_higher_video_resolution` - Whether to prohibit transcoding from low resolution to high resolution. `false`: no, `true`: yes. + * `drm_type` - DRM scheme type. + * `format` - Adaptive bitstream format. + * `name` - Template name. + * `stream_info` - List of AdaptiveStreamTemplate parameter information of output substream for adaptive bitrate streaming. + * `audio` - Audio parameter information. + * `audio_channel` - Audio channel system. Valid values: mono, dual, stereo. + * `bitrate` - Audio stream bitrate in Kbps. Value range: `0` and `[26, 256]`. If the value is `0`, the bitrate of the audio stream will be the same as that of the original audio. + * `codec` - Audio stream encoder. Valid value are: `libfdk_aac` and `libmp3lame`. + * `sample_rate` - Audio stream sample rate. Valid values: `32000`, `44100`, `48000`. Unit is HZ. + * `remove_audio` - Whether to remove audio stream. `false`: no, `true`: yes. + * `video` - Video parameter information. + * `bitrate` - Bitrate of video stream in Kbps. Value range: `0` and `[128, 35000]`. If the value is `0`, the bitrate of the video will be the same as that of the source video. + * `codec` - Video stream encoder. Valid values: `libx264`, `libx265`, `av1`.`libx264`: H.264, `libx265`: H.265, `av1`: AOMedia Video 1. Currently, a resolution within 640x480 must be specified for `H.265`. and the `av1` container only supports mp4. + * `fill_type` - Fill type. Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: `stretch`: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; `black`: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Note: this field may return null, indicating that no valid values can be obtained. + * `fps` - Video frame rate in Hz. Value range: `[0, 60]`. If the value is `0`, the frame rate will be the same as that of the source video. + * `height` - Maximum value of the height (or short side) of a video stream in px. Value range: `0` and `[128, 4096]`. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, `width` will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. Note: this field may return null, indicating that no valid values can be obtained. + * `resolution_adaptive` - Resolution adaption. Valid values: `true`,`false`. `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height. Note: this field may return null, indicating that no valid values can be obtained. + * `width` - Maximum value of the width (or long side) of a video stream in px. Value range: `0` and `[128, 4096]`. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, `width` will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. Note: this field may return null, indicating that no valid values can be obtained. + * `type` - Template type filter. Valid values: `Preset`,`Custom`. `Preset`: preset template; `Custom`: custom template. + * `update_time` - Last modified time of template in ISO date format. + + diff --git a/config/docs/d/vod_image_sprite_templates.html.markdown b/config/docs/d/vod_image_sprite_templates.html.markdown new file mode 100644 index 0000000..7420325 --- /dev/null +++ b/config/docs/d/vod_image_sprite_templates.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "Video on Demand(VOD)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vod_image_sprite_templates" +sidebar_current: "docs-tencentcloud-datasource-vod_image_sprite_templates" +description: |- + Use this data source to query detailed information of VOD image sprite templates. +--- + +# tencentcloud_vod_image_sprite_templates + +Use this data source to query detailed information of VOD image sprite templates. + +## Example Usage + +```hcl +resource "tencentcloud_vod_image_sprite_template" "foo" { + sample_type = "Percent" + sample_interval = 10 + row_count = 3 + column_count = 3 + name = "tf-sprite" + comment = "test" + fill_type = "stretch" + width = 128 + height = 128 + resolution_adaptive = false +} + +data "tencentcloud_vod_image_sprite_templates" "foo" { + type = "Custom" + definition = tencentcloud_vod_image_sprite_template.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `definition` - (Optional, String) Unique ID filter of image sprite template. +* `result_output_file` - (Optional, String) Used to save results. +* `sub_app_id` - (Optional, Int) Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. +* `type` - (Optional, String) Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `template_list` - A list of image sprite templates. Each element contains the following attributes: + * `column_count` - Subimage column count of an image sprite. + * `comment` - Template description. + * `create_time` - Creation time of template in ISO date format. + * `definition` - Unique ID of image sprite template. + * `fill_type` - Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: `stretch`: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; `black`: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. + * `height` - Maximum value of the `height` (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, `width` will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. + * `name` - Name of a time point screen capturing template. + * `resolution_adaptive` - Resolution adaption. Valid values: `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height. + * `row_count` - Subimage row count of an image sprite. + * `sample_interval` - Sampling interval. If `sample_type` is `Percent`, sampling will be performed at an interval of the specified percentage. If `sample_type` is `Time`, sampling will be performed at the specified time interval in seconds. + * `sample_type` - Sampling type. Valid values: `Percent`, `Time`. `Percent`: by percent. `Time`: by time interval. + * `type` - Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template. + * `update_time` - Last modified time of template in ISO date format. + * `width` - Maximum value of the `width` (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, width will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. + + diff --git a/config/docs/d/vod_procedure_templates.html.markdown b/config/docs/d/vod_procedure_templates.html.markdown new file mode 100644 index 0000000..b7c0f23 --- /dev/null +++ b/config/docs/d/vod_procedure_templates.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "Video on Demand(VOD)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vod_procedure_templates" +sidebar_current: "docs-tencentcloud-datasource-vod_procedure_templates" +description: |- + Use this data source to query detailed information of VOD procedure templates. +--- + +# tencentcloud_vod_procedure_templates + +Use this data source to query detailed information of VOD procedure templates. + +## Example Usage + +```hcl +resource "tencentcloud_vod_procedure_template" "foo" { + name = "tf-procedure" + comment = "test" + media_process_task { + adaptive_dynamic_streaming_task_list { + definition = tencentcloud_vod_adaptive_dynamic_streaming_template.foo.id + } + snapshot_by_time_offset_task_list { + definition = tencentcloud_vod_snapshot_by_time_offset_template.foo.id + ext_time_offset_list = [ + "3.5s" + ] + } + image_sprite_task_list { + definition = tencentcloud_vod_image_sprite_template.foo.id + } + } +} + +data "tencentcloud_vod_procedure_templates" "foo" { + type = "Custom" + name = tencentcloud_vod_procedure_template.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Optional, String) Name of procedure template. +* `result_output_file` - (Optional, String) Used to save results. +* `sub_app_id` - (Optional, Int) Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. +* `type` - (Optional, String) Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `template_list` - A list of adaptive dynamic streaming templates. Each element contains the following attributes: + * `comment` - Template description. + * `create_time` - Creation time of template in ISO date format. + * `media_process_task` - Parameter of video processing task. + * `adaptive_dynamic_streaming_task_list` - List of adaptive bitrate streaming tasks. Note: this field may return null, indicating that no valid values can be obtained. + * `definition` - Adaptive bitrate streaming template ID. + * `watermark_list` - List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained. + * `animated_graphic_task_list` - List of animated image generating tasks. Note: this field may return null, indicating that no valid values can be obtained. + * `definition` - Animated image generating template ID. + * `end_time_offset` - End time of animated image in video in seconds. + * `start_time_offset` - Start time of animated image in video in seconds. + * `cover_by_snapshot_task_list` - List of cover generating tasks. Note: this field may return null, indicating that no valid values can be obtained. + * `definition` - Time point screen capturing template ID. + * `position_type` - Screen capturing mode. Valid values: `Time`, `Percent`. `Time`: screen captures by time point, `Percent`: screen captures by percentage. + * `position_value` - Screenshot position: For time point screen capturing, this means to take a screenshot at a specified time point (in seconds) and use it as the cover. For percentage screen capturing, this value means to take a screenshot at a specified percentage of the video duration and use it as the cover. + * `watermark_list` - List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained. + * `image_sprite_task_list` - List of image sprite generating tasks. Note: this field may return null, indicating that no valid values can be obtained. + * `definition` - Image sprite generating template ID. + * `sample_snapshot_task_list` - List of sampled screen capturing tasks. Note: this field may return null, indicating that no valid values can be obtained. + * `definition` - Sampled screen capturing template ID. + * `watermark_list` - List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained. + * `snapshot_by_time_offset_task_list` - List of time point screen capturing tasks. Note: this field may return null, indicating that no valid values can be obtained. + * `definition` - Time point screen capturing template ID. + * `ext_time_offset_list` - The list of screenshot time points. `s` and `%` formats are supported: When a time point string ends with `s`, its unit is second. For example, `3.5s` means the 3.5th second of the video; When a time point string ends with `%`, it is marked with corresponding percentage of the video duration. For example, `10%` means that the time point is at the 10% of the video entire duration. + * `watermark_list` - List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained. + * `transcode_task_list` - List of transcoding tasks. Note: this field may return null, indicating that no valid values can be obtained. + * `definition` - Video transcoding template ID. + * `mosaic_list` - List of blurs. Up to 10 ones can be supported. + * `coordinate_origin` - Origin position, which currently can only be: `TopLeft`: the origin of coordinates is in the top-left corner of the video, and the origin of the blur is in the top-left corner of the image or text. + * `end_time_offset` - End time offset of blur in seconds. If this parameter is left empty or `0` is entered, the blur will exist till the last video frame; If this value is greater than `0` (e.g., n), the blur will exist till second n; If this value is smaller than `0` (e.g., -n), the blur will exist till second n before the last video frame. + * `height` - Blur height. `%` and `px` formats are supported: If the string ends in `%`, the `height` of the blur will be the specified percentage of the video height; for example, 10% means that Height is 10% of the video height; If the string ends in `px`, the `height` of the blur will be in px; for example, 100px means that Height is 100 px. + * `start_time_offset` - Start time offset of blur in seconds. If this parameter is left empty or `0` is entered, the blur will appear upon the first video frame. If this parameter is left empty or `0` is entered, the blur will appear upon the first video frame; If this value is greater than `0` (e.g., n), the blur will appear at second n after the first video frame; If this value is smaller than `0` (e.g., -n), the blur will appear at second n before the last video frame. + * `width` - Blur width. `%` and `px` formats are supported: If the string ends in `%`, the `width` of the blur will be the specified percentage of the video width; for example, 10% means that `width` is 10% of the video width; If the string ends in `px`, the `width` of the blur will be in px; for example, 100px means that Width is 100 px. + * `x_pos` - The horizontal position of the origin of the blur relative to the origin of coordinates of the video. `%` and `px` formats are supported: If the string ends in `%`, the XPos of the blur will be the specified percentage of the video width; for example, 10% means that XPos is 10% of the video width; If the string ends in `px`, the XPos of the blur will be the specified px; for example, 100px means that XPos is 100 px. + * `y_pos` - Vertical position of the origin of blur relative to the origin of coordinates of video. `%` and `px` formats are supported: If the string ends in `%`, the YPos of the blur will be the specified percentage of the video height; for example, 10% means that YPos is 10% of the video height; If the string ends in `px`, the YPos of the blur will be the specified px; for example, 100px means that YPos is 100 px. + * `watermark_list` - List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained. + * `name` - Task flow name. + * `type` - Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template. + * `update_time` - Last modified time of template in ISO date format. + + diff --git a/config/docs/d/vod_snapshot_by_time_offset_templates.html.markdown b/config/docs/d/vod_snapshot_by_time_offset_templates.html.markdown new file mode 100644 index 0000000..9ac8732 --- /dev/null +++ b/config/docs/d/vod_snapshot_by_time_offset_templates.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Video on Demand(VOD)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vod_snapshot_by_time_offset_templates" +sidebar_current: "docs-tencentcloud-datasource-vod_snapshot_by_time_offset_templates" +description: |- + Use this data source to query detailed information of VOD snapshot by time offset templates. +--- + +# tencentcloud_vod_snapshot_by_time_offset_templates + +Use this data source to query detailed information of VOD snapshot by time offset templates. + +## Example Usage + +```hcl +resource "tencentcloud_vod_snapshot_by_time_offset_template" "foo" { + name = "tf-snapshot" + width = 130 + height = 128 + resolution_adaptive = false + format = "png" + comment = "test" + fill_type = "white" +} + +data "tencentcloud_vod_snapshot_by_time_offset_templates" "foo" { + type = "Custom" + definition = tencentcloud_vod_snapshot_by_time_offset_template.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `definition` - (Optional, String) Unique ID filter of snapshot by time offset template. +* `result_output_file` - (Optional, String) Used to save results. +* `sub_app_id` - (Optional, Int) Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. +* `type` - (Optional, String) Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `template_list` - A list of snapshot by time offset templates. Each element contains the following attributes: + * `comment` - Template description. + * `create_time` - Creation time of template in ISO date format. + * `definition` - Unique ID of snapshot by time offset template. + * `fill_type` - Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: `stretch`: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot `shorter` or `longer`; `black`: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. `white`: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. `gauss`: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur. + * `format` - Image format. Valid values: `jpg`, `png`. + * `height` - Maximum value of the `height` (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, `width` will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. + * `name` - Name of a time point screen capturing template. + * `resolution_adaptive` - Resolution adaption. Valid values: `true`, `false`. `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height. + * `type` - Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template. + * `update_time` - Last modified time of template in ISO date format. + * `width` - Maximum value of the `width` (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, width will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. + + diff --git a/config/docs/d/vod_super_player_configs.html.markdown b/config/docs/d/vod_super_player_configs.html.markdown new file mode 100644 index 0000000..a9476f7 --- /dev/null +++ b/config/docs/d/vod_super_player_configs.html.markdown @@ -0,0 +1,73 @@ +--- +subcategory: "Video on Demand(VOD)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vod_super_player_configs" +sidebar_current: "docs-tencentcloud-datasource-vod_super_player_configs" +description: |- + Use this data source to query detailed information of VOD super player configs. +--- + +# tencentcloud_vod_super_player_configs + +Use this data source to query detailed information of VOD super player configs. + +## Example Usage + +```hcl +resource "tencentcloud_vod_super_player_config" "foo" { + name = "tf-super-player" + drm_switch = true + drm_streaming_info { + simple_aes_definition = tencentcloud_vod_adaptive_dynamic_streaming_template.foo.id + } + image_sprite_definition = tencentcloud_vod_image_sprite_template.foo.id + resolution_names { + min_edge_length = 889 + name = "test1" + } + resolution_names { + min_edge_length = 890 + name = "test2" + } + domain = "Default" + scheme = "Default" + comment = "test" +} + +data "tencentcloud_vod_super_player_configs" "foo" { + type = "Custom" + name = "tf-super-player" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Optional, String) Name of super player config. +* `result_output_file` - (Optional, String) Used to save results. +* `sub_app_id` - (Optional, Int) Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. +* `type` - (Optional, String) Config type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `config_list` - A list of super player configs. Each element contains the following attributes: + * `adaptive_dynamic_streaming_definition` - ID of the unencrypted adaptive bitrate streaming template that allows output, which is required if `drm_switch` is `false`. + * `comment` - Template description. + * `create_time` - Creation time of template in ISO date format. + * `domain` - Domain name used for playback. If it is left empty or set to `Default`, the domain name configured in [Default Distribution Configuration](https://cloud.tencent.com/document/product/266/33373) will be used. + * `drm_streaming_info` - Content of the DRM-protected adaptive bitrate streaming template that allows output, which is required if `drm_switch` is `true`. + * `simple_aes_definition` - ID of the adaptive dynamic streaming template whose protection type is `SimpleAES`. + * `drm_switch` - Switch of DRM-protected adaptive bitstream playback: `true`: enabled, indicating to play back only output adaptive bitstreams protected by DRM; `false`: disabled, indicating to play back unencrypted output adaptive bitstreams. + * `image_sprite_definition` - ID of the image sprite template that allows output. + * `name` - Player configuration name, which can contain up to 64 letters, digits, underscores, and hyphens (such as test_ABC-123) and must be unique under a user. + * `resolution_names` - Display name of player for substreams with different resolutions. If this parameter is left empty or an empty array, the default configuration will be used: `min_edge_length: 240, name: LD`; `min_edge_length: 480, name: SD`; `min_edge_length: 720, name: HD`; `min_edge_length: 1080, name: FHD`; `min_edge_length: 1440, name: 2K`; `min_edge_length: 2160, name: 4K`; `min_edge_length: 4320, name: 8K`. + * `min_edge_length` - Length of video short side in px. + * `name` - Display name. + * `scheme` - Scheme used for playback. If it is left empty or set to `Default`, the scheme configured in [Default Distribution Configuration](https://cloud.tencent.com/document/product/266/33373) will be used. Other valid values: `HTTP`; `HTTPS`. + * `type` - Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template. + * `update_time` - Last modified time of template in ISO date format. + + diff --git a/config/docs/d/vpc.html.markdown b/config/docs/d/vpc.html.markdown new file mode 100644 index 0000000..4a085c4 --- /dev/null +++ b/config/docs/d/vpc.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc" +sidebar_current: "docs-tencentcloud-datasource-vpc" +description: |- + Provides details about a specific VPC. +--- + +# tencentcloud_vpc + +Provides details about a specific VPC. + +This resource can prove useful when a module accepts a vpc id as an input variable and needs to, for example, determine the CIDR block of that VPC. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_vpc_instances. + +## Example Usage + +```hcl +variable "vpc_id" {} + +data "tencentcloud_vpc" "selected" { + id = var.vpc_id +} + +resource "tencentcloud_subnet" "main" { + name = "my test subnet" + cidr_block = cidrsubnet(data.tencentcloud_vpc.selected.cidr_block, 4, 1) + availability_zone = "eu-frankfurt-1" + vpc_id = data.tencentcloud_vpc.selected.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) The ID of the specific VPC to retrieve. +* `name` - (Optional, String) The name of the specific VPC to retrieve. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `cidr_block` - The CIDR block of the VPC. +* `is_default` - Whether or not the default VPC. +* `is_multicast` - Whether or not the VPC has Multicast support. + + diff --git a/config/docs/d/vpc_account_attributes.html.markdown b/config/docs/d/vpc_account_attributes.html.markdown new file mode 100644 index 0000000..ea2a571 --- /dev/null +++ b/config/docs/d/vpc_account_attributes.html.markdown @@ -0,0 +1,34 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_account_attributes" +sidebar_current: "docs-tencentcloud-datasource-vpc_account_attributes" +description: |- + Use this data source to query detailed information of vpc account_attributes +--- + +# tencentcloud_vpc_account_attributes + +Use this data source to query detailed information of vpc account_attributes + +## Example Usage + +```hcl +data "tencentcloud_vpc_account_attributes" "account_attributes" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `account_attribute_set` - User account attribute object. + * `attribute_name` - Attribute name. + * `attribute_values` - Attribute values. + + diff --git a/config/docs/d/vpc_acls.html.markdown b/config/docs/d/vpc_acls.html.markdown new file mode 100644 index 0000000..497e863 --- /dev/null +++ b/config/docs/d/vpc_acls.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_acls" +sidebar_current: "docs-tencentcloud-datasource-vpc_acls" +description: |- + Use this data source to query VPC Network ACL information. +--- + +# tencentcloud_vpc_acls + +Use this data source to query VPC Network ACL information. + +## Example Usage + +```hcl +data "tencentcloud_vpc_instances" "foo" { +} + +data "tencentcloud_vpc_acls" "foo" { + vpc_id = data.tencentcloud_vpc_instances.foo.instance_list.0.vpc_id +} + +data "tencentcloud_vpc_acls" "foo" { + name = "test_acl" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the network ACL instance. +* `name` - (Optional, String) Name of the network ACL. +* `result_output_file` - (Optional, String) Used to save results. +* `vpc_id` - (Optional, String) ID of the VPC instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `acl_list` - The information list of the VPC. Each element contains the following attributes: + * `create_time` - Creation time. + * `egress` - Outbound rules of the network ACL. + * `cidr_block` - An IP address network or segment. + * `description` - Rule description. + * `policy` - Rule policy of Network ACL. + * `port` - Range of the port. + * `protocol` - Type of IP protocol. + * `id` - ID of the network ACL instance. + * `ingress` - Inbound rules of the network ACL. + * `cidr_block` - An IP address network or segment. + * `description` - Rule description. + * `policy` - Rule policy of Network ACL. + * `port` - Range of the port. + * `protocol` - Type of IP protocol. + * `name` - Name of the network ACL. + * `subnets` - Subnets associated with the network ACL. + * `cidr_block` - The IPv4 CIDR of the subnet. + * `subnet_id` - Subnet instance ID. + * `subnet_name` - Subnet name. + * `tags` - Tags of the subnet. + * `vpc_id` - ID of the VPC instance. + * `vpc_id` - ID of the VPC instance. + + diff --git a/config/docs/d/vpc_bandwidth_package_bill_usage.html.markdown b/config/docs/d/vpc_bandwidth_package_bill_usage.html.markdown new file mode 100644 index 0000000..1cf23e2 --- /dev/null +++ b/config/docs/d/vpc_bandwidth_package_bill_usage.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_bandwidth_package_bill_usage" +sidebar_current: "docs-tencentcloud-datasource-vpc_bandwidth_package_bill_usage" +description: |- + Use this data source to query detailed information of vpc bandwidth_package_bill_usage +--- + +# tencentcloud_vpc_bandwidth_package_bill_usage + +Use this data source to query detailed information of vpc bandwidth_package_bill_usage + +## Example Usage + +```hcl +data "tencentcloud_vpc_bandwidth_package_bill_usage" "bandwidth_package_bill_usage" { + bandwidth_package_id = "bwp-234rfgt5" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bandwidth_package_id` - (Required, String) The unique ID of the postpaid bandwidth package. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `bandwidth_package_bill_bandwidth_set` - current billing amount. + * `bandwidth_usage` - Current billing amount in Mbps. + + diff --git a/config/docs/d/vpc_bandwidth_package_quota.html.markdown b/config/docs/d/vpc_bandwidth_package_quota.html.markdown new file mode 100644 index 0000000..770dc9a --- /dev/null +++ b/config/docs/d/vpc_bandwidth_package_quota.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_bandwidth_package_quota" +sidebar_current: "docs-tencentcloud-datasource-vpc_bandwidth_package_quota" +description: |- + Use this data source to query detailed information of vpc bandwidth_package_quota +--- + +# tencentcloud_vpc_bandwidth_package_quota + +Use this data source to query detailed information of vpc bandwidth_package_quota + +## Example Usage + +```hcl +data "tencentcloud_vpc_bandwidth_package_quota" "bandwidth_package_quota" { +} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `quota_set` - Bandwidth Package Quota Details. + * `quota_current` - current amount. + * `quota_id` - Quota type. + * `quota_limit` - quota amount. + + diff --git a/config/docs/d/vpc_classic_link_instances.html.markdown b/config/docs/d/vpc_classic_link_instances.html.markdown new file mode 100644 index 0000000..1a4bb5e --- /dev/null +++ b/config/docs/d/vpc_classic_link_instances.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_classic_link_instances" +sidebar_current: "docs-tencentcloud-datasource-vpc_classic_link_instances" +description: |- + Use this data source to query detailed information of vpc classic_link_instances +--- + +# tencentcloud_vpc_classic_link_instances + +Use this data source to query detailed information of vpc classic_link_instances + +## Example Usage + +```hcl +data "tencentcloud_vpc_classic_link_instances" "classic_link_instances" { + filters { + name = "vpc-id" + values = ["vpc-lh4nqig9"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter conditions.`vpc-id` - String - (Filter condition) The VPC instance ID. `vm-ip` - String - (Filter condition) The IP address of the CVM on the basic network. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) The attribute name. If more than one Filter exists, the logical relation between these Filters is `AND`. +* `values` - (Required, Set) The attribute value. If there are multiple Values for one Filter, the logical relation between these Values under the same Filter is `OR`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `classic_link_instance_set` - Classiclink instance. + * `instance_id` - The unique ID of the CVM instance. + * `vpc_id` - VPC instance ID. + + diff --git a/config/docs/d/vpc_cvm_instances.html.markdown b/config/docs/d/vpc_cvm_instances.html.markdown new file mode 100644 index 0000000..6ffc4cf --- /dev/null +++ b/config/docs/d/vpc_cvm_instances.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_cvm_instances" +sidebar_current: "docs-tencentcloud-datasource-vpc_cvm_instances" +description: |- + Use this data source to query detailed information of vpc cvm_instances +--- + +# tencentcloud_vpc_cvm_instances + +Use this data source to query detailed information of vpc cvm_instances + +## Example Usage + +```hcl +data "tencentcloud_vpc_cvm_instances" "cvm_instances" { + filters { + name = "vpc-id" + values = ["vpc-lh4nqig9"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Required, List) Filter condition. `RouteTableIds` and `Filters` cannot be specified at the same time. vpc-id - String - (Filter condition) VPC instance ID, such as `vpc-f49l6u0z`;instance-type - String - (Filter condition) CVM instance ID;instance-name - String - (Filter condition) CVM name. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) The attribute name. If more than one Filter exists, the logical relation between these Filters is `AND`. +* `values` - (Required, Set) Attribute value. If multiple values exist in one filter, the logical relationship between these values is `OR`. For a `bool` parameter, the valid values include `TRUE` and `FALSE`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_set` - List of CVM instances. + * `cpu` - Number of CPU cores in an instance (in core). + * `created_time` - The creation time. + * `eni_ip_limit` - Private IP quoata for instance ENIs (including primary ENIs). + * `eni_limit` - Instance ENI quota (including primary ENIs). + * `instance_eni_count` - The number of ENIs (including primary ENIs) bound to a instance. + * `instance_id` - CVM instance ID. + * `instance_name` - CVM Name. + * `instance_state` - CVM status. + * `instance_type` - Instance type. + * `memory` - Instance's memory capacity. Unit: GB. + * `subnet_id` - Subnet instance ID. + * `vpc_id` - VPC instance ID. + + diff --git a/config/docs/d/vpc_gateway_flow_monitor_detail.html.markdown b/config/docs/d/vpc_gateway_flow_monitor_detail.html.markdown new file mode 100644 index 0000000..61f8d76 --- /dev/null +++ b/config/docs/d/vpc_gateway_flow_monitor_detail.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_gateway_flow_monitor_detail" +sidebar_current: "docs-tencentcloud-datasource-vpc_gateway_flow_monitor_detail" +description: |- + Use this data source to query detailed information of vpc gateway_flow_monitor_detail +--- + +# tencentcloud_vpc_gateway_flow_monitor_detail + +Use this data source to query detailed information of vpc gateway_flow_monitor_detail + +## Example Usage + +```hcl +data "tencentcloud_vpc_gateway_flow_monitor_detail" "gateway_flow_monitor_detail" { + time_point = "2023-06-02 12:15:20" + vpn_id = "vpngw-gt8bianl" + order_field = "OutTraffic" + order_direction = "DESC" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `time_point` - (Required, String) The point in time. This indicates details of this minute will be queried. For example, in `2019-02-28 18:15:20`, details at `18:15` will be queried. +* `direct_connect_gateway_id` - (Optional, String) The instance ID of the Direct Connect gateway, such as `dcg-ltjahce6`. +* `nat_id` - (Optional, String) The instance ID of the NAT gateway, such as `nat-ltjahce6`. +* `order_direction` - (Optional, String) Order methods. Ascending: `ASC`, Descending: `DESC`. +* `order_field` - (Optional, String) The order field supports `InPkg`, `OutPkg`, `InTraffic`, and `OutTraffic`. +* `peering_connection_id` - (Optional, String) The instance ID of the peering connection, such as `pcx-ltjahce6`. +* `result_output_file` - (Optional, String) Used to save results. +* `vpn_id` - (Optional, String) The instance ID of the VPN gateway, such as `vpn-ltjahce6`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `gateway_flow_monitor_detail_set` - The gateway traffic monitoring details. + * `in_pkg` - Inbound packets. + * `in_traffic` - Inbound traffic, in Byte. + * `out_pkg` - Outbound packets. + * `out_traffic` - Outbound traffic, in Byte. + * `private_ip_address` - Origin `IP`. + + diff --git a/config/docs/d/vpc_gateway_flow_qos.html.markdown b/config/docs/d/vpc_gateway_flow_qos.html.markdown new file mode 100644 index 0000000..b87c8b1 --- /dev/null +++ b/config/docs/d/vpc_gateway_flow_qos.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_gateway_flow_qos" +sidebar_current: "docs-tencentcloud-datasource-vpc_gateway_flow_qos" +description: |- + Use this data source to query detailed information of vpc gateway_flow_qos +--- + +# tencentcloud_vpc_gateway_flow_qos + +Use this data source to query detailed information of vpc gateway_flow_qos + +## Example Usage + +```hcl +data "tencentcloud_vpc_gateway_flow_qos" "gateway_flow_qos" { + gateway_id = "vpngw-gt8bianl" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) Network instance ID, the network instance types we currently support are:Private line gateway instance ID, in the form of `dcg-ltjahce6`;Nat gateway instance ID, in the form of `nat-ltjahce6`;VPN gateway instance ID, in the form of `vpn-ltjahce6`. +* `ip_addresses` - (Optional, Set: [`String`]) Intranet IP of the cloud server with traffic limitation. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `gateway_qos_set` - instance detail list. + * `bandwidth` - bandwidth value. + * `create_time` - create time. + * `ip_address` - cvm ip address. + * `vpc_id` - vpc id. + + diff --git a/config/docs/d/vpc_instances.html.markdown b/config/docs/d/vpc_instances.html.markdown new file mode 100644 index 0000000..30ba5b2 --- /dev/null +++ b/config/docs/d/vpc_instances.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_instances" +sidebar_current: "docs-tencentcloud-datasource-vpc_instances" +description: |- + Use this data source to query vpc instances' information. +--- + +# tencentcloud_vpc_instances + +Use this data source to query vpc instances' information. + +## Example Usage + +```hcl +resource "tencentcloud_vpc" "foo" { + name = "guagua_vpc_instance_test" + cidr_block = "10.0.0.0/16" +} + +data "tencentcloud_vpc_instances" "id_instances" { + vpc_id = tencentcloud_vpc.foo.id +} + +data "tencentcloud_vpc_instances" "name_instances" { + name = tencentcloud_vpc.foo.name +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cidr_block` - (Optional, String) Filter VPC with this CIDR. +* `is_default` - (Optional, Bool) Filter default or no default VPC. +* `name` - (Optional, String) Name of the VPC to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `tag_key` - (Optional, String) Filter if VPC has this tag. +* `tags` - (Optional, Map) Tags of the VPC to be queried. +* `vpc_id` - (Optional, String) ID of the VPC to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - The information list of the VPC. + * `cidr_block` - A network address block of a VPC CIDR. + * `create_time` - Creation time of VPC. + * `dns_servers` - A list of DNS servers which can be used within the VPC. + * `is_default` - Indicates whether it is the default VPC for this region. + * `is_multicast` - Indicates whether VPC multicast is enabled. + * `name` - Name of the VPC. + * `subnet_ids` - A ID list of subnets within this VPC. + * `tags` - Tags of the VPC. + * `vpc_id` - ID of the VPC. + + diff --git a/config/docs/d/vpc_limits.html.markdown b/config/docs/d/vpc_limits.html.markdown new file mode 100644 index 0000000..ce8ed47 --- /dev/null +++ b/config/docs/d/vpc_limits.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_limits" +sidebar_current: "docs-tencentcloud-datasource-vpc_limits" +description: |- + Use this data source to query detailed information of vpc limits +--- + +# tencentcloud_vpc_limits + +Use this data source to query detailed information of vpc limits + +## Example Usage + +```hcl +data "tencentcloud_vpc_limits" "limits" { + limit_types = ["appid-max-vpcs", "vpc-max-subnets"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `limit_types` - (Required, Set: [`String`]) Quota name. A maximum of 100 quota types can be queried each time. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `vpc_limit_set` - vpc limit. + * `limit_type` - type of vpc limit. + * `limit_value` - value of vpc limit. + + diff --git a/config/docs/d/vpc_net_detect_state_check.html.markdown b/config/docs/d/vpc_net_detect_state_check.html.markdown new file mode 100644 index 0000000..a06b864 --- /dev/null +++ b/config/docs/d/vpc_net_detect_state_check.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_net_detect_state_check" +sidebar_current: "docs-tencentcloud-datasource-vpc_net_detect_state_check" +description: |- + Use this data source to query detailed information of vpc net_detect_state_check +--- + +# tencentcloud_vpc_net_detect_state_check + +Use this data source to query detailed information of vpc net_detect_state_check + +## Example Usage + +```hcl +data "tencentcloud_vpc_net_detect_state_check" "net_detect_state_check" { + net_detect_id = "netd-12345678" + detect_destination_ip = [ + "10.0.0.3", + "10.0.0.2" + ] + next_hop_type = "NORMAL_CVM" + next_hop_destination = "10.0.0.4" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `detect_destination_ip` - (Required, Set: [`String`]) The array of detection destination IPv4 addresses, which contains at most two IP addresses. +* `next_hop_destination` - (Required, String) The next-hop destination gateway. The value is related to NextHopType.If NextHopType is set to VPN, the value of this parameter is the VPN gateway ID, such as vpngw-12345678.If NextHopType is set to DIRECTCONNECT, the value of this parameter is the direct connect gateway ID, such as dcg-12345678.If NextHopType is set to PEERCONNECTION, the value of this parameter is the peering connection ID, such as pcx-12345678.If NextHopType is set to NAT, the value of this parameter is the NAT gateway ID, such as nat-12345678.If NextHopType is set to NORMAL_CVM, the value of this parameter is the IPv4 address of the CVM, such as 10.0.0.12. +* `next_hop_type` - (Required, String) The type of the next hop. Currently supported types are:VPN: VPN gateway;DIRECTCONNECT: direct connect gateway;PEERCONNECTION: peering connection;NAT: NAT gateway;NORMAL_CVM: normal CVM. +* `net_detect_id` - (Optional, String) ID of a network inspector instance, e.g. netd-12345678. Enter at least one of this parameter, VpcId, SubnetId, and NetDetectName. Use NetDetectId if it is present. +* `net_detect_name` - (Optional, String) The name of a network inspector, up to 60 bytes in length. It is used together with VpcId and NetDetectName. You should enter either this parameter or NetDetectId, or both. Use NetDetectId if it is present. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) ID of a subnet instance, e.g. `subnet-12345678`, which is used together with VpcId and NetDetectName. You should enter either this parameter or NetDetectId, or both. Use NetDetectId if it is present. +* `vpc_id` - (Optional, String) ID of a `VPC` instance, e.g. `vpc-12345678`, which is used together with SubnetId and NetDetectName. You should enter either this parameter or NetDetectId, or both. Use NetDetectId if it is present. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `net_detect_ip_state_set` - The array of network detection verification results. + * `delay` - The latency. Unit: ms. + * `detect_destination_ip` - The destination IPv4 address of network detection. + * `packet_loss_rate` - The packet loss rate. + * `state` - The detection result.0: successful;-1: no packet loss occurred during routing;-2: packet loss occurred when outbound traffic is blocked by the ACL;-3: packet loss occurred when inbound traffic is blocked by the ACL;-4: other errors. + + diff --git a/config/docs/d/vpc_net_detect_states.html.markdown b/config/docs/d/vpc_net_detect_states.html.markdown new file mode 100644 index 0000000..c4fbb79 --- /dev/null +++ b/config/docs/d/vpc_net_detect_states.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_net_detect_states" +sidebar_current: "docs-tencentcloud-datasource-vpc_net_detect_states" +description: |- + Use this data source to query detailed information of vpc net_detect_states +--- + +# tencentcloud_vpc_net_detect_states + +Use this data source to query detailed information of vpc net_detect_states + +## Example Usage + +```hcl +data "tencentcloud_vpc_net_detect_states" "net_detect_states" { + net_detect_ids = ["netd-12345678"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filter conditions. `NetDetectIds` and `Filters` cannot be specified at the same time.net-detect-id - String - (Filter condition) The network detection instance ID, such as netd-12345678. +* `net_detect_ids` - (Optional, Set: [`String`]) The array of network detection instance `IDs`, such as [`netd-12345678`]. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Required, String) The attribute name. If more than one Filter exists, the logical relation between these Filters is `AND`. +* `values` - (Required, Set) Attribute value. If multiple values exist in one filter, the logical relationship between these values is `OR`. For a `bool` parameter, the valid values include `TRUE` and `FALSE`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `net_detect_state_set` - The array of network detection verification results that meet requirements.Note: This field may return null, indicating that no valid values can be obtained. + * `net_detect_id` - The ID of a network detection instance, such as netd-12345678. + * `net_detect_ip_state_set` - The array of network detection destination IP verification results. + * `delay` - The latency. Unit: ms. + * `detect_destination_ip` - The destination IPv4 address of network detection. + * `packet_loss_rate` - The packet loss rate. + * `state` - The detection result.0: successful;-1: no packet loss occurred during routing;-2: packet loss occurred when outbound traffic is blocked by the ACL;-3: packet loss occurred when inbound traffic is blocked by the ACL;-4: other errors. + + diff --git a/config/docs/d/vpc_network_interface_limit.html.markdown b/config/docs/d/vpc_network_interface_limit.html.markdown new file mode 100644 index 0000000..ae1b746 --- /dev/null +++ b/config/docs/d/vpc_network_interface_limit.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_network_interface_limit" +sidebar_current: "docs-tencentcloud-datasource-vpc_network_interface_limit" +description: |- + Use this data source to query detailed information of vpc network_interface_limit +--- + +# tencentcloud_vpc_network_interface_limit + +Use this data source to query detailed information of vpc network_interface_limit + +## Example Usage + +```hcl +data "tencentcloud_vpc_network_interface_limit" "network_interface_limit" { + instance_id = "ins-cr2rfq78" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) ID of a CVM instance or ENI to query. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `eni_private_ip_address_quantity` - Quota of IP addresses that can be allocated to each standard-mounted ENI. +* `eni_quantity` - Quota of ENIs mounted to a CVM instance in a standard way. +* `extend_eni_private_ip_address_quantity` - Quota of IP addresses that can be allocated to each extension-mounted ENI.Note: this field may return `null`, indicating that no valid values can be obtained. +* `extend_eni_quantity` - Quota of ENIs mounted to a CVM instance as an extensionNote: this field may return `null`, indicating that no valid values can be obtained. +* `sub_eni_private_ip_address_quantity` - The quota of IPs that can be assigned to each relayed ENI.Note: This field may return `null`, indicating that no valid values can be obtained. +* `sub_eni_quantity` - The quota of relayed ENIsNote: This field may return `null`, indicating that no valid values can be obtained. + + diff --git a/config/docs/d/vpc_private_ip_addresses.html.markdown b/config/docs/d/vpc_private_ip_addresses.html.markdown new file mode 100644 index 0000000..25c58fa --- /dev/null +++ b/config/docs/d/vpc_private_ip_addresses.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_private_ip_addresses" +sidebar_current: "docs-tencentcloud-datasource-vpc_private_ip_addresses" +description: |- + Use this data source to query detailed information of vpc private_ip_addresses +--- + +# tencentcloud_vpc_private_ip_addresses + +Use this data source to query detailed information of vpc private_ip_addresses + +## Example Usage + +```hcl +data "tencentcloud_vpc_private_ip_addresses" "private_ip_addresses" { + vpc_id = "vpc-l0dw94uh" + private_ip_addresses = ["10.0.0.1"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `private_ip_addresses` - (Required, Set: [`String`]) The private `IP` address list. Each request supports a maximum of `10` batch querying. +* `vpc_id` - (Required, String) The `ID` of the `VPC`, such as `vpc-f49l6u0z`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `vpc_private_ip_address_set` - The list of private `IP` address information. + * `cidr_block` - The `CIDR` belonging to the subnet. + * `created_time` - `IP` application time. + * `private_ip_address_type` - Private `IP` type. + * `private_ip_address` - `VPC` private `IP`. + + diff --git a/config/docs/d/vpc_product_quota.html.markdown b/config/docs/d/vpc_product_quota.html.markdown new file mode 100644 index 0000000..b3f6cf1 --- /dev/null +++ b/config/docs/d/vpc_product_quota.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_product_quota" +sidebar_current: "docs-tencentcloud-datasource-vpc_product_quota" +description: |- + Use this data source to query detailed information of vpc product_quota +--- + +# tencentcloud_vpc_product_quota + +Use this data source to query detailed information of vpc product_quota + +## Example Usage + +```hcl +data "tencentcloud_vpc_product_quota" "product_quota" { + product = "vpc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `product` - (Required, String) The name of the network product to be queried. The products that can be queried are:vpc, ccn, vpn, dc, dfw, clb, eip. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `product_quota_set` - ProductQuota Array. + * `quota_current` - Current Quota. + * `quota_id` - Quota Id. + * `quota_limit` - Quota limit. + * `quota_name` - Quota name. + * `quota_region` - Quota region. + + diff --git a/config/docs/d/vpc_resource_dashboard.html.markdown b/config/docs/d/vpc_resource_dashboard.html.markdown new file mode 100644 index 0000000..68703b8 --- /dev/null +++ b/config/docs/d/vpc_resource_dashboard.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_resource_dashboard" +sidebar_current: "docs-tencentcloud-datasource-vpc_resource_dashboard" +description: |- + Use this data source to query detailed information of vpc resource_dashboard +--- + +# tencentcloud_vpc_resource_dashboard + +Use this data source to query detailed information of vpc resource_dashboard + +## Example Usage + +```hcl +data "tencentcloud_vpc_resource_dashboard" "resource_dashboard" { + vpc_ids = ["vpc-4owdpnwr"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `vpc_ids` - (Required, Set: [`String`]) Vpc instance ID, e.g. vpc-f1xjkw1b. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `resource_dashboard_set` - List of resource objects. + * `cdb` - Relational database. + * `cfs` - Cloud file storage - CFS. + * `ckafka` - Cloud Kafka (CKafka). + * `classic_link` - Classic link. + * `cmem` - TencentDB for Memcached. + * `cnas` - Cnas. + * `cts_db` - Cloud time series database. + * `cvm` - Cloud Virtual Machine. + * `cynos_db_mysql` - An enterprise-grade TencentDB - CynosDB for MySQL. + * `cynos_db_postgres` - Enterprise TencentDB - CynosDB for Postgres. + * `db_audit` - Cloud database audit. + * `dcdb` - A distributed cloud database - TencentDB for TDSQL. + * `dcg` - Direct Connect gateway. + * `elastic_search` - ElasticSearch Service. + * `emr` - EMR cluster. + * `flow_log` - Flow log. + * `greenplumn` - Snova data warehouse. + * `grocery` - Grocery. + * `hsm` - Data encryption service. + * `ip` - Total number of used IPs except for CVM IP, EIP and network probe IP. The three IP types will be independently counted. + * `itop` - Itop. + * `lb` - Load balancer. + * `maria_db` - TencentDB for MariaDB (TDSQL). + * `mongo_db` - TencentDB for MongoDB. + * `nas` - Network attached storage. + * `nat` - NAT gateway. + * `network_acl` - Network ACL. + * `network_detect` - Network probing. + * `oracle` - Oracle. + * `pcx` - Peering connection. + * `postgres` - TencentDB for PostgreSQL. + * `redis` - TencentDB for Redis. + * `route_table` - Route table. + * `seal` - SEAL. + * `sql_server` - TencentDB for SQL Server. + * `subnet_id` - Subnet instance ID, such as subnet-bthucmmy. + * `subnet` - Subnets. + * `t_baas` - Blockchain service. + * `tcaplus` - Game storage - Tcaplus. + * `ti_db` - HTAP database - TiDB. + * `vpc_id` - VPC instance ID, such as `vpc-bq4bzxpj`. + * `vpngw` - VPN gateway. + + diff --git a/config/docs/d/vpc_route_conflicts.html.markdown b/config/docs/d/vpc_route_conflicts.html.markdown new file mode 100644 index 0000000..30e5477 --- /dev/null +++ b/config/docs/d/vpc_route_conflicts.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_route_conflicts" +sidebar_current: "docs-tencentcloud-datasource-vpc_route_conflicts" +description: |- + Use this data source to query detailed information of vpc route_conflicts +--- + +# tencentcloud_vpc_route_conflicts + +Use this data source to query detailed information of vpc route_conflicts + +## Example Usage + +```hcl +data "tencentcloud_vpc_route_conflicts" "route_conflicts" { + route_table_id = "rtb-6xypllqe" + destination_cidr_blocks = ["172.18.111.0/24"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `destination_cidr_blocks` - (Required, Set: [`String`]) List of conflicting destinations to check for. +* `route_table_id` - (Required, String) Routing table instance ID, for example:rtb-azd4dt1c. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `route_conflict_set` - route conflict list. + * `conflict_set` - route conflict list. + * `created_time` - create time. + * `destination_cidr_block` - Destination Cidr Block, like 112.20.51.0/24. + * `destination_ipv6_cidr_block` - Destination of Ipv6 Cidr Block. + * `enabled` - if enabled. + * `gateway_id` - next hop id. + * `gateway_type` - next gateway type. + * `published_to_vbc` - if published To ccn. + * `route_description` - route description. + * `route_id` - route id. + * `route_item_id` - unique policy id. + * `route_table_id` - route table id. + * `route_type` - routr type. + * `destination_cidr_block` - destination cidr block. + * `route_table_id` - route table id. + + diff --git a/config/docs/d/vpc_route_tables.html.markdown b/config/docs/d/vpc_route_tables.html.markdown new file mode 100644 index 0000000..d67115a --- /dev/null +++ b/config/docs/d/vpc_route_tables.html.markdown @@ -0,0 +1,84 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_route_tables" +sidebar_current: "docs-tencentcloud-datasource-vpc_route_tables" +description: |- + Use this data source to query vpc route tables information. +--- + +# tencentcloud_vpc_route_tables + +Use this data source to query vpc route tables information. + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +resource "tencentcloud_vpc" "foo" { + name = "guagua-ci-temp-test" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_route_table" "route_table" { + vpc_id = tencentcloud_vpc.foo.id + name = "ci-temp-test-rt" + + tags = { + "test" = "test" + } +} + +data "tencentcloud_vpc_route_tables" "id_instances" { + route_table_id = tencentcloud_route_table.route_table.id +} + +data "tencentcloud_vpc_route_tables" "name_instances" { + name = tencentcloud_route_table.route_table.name +} + +data "tencentcloud_vpc_route_tables" "vpc_default_instance" { + vpc_id = tencentcloud_vpc.foo.id + association_main = true +} + +data "tencentcloud_vpc_route_tables" "tags_instances" { + tags = tencentcloud_route_table.route_table.tags +} +``` + +## Argument Reference + +The following arguments are supported: + +* `association_main` - (Optional, Bool) Filter the main routing table. +* `name` - (Optional, String) Name of the routing table to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `route_table_id` - (Optional, String) ID of the routing table to be queried. +* `tag_key` - (Optional, String) Filter if routing table has this tag. +* `tags` - (Optional, Map) Tags of the routing table to be queried. +* `vpc_id` - (Optional, String) ID of the VPC to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - The information list of the VPC route table. + * `create_time` - Creation time of the routing table. + * `is_default` - Indicates whether it is the default routing table. + * `name` - Name of the routing table. + * `route_entry_infos` - Detailed information of each entry of the route table. + * `description` - Description information user defined for a route table rule. + * `destination_cidr_block` - The destination address block. + * `next_hub` - ID of next-hop gateway. Note: when 'next_type' is EIP, GatewayId will fix the value `0`. + * `next_type` - Type of next-hop, and available values include `CVM`, `VPN`, `DIRECTCONNECT`, `PEERCONNECTION`, `SSLVPN`, `NAT`, `NORMAL_CVM`, `EIP` and `CCN`. + * `route_entry_id` - ID of a route table entry. + * `route_table_id` - ID of the routing table. + * `subnet_ids` - List of subnet IDs bound to the route table. + * `tags` - Tags of the routing table. + * `vpc_id` - ID of the VPC. + + diff --git a/config/docs/d/vpc_security_group_limits.html.markdown b/config/docs/d/vpc_security_group_limits.html.markdown new file mode 100644 index 0000000..545c13b --- /dev/null +++ b/config/docs/d/vpc_security_group_limits.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_security_group_limits" +sidebar_current: "docs-tencentcloud-datasource-vpc_security_group_limits" +description: |- + Use this data source to query detailed information of vpc security_group_limits +--- + +# tencentcloud_vpc_security_group_limits + +Use this data source to query detailed information of vpc security_group_limits + +## Example Usage + +```hcl +data "tencentcloud_vpc_security_group_limits" "security_group_limits" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `security_group_limit_set` - sg limit set. + * `instance_security_group_limit` - number of instances associated sg. + * `referred_security_group_limit` - number of sg can be referred. + * `security_group_extended_policy_limit` - number of sg extended policy. + * `security_group_instance_limit` - number of sg associated instances. + * `security_group_limit` - number of sg can be created. + * `security_group_policy_limit` - number of sg polciy can be created. + * `security_group_referred_cvm_and_eni_limit` - number of eni and cvm can be referred. + * `security_group_referred_svc_limit` - number of svc can be referred. + + diff --git a/config/docs/d/vpc_security_group_references.html.markdown b/config/docs/d/vpc_security_group_references.html.markdown new file mode 100644 index 0000000..2995ea3 --- /dev/null +++ b/config/docs/d/vpc_security_group_references.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_security_group_references" +sidebar_current: "docs-tencentcloud-datasource-vpc_security_group_references" +description: |- + Use this data source to query detailed information of vpc security_group_references +--- + +# tencentcloud_vpc_security_group_references + +Use this data source to query detailed information of vpc security_group_references + +## Example Usage + +```hcl +data "tencentcloud_vpc_security_group_references" "security_group_references" { + security_group_ids = ["sg-edmur627"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `security_group_ids` - (Required, Set: [`String`]) A set of security group instance IDs, e.g. [sg-12345678]. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `referred_security_group_set` - Referred security groups. + * `referred_security_group_ids` - IDs of all referred security group instances. + * `security_group_id` - Security group instance ID. + + diff --git a/config/docs/d/vpc_sg_snapshot_file_content.html.markdown b/config/docs/d/vpc_sg_snapshot_file_content.html.markdown new file mode 100644 index 0000000..b43b595 --- /dev/null +++ b/config/docs/d/vpc_sg_snapshot_file_content.html.markdown @@ -0,0 +1,73 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_sg_snapshot_file_content" +sidebar_current: "docs-tencentcloud-datasource-vpc_sg_snapshot_file_content" +description: |- + Use this data source to query detailed information of vpc sg_snapshot_file_content +--- + +# tencentcloud_vpc_sg_snapshot_file_content + +Use this data source to query detailed information of vpc sg_snapshot_file_content + +## Example Usage + +```hcl +data "tencentcloud_vpc_sg_snapshot_file_content" "sg_snapshot_file_content" { + snapshot_policy_id = "sspolicy-ebjofe71" + snapshot_file_id = "ssfile-017gepjxpr" + security_group_id = "sg-ntrgm89v" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `security_group_id` - (Required, String) Security group ID. +* `snapshot_file_id` - (Required, String) Snapshot file ID. +* `snapshot_policy_id` - (Required, String) Snapshot policy IDs. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `backup_data` - Backup data. + * `action` - ACCEPT or DROP. + * `address_template` - IP address ID or IP address group ID. + * `address_group_id` - The ID of the IP address group, such as `ipmg-2uw6ujo6`. + * `address_id` - The ID of the IP address, such as `ipm-2uw6ujo6`. + * `cidr_block` - Either `CidrBlock` or `Ipv6CidrBlock can be specified. Note that if `0.0.0.0/n` is entered, it is mapped to 0.0.0.0/0. + * `ipv6_cidr_block` - The CIDR block or IPv6 (mutually exclusive). + * `modify_time` - The last modification time of the security group. + * `policy_description` - Security group policy description. + * `policy_index` - The index number of security group rules, which dynamically changes with the rules. This parameter can be obtained via the `DescribeSecurityGroupPolicies` API and used with the `Version` field in the returned value of the API. + * `port` - Port (`all`, a single port, or a port range).Note: If the `Protocol` value is set to `ALL`, the `Port` value also needs to be set to `all`. + * `protocol` - Protocol. Valid values: TCP, UDP, ICMP, ICMPv6, ALL. + * `security_group_id` - The security group instance ID, such as `sg-ohuuioma`. + * `service_template` - Protocol port ID or protocol port group ID. ServiceTemplate and Protocol+Port are mutually exclusive. + * `service_group_id` - Protocol port group ID, such as `ppmg-f5n1f8da`. + * `service_id` - Protocol port ID, such as `ppm-f5n1f8da`. +* `backup_time` - Backup time. +* `instance_id` - Security group ID. +* `operator` - Operator. +* `original_data` - Original data. + * `action` - ACCEPT or DROP. + * `address_template` - IP address ID or IP address group ID. + * `address_group_id` - The ID of the IP address group, such as `ipmg-2uw6ujo6`. + * `address_id` - The ID of the IP address, such as `ipm-2uw6ujo6`. + * `cidr_block` - Either `CidrBlock` or `Ipv6CidrBlock can be specified. Note that if `0.0.0.0/n` is entered, it is mapped to 0.0.0.0/0. + * `ipv6_cidr_block` - The CIDR block or IPv6 (mutually exclusive). + * `modify_time` - The last modification time of the security group. + * `policy_description` - Security group policy description. + * `policy_index` - The index number of security group rules, which dynamically changes with the rules. This parameter can be obtained via the `DescribeSecurityGroupPolicies` API and used with the `Version` field in the returned value of the API. + * `port` - Port (`all`, a single port, or a port range).Note: If the `Protocol` value is set to `ALL`, the `Port` value also needs to be set to `all`. + * `protocol` - Protocol. Valid values: TCP, UDP, ICMP, ICMPv6, ALL. + * `security_group_id` - The security group instance ID, such as `sg-ohuuioma`. + * `service_template` - Protocol port ID or protocol port group ID. ServiceTemplate and Protocol+Port are mutually exclusive. + * `service_group_id` - Protocol port group ID, such as `ppmg-f5n1f8da`. + * `service_id` - Protocol port ID, such as `ppm-f5n1f8da`. + + diff --git a/config/docs/d/vpc_snapshot_files.html.markdown b/config/docs/d/vpc_snapshot_files.html.markdown new file mode 100644 index 0000000..93fae1a --- /dev/null +++ b/config/docs/d/vpc_snapshot_files.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_snapshot_files" +sidebar_current: "docs-tencentcloud-datasource-vpc_snapshot_files" +description: |- + Use this data source to query detailed information of vpc snapshot_files +--- + +# tencentcloud_vpc_snapshot_files + +Use this data source to query detailed information of vpc snapshot_files + +## Example Usage + +```hcl +data "tencentcloud_vpc_snapshot_files" "snapshot_files" { + business_type = "securitygroup" + instance_id = "sg-902tl7t7" + start_date = "2022-10-10 00:00:00" + end_date = "2023-10-30 19:00:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `business_type` - (Required, String) Business type, currently supports security group:securitygroup. +* `end_date` - (Required, String) End date in the format %Y-%m-%d %H:%M:%S. +* `instance_id` - (Required, String) InstanceId. +* `start_date` - (Required, String) Start date in the format %Y-%m-%d %H:%M:%S. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `snapshot_file_set` - snap shot file set. + * `backup_time` - backup time. + * `instance_id` - instance id. + * `operator` - Uin of operator. + * `snapshot_file_id` - snap shot file id. + * `snapshot_policy_id` - Snapshot Policy Id. + + diff --git a/config/docs/d/vpc_subnet_resource_dashboard.html.markdown b/config/docs/d/vpc_subnet_resource_dashboard.html.markdown new file mode 100644 index 0000000..fc64a5a --- /dev/null +++ b/config/docs/d/vpc_subnet_resource_dashboard.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_subnet_resource_dashboard" +sidebar_current: "docs-tencentcloud-datasource-vpc_subnet_resource_dashboard" +description: |- + Use this data source to query detailed information of vpc subnet_resource_dashboard +--- + +# tencentcloud_vpc_subnet_resource_dashboard + +Use this data source to query detailed information of vpc subnet_resource_dashboard + +## Example Usage + +```hcl +data "tencentcloud_vpc_subnet_resource_dashboard" "subnet_resource_dashboard" { + subnet_ids = ["subnet-i9tpf6hq"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `subnet_ids` - (Required, Set: [`String`]) Subnet instance ID, such as `subnet-f1xjkw1b`. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `resource_statistics_set` - Information of resources returned. + * `ip` - The total number of used IP addresses. + * `resource_statistics_item_set` - Information of associated resources. + * `resource_count` - Number of resources. + * `resource_name` - Resource name. + * `resource_type` - Resource type, such as CVM, ENI. + * `subnet_id` - Subnet instance ID, such as `subnet-bthucmmy`. + * `vpc_id` - VPC instance ID, such as vpc-f1xjkw1b. + + diff --git a/config/docs/d/vpc_subnets.html.markdown b/config/docs/d/vpc_subnets.html.markdown new file mode 100644 index 0000000..e2969ba --- /dev/null +++ b/config/docs/d/vpc_subnets.html.markdown @@ -0,0 +1,83 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_subnets" +sidebar_current: "docs-tencentcloud-datasource-vpc_subnets" +description: |- + Use this data source to query vpc subnets information. +--- + +# tencentcloud_vpc_subnets + +Use this data source to query vpc subnets information. + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +resource "tencentcloud_vpc" "foo" { + name = "guagua_vpc_instance_test" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = var.availability_zone + name = "guagua_vpc_subnet_test" + vpc_id = tencentcloud_vpc.foo.id + cidr_block = "10.0.20.0/28" + is_multicast = false + + tags = { + "test" = "test" + } +} + +data "tencentcloud_vpc_subnets" "id_instances" { + subnet_id = tencentcloud_subnet.subnet.id +} + +data "tencentcloud_vpc_subnets" "name_instances" { + name = tencentcloud_subnet.subnet.name +} + +data "tencentcloud_vpc_subnets" "tags_instances" { + tags = tencentcloud_subnet.subnet.tags +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Optional, String) Zone of the subnet to be queried. +* `cidr_block` - (Optional, String) Filter subnet with this CIDR. +* `is_default` - (Optional, Bool) Filter default or no default subnets. +* `is_remote_vpc_snat` - (Optional, Bool) Filter the VPC SNAT address pool subnet. +* `name` - (Optional, String) Name of the subnet to be queried. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) ID of the subnet to be queried. +* `tag_key` - (Optional, String) Filter if subnet has this tag. +* `tags` - (Optional, Map) Tags of the subnet to be queried. +* `vpc_id` - (Optional, String) ID of the VPC to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `instance_list` - List of subnets. + * `availability_zone` - The availability zone of the subnet. + * `available_ip_count` - The number of available IPs. + * `cidr_block` - A network address block of the subnet. + * `create_time` - Creation time of the subnet resource. + * `is_default` - Indicates whether it is the default subnet of the VPC for this region. + * `is_multicast` - Indicates whether multicast is enabled. + * `name` - Name of the subnet. + * `route_table_id` - ID of the routing table. + * `subnet_id` - ID of the subnet. + * `tags` - Tags of the subnet resource. + * `vpc_id` - ID of the VPC. + + diff --git a/config/docs/d/vpc_template_limits.html.markdown b/config/docs/d/vpc_template_limits.html.markdown new file mode 100644 index 0000000..40dadc6 --- /dev/null +++ b/config/docs/d/vpc_template_limits.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_template_limits" +sidebar_current: "docs-tencentcloud-datasource-vpc_template_limits" +description: |- + Use this data source to query detailed information of vpc template_limits +--- + +# tencentcloud_vpc_template_limits + +Use this data source to query detailed information of vpc template_limits + +## Example Usage + +```hcl +data "tencentcloud_vpc_template_limits" "template_limits" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `template_limit` - template limit. + * `address_template_group_member_limit` - address template group member limit. + * `address_template_member_limit` - address template member limit. + * `service_template_group_member_limit` - service template group member limit. + * `service_template_member_limit` - service template member limit. + + diff --git a/config/docs/d/vpc_used_ip_address.html.markdown b/config/docs/d/vpc_used_ip_address.html.markdown new file mode 100644 index 0000000..1775870 --- /dev/null +++ b/config/docs/d/vpc_used_ip_address.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_used_ip_address" +sidebar_current: "docs-tencentcloud-datasource-vpc_used_ip_address" +description: |- + Use this data source to query detailed information of vpc used_ip_address +--- + +# tencentcloud_vpc_used_ip_address + +Use this data source to query detailed information of vpc used_ip_address + +## Example Usage + +```hcl +data "tencentcloud_vpc_used_ip_address" "used_ip_address" { + vpc_id = "vpc-4owdpnwr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `vpc_id` - (Required, String) VPC instance ID. +* `ip_addresses` - (Optional, Set: [`String`]) IPs to query. +* `result_output_file` - (Optional, String) Used to save results. +* `subnet_id` - (Optional, String) Subnet instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `ip_address_states` - Information of resources bound with the queried IPs Note: This parameter may return null, indicating that no valid values can be obtained. + * `ip_address` - IP address. + * `resource_id` - Resource ID. + * `resource_type` - Resource type. + * `subnet_id` - Subnet instance ID. + * `vpc_id` - VPC instance ID. + + diff --git a/config/docs/d/vpn_connections.html.markdown b/config/docs/d/vpn_connections.html.markdown new file mode 100644 index 0000000..b46d8ca --- /dev/null +++ b/config/docs/d/vpn_connections.html.markdown @@ -0,0 +1,80 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_connections" +sidebar_current: "docs-tencentcloud-datasource-vpn_connections" +description: |- + Use this data source to query detailed information of VPN connections. +--- + +# tencentcloud_vpn_connections + +Use this data source to query detailed information of VPN connections. + +## Example Usage + +```hcl +data "tencentcloud_vpn_connections" "foo" { + name = "main" + id = "vpnx-xfqag" + vpn_gateway_id = "vpngw-8ccsnclt" + vpc_id = "cgw-xfqag" + customer_gateway_id = "" + tags = { + test = "tf" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `customer_gateway_id` - (Optional, String) Customer gateway ID of the VPN connection. +* `id` - (Optional, String) ID of the VPN connection. +* `name` - (Optional, String) Name of the VPN connection. The length of character is limited to 1-60. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) Tags of the VPN connection to be queried. +* `vpc_id` - (Optional, String) ID of the VPC. +* `vpn_gateway_id` - (Optional, String) VPN gateway ID of the VPN connection. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `connection_list` - Information list of the dedicated connections. + * `create_time` - Create time of the VPN connection. + * `customer_gateway_id` - ID of the customer gateway. + * `encrypt_proto` - Encrypt proto of the VPN connection. + * `id` - ID of the VPN connection. + * `ike_dh_group_name` - DH group name of the IKE operation specification. + * `ike_exchange_mode` - Exchange mode of the IKE operation specification. + * `ike_local_address` - Local address of the IKE operation specification. + * `ike_local_fqdn_name` - Local FQDN name of the IKE operation specification. + * `ike_local_identity` - Local identity of the IKE operation specification. + * `ike_proto_authen_algorithm` - Proto authenticate algorithm of the IKE operation specification. + * `ike_proto_encry_algorithm` - Proto encrypt algorithm of the IKE operation specification. + * `ike_remote_address` - Remote address of the IKE operation specification. + * `ike_remote_fqdn_name` - Remote FQDN name of the IKE operation specification. + * `ike_remote_identity` - Remote identity of the IKE operation specification. + * `ike_sa_lifetime_seconds` - SA lifetime of the IKE operation specification, unit is `second`. + * `ike_version` - Version of the IKE operation specification. + * `ipsec_encrypt_algorithm` - Encrypt algorithm of the IPSEC operation specification. + * `ipsec_integrity_algorithm` - Integrity algorithm of the IPSEC operation specification. + * `ipsec_pfs_dh_group` - PFS DH group name of the IPSEC operation specification. + * `ipsec_sa_lifetime_seconds` - SA lifetime of the IPSEC operation specification, unit is `second`. + * `ipsec_sa_lifetime_traffic` - SA lifetime traffic of the IPSEC operation specification, unit is `KB`. + * `name` - Name of the VPN connection. + * `net_status` - Net status of the VPN connection. + * `pre_share_key` - Pre-shared key of the VPN connection. + * `route_type` - Route type of the VPN connection. + * `security_group_policy` - Security group policy of the VPN connection. + * `local_cidr_block` - Local cidr block. + * `remote_cidr_block` - Remote cidr block list. + * `state` - State of the VPN connection. + * `tags` - A list of tags used to associate different resources. + * `vpc_id` - ID of the VPC. + * `vpn_gateway_id` - ID of the VPN gateway. + * `vpn_proto` - Vpn proto of the VPN connection. + + diff --git a/config/docs/d/vpn_customer_gateway_vendors.html.markdown b/config/docs/d/vpn_customer_gateway_vendors.html.markdown new file mode 100644 index 0000000..8c2dfd9 --- /dev/null +++ b/config/docs/d/vpn_customer_gateway_vendors.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_customer_gateway_vendors" +sidebar_current: "docs-tencentcloud-datasource-vpn_customer_gateway_vendors" +description: |- + Use this data source to query detailed information of vpc vpn_customer_gateway_vendors +--- + +# tencentcloud_vpn_customer_gateway_vendors + +Use this data source to query detailed information of vpc vpn_customer_gateway_vendors + +## Example Usage + +```hcl +data "tencentcloud_vpn_customer_gateway_vendors" "vpn_customer_gateway_vendors" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `customer_gateway_vendor_set` - Customer Gateway Vendor Set. + * `platform` - Platform. + * `software_version` - SoftwareVersion. + * `vendor_name` - VendorName. + + diff --git a/config/docs/d/vpn_customer_gateways.html.markdown b/config/docs/d/vpn_customer_gateways.html.markdown new file mode 100644 index 0000000..2b583a9 --- /dev/null +++ b/config/docs/d/vpn_customer_gateways.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_customer_gateways" +sidebar_current: "docs-tencentcloud-datasource-vpn_customer_gateways" +description: |- + Use this data source to query detailed information of VPN customer gateways. +--- + +# tencentcloud_vpn_customer_gateways + +Use this data source to query detailed information of VPN customer gateways. + +## Example Usage + +```hcl +data "tencentcloud_customer_gateways" "foo" { + name = "main" + id = "cgw-xfqag" + public_ip_address = "1.1.1.1" + tags = { + test = "tf" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the VPN customer gateway. +* `name` - (Optional, String) Name of the customer gateway. The length of character is limited to 1-60. +* `public_ip_address` - (Optional, String) Public ip address of the VPN customer gateway. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) Tags of the VPN customer gateway to be queried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `gateway_list` - Information list of the dedicated gateways. + * `create_time` - Create time of the VPN customer gateway. + * `id` - ID of the VPN customer gateway. + * `name` - Name of the VPN customer gateway. + * `public_ip_address` - Public ip address of the VPN customer gateway. + * `tags` - Tags of the VPN customer gateway. + + diff --git a/config/docs/d/vpn_default_health_check_ip.html.markdown b/config/docs/d/vpn_default_health_check_ip.html.markdown new file mode 100644 index 0000000..a4b1512 --- /dev/null +++ b/config/docs/d/vpn_default_health_check_ip.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_default_health_check_ip" +sidebar_current: "docs-tencentcloud-datasource-vpn_default_health_check_ip" +description: |- + Use this data source to query detailed information of vpn default_health_check_ip +--- + +# tencentcloud_vpn_default_health_check_ip + +Use this data source to query detailed information of vpn default_health_check_ip + +## Example Usage + +```hcl +data "tencentcloud_vpn_default_health_check_ip" "default_health_check_ip" { + vpn_gateway_id = "vpngw-gt8bianl" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `vpn_gateway_id` - (Required, String) vpn gateway id. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `health_check_local_ip` - local ip of health check. +* `health_check_remote_ip` - remote ip for health check. + + diff --git a/config/docs/d/vpn_gateway_routes.html.markdown b/config/docs/d/vpn_gateway_routes.html.markdown new file mode 100644 index 0000000..20acbda --- /dev/null +++ b/config/docs/d/vpn_gateway_routes.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_gateway_routes" +sidebar_current: "docs-tencentcloud-datasource-vpn_gateway_routes" +description: |- + Use this data source to query detailed information of VPN gateways. +--- + +# tencentcloud_vpn_gateway_routes + +Use this data source to query detailed information of VPN gateways. + +## Example Usage + +```hcl +data "tencentcloud_vpn_gateways" "foo" { + vpn_gateway_id = "main" + destination_cidr_block = "vpngw-8ccsnclt" + instance_type = "1.1.1.1" + instance_id = "ap-guangzhou-3" + tags = { + test = "tf" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `vpn_gateway_id` - (Required, String) VPN gateway ID. +* `destination_cidr` - (Optional, String) Destination IDC IP range. +* `instance_id` - (Optional, String) Instance ID of the next hop. +* `instance_type` - (Optional, String) Next hop type (type of the associated instance). Valid values: VPNCONN (VPN tunnel) and CCN (CCN instance). +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `vpn_gateway_route_list` - Information list of the vpn gateway routes. + * `create_time` - Create time. + * `route_id` - Route ID. + * `type` - Route type. Default value: Static. + * `update_time` - Update time. + + diff --git a/config/docs/d/vpn_gateways.html.markdown b/config/docs/d/vpn_gateways.html.markdown new file mode 100644 index 0000000..20e8bfc --- /dev/null +++ b/config/docs/d/vpn_gateways.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_gateways" +sidebar_current: "docs-tencentcloud-datasource-vpn_gateways" +description: |- + Use this data source to query detailed information of VPN gateways. +--- + +# tencentcloud_vpn_gateways + +Use this data source to query detailed information of VPN gateways. + +## Example Usage + +```hcl +data "tencentcloud_vpn_gateways" "foo" { + name = "main" + id = "vpngw-8ccsnclt" + public_ip_address = "1.1.1.1" + zone = "ap-guangzhou-3" + vpc_id = "vpc-dk8zmwuf" + tags = { + test = "tf" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `id` - (Optional, String) ID of the VPN gateway. +* `name` - (Optional, String) Name of the VPN gateway. The length of character is limited to 1-60. +* `public_ip_address` - (Optional, String) Public ip address of the VPN gateway. +* `result_output_file` - (Optional, String) Used to save results. +* `tags` - (Optional, Map) Tags of the VPN gateway to be queried. +* `vpc_id` - (Optional, String) ID of the VPC. +* `zone` - (Optional, String) Zone of the VPN gateway. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `gateway_list` - Information list of the dedicated gateways. + * `bandwidth` - The maximum public network output bandwidth of VPN gateway (unit: Mbps). + * `charge_type` - Charge Type of the VPN gateway. + * `create_time` - Create time of the VPN gateway. + * `expired_time` - Expired time of the VPN gateway when charge type is `PREPAID`. + * `id` - ID of the VPN gateway. + * `is_address_blocked` - Indicates whether ip address is blocked. + * `name` - Name of the VPN gateway. + * `new_purchase_plan` - The plan of new purchase. + * `prepaid_renew_flag` - Flag indicates whether to renew or not. + * `public_ip_address` - Public ip of the VPN gateway. + * `restrict_state` - Restrict state of VPN gateway. + * `state` - State of the VPN gateway. + * `tags` - A list of tags used to associate different resources. + * `type` - Type of gateway instance. + * `vpc_id` - ID of the VPC. + * `zone` - Zone of the VPN gateway. + + diff --git a/config/docs/d/waf_attack_log_histogram.html.markdown b/config/docs/d/waf_attack_log_histogram.html.markdown new file mode 100644 index 0000000..4c393f9 --- /dev/null +++ b/config/docs/d/waf_attack_log_histogram.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_attack_log_histogram" +sidebar_current: "docs-tencentcloud-datasource-waf_attack_log_histogram" +description: |- + Use this data source to query detailed information of waf attack_log_histogram +--- + +# tencentcloud_waf_attack_log_histogram + +Use this data source to query detailed information of waf attack_log_histogram + +## Example Usage + +### Obtain the specified domain name log information + +```hcl +data "tencentcloud_waf_attack_log_histogram" "example" { + domain = "domain.com" + start_time = "2023-09-01 00:00:00" + end_time = "2023-09-29 00:00:00" + query_string = "method:GET" +} +``` + +### Obtain all domain name log information + +```hcl +data "tencentcloud_waf_attack_log_histogram" "example" { + domain = "all" + start_time = "2023-09-01 00:00:00" + end_time = "2023-09-29 00:00:00" + query_string = "method:GET" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Domain for query, all domain use all. +* `end_time` - (Required, String) End time. +* `query_string` - (Required, String) Lucene grammar. +* `start_time` - (Required, String) Begin time. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - The statistics detail. + * `count` - The count of logs. + * `time_stamp` - Timestamp. +* `period` - Period. +* `total_count` - total count. + + diff --git a/config/docs/d/waf_attack_log_list.html.markdown b/config/docs/d/waf_attack_log_list.html.markdown new file mode 100644 index 0000000..91bdede --- /dev/null +++ b/config/docs/d/waf_attack_log_list.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_attack_log_list" +sidebar_current: "docs-tencentcloud-datasource-waf_attack_log_list" +description: |- + Use this data source to query detailed information of waf attack_log_list +--- + +# tencentcloud_waf_attack_log_list + +Use this data source to query detailed information of waf attack_log_list + +## Example Usage + +### Obtain the specified domain name attack log list + +```hcl +data "tencentcloud_waf_attack_log_list" "example" { + domain = "domain.com" + start_time = "2023-09-01 00:00:00" + end_time = "2023-09-07 00:00:00" + query_string = "method:GET" + sort = "desc" + query_count = 10 + page = 0 +} +``` + +### Obtain all domain name attack log list + +```hcl +data "tencentcloud_waf_attack_log_list" "example" { + domain = "all" + start_time = "2023-09-01 00:00:00" + end_time = "2023-09-07 00:00:00" + query_string = "method:GET" + sort = "asc" + query_count = 20 + page = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Domain for query, all domain use all. +* `end_time` - (Required, String) End time. +* `query_string` - (Required, String) Lucene grammar. +* `start_time` - (Required, String) Begin time. +* `page` - (Optional, Int) Number of pages, starting from 0 by default. +* `query_count` - (Optional, Int) Number of queries, default to 10, maximum of 100. +* `result_output_file` - (Optional, String) Used to save results. +* `sort` - (Optional, String) Default desc, support desc, asc. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Attack log array. + * `content` - The detail of attack log. + * `file_name` - Useless. + * `source` - Useless. + * `time_stamp` - Time string. + + diff --git a/config/docs/d/waf_attack_overview.html.markdown b/config/docs/d/waf_attack_overview.html.markdown new file mode 100644 index 0000000..c084c53 --- /dev/null +++ b/config/docs/d/waf_attack_overview.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_attack_overview" +sidebar_current: "docs-tencentcloud-datasource-waf_attack_overview" +description: |- + Use this data source to query detailed information of waf attack_overview +--- + +# tencentcloud_waf_attack_overview + +Use this data source to query detailed information of waf attack_overview + +## Example Usage + +### Basic Query + +```hcl +data "tencentcloud_waf_attack_overview" "example" { + from_time = "2023-09-01 00:00:00" + to_time = "2023-09-07 00:00:00" +} +``` + +### Query by filter + +```hcl +data "tencentcloud_waf_attack_overview" "example" { + from_time = "2023-09-01 00:00:00" + to_time = "2023-09-07 00:00:00" + appid = 1304251372 + domain = "test.com" + edition = "clb-waf" + instance_id = "waf_2kxtlbky00b2v1fn" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `from_time` - (Required, String) Begin time. +* `to_time` - (Required, String) End time. +* `appid` - (Optional, Int) App id. +* `domain` - (Optional, String) Domain. +* `edition` - (Optional, String) support `sparta-waf`, `clb-waf`, otherwise not filter. +* `instance_id` - (Optional, String) Waf instanceId, otherwise not filter. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `access_count` - Access count. +* `acl_count` - Access control count. +* `api_assets_count` - Api asset count. +* `api_risk_event_count` - Number of API risk events. +* `attack_count` - Attack count. +* `bot_count` - Bot attack count. +* `cc_count` - CC attack count. + + diff --git a/config/docs/d/waf_attack_total_count.html.markdown b/config/docs/d/waf_attack_total_count.html.markdown new file mode 100644 index 0000000..870a1c5 --- /dev/null +++ b/config/docs/d/waf_attack_total_count.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_attack_total_count" +sidebar_current: "docs-tencentcloud-datasource-waf_attack_total_count" +description: |- + Use this data source to query detailed information of waf attack_total_count +--- + +# tencentcloud_waf_attack_total_count + +Use this data source to query detailed information of waf attack_total_count + +## Example Usage + +### Obtain the specified domain name attack log + +```hcl +data "tencentcloud_waf_attack_total_count" "example" { + start_time = "2023-09-01 00:00:00" + end_time = "2023-09-07 00:00:00" + domain = "domain.com" + query_string = "method:GET" +} +``` + +### Obtain all domain name attack log + +```hcl +data "tencentcloud_waf_attack_total_count" "example" { + start_time = "2023-09-01 00:00:00" + end_time = "2023-09-07 00:00:00" + domain = "all" + query_string = "method:GET" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Query domain name, all domain use all. +* `end_time` - (Required, String) End time. +* `start_time` - (Required, String) Begin time. +* `query_string` - (Optional, String) Query conditions. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `total_count` - Total number of attacks. + + diff --git a/config/docs/d/waf_ciphers.html.markdown b/config/docs/d/waf_ciphers.html.markdown new file mode 100644 index 0000000..64c71a8 --- /dev/null +++ b/config/docs/d/waf_ciphers.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_ciphers" +sidebar_current: "docs-tencentcloud-datasource-waf_ciphers" +description: |- + Use this data source to query detailed information of waf ciphers +--- + +# tencentcloud_waf_ciphers + +Use this data source to query detailed information of waf ciphers + +## Example Usage + +```hcl +data "tencentcloud_waf_ciphers" "example" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `ciphers` - Encryption Suite InformationNote: This field may return null, indicating that a valid value cannot be obtained. + * `cipher_id` - Encryption Suite IDNote: This field may return null, indicating that a valid value cannot be obtained. + * `cipher_name` - Encryption Suite NameNote: This field may return null, indicating that a valid value cannot be obtained. + * `version_id` - TLS version IDNote: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/waf_domains.html.markdown b/config/docs/d/waf_domains.html.markdown new file mode 100644 index 0000000..4e9e0c3 --- /dev/null +++ b/config/docs/d/waf_domains.html.markdown @@ -0,0 +1,90 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_domains" +sidebar_current: "docs-tencentcloud-datasource-waf_domains" +description: |- + Use this data source to query detailed information of waf domains +--- + +# tencentcloud_waf_domains + +Use this data source to query detailed information of waf domains + +## Example Usage + +### Find all domains + +```hcl +data "tencentcloud_waf_domains" "example" {} +``` + +### Find domains by filter + +```hcl +data "tencentcloud_waf_domains" "example" { + instance_id = "waf_2kxtlbky01b3wceb" + domain = "tf.example.com" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Optional, String) Domain name. +* `instance_id` - (Optional, String) Unique ID of Instance. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `domains` - Domain info list. + * `alb_type` - Traffic Source: clb represents Tencent Cloud clb, apisix represents apisix gateway, tsegw represents Tencent Cloud API gateway, default clbNote: This field may return null, indicating that a valid value cannot be obtained. + * `api_status` - API security switch status, 0 off, 1 onNote: This field may return null, indicating that a valid value cannot be obtained. + * `app_id` - User appid. + * `bot_status` - BOT switch status, 0 off, 1 on. + * `cc_list` - Waf sandbox export addresses, should be added to the whitelist by the upstreams. + * `cdc_clusters` - Cdc clustersNote: This field may return null, indicating that a valid value cannot be obtained. + * `cls_status` - Whether to enable access logs, 1 enable, 0 disable. + * `cname` - Cname address, used for dns access. + * `create_time` - Create time. + * `domain_id` - Domain unique ID. + * `domain` - Domain name. + * `edition` - Instance type, sparta-waf represents SAAS WAF, clb-waf represents CLB WAF. + * `engine` - Rule and AI Defense Mode, 10 Rule Engine Observation&amp;&amp;AI Engine Shutdown Mode 11 Rule Engine Observation&amp;&amp;AI Engine Observation Mode 12 Rule Engine Observation&amp;&amp;AI Engine Interception Mode 20 Rule Engine Interception&amp;&amp;AI Engine Shutdown Mode 21 Rule Engine Interception&amp;&amp;AI Engine Observation Mode 22 Rule Engine Interception&amp;&amp;AI Engine Interception Mode. + * `flow_mode` - CLBWAF traffic mode, 1 cleaning mode, 0 mirroring mode. + * `instance_id` - Instance unique ID. + * `instance_name` - Instance name. + * `ipv6_status` - Ipv6 switch status, 0 off, 1 on. + * `level` - Instance level. + * `load_balancer_set` - List of bound LB. + * `listener_id` - Listener unique IDNote: This field may return null, indicating that a valid value cannot be obtained. + * `listener_name` - Listener nameNote: This field may return null, indicating that a valid value cannot be obtained. + * `load_balancer_id` - LoadBalancer IDNote: This field may return null, indicating that a valid value cannot be obtained. + * `load_balancer_name` - LoadBalancer nameNote: This field may return null, indicating that a valid value cannot be obtained. + * `load_balancer_type` - Loadbalancer typeNote: This field may return null, indicating that a valid value cannot be obtained. + * `numerical_vpc_id` - VPCID for load balancer, public network is -1, and internal network is filled in according to actual conditionsNote: This field may return null, indicating that a valid value cannot be obtained. + * `protocol` - Listener protocolNote: This field may return null, indicating that a valid value cannot be obtained. + * `region` - RegionNote: This field may return null, indicating that a valid value cannot be obtained. + * `vip` - LoadBalancer ipNote: This field may return null, indicating that a valid value cannot be obtained. + * `vport` - Listener portNote: This field may return null, indicating that a valid value cannot be obtained. + * `zone` - Loadbalancer zoneNote: This field may return null, indicating that a valid value cannot be obtained. + * `mode` - Rule defense mode, 0 observation mode, 1 interception mode. + * `ports` - Listening ports. + * `nginx_server_id` - Nginx server ID. + * `port` - Listening port. + * `protocol` - The listening protocol of listening port. + * `upstream_port` - The upstream port for listening port. + * `upstream_protocol` - The upstream protocol for listening port. + * `post_ckafka_status` - Whether to enable the delivery of CKafka function, 0 off, 1 on. + * `post_cls_status` - Whether to enable the delivery CLS function, 0 off, 1 on. + * `region` - Region. + * `rs_list` - Waf engine export addresses, should be added to the whitelist by the upstreams. + * `sg_detail` - Detailed explanation of security group statusNote: This field may return null, indicating that a valid value cannot be obtained. + * `sg_state` - Security group status, 0 does not display, 1 non Tencent cloud source site, 2 security group binding failed, 3 security group changedNote: This field may return null, indicating that a valid value cannot be obtained. + * `state` - Clbwaf domain name listener status, 0 operation successful, 4 binding LB, 6 unbinding LB, 7 unbinding LB failed, 8 binding LB failed, 10 internal error. + * `status` - Waf switch,0 off 1 on. + + diff --git a/config/docs/d/waf_find_domains.html.markdown b/config/docs/d/waf_find_domains.html.markdown new file mode 100644 index 0000000..630fd88 --- /dev/null +++ b/config/docs/d/waf_find_domains.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_find_domains" +sidebar_current: "docs-tencentcloud-datasource-waf_find_domains" +description: |- + Use this data source to query detailed information of waf find_domains +--- + +# tencentcloud_waf_find_domains + +Use this data source to query detailed information of waf find_domains + +## Example Usage + +### Find all domains + +```hcl +data "tencentcloud_waf_find_domains" "example" {} +``` + +### Find domains by filter + +```hcl +data "tencentcloud_waf_find_domains" "example" { + key = "keyWord" + is_waf_domain = "1" + by = "FindTime" + order = "asc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `by` - (Optional, String) Sorting parameter, eg: FindTime. +* `is_waf_domain` - (Optional, String) Whether access to waf or not. +* `key` - (Optional, String) Filter condition. +* `order` - (Optional, String) Sorting type, eg: desc, asc. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `list` - Domain info list. + * `appid` - User appid. + * `domain_id` - Domain unique id. + * `domain` - Domain name. + * `edition` - Instance type, sparta-waf represents SAAS WAF, clb-waf represents CLB WAF. + * `find_time` - Find time. + * `instance_id` - Instance unique id. + * `ips` - Domain ip. + * `is_waf_domain` - Whether access to waf or not. + + diff --git a/config/docs/d/waf_instance_qps_limit.html.markdown b/config/docs/d/waf_instance_qps_limit.html.markdown new file mode 100644 index 0000000..b7d9486 --- /dev/null +++ b/config/docs/d/waf_instance_qps_limit.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_instance_qps_limit" +sidebar_current: "docs-tencentcloud-datasource-waf_instance_qps_limit" +description: |- + Use this data source to query detailed information of waf instance_qps_limit +--- + +# tencentcloud_waf_instance_qps_limit + +Use this data source to query detailed information of waf instance_qps_limit + +## Example Usage + +```hcl +data "tencentcloud_waf_instance_qps_limit" "example" { + instance_id = "waf_2kxtlbky00b3b4qz" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Unique ID of Instance. +* `result_output_file` - (Optional, String) Used to save results. +* `type` - (Optional, String) Instance type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `qps_data` - Qps info. + * `elastic_billing_default` - Elastic qps default value. + * `elastic_billing_max` - Maximum elastic qps. + * `elastic_billing_min` - Minimum elastic qps. + * `qps_extend_intl_max` - Maximum qps of extend package for overseas. + * `qps_extend_max` - Maximum qps of extend package. + + diff --git a/config/docs/d/waf_peak_points.html.markdown b/config/docs/d/waf_peak_points.html.markdown new file mode 100644 index 0000000..6a9b1f0 --- /dev/null +++ b/config/docs/d/waf_peak_points.html.markdown @@ -0,0 +1,70 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_peak_points" +sidebar_current: "docs-tencentcloud-datasource-waf_peak_points" +description: |- + Use this data source to query detailed information of waf peak_points +--- + +# tencentcloud_waf_peak_points + +Use this data source to query detailed information of waf peak_points + +## Example Usage + +### Basic Query + +```hcl +data "tencentcloud_waf_peak_points" "example" { + from_time = "2023-09-01 00:00:00" + to_time = "2023-09-07 00:00:00" +} +``` + +### Query by filter + +```hcl +data "tencentcloud_waf_peak_points" "example" { + from_time = "2023-09-01 00:00:00" + to_time = "2023-09-07 00:00:00" + domain = "domain.com" + edition = "clb-waf" + instance_id = "waf_2kxtlbky00b2v1fn" + metric_name = "access" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `from_time` - (Required, String) Begin time. +* `to_time` - (Required, String) End time. +* `domain` - (Optional, String) The domain name to be queried. If all domain name data is queried, this parameter is not filled in. +* `edition` - (Optional, String) Only support sparta-waf and clb-waf. If not passed, there will be no filtering. +* `instance_id` - (Optional, String) WAF instance ID, if not passed, there will be no filtering. +* `metric_name` - (Optional, String) Thirteen values are available: access-Peak qps trend chart; botAccess- bot peak qps trend chart; down-Downstream peak bandwidth trend chart; up-Upstream peak bandwidth trend chart; attack-Trend chart of total number of web attacks; cc-Trend chart of total number of CC attacks; StatusServerError-Trend chart of the number of status codes returned by WAF to the server; StatusClientError-Trend chart of the number of status codes returned by WAF to the client; StatusRedirect-Trend chart of the number of status codes returned by WAF to the client; StatusOk-Trend chart of the number of status codes returned by WAF to the client; UpstreamServerError-Trend chart of the number of status codes returned to WAF by the origin site; UpstreamClientError-Trend chart of the number of status codes returned to WAF by the origin site; UpstreamRedirect-Trend chart of the number of status codes returned to WAF by the origin site. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `points` - point list. + * `access` - qps. + * `attack` - Number of web attacks. + * `bot_access` - Bot qps. + * `cc` - Number of cc attacks. + * `down` - Peak downlink bandwidth, unit B. + * `status_client_error` - Trend chart of the number of status codes returned by WAF to the client. + * `status_ok` - Trend chart of the number of status codes returned by WAF to the client. + * `status_redirect` - Trend chart of the number of status codes returned by WAF to the client. + * `status_server_error` - Trend chart of the number of status codes returned by WAF to the server. + * `time` - Second level timestamp. + * `up` - Peak uplink bandwidth, unit B. + * `upstream_client_error` - Trend chart of the number of status codes returned to WAF by the origin site. + * `upstream_redirect` - Trend chart of the number of status codes returned to WAF by the origin site. + * `upstream_server_error` - Trend chart of the number of status codes returned to WAF by the origin site. + + diff --git a/config/docs/d/waf_ports.html.markdown b/config/docs/d/waf_ports.html.markdown new file mode 100644 index 0000000..6ab9a55 --- /dev/null +++ b/config/docs/d/waf_ports.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_ports" +sidebar_current: "docs-tencentcloud-datasource-waf_ports" +description: |- + Use this data source to query detailed information of waf ports +--- + +# tencentcloud_waf_ports + +Use this data source to query detailed information of waf ports + +## Example Usage + +```hcl +data "tencentcloud_waf_ports" "example" {} +``` + +### Or + +```hcl +data "tencentcloud_waf_ports" "example" { + edition = "clb-waf" + instance_id = "waf_2kxtlbky00b2v1fn" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `edition` - (Optional, String) Instance type, sparta-waf represents SAAS WAF, clb-waf represents CLB WAF. +* `instance_id` - (Optional, String) Instance unique ID. +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `http_ports` - Http port list for instance. +* `https_ports` - Https port list for instance. + + diff --git a/config/docs/d/waf_tls_versions.html.markdown b/config/docs/d/waf_tls_versions.html.markdown new file mode 100644 index 0000000..9372a79 --- /dev/null +++ b/config/docs/d/waf_tls_versions.html.markdown @@ -0,0 +1,34 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_tls_versions" +sidebar_current: "docs-tencentcloud-datasource-waf_tls_versions" +description: |- + Use this data source to query detailed information of waf tls_versions +--- + +# tencentcloud_waf_tls_versions + +Use this data source to query detailed information of waf tls_versions + +## Example Usage + +```hcl +data "tencentcloud_waf_tls_versions" "example" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `tls` - TLS key value. + * `version_id` - TLS version IDNote: This field may return null, indicating that a valid value cannot be obtained. + * `version_name` - Tls version nameNote: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/waf_user_clb_regions.html.markdown b/config/docs/d/waf_user_clb_regions.html.markdown new file mode 100644 index 0000000..34eb48c --- /dev/null +++ b/config/docs/d/waf_user_clb_regions.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_user_clb_regions" +sidebar_current: "docs-tencentcloud-datasource-waf_user_clb_regions" +description: |- + Use this data source to query detailed information of waf user_clb_regions +--- + +# tencentcloud_waf_user_clb_regions + +Use this data source to query detailed information of waf user_clb_regions + +## Example Usage + +```hcl +data "tencentcloud_waf_user_clb_regions" "example" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Region list(ap-xxx format). +* `rich_datas` - Detail info for region. + * `code` - Region code. + * `id` - Region ID. + * `text` - Chinese description for region. + * `value` - English description for region. + + diff --git a/config/docs/d/waf_user_domains.html.markdown b/config/docs/d/waf_user_domains.html.markdown new file mode 100644 index 0000000..4a70989 --- /dev/null +++ b/config/docs/d/waf_user_domains.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_user_domains" +sidebar_current: "docs-tencentcloud-datasource-waf_user_domains" +description: |- + Use this data source to query detailed information of waf user_domains +--- + +# tencentcloud_waf_user_domains + +Use this data source to query detailed information of waf user_domains + +## Example Usage + +```hcl +data "tencentcloud_waf_user_domains" "user_domains" {} +``` + +## Argument Reference + +The following arguments are supported: + +* `result_output_file` - (Optional, String) Used to save results. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `users_info` - Domain infos. + * `appid` - User appid. + * `cls` - CLS switch 1: write, 0: do not writeNote: This field may return null, indicating that a valid value cannot be obtained. + * `domain_id` - Domain unique id. + * `domain` - Domain name. + * `edition` - Instance type, sparta-waf represents SAAS WAF, clb-waf represents CLB WAF. + * `instance_id` - Instance unique id. + * `instance_name` - Instance name. + * `level` - Instance level infoNote: This field may return null, indicating that a valid value cannot be obtained. + * `write_config` - Switch for accessing log fieldsNote: This field may return null, indicating that a valid value cannot be obtained. + + diff --git a/config/docs/d/wedata_data_source_info_list.html.markdown b/config/docs/d/wedata_data_source_info_list.html.markdown new file mode 100644 index 0000000..d33e2a7 --- /dev/null +++ b/config/docs/d/wedata_data_source_info_list.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_data_source_info_list" +sidebar_current: "docs-tencentcloud-datasource-wedata_data_source_info_list" +description: |- + Use this data source to query detailed information of wedata data_source_info_list +--- + +# tencentcloud_wedata_data_source_info_list + +Use this data source to query detailed information of wedata data_source_info_list + +## Example Usage + +```hcl +data "tencentcloud_wedata_data_source_info_list" "example" { + project_id = "1927766435649077248" + filters { + name = "Name" + values = ["tf_example"] + } + + order_fields { + name = "CreateTime" + direction = "DESC" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Required, String) Project ID. +* `datasource_name` - (Optional, String) DatasourceName. +* `filters` - (Optional, List) Filters. +* `order_fields` - (Optional, List) OrderFields. +* `result_output_file` - (Optional, String) Used to save results. +* `type` - (Optional, String) Datasource type. + +The `filters` object supports the following: + +* `name` - (Optional, String) Filter name. +* `values` - (Optional, Set) Filter values. + +The `order_fields` object supports the following: + +* `direction` - (Required, String) OrderFields rule. +* `name` - (Required, String) OrderFields name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `datasource_set` - DatasourceSet. + * `cluster_id` - ClusterId. + * `database_names` - DatabaseNames. + * `description` - Description. + * `id` - Id. + * `instance` - Instance. + * `name` - Name. + * `region` - Region. + * `type` - Type. + * `version` - Desc. + + diff --git a/config/docs/d/wedata_data_source_list.html.markdown b/config/docs/d/wedata_data_source_list.html.markdown new file mode 100644 index 0000000..4aa58e3 --- /dev/null +++ b/config/docs/d/wedata_data_source_list.html.markdown @@ -0,0 +1,93 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_data_source_list" +sidebar_current: "docs-tencentcloud-datasource-wedata_data_source_list" +description: |- + Use this data source to query detailed information of wedata data_source_list +--- + +# tencentcloud_wedata_data_source_list + +Use this data source to query detailed information of wedata data_source_list + +## Example Usage + +### Query All + +```hcl +data "tencentcloud_wedata_data_source_list" "example" {} +``` + +### Query By filter + +```hcl +data "tencentcloud_wedata_data_source_list" "example" { + order_fields { + name = "create_time" + direction = "DESC" + } + + filters { + name = "Name" + values = ["tf_example"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filters. +* `order_fields` - (Optional, List) OrderFields. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Optional, String) Filter name. +* `values` - (Optional, Set) Filter value. + +The `order_fields` object supports the following: + +* `direction` - (Required, String) OrderFields rule. +* `name` - (Required, String) OrderFields name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `rows` - Data rows. + * `app_id` - Appid. + * `author` - Has Author. + * `authority_project_name` - Datasource AuthorityProjectName. + * `authority_user_name` - Datasource AuthorityUserName. + * `biz_params_string` - Biz params json string. + * `biz_params` - Biz params. + * `category` - Datasource category. + * `cluster_id` - Datasource cluster id. + * `cluster_name` - Datasource cluster name. + * `create_time` - CreateTime. + * `data_source_status` - DatasourceDataSourceStatus. + * `database_name` - DatabaseName. + * `deliver` - Can Deliver. + * `description` - Description. + * `display` - Datasource display name. + * `edit` - Datasource can Edit. + * `id` - ID. + * `instance` - Instance. + * `modified_time` - Datasource ModifiedTime. + * `name` - Datasource name. + * `owner_account_name` - Datasource owner account name. + * `owner_account` - Datasource owner account. + * `owner_project_id` - Datasource owner project id. + * `owner_project_ident` - Datasource OwnerProjectIdent. + * `owner_project_name` - Datasource OwnerProjectName. + * `params_string` - Params json string. + * `params` - Datasource params. + * `region` - Datasource engin cluster region. + * `show_type` - Datasource show type. + * `status` - Datasource status. + * `type` - Datasource type. + + diff --git a/config/docs/d/wedata_data_source_without_info.html.markdown b/config/docs/d/wedata_data_source_without_info.html.markdown new file mode 100644 index 0000000..8a84a16 --- /dev/null +++ b/config/docs/d/wedata_data_source_without_info.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_data_source_without_info" +sidebar_current: "docs-tencentcloud-datasource-wedata_data_source_without_info" +description: |- + Use this data source to query detailed information of wedata data_source_without_info +--- + +# tencentcloud_wedata_data_source_without_info + +Use this data source to query detailed information of wedata data_source_without_info + +## Example Usage + +```hcl +data "tencentcloud_wedata_data_source_without_info" "example" { + filters { + name = "ownerProjectId" + values = ["1612982498218618880"] + } + + order_fields { + name = "create_time" + direction = "DESC" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `filters` - (Optional, List) Filters. +* `order_fields` - (Optional, List) OrderFields. +* `result_output_file` - (Optional, String) Used to save results. + +The `filters` object supports the following: + +* `name` - (Optional, String) Filter name. +* `values` - (Optional, Set) Filter value. + +The `order_fields` object supports the following: + +* `direction` - (Required, String) OrderFields rule. +* `name` - (Required, String) OrderFields name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - Data. + * `app_id` - Appid. + * `author` - Has Author. + * `authority_project_name` - Datasource AuthorityProjectName. + * `authority_user_name` - Datasource AuthorityUserName. + * `biz_params_string` - Biz params json string. + * `biz_params` - Biz params. + * `category` - Datasource category. + * `cluster_id` - Datasource cluster id. + * `cluster_name` - Datasource cluster name. + * `create_time` - CreateTime. + * `data_source_status` - DatasourceDataSourceStatus. + * `database_name` - DatabaseName. + * `deliver` - Can Deliver. + * `description` - Description. + * `display` - Datasource display name. + * `edit` - Datasource can Edit. + * `id` - ID. + * `instance` - Instance. + * `modified_time` - Datasource ModifiedTime. + * `name` - Datasource name. + * `owner_account_name` - Datasource owner account name. + * `owner_account` - Datasource owner account. + * `owner_project_id` - Datasource owner project id. + * `owner_project_ident` - Datasource OwnerProjectIdent. + * `owner_project_name` - Datasource OwnerProjectName. + * `params_string` - Params json string. + * `params` - Datasource params. + * `region` - Datasource engin cluster region. + * `show_type` - Datasource show type. + * `status` - Datasource status. + * `type` - Datasource type. + + diff --git a/config/docs/d/wedata_rule_templates.html.markdown b/config/docs/d/wedata_rule_templates.html.markdown new file mode 100644 index 0000000..93fb4bb --- /dev/null +++ b/config/docs/d/wedata_rule_templates.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_rule_templates" +sidebar_current: "docs-tencentcloud-datasource-wedata_rule_templates" +description: |- + Use this data source to query detailed information of wedata rule templates +--- + +# tencentcloud_wedata_rule_templates + +Use this data source to query detailed information of wedata rule templates + +## Example Usage + +```hcl +data "tencentcloud_wedata_rule_templates" "rule_templates" { + type = 2 + source_object_type = 2 + project_id = "1840731346428280832" + source_engine_types = [2, 4, 16] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Optional, String) Project ID. +* `result_output_file` - (Optional, String) Used to save results. +* `source_engine_types` - (Optional, Set: [`Int`]) Applicable type of source data. +* `source_object_type` - (Optional, Int) Source data object type. `1`: Constant, `2`: Offline table level, `3`: Offline field level. +* `type` - (Optional, Int) Template type. `1` means System template, `2` means Custom template. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `data` - rule template list. + * `citation_count` - Citations. + * `compare_type` - The type of comparison method supported by the rule (1: fixed value comparison, greater than, less than, greater than or equal to, etc. 2: fluctuating value comparison, absolute value, rise, fall). + * `description` - Description of rule template. + * `multi_source_flag` - Whether to associate other library tables. + * `name` - Name of rule template. + * `quality_dim` - Quality inspection dimensions. `1`: Accuracy, `2`: Uniqueness, `3`: Completeness, `4`: Consistency, `5`: Timeliness, `6`: Effectiveness. + * `rule_template_id` - ID of rule template. + * `source_content` - Content of rule template. + * `source_engine_types` - Applicable type of source data. + * `source_object_data_type` - Source data object type. `1`: value, `2`: string. + * `source_object_type` - Source object type. `1`: Constant, `2`: Offline table level, `3`: Offline field level. + * `sql_expression` - Sql Expression. + * `sub_quality_dim` - Sub Quality inspection dimensions. `1`: Accuracy, `2`: Uniqueness, `3`: Completeness, `4`: Consistency, `5`: Timeliness, `6`: Effectiveness. + * `type` - Template type. `1` means System template, `2` means Custom template. + * `update_time` - update time, like: yyyy-MM-dd HH:mm:ss. + * `user_id` - user id. + * `user_name` - user name. + * `where_flag` - If add where. + + diff --git a/config/docs/r/address_template.html.markdown b/config/docs/r/address_template.html.markdown new file mode 100644 index 0000000..7ef5f77 --- /dev/null +++ b/config/docs/r/address_template.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_address_template" +sidebar_current: "docs-tencentcloud-resource-address_template" +description: |- + Provides a resource to manage address template. +--- + +# tencentcloud_address_template + +Provides a resource to manage address template. + +## Example Usage + +```hcl +resource "tencentcloud_address_template" "foo" { + name = "cam-user-test" + addresses = ["10.0.0.1", "10.0.1.0/24", "10.0.0.1-10.0.0.100"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `addresses` - (Required, Set: [`String`]) Address list. IP(`10.0.0.1`), CIDR(`10.0.1.0/24`), IP range(`10.0.0.1-10.0.0.100`) format are supported. +* `name` - (Required, String, ForceNew) Name of the address template. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Address template can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_address_template.foo ipm-makf7k9e" +``` + diff --git a/config/docs/r/address_template_group.html.markdown b/config/docs/r/address_template_group.html.markdown new file mode 100644 index 0000000..b303018 --- /dev/null +++ b/config/docs/r/address_template_group.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_address_template_group" +sidebar_current: "docs-tencentcloud-resource-address_template_group" +description: |- + Provides a resource to manage address template group. +--- + +# tencentcloud_address_template_group + +Provides a resource to manage address template group. + +## Example Usage + +```hcl +resource "tencentcloud_address_template_group" "foo" { + name = "group-test" + template_ids = ["ipl-axaf24151", "ipl-axaf24152"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String, ForceNew) Name of the address template group. +* `template_ids` - (Required, Set: [`String`]) Template ID list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Address template group can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_address_template_group.foo ipmg-0np3u974 +``` + diff --git a/config/docs/r/alb_server_attachment.html.markdown b/config/docs/r/alb_server_attachment.html.markdown new file mode 100644 index 0000000..5e65ff5 --- /dev/null +++ b/config/docs/r/alb_server_attachment.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_alb_server_attachment" +sidebar_current: "docs-tencentcloud-resource-alb_server_attachment" +description: |- + Provides an tencentcloud application load balancer servers attachment as a resource, to attach and detach instances from load balancer. +--- + +# tencentcloud_alb_server_attachment + +Provides an tencentcloud application load balancer servers attachment as a resource, to attach and detach instances from load balancer. + +~> **NOTE:** It has been deprecated and replaced by `tencentcloud_clb_attachment`. + +~> **NOTE:** Currently only support existing `loadbalancer_id` `listener_id` `location_id` and Application layer 7 load balancer + +## Example Usage + +```hcl +resource "tencentcloud_alb_server_attachment" "service1" { + loadbalancer_id = "lb-qk1dqox5" + listener_id = "lbl-ghoke4tl" + location_id = "loc-i858qv1l" + + backends = [ + { + instance_id = "ins-4j30i5pe" + port = 80 + weight = 50 + }, + { + instance_id = "ins-4j30i5pe" + port = 8080 + weight = 50 + }, + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backends` - (Required, Set) list of backend server. +* `listener_id` - (Required, String, ForceNew) listener ID. +* `loadbalancer_id` - (Required, String, ForceNew) loadbalancer ID. +* `location_id` - (Optional, String, ForceNew) location ID, only support for layer 7 loadbalancer. + +The `backends` object supports the following: + +* `instance_id` - (Required, String) A list backend instance ID (CVM instance ID). +* `port` - (Required, Int) The port used by the backend server. Valid value range: [1-65535]. +* `weight` - (Optional, Int) Weight of the backend server. Valid value range: [0-100]. Default to 10. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `protocol_type` - The protocol type, http or tcp. + + diff --git a/config/docs/r/antiddos_cc_black_white_ip.html.markdown b/config/docs/r/antiddos_cc_black_white_ip.html.markdown new file mode 100644 index 0000000..36b7889 --- /dev/null +++ b/config/docs/r/antiddos_cc_black_white_ip.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_cc_black_white_ip" +sidebar_current: "docs-tencentcloud-resource-antiddos_cc_black_white_ip" +description: |- + Provides a resource to create a antiddos cc black white ip +--- + +# tencentcloud_antiddos_cc_black_white_ip + +Provides a resource to create a antiddos cc black white ip + +## Example Usage + +```hcl +resource "tencentcloud_antiddos_cc_black_white_ip" "cc_black_white_ip" { + instance_id = "bgpip-xxxxxx" + black_white_ip { + ip = "1.2.3.5" + mask = 0 + + } + type = "black" + ip = "xxx.xxx.xxx.xxx" + domain = "t.baidu.com" + protocol = "http" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `black_white_ip` - (Required, List, ForceNew) Black white ip. +* `domain` - (Required, String, ForceNew) domain. +* `instance_id` - (Required, String, ForceNew) instance id. +* `ip` - (Required, String, ForceNew) ip address. +* `protocol` - (Required, String, ForceNew) protocol. +* `type` - (Required, String, ForceNew) IP type, value [black(blacklist IP), white(whitelist IP)]. + +The `black_white_ip` object supports the following: + +* `ip` - (Required, String) ip address. +* `mask` - (Required, Int) ip mask. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +antiddos cc_black_white_ip can be imported using the id, e.g. + +``` +terraform import tencentcloud_antiddos_cc_black_white_ip.cc_black_white_ip ${instanceId}#${policyId}#${instanceIp}#${domain}#${protocol} +``` + diff --git a/config/docs/r/antiddos_cc_precision_policy.html.markdown b/config/docs/r/antiddos_cc_precision_policy.html.markdown new file mode 100644 index 0000000..98d6182 --- /dev/null +++ b/config/docs/r/antiddos_cc_precision_policy.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_cc_precision_policy" +sidebar_current: "docs-tencentcloud-resource-antiddos_cc_precision_policy" +description: |- + Provides a resource to create a antiddos cc_precision_policy +--- + +# tencentcloud_antiddos_cc_precision_policy + +Provides a resource to create a antiddos cc_precision_policy + +## Example Usage + +```hcl +resource "tencentcloud_antiddos_cc_precision_policy" "cc_precision_policy" { + instance_id = "bgpip-0000078h" + ip = "212.64.62.191" + protocol = "http" + domain = "t.baidu.com" + policy_action = "drop" + policy_list { + field_type = "value" + field_name = "cgi" + value = "a.com" + value_operator = "equal" + } + + policy_list { + field_type = "value" + field_name = "ua" + value = "test" + value_operator = "equal" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) domain. +* `instance_id` - (Required, String) Instance Id. +* `ip` - (Required, String) Ip value. +* `policy_action` - (Required, String) policy type, alg or drop. +* `policy_list` - (Required, List) policy list. +* `protocol` - (Required, String) protocol http or https. + +The `policy_list` object supports the following: + +* `field_name` - (Required, String) Configuration fields can take values of cgi, ua, cookie, referer, accept, srcip. +* `field_type` - (Required, String) field type. +* `value_operator` - (Required, String) Configuration item value comparison method, can take values of equal, not_ Equal, include. +* `value` - (Required, String) value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +antiddos cc_precision_policy can be imported using the id, e.g. + +``` +terraform import tencentcloud_antiddos_cc_precision_policy.cc_precision_policy ${instanceId}#${policyId}#${instanceIp}#${domain}#${protocol} +``` + diff --git a/config/docs/r/antiddos_ddos_black_white_ip.html.markdown b/config/docs/r/antiddos_ddos_black_white_ip.html.markdown new file mode 100644 index 0000000..9d606b6 --- /dev/null +++ b/config/docs/r/antiddos_ddos_black_white_ip.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_ddos_black_white_ip" +sidebar_current: "docs-tencentcloud-resource-antiddos_ddos_black_white_ip" +description: |- + Provides a resource to create a antiddos ddos black white ip +--- + +# tencentcloud_antiddos_ddos_black_white_ip + +Provides a resource to create a antiddos ddos black white ip + +## Example Usage + +```hcl +resource "tencentcloud_antiddos_ddos_black_white_ip" "ddos_black_white_ip" { + instance_id = "bgp-xxxxxx" + ip = "1.2.3.5" + mask = 0 + type = "black" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `ip` - (Required, String) ip list. +* `mask` - (Required, Int) ip mask. +* `type` - (Required, String) ip type, black: black ip list, white: white ip list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +antiddos ddos_black_white_ip can be imported using the id, e.g. + +``` +terraform import tencentcloud_antiddos_ddos_black_white_ip.ddos_black_white_ip ${instanceId}#${ip} +``` + diff --git a/config/docs/r/antiddos_ddos_geo_ip_block_config.html.markdown b/config/docs/r/antiddos_ddos_geo_ip_block_config.html.markdown new file mode 100644 index 0000000..74b648d --- /dev/null +++ b/config/docs/r/antiddos_ddos_geo_ip_block_config.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_ddos_geo_ip_block_config" +sidebar_current: "docs-tencentcloud-resource-antiddos_ddos_geo_ip_block_config" +description: |- + Provides a resource to create a antiddos ddos_geo_ip_block_config +--- + +# tencentcloud_antiddos_ddos_geo_ip_block_config + +Provides a resource to create a antiddos ddos_geo_ip_block_config + +## Example Usage + +```hcl +resource "tencentcloud_antiddos_ddos_geo_ip_block_config" "ddos_geo_ip_block_config" { + instance_id = "bgp-xxxxxx" + ddos_geo_ip_block_config { + region_type = "customized" + action = "drop" + area_list = [100002] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ddos_geo_ip_block_config` - (Required, List) DDoS region blocking configuration, configuration ID cannot be empty when filling in parameters. +* `instance_id` - (Required, String) InstanceId. + +The `ddos_geo_ip_block_config` object supports the following: + +* `action` - (Required, String) Blocking action, value [drop (intercept) trans (release)]. +* `region_type` - (Required, String) Region type, value [oversea (overseas) China (domestic) customized (custom region)]. +* `area_list` - (Optional, Set) When RegionType is customized, an AreaList must be filled in, with a maximum of 128 entries;. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +antiddos ddos_geo_ip_block_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_antiddos_ddos_geo_ip_block_config.ddos_geo_ip_block_config ${instanceId}#${configId} +``` + diff --git a/config/docs/r/antiddos_ddos_speed_limit_config.html.markdown b/config/docs/r/antiddos_ddos_speed_limit_config.html.markdown new file mode 100644 index 0000000..2836cdb --- /dev/null +++ b/config/docs/r/antiddos_ddos_speed_limit_config.html.markdown @@ -0,0 +1,75 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_ddos_speed_limit_config" +sidebar_current: "docs-tencentcloud-resource-antiddos_ddos_speed_limit_config" +description: |- + Provides a resource to create a antiddos ddos speed limit config +--- + +# tencentcloud_antiddos_ddos_speed_limit_config + +Provides a resource to create a antiddos ddos speed limit config + +## Example Usage + +```hcl +resource "tencentcloud_antiddos_ddos_speed_limit_config" "ddos_speed_limit_config" { + instance_id = "bgp-xxxxxx" + ddos_speed_limit_config { + mode = 1 + speed_values { + type = 1 + value = 1 + } + speed_values { + type = 2 + value = 2 + } + protocol_list = "ALL" + dst_port_list = "8000" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ddos_speed_limit_config` - (Required, List) Accessing speed limit configuration, the configuration ID cannot be empty when filling in parameters. +* `instance_id` - (Required, String) InstanceId. + +The `ddos_speed_limit_config` object supports the following: + +* `mode` - (Required, Int) Speed limit mode, value [1 (based on source IP speed limit) 2 (based on destination port speed limit)]. +* `speed_values` - (Required, List) Speed limit values, each type of speed limit value can support up to 1; This field array has at least one speed limit value. +* `dst_port_list` - (Optional, String) List of port ranges, up to 8, multiple; Separate and indicate the range with -; This port range must be filled in; Fill in style 1:0-65535, style 2: 80; 443; 1000-2000. +* `dst_port_scopes` - (Optional, List) This field has been deprecated. Please fill in the new field DstPortList. +* `protocol_list` - (Optional, String) IP protocol numbers, values [ALL (all protocols) TCP (tcp protocol) UDP (udp protocol) SMP (smp protocol) 1; 2-100 (custom protocol number range, up to 8)] Note: When customizing the protocol number range, only the protocol number can be filled in, multiple ranges; Separation; When filling in ALL, no other agreements or agreements can be filled inNumber. + +The `dst_port_scopes` object supports the following: + +* `begin_port` - (Required, Int) Starting port, ranging from 1 to 65535. +* `end_port` - (Required, Int) end port, ranging from 1 to 65535. + +The `speed_values` object supports the following: + +* `type` - (Required, Int) Speed limit value type, value [1 (packet rate pps) 2 (bandwidth bps)]. +* `value` - (Required, Int) value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +antiddos ddos_speed_limit_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_antiddos_ddos_speed_limit_config.ddos_speed_limit_config ${instanceId}#${configId}s +``` + diff --git a/config/docs/r/antiddos_default_alarm_threshold.html.markdown b/config/docs/r/antiddos_default_alarm_threshold.html.markdown new file mode 100644 index 0000000..7c15245 --- /dev/null +++ b/config/docs/r/antiddos_default_alarm_threshold.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_default_alarm_threshold" +sidebar_current: "docs-tencentcloud-resource-antiddos_default_alarm_threshold" +description: |- + Provides a resource to create a antiddos default alarm threshold +--- + +# tencentcloud_antiddos_default_alarm_threshold + +Provides a resource to create a antiddos default alarm threshold + +## Example Usage + +```hcl +resource "tencentcloud_antiddos_default_alarm_threshold" "default_alarm_threshold" { + default_alarm_config { + alarm_type = 1 + alarm_threshold = 2000 + } + instance_type = "bgp" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `default_alarm_config` - (Required, List) Alarm threshold configuration. +* `instance_type` - (Required, String, ForceNew) Product type, value [bgp (represents advanced defense package product) bgpip (represents advanced defense IP product)]. + +The `default_alarm_config` object supports the following: + +* `alarm_threshold` - (Optional, Int) Alarm threshold, in Mbps, with a value of>=0; When used as an input parameter, setting 0 will delete the alarm threshold configuration;. +* `alarm_type` - (Optional, Int) Alarm threshold type, value [1 (incoming traffic alarm threshold) 2 (attack cleaning traffic alarm threshold)]. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +antiddos default_alarm_threshold can be imported using the id, e.g. + +``` +terraform import tencentcloud_antiddos_default_alarm_threshold.default_alarm_threshold ${instanceType} +``` + diff --git a/config/docs/r/antiddos_ip_alarm_threshold_config.html.markdown b/config/docs/r/antiddos_ip_alarm_threshold_config.html.markdown new file mode 100644 index 0000000..e59738a --- /dev/null +++ b/config/docs/r/antiddos_ip_alarm_threshold_config.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_ip_alarm_threshold_config" +sidebar_current: "docs-tencentcloud-resource-antiddos_ip_alarm_threshold_config" +description: |- + Provides a resource to create a antiddos ip_alarm_threshold_config +--- + +# tencentcloud_antiddos_ip_alarm_threshold_config + +Provides a resource to create a antiddos ip_alarm_threshold_config + +## Example Usage + +```hcl +resource "tencentcloud_antiddos_ip_alarm_threshold_config" "ip_alarm_threshold_config" { + alarm_type = 1 + alarm_threshold = 2 + instance_ip = "xxx.xxx.xxx.xxx" + instance_id = "bgp-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `alarm_threshold` - (Required, Int) Alarm threshold, in Mbps, with a value of>=0; When used as an input parameter, setting 0 will delete the alarm threshold configuration;. +* `alarm_type` - (Required, Int) Alarm threshold type, value [1 (incoming traffic alarm threshold) 2 (attack cleaning traffic alarm threshold)]. +* `instance_id` - (Required, String) Instance id. +* `instance_ip` - (Required, String) Instance ip. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +antiddos ip_alarm_threshold_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_antiddos_ip_alarm_threshold_config.ip_alarm_threshold_config ${instanceId}#${instanceIp}#${alarmType} +``` + diff --git a/config/docs/r/antiddos_packet_filter_config.html.markdown b/config/docs/r/antiddos_packet_filter_config.html.markdown new file mode 100644 index 0000000..c59aa7d --- /dev/null +++ b/config/docs/r/antiddos_packet_filter_config.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_packet_filter_config" +sidebar_current: "docs-tencentcloud-resource-antiddos_packet_filter_config" +description: |- + Provides a resource to create a antiddos packet filter config +--- + +# tencentcloud_antiddos_packet_filter_config + +Provides a resource to create a antiddos packet filter config + +## Example Usage + +```hcl +resource "tencentcloud_antiddos_packet_filter_config" "packet_filter_config" { + instance_id = "bgp-00000ry7" + packet_filter_config { + action = "drop" + depth = 1 + dport_start = 80 + dport_end = 80 + is_not = 0 + match_begin = "begin_l5" + match_type = "pcre" + offset = 1 + pktlen_min = 1400 + pktlen_max = 1400 + protocol = "all" + sport_start = 8080 + sport_end = 8080 + str = "a" + } +} s +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) resource id. +* `packet_filter_config` - (Required, List, ForceNew) Feature filtering configuration. + +The `packet_filter_config` object supports the following: + +* `action` - (Required, String) Action, value [drop (discard) transmit (release) drop_black (discard and pull black) drop_rst (intercept) drop_black_rst (intercept and pull black) forward (continue protection)]. +* `dport_end` - (Required, Int) end destination port, ranging from 0 to 65535. +* `dport_start` - (Required, Int) Starting destination port, ranging from 0 to 65535. +* `pktlen_max` - (Required, Int) The maximum message length, ranging from 1 to 1500, must be greater than or equal to the minimum message length. +* `pktlen_min` - (Required, Int) Minimum message length, ranging from 1 to 1500. +* `protocol` - (Required, String) Protocol, value [TCP udp icmp all]. +* `sport_end` - (Required, Int) End source port, values range from 1 to 65535, must be greater than or equal to the start source port. +* `sport_start` - (Required, Int) Starting source port, ranging from 0 to 65535. +* `depth2` - (Optional, Int) The second detection depth starting from the second detection position, with a value of [01500]. +* `depth` - (Optional, Int) The detection depth starting from the detection position, with a value of [0-1500]. +* `is_not2` - (Optional, Int) Whether the second detection includes detection values, with a value of [0 (inclusive) and 1 (exclusive)]. +* `is_not` - (Optional, Int) Whether to include detection values, with a value of [0 (inclusive) and 1 (exclusive)]. +* `match_begin2` - (Optional, String) Second detection position, value [begin_l5 (load) no_match (mismatch)]. +* `match_begin` - (Optional, String) Detection position, value [begin_l3 (IP header) begin_l4 (TCP/UDP header) begin_l5 (T payload) no_match (mismatch)]. +* `match_logic` - (Optional, String) When there is a second detection condition, the AND or relationship with the first detection condition, with the value [and (and relationship) none (fill in this value when there is no second detection condition)]. +* `match_type2` - (Optional, String) The second detection type, with a value of [Sunday (keyword) pcre (regular expression)]. +* `match_type` - (Optional, String) Detection type, value [Sunday (keyword) pcre (regular expression)]. +* `offset2` - (Optional, Int) The offset from the second detection position, with a value range of [0, Depth2]. +* `offset` - (Optional, Int) The offset from the detection position, with a value range of [0, Depth]. +* `pkt_len_gt` - (Optional, Int) Greater than message length, value 1+. +* `str2` - (Optional, String) key string or regular expression, value [When the detection type is Sunday, please fill in the string or hexadecimal bytecode, for example, x313233 corresponds to the hexadecimal word>section code of the string '123'; when the detection type is pcre, please fill in the regular expression character string;]. +* `str` - (Optional, String) Detection value, key string or regular expression, value [When the detection type is Sunday, please fill in the string or hexadecimal bytecode, for example, x313233 corresponds to the hexadecimal word>section code of the string '123'; when the detection type is pcre, please fill in the regular expression character string;]. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +antiddos packet_filter_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_antiddos_packet_filter_config.packet_filter_config packet_filter_config_id +``` + diff --git a/config/docs/r/antiddos_port_acl_config.html.markdown b/config/docs/r/antiddos_port_acl_config.html.markdown new file mode 100644 index 0000000..33ff8cd --- /dev/null +++ b/config/docs/r/antiddos_port_acl_config.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_port_acl_config" +sidebar_current: "docs-tencentcloud-resource-antiddos_port_acl_config" +description: |- + Provides a resource to create a antiddos port acl config +--- + +# tencentcloud_antiddos_port_acl_config + +Provides a resource to create a antiddos port acl config + +## Example Usage + +```hcl +resource "tencentcloud_antiddos_port_acl_config" "port_acl_config" { + instance_id = "bgp-xxxxxx" + acl_config { + forward_protocol = "all" + d_port_start = 22 + d_port_end = 23 + s_port_start = 22 + s_port_end = 23 + action = "drop" + priority = 2 + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `acl_config` - (Required, List, ForceNew) Port ACL Policy. +* `instance_id` - (Required, String, ForceNew) InstanceIdList. + +The `acl_config` object supports the following: + +* `action` - (Required, String) Action, can take values: drop, transmit, forward. +* `d_port_end` - (Required, Int) end from port, with a range of 0~65535 values. +* `d_port_start` - (Required, Int) Starting from port, with a range of 0~65535 values. +* `forward_protocol` - (Required, String) Protocol type, can take TCP, udp, all values. +* `s_port_end` - (Required, Int) end from the source port, with a value range of 0~65535. +* `s_port_start` - (Required, Int) Starting from the source port, with a value range of 0~65535. +* `priority` - (Optional, Int) The policy priority, the smaller the number, the higher the level, and the higher the matching of the rule, with values ranging from 1 to 1000. Note: This field may return null, indicating that a valid value cannot be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +antiddos port_acl_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_antiddos_port_acl_config.port_acl_config ${instanceId}#${configJson} +``` + diff --git a/config/docs/r/antiddos_scheduling_domain_user_name.html.markdown b/config/docs/r/antiddos_scheduling_domain_user_name.html.markdown new file mode 100644 index 0000000..8a2819f --- /dev/null +++ b/config/docs/r/antiddos_scheduling_domain_user_name.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_antiddos_scheduling_domain_user_name" +sidebar_current: "docs-tencentcloud-resource-antiddos_scheduling_domain_user_name" +description: |- + Provides a resource to create a antiddos scheduling_domain_user_name +--- + +# tencentcloud_antiddos_scheduling_domain_user_name + +Provides a resource to create a antiddos scheduling_domain_user_name + +## Example Usage + +```hcl +resource "tencentcloud_antiddos_scheduling_domain_user_name" "scheduling_domain_user_name" { + domain_name = "test.com" + domain_user_name = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_name` - (Required, String, ForceNew) user cname. +* `domain_user_name` - (Required, String) domain name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +antiddos scheduling_domain_user_name can be imported using the id, e.g. + +``` +terraform import tencentcloud_antiddos_scheduling_domain_user_name.scheduling_domain_user_name ${domainName} +``` + diff --git a/config/docs/r/api_gateway_api.html.markdown b/config/docs/r/api_gateway_api.html.markdown new file mode 100644 index 0000000..a4dc272 --- /dev/null +++ b/config/docs/r/api_gateway_api.html.markdown @@ -0,0 +1,222 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api" +sidebar_current: "docs-tencentcloud-resource-api_gateway_api" +description: |- + Use this resource to create API of API gateway. +--- + +# tencentcloud_api_gateway_api + +Use this resource to create API of API gateway. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_service" "example" { + service_name = "tf-example" + protocol = "http&https" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_api" "api" { + service_id = tencentcloud_api_gateway_service.example.id + api_name = "tf-example" + api_desc = "desc." + auth_type = "NONE" + protocol = "HTTP" + enable_cors = true + request_config_path = "/user/info" + request_config_method = "GET" + + request_parameters { + name = "name" + position = "QUERY" + type = "string" + desc = "who are you?" + default_value = "tom" + required = true + } + service_config_type = "HTTP" + service_config_timeout = 15 + service_config_url = "http://www.qq.com" + service_config_path = "/user" + service_config_method = "GET" + response_type = "HTML" + response_success_example = "success" + response_fail_example = "fail" + response_error_codes { + code = 500 + msg = "system error" + desc = "system error code" + converted_code = 5000 + need_convert = true + } + + release_limit = 500 + pre_limit = 500 + test_limit = 500 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_name` - (Required, String) Custom API name. +* `request_config_path` - (Required, String) Request frontend path configuration. Like `/user/getinfo`. +* `service_id` - (Required, String, ForceNew) The unique ID of the service where the API is located. Refer to resource `tencentcloud_api_gateway_service`. +* `api_business_type` - (Optional, String) When `auth_type` is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API. +* `api_desc` - (Optional, String) Custom API description. +* `api_type` - (Optional, String) API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL. +* `auth_relation_api_id` - (Optional, String) The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding. +* `auth_type` - (Optional, String) API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE. +* `constant_parameters` - (Optional, Set) Constant parameter. +* `eiam_app_id` - (Optional, String) EIAM application ID. +* `eiam_app_type` - (Optional, String) EIAM application type. +* `eiam_auth_type` - (Optional, String) The EIAM application authentication type supports AuthenticationOnly, Authentication, and Authorization. +* `enable_cors` - (Optional, Bool) Whether to enable CORS. Default value: `true`. +* `event_bus_id` - (Optional, String) Event bus ID. +* `is_base64_encoded` - (Optional, Bool) Whether to enable Base64 encoding will only take effect when the backend is scf. +* `is_debug_after_charge` - (Optional, Bool) Charge after starting debugging. (Cloud Market Reserved Fields). +* `is_delete_response_error_codes` - (Optional, Bool) Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted. +* `micro_services` - (Optional, Set) API bound microservice list. +* `oauth_config` - (Optional, List) OAuth configuration. Effective when AuthType is OAUTH. +* `owner` - (Optional, String) Owner of resources. +* `pre_limit` - (Optional, Int) API QPS value. Enter a positive number to limit the API query rate per second `QPS`. +* `protocol` - (Optional, String, ForceNew) API frontend request type. Valid values: `HTTP`, `WEBSOCKET`. Default value: `HTTP`. +* `release_limit` - (Optional, Int) API QPS value. Enter a positive number to limit the API query rate per second `QPS`. +* `request_config_method` - (Optional, String) Request frontend method configuration. Valid values: `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`ANY`. Default value: `GET`. +* `request_parameters` - (Optional, Set) Frontend request parameters. +* `response_error_codes` - (Optional, Set) Custom error code configuration. Must keep at least one after set. +* `response_fail_example` - (Optional, String) Response failure sample of custom response configuration. +* `response_success_example` - (Optional, String) Successful response sample of custom response configuration. +* `response_type` - (Optional, String) Return type. Valid values: `HTML`, `JSON`, `TEXT`, `BINARY`, `XML`. Default value: `HTML`. +* `service_config_cos_config` - (Optional, List) API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained. +* `service_config_method` - (Optional, String) API backend service request method, such as `GET`. If `service_config_type` is `HTTP`, this parameter will be required. The frontend `request_config_method` and backend method `service_config_method` can be different. +* `service_config_mock_return_message` - (Optional, String) Returned information of API backend mocking. This parameter is required when `service_config_type` is `MOCK`. +* `service_config_path` - (Optional, String) API backend service path, such as /path. If `service_config_type` is `HTTP`, this parameter will be required. The frontend `request_config_path` and backend path `service_config_path` can be different. +* `service_config_product` - (Optional, String) Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream. +* `service_config_scf_function_name` - (Optional, String) SCF function name. This parameter takes effect when `service_config_type` is `SCF`. +* `service_config_scf_function_namespace` - (Optional, String) SCF function namespace. This parameter takes effect when `service_config_type` is `SCF`. +* `service_config_scf_function_qualifier` - (Optional, String) SCF function version. This parameter takes effect when `service_config_type` is `SCF`. +* `service_config_scf_function_type` - (Optional, String) Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP). +* `service_config_scf_is_integrated_response` - (Optional, Bool) Whether to enable response integration. Effective when the backend type is SCF. +* `service_config_timeout` - (Optional, Int) API backend service timeout period in seconds. Default value: `5`. +* `service_config_type` - (Optional, String) The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing). +* `service_config_upstream_id` - (Optional, String) Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained. +* `service_config_url` - (Optional, String) The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed. +* `service_config_vpc_id` - (Optional, String) Unique VPC ID. +* `service_config_websocket_cleanup_function_name` - (Optional, String) Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_cleanup_function_namespace` - (Optional, String) Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_cleanup_function_qualifier` - (Optional, String) Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_register_function_name` - (Optional, String) Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_register_function_namespace` - (Optional, String) Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_register_function_qualifier` - (Optional, String) Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_transport_function_name` - (Optional, String) Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_transport_function_namespace` - (Optional, String) Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_transport_function_qualifier` - (Optional, String) Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_parameters` - (Optional, List) The backend service parameters of the API. +* `service_tsf_health_check_conf` - (Optional, List) Health check configuration for microservices. +* `service_tsf_load_balance_conf` - (Optional, List) Load balancing configuration for microservices. +* `target_namespace_id` - (Optional, String) Tsf serverless namespace ID. (In internal testing). +* `target_services_health_check_conf` - (Optional, List) Target health check configuration. (Internal testing stage). +* `target_services_load_balance_conf` - (Optional, Int) Target type load balancing configuration. (Internal testing stage). +* `target_services` - (Optional, List) Target type backend resource information. (Internal testing stage). +* `test_limit` - (Optional, Int) API QPS value. Enter a positive number to limit the API query rate per second `QPS`. +* `token_timeout` - (Optional, Int) The effective time of the EIAM application token, measured in seconds, defaults to 7200 seconds. +* `user_type` - (Optional, String) User type. + +The `constant_parameters` object supports the following: + +* `default_value` - (Optional, String) Default value for constant parameters. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. +* `desc` - (Optional, String) Constant parameter description. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. +* `name` - (Optional, String) Constant parameter name. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. +* `position` - (Optional, String) Constant parameter position. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. + +The `micro_services` object supports the following: + +* `cluster_id` - (Required, String) Micro service cluster. +* `micro_service_name` - (Required, String) Microservice name. +* `namespace_id` - (Required, String) Microservice namespace. + +The `oauth_config` object supports the following: + +* `public_key` - (Required, String) Public key, used to verify user tokens. +* `token_location` - (Required, String) Token passes the position. +* `login_redirect_url` - (Optional, String) Redirect address, used to guide users in login operations. + +The `request_parameters` object supports the following: + +* `name` - (Required, String) Parameter name. +* `position` - (Required, String) Parameter location. +* `type` - (Required, String) Parameter type. +* `default_value` - (Optional, String) Parameter default value. +* `desc` - (Optional, String) Parameter description. +* `required` - (Optional, Bool) If this parameter required. Default value: `false`. + +The `response_error_codes` object supports the following: + +* `code` - (Required, Int) Custom response configuration error code. +* `msg` - (Required, String) Custom response configuration error message. +* `converted_code` - (Optional, Int) Custom error code conversion. +* `desc` - (Optional, String) Parameter description. +* `need_convert` - (Optional, Bool) Whether to enable error code conversion. Default value: `false`. + +The `service_config_cos_config` object supports the following: + +* `action` - (Required, String) The API calls the backend COS method, and the optional values for the front-end request method and Action are:GET: GetObjectPUT: PutObjectPOST: PostObject, AppendObjectHEAD: HeadObjectDELETE: DeleteObject.Note: This field may return null, indicating that a valid value cannot be obtained. +* `bucket_name` - (Required, String) The bucket name of the API backend COS.Note: This field may return null, indicating that a valid value cannot be obtained. +* `authorization` - (Optional, Bool) The API calls the signature switch of the backend COS, which defaults to false.Note: This field may return null, indicating that a valid value cannot be obtained. +* `path_match_mode` - (Optional, String) Path matching mode for API backend COS, optional values:BackEndPath: Backend path matchingFullPath: Full Path MatchingThe default value is: BackEndPathNote: This field may return null, indicating that a valid value cannot be obtained. + +The `service_parameters` object supports the following: + +* `default_value` - (Optional, String) The default value for the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. +* `name` - (Optional, String) The backend service parameter name of the API. This parameter is only used when ServiceType is HTTP. The front and rear parameter names can be different.Note: This field may return null, indicating that a valid value cannot be obtained. +* `position` - (Optional, String) The backend service parameter location of the API, such as head. This parameter is only used when ServiceType is HTTP. The parameter positions at the front and rear ends can be configured differently.Note: This field may return null, indicating that a valid value cannot be obtained. +* `relevant_request_parameter_desc` - (Optional, String) Remarks on the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. +* `relevant_request_parameter_name` - (Optional, String) The name of the front-end parameter corresponding to the backend service parameter of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. +* `relevant_request_parameter_position` - (Optional, String) The location of the front-end parameters corresponding to the backend service parameters of the API, such as head. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. +* `relevant_request_parameter_type` - (Optional, String) The backend service parameter type of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. + +The `service_tsf_health_check_conf` object supports the following: + +* `error_threshold_percentage` - (Optional, Int) Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained. +* `is_health_check` - (Optional, Bool) Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained. +* `request_volume_threshold` - (Optional, Int) Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained. +* `sleep_window_in_milliseconds` - (Optional, Int) Window size.Note: This field may return null, indicating that a valid value cannot be obtained. + +The `service_tsf_load_balance_conf` object supports the following: + +* `is_load_balance` - (Optional, Bool) Is load balancing enabled.Note: This field may return null, indicating that a valid value cannot be obtained. +* `method` - (Optional, String) Load balancing method.Note: This field may return null, indicating that a valid value cannot be obtained. +* `session_stick_required` - (Optional, Bool) Whether to enable session persistence.Note: This field may return null, indicating that a valid value cannot be obtained. +* `session_stick_timeout` - (Optional, Int) Session hold timeout.Note: This field may return null, indicating that a valid value cannot be obtained. + +The `target_services_health_check_conf` object supports the following: + +* `error_threshold_percentage` - (Optional, Int) Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained. +* `is_health_check` - (Optional, Bool) Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained. +* `request_volume_threshold` - (Optional, Int) Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained. +* `sleep_window_in_milliseconds` - (Optional, Int) Window size.Note: This field may return null, indicating that a valid value cannot be obtained. + +The `target_services` object supports the following: + +* `host_ip` - (Required, String) Host IP of the CVM. +* `vm_ip` - (Required, String) vm ip. +* `vm_port` - (Required, Int) vm port. +* `vpc_id` - (Required, String) vpc id. +* `docker_ip` - (Optional, String) docker ip. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. +* `update_time` - Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + + diff --git a/config/docs/r/api_gateway_api_app.html.markdown b/config/docs/r/api_gateway_api_app.html.markdown new file mode 100644 index 0000000..b28484e --- /dev/null +++ b/config/docs/r/api_gateway_api_app.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_app" +sidebar_current: "docs-tencentcloud-resource-api_gateway_api_app" +description: |- + Provides a resource to create a APIGateway ApiApp +--- + +# tencentcloud_api_gateway_api_app + +Provides a resource to create a APIGateway ApiApp + +## Example Usage + +### Create a basic apigateway api_app + +```hcl +resource "tencentcloud_api_gateway_api_app" "example" { + api_app_name = "tf_example" + api_app_desc = "app desc." +} +``` + +### Bind Tag + +```hcl +resource "tencentcloud_api_gateway_api_app" "example" { + api_app_name = "tf_example" + api_app_desc = "app desc." + + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_app_name` - (Required, String) Api app name. +* `api_app_desc` - (Optional, String) App description. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `api_app_id` - Api app ID. +* `api_app_key` - Api app key. +* `api_app_secret` - Api app secret. +* `created_time` - Api app created time. +* `modified_time` - Api app modified time. + + +## Import + +apigateway api_app can be imported using the id, e.g. + +``` +terraform import tencentcloud_api_gateway_api_app.example app-poe0pyex +``` + diff --git a/config/docs/r/api_gateway_api_app_attachment.html.markdown b/config/docs/r/api_gateway_api_app_attachment.html.markdown new file mode 100644 index 0000000..7f6c3fd --- /dev/null +++ b/config/docs/r/api_gateway_api_app_attachment.html.markdown @@ -0,0 +1,99 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_app_attachment" +sidebar_current: "docs-tencentcloud-resource-api_gateway_api_app_attachment" +description: |- + Provides a resource to create a apigateway api_app_attachment +--- + +# tencentcloud_api_gateway_api_app_attachment + +Provides a resource to create a apigateway api_app_attachment + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_api_app" "example" { + api_app_name = "tf_example" + api_app_desc = "app desc." +} + +resource "tencentcloud_api_gateway_service" "example" { + service_name = "tf_example_service" + protocol = "http&https" + service_desc = "your nice service" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_api" "example" { + service_id = tencentcloud_api_gateway_service.example.id + api_name = "tf_example_api" + api_desc = "desc." + auth_type = "APP" + protocol = "HTTP" + enable_cors = true + request_config_path = "/user/info" + request_config_method = "GET" + + request_parameters { + name = "name" + position = "QUERY" + type = "string" + desc = "desc." + default_value = "terraform" + required = true + } + + service_config_type = "HTTP" + service_config_timeout = 15 + service_config_url = "https://www.qq.com" + service_config_path = "/user" + service_config_method = "GET" + response_type = "HTML" + response_success_example = "success" + response_fail_example = "fail" + + response_error_codes { + code = 400 + msg = "system error msg." + desc = "system error desc." + converted_code = 407 + need_convert = true + } +} + +resource "tencentcloud_api_gateway_api_app_attachment" "example" { + api_app_id = tencentcloud_api_gateway_api_app.example.id + environment = "test" + service_id = tencentcloud_api_gateway_service.example.id + api_id = tencentcloud_api_gateway_api.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_app_id` - (Required, String, ForceNew) The unique ID of the application to be bound. +* `api_id` - (Required, String, ForceNew) The unique ID of the API to be bound. +* `environment` - (Required, String, ForceNew) The environment to be bound. +* `service_id` - (Required, String, ForceNew) The unique ID of the service to be bound. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +apigateway api_app_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_api_gateway_api_app_attachment.example app-f2dxx0lv#test#service-h0trno8e#api-grsomg0w +``` + diff --git a/config/docs/r/api_gateway_api_doc.html.markdown b/config/docs/r/api_gateway_api_doc.html.markdown new file mode 100644 index 0000000..10f47ed --- /dev/null +++ b/config/docs/r/api_gateway_api_doc.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_doc" +sidebar_current: "docs-tencentcloud-resource-api_gateway_api_doc" +description: |- + Provides a resource to create a APIGateway ApiDoc +--- + +# tencentcloud_api_gateway_api_doc + +Provides a resource to create a APIGateway ApiDoc + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_api_doc" "my_api_doc" { + api_doc_name = "doc_test1" + service_id = "service_test1" + environment = "release" + api_ids = ["api-test1", "api-test2"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_doc_name` - (Required, String) Api Document name. +* `api_ids` - (Required, Set: [`String`]) List of APIs for generating documents. +* `environment` - (Required, String) Env name. +* `service_id` - (Required, String) Service name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `api_count` - Api Document count. +* `api_doc_id` - Api Document ID. +* `api_doc_status` - API Document Build Status. +* `api_doc_uri` - API Document Access URI. +* `api_names` - List of names for generating documents. +* `release_count` - Number of API document releases. +* `service_name` - API Document service name. +* `share_password` - API Document Sharing Password. +* `updated_time` - API Document update time. +* `view_count` - API Document Viewing Times. + + diff --git a/config/docs/r/api_gateway_api_key.html.markdown b/config/docs/r/api_gateway_api_key.html.markdown new file mode 100644 index 0000000..261f464 --- /dev/null +++ b/config/docs/r/api_gateway_api_key.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_key" +sidebar_current: "docs-tencentcloud-resource-api_gateway_api_key" +description: |- + Use this resource to create API gateway access key. +--- + +# tencentcloud_api_gateway_api_key + +Use this resource to create API gateway access key. + +## Example Usage + +### Automatically generate key for API gateway access key. + +```hcl +resource "tencentcloud_api_gateway_api_key" "example_auto" { + secret_name = "tf_example_auto" + status = "on" +} +``` + +### Manually generate a secret key for API gateway access key. + +```hcl +resource "tencentcloud_api_gateway_api_key" "example_manual" { + secret_name = "tf_example_manual" + status = "on" + access_key_type = "manual" + access_key_id = "28e287e340507fa147b2c8284dab542f" + access_key_secret = "0198a4b8c3105080f4acd9e507599eff" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `secret_name` - (Required, String, ForceNew) Custom key name. +* `access_key_id` - (Optional, String) User defined key ID, required when access_key_type is manual. The length is 5-50 characters, consisting of letters, numbers, and English underscores. +* `access_key_secret` - (Optional, String) The user-defined key must be passed when the access_key_type is manual. The length is 10-50 characters, consisting of letters, numbers, and English underscores. +* `access_key_type` - (Optional, String) Key type, supports both auto and manual (custom keys), defaults to auto. +* `status` - (Optional, String) Key status. Valid values: `on`, `off`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. +* `modify_time` - Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + + +## Import + +API gateway access key can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_api_gateway_api_key.test AKIDMZwceezso9ps5p8jkro8a9fwe1e7nzF2k50B +``` + diff --git a/config/docs/r/api_gateway_api_key_attachment.html.markdown b/config/docs/r/api_gateway_api_key_attachment.html.markdown new file mode 100644 index 0000000..d16ed37 --- /dev/null +++ b/config/docs/r/api_gateway_api_key_attachment.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_api_key_attachment" +sidebar_current: "docs-tencentcloud-resource-api_gateway_api_key_attachment" +description: |- + Use this resource to API gateway attach access key to usage plan. +--- + +# tencentcloud_api_gateway_api_key_attachment + +Use this resource to API gateway attach access key to usage plan. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_api_key" "key" { + secret_name = "my_api_key" + status = "on" +} + +resource "tencentcloud_api_gateway_usage_plan" "plan" { + usage_plan_name = "my_plan" + usage_plan_desc = "nice plan" + max_request_num = 100 + max_request_num_pre_sec = 10 +} + +resource "tencentcloud_api_gateway_api_key_attachment" "attach" { + api_key_id = tencentcloud_api_gateway_api_key.key.id + usage_plan_id = tencentcloud_api_gateway_usage_plan.plan.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_key_id` - (Required, String, ForceNew) ID of API key. +* `usage_plan_id` - (Required, String, ForceNew) ID of the usage plan. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +API gateway attach access key can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_api_gateway_api_key_attachment.attach AKID110b8Rmuw7t0fP1N8bi809n327023Is7xN8f#usagePlan-gyeafpab +``` + diff --git a/config/docs/r/api_gateway_custom_domain.html.markdown b/config/docs/r/api_gateway_custom_domain.html.markdown new file mode 100644 index 0000000..569e617 --- /dev/null +++ b/config/docs/r/api_gateway_custom_domain.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_custom_domain" +sidebar_current: "docs-tencentcloud-resource-api_gateway_custom_domain" +description: |- + Use this resource to create custom domain of API gateway. +--- + +# tencentcloud_api_gateway_custom_domain + +Use this resource to create custom domain of API gateway. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_custom_domain" "foo" { + service_id = "service-ohxqslqe" + sub_domain = "tic-test.dnsv1.com" + protocol = "http" + net_type = "OUTER" + is_default_mapping = "false" + default_domain = "service-ohxqslqe-1259649581.gz.apigw.tencentcs.com" + path_mappings = ["/good#test", "/root#release"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `default_domain` - (Required, String) Default domain name. +* `net_type` - (Required, String) Network type. Valid values: `OUTER`, `INNER`. +* `protocol` - (Required, String) Protocol supported by service. Valid values: `http`, `https`, `http&https`. +* `service_id` - (Required, String, ForceNew) Unique service ID. +* `sub_domain` - (Required, String) Custom domain name to be bound. +* `certificate_id` - (Optional, String) Unique certificate ID of the custom domain name to be bound. You can choose to upload for the `protocol` attribute value `https` or `http&https`. +* `is_default_mapping` - (Optional, Bool) Whether the default path mapping is used. The default value is `true`. When it is `false`, it means custom path mapping. In this case, the `path_mappings` attribute is required. +* `is_forced_https` - (Optional, Bool) Whether to force HTTP requests to jump to HTTPS, default to false. When the parameter is true, the API gateway will redirect all HTTP protocol requests using the custom domain name to the HTTPS protocol for forwarding. +* `path_mappings` - (Optional, Set: [`String`]) Custom domain name path mapping. The data format is: `path#environment`. Optional values for the environment are `test`, `prepub`, and `release`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - Domain name resolution status. `1` means normal analysis, `0` means parsing failed. + + diff --git a/config/docs/r/api_gateway_import_open_api.html.markdown b/config/docs/r/api_gateway_import_open_api.html.markdown new file mode 100644 index 0000000..4eb451d --- /dev/null +++ b/config/docs/r/api_gateway_import_open_api.html.markdown @@ -0,0 +1,144 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_import_open_api" +sidebar_current: "docs-tencentcloud-resource-api_gateway_import_open_api" +description: |- + Provides a resource to create a apiGateway import_open_api +--- + +# tencentcloud_api_gateway_import_open_api + +Provides a resource to create a apiGateway import_open_api + +## Example Usage + +### Import open Api by YAML + +```hcl +resource "tencentcloud_api_gateway_import_open_api" "example" { + service_id = "service-nxz6yync" + content = "info:\n title: keep-service\n version: 1.0.1\nopenapi: 3.0.0\npaths:\n /api/test:\n get:\n description: desc\n operationId: test\n responses:\n '200':\n content:\n text/html:\n example: '200'\n description: '200'\n default:\n content:\n text/html:\n example: '400'\n description: '400'\n x-apigw-api-business-type: NORMAL\n x-apigw-api-type: NORMAL\n x-apigw-backend:\n ServiceConfig:\n Method: GET\n Path: /test\n Url: http://domain.com\n ServiceType: HTTP\n x-apigw-cors: false\n x-apigw-protocol: HTTP\n x-apigw-service-timeout: 15\n" + encode_type = "YAML" + content_version = "openAPI" +} +``` + +### Import open Api by JSON + +```hcl +resource "tencentcloud_api_gateway_import_open_api" "example" { + service_id = "service-nxz6yync" + content = "{\"openapi\": \"3.0.0\", \"info\": {\"title\": \"keep-service\", \"version\": \"1.0.1\"}, \"paths\": {\"/api/test\": {\"get\": {\"operationId\": \"test\", \"description\": \"desc\", \"responses\": {\"200\": {\"description\": \"200\", \"content\": {\"text/html\": {\"example\": \"200\"}}}, \"default\": {\"content\": {\"text/html\": {\"example\": \"400\"}}, \"description\": \"400\"}}, \"x-apigw-api-type\": \"NORMAL\", \"x-apigw-api-business-type\": \"NORMAL\", \"x-apigw-protocol\": \"HTTP\", \"x-apigw-cors\": false, \"x-apigw-service-timeout\": 15, \"x-apigw-backend\": {\"ServiceType\": \"HTTP\", \"ServiceConfig\": {\"Url\": \"http://domain.com\", \"Path\": \"/test\", \"Method\": \"GET\"}}}}}}" + encode_type = "JSON" + content_version = "openAPI" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `content` - (Required, String, ForceNew) OpenAPI body content. +* `service_id` - (Required, String, ForceNew) The unique ID of the service where the API is located. +* `content_version` - (Optional, String, ForceNew) The Content version defaults to OpenAPI and currently only supports OpenAPI. +* `encode_type` - (Optional, String, ForceNew) The Content format can only be YAML or JSON, and the default is YAML. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `api_business_type` - When `auth_type` is OAUTH, this field is valid, NORMAL: Business API, OAUTH: Authorization API. +* `api_desc` - Custom API description. +* `api_id` - Custom Api Id. +* `api_name` - Custom API name. +* `api_type` - API type, supports NORMAL (regular API) and TSF (microservice API), defaults to NORMAL. +* `auth_relation_api_id` - The unique ID of the associated authorization API takes effect when AuthType is OAUTH and ApiBusinessType is NORMAL. The unique ID of the oauth2.0 authorized API that identifies the business API binding. +* `auth_type` - API authentication type. Support SECRET (Key Pair Authentication), NONE (Authentication Exemption), OAUTH, APP (Application Authentication). The default is NONE. +* `constant_parameters` - Constant parameter. + * `default_value` - Default value for constant parameters. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. + * `desc` - Constant parameter description. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. + * `name` - Constant parameter name. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. + * `position` - Constant parameter position. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. +* `create_time` - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. +* `enable_cors` - Whether to enable CORS. Default value: `true`. +* `is_base64_encoded` - Whether to enable Base64 encoding will only take effect when the backend is scf. +* `is_debug_after_charge` - Charge after starting debugging. (Cloud Market Reserved Fields). +* `is_delete_response_error_codes` - Do you want to delete the custom response configuration error code? If it is not passed or False is passed, it will not be deleted. If True is passed, all custom response configuration error codes for this API will be deleted. +* `micro_services` - API bound microservice list. + * `cluster_id` - Micro service cluster. + * `micro_service_name` - Microservice name. + * `namespace_id` - Microservice namespace. +* `oauth_config` - OAuth configuration. Effective when AuthType is OAUTH. + * `login_redirect_url` - Redirect address, used to guide users in login operations. + * `public_key` - Public key, used to verify user tokens. + * `token_location` - Token passes the position. +* `protocol` - API frontend request type. Valid values: `HTTP`, `WEBSOCKET`. Default value: `HTTP`. +* `request_config_method` - Request frontend method configuration. Valid values: `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`ANY`. Default value: `GET`. +* `request_config_path` - Request frontend path configuration. Like `/user/getinfo`. +* `request_parameters` - Frontend request parameters. + * `default_value` - Parameter default value. + * `desc` - Parameter description. + * `name` - Parameter name. + * `position` - Parameter location. + * `required` - If this parameter required. Default value: `false`. + * `type` - Parameter type. +* `response_error_codes` - Custom error code configuration. Must keep at least one after set. + * `code` - Custom response configuration error code. + * `converted_code` - Custom error code conversion. + * `desc` - Parameter description. + * `msg` - Custom response configuration error message. + * `need_convert` - Whether to enable error code conversion. Default value: `false`. +* `response_fail_example` - Response failure sample of custom response configuration. +* `response_success_example` - Successful response sample of custom response configuration. +* `response_type` - Return type. Valid values: `HTML`, `JSON`, `TEXT`, `BINARY`, `XML`. Default value: `HTML`. +* `service_config_cos_config` - API backend COS configuration. If ServiceType is COS, then this parameter must be passed.Note: This field may return null, indicating that a valid value cannot be obtained. + * `action` - The API calls the backend COS method, and the optional values for the front-end request method and Action are:GET: GetObjectPUT: PutObjectPOST: PostObject, AppendObjectHEAD: HeadObjectDELETE: DeleteObject.Note: This field may return null, indicating that a valid value cannot be obtained. + * `authorization` - The API calls the signature switch of the backend COS, which defaults to false.Note: This field may return null, indicating that a valid value cannot be obtained. + * `bucket_name` - The bucket name of the API backend COS.Note: This field may return null, indicating that a valid value cannot be obtained. + * `path_match_mode` - Path matching mode for API backend COS, optional values:BackEndPath: Backend path matchingFullPath: Full Path MatchingThe default value is: BackEndPathNote: This field may return null, indicating that a valid value cannot be obtained. +* `service_config_method` - API backend service request method, such as `GET`. If `service_config_type` is `HTTP`, this parameter will be required. The frontend `request_config_method` and backend method `service_config_method` can be different. +* `service_config_mock_return_message` - Returned information of API backend mocking. This parameter is required when `service_config_type` is `MOCK`. +* `service_config_path` - API backend service path, such as /path. If `service_config_type` is `HTTP`, this parameter will be required. The frontend `request_config_path` and backend path `service_config_path` can be different. +* `service_config_product` - Backend type. Effective when enabling vpc, currently supported types are clb, cvm, and upstream. +* `service_config_scf_function_name` - SCF function name. This parameter takes effect when `service_config_type` is `SCF`. +* `service_config_scf_function_namespace` - SCF function namespace. This parameter takes effect when `service_config_type` is `SCF`. +* `service_config_scf_function_qualifier` - SCF function version. This parameter takes effect when `service_config_type` is `SCF`. +* `service_config_scf_function_type` - Scf function type. Effective when the backend type is SCF. Support Event Triggering (EVENT) and HTTP Direct Cloud Function (HTTP). +* `service_config_scf_is_integrated_response` - Whether to enable response integration. Effective when the backend type is SCF. +* `service_config_timeout` - API backend service timeout period in seconds. Default value: `5`. +* `service_config_type` - The backend service type of the API. Supports HTTP, MOCK, TSF, SCF, WEBSOCKET, COS, TARGET (internal testing). +* `service_config_upstream_id` - Only required when binding to VPC channelsNote: This field may return null, indicating that a valid value cannot be obtained. +* `service_config_url` - The backend service URL of the API. If the ServiceType is HTTP, this parameter must be passed. +* `service_config_vpc_id` - Unique VPC ID. +* `service_config_websocket_cleanup_function_name` - Scf websocket cleaning function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_cleanup_function_namespace` - Scf websocket cleans up the function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_cleanup_function_qualifier` - Scf websocket cleaning function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_register_function_name` - Scf websocket registration function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_register_function_namespace` - Scf websocket registers function namespaces. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_register_function_qualifier` - Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_transport_function_name` - Scf websocket transfer function. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_transport_function_namespace` - Scf websocket transfer function namespace. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_config_websocket_transport_function_qualifier` - Scf websocket transfer function version. It takes effect when the current end type is WEBSOCKET and the backend type is SCF. +* `service_parameters` - The backend service parameters of the API. + * `default_value` - The default value for the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. + * `name` - The backend service parameter name of the API. This parameter is only used when ServiceType is HTTP. The front and rear parameter names can be different.Note: This field may return null, indicating that a valid value cannot be obtained. + * `position` - The backend service parameter location of the API, such as head. This parameter is only used when ServiceType is HTTP. The parameter positions at the front and rear ends can be configured differently.Note: This field may return null, indicating that a valid value cannot be obtained. + * `relevant_request_parameter_desc` - Remarks on the backend service parameters of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. + * `relevant_request_parameter_name` - The name of the front-end parameter corresponding to the backend service parameter of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. + * `relevant_request_parameter_position` - The location of the front-end parameters corresponding to the backend service parameters of the API, such as head. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. + * `relevant_request_parameter_type` - The backend service parameter type of the API. This parameter is only used when ServiceType is HTTP.Note: This field may return null, indicating that a valid value cannot be obtained. +* `service_tsf_health_check_conf` - Health check configuration for microservices. + * `error_threshold_percentage` - Threshold percentage.Note: This field may return null, indicating that a valid value cannot be obtained. + * `is_health_check` - Whether to initiate a health check.Note: This field may return null, indicating that a valid value cannot be obtained. + * `request_volume_threshold` - Health check threshold.Note: This field may return null, indicating that a valid value cannot be obtained. + * `sleep_window_in_milliseconds` - Window size.Note: This field may return null, indicating that a valid value cannot be obtained. +* `service_tsf_load_balance_conf` - Load balancing configuration for microservices. + * `is_load_balance` - Is load balancing enabled.Note: This field may return null, indicating that a valid value cannot be obtained. + * `method` - Load balancing method.Note: This field may return null, indicating that a valid value cannot be obtained. + * `session_stick_required` - Whether to enable session persistence.Note: This field may return null, indicating that a valid value cannot be obtained. + * `session_stick_timeout` - Session hold timeout.Note: This field may return null, indicating that a valid value cannot be obtained. +* `update_time` - Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + + diff --git a/config/docs/r/api_gateway_ip_strategy.html.markdown b/config/docs/r/api_gateway_ip_strategy.html.markdown new file mode 100644 index 0000000..2b44d69 --- /dev/null +++ b/config/docs/r/api_gateway_ip_strategy.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_ip_strategy" +sidebar_current: "docs-tencentcloud-resource-api_gateway_ip_strategy" +description: |- + Use this resource to create IP strategy of API gateway. +--- + +# tencentcloud_api_gateway_ip_strategy + +Use this resource to create IP strategy of API gateway. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_service" "service" { + service_name = "niceservice" + protocol = "http&https" + service_desc = "your nice service" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_ip_strategy" "test" { + service_id = tencentcloud_api_gateway_service.service.id + strategy_name = "tf_test" + strategy_type = "BLACK" + strategy_data = "9.9.9.9" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `service_id` - (Required, String, ForceNew) The ID of the API gateway service. +* `strategy_data` - (Required, String) IP address data. +* `strategy_name` - (Required, String, ForceNew) User defined strategy name. +* `strategy_type` - (Required, String, ForceNew) Blacklist or whitelist. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. +* `strategy_id` - IP policy ID. + + +## Import + +IP strategy of API gateway can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_api_gateway_ip_strategy.test service-ohxqslqe#IPStrategy-q1lk8ud2 +``` + diff --git a/config/docs/r/api_gateway_plugin.html.markdown b/config/docs/r/api_gateway_plugin.html.markdown new file mode 100644 index 0000000..279f94e --- /dev/null +++ b/config/docs/r/api_gateway_plugin.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_plugin" +sidebar_current: "docs-tencentcloud-resource-api_gateway_plugin" +description: |- + Provides a resource to create a apiGateway plugin +--- + +# tencentcloud_api_gateway_plugin + +Provides a resource to create a apiGateway plugin + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_plugin" "example" { + plugin_name = "tf-example" + plugin_type = "IPControl" + plugin_data = jsonencode({ + "type" : "white_list", + "blocks" : "1.1.1.1", + }) + description = "desc." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `plugin_data` - (Required, String) Statement to define plugin. +* `plugin_name` - (Required, String) Name of the user define plugin. It must start with a letter and end with letter or number, the rest can contain letters, numbers and dashes(-). The length range is from 2 to 50. +* `plugin_type` - (Required, String) Type of plugin. Now support IPControl, TrafficControl, Cors, CustomReq, CustomAuth, Routing, TrafficControlByParameter, CircuitBreaker, ProxyCache. +* `description` - (Optional, String) Description of plugin. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +apiGateway plugin can be imported using the id, e.g. + +``` +terraform import tencentcloud_api_gateway_plugin.plugin plugin_id +``` + diff --git a/config/docs/r/api_gateway_plugin_attachment.html.markdown b/config/docs/r/api_gateway_plugin_attachment.html.markdown new file mode 100644 index 0000000..183b83b --- /dev/null +++ b/config/docs/r/api_gateway_plugin_attachment.html.markdown @@ -0,0 +1,110 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_plugin_attachment" +sidebar_current: "docs-tencentcloud-resource-api_gateway_plugin_attachment" +description: |- + Provides a resource to create a apiGateway plugin_attachment +--- + +# tencentcloud_api_gateway_plugin_attachment + +Provides a resource to create a apiGateway plugin_attachment + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_plugin" "example" { + plugin_name = "tf-example" + plugin_type = "IPControl" + plugin_data = jsonencode({ + "type" : "white_list", + "blocks" : "1.1.1.1", + }) + description = "desc." +} + +resource "tencentcloud_api_gateway_service" "example" { + service_name = "tf_example_service" + protocol = "http&https" + service_desc = "your nice service" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_api" "example" { + service_id = tencentcloud_api_gateway_service.example.id + api_name = "tf_example_api" + api_desc = "desc." + auth_type = "APP" + protocol = "HTTP" + enable_cors = true + request_config_path = "/user/info" + request_config_method = "GET" + + request_parameters { + name = "name" + position = "QUERY" + type = "string" + desc = "desc." + default_value = "terraform" + required = true + } + + service_config_type = "HTTP" + service_config_timeout = 15 + service_config_url = "https://www.qq.com" + service_config_path = "/user" + service_config_method = "GET" + response_type = "HTML" + response_success_example = "success" + response_fail_example = "fail" + + response_error_codes { + code = 400 + msg = "system error msg." + desc = "system error desc." + converted_code = 407 + need_convert = true + } +} + +resource "tencentcloud_api_gateway_service_release" "example" { + service_id = tencentcloud_api_gateway_api.example.service_id + environment_name = "release" + release_desc = "desc." +} + +resource "tencentcloud_api_gateway_plugin_attachment" "example" { + plugin_id = tencentcloud_api_gateway_plugin.example.id + service_id = tencentcloud_api_gateway_service_release.example.service_id + api_id = tencentcloud_api_gateway_api.example.id + environment_name = "release" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_id` - (Required, String, ForceNew) Id of API. +* `environment_name` - (Required, String, ForceNew) Name of Environment. +* `plugin_id` - (Required, String, ForceNew) Id of Plugin. +* `service_id` - (Required, String, ForceNew) Id of Service. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +apiGateway plugin_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_api_gateway_plugin_attachment.example plugin-hnqntalp#service-q3f533ja#release#api-62ud9woa +``` + diff --git a/config/docs/r/api_gateway_service.html.markdown b/config/docs/r/api_gateway_service.html.markdown new file mode 100644 index 0000000..ea435ba --- /dev/null +++ b/config/docs/r/api_gateway_service.html.markdown @@ -0,0 +1,114 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_service" +sidebar_current: "docs-tencentcloud-resource-api_gateway_service" +description: |- + Use this resource to create API gateway service. +--- + +# tencentcloud_api_gateway_service + +Use this resource to create API gateway service. + +~> **NOTE:** After setting `uniq_vpc_id`, it cannot be modified. + +## Example Usage + +### Shared Service + +```hcl +resource "tencentcloud_vpc" "vpc" { + name = "example-vpc" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_api_gateway_service" "example" { + service_name = "tf-example" + protocol = "http&https" + service_desc = "desc." + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" + uniq_vpc_id = tencentcloud_vpc.vpc.id + + tags = { + createdBy = "terraform" + } + + release_limit = 500 + pre_limit = 500 + test_limit = 500 +} +``` + +### Exclusive Service + +```hcl +resource "tencentcloud_api_gateway_service" "example" { + service_name = "tf-example" + protocol = "http&https" + service_desc = "desc." + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" + uniq_vpc_id = tencentcloud_vpc.vpc.id + instance_id = "instance-rc6fcv4e" + + tags = { + createdBy = "terraform" + } + + release_limit = 500 + pre_limit = 500 + test_limit = 500 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `net_type` - (Required, Set: [`String`]) Network type list, which is used to specify the supported network types. Valid values: `INNER`, `OUTER`. `INNER` indicates access over private network, and `OUTER` indicates access over public network. +* `protocol` - (Required, String) Service frontend request type. Valid values: `http`, `https`, `http&https`. +* `service_name` - (Required, String) Custom service name. +* `exclusive_set_name` - (Optional, String, ForceNew, **Deprecated**) It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created. +* `instance_id` - (Optional, String, ForceNew) Exclusive instance ID. +* `ip_version` - (Optional, String, ForceNew) IP version number. Valid values: `IPv4`, `IPv6`. Default value: `IPv4`. +* `pre_limit` - (Optional, Int) API QPS value. Enter a positive number to limit the API query rate per second `QPS`. +* `release_limit` - (Optional, Int) API QPS value. Enter a positive number to limit the API query rate per second `QPS`. +* `service_desc` - (Optional, String) Custom service description. +* `tags` - (Optional, Map) Tag description list. +* `test_limit` - (Optional, Int) API QPS value. Enter a positive number to limit the API query rate per second `QPS`. +* `uniq_vpc_id` - (Optional, String) VPC ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `api_list` - A list of APIs. + * `api_desc` - Description of the API. + * `api_id` - ID of the API. + * `api_name` - Name of the API. + * `method` - Method of the API. + * `path` - Path of the API. +* `create_time` - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. +* `inner_http_port` - Port number for http access over private network. +* `inner_https_port` - Port number for https access over private network. +* `internal_sub_domain` - Private network access subdomain name. +* `modify_time` - Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. +* `outer_sub_domain` - Public network access subdomain name. +* `usage_plan_list` - A list of attach usage plans. + * `api_id` - ID of the API. + * `bind_type` - Binding type. + * `usage_plan_id` - ID of the usage plan. + * `usage_plan_name` - Name of the usage plan. + + +## Import + +API gateway service can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_api_gateway_service.service service-pg6ud8pa +``` + diff --git a/config/docs/r/api_gateway_service_release.html.markdown b/config/docs/r/api_gateway_service_release.html.markdown new file mode 100644 index 0000000..5317527 --- /dev/null +++ b/config/docs/r/api_gateway_service_release.html.markdown @@ -0,0 +1,90 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_service_release" +sidebar_current: "docs-tencentcloud-resource-api_gateway_service_release" +description: |- + Use this resource to create API gateway service release. +--- + +# tencentcloud_api_gateway_service_release + +Use this resource to create API gateway service release. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_service" "service" { + service_name = "myservice" + protocol = "http" + service_desc = "my nice service" + net_type = ["INNER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_api" "api" { + service_id = tencentcloud_api_gateway_service.service.id + api_name = "tf_example" + api_desc = "my hello api update" + auth_type = "SECRET" + protocol = "HTTP" + enable_cors = true + request_config_path = "/user/info" + request_config_method = "POST" + request_parameters { + name = "email" + position = "QUERY" + type = "string" + desc = "your email please?" + default_value = "tom@qq.com" + required = true + } + service_config_type = "HTTP" + service_config_timeout = 10 + service_config_url = "http://www.tencent.com" + service_config_path = "/user" + service_config_method = "POST" + response_type = "XML" + response_success_example = "success" + response_fail_example = "fail" + response_error_codes { + code = 10 + msg = "system error" + desc = "system error code" + converted_code = -10 + need_convert = true + } +} + +resource "tencentcloud_api_gateway_service_release" "service" { + service_id = tencentcloud_api_gateway_api.api.service.id + environment_name = "release" + release_desc = "test service release" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `environment_name` - (Required, String, ForceNew) API gateway service environment name to be released. Valid values: `test`, `prepub`, `release`. +* `release_desc` - (Required, String, ForceNew) This release description of the API gateway service. +* `service_id` - (Required, String, ForceNew) ID of API gateway service. +* `release_version` - (Optional, String) The release version. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +API gateway service release can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_api_gateway_service_release.service service-jjt3fs3s#release#20201015121916d85fb161-eaec-4dda-a7e0-659aa5f401be +``` + diff --git a/config/docs/r/api_gateway_strategy_attachment.html.markdown b/config/docs/r/api_gateway_strategy_attachment.html.markdown new file mode 100644 index 0000000..5def52b --- /dev/null +++ b/config/docs/r/api_gateway_strategy_attachment.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_strategy_attachment" +sidebar_current: "docs-tencentcloud-resource-api_gateway_strategy_attachment" +description: |- + Use this resource to create IP strategy attachment of API gateway. +--- + +# tencentcloud_api_gateway_strategy_attachment + +Use this resource to create IP strategy attachment of API gateway. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_service" "service" { + service_name = "niceservice" + protocol = "http&https" + service_desc = "your nice service" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_ip_strategy" "test" { + service_id = tencentcloud_api_gateway_service.service.id + strategy_name = "tf_test" + strategy_type = "BLACK" + strategy_data = "9.9.9.9" +} + +resource "tencentcloud_api_gateway_api" "api" { + service_id = tencentcloud_api_gateway_service.service.id + api_name = "tf_example" + api_desc = "my hello api update" + auth_type = "SECRET" + protocol = "HTTP" + enable_cors = true + request_config_path = "/user/info" + request_config_method = "POST" + request_parameters { + name = "email" + position = "QUERY" + type = "string" + desc = "your email please?" + default_value = "tom@qq.com" + required = true + } + service_config_type = "HTTP" + service_config_timeout = 10 + service_config_url = "http://www.tencent.com" + service_config_path = "/user" + service_config_method = "POST" + response_type = "XML" + response_success_example = "success" + response_fail_example = "fail" + response_error_codes { + code = 10 + msg = "system error" + desc = "system error code" + converted_code = -10 + need_convert = true + } +} + +resource "tencentcloud_api_gateway_service_release" "service" { + service_id = tencentcloud_api_gateway_service.service.id + environment_name = "release" + release_desc = "test service release" +} + +resource "tencentcloud_api_gateway_strategy_attachment" "test" { + service_id = tencentcloud_api_gateway_service_release.service.service_id + strategy_id = tencentcloud_api_gateway_ip_strategy.test.strategy_id + environment_name = "release" + bind_api_id = tencentcloud_api_gateway_api.api.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bind_api_id` - (Required, String, ForceNew) The API that needs to be bound. +* `environment_name` - (Required, String, ForceNew) The environment of the strategy association. Valid values: `test`, `release`, `prepub`. +* `service_id` - (Required, String, ForceNew) The ID of the API gateway service. +* `strategy_id` - (Required, String, ForceNew) The ID of the API gateway strategy. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +IP strategy attachment of API gateway can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_api_gateway_strategy_attachment.test service-pk2r6bcc#IPStrategy-4kz2ljfi#api-h3wc5r0s#release +``` + diff --git a/config/docs/r/api_gateway_update_api_app_key.html.markdown b/config/docs/r/api_gateway_update_api_app_key.html.markdown new file mode 100644 index 0000000..a551906 --- /dev/null +++ b/config/docs/r/api_gateway_update_api_app_key.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_update_api_app_key" +sidebar_current: "docs-tencentcloud-resource-api_gateway_update_api_app_key" +description: |- + Provides a resource to create a apiGateway update_api_app_key +--- + +# tencentcloud_api_gateway_update_api_app_key + +Provides a resource to create a apiGateway update_api_app_key + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_update_api_app_key" "example" { + api_app_id = "app-krljp4wn" + api_app_key = "APID6JmG21yRCc03h4z16hlsTqj1wpO3dB3ZQcUP" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_app_id` - (Required, String, ForceNew) Application unique ID. +* `api_app_key` - (Required, String, ForceNew) Key of the application. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/api_gateway_upstream.html.markdown b/config/docs/r/api_gateway_upstream.html.markdown new file mode 100644 index 0000000..cf9ba49 --- /dev/null +++ b/config/docs/r/api_gateway_upstream.html.markdown @@ -0,0 +1,211 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_upstream" +sidebar_current: "docs-tencentcloud-resource-api_gateway_upstream" +description: |- + Provides a resource to create a apigateway upstream +--- + +# tencentcloud_api_gateway_upstream + +Provides a resource to create a apigateway upstream + +## Example Usage + +### Create a basic VPC channel + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cvm" +} + +data "tencentcloud_images" "images" { + image_type = ["PUBLIC_IMAGE"] + image_name_regex = "Final" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.3.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_instance" "example" { + instance_name = "tf_example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.3.name + image_id = data.tencentcloud_images.images.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "terraform" + project_id = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + + data_disks { + data_disk_type = "CLOUD_PREMIUM" + data_disk_size = 50 + encrypt = false + } + + tags = { + tagKey = "tagValue" + } +} + +resource "tencentcloud_api_gateway_upstream" "example" { + scheme = "HTTP" + algorithm = "ROUND-ROBIN" + uniq_vpc_id = tencentcloud_vpc.vpc.id + upstream_name = "tf_example" + upstream_description = "desc." + upstream_type = "IP_PORT" + retries = 5 + + nodes { + host = "1.1.1.1" + port = 9090 + weight = 10 + vm_instance_id = tencentcloud_instance.example.id + tags = ["tags"] + } + + tags = { + "createdBy" = "terraform" + } +} +``` + +### Create a complete VPC channel + +```hcl +resource "tencentcloud_api_gateway_upstream" "example" { + scheme = "HTTP" + algorithm = "ROUND-ROBIN" + uniq_vpc_id = tencentcloud_vpc.vpc.id + upstream_name = "tf_example" + upstream_description = "desc." + upstream_type = "IP_PORT" + retries = 5 + + nodes { + host = "1.1.1.1" + port = 9090 + weight = 10 + vm_instance_id = tencentcloud_instance.example.id + tags = ["tags"] + } + + health_checker { + enable_active_check = true + enable_passive_check = true + healthy_http_status = "200" + unhealthy_http_status = "500" + tcp_failure_threshold = 5 + timeout_threshold = 5 + http_failure_threshold = 3 + active_check_http_path = "/" + active_check_timeout = 5 + active_check_interval = 5 + unhealthy_timeout = 30 + } + + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `algorithm` - (Required, String) Load balancing algorithm, value range: ROUND-ROBIN. +* `scheme` - (Required, String) Backend protocol, value range: HTTP, HTTPS, gRPC, gRPCs. +* `uniq_vpc_id` - (Required, String) VPC Unique ID. +* `health_checker` - (Optional, List) Health check configuration, currently only supports VPC channels. +* `k8s_service` - (Optional, List) Configuration of K8S container service. +* `nodes` - (Optional, List) Backend nodes. +* `retries` - (Optional, Int) Request retry count, default to 3 times. +* `tags` - (Optional, Map) Tag description list. +* `upstream_description` - (Optional, String) Backend channel description. +* `upstream_host` - (Optional, String) Host request header forwarded by gateway to backend. +* `upstream_name` - (Optional, String) Backend channel name. +* `upstream_type` - (Optional, String) Backend access type, value range: IP_PORT, K8S. + +The `extra_labels` object supports the following: + +* `key` - (Required, String) Key of Label. +* `value` - (Required, String) Value of Label. + +The `health_checker` object supports the following: + +* `enable_active_check` - (Required, Bool) Identify whether active health checks are enabled. +* `enable_passive_check` - (Required, Bool) Identify whether passive health checks are enabled. +* `healthy_http_status` - (Required, String) The HTTP status code that determines a successful request during a health check. +* `http_failure_threshold` - (Required, Int) HTTP continuous error threshold. 0 means HTTP checking is disabled. Value range: [0, 254]. +* `tcp_failure_threshold` - (Required, Int) TCP continuous error threshold. 0 indicates disabling TCP checking. Value range: [0, 254]. +* `timeout_threshold` - (Required, Int) Continuous timeout threshold. 0 indicates disabling timeout checking. Value range: [0, 254]. +* `unhealthy_http_status` - (Required, String) The HTTP status code that determines a failed request during a health check. +* `active_check_http_path` - (Optional, String) Detect the requested path during active health checks. The default is'/'. +* `active_check_interval` - (Optional, Int) The time interval for active health checks is 5 seconds by default. +* `active_check_timeout` - (Optional, Int) The detection request for active health check timed out in seconds. The default is 5 seconds. +* `unhealthy_timeout` - (Optional, Int) The automatic recovery time of abnormal node status, in seconds. When only passive checking is enabled, it must be set to a value>0, otherwise the passive exception node will not be able to recover. The default is 30 seconds. + +The `k8s_service` object supports the following: + +* `cluster_id` - (Required, String) K8s cluster ID. +* `extra_labels` - (Required, List) Additional Selected Pod Label. +* `namespace` - (Required, String) Container namespace. +* `port` - (Required, Int) Port of service. +* `service_name` - (Required, String) The name of the container service. +* `weight` - (Required, Int) weight. +* `name` - (Optional, String) Customized service name, optional. + +The `nodes` object supports the following: + +* `host` - (Required, String) IP or domain name. +* `port` - (Required, Int) Port [0, 65535]. +* `weight` - (Required, Int) Weight [0, 100], 0 is disabled. +* `cluster_id` - (Optional, String) The ID of the TKE clusterNote: This field may return null, indicating that a valid value cannot be obtained. +* `name_space` - (Optional, String) K8S namespaceNote: This field may return null, indicating that a valid value cannot be obtained. +* `service_name` - (Optional, String) K8S container service nameNote: This field may return null, indicating that a valid value cannot be obtained. +* `source` - (Optional, String) Source of Node, value range: K8SNote: This field may return null, indicating that a valid value cannot be obtained. +* `tags` - (Optional, Set) Dye labelNote: This field may return null, indicating that a valid value cannot be obtained. +* `unique_service_name` - (Optional, String) Unique service name recorded internally by API gatewayNote: This field may return null, indicating that a valid value cannot be obtained. +* `vm_instance_id` - (Optional, String) CVM instance IDNote: This field may return null, indicating that a valid value cannot be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +apigateway upstream can be imported using the id, e.g. + +``` +terraform import tencentcloud_api_gateway_upstream.upstream upstream_id +``` + diff --git a/config/docs/r/api_gateway_usage_plan.html.markdown b/config/docs/r/api_gateway_usage_plan.html.markdown new file mode 100644 index 0000000..0977a82 --- /dev/null +++ b/config/docs/r/api_gateway_usage_plan.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_usage_plan" +sidebar_current: "docs-tencentcloud-resource-api_gateway_usage_plan" +description: |- + Use this resource to create API gateway usage plan. +--- + +# tencentcloud_api_gateway_usage_plan + +Use this resource to create API gateway usage plan. + +## Example Usage + +```hcl +resource "tencentcloud_api_gateway_usage_plan" "example" { + usage_plan_name = "tf_example" + usage_plan_desc = "desc." + max_request_num = 100 + max_request_num_pre_sec = 10 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `usage_plan_name` - (Required, String) Custom usage plan name. +* `max_request_num_pre_sec` - (Optional, Int) Limit of requests per second. Valid values: -1, [1,2000]. The default value is -1, which indicates no limit. +* `max_request_num` - (Optional, Int) Total number of requests allowed. Valid values: -1, [1,99999999]. The default value is -1, which indicates no limit. +* `usage_plan_desc` - (Optional, String) Custom usage plan description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `attach_api_keys` - Attach API keys list. +* `attach_list` - Attach service and API list. + * `api_id` - The API ID, this value is empty if attach service. + * `api_name` - The API name, this value is empty if attach service. + * `create_time` - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + * `environment` - The environment name. + * `method` - The API method, this value is empty if attach service. + * `modify_time` - Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + * `path` - The API path, this value is empty if attach service. + * `service_id` - The service ID. + * `service_name` - The service name. +* `create_time` - Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. +* `modify_time` - Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used. + + +## Import + +API gateway usage plan can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_api_gateway_usage_plan.plan usagePlan-gyeafpab +``` + diff --git a/config/docs/r/api_gateway_usage_plan_attachment.html.markdown b/config/docs/r/api_gateway_usage_plan_attachment.html.markdown new file mode 100644 index 0000000..fe95b3d --- /dev/null +++ b/config/docs/r/api_gateway_usage_plan_attachment.html.markdown @@ -0,0 +1,124 @@ +--- +subcategory: "API GateWay" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_api_gateway_usage_plan_attachment" +sidebar_current: "docs-tencentcloud-resource-api_gateway_usage_plan_attachment" +description: |- + Use this resource to attach API gateway usage plan to service. +--- + +# tencentcloud_api_gateway_usage_plan_attachment + +Use this resource to attach API gateway usage plan to service. + +~> **NOTE:** If the `auth_type` parameter of API is not `SECRET`, it cannot be bound access key. + +## Example Usage + +### Normal creation + +```hcl +resource "tencentcloud_api_gateway_usage_plan" "example" { + usage_plan_name = "tf_example" + usage_plan_desc = "desc." + max_request_num = 100 + max_request_num_pre_sec = 10 +} + +resource "tencentcloud_api_gateway_service" "example" { + service_name = "tf_example" + protocol = "http&https" + service_desc = "desc." + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +resource "tencentcloud_api_gateway_api" "example" { + service_id = tencentcloud_api_gateway_service.example.id + api_name = "tf_example" + api_desc = "my hello api update" + auth_type = "SECRET" + protocol = "HTTP" + enable_cors = true + request_config_path = "/user/info" + request_config_method = "POST" + request_parameters { + name = "email" + position = "QUERY" + type = "string" + desc = "desc." + default_value = "test@qq.com" + required = true + } + service_config_type = "HTTP" + service_config_timeout = 10 + service_config_url = "http://www.tencent.com" + service_config_path = "/user" + service_config_method = "POST" + response_type = "XML" + response_success_example = "success" + response_fail_example = "fail" + response_error_codes { + code = 500 + msg = "system error" + desc = "system error code" + converted_code = 5000 + need_convert = true + } +} + +resource "tencentcloud_api_gateway_usage_plan_attachment" "example" { + usage_plan_id = tencentcloud_api_gateway_usage_plan.example.id + service_id = tencentcloud_api_gateway_service.example.id + environment = "release" + bind_type = "API" + api_id = tencentcloud_api_gateway_api.example.id +} +``` + +### Bind the key to a usage plan + +```hcl +resource "tencentcloud_api_gateway_api_key" "example" { + secret_name = "tf_example" + status = "on" +} + +resource "tencentcloud_api_gateway_usage_plan_attachment" "example" { + usage_plan_id = tencentcloud_api_gateway_usage_plan.example.id + service_id = tencentcloud_api_gateway_service.example.id + environment = "release" + bind_type = "API" + api_id = tencentcloud_api_gateway_api.example.id + + access_key_ids = [tencentcloud_api_gateway_api_key.example.id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `environment` - (Required, String, ForceNew) The environment to be bound. Valid values: `test`, `prepub`, `release`. +* `service_id` - (Required, String, ForceNew) ID of the service. +* `usage_plan_id` - (Required, String, ForceNew) ID of the usage plan. +* `access_key_ids` - (Optional, Set: [`String`], ForceNew) Array of key IDs to be bound. +* `api_id` - (Optional, String, ForceNew) ID of the API. This parameter will be required when `bind_type` is `API`. +* `bind_type` - (Optional, String, ForceNew) Binding type. Valid values: `API`, `SERVICE`. Default value is `SERVICE`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +API gateway usage plan attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_api_gateway_usage_plan_attachment.attach_service usagePlan-pe7fbdgn#service-kuqd6xqk#release#API#api-p8gtanvy +``` + diff --git a/config/docs/r/apm_instance.html.markdown b/config/docs/r/apm_instance.html.markdown new file mode 100644 index 0000000..8055ae4 --- /dev/null +++ b/config/docs/r/apm_instance.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Application Performance Management(APM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_apm_instance" +sidebar_current: "docs-tencentcloud-resource-apm_instance" +description: |- + Provides a resource to create a apm instance +--- + +# tencentcloud_apm_instance + +Provides a resource to create a apm instance + +## Example Usage + +```hcl +resource "tencentcloud_apm_instance" "instance" { + name = "terraform-test" + description = "for terraform test" + trace_duration = 15 + span_daily_counters = 20 + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name Of Instance. +* `description` - (Optional, String) Description Of Instance. +* `span_daily_counters` - (Optional, Int) Quota Of Instance Reporting. +* `tags` - (Optional, Map) Tag description list. +* `trace_duration` - (Optional, Int) Duration Of Trace Data. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +apm instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_apm_instance.instance instance_id +``` + diff --git a/config/docs/r/as_attachment.html.markdown b/config/docs/r/as_attachment.html.markdown new file mode 100644 index 0000000..9bcfc43 --- /dev/null +++ b/config/docs/r/as_attachment.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_attachment" +sidebar_current: "docs-tencentcloud-resource-as_attachment" +description: |- + Provides a resource to attach or detach CVM instances to a specified scaling group. +--- + +# tencentcloud_as_attachment + +Provides a resource to attach or detach CVM instances to a specified scaling group. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones_by_product.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_instance" "example" { + instance_name = "tf_example_instance" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + image_id = data.tencentcloud_images.image.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + allocate_public_ip = true + internet_max_bandwidth_out = 10 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_as_attachment" "attachment" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + instance_ids = [tencentcloud_instance.example.id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_ids` - (Required, Set: [`String`]) ID list of CVM instances to be attached to the scaling group. +* `scaling_group_id` - (Required, String, ForceNew) ID of a scaling group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/as_complete_lifecycle.html.markdown b/config/docs/r/as_complete_lifecycle.html.markdown new file mode 100644 index 0000000..2de363d --- /dev/null +++ b/config/docs/r/as_complete_lifecycle.html.markdown @@ -0,0 +1,116 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_complete_lifecycle" +sidebar_current: "docs-tencentcloud-resource-as_complete_lifecycle" +description: |- + Provides a resource to create a as complete_lifecycle +--- + +# tencentcloud_as_complete_lifecycle + +Provides a resource to create a as complete_lifecycle + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones_by_product.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_as_lifecycle_hook" "example" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + lifecycle_hook_name = "tf-as-lifecycle-hook" + lifecycle_transition = "INSTANCE_LAUNCHING" + default_result = "CONTINUE" + heartbeat_timeout = 500 + notification_metadata = "tf test" +} + +resource "tencentcloud_instance" "example" { + instance_name = "tf_example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + image_id = data.tencentcloud_images.image.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "user" + project_id = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_as_complete_lifecycle" "complete_lifecycle" { + lifecycle_hook_id = tencentcloud_as_lifecycle_hook.example.id + instance_id = tencentcloud_instance.example.id + lifecycle_action_result = "CONTINUE" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `lifecycle_action_result` - (Required, String, ForceNew) Result of the lifecycle action. Value range: `CONTINUE`, `ABANDON`. +* `lifecycle_hook_id` - (Required, String, ForceNew) Lifecycle hook ID. +* `instance_id` - (Optional, String, ForceNew) Instance ID. Either InstanceId or LifecycleActionToken must be specified. +* `lifecycle_action_token` - (Optional, String, ForceNew) Either InstanceId or LifecycleActionToken must be specified. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/as_execute_scaling_policy.html.markdown b/config/docs/r/as_execute_scaling_policy.html.markdown new file mode 100644 index 0000000..952d6bc --- /dev/null +++ b/config/docs/r/as_execute_scaling_policy.html.markdown @@ -0,0 +1,101 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_execute_scaling_policy" +sidebar_current: "docs-tencentcloud-resource-as_execute_scaling_policy" +description: |- + Provides a resource to create a as execute_scaling_policy +--- + +# tencentcloud_as_execute_scaling_policy + +Provides a resource to create a as execute_scaling_policy + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 4 + min_size = 1 + desired_capacity = 2 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_as_scaling_policy" "example" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + policy_name = "tf-as-scaling-policy" + adjustment_type = "EXACT_CAPACITY" + adjustment_value = 0 + comparison_operator = "GREATER_THAN" + metric_name = "CPU_UTILIZATION" + threshold = 80 + period = 300 + continuous_time = 10 + statistic = "AVERAGE" + cooldown = 360 +} + +resource "tencentcloud_as_execute_scaling_policy" "example" { + auto_scaling_policy_id = tencentcloud_as_scaling_policy.example.id + honor_cooldown = false + trigger_source = "API" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_scaling_policy_id` - (Required, String, ForceNew) Auto-scaling policy ID. This parameter is not available to a target tracking policy. +* `honor_cooldown` - (Optional, Bool, ForceNew) Whether to check if the auto scaling group is in the cooldown period. Default value: false. +* `trigger_source` - (Optional, String, ForceNew) Source that triggers the scaling policy. Valid values: API and CLOUD_MONITOR. Default value: API. The value CLOUD_MONITOR is specific to the Cloud Monitor service. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +as execute_scaling_policy can be imported using the id, e.g. + +``` +terraform import tencentcloud_as_execute_scaling_policy.execute_scaling_policy execute_scaling_policy_id +``` + diff --git a/config/docs/r/as_lifecycle_hook.html.markdown b/config/docs/r/as_lifecycle_hook.html.markdown new file mode 100644 index 0000000..ae89f9a --- /dev/null +++ b/config/docs/r/as_lifecycle_hook.html.markdown @@ -0,0 +1,119 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_lifecycle_hook" +sidebar_current: "docs-tencentcloud-resource-as_lifecycle_hook" +description: |- + Provides a resource for an AS (Auto scaling) lifecycle hook. +--- + +# tencentcloud_as_lifecycle_hook + +Provides a resource for an AS (Auto scaling) lifecycle hook. + +## Example Usage + +### Create a basic LifecycleHook + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_as_lifecycle_hook" "example" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + lifecycle_hook_name = "tf-as-lifecycle-hook" + lifecycle_transition = "INSTANCE_LAUNCHING" + default_result = "CONTINUE" + heartbeat_timeout = 500 + notification_metadata = "tf test" +} +``` + + + +```hcl +resource "tencentcloud_as_lifecycle_hook" "example" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + lifecycle_hook_name = "tf-as-lifecycle-hook" + lifecycle_transition = "INSTANCE_LAUNCHING" + default_result = "CONTINUE" + heartbeat_timeout = 500 + notification_metadata = "tf test" + notification_target_type = "CMQ_QUEUE" + notification_queue_name = "lifcyclehook" +} +``` + + + +```hcl +resource "tencentcloud_as_lifecycle_hook" "example" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + lifecycle_hook_name = "tf-as-lifecycle-hook" + lifecycle_transition = "INSTANCE_LAUNCHING" + default_result = "CONTINUE" + heartbeat_timeout = 500 + notification_metadata = "tf test" + notification_target_type = "CMQ_TOPIC" + notification_topic_name = "lifcyclehook" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `lifecycle_hook_name` - (Required, String) The name of the lifecycle hook. +* `lifecycle_transition` - (Required, String) The instance state to which you want to attach the lifecycle hook. Valid values: `INSTANCE_LAUNCHING` and `INSTANCE_TERMINATING`. +* `scaling_group_id` - (Required, String, ForceNew) ID of a scaling group. +* `default_result` - (Optional, String) Defines the action the AS group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. Valid values: `CONTINUE` and `ABANDON`. The default value is `CONTINUE`. +* `heartbeat_timeout` - (Optional, Int) Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. Valid value ranges: (30~7200). and default value is `300`. +* `notification_metadata` - (Optional, String) Contains additional information that you want to include any time AS sends a message to the notification target. +* `notification_queue_name` - (Optional, String) For CMQ_QUEUE type, a name of queue must be set. +* `notification_target_type` - (Optional, String) Target type. Valid values: `CMQ_QUEUE`, `CMQ_TOPIC`. +* `notification_topic_name` - (Optional, String) For CMQ_TOPIC type, a name of topic must be set. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/as_notification.html.markdown b/config/docs/r/as_notification.html.markdown new file mode 100644 index 0000000..48e2fdd --- /dev/null +++ b/config/docs/r/as_notification.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_notification" +sidebar_current: "docs-tencentcloud-resource-as_notification" +description: |- + Provides a resource for an AS (Auto scaling) notification. +--- + +# tencentcloud_as_notification + +Provides a resource for an AS (Auto scaling) notification. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_cam_group" "example" { + name = "tf-example" + remark = "desc." +} + +resource "tencentcloud_as_notification" "as_notification" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + notification_types = [ + "SCALE_OUT_SUCCESSFUL", "SCALE_OUT_FAILED", "SCALE_IN_FAILED", "REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL", "REPLACE_UNHEALTHY_INSTANCE_FAILED" + ] + notification_user_group_ids = [tencentcloud_cam_group.example.id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `notification_types` - (Required, List: [`String`]) A list of Notification Types that trigger notifications. Acceptable values are `SCALE_OUT_FAILED`, `SCALE_IN_SUCCESSFUL`, `SCALE_IN_FAILED`, `REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL` and `REPLACE_UNHEALTHY_INSTANCE_FAILED`. +* `notification_user_group_ids` - (Required, List: [`String`]) A group of user IDs to be notified. +* `scaling_group_id` - (Required, String, ForceNew) ID of a scaling group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/as_protect_instances.html.markdown b/config/docs/r/as_protect_instances.html.markdown new file mode 100644 index 0000000..4cbf46f --- /dev/null +++ b/config/docs/r/as_protect_instances.html.markdown @@ -0,0 +1,123 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_protect_instances" +sidebar_current: "docs-tencentcloud-resource-as_protect_instances" +description: |- + Provides a resource to create a as protect_instances +--- + +# tencentcloud_as_protect_instances + +Provides a resource to create a as protect_instances + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones_by_product.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_instance" "example" { + instance_name = "tf_example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + image_id = data.tencentcloud_images.image.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "user" + project_id = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +# Attachment Instance +resource "tencentcloud_as_attachment" "attachment" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + instance_ids = [tencentcloud_instance.example.id] +} + +# Set protect +resource "tencentcloud_as_protect_instances" "protect" { + auto_scaling_group_id = tencentcloud_as_scaling_group.example.id + instance_ids = tencentcloud_as_attachment.attachment.instance_ids + protected_from_scale_in = true +} +``` + +### Or close protect + +```hcl +resource "tencentcloud_as_protect_instances" "protect" { + auto_scaling_group_id = tencentcloud_as_scaling_group.example.id + instance_ids = tencentcloud_as_attachment.attachment.instance_ids + protected_from_scale_in = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_scaling_group_id` - (Required, String, ForceNew) Launch configuration ID. +* `instance_ids` - (Required, Set: [`String`], ForceNew) List of cvm instances to remove. +* `protected_from_scale_in` - (Required, Bool, ForceNew) If instances need protect. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/as_remove_instances.html.markdown b/config/docs/r/as_remove_instances.html.markdown new file mode 100644 index 0000000..d1a4624 --- /dev/null +++ b/config/docs/r/as_remove_instances.html.markdown @@ -0,0 +1,111 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_remove_instances" +sidebar_current: "docs-tencentcloud-resource-as_remove_instances" +description: |- + Provides a resource to create a as remove_instances +--- + +# tencentcloud_as_remove_instances + +Provides a resource to create a as remove_instances + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones_by_product.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_instance" "example" { + instance_name = "tf_example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + image_id = data.tencentcloud_images.image.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "user" + project_id = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +# Attachment Instance +resource "tencentcloud_as_attachment" "attachment" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + instance_ids = [tencentcloud_instance.example.id] +} + +# Remove Instance +resource "tencentcloud_as_remove_instances" "remove" { + auto_scaling_group_id = tencentcloud_as_scaling_group.example.id + instance_ids = tencentcloud_as_attachment.attachment.instance_ids +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_scaling_group_id` - (Required, String, ForceNew) Launch configuration ID. +* `instance_ids` - (Required, Set: [`String`], ForceNew) List of cvm instances to remove. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/as_scale_in_instances.html.markdown b/config/docs/r/as_scale_in_instances.html.markdown new file mode 100644 index 0000000..b4be0e1 --- /dev/null +++ b/config/docs/r/as_scale_in_instances.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_scale_in_instances" +sidebar_current: "docs-tencentcloud-resource-as_scale_in_instances" +description: |- + Provides a resource to create a as scale_in_instances +--- + +# tencentcloud_as_scale_in_instances + +Provides a resource to create a as scale_in_instances + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 4 + min_size = 1 + desired_capacity = 2 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_as_scale_in_instances" "scale_in_instances" { + auto_scaling_group_id = tencentcloud_as_scaling_group.example.id + scale_in_number = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_scaling_group_id` - (Required, String, ForceNew) Scaling group ID. +* `scale_in_number` - (Required, Int, ForceNew) Number of instances to be reduced. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +as scale_in_instances can be imported using the id, e.g. + +``` +terraform import tencentcloud_as_scale_in_instances.scale_in_instances scale_in_instances_id +``` + diff --git a/config/docs/r/as_scale_out_instances.html.markdown b/config/docs/r/as_scale_out_instances.html.markdown new file mode 100644 index 0000000..40dc224 --- /dev/null +++ b/config/docs/r/as_scale_out_instances.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_scale_out_instances" +sidebar_current: "docs-tencentcloud-resource-as_scale_out_instances" +description: |- + Provides a resource to create a as scale_out_instances +--- + +# tencentcloud_as_scale_out_instances + +Provides a resource to create a as scale_out_instances + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 4 + min_size = 0 + desired_capacity = 2 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_as_scale_out_instances" "scale_out_instances" { + auto_scaling_group_id = tencentcloud_as_scaling_group.example.id + scale_out_number = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_scaling_group_id` - (Required, String, ForceNew) Scaling group ID. +* `scale_out_number` - (Required, Int, ForceNew) Number of instances to be added. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +as scale_out_instances can be imported using the id, e.g. + +``` +terraform import tencentcloud_as_scale_out_instances.scale_out_instances scale_out_instances_id +``` + diff --git a/config/docs/r/as_scaling_config.html.markdown b/config/docs/r/as_scaling_config.html.markdown new file mode 100644 index 0000000..57169c8 --- /dev/null +++ b/config/docs/r/as_scaling_config.html.markdown @@ -0,0 +1,139 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_scaling_config" +sidebar_current: "docs-tencentcloud-resource-as_scaling_config" +description: |- + Provides a resource to create a configuration for an AS (Auto scaling) instance. +--- + +# tencentcloud_as_scaling_config + +Provides a resource to create a configuration for an AS (Auto scaling) instance. + +~> **NOTE:** In order to ensure the integrity of customer data, if the cvm instance was destroyed due to shrinking, it will keep the cbs associate with cvm by default. If you want to destroy together, please set `delete_with_instance` to `true`. + +## Example Usage + +```hcl +data "tencentcloud_images" "example" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "example-launch-configuration" + image_id = data.tencentcloud_images.example.images.0.image_id + instance_types = ["SA1.SMALL1"] + project_id = 0 + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = "50" + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 10 + public_ip_assigned = true + password = "Test@123#" + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + + host_name_settings { + host_name = "host-name-test" + host_name_style = "UNIQUE" + } + + instance_tags = { + tag = "example" + } +} +``` + +### charge type + +```hcl +data "tencentcloud_images" "example" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "launch-configuration" + image_id = data.tencentcloud_images.example.images.0.image_id + instance_types = ["SA1.SMALL1"] + instance_charge_type = "SPOTPAID" + spot_instance_type = "one-time" + spot_max_price = "1000" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `configuration_name` - (Required, String) Name of a launch configuration. +* `image_id` - (Required, String) An available image ID for a cvm instance. +* `instance_types` - (Required, List: [`String`]) Specified types of CVM instances. +* `cam_role_name` - (Optional, String) CAM role name authorized to access. +* `data_disk` - (Optional, List) Configurations of data disk. +* `disk_type_policy` - (Optional, String) Policy of cloud disk type. Valid values: `ORIGINAL` and `AUTOMATIC`. Default is `ORIGINAL`. +* `enhanced_monitor_service` - (Optional, Bool) To specify whether to enable cloud monitor service. Default is `TRUE`. +* `enhanced_security_service` - (Optional, Bool) To specify whether to enable cloud security service. Default is `TRUE`. +* `host_name_settings` - (Optional, List) Related settings of the cloud server hostname (HostName). +* `instance_charge_type_prepaid_period` - (Optional, Int) The tenancy (in 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`. +* `instance_charge_type_prepaid_renew_flag` - (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`. +* `instance_charge_type` - (Optional, String) Charge type of instance. Valid values are `PREPAID`, `POSTPAID_BY_HOUR`, `SPOTPAID`. The default is `POSTPAID_BY_HOUR`. NOTE: `SPOTPAID` instance must set `spot_instance_type` and `spot_max_price` at the same time. +* `instance_name_settings` - (Optional, List) Settings of CVM instance names. +* `instance_tags` - (Optional, Map) A list of tags used to associate different resources. +* `internet_charge_type` - (Optional, String) Charge types for network traffic. Valid values: `BANDWIDTH_PREPAID`, `TRAFFIC_POSTPAID_BY_HOUR` and `BANDWIDTH_PACKAGE`. +* `internet_max_bandwidth_out` - (Optional, Int) Max bandwidth of Internet access in Mbps. Default is `0`. +* `keep_image_login` - (Optional, Bool) Specify whether to keep original settings of a CVM image. And it can't be used with password or key_ids together. +* `key_ids` - (Optional, List: [`String`]) ID list of keys. +* `password` - (Optional, String) Password to access. +* `project_id` - (Optional, Int) Specifys to which project the configuration belongs. +* `public_ip_assigned` - (Optional, Bool) Specify whether to assign an Internet IP address. +* `security_group_ids` - (Optional, List: [`String`]) Security groups to which a CVM instance belongs. +* `spot_instance_type` - (Optional, String) Type of spot instance, only support `one-time` now. Note: it only works when instance_charge_type is set to `SPOTPAID`. +* `spot_max_price` - (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`. +* `system_disk_size` - (Optional, Int) Volume of system disk in GB. Default is `50`. +* `system_disk_type` - (Optional, String) Type of a CVM disk. Valid values: `CLOUD_PREMIUM` and `CLOUD_SSD`. Default is `CLOUD_PREMIUM`. valid when disk_type_policy is ORIGINAL. +* `user_data` - (Optional, String) ase64-encoded User Data text, the length limit is 16KB. + +The `data_disk` object supports the following: + +* `delete_with_instance` - (Optional, Bool) Indicates whether the disk remove after instance terminated. Default is `false`. +* `disk_size` - (Optional, Int) Volume of disk in GB. Default is `0`. +* `disk_type` - (Optional, String) Types of disk. Valid values: `CLOUD_PREMIUM` and `CLOUD_SSD`. valid when disk_type_policy is ORIGINAL. +* `snapshot_id` - (Optional, String) Data disk snapshot ID. + +The `host_name_settings` object supports the following: + +* `host_name` - (Required, String) The host name of the cloud server; dots (.) and dashes (-) cannot be used as the first and last characters of HostName, and cannot be used consecutively; Windows instances are not supported; other types (Linux, etc.) instances: the character length is [2, 40], it is allowed to support multiple dots, and there is a paragraph between the dots, and each paragraph is allowed to consist of letters (no uppercase and lowercase restrictions), numbers and dashes (-). Pure numbers are not allowed. +* `host_name_style` - (Optional, String) The style of the host name of the cloud server, the value range includes `ORIGINAL` and `UNIQUE`, the default is `ORIGINAL`; `ORIGINAL`, the AS directly passes the HostName filled in the input parameter to the CVM, and the CVM may append a sequence to the HostName number, the HostName of the instance in the scaling group will conflict; `UNIQUE`, the HostName filled in as a parameter is equivalent to the host name prefix, AS and CVM will expand it, and the HostName of the instance in the scaling group can be guaranteed to be unique. + +The `instance_name_settings` object supports the following: + +* `instance_name` - (Required, String) CVM instance name. +* `instance_name_style` - (Optional, String) Type of CVM instance name. Valid values: `ORIGINAL` and `UNIQUE`. Default is `ORIGINAL`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - The time when the launch configuration was created. +* `status` - Current statues of a launch configuration. + + +## Import + +AutoScaling Configuration can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_as_scaling_config.example asc-n32ymck2 +``` + diff --git a/config/docs/r/as_scaling_group.html.markdown b/config/docs/r/as_scaling_group.html.markdown new file mode 100644 index 0000000..ce7ab4d --- /dev/null +++ b/config/docs/r/as_scaling_group.html.markdown @@ -0,0 +1,171 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_scaling_group" +sidebar_current: "docs-tencentcloud-resource-as_scaling_group" +description: |- + Provides a resource to create a group of AS (Auto scaling) instances. +--- + +# tencentcloud_as_scaling_group + +Provides a resource to create a group of AS (Auto scaling) instances. + +## Example Usage + +### Create a basic Scaling Group + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} +``` + +### Create a complete Scaling Group + +```hcl +resource "tencentcloud_clb_instance" "example" { + network_type = "INTERNAL" + clb_name = "clb-example" + project_id = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + + tags = { + test = "tf" + } +} + +resource "tencentcloud_clb_listener" "example" { + clb_id = tencentcloud_clb_instance.example.id + listener_name = "listener-example" + port = 80 + protocol = "HTTP" +} + +resource "tencentcloud_clb_listener_rule" "example" { + listener_id = tencentcloud_clb_listener.example.listener_id + clb_id = tencentcloud_clb_instance.example.id + domain = "foo.net" + url = "/bar" +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] + project_id = 0 + default_cooldown = 400 + desired_capacity = 1 + termination_policies = ["NEWEST_INSTANCE"] + retry_policy = "INCREMENTAL_INTERVALS" + + forward_balancer_ids { + load_balancer_id = tencentcloud_clb_instance.example.id + listener_id = tencentcloud_clb_listener.example.listener_id + rule_id = tencentcloud_clb_listener_rule.example.rule_id + + target_attribute { + port = 80 + weight = 90 + } + } + + tags = { + "createBy" = "tfExample" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `configuration_id` - (Required, String) An available ID for a launch configuration. +* `max_size` - (Required, Int) Maximum number of CVM instances. Valid value ranges: (0~2000). +* `min_size` - (Required, Int) Minimum number of CVM instances. Valid value ranges: (0~2000). +* `scaling_group_name` - (Required, String) Name of a scaling group. +* `vpc_id` - (Required, String) ID of VPC network. +* `default_cooldown` - (Optional, Int) Default cooldown time in second, and default value is `300`. +* `desired_capacity` - (Optional, Int) Desired volume of CVM instances, which is between `max_size` and `min_size`. +* `forward_balancer_ids` - (Optional, List) List of application load balancers, which can't be specified with `load_balancer_ids` together. +* `load_balancer_ids` - (Optional, List: [`String`]) ID list of traditional load balancers. +* `multi_zone_subnet_policy` - (Optional, String) Multi zone or subnet strategy, Valid values: PRIORITY and EQUALITY. +* `project_id` - (Optional, Int) Specifies to which project the scaling group belongs. +* `replace_load_balancer_unhealthy` - (Optional, Bool) Enable unhealthy instance replacement. If set to `true`, AS will replace instances that are found unhealthy in the CLB health check. +* `replace_monitor_unhealthy` - (Optional, Bool) Enables unhealthy instance replacement. If set to `true`, AS will replace instances that are flagged as unhealthy by Cloud Monitor. +* `retry_policy` - (Optional, String) Available values for retry policies. Valid values: IMMEDIATE_RETRY and INCREMENTAL_INTERVALS. +* `scaling_mode` - (Optional, String) Indicates scaling mode which creates and terminates instances (classic method), or method first tries to start stopped instances (wake up stopped) to perform scaling operations. Available values: `CLASSIC_SCALING`, `WAKE_UP_STOPPED_SCALING`. Default: `CLASSIC_SCALING`. +* `subnet_ids` - (Optional, List: [`String`]) ID list of subnet, and for VPC it is required. +* `tags` - (Optional, Map) Tags of a scaling group. +* `termination_policies` - (Optional, List: [`String`]) Available values for termination policies. Valid values: OLDEST_INSTANCE and NEWEST_INSTANCE. +* `zones` - (Optional, List: [`String`]) List of available zones, for Basic network it is required. + +The `forward_balancer_ids` object supports the following: + +* `listener_id` - (Required, String) Listener ID for application load balancers. +* `load_balancer_id` - (Required, String) ID of available load balancers. +* `target_attribute` - (Required, List) Attribute list of target rules. +* `rule_id` - (Optional, String) ID of forwarding rules. + +The `target_attribute` object supports the following: + +* `port` - (Required, Int) Port number. +* `weight` - (Required, Int) Weight. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - The time when the AS group was created. +* `instance_count` - Instance number of a scaling group. +* `status` - Current status of a scaling group. + + +## Import + +AutoScaling Groups can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_as_scaling_group.scaling_group asg-n32ymck2 +``` + diff --git a/config/docs/r/as_scaling_group_status.html.markdown b/config/docs/r/as_scaling_group_status.html.markdown new file mode 100644 index 0000000..120005d --- /dev/null +++ b/config/docs/r/as_scaling_group_status.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_scaling_group_status" +sidebar_current: "docs-tencentcloud-resource-as_scaling_group_status" +description: |- + Provides a resource to set as scaling_group status +--- + +# tencentcloud_as_scaling_group_status + +Provides a resource to set as scaling_group status + +## Example Usage + +### Deactivate Scaling Group + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_as_scaling_group_status" "scaling_group_status" { + auto_scaling_group_id = tencentcloud_as_scaling_group.example.id + enable = false +} +``` + +### Enable Scaling Group + +```hcl +resource "tencentcloud_as_scaling_group_status" "scaling_group_status" { + auto_scaling_group_id = tencentcloud_as_scaling_group.example.id + enable = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_scaling_group_id` - (Required, String, ForceNew) Scaling group ID. +* `enable` - (Required, Bool) If enable auto scaling group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +as scaling_group_status can be imported using the id, e.g. + +``` +terraform import tencentcloud_as_scaling_group_status.scaling_group_status scaling_group_id +``` + diff --git a/config/docs/r/as_scaling_policy.html.markdown b/config/docs/r/as_scaling_policy.html.markdown new file mode 100644 index 0000000..764c849 --- /dev/null +++ b/config/docs/r/as_scaling_policy.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_scaling_policy" +sidebar_current: "docs-tencentcloud-resource-as_scaling_policy" +description: |- + Provides a resource for an AS (Auto scaling) policy. +--- + +# tencentcloud_as_scaling_policy + +Provides a resource for an AS (Auto scaling) policy. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_as_scaling_policy" "example" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + policy_name = "tf-as-scaling-policy" + adjustment_type = "EXACT_CAPACITY" + adjustment_value = 0 + comparison_operator = "GREATER_THAN" + metric_name = "CPU_UTILIZATION" + threshold = 80 + period = 300 + continuous_time = 10 + statistic = "AVERAGE" + cooldown = 360 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `adjustment_type` - (Required, String) Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values: `CHANGE_IN_CAPACITY`, `EXACT_CAPACITY` and `PERCENT_CHANGE_IN_CAPACITY`. +* `adjustment_value` - (Required, Int) Define the number of instances by which to scale.For `CHANGE_IN_CAPACITY` type or PERCENT_CHANGE_IN_CAPACITY, a positive increment adds to the current capacity and a negative value removes from the current capacity. For `EXACT_CAPACITY` type, it defines an absolute number of the existing Auto Scaling group size. +* `comparison_operator` - (Required, String) Comparison operator. Valid values: `GREATER_THAN`, `GREATER_THAN_OR_EQUAL_TO`, `LESS_THAN`, `LESS_THAN_OR_EQUAL_TO`, `EQUAL_TO` and `NOT_EQUAL_TO`. +* `continuous_time` - (Required, Int) Retry times. Valid value ranges: (1~10). +* `metric_name` - (Required, String) Name of an indicator. Valid values: `CPU_UTILIZATION`, `MEM_UTILIZATION`, `LAN_TRAFFIC_OUT`, `LAN_TRAFFIC_IN`, `WAN_TRAFFIC_OUT` and `WAN_TRAFFIC_IN`. +* `period` - (Required, Int) Time period in second. Valid values: `60` and `300`. +* `policy_name` - (Required, String) Name of a policy used to define a reaction when an alarm is triggered. +* `scaling_group_id` - (Required, String, ForceNew) ID of a scaling group. +* `threshold` - (Required, Int) Alarm threshold. +* `cooldown` - (Optional, Int) Cooldwon time in second. Default is `30`0. +* `notification_user_group_ids` - (Optional, List: [`String`]) An ID group of users to be notified when an alarm is triggered. +* `statistic` - (Optional, String) Statistic types. Valid values: `AVERAGE`, `MAXIMUM` and `MINIMUM`. Default is `AVERAGE`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/as_schedule.html.markdown b/config/docs/r/as_schedule.html.markdown new file mode 100644 index 0000000..08e848e --- /dev/null +++ b/config/docs/r/as_schedule.html.markdown @@ -0,0 +1,88 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_schedule" +sidebar_current: "docs-tencentcloud-resource-as_schedule" +description: |- + Provides a resource for an AS (Auto scaling) schedule. +--- + +# tencentcloud_as_schedule + +Provides a resource for an AS (Auto scaling) schedule. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_as_schedule" "example" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + schedule_action_name = "tf-as-schedule" + max_size = 10 + min_size = 0 + desired_capacity = 0 + start_time = "2019-01-01T00:00:00+08:00" + end_time = "2019-12-01T00:00:00+08:00" + recurrence = "0 0 * * *" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `desired_capacity` - (Required, Int) The desired number of CVM instances that should be running in the group. +* `max_size` - (Required, Int) The maximum size for the Auto Scaling group. +* `min_size` - (Required, Int) The minimum size for the Auto Scaling group. +* `scaling_group_id` - (Required, String, ForceNew) ID of a scaling group. +* `schedule_action_name` - (Required, String) The name of this scaling action. +* `start_time` - (Required, String) The time for this action to start, in "YYYY-MM-DDThh:mm:ss+08:00" format (UTC+8). +* `end_time` - (Optional, String) The time for this action to end, in "YYYY-MM-DDThh:mm:ss+08:00" format (UTC+8). +* `recurrence` - (Optional, String) The time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. And this argument should be set with end_time together. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/as_start_instances.html.markdown b/config/docs/r/as_start_instances.html.markdown new file mode 100644 index 0000000..24c2e10 --- /dev/null +++ b/config/docs/r/as_start_instances.html.markdown @@ -0,0 +1,110 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_start_instances" +sidebar_current: "docs-tencentcloud-resource-as_start_instances" +description: |- + Provides a resource to create a as start_instances +--- + +# tencentcloud_as_start_instances + +Provides a resource to create a as start_instances + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones_by_product.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_instance" "example" { + instance_name = "tf_example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + image_id = data.tencentcloud_images.image.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "user" + project_id = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +# Attachment Instance +resource "tencentcloud_as_attachment" "attachment" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + instance_ids = [tencentcloud_instance.example.id] +} + +resource "tencentcloud_as_start_instances" "start_instances" { + auto_scaling_group_id = tencentcloud_as_scaling_group.example.id + instance_ids = tencentcloud_as_attachment.attachment.instance_ids +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_scaling_group_id` - (Required, String, ForceNew) Launch configuration ID. +* `instance_ids` - (Required, Set: [`String`], ForceNew) List of cvm instances to start. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/as_stop_instances.html.markdown b/config/docs/r/as_stop_instances.html.markdown new file mode 100644 index 0000000..0852798 --- /dev/null +++ b/config/docs/r/as_stop_instances.html.markdown @@ -0,0 +1,112 @@ +--- +subcategory: "Auto Scaling(AS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_as_stop_instances" +sidebar_current: "docs-tencentcloud-resource-as_stop_instances" +description: |- + Provides a resource to create a as stop_instances +--- + +# tencentcloud_as_stop_instances + +Provides a resource to create a as stop_instances + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "as" +} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones_by_product.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name +} + +resource "tencentcloud_as_scaling_config" "example" { + configuration_name = "tf-example" + image_id = data.tencentcloud_images.image.images.0.image_id + instance_types = ["SA1.SMALL1", "SA2.SMALL1", "SA2.SMALL2", "SA2.SMALL4"] + instance_name_settings { + instance_name = "test-ins-name" + } +} + +resource "tencentcloud_as_scaling_group" "example" { + scaling_group_name = "tf-example" + configuration_id = tencentcloud_as_scaling_config.example.id + max_size = 1 + min_size = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] +} + +resource "tencentcloud_instance" "example" { + instance_name = "tf_example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + image_id = data.tencentcloud_images.image.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "user" + project_id = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +# Attachment Instance +resource "tencentcloud_as_attachment" "attachment" { + scaling_group_id = tencentcloud_as_scaling_group.example.id + instance_ids = [tencentcloud_instance.example.id] +} + +resource "tencentcloud_as_stop_instances" "stop_instances" { + auto_scaling_group_id = tencentcloud_as_scaling_group.example.id + instance_ids = tencentcloud_as_attachment.attachment.instance_ids + stopped_mode = "STOP_CHARGING" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_scaling_group_id` - (Required, String, ForceNew) Launch configuration ID. +* `instance_ids` - (Required, Set: [`String`], ForceNew) List of cvm instances to stop. +* `stopped_mode` - (Optional, String, ForceNew) Billing method of a pay-as-you-go instance after shutdown. Available values: `KEEP_CHARGING`,`STOP_CHARGING`. Default `KEEP_CHARGING`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/audit.html.markdown b/config/docs/r/audit.html.markdown new file mode 100644 index 0000000..a324a0e --- /dev/null +++ b/config/docs/r/audit.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Cloud Audit(Audit)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_audit" +sidebar_current: "docs-tencentcloud-resource-audit" +description: |- + Provides a resource to create an audit. +--- + +# tencentcloud_audit + +Provides a resource to create an audit. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_audit_track. + +## Example Usage + +```hcl +resource "tencentcloud_audit" "foo" { + name = "audittest" + cos_bucket = "test" + cos_region = "ap-hongkong" + log_file_prefix = "test" + audit_switch = true + read_write_attribute = 3 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `audit_switch` - (Required, Bool) Indicate whether to turn on audit logging or not. +* `cos_bucket` - (Required, String) Name of the cos bucket to save audit log. Caution: the validation of existing cos bucket will not be checked by terraform. +* `cos_region` - (Required, String) Region of the cos bucket. +* `name` - (Required, String, ForceNew) Name of audit. Valid length ranges from 3 to 128. Only alpha character or numbers or '_' supported. +* `read_write_attribute` - (Required, Int) Event attribute filter. Valid values: `1`, `2`, `3`. `1` for readonly, `2` for write-only, `3` for all. +* `enable_kms_encry` - (Optional, Bool) Indicate whether the log is encrypt with KMS algorithm or not. +* `key_id` - (Optional, String) Existing CMK unique key. This field can be get by data source `tencentcloud_audit_key_alias`. Caution: the region of the KMS must be as same as the `cos_region`. +* `log_file_prefix` - (Optional, String) The log file name prefix. The length ranges from 3 to 40. If not set, the account ID will be the log file prefix. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Audit can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_audit.foo audit-test +``` + diff --git a/config/docs/r/audit_track.html.markdown b/config/docs/r/audit_track.html.markdown new file mode 100644 index 0000000..614647f --- /dev/null +++ b/config/docs/r/audit_track.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "Cloud Audit(Audit)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_audit_track" +sidebar_current: "docs-tencentcloud-resource-audit_track" +description: |- + Provides a resource to create a audit track +--- + +# tencentcloud_audit_track + +Provides a resource to create a audit track + +## Example Usage + +```hcl +resource "tencentcloud_audit_track" "track" { + action_type = "Read" + event_names = [ + "*", + ] + name = "terraform_track" + resource_type = "*" + status = 1 + track_for_all_members = 0 + + storage { + storage_name = "db90b92c-91d2-46b0-94ac-debbbb21dc4e" + storage_prefix = "cloudaudit" + storage_region = "ap-guangzhou" + storage_type = "cls" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `action_type` - (Required, String) Track interface type, optional:- `Read`: Read interface- `Write`: Write interface- `*`: All interface. +* `event_names` - (Required, Set: [`String`]) Track interface name list:- when ResourceType is `*`, EventNames is must `[&quot;*&quot;]`- when ResourceType is a single product, EventNames support all interface:`[&quot;*&quot;]`- when ResourceType is a single product, EventNames support some interface, up to 10. +* `name` - (Required, String) Track name. +* `resource_type` - (Required, String) Track product, optional:- `*`: All product- Single product, such as `cos`. +* `status` - (Required, Int) Track status, optional:- `0`: Close- `1`: Open. +* `storage` - (Required, List) Track Storage, support `cos` and `cls`. +* `track_for_all_members` - (Optional, Int) Whether to enable the delivery of group member operation logs to the group management account or trusted service management account, optional:- `0`: Close- `1`: Open. + +The `storage` object supports the following: + +* `storage_name` - (Required, String) Track Storage name:- when StorageType is `cls`, StorageName is cls topicId- when StorageType is `cos`, StorageName is cos bucket name that does not contain `-APPID`. +* `storage_prefix` - (Required, String) Storage path prefix. +* `storage_region` - (Required, String) Storage region. +* `storage_type` - (Required, String) Track Storage type, optional:- `cos`- `cls`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Track create time. + + +## Import + +audit track can be imported using the id, e.g. +``` +$ terraform import tencentcloud_audit_track.track track_id +``` + diff --git a/config/docs/r/bi_datasource.html.markdown b/config/docs/r/bi_datasource.html.markdown new file mode 100644 index 0000000..f9ec211 --- /dev/null +++ b/config/docs/r/bi_datasource.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "Business Intelligence(BI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_bi_datasource" +sidebar_current: "docs-tencentcloud-resource-bi_datasource" +description: |- + Provides a resource to create a bi datasource +--- + +# tencentcloud_bi_datasource + +Provides a resource to create a bi datasource + +## Example Usage + +```hcl +resource "tencentcloud_bi_datasource" "datasource" { + charset = "utf8" + db_host = "bj-cdb-1lxqg5r6.sql.tencentcdb.com" + db_name = "tf-test" + db_port = 63694 + db_type = "MYSQL" + db_pwd = "ABc123,,," + db_user = "root" + project_id = 11015030 + source_name = "tf-source-name" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `charset` - (Required, String) Charset. +* `db_host` - (Required, String) Host. +* `db_name` - (Required, String) Database name. +* `db_port` - (Required, Int) Port. +* `db_pwd` - (Required, String) Password. +* `db_type` - (Required, String) `MYSQL`, `MSSQL`, `POSTGRE`, `ORACLE`, `CLICKHOUSE`, `TIDB`, `HIVE`, `PRESTO`. +* `db_user` - (Required, String) User name. +* `project_id` - (Required, Int) Project id. +* `source_name` - (Required, String) Datasource name in BI. +* `catalog` - (Optional, String) Catalog. +* `data_origin_datasource_id` - (Optional, String) Third-party datasource project id, this parameter can be ignored. +* `data_origin_project_id` - (Optional, String) Third-party datasource project id, this parameter can be ignored. +* `data_origin` - (Optional, String) Third-party datasource identification, this parameter can be ignored. +* `service_type` - (Optional, String) Own or Cloud, default: `Own`. +* `uniq_vpc_id` - (Optional, String) Tencent cloud private network unified identity. +* `vpc_id` - (Optional, String) Tencent cloud private network identity. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +bi datasource can be imported using the id, e.g. + +``` +terraform import tencentcloud_bi_datasource.datasource datasource_id +``` + diff --git a/config/docs/r/bi_datasource_cloud.html.markdown b/config/docs/r/bi_datasource_cloud.html.markdown new file mode 100644 index 0000000..112cc2b --- /dev/null +++ b/config/docs/r/bi_datasource_cloud.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Business Intelligence(BI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_bi_datasource_cloud" +sidebar_current: "docs-tencentcloud-resource-bi_datasource_cloud" +description: |- + Provides a resource to create a bi datasource_cloud +--- + +# tencentcloud_bi_datasource_cloud + +Provides a resource to create a bi datasource_cloud + +## Example Usage + +```hcl +resource "tencentcloud_bi_datasource_cloud" "datasource_cloud" { + charset = "utf8" + db_name = "bi_dev" + db_type = "MYSQL" + db_user = "root" + project_id = "11015056" + db_pwd = "xxxxxx" + service_type { + instance_id = "cdb-12viotu5" + region = "ap-guangzhou" + type = "Cloud" + } + source_name = "tf-test1" + vip = "10.0.0.4" + vport = "3306" + region_id = "gz" + vpc_id = 5292713 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `charset` - (Required, String) Charset. +* `db_name` - (Required, String) Database name. +* `db_pwd` - (Required, String) Password. +* `db_type` - (Required, String) `MYSQL`, `TDSQL-C_MYSQL`, `TDSQL_MYSQL`, `MSSQL`, `POSTGRESQL`, `MARIADB`. +* `db_user` - (Required, String) User name. +* `project_id` - (Required, String) Project id. +* `service_type` - (Required, List) Service type, Own or Cloud. +* `source_name` - (Required, String) Datasource name in BI. +* `vpc_id` - (Required, String) Vpc identification. +* `data_origin_datasource_id` - (Optional, String) Third-party datasource project id, this parameter can be ignored. +* `data_origin_project_id` - (Optional, String) Third-party datasource project id, this parameter can be ignored. +* `data_origin` - (Optional, String) Third-party datasource identification, this parameter can be ignored. +* `extra_param` - (Optional, String) Extended parameters. +* `region_id` - (Optional, String) Region identifier. +* `uniq_vpc_id` - (Optional, String) Unified vpc identification. +* `vip` - (Optional, String) Public cloud intranet ip. +* `vport` - (Optional, String) Public cloud intranet port. + +The `service_type` object supports the following: + +* `instance_id` - (Required, String) Instance Id. +* `region` - (Required, String) Region. +* `type` - (Required, String) Service type, Cloud. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/bi_embed_interval_apply.html.markdown b/config/docs/r/bi_embed_interval_apply.html.markdown new file mode 100644 index 0000000..6a82f84 --- /dev/null +++ b/config/docs/r/bi_embed_interval_apply.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Business Intelligence(BI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_bi_embed_interval_apply" +sidebar_current: "docs-tencentcloud-resource-bi_embed_interval_apply" +description: |- + Provides a resource to create a bi embed_interval +--- + +# tencentcloud_bi_embed_interval_apply + +Provides a resource to create a bi embed_interval + +## Example Usage + +```hcl +resource "tencentcloud_bi_embed_interval_apply" "embed_interval" { + project_id = 11015030 + page_id = 10520483 + bi_token = "4192d65b-d674-4117-9a59-xxxxxxxxx" + scope = "page" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bi_token` - (Optional, String, ForceNew) Token that needs to be applied for extension. +* `page_id` - (Optional, Int, ForceNew) Sharing page id, this is empty value 0 when embedding the board. +* `project_id` - (Optional, Int, ForceNew) Sharing project id, required. +* `scope` - (Optional, String, ForceNew) Choose panel or page. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/bi_embed_token_apply.html.markdown b/config/docs/r/bi_embed_token_apply.html.markdown new file mode 100644 index 0000000..1c0f733 --- /dev/null +++ b/config/docs/r/bi_embed_token_apply.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Business Intelligence(BI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_bi_embed_token_apply" +sidebar_current: "docs-tencentcloud-resource-bi_embed_token_apply" +description: |- + Provides a resource to create a bi embed_token +--- + +# tencentcloud_bi_embed_token_apply + +Provides a resource to create a bi embed_token + +## Example Usage + +```hcl +resource "tencentcloud_bi_embed_token_apply" "embed_token" { + project_id = 11015030 + page_id = 10520483 + scope = "page" + expire_time = "240" + user_corp_id = "100022975249" + user_id = "100024664626" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `expire_time` - (Optional, String, ForceNew) Expiration. Unit: Minutes Maximum value: 240. i.e. 4 hours Default: 240. +* `page_id` - (Optional, Int, ForceNew) Sharing page id, this is empty value 0 when embedding the board. +* `project_id` - (Optional, Int, ForceNew) Share project id. +* `scope` - (Optional, String, ForceNew) Page means embedding the page, and panel means embedding the entire board. +* `user_corp_id` - (Optional, String, ForceNew) User enterprise ID (for multi-user only). +* `user_id` - (Optional, String, ForceNew) UserId (for multi-user only). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `bi_token` - Create the generated token. +* `create_at` - Create time. +* `udpate_at` - Upadte time. + + diff --git a/config/docs/r/bi_project.html.markdown b/config/docs/r/bi_project.html.markdown new file mode 100644 index 0000000..4bf7306 --- /dev/null +++ b/config/docs/r/bi_project.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Business Intelligence(BI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_bi_project" +sidebar_current: "docs-tencentcloud-resource-bi_project" +description: |- + Provides a resource to create a bi project +--- + +# tencentcloud_bi_project + +Provides a resource to create a bi project + +## Example Usage + +```hcl +resource "tencentcloud_bi_project" "project" { + name = "terraform_test" + color_code = "#7BD936" + logo = "TF-test" + mark = "project mark" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `color_code` - (Required, String) Logo background color. +* `name` - (Required, String) Project name. +* `logo` - (Optional, String) Project logo. +* `mark` - (Optional, String) Remark. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +bi project can be imported using the id, e.g. + +``` +terraform import tencentcloud_bi_project.project project_id +``` + diff --git a/config/docs/r/bi_project_user_role.html.markdown b/config/docs/r/bi_project_user_role.html.markdown new file mode 100644 index 0000000..07c06b6 --- /dev/null +++ b/config/docs/r/bi_project_user_role.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Business Intelligence(BI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_bi_project_user_role" +sidebar_current: "docs-tencentcloud-resource-bi_project_user_role" +description: |- + Provides a resource to create a bi project_user_role +--- + +# tencentcloud_bi_project_user_role + +Provides a resource to create a bi project_user_role + +~> **NOTE:** You cannot use `tencentcloud_bi_user_role` and `tencentcloud_bi_project_user_role` at the same time to modify the `phone_number` and `email` of the same user. + +## Example Usage + +```hcl +resource "tencentcloud_bi_project_user_role" "project_user_role" { + area_code = "+86" + project_id = 11015030 + role_id_list = [10629453] + email = "123456@qq.com" + phone_number = "13130001000" + user_id = "100024664626" + user_name = "keep-cam-user" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `area_code` - (Required, String) Mobile area code(Note: This field may return null, indicating that no valid value can be obtained). +* `email` - (Required, String) E-mail(Note: This field may return null, indicating that no valid value can be obtained). +* `phone_number` - (Required, String) Phone number(Note: This field may return null, indicating that no valid value can be obtained). +* `user_id` - (Required, String) User id. +* `user_name` - (Required, String) Username. +* `project_id` - (Optional, Int) Project id. +* `role_id_list` - (Optional, Set: [`Int`]) Role id list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +bi project_user_role can be imported using the id, e.g. + +``` +terraform import tencentcloud_bi_project_user_role.project_user_role projectId#userId +``` + diff --git a/config/docs/r/bi_user_role.html.markdown b/config/docs/r/bi_user_role.html.markdown new file mode 100644 index 0000000..4c5a2e3 --- /dev/null +++ b/config/docs/r/bi_user_role.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Business Intelligence(BI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_bi_user_role" +sidebar_current: "docs-tencentcloud-resource-bi_user_role" +description: |- + Provides a resource to create a bi user_role +--- + +# tencentcloud_bi_user_role + +Provides a resource to create a bi user_role + +## Example Usage + +```hcl +resource "tencentcloud_bi_user_role" "user_role" { + area_code = "+83" + email = "1055000000@qq.com" + phone_number = "13470010000" + role_id_list = [ + 10629359, + ] + user_id = "100032767426" + user_name = "keep-iac-test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `area_code` - (Required, String) Mobile area code(Note: This field may return null, indicating that no valid value can be obtained). +* `email` - (Required, String) E-mail(Note: This field may return null, indicating that no valid value can be obtained). +* `phone_number` - (Required, String) Phone number(Note: This field may return null, indicating that no valid value can be obtained). +* `role_id_list` - (Required, Set: [`Int`]) Role id list. +* `user_id` - (Required, String) User id. +* `user_name` - (Required, String) Username. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +bi user_role can be imported using the id, e.g. + +``` +terraform import tencentcloud_bi_user_role.user_role user_id +``` + diff --git a/config/docs/r/cam_access_key.html.markdown b/config/docs/r/cam_access_key.html.markdown new file mode 100644 index 0000000..d2f3890 --- /dev/null +++ b/config/docs/r/cam_access_key.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_access_key" +sidebar_current: "docs-tencentcloud-resource-cam_access_key" +description: |- + Provides a resource to create a cam access_key +--- + +# tencentcloud_cam_access_key + +Provides a resource to create a cam access_key + +## Example Usage + +```hcl +resource "tencentcloud_cam_access_key" "access_key" { + target_uin = 100033690181 +} +``` + +### Update + +```hcl +resource "tencentcloud_cam_access_key" "access_key" { + target_uin = 100033690181 + status = "Inactive" +} +``` + +### Encrypted + +```hcl +resource "tencentcloud_cam_access_key" "access_key" { + target_uin = 100033690181 + pgp_key = "keybase:some_person_that_exists" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_key` - (Optional, String) Access_key is the access key identification, required when updating. +* `pgp_key` - (Optional, String, ForceNew) Either a base-64 encoded PGP public key, or a keybase username in the form keybase:some_person_that_exists, for use in the encrypted_secret output attribute. If providing a base-64 encoded PGP public key, make sure to provide the "raw" version and not the "armored" one (e.g. avoid passing the -a option to gpg --export). +* `status` - (Optional, String) Key status, activated (Active) or inactive (Inactive), required when updating. +* `target_uin` - (Optional, Int) Specify user Uin, if not filled, the access key is created for the current user by default. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `encrypted_secret_access_key` - Encrypted secret, base64 encoded, if pgp_key was specified. This attribute is not available for imported resources. The encrypted secret may be decrypted using the command line, for example: terraform output -raw encrypted_secret | base64 --decode | keybase pgp decrypt. +* `key_fingerprint` - Fingerprint of the PGP key used to encrypt the secret. This attribute is not available for imported resources. +* `secret_access_key` - Access key (key is only visible when created, please keep it properly). + + +## Import + +cam access_key can be imported using the id, e.g. + +``` +terraform import tencentcloud_cam_access_key.access_key access_key_id +``` + diff --git a/config/docs/r/cam_group.html.markdown b/config/docs/r/cam_group.html.markdown new file mode 100644 index 0000000..c702277 --- /dev/null +++ b/config/docs/r/cam_group.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_group" +sidebar_current: "docs-tencentcloud-resource-cam_group" +description: |- + Provides a resource to create a CAM group. +--- + +# tencentcloud_cam_group + +Provides a resource to create a CAM group. + +## Example Usage + +```hcl +resource "tencentcloud_cam_group" "foo" { + name = "tf_cam_group" + remark = "tf_group_remark" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of CAM group. +* `remark` - (Optional, String) Description of the CAM group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the CAM group. + + +## Import + +CAM group can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cam_group.foo 90496 +``` + diff --git a/config/docs/r/cam_group_membership.html.markdown b/config/docs/r/cam_group_membership.html.markdown new file mode 100644 index 0000000..242527d --- /dev/null +++ b/config/docs/r/cam_group_membership.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_group_membership" +sidebar_current: "docs-tencentcloud-resource-cam_group_membership" +description: |- + Provides a resource to create a CAM group membership. +--- + +# tencentcloud_cam_group_membership + +Provides a resource to create a CAM group membership. + +## Example Usage + +```hcl +variable "cam_group_basic" { + default = "keep-cam-group" +} + +data "tencentcloud_cam_groups" "groups" { + name = var.cam_group_basic +} + +resource "tencentcloud_cam_user" "foo" { + name = "tf_cam_user" + remark = "tf_user_remark" + console_login = true + use_api = true + need_reset_password = true + password = "Gail@1234" + phone_num = "12345678910" + country_code = "86" + email = "1234@qq.com" + force_delete = true +} + +resource "tencentcloud_cam_group_membership" "group_membership_basic" { + group_id = data.tencentcloud_cam_groups.groups.group_list.0.group_id + user_names = [tencentcloud_cam_user.foo.id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String) ID of CAM group. +* `user_ids` - (Optional, Set: [`String`], **Deprecated**) It has been deprecated from version 1.59.5. Use `user_names` instead. ID set of the CAM group members. +* `user_names` - (Optional, Set: [`String`]) User name set as ID of the CAM group members. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +CAM group membership can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cam_group_membership.foo 12515263 +``` + diff --git a/config/docs/r/cam_group_policy_attachment.html.markdown b/config/docs/r/cam_group_policy_attachment.html.markdown new file mode 100644 index 0000000..809bea8 --- /dev/null +++ b/config/docs/r/cam_group_policy_attachment.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_group_policy_attachment" +sidebar_current: "docs-tencentcloud-resource-cam_group_policy_attachment" +description: |- + Provides a resource to create a CAM group policy attachment. +--- + +# tencentcloud_cam_group_policy_attachment + +Provides a resource to create a CAM group policy attachment. + +## Example Usage + +```hcl +variable "cam_policy_basic" { + default = "keep-cam-policy" +} + +variable "cam_group_basic" { + default = "keep-cam-group" +} + +data "tencentcloud_cam_groups" "groups" { + name = var.cam_group_basic +} + +data "tencentcloud_cam_policies" "policy" { + name = var.cam_policy_basic +} + +resource "tencentcloud_cam_group_policy_attachment" "group_policy_attachment_basic" { + group_id = data.tencentcloud_cam_groups.groups.group_list.0.group_id + policy_id = data.tencentcloud_cam_policies.policy.policy_list.0.policy_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String, ForceNew) ID of the attached CAM group. +* `policy_id` - (Required, String, ForceNew) ID of the policy. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_mode` - Mode of Creation of the CAM group policy attachment. `1` means the cam policy attachment is created by production, and the others indicate syntax strategy ways. +* `create_time` - Create time of the CAM group policy attachment. +* `policy_name` - Name of the policy. +* `policy_type` - Type of the policy strategy. 'Group' means customer strategy and 'QCS' means preset strategy. + + +## Import + +CAM group policy attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cam_group_policy_attachment.foo 12515263#26800353 +``` + diff --git a/config/docs/r/cam_mfa_flag.html.markdown b/config/docs/r/cam_mfa_flag.html.markdown new file mode 100644 index 0000000..a8b08f4 --- /dev/null +++ b/config/docs/r/cam_mfa_flag.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_mfa_flag" +sidebar_current: "docs-tencentcloud-resource-cam_mfa_flag" +description: |- + Provides a resource to create a cam mfa_flag +--- + +# tencentcloud_cam_mfa_flag + +Provides a resource to create a cam mfa_flag + +## Example Usage + +```hcl +data "tencentcloud_user_info" "info" {} + +resource "tencentcloud_cam_mfa_flag" "mfa_flag" { + op_uin = data.tencentcloud_user_info.info.uin + login_flag { + phone = 0 + stoken = 1 + wechat = 0 + } + action_flag { + phone = 0 + stoken = 1 + wechat = 0 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `op_uin` - (Required, Int) Operate uin. +* `action_flag` - (Optional, List) Action flag setting. +* `login_flag` - (Optional, List) Login flag setting. + +The `action_flag` object supports the following: + +* `phone` - (Optional, Int) Phone. +* `stoken` - (Optional, Int) Soft token. +* `wechat` - (Optional, Int) Wechat. + +The `login_flag` object supports the following: + +* `phone` - (Optional, Int) Phone. +* `stoken` - (Optional, Int) Soft token. +* `wechat` - (Optional, Int) Wechat. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cam mfa_flag can be imported using the id, e.g. + +``` +terraform import tencentcloud_cam_mfa_flag.mfa_flag mfa_flag_id +``` + diff --git a/config/docs/r/cam_oidc_sso.html.markdown b/config/docs/r/cam_oidc_sso.html.markdown new file mode 100644 index 0000000..70d108d --- /dev/null +++ b/config/docs/r/cam_oidc_sso.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_oidc_sso" +sidebar_current: "docs-tencentcloud-resource-cam_oidc_sso" +description: |- + Provides a resource to create a CAM-OIDC-SSO. +--- + +# tencentcloud_cam_oidc_sso + +Provides a resource to create a CAM-OIDC-SSO. + +## Example Usage + +```hcl +resource "tencentcloud_cam_oidc_sso" "foo" { + authorization_endpoint = "https://login.microsoftonline.com/.../oauth2/v2.0/authorize" + client_id = "..." + identity_key = "..." + identity_url = "https://login.microsoftonline.com/.../v2.0" + mapping_filed = "name" + response_mode = "form_post" + response_type = "id_token" + scope = ["openid", "email"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `authorization_endpoint` - (Required, String) Authorization request Endpoint, OpenID Connect identity provider authorization address. Corresponds to the value of the `authorization_endpoint` field in the Openid-configuration provided by the Enterprise IdP. +* `client_id` - (Required, String) Client ID, the client ID registered with the OpenID Connect identity provider. +* `identity_key` - (Required, String) The signature public key requires base64_encode. Verify the public key signed by the OpenID Connect identity provider ID Token. For the security of your account, we recommend that you rotate the signed public key regularly. +* `identity_url` - (Required, String) Identity provider URL. OpenID Connect identity provider identity.Corresponds to the value of the `issuer` field in the Openid-configuration provided by the Enterprise IdP. +* `mapping_filed` - (Required, String) Map field names. Which field in the IdP's id_token maps to the user name of the subuser, usually the sub or name field. +* `response_mode` - (Required, String) Authorize the request Forsonse mode. Authorization request return mode, form_post and frogment two optional modes, recommended to select form_post mode. +* `response_type` - (Required, String) Authorization requests The Response type, with a fixed value id_token. +* `scope` - (Optional, Set: [`String`]) Authorize the request Scope. openid; email; profile; Authorization request information scope. The default is required openid. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +CAM-OIDC-SSO can be imported using the client_id or any string which can identifier resource, e.g. + +``` +$ terraform import tencentcloud_cam_oidc_sso.foo xxxxxxxxxxx +``` + diff --git a/config/docs/r/cam_policy.html.markdown b/config/docs/r/cam_policy.html.markdown new file mode 100644 index 0000000..e44ea4b --- /dev/null +++ b/config/docs/r/cam_policy.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_policy" +sidebar_current: "docs-tencentcloud-resource-cam_policy" +description: |- + Provides a resource to create a CAM policy. +--- + +# tencentcloud_cam_policy + +Provides a resource to create a CAM policy. + +## Example Usage + +```hcl +resource "tencentcloud_cam_policy" "foo" { + name = "tf_cam_policy" + document = <:uin/"] + } + } + ] +} +EOF + description = "test" + console_login = true + tags = { + test = "tf-cam-role", + } +} +``` + +### Create with SAML provider + +```hcl +resource "tencentcloud_cam_role_by_name" "boo" { + name = "cam-role-test" + document = <:saml-provider/"] + } + } + ] +} +EOF + description = "test" + console_login = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `document` - (Required, String) Document of the CAM role. The syntax refers to [CAM POLICY](https://intl.cloud.tencent.com/document/product/598/10604). There are some notes when using this para in terraform: 1. The elements in json claimed supporting two types as `string` and `array` only support type `array`; 2. Terraform does not support the `root` syntax, when appears, it must be replaced with the uin it stands for. +* `name` - (Required, String, ForceNew) Name of CAM role. +* `console_login` - (Optional, Bool, ForceNew) Indicates whether the CAM role can login or not. +* `description` - (Optional, String) Description of the CAM role. +* `tags` - (Optional, Map) A list of tags used to associate different resources. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the CAM role. +* `update_time` - The last update time of the CAM role. + + +## Import + +CAM role can be imported using the name, e.g. + +``` +$ terraform import tencentcloud_cam_role_by_name.foo cam-role-test +``` + diff --git a/config/docs/r/cam_role_permission_boundary_attachment.html.markdown b/config/docs/r/cam_role_permission_boundary_attachment.html.markdown new file mode 100644 index 0000000..e8470c7 --- /dev/null +++ b/config/docs/r/cam_role_permission_boundary_attachment.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_role_permission_boundary_attachment" +sidebar_current: "docs-tencentcloud-resource-cam_role_permission_boundary_attachment" +description: |- + Provides a resource to create a cam role_permission_boundary_attachment +--- + +# tencentcloud_cam_role_permission_boundary_attachment + +Provides a resource to create a cam role_permission_boundary_attachment + +## Example Usage + +```hcl +resource "tencentcloud_cam_role_permission_boundary_attachment" "role_permission_boundary_attachment" { + policy_id = 1 + role_name = "test-cam-tag" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy_id` - (Required, Int, ForceNew) Role ID. +* `role_id` - (Optional, String, ForceNew) Role ID (at least one should be filled in with the role name). +* `role_name` - (Optional, String, ForceNew) Role name (at least one should be filled in with the role ID). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cam role_permission_boundary_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_cam_role_permission_boundary_attachment.role_permission_boundary_attachment role_permission_boundary_attachment_id +``` + diff --git a/config/docs/r/cam_role_policy_attachment.html.markdown b/config/docs/r/cam_role_policy_attachment.html.markdown new file mode 100644 index 0000000..b35746b --- /dev/null +++ b/config/docs/r/cam_role_policy_attachment.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_role_policy_attachment" +sidebar_current: "docs-tencentcloud-resource-cam_role_policy_attachment" +description: |- + Provides a resource to create a CAM role policy attachment. +--- + +# tencentcloud_cam_role_policy_attachment + +Provides a resource to create a CAM role policy attachment. + +## Example Usage + +```hcl +variable "cam_policy_basic" { + default = "keep-cam-policy" +} + +variable "cam_role_basic" { + default = "keep-cam-role" +} + +data "tencentcloud_cam_policies" "policy" { + name = var.cam_policy_basic +} + +data "tencentcloud_cam_roles" "roles" { + name = var.cam_role_basic +} + +resource "tencentcloud_cam_role_policy_attachment" "role_policy_attachment_basic" { + role_id = data.tencentcloud_cam_roles.roles.role_list.0.role_id + policy_id = data.tencentcloud_cam_policies.policy.policy_list.0.policy_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy_id` - (Required, String, ForceNew) ID of the policy. +* `role_id` - (Required, String, ForceNew) ID of the attached CAM role. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_mode` - Mode of Creation of the CAM role policy attachment. `1` means the CAM policy attachment is created by production, and the others indicate syntax strategy ways. +* `create_time` - The create time of the CAM role policy attachment. +* `policy_name` - The name of the policy. +* `policy_type` - Type of the policy strategy. `User` means customer strategy and `QCS` means preset strategy. + + +## Import + +CAM role policy attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cam_role_policy_attachment.foo 4611686018427922725#26800353 +``` + diff --git a/config/docs/r/cam_role_policy_attachment_by_name.html.markdown b/config/docs/r/cam_role_policy_attachment_by_name.html.markdown new file mode 100644 index 0000000..3698bd4 --- /dev/null +++ b/config/docs/r/cam_role_policy_attachment_by_name.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_role_policy_attachment_by_name" +sidebar_current: "docs-tencentcloud-resource-cam_role_policy_attachment_by_name" +description: |- + Provides a resource to create a CAM role policy attachment. +--- + +# tencentcloud_cam_role_policy_attachment_by_name + +Provides a resource to create a CAM role policy attachment. + +## Example Usage + +```hcl +variable "cam_policy_basic" { + default = "keep-cam-policy" +} + +variable "cam_role_basic" { + default = "keep-cam-role" +} + +data "tencentcloud_cam_policies" "policy" { + name = var.cam_policy_basic +} + +data "tencentcloud_cam_roles" "roles" { + name = var.cam_role_basic +} + +resource "tencentcloud_cam_role_policy_attachment_by_name" "role_policy_attachment_basic" { + role_name = var.cam_role_basic + policy_name = var.cam_policy_basic +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy_name` - (Required, String, ForceNew) Name of the policy. +* `role_name` - (Required, String, ForceNew) Name of the attached CAM role. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_mode` - Mode of Creation of the CAM role policy attachment. `1` means the CAM policy attachment is created by production, and the others indicate syntax strategy ways. +* `create_time` - The create time of the CAM role policy attachment. +* `policy_type` - Type of the policy strategy. `User` means customer strategy and `QCS` means preset strategy. + + +## Import + +CAM role policy attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cam_role_policy_attachment_by_name.foo ${role_name}#${policy_name} +``` + diff --git a/config/docs/r/cam_role_sso.html.markdown b/config/docs/r/cam_role_sso.html.markdown new file mode 100644 index 0000000..c971a59 --- /dev/null +++ b/config/docs/r/cam_role_sso.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_role_sso" +sidebar_current: "docs-tencentcloud-resource-cam_role_sso" +description: |- + Provides a resource to create a CAM-ROLE-SSO (Only support OIDC). +--- + +# tencentcloud_cam_role_sso + +Provides a resource to create a CAM-ROLE-SSO (Only support OIDC). + +## Example Usage + +```hcl +resource "tencentcloud_cam_role_sso" "foo" { + name = "tf_cam_role_sso" + identity_url = "https://login.microsoftonline.com/.../v2.0" + identity_key = "..." + client_ids = ["..."] + description = "this is a description" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `client_ids` - (Required, Set: [`String`]) Client ids. +* `identity_key` - (Required, String) Sign the public key. +* `identity_url` - (Required, String) Identity provider URL. +* `name` - (Required, String) The name of resource. +* `description` - (Optional, String) The description of resource. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +CAM-ROLE-SSO can be imported using the `name`, e.g. + +``` +$ terraform import tencentcloud_cam_role_sso.foo "test" +``` + diff --git a/config/docs/r/cam_saml_provider.html.markdown b/config/docs/r/cam_saml_provider.html.markdown new file mode 100644 index 0000000..d8fb5a1 --- /dev/null +++ b/config/docs/r/cam_saml_provider.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_saml_provider" +sidebar_current: "docs-tencentcloud-resource-cam_saml_provider" +description: |- + Provides a resource to create a CAM SAML provider. +--- + +# tencentcloud_cam_saml_provider + +Provides a resource to create a CAM SAML provider. + +## Example Usage + +```hcl +resource "tencentcloud_cam_saml_provider" "saml_provider_basic" { + name = "tf_cam_saml" + meta_data = "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48bWQ6RW50aXR5RGVzY3JpcHRvciBlbnRpdHlJRD0iaHR0cDovL3d3dy5va3RhLmNvbS9leGsxa3F4bWNqUW1HQURNeTM1NyIgeG1sbnM6bWQ9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDptZXRhZGF0YSI+PG1kOklEUFNTT0Rlc2NyaXB0b3IgV2FudEF1dGhuUmVxdWVzdHNTaWduZWQ9ImZhbHNlIiBwcm90b2NvbFN1cHBvcnRFbnVtZXJhdGlvbj0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOnByb3RvY29sIj48bWQ6S2V5RGVzY3JpcHRvciB1c2U9InNpZ25pbmciPjxkczpLZXlJbmZvIHhtbG5zOmRzPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwLzA5L3htbGRzaWcjIj48ZHM6WDUwOURhdGE+PGRzOlg1MDlDZXJ0aWZpY2F0ZT5NSUlEb0RDQ0FvaWdBd0lCQWdJR0FXM0lTcExvTUEwR0NTcUdTSWIzRFFFQkN3VUFNSUdRTVFzd0NRWURWUVFHRXdKVlV6RVRNQkVHDQpBMVVFQ0F3S1EyRnNhV1p2Y201cFlURVdNQlFHQTFVRUJ3d05VMkZ1SUVaeVlXNWphWE5qYnpFTk1Bc0dBMVVFQ2d3RVQydDBZVEVVDQpNQklHQTFVRUN3d0xVMU5QVUhKdmRtbGtaWEl4RVRBUEJnTlZCQU1NQ0dsa2VIVmxkblJoTVJ3d0dnWUpLb1pJaHZjTkFRa0JGZzFwDQpibVp2UUc5cmRHRXVZMjl0TUI0WERURTVNVEF4TkRBek1qSXhNMW9YRFRJNU1UQXhOREF6TWpNeE0xb3dnWkF4Q3pBSkJnTlZCQVlUDQpBbFZUTVJNd0VRWURWUVFJREFwRFlXeHBabTl5Ym1saE1SWXdGQVlEVlFRSERBMVRZVzRnUm5KaGJtTnBjMk52TVEwd0N3WURWUVFLDQpEQVJQYTNSaE1SUXdFZ1lEVlFRTERBdFRVMDlRY205MmFXUmxjakVSTUE4R0ExVUVBd3dJYVdSNGRXVjJkR0V4SERBYUJna3Foa2lHDQo5dzBCQ1FFV0RXbHVabTlBYjJ0MFlTNWpiMjB3Z2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRQ2g4b3dqDQpZK2dQSUM3blQvNTduLzdmeXJzcDlHMXdxa2UxdXhjMHVrTndnQXozOVNpelY3QVhLMWRReTFLaThXWjJJMzFEczJkT0FNQ1FKR2pWDQpUWWNNbnA3KzhqUzNLdmxNUkRJamk5cmxuUi9vcnBvMll1RHVWby9jVzdidlRIS2h2REo1QWZRaWxzYlNPTXdUOWM2TVlYZGhBNVBwDQpzelFsK1UrdHJmcXUrdUorSER4SVQxdlhWaVI5YlY2SUFRSzZpbWZoc2wxWmVSUytjbVFVNEpjQWlYT0xtTnFVVWM2UkpxUzhrMW1mDQpBLzhmb2VyMGc3SG4xZDVXclpCc2gyUlR2Vzh1ZVdadHQ3dmh4QTlGdE5kSVlEcXJ0eElmMlZXcXhrSHM3WFZDSm5wTnJITVovT1BRDQpGY21YSGVxNlJJMlB3Q1RlOW8zZHZpM0hqeXBaOEl4dkFnTUJBQUV3RFFZSktvWklodmNOQVFFTEJRQURnZ0VCQUFHaHk1bG9nbGtTDQoyVHg2YS90MnF5VEx0YVV5cEwrNGhySGJoMVAweVVMc0NrSnFsM2wrWG9VZDZCY2FJaFNSVGFPQk95ODViL0UzelJ4K3JzQXJwTjVVDQp5ZThuUEM4a05PYW5vTk9wWnZvYmhpTzFlMFIvYmxEcnRBL0o5UlBwMWtmdlhmS2NSTTU3TlRCWXppTURlbnFQUTRFOWN1U2lGdFFxDQpJYmpIbThaM1B1YXgwRitldkZ3U1pJMDNCWXNISGw1d1EraEJBS3hTdTJINEZRdU93Zmpnb2EveEN6Z1NKYjJ2UXdEc1MxMk9mSkNiDQpSRm1ZL1VYZXQramFhdEVORktLZStZSUJpU0J2WG1adTN0MHN5NDZTNzlPVzBacXJ0NUh2bElsT2lpTFpaN1FZamxjM1kxeG1LZ1luDQpXM2M2WGZkdmhGWHo0ZDdkbWYvTUdpNGY0enM9PC9kczpYNTA5Q2VydGlmaWNhdGU+PC9kczpYNTA5RGF0YT48L2RzOktleUluZm8+PC9tZDpLZXlEZXNjcmlwdG9yPjxtZDpOYW1lSURGb3JtYXQ+dXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6MS4xOm5hbWVpZC1mb3JtYXQ6dW5zcGVjaWZpZWQ8L21kOk5hbWVJREZvcm1hdD48bWQ6TmFtZUlERm9ybWF0PnVybjpvYXNpczpuYW1lczp0YzpTQU1MOjEuMTpuYW1laWQtZm9ybWF0OmVtYWlsQWRkcmVzczwvbWQ6TmFtZUlERm9ybWF0PjxtZDpTaW5nbGVTaWduT25TZXJ2aWNlIEJpbmRpbmc9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDpiaW5kaW5nczpIVFRQLVBPU1QiIExvY2F0aW9uPSJodHRwczovL2lkeHVldnRhLm9rdGEuY29tL2FwcC9pZHh1ZW9yZzYzNzM1OF90ZXN0XzEvZXhrMWtxeG1jalFtR0FETXkzNTcvc3NvL3NhbWwiLz48bWQ6U2luZ2xlU2lnbk9uU2VydmljZSBCaW5kaW5nPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6YmluZGluZ3M6SFRUUC1SZWRpcmVjdCIgTG9jYXRpb249Imh0dHBzOi8vaWR4dWV2dGEub2t0YS5jb20vYXBwL2lkeHVlb3JnNjM3MzU4X3Rlc3RfMS9leGsxa3F4bWNqUW1HQURNeTM1Ny9zc28vc2FtbCIvPjwvbWQ6SURQU1NPRGVzY3JpcHRvcj48L21kOkVudGl0eURlc2NyaXB0b3I+" + description = "tf_test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `description` - (Required, String) The description of the CAM SAML provider. +* `meta_data` - (Required, String) The meta data document of the CAM SAML provider. +* `name` - (Required, String, ForceNew) Name of CAM SAML provider. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - The create time of the CAM SAML provider. +* `provider_arn` - The ARN of the CAM SAML provider. +* `update_time` - The last update time of the CAM SAML provider. + + +## Import + +CAM SAML provider can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cam_saml_provider.foo cam-SAML-provider-test +``` + diff --git a/config/docs/r/cam_service_linked_role.html.markdown b/config/docs/r/cam_service_linked_role.html.markdown new file mode 100644 index 0000000..eff6dbd --- /dev/null +++ b/config/docs/r/cam_service_linked_role.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_service_linked_role" +sidebar_current: "docs-tencentcloud-resource-cam_service_linked_role" +description: |- + Provides a resource to create a cam service_linked_role +--- + +# tencentcloud_cam_service_linked_role + +Provides a resource to create a cam service_linked_role + +## Example Usage + +```hcl +resource "tencentcloud_cam_service_linked_role" "service_linked_role" { + qcs_service_name = ["cvm.qcloud.com", "ekslog.tke.cloud.tencent.com"] + custom_suffix = "tf" + description = "desc cam" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `qcs_service_name` - (Required, Set: [`String`], ForceNew) Authorization service, the Tencent Cloud service principal with this role attached. +* `custom_suffix` - (Optional, String, ForceNew) The custom suffix, based on the string you provide, is combined with the prefix provided by the service to form the full role name. This field is not allowed to contain the character `_`. +* `description` - (Optional, String) role description. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cam_set_policy_version_config.html.markdown b/config/docs/r/cam_set_policy_version_config.html.markdown new file mode 100644 index 0000000..8b6c369 --- /dev/null +++ b/config/docs/r/cam_set_policy_version_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_set_policy_version_config" +sidebar_current: "docs-tencentcloud-resource-cam_set_policy_version_config" +description: |- + Provides a resource to create a cam set_policy_version_config +--- + +# tencentcloud_cam_set_policy_version_config + +Provides a resource to create a cam set_policy_version_config + +## Example Usage + +```hcl +resource "tencentcloud_cam_set_policy_version_config" "set_policy_version_config" { + policy_id = 171162811 + version_id = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy_id` - (Required, Int) Policy ID. +* `version_id` - (Required, Int) The policy version number, which can be obtained from ListPolicyVersions. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cam set_policy_version_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_cam_set_policy_version_config.set_policy_version_config set_policy_version_config_id +``` + diff --git a/config/docs/r/cam_tag_role_attachment.html.markdown b/config/docs/r/cam_tag_role_attachment.html.markdown new file mode 100644 index 0000000..624b046 --- /dev/null +++ b/config/docs/r/cam_tag_role_attachment.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_tag_role_attachment" +sidebar_current: "docs-tencentcloud-resource-cam_tag_role_attachment" +description: |- + Provides a resource to create a cam tag_role +--- + +# tencentcloud_cam_tag_role_attachment + +Provides a resource to create a cam tag_role + +## Example Usage + +```hcl +resource "tencentcloud_cam_tag_role_attachment" "tag_role" { + tags { + key = "test1" + value = "test1" + } + role_id = "test-cam-tag" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `tags` - (Required, List, ForceNew) Label. +* `role_id` - (Optional, String, ForceNew) Character ID, at least one input with the character name. +* `role_name` - (Optional, String, ForceNew) Character name, at least one input with the character ID. + +The `tags` object supports the following: + +* `key` - (Required, String) Label. +* `value` - (Required, String) Label. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cam tag_role can be imported using the id, e.g. + +``` +terraform import tencentcloud_cam_tag_role_attachment.tag_role tag_role_id +``` + diff --git a/config/docs/r/cam_user.html.markdown b/config/docs/r/cam_user.html.markdown new file mode 100644 index 0000000..803c4b1 --- /dev/null +++ b/config/docs/r/cam_user.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_user" +sidebar_current: "docs-tencentcloud-resource-cam_user" +description: |- + Provides a resource to manage CAM user. +--- + +# tencentcloud_cam_user + +Provides a resource to manage CAM user. + +## Example Usage + +```hcl +resource "tencentcloud_cam_user" "foo" { + name = "tf_cam_user" + remark = "tf_user_test" + console_login = true + use_api = true + need_reset_password = true + password = "Gail@1234" + phone_num = "12345678910" + email = "hello@test.com" + country_code = "86" + force_delete = true + tags = { + test = "tf_cam_user", + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String, ForceNew) Name of the CAM user. +* `console_login` - (Optional, Bool) Indicate whether the CAM user can login to the web console or not. +* `country_code` - (Optional, String) Country code of the phone number, for example: '86'. +* `email` - (Optional, String) Email of the CAM user. +* `force_delete` - (Optional, Bool) Indicate whether to force deletes the CAM user. If set false, the API secret key will be checked and failed when exists; otherwise the user will be deleted directly. Default is false. +* `need_reset_password` - (Optional, Bool) Indicate whether the CAM user need to reset the password when first logins. +* `password` - (Optional, String) The password of the CAM user. Password should be at least 8 characters and no more than 32 characters, includes uppercase letters, lowercase letters, numbers and special characters. Only required when `console_login` is true. If not set, a random password will be automatically generated. +* `phone_num` - (Optional, String) Phone number of the CAM user. +* `remark` - (Optional, String) Remark of the CAM user. +* `tags` - (Optional, Map) A list of tags used to associate different resources. +* `use_api` - (Optional, Bool) Indicate whether to generate the API secret key or not. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `secret_id` - Secret ID of the CAM user. +* `secret_key` - Secret key of the CAM user. +* `uid` - ID of the CAM user. +* `uin` - Uin of the CAM User. + + +## Import + +CAM user can be imported using the user name, e.g. + +``` +$ terraform import tencentcloud_cam_user.foo cam-user-test +``` + diff --git a/config/docs/r/cam_user_permission_boundary_attachment.html.markdown b/config/docs/r/cam_user_permission_boundary_attachment.html.markdown new file mode 100644 index 0000000..ee8e60b --- /dev/null +++ b/config/docs/r/cam_user_permission_boundary_attachment.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_user_permission_boundary_attachment" +sidebar_current: "docs-tencentcloud-resource-cam_user_permission_boundary_attachment" +description: |- + Provides a resource to create a cam user_permission_boundary +--- + +# tencentcloud_cam_user_permission_boundary_attachment + +Provides a resource to create a cam user_permission_boundary + +## Example Usage + +```hcl +resource "tencentcloud_cam_user_permission_boundary_attachment" "user_permission_boundary" { + target_uin = 100032767426 + policy_id = 151113272 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy_id` - (Required, Int, ForceNew) Policy ID. +* `target_uin` - (Required, Int, ForceNew) Sub account Uin. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cam user_permission_boundary can be imported using the id, e.g. + +``` +terraform import tencentcloud_cam_user_permission_boundary_attachment.user_permission_boundary user_permission_boundary_id +``` + diff --git a/config/docs/r/cam_user_policy_attachment.html.markdown b/config/docs/r/cam_user_policy_attachment.html.markdown new file mode 100644 index 0000000..877ca6c --- /dev/null +++ b/config/docs/r/cam_user_policy_attachment.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_user_policy_attachment" +sidebar_current: "docs-tencentcloud-resource-cam_user_policy_attachment" +description: |- + Provides a resource to create a CAM user policy attachment. +--- + +# tencentcloud_cam_user_policy_attachment + +Provides a resource to create a CAM user policy attachment. + +## Example Usage + +```hcl +variable "cam_user_basic" { + default = "keep-cam-user" +} + +resource "tencentcloud_cam_policy" "policy_basic" { + name = "tf_cam_attach_user_policy" + document = jsonencode({ + "version" : "2.0", + "statement" : [ + { + "action" : ["cos:*"], + "resource" : ["*"], + "effect" : "allow", + }, + { + "effect" : "allow", + "action" : ["monitor:*", "cam:ListUsersForGroup", "cam:ListGroups", "cam:GetGroup"], + "resource" : ["*"], + } + ] + }) + description = "tf_test" +} + +data "tencentcloud_cam_users" "users" { + name = var.cam_user_basic +} + +resource "tencentcloud_cam_user_policy_attachment" "user_policy_attachment_basic" { + user_name = data.tencentcloud_cam_users.users.user_list.0.user_id + policy_id = tencentcloud_cam_policy.policy_basic.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy_id` - (Required, String, ForceNew) ID of the policy. +* `user_id` - (Optional, String, ForceNew, **Deprecated**) It has been deprecated from version 1.59.5. Use `user_name` instead. ID of the attached CAM user. +* `user_name` - (Optional, String, ForceNew) Name of the attached CAM user as uniq key. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_mode` - Mode of Creation of the CAM user policy attachment. `1` means the CAM policy attachment is created by production, and the others indicate syntax strategy ways. +* `create_time` - Create time of the CAM user policy attachment. +* `policy_name` - Name of the policy. +* `policy_type` - Type of the policy strategy. `User` means customer strategy and `QCS` means preset strategy. + + +## Import + +CAM user policy attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cam_user_policy_attachment.foo cam-test#26800353 +``` + diff --git a/config/docs/r/cam_user_saml_config.html.markdown b/config/docs/r/cam_user_saml_config.html.markdown new file mode 100644 index 0000000..b2b6381 --- /dev/null +++ b/config/docs/r/cam_user_saml_config.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Access Management(CAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cam_user_saml_config" +sidebar_current: "docs-tencentcloud-resource-cam_user_saml_config" +description: |- + Provides a resource to create a cam user_saml_config +--- + +# tencentcloud_cam_user_saml_config + +Provides a resource to create a cam user_saml_config + +## Example Usage + +```hcl +resource "tencentcloud_cam_user_saml_config" "user_saml_config" { + saml_metadata_document = "./metadataDocument.xml" + # saml_metadata_document = <<-EOT + # + # EOT +} +``` + +## Argument Reference + +The following arguments are supported: + +* `saml_metadata_document` - (Required, String) SAML metadata document, xml format, support string content or file path. +* `metadata_document_file` - (Optional, String) The path used to save the samlMetadat file. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - Status: `0`: not set, `11`: enabled, `2`: disabled. + + +## Import + +cam user_saml_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_cam_user_saml_config.user_saml_config user_id +``` + diff --git a/config/docs/r/cat_task_set.html.markdown b/config/docs/r/cat_task_set.html.markdown new file mode 100644 index 0000000..ea5b75b --- /dev/null +++ b/config/docs/r/cat_task_set.html.markdown @@ -0,0 +1,93 @@ +--- +subcategory: "Cloud Automated Testing(CAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cat_task_set" +sidebar_current: "docs-tencentcloud-resource-cat_task_set" +description: |- + Provides a resource to create a cat task_set +--- + +# tencentcloud_cat_task_set + +Provides a resource to create a cat task_set + +## Example Usage + +```hcl +resource "tencentcloud_cat_task_set" "task_set" { + batch_tasks { + name = "demo" + target_address = "http://www.baidu.com" + } + task_type = 5 + nodes = ["12136", "12137", "12138", "12141", "12144"] + interval = 6 + parameters = jsonencode( + { + "ipType" = 0, + "grabBag" = 0, + "filterIp" = 0, + "netIcmpOn" = 1, + "netIcmpActivex" = 0, + "netIcmpTimeout" = 20, + "netIcmpInterval" = 0.5, + "netIcmpNum" = 20, + "netIcmpSize" = 32, + "netIcmpDataCut" = 1, + "netDnsOn" = 1, + "netDnsTimeout" = 5, + "netDnsQuerymethod" = 1, + "netDnsNs" = "", + "netDigOn" = 1, + "netDnsServer" = 2, + "netTracertOn" = 1, + "netTracertTimeout" = 60, + "netTracertNum" = 30, + "whiteList" = "", + "blackList" = "", + "netIcmpActivexStr" = "" + } + ) + task_category = 1 + cron = "* 0-6 * * *" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `batch_tasks` - (Required, List) Batch task name address. +* `interval` - (Required, Int) Task interval minutes in (1,5,10,15,30,60,120,240). +* `nodes` - (Required, Set: [`String`]) Task Nodes. +* `parameters` - (Required, String) tasks parameters. +* `task_category` - (Required, Int) Task category,1:PC,2:Mobile. +* `task_type` - (Required, Int) Task Type 1:Page Performance, 2:File upload,3:File Download,4:Port performance 5:Audio and video. +* `cron` - (Optional, String) Timer task cron expression. +* `operate` - (Optional, String) The input is valid when the parameter is modified, `suspend`/`resume`, used to suspend/resume the dial test task. +* `tags` - (Optional, Map) Tag description list. + +The `batch_tasks` object supports the following: + +* `name` - (Required, String) Task name. +* `target_address` - (Required, String) Target address. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - Task status 1:TaskPending, 2:TaskRunning,3:TaskRunException,4:TaskSuspending 5:TaskSuspendException,6:TaskSuspendException,7:TaskSuspended,9:TaskDeleted. +* `task_id` - Task Id. + + +## Import + +cat task_set can be imported using the id, e.g. +``` +$ terraform import tencentcloud_cat_task_set.task_set taskSet_id +``` + diff --git a/config/docs/r/cbs_disk_backup.html.markdown b/config/docs/r/cbs_disk_backup.html.markdown new file mode 100644 index 0000000..f2ad939 --- /dev/null +++ b/config/docs/r/cbs_disk_backup.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_disk_backup" +sidebar_current: "docs-tencentcloud-resource-cbs_disk_backup" +description: |- + Provides a resource to create a cbs disk_backup. +--- + +# tencentcloud_cbs_disk_backup + +Provides a resource to create a cbs disk_backup. + +~> **NOTE:** Backup quota must greater than 1. + +## Example Usage + +```hcl +resource "tencentcloud_cbs_disk_backup" "disk_backup" { + disk_id = "disk-xxx" + disk_backup_name = "xxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `disk_id` - (Required, String, ForceNew) ID of the original cloud disk of the backup point, which can be queried through the DescribeDisks API. +* `disk_backup_name` - (Optional, String, ForceNew) Backup point name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cbs disk_backup can be imported using the id, e.g. + +``` +terraform import tencentcloud_cbs_disk_backup.disk_backup disk_backup_id +``` + diff --git a/config/docs/r/cbs_disk_backup_rollback_operation.html.markdown b/config/docs/r/cbs_disk_backup_rollback_operation.html.markdown new file mode 100644 index 0000000..db12343 --- /dev/null +++ b/config/docs/r/cbs_disk_backup_rollback_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_disk_backup_rollback_operation" +sidebar_current: "docs-tencentcloud-resource-cbs_disk_backup_rollback_operation" +description: |- + Provides a resource to rollback cbs disk backup. +--- + +# tencentcloud_cbs_disk_backup_rollback_operation + +Provides a resource to rollback cbs disk backup. + +## Example Usage + +```hcl +resource "tencentcloud_cbs_disk_backup_rollback_operation" "operation" { + disk_backup_id = "dbp-xxx" + disk_id = "disk-xxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `disk_backup_id` - (Required, String, ForceNew) Cloud disk backup point ID. +* `disk_id` - (Required, String, ForceNew) Cloud disk backup point original cloud disk ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `is_rollback_completed` - Whether the rollback is completed. `true` meaing rollback completed, `false` meaning still rollbacking. + + diff --git a/config/docs/r/cbs_snapshot.html.markdown b/config/docs/r/cbs_snapshot.html.markdown new file mode 100644 index 0000000..5959739 --- /dev/null +++ b/config/docs/r/cbs_snapshot.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_snapshot" +sidebar_current: "docs-tencentcloud-resource-cbs_snapshot" +description: |- + Provides a resource to create a CBS snapshot. +--- + +# tencentcloud_cbs_snapshot + +Provides a resource to create a CBS snapshot. + +## Example Usage + +```hcl +resource "tencentcloud_cbs_snapshot" "snapshot" { + snapshot_name = "unnamed" + storage_id = "disk-kdt0sq6m" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `snapshot_name` - (Required, String) Name of the snapshot. +* `storage_id` - (Required, String, ForceNew) ID of the the CBS which this snapshot created from. +* `tags` - (Optional, Map, **Deprecated**) cbs snapshot do not support tag now. The available tags within this CBS Snapshot. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of snapshot. +* `disk_type` - Types of CBS which this snapshot created from. +* `percent` - Snapshot creation progress percentage. If the snapshot has created successfully, the constant value is 100. +* `snapshot_status` - Status of the snapshot. +* `storage_size` - Volume of storage which this snapshot created from. + + +## Import + +CBS snapshot can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cbs_snapshot.snapshot snap-3sa3f39b +``` + diff --git a/config/docs/r/cbs_snapshot_policy.html.markdown b/config/docs/r/cbs_snapshot_policy.html.markdown new file mode 100644 index 0000000..4ebf002 --- /dev/null +++ b/config/docs/r/cbs_snapshot_policy.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_snapshot_policy" +sidebar_current: "docs-tencentcloud-resource-cbs_snapshot_policy" +description: |- + Provides a snapshot policy resource. +--- + +# tencentcloud_cbs_snapshot_policy + +Provides a snapshot policy resource. + +## Example Usage + +```hcl +resource "tencentcloud_cbs_snapshot_policy" "snapshot_policy" { + snapshot_policy_name = "mysnapshotpolicyname" + repeat_weekdays = [1, 4] + repeat_hours = [1] + retention_days = 7 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `repeat_hours` - (Required, List: [`Int`]) Trigger times of periodic snapshot. Valid value ranges: (0~23). The 0 means 00:00, and so on. +* `repeat_weekdays` - (Required, List: [`Int`]) Periodic snapshot is enabled. Valid values: [0, 1, 2, 3, 4, 5, 6]. 0 means Sunday, 1-6 means Monday to Saturday. +* `snapshot_policy_name` - (Required, String) Name of snapshot policy. The maximum length can not exceed 60 bytes. +* `retention_days` - (Optional, Int) Retention days of the snapshot, and the default value is 7. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +CBS snapshot policy can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cbs_snapshot_policy.snapshot_policy asp-jliex1tn +``` + diff --git a/config/docs/r/cbs_snapshot_policy_attachment.html.markdown b/config/docs/r/cbs_snapshot_policy_attachment.html.markdown new file mode 100644 index 0000000..2a6a0ff --- /dev/null +++ b/config/docs/r/cbs_snapshot_policy_attachment.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_snapshot_policy_attachment" +sidebar_current: "docs-tencentcloud-resource-cbs_snapshot_policy_attachment" +description: |- + Provides a CBS snapshot policy attachment resource. +--- + +# tencentcloud_cbs_snapshot_policy_attachment + +Provides a CBS snapshot policy attachment resource. + +## Example Usage + +```hcl +resource "tencentcloud_cbs_snapshot_policy_attachment" "foo" { + storage_id = tencentcloud_cbs_storage.foo.id + snapshot_policy_id = tencentcloud_cbs_snapshot_policy.policy.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `snapshot_policy_id` - (Required, String, ForceNew) ID of CBS snapshot policy. +* `storage_id` - (Required, String, ForceNew) ID of CBS. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cbs_snapshot_share_permission.html.markdown b/config/docs/r/cbs_snapshot_share_permission.html.markdown new file mode 100644 index 0000000..01e6adc --- /dev/null +++ b/config/docs/r/cbs_snapshot_share_permission.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_snapshot_share_permission" +sidebar_current: "docs-tencentcloud-resource-cbs_snapshot_share_permission" +description: |- + Provides a resource to create a cbs snapshot_share_permission +--- + +# tencentcloud_cbs_snapshot_share_permission + +Provides a resource to create a cbs snapshot_share_permission + +## Example Usage + +```hcl +resource "tencentcloud_cbs_snapshot_share_permission" "snapshot_share_permission" { + account_ids = ["1xxxxxx", "2xxxxxx"] + snapshot_id = "snap-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account_ids` - (Required, Set: [`String`]) List of account IDs with which a snapshot is shared. For the format of array-type parameters, see[API Introduction](https://cloud.tencent.com/document/api/213/568). You can find the account ID in[Account Information](https://console.cloud.tencent.com/developer). +* `snapshot_id` - (Required, String) The ID of the snapshot to be queried. You can obtain this by using [DescribeSnapshots](https://cloud.tencent.com/document/api/362/15647). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cbs snapshot_share_permission can be imported using the id, e.g. + +``` +terraform import tencentcloud_cbs_snapshot_share_permission.snapshot_share_permission snap-xxxxxx +``` + diff --git a/config/docs/r/cbs_storage.html.markdown b/config/docs/r/cbs_storage.html.markdown new file mode 100644 index 0000000..67eafaa --- /dev/null +++ b/config/docs/r/cbs_storage.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_storage" +sidebar_current: "docs-tencentcloud-resource-cbs_storage" +description: |- + Provides a resource to create a CBS. +--- + +# tencentcloud_cbs_storage + +Provides a resource to create a CBS. + +## Example Usage + +```hcl +resource "tencentcloud_cbs_storage" "storage" { + storage_name = "mystorage" + storage_type = "CLOUD_SSD" + storage_size = 100 + availability_zone = "ap-guangzhou-3" + project_id = 0 + encrypt = false + + tags = { + test = "tf" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Required, String, ForceNew) The available zone that the CBS instance locates at. +* `storage_name` - (Required, String) Name of CBS. The maximum length can not exceed 60 bytes. +* `storage_size` - (Required, Int) Volume of CBS, and unit is GB. +* `storage_type` - (Required, String, ForceNew) Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. +* `charge_type` - (Optional, String) The charge type of CBS instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. The default is `POSTPAID_BY_HOUR`. +* `disk_backup_quota` - (Optional, Int) The quota of backup points of cloud disk. +* `encrypt` - (Optional, Bool, ForceNew) Indicates whether CBS is encrypted. +* `force_delete` - (Optional, Bool) Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin. +* `period` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.33.0. Set `prepaid_period` instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]. +* `prepaid_period` - (Optional, Int) The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to `PREPAID`. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. +* `prepaid_renew_flag` - (Optional, String) Auto Renewal flag. Value range: `NOTIFY_AND_AUTO_RENEW`: Notify expiry and renew automatically, `NOTIFY_AND_MANUAL_RENEW`: Notify expiry but do not renew automatically, `DISABLE_NOTIFY_AND_MANUAL_RENEW`: Neither notify expiry nor renew automatically. Default value range: `NOTIFY_AND_MANUAL_RENEW`: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to `PREPAID`. +* `project_id` - (Optional, Int) ID of the project to which the instance belongs. +* `snapshot_id` - (Optional, String) ID of the snapshot. If specified, created the CBS by this snapshot. +* `tags` - (Optional, Map) The available tags within this CBS. +* `throughput_performance` - (Optional, Int) Add extra performance to the data disk. Only works when disk type is `CLOUD_TSSD` or `CLOUD_HSSD`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `attached` - Indicates whether the CBS is mounted the CVM. +* `storage_status` - Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING. + + +## Import + +CBS storage can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cbs_storage.storage disk-41s6jwy4 +``` + diff --git a/config/docs/r/cbs_storage_attachment.html.markdown b/config/docs/r/cbs_storage_attachment.html.markdown new file mode 100644 index 0000000..8d1befd --- /dev/null +++ b/config/docs/r/cbs_storage_attachment.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_storage_attachment" +sidebar_current: "docs-tencentcloud-resource-cbs_storage_attachment" +description: |- + Provides a CBS storage attachment resource. +--- + +# tencentcloud_cbs_storage_attachment + +Provides a CBS storage attachment resource. + +## Example Usage + +```hcl +resource "tencentcloud_cbs_storage_attachment" "attachment" { + storage_id = "disk-kdt0sq6m" + instance_id = "ins-jqlegd42" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of the CVM instance. +* `storage_id` - (Required, String, ForceNew) ID of the mounted CBS. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +CBS storage attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cbs_storage_attachment.attachment disk-41s6jwy4 +``` + diff --git a/config/docs/r/cbs_storage_set.html.markdown b/config/docs/r/cbs_storage_set.html.markdown new file mode 100644 index 0000000..7446289 --- /dev/null +++ b/config/docs/r/cbs_storage_set.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_storage_set" +sidebar_current: "docs-tencentcloud-resource-cbs_storage_set" +description: |- + Provides a resource to create CBS set. +--- + +# tencentcloud_cbs_storage_set + +Provides a resource to create CBS set. + +## Example Usage + +```hcl +resource "tencentcloud_cbs_storage_set" "storage" { + disk_count = 10 + storage_name = "mystorage" + storage_type = "CLOUD_SSD" + storage_size = 100 + availability_zone = "ap-guangzhou-3" + project_id = 0 + encrypt = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Required, String, ForceNew) The available zone that the CBS instance locates at. +* `storage_name` - (Required, String) Name of CBS. The maximum length can not exceed 60 bytes. +* `storage_size` - (Required, Int) Volume of CBS, and unit is GB. +* `storage_type` - (Required, String, ForceNew) Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD. +* `charge_type` - (Optional, String) The charge type of CBS instance. Only support `POSTPAID_BY_HOUR`. +* `disk_count` - (Optional, Int, ForceNew) The number of disks to be purchased. Default 1. +* `encrypt` - (Optional, Bool, ForceNew) Indicates whether CBS is encrypted. +* `project_id` - (Optional, Int) ID of the project to which the instance belongs. +* `snapshot_id` - (Optional, String) ID of the snapshot. If specified, created the CBS by this snapshot. +* `throughput_performance` - (Optional, Int) Add extra performance to the data disk. Only works when disk type is `CLOUD_TSSD` or `CLOUD_HSSD`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `attached` - Indicates whether the CBS is mounted the CVM. +* `disk_ids` - disk id list. +* `storage_status` - Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING. + + diff --git a/config/docs/r/cbs_storage_set_attachment.html.markdown b/config/docs/r/cbs_storage_set_attachment.html.markdown new file mode 100644 index 0000000..ae23415 --- /dev/null +++ b/config/docs/r/cbs_storage_set_attachment.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Block Storage(CBS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cbs_storage_set_attachment" +sidebar_current: "docs-tencentcloud-resource-cbs_storage_set_attachment" +description: |- + Provides a CBS storage set attachment resource. +--- + +# tencentcloud_cbs_storage_set_attachment + +Provides a CBS storage set attachment resource. + +## Example Usage + +```hcl +resource "tencentcloud_cbs_storage_set_attachment" "attachment" { + storage_id = "disk-kdt0sq6m" + instance_id = "ins-jqlegd42" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of the CVM instance. +* `storage_id` - (Required, String, ForceNew) ID of the mounted CBS. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ccn.html.markdown b/config/docs/r/ccn.html.markdown new file mode 100644 index 0000000..df7be53 --- /dev/null +++ b/config/docs/r/ccn.html.markdown @@ -0,0 +1,80 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn" +sidebar_current: "docs-tencentcloud-resource-ccn" +description: |- + Provides a resource to create a CCN instance. +--- + +# tencentcloud_ccn + +Provides a resource to create a CCN instance. + +## Example Usage + +### Create a prepaid CCN + +```hcl +resource "tencentcloud_ccn" "main" { + name = "ci-temp-test-ccn" + description = "ci-temp-test-ccn-des" + qos = "AG" + charge_type = "PREPAID" + bandwidth_limit_type = "INTER_REGION_LIMIT" +} +``` + +### Create a post-paid regional export speed limit type CCN + +```hcl +resource "tencentcloud_ccn" "main" { + name = "ci-temp-test-ccn" + description = "ci-temp-test-ccn-des" + qos = "AG" + charge_type = "POSTPAID" + bandwidth_limit_type = "OUTER_REGION_LIMIT" +} +``` + +### Create a post-paid inter-regional rate limit type CNN + +```hcl +resource "tencentcloud_ccn" "main" { + name = "ci-temp-test-ccn" + description = "ci-temp-test-ccn-des" + qos = "AG" + charge_type = "POSTPAID" + bandwidth_limit_type = "INTER_REGION_LIMIT" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the CCN to be queried, and maximum length does not exceed 60 bytes. +* `bandwidth_limit_type` - (Optional, String) The speed limit type. Valid values: `INTER_REGION_LIMIT`, `OUTER_REGION_LIMIT`. `OUTER_REGION_LIMIT` represents the regional export speed limit, `INTER_REGION_LIMIT` is the inter-regional speed limit. The default is `OUTER_REGION_LIMIT`. +* `charge_type` - (Optional, String, ForceNew) Billing mode. Valid values: `PREPAID`, `POSTPAID`. `PREPAID` means prepaid, which means annual and monthly subscription, `POSTPAID` means post-payment, which means billing by volume. The default is `POSTPAID`. The prepaid model only supports inter-regional speed limit, and the post-paid model supports inter-regional speed limit and regional export speed limit. +* `description` - (Optional, String) Description of CCN, and maximum length does not exceed 100 bytes. +* `qos` - (Optional, String, ForceNew) Service quality of CCN. Valid values: `PT`, `AU`, `AG`. The default is `AU`. +* `tags` - (Optional, Map) Instance tag. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of resource. +* `instance_count` - Number of attached instances. +* `state` - States of instance. Valid values: `ISOLATED`(arrears) and `AVAILABLE`. + + +## Import + +Ccn instance can be imported, e.g. + +``` +$ terraform import tencentcloud_ccn.test ccn-id +``` + diff --git a/config/docs/r/ccn_attachment.html.markdown b/config/docs/r/ccn_attachment.html.markdown new file mode 100644 index 0000000..4807a9b --- /dev/null +++ b/config/docs/r/ccn_attachment.html.markdown @@ -0,0 +1,79 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_attachment" +sidebar_current: "docs-tencentcloud-resource-ccn_attachment" +description: |- + Provides a CCN attaching resource. +--- + +# tencentcloud_ccn_attachment + +Provides a CCN attaching resource. + +## Example Usage + +```hcl +variable "region" { + default = "ap-guangzhou" +} + +variable "otheruin" { + default = "123353" +} + +variable "otherccn" { + default = "ccn-151ssaga" +} + +resource "tencentcloud_vpc" "vpc" { + name = "ci-temp-test-vpc" + cidr_block = "10.0.0.0/16" + dns_servers = ["119.29.29.29", "8.8.8.8"] + is_multicast = false +} + +resource "tencentcloud_ccn" "main" { + name = "ci-temp-test-ccn" + description = "ci-temp-test-ccn-des" + qos = "AG" +} + +resource "tencentcloud_ccn_attachment" "attachment" { + ccn_id = tencentcloud_ccn.main.id + instance_type = "VPC" + instance_id = tencentcloud_vpc.vpc.id + instance_region = var.region +} + +resource "tencentcloud_ccn_attachment" "other_account" { + ccn_id = var.otherccn + instance_type = "VPC" + instance_id = tencentcloud_vpc.vpc.id + instance_region = var.region + ccn_uin = var.otheruin +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ccn_id` - (Required, String, ForceNew) ID of the CCN. +* `instance_id` - (Required, String, ForceNew) ID of instance is attached. +* `instance_region` - (Required, String, ForceNew) The region that the instance locates at. +* `instance_type` - (Required, String, ForceNew) Type of attached instance network, and available values include `VPC`, `DIRECTCONNECT`, `BMVPC` and `VPNGW`. Note: `VPNGW` type is only for whitelist customer now. +* `ccn_uin` - (Optional, String, ForceNew) Uin of the ccn attached. Default is ``, which means the uin of this account. This parameter is used with case when attaching ccn of other account to the instance of this account. For now only support instance type `VPC`. +* `description` - (Optional, String) Remark of attachment. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `attached_time` - Time of attaching. +* `cidr_block` - A network address block of the instance that is attached. +* `route_ids` - Route id list. +* `state` - States of instance is attached. Valid values: `PENDING`, `ACTIVE`, `EXPIRED`, `REJECTED`, `DELETED`, `FAILED`, `ATTACHING`, `DETACHING` and `DETACHFAILED`. `FAILED` means asynchronous forced disassociation after 2 hours. `DETACHFAILED` means asynchronous forced disassociation after 2 hours. + + diff --git a/config/docs/r/ccn_bandwidth_limit.html.markdown b/config/docs/r/ccn_bandwidth_limit.html.markdown new file mode 100644 index 0000000..7202b52 --- /dev/null +++ b/config/docs/r/ccn_bandwidth_limit.html.markdown @@ -0,0 +1,78 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_bandwidth_limit" +sidebar_current: "docs-tencentcloud-resource-ccn_bandwidth_limit" +description: |- + Provides a resource to limit CCN bandwidth. +--- + +# tencentcloud_ccn_bandwidth_limit + +Provides a resource to limit CCN bandwidth. + +## Example Usage + +### Set the upper limit of regional outbound bandwidth + +```hcl +variable "other_region1" { + default = "ap-shanghai" +} + +resource "tencentcloud_ccn" "main" { + name = "ci-temp-test-ccn" + description = "ci-temp-test-ccn-des" + qos = "AG" +} + +resource "tencentcloud_ccn_bandwidth_limit" "limit1" { + ccn_id = tencentcloud_ccn.main.id + region = var.other_region1 + bandwidth_limit = 500 +} +``` + +### Set the upper limit between regions + +```hcl +variable "other_region1" { + default = "ap-shanghai" +} + +variable "other_region2" { + default = "ap-nanjing" +} + +resource tencentcloud_ccn main { + name = "ci-temp-test-ccn" + description = "ci-temp-test-ccn-des" + qos = "AG" + bandwidth_limit_type = "INTER_REGION_LIMIT" +} + +resource tencentcloud_ccn_bandwidth_limit limit1 { + ccn_id = tencentcloud_ccn.main.id + region = var.other_region1 + dst_region = var.other_region2 + bandwidth_limit = 100 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ccn_id` - (Required, String, ForceNew) ID of the CCN. +* `region` - (Required, String, ForceNew) Limitation of region. +* `bandwidth_limit` - (Optional, Int) Limitation of bandwidth. Default is `0`. +* `dst_region` - (Optional, String, ForceNew) Destination area restriction. If the `CCN` rate limit type is `OUTER_REGION_LIMIT`, this value does not need to be set. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ccn_instances_accept_attach.html.markdown b/config/docs/r/ccn_instances_accept_attach.html.markdown new file mode 100644 index 0000000..dfbb0e7 --- /dev/null +++ b/config/docs/r/ccn_instances_accept_attach.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_instances_accept_attach" +sidebar_current: "docs-tencentcloud-resource-ccn_instances_accept_attach" +description: |- + Provides a resource to create a vpc ccn_instances_accept_attach, you can use this resource to approve cross-region attachment. +--- + +# tencentcloud_ccn_instances_accept_attach + +Provides a resource to create a vpc ccn_instances_accept_attach, you can use this resource to approve cross-region attachment. + +## Example Usage + +```hcl +resource "tencentcloud_ccn_instances_accept_attach" "ccn_instances_accept_attach" { + ccn_id = "ccn-39lqkygf" + instances { + instance_id = "vpc-j9yhbzpn" + instance_region = "ap-guangzhou" + instance_type = "VPC" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ccn_id` - (Required, String, ForceNew) CCN Instance ID. +* `instances` - (Required, List, ForceNew) Accept List Of Attachment Instances. + +The `instances` object supports the following: + +* `instance_id` - (Required, String) Attachment Instance ID. +* `instance_region` - (Required, String) Instance Region. +* `description` - (Optional, String) Description. +* `instance_type` - (Optional, String) InstanceType: `VPC`, `DIRECTCONNECT`, `BMVPC`, `VPNGW`. +* `route_table_id` - (Optional, String) ID of the routing table associated with the instance. Note: This field may return null, indicating that no valid value can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ccn_instances_reject_attach.html.markdown b/config/docs/r/ccn_instances_reject_attach.html.markdown new file mode 100644 index 0000000..4ac2c37 --- /dev/null +++ b/config/docs/r/ccn_instances_reject_attach.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_instances_reject_attach" +sidebar_current: "docs-tencentcloud-resource-ccn_instances_reject_attach" +description: |- + Provides a resource to create a vpc ccn_instances_reject_attach, you can use this resource to approve cross-region attachment. +--- + +# tencentcloud_ccn_instances_reject_attach + +Provides a resource to create a vpc ccn_instances_reject_attach, you can use this resource to approve cross-region attachment. + +## Example Usage + +```hcl +resource "tencentcloud_ccn_instances_reject_attach" "ccn_instances_reject_attach" { + ccn_id = "ccn-39lqkygf" + instances { + instance_id = "vpc-j9yhbzpn" + instance_region = "ap-guangzhou" + instance_type = "VPC" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ccn_id` - (Required, String, ForceNew) CCN Instance ID. +* `instances` - (Required, List, ForceNew) Reject List Of Attachment Instances. + +The `instances` object supports the following: + +* `instance_id` - (Required, String) Attachment Instance ID. +* `instance_region` - (Required, String) Instance Region. +* `description` - (Optional, String) Description. +* `instance_type` - (Optional, String) InstanceType: `VPC`, `DIRECTCONNECT`, `BMVPC`, `VPNGW`. +* `route_table_id` - (Optional, String) ID of the routing table associated with the instance. Note: This field may return null, indicating that no valid value can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ccn_instances_reset_attach.html.markdown b/config/docs/r/ccn_instances_reset_attach.html.markdown new file mode 100644 index 0000000..66962b1 --- /dev/null +++ b/config/docs/r/ccn_instances_reset_attach.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_instances_reset_attach" +sidebar_current: "docs-tencentcloud-resource-ccn_instances_reset_attach" +description: |- + Provides a resource to create a vpc ccn_instances_reset_attach, you can use this resource to reset cross-region attachment. +--- + +# tencentcloud_ccn_instances_reset_attach + +Provides a resource to create a vpc ccn_instances_reset_attach, you can use this resource to reset cross-region attachment. + +## Example Usage + +```hcl +resource "tencentcloud_ccn_instances_reset_attach" "ccn_instances_reset_attach" { + ccn_id = "ccn-39lqkygf" + ccn_uin = "100022975249" + instances { + instance_id = "vpc-j9yhbzpn" + instance_region = "ap-guangzhou" + instance_type = "VPC" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ccn_id` - (Required, String, ForceNew) CCN Instance ID. +* `ccn_uin` - (Required, String, ForceNew) CCN Uin (root account). +* `instances` - (Required, List, ForceNew) List Of Attachment Instances. + +The `instances` object supports the following: + +* `instance_id` - (Required, String) Attachment Instance ID. +* `instance_region` - (Required, String) Instance Region. +* `description` - (Optional, String) Description. +* `instance_type` - (Optional, String) InstanceType: `VPC`, `DIRECTCONNECT`, `BMVPC`, `VPNGW`. +* `route_table_id` - (Optional, String) ID of the routing table associated with the instance. Note: This field may return null, indicating that no valid value can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ccn_routes.html.markdown b/config/docs/r/ccn_routes.html.markdown new file mode 100644 index 0000000..8a3bf20 --- /dev/null +++ b/config/docs/r/ccn_routes.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Connect Network(CCN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ccn_routes" +sidebar_current: "docs-tencentcloud-resource-ccn_routes" +description: |- + Provides a resource to create a vpc ccn_routes +--- + +# tencentcloud_ccn_routes + +Provides a resource to create a vpc ccn_routes + +## Example Usage + +```hcl +resource "tencentcloud_ccn_routes" "ccn_routes" { + ccn_id = "ccn-39lqkygf" + route_id = "ccnr-3o0dfyuw" + switch = "on" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ccn_id` - (Required, String, ForceNew) CCN Instance ID. +* `route_id` - (Required, String, ForceNew) CCN Route Id List. +* `switch` - (Required, String) `on`: Enable, `off`: Disable. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc ccn_routes can be imported using the id, e.g. + +``` +terraform import tencentcloud_ccn_routes.ccn_routes ccnId#routesId +``` + diff --git a/config/docs/r/cdh_instance.html.markdown b/config/docs/r/cdh_instance.html.markdown new file mode 100644 index 0000000..3776dbc --- /dev/null +++ b/config/docs/r/cdh_instance.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "CVM Dedicated Host(CDH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cdh_instance" +sidebar_current: "docs-tencentcloud-resource-cdh_instance" +description: |- + Provides a resource to manage CDH instance. +--- + +# tencentcloud_cdh_instance + +Provides a resource to manage CDH instance. + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +resource "tencentcloud_cdh_instance" "foo" { + availability_zone = var.availability_zone + host_type = "HC20" + charge_type = "PREPAID" + prepaid_period = 1 + host_name = "test" + prepaid_renew_flag = "NOTIFY_AND_MANUAL_RENEW" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Required, String, ForceNew) The available zone for the CDH instance. +* `charge_type` - (Optional, String) The charge type of instance. Valid values are `PREPAID`. The default is `PREPAID`. +* `host_name` - (Optional, String) The name of the CDH instance. The max length of host_name is 60. +* `host_type` - (Optional, String, ForceNew) The type of the CDH instance. +* `prepaid_period` - (Optional, Int) The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to `PREPAID`. Valid values are `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `24`, `36`. +* `prepaid_renew_flag` - (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 charge_type is set to `PREPAID`. +* `project_id` - (Optional, Int) The project the instance belongs to, default to 0. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the instance. +* `cvm_instance_ids` - Id of CVM instances that have been created on the CDH instance. +* `expired_time` - Expired time of the instance. +* `host_resource` - An information list of host resource. Each element contains the following attributes: + * `cpu_available_num` - The number of available CPU cores of the instance. + * `cpu_total_num` - The number of total CPU cores of the instance. + * `disk_available_size` - Instance disk available capacity, unit in GB. + * `disk_total_size` - Instance disk total capacity, unit in GB. + * `disk_type` - Type of the disk. + * `memory_available_size` - Instance memory available capacity, unit in GB. + * `memory_total_size` - Instance memory total capacity, unit in GB. +* `host_state` - State of the CDH instance. + + +## Import + +CDH instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cdh_instance.foo host-d6s7i5q4 +``` + diff --git a/config/docs/r/cdn_domain.html.markdown b/config/docs/r/cdn_domain.html.markdown new file mode 100644 index 0000000..6320c08 --- /dev/null +++ b/config/docs/r/cdn_domain.html.markdown @@ -0,0 +1,522 @@ +--- +subcategory: "Content Delivery Network(CDN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cdn_domain" +sidebar_current: "docs-tencentcloud-resource-cdn_domain" +description: |- + Provides a resource to create a CDN domain. +--- + +# tencentcloud_cdn_domain + +Provides a resource to create a CDN domain. + +~> **NOTE:** To disable most of configuration with switch, just modify switch argument to off instead of remove the whole block + +## Example Usage + +```hcl +resource "tencentcloud_cdn_domain" "foo" { + domain = "xxxx.com" + service_type = "web" + area = "mainland" + full_url_cache = false + + origin { + origin_type = "ip" + origin_list = ["127.0.0.1"] + origin_pull_protocol = "follow" + } + + https_config { + https_switch = "off" + http2_switch = "off" + ocsp_stapling_switch = "off" + spdy_switch = "off" + verify_client = "off" + + force_redirect { + switch = "on" + redirect_type = "http" + redirect_status_code = 302 + } + } + + tags = { + hello = "world" + } +} +``` + +### Example Usage of cdn uses cache and request headers + +```hcl +resource "tencentcloud_cdn_domain" "foo" { + domain = "xxxx.com" + service_type = "web" + area = "mainland" + # full_url_cache = true # Deprecated, use cache_key below. + cache_key { + full_url_cache = "on" + } + range_origin_switch = "off" + + rule_cache { + cache_time = 10000 + no_cache_switch = "on" + re_validate = "on" + } + + request_header { + switch = "on" + + header_rules { + header_mode = "add" + header_name = "tf-header-name" + header_value = "tf-header-value" + rule_type = "all" + rule_paths = ["*"] + } + } + + origin { + origin_type = "ip" + origin_list = ["127.0.0.1"] + origin_pull_protocol = "follow" + } + + https_config { + https_switch = "off" + http2_switch = "off" + ocsp_stapling_switch = "off" + spdy_switch = "off" + verify_client = "off" + + force_redirect { + switch = "on" + redirect_type = "http" + redirect_status_code = 302 + } + } + + tags = { + hello = "world" + } +} +``` + +### Example Usage of COS bucket url as origin + +```hcl +resource "tencentcloud_cos_bucket" "bucket" { + # Bucket format should be [custom name]-[appid]. + bucket = "demo-bucket-1251234567" + acl = "private" +} + +# Create cdn domain +resource "tencentcloud_cdn_domain" "cdn" { + domain = "abc.com" + service_type = "web" + area = "mainland" + # full_url_cache = false # Deprecated + cache_key { + full_url_cache = "off" + } + + origin { + origin_type = "cos" + origin_list = [tencentcloud_cos_bucket.bucket.cos_bucket_url] + server_name = tencentcloud_cos_bucket.bucket.cos_bucket_url + origin_pull_protocol = "follow" + cos_private_access = "on" + } + + https_config { + https_switch = "off" + http2_switch = "off" + ocsp_stapling_switch = "off" + spdy_switch = "off" + verify_client = "off" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Name of the acceleration domain. +* `origin` - (Required, List) Origin server configuration. It's a list and consist of at most one item. +* `service_type` - (Required, String, ForceNew) Acceleration domain name service type. `web`: static acceleration, `download`: download acceleration, `media`: streaming media VOD acceleration, `hybrid`: hybrid acceleration, `dynamic`: dynamic acceleration. +* `area` - (Optional, String) Domain name acceleration region. `mainland`: acceleration inside mainland China, `overseas`: acceleration outside mainland China, `global`: global acceleration. Overseas acceleration service must be enabled to use overseas acceleration and global acceleration. +* `authentication` - (Optional, List) Specify timestamp hotlink protection configuration, NOTE: only one type can choose for the sub elements. +* `aws_private_access` - (Optional, List) Access authentication for S3 origin. +* `band_width_alert` - (Optional, List) Bandwidth cap configuration. +* `cache_key` - (Optional, List) Cache key configuration (Ignore Query String configuration). NOTE: All of `full_url_cache` default value is `on`. +* `compression` - (Optional, List) Smart compression configurations. +* `downstream_capping` - (Optional, List) Downstream capping configuration. +* `error_page` - (Optional, List) Error page configurations. +* `explicit_using_dry_run` - (Optional, Bool) Used for validate only by store arguments to request json string as expected, WARNING: if set to `true`, NO Cloud Api will be invoked but store as local data, do not use this argument unless you really know what you are doing. +* `follow_redirect_switch` - (Optional, String) 301/302 redirect following switch, available values: `on`, `off` (default). +* `full_url_cache` - (Optional, Bool, **Deprecated**) Use `cache_key` -> `full_url_cache` instead. Whether to enable full-path cache. Default value is `true`. +* `https_config` - (Optional, List) HTTPS acceleration configuration. It's a list and consist of at most one item. +* `hw_private_access` - (Optional, List) Access authentication for OBS origin. +* `ip_filter` - (Optional, List) Specify Ip filter configurations. +* `ip_freq_limit` - (Optional, List) Specify Ip frequency limit configurations. +* `ipv6_access_switch` - (Optional, String) ipv6 access configuration switch. Only available when area set to `mainland`. Valid values are `on` and `off`. Default value is `off`. +* `max_age` - (Optional, List) Browser cache configuration. (This feature is in beta and not generally available yet). +* `offline_cache_switch` - (Optional, String) Offline cache switch, available values: `on`, `off` (default). +* `origin_pull_optimization` - (Optional, List) Cross-border linkage optimization configuration. (This feature is in beta and not generally available yet). +* `origin_pull_timeout` - (Optional, List) Cross-border linkage optimization configuration. +* `oss_private_access` - (Optional, List) Access authentication for OSS origin. +* `post_max_size` - (Optional, List) Maximum post size configuration. +* `project_id` - (Optional, Int) The project CDN belongs to, default to 0. +* `qn_private_access` - (Optional, List) Access authentication for OBS origin. +* `quic_switch` - (Optional, String) QUIC switch, available values: `on`, `off` (default). +* `range_origin_switch` - (Optional, String) Sharding back to source configuration switch. Valid values are `on` and `off`. Default value is `on`. +* `referer` - (Optional, List) Referer configuration. +* `request_header` - (Optional, List) Request header configuration. It's a list and consist of at most one item. +* `response_header_cache_switch` - (Optional, String) Response header cache switch, available values: `on`, `off` (default). +* `response_header` - (Optional, List) Response header configurations. +* `rule_cache` - (Optional, List) Advanced path cache configuration. +* `seo_switch` - (Optional, String) SEO switch, available values: `on`, `off` (default). +* `specific_config_mainland` - (Optional, String) Specific configuration for mainland, NOTE: Both specifying full schema or using it is superfluous, please use cloud api parameters json passthroughs, check the [Data Types](https://www.tencentcloud.com/document/api/228/31739#MainlandConfig) for more details. +* `specific_config_overseas` - (Optional, String) Specific configuration for oversea, NOTE: Both specifying full schema or using it is superfluous, please use cloud api parameters json passthroughs, check the [Data Types](https://www.tencentcloud.com/document/api/228/31739#OverseaConfig) for more details. +* `status_code_cache` - (Optional, List) Status code cache configurations. +* `tags` - (Optional, Map) Tags of cdn domain. +* `video_seek_switch` - (Optional, String) Video seek switch, available values: `on`, `off` (default). + +The `authentication` object supports the following: + +* `switch` - (Optional, String) Authentication switching, available values: `on`, `off`. +* `type_a` - (Optional, List) Timestamp hotlink protection mode A configuration. +* `type_b` - (Optional, List) Timestamp hotlink protection mode B configuration. NOTE: according to upgrading of TencentCloud Platform, TypeB is unavailable for now. +* `type_c` - (Optional, List) Timestamp hotlink protection mode C configuration. +* `type_d` - (Optional, List) Timestamp hotlink protection mode D configuration. + +The `aws_private_access` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `access_key` - (Optional, String) Access ID. +* `bucket` - (Optional, String) Bucket. +* `region` - (Optional, String) Region. +* `secret_key` - (Optional, String) Key. + +The `band_width_alert` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `alert_percentage` - (Optional, Int) Alert percentage. +* `alert_switch` - (Optional, String) Switch alert. +* `bps_threshold` - (Optional, Int) threshold of bps. +* `counter_measure` - (Optional, String) Counter measure. +* `metric` - (Optional, String) Metric. +* `statistic_item` - (Optional, List) Specify statistic item configuration. + +The `cache_key` object supports the following: + +* `full_url_cache` - (Optional, String) Whether to enable full-path cache, values `on` (DEFAULT ON), `off`. +* `ignore_case` - (Optional, String) Specifies whether the cache key is case sensitive. +* `key_rules` - (Optional, List) Path-specific cache key configuration. +* `query_string` - (Optional, List) Request parameter contained in CacheKey. + +The `cache_rules` object supports the following: + +* `cache_time` - (Required, Int) Status code cache expiration time (in seconds). +* `status_code` - (Required, String) Code of status cache. available values: `403`, `404`. + +The `capping_rules` object supports the following: + +* `kbps_threshold` - (Required, Int) Capping rule kbps threshold. +* `rule_paths` - (Required, List) List of capping rule path. +* `rule_type` - (Required, String) Capping rule type. + +The `client_certificate_config` object supports the following: + +* `certificate_content` - (Required, String) Client Certificate PEM format, requires Base64 encoding. + +The `compression_rules` object supports the following: + +* `algorithms` - (Required, List) List of algorithms, available: `gzip` and `brotli`. +* `compress` - (Required, Bool) Must be set as true, enables compression. +* `max_length` - (Required, Int) The maximum file size to trigger compression (in bytes). +* `min_length` - (Required, Int) The minimum file size to trigger compression (in bytes). +* `file_extensions` - (Optional, List) List of file extensions like `jpg`, `txt`. +* `rule_paths` - (Optional, List) List of rule paths for each `rule_type`: `*` for `all`, file ext like `jpg` for `file`, `/dir/like/` for `directory` and `/path/index.html` for `path`. +* `rule_type` - (Optional, String) Rule type, available: `all`, `file`, `directory`, `path`, `contentType`. + +The `compression` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `compression_rules` - (Optional, List) List of compression rules. + +The `downstream_capping` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `capping_rules` - (Optional, List) List of capping rule. + +The `error_page` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `page_rules` - (Optional, List) List of error page rule. + +The `filter_rules` object supports the following: + +* `filter_type` - (Required, String) Ip filter `blacklist`/`whitelist` type of filter rules. +* `filters` - (Required, List) Ip filter rule list, supports IPs in X.X.X.X format, or /8, /16, /24 format IP ranges. Up to 50 allowlists or blocklists can be entered. +* `rule_paths` - (Required, List) Content list for each `rule_type`: `*` for `all`, file ext like `jpg` for `file`, `/dir/like/` for `directory` and `/path/index.html` for `path`. +* `rule_type` - (Required, String) Ip filter rule type of filter rules, available: `all`, `file`, `directory`, `path`. + +The `force_redirect` object supports the following: + +* `carry_headers` - (Optional, String) Whether to return the newly added header during force redirection. Values: `on`, `off`. +* `redirect_status_code` - (Optional, Int) Forced redirect status code. Valid values are `301` and `302`. When `switch` setting `off`, this property does not need to be set or set to `302`. Default value is `302`. +* `redirect_type` - (Optional, String) Forced redirect type. Valid values are `http` and `https`. `http` means a forced redirect from HTTPS to HTTP, `https` means a forced redirect from HTTP to HTTPS. When `switch` setting `off`, this property does not need to be set or set to `http`. Default value is `http`. +* `switch` - (Optional, String) Forced redirect configuration switch. Valid values are `on` and `off`. Default value is `off`. + +The `header_rules` object supports the following: + +* `header_mode` - (Required, String) Http header setting method. The following types are supported: `add`: add a head, if a head already exists, there will be a duplicate head, `del`: delete the head. +* `header_name` - (Required, String) Http header name. +* `header_value` - (Required, String) Http header value, optional when Mode is `del`, Required when Mode is `add`/`set`. +* `rule_paths` - (Required, List) Matching content under the corresponding type of CacheType: `all`: fill *, `file`: fill in the suffix name, such as jpg, txt, `directory`: fill in the path, such as /xxx/test, `path`: fill in the absolute path, such as /xxx/test.html. +* `rule_type` - (Required, String) Rule type. The following types are supported: `all`: all documents take effect, `file`: the specified file suffix takes effect, `directory`: the specified path takes effect, `path`: specify the absolute path to take effect. + +The `header_rules` object supports the following: + +* `header_mode` - (Required, String) Response header mode. +* `header_name` - (Required, String) response header name of rule. +* `header_value` - (Required, String) response header value of rule. +* `rule_paths` - (Required, List) response rule paths of rule. +* `rule_type` - (Required, String) response rule type of rule. + +The `https_config` object supports the following: + +* `https_switch` - (Required, String) HTTPS configuration switch. Valid values are `on` and `off`. +* `client_certificate_config` - (Optional, List) Client certificate configuration information. +* `force_redirect` - (Optional, List) Configuration of forced HTTP or HTTPS redirects. +* `http2_switch` - (Optional, String) HTTP2 configuration switch. Valid values are `on` and `off`. and default value is `off`. +* `ocsp_stapling_switch` - (Optional, String) OCSP configuration switch. Valid values are `on` and `off`. and default value is `off`. +* `server_certificate_config` - (Optional, List) Server certificate configuration information. +* `spdy_switch` - (Optional, String) Spdy configuration switch. Valid values are `on` and `off`. and default value is `off`. This parameter is for white-list customer. +* `tls_versions` - (Optional, List) Tls version settings, only support some Advanced domain names, support settings TLSv1, TLSV1.1, TLSV1.2, TLSv1.3, when modifying must open consecutive versions. +* `verify_client` - (Optional, String) Client certificate authentication feature. Valid values are `on` and `off`. and default value is `off`. + +The `hw_private_access` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `access_key` - (Optional, String) Access ID. +* `bucket` - (Optional, String) Bucket. +* `secret_key` - (Optional, String) Key. + +The `ip_filter` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `filter_rules` - (Optional, List) Ip filter rules, This feature is only available to selected beta customers. +* `filter_type` - (Optional, String) IP `blacklist`/`whitelist` type. +* `filters` - (Optional, List) Ip filter list, Supports IPs in X.X.X.X format, or /8, /16, /24 format IP ranges. Up to 50 allowlists or blocklists can be entered. +* `return_code` - (Optional, Int) Return code, available values: 400-499. + +The `ip_freq_limit` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `qps` - (Optional, Int) Sets the limited number of requests per second, 514 will be returned for requests that exceed the limit. + +The `key_rules` object supports the following: + +* `query_string` - (Required, List) Request parameter contained in CacheKey. +* `rule_paths` - (Required, List) List of rule paths for each `key_rules`: `/` for `index`, file ext like `jpg` for `file`, `/dir/like/` for `directory` and `/path/index.html` for `path`. +* `rule_type` - (Required, String) Rule type, available: `file`, `directory`, `path`, `index`. +* `full_url_cache` - (Optional, String) Whether to enable full-path cache, values `on` (DEFAULT ON), `off`. +* `ignore_case` - (Optional, String) Whether caches are case insensitive. +* `rule_tag` - (Optional, String) Specify rule tag, default value is `user`. + +The `max_age_rules` object supports the following: + +* `max_age_contents` - (Required, List) List of rule paths for each `max_age_type`: `*` for `all`, file ext like `jpg` for `file`, `/dir/like/` for `directory` and `/path/index.html` for `path`. +* `max_age_time` - (Required, Int) Max Age time in seconds, this can set to `0` that stands for no cache. +* `max_age_type` - (Required, String) The following types are supported: `all`: all documents take effect, `file`: the specified file suffix takes effect, `directory`: the specified path takes effect, `path`: specify the absolute path to take effect, `index`: home page. +* `follow_origin` - (Optional, String) Whether to follow origin, values: `on`/`off`, if set to `on`, the `max_age_time` will be ignored. + +The `max_age` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `max_age_rules` - (Optional, List) List of Max Age rule configuration. + +The `origin_pull_optimization` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `optimization_type` - (Optional, String) Optimization type, values: `OVToCN` - Overseas to CN, `CNToOV` CN to Overseas. + +The `origin_pull_timeout` object supports the following: + +* `connect_timeout` - (Required, Int) The origin-pull connection timeout (in seconds). Valid range: 5-60. +* `receive_timeout` - (Required, Int) The origin-pull receipt timeout (in seconds). Valid range: 10-60. + +The `origin` object supports the following: + +* `origin_list` - (Required, List) Master origin server list. Valid values can be ip or domain name. When modifying the origin server, you need to enter the corresponding `origin_type`. +* `origin_type` - (Required, String) Master origin server type. The following types are supported: `domain`: domain name type, `cos`: COS origin, `ip`: IP list used as origin server, `ipv6`: origin server list is a single IPv6 address, `ip_ipv6`: origin server list is multiple IPv4 addresses and an IPv6 address. +* `backup_origin_list` - (Optional, List) Backup origin server list. Valid values can be ip or domain name. When modifying the backup origin server, you need to enter the corresponding `backup_origin_type`. +* `backup_origin_type` - (Optional, String) Backup origin server type, which supports the following types: `domain`: domain name type, `ip`: IP list used as origin server. +* `backup_server_name` - (Optional, String) Host header used when accessing the backup origin server. If left empty, the ServerName of master origin server will be used by default. +* `cos_private_access` - (Optional, String) When OriginType is COS, you can specify if access to private buckets is allowed. Valid values are `on` and `off`. and default value is `off`. +* `origin_pull_protocol` - (Optional, String) Origin-pull protocol configuration. `http`: forced HTTP origin-pull, `follow`: protocol follow origin-pull, `https`: forced HTTPS origin-pull. This only supports origin server port 443 for origin-pull. +* `server_name` - (Optional, String) Host header used when accessing the master origin server. If left empty, the acceleration domain name will be used by default. + +The `oss_private_access` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `access_key` - (Optional, String) Access ID. +* `bucket` - (Optional, String) Bucket. +* `region` - (Optional, String) Region. +* `secret_key` - (Optional, String) Key. + +The `page_rules` object supports the following: + +* `redirect_code` - (Required, Int) Redirect code of error page rules. +* `redirect_url` - (Required, String) Redirect url of error page rules. +* `status_code` - (Required, Int) Status code of error page rules. + +The `post_max_size` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `max_size` - (Optional, Int) Maximum size in MB, value range is `[1, 200]`. + +The `qn_private_access` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `access_key` - (Optional, String) Access ID. +* `secret_key` - (Optional, String) Key. + +The `query_string` object supports the following: + +* `action` - (Optional, String) Include/exclude query parameters. Values: `includeAll` (Default), `excludeAll`, `includeCustom`, `excludeCustom`. +* `reorder` - (Optional, String) Whether to sort again, values `on`, `off` (Default). +* `switch` - (Optional, String) Whether to use QueryString as part of CacheKey, values `on`, `off` (Default). +* `value` - (Optional, String) Array of included/excluded query strings (separated by `;`). + +The `query_string` object supports the following: + +* `action` - (Optional, String) Specify key rule QS action, values: `includeCustom`, `excludeCustom`. +* `switch` - (Optional, String) Whether to use QueryString as part of CacheKey, values `on`, `off` (Default). +* `value` - (Optional, String) Array of included/excluded query strings (separated by `;`). + +The `referer_rules` object supports the following: + +* `allow_empty` - (Required, Bool) Whether to allow emptpy. +* `referer_type` - (Required, String) Referer type. +* `referers` - (Required, List) Referer list. +* `rule_paths` - (Required, List) Referer rule path list. +* `rule_type` - (Required, String) Referer rule type. + +The `referer` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `referer_rules` - (Optional, List) List of referer rules. + +The `request_header` object supports the following: + +* `header_rules` - (Optional, List) Custom request header configuration rules. +* `switch` - (Optional, String) Custom request header configuration switch. Valid values are `on` and `off`. and default value is `off`. + +The `response_header` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `header_rules` - (Optional, List) List of response header rule. + +The `rule_cache` object supports the following: + +* `cache_time` - (Required, Int) Cache expiration time setting, the unit is second, the maximum can be set to 365 days. +* `compare_max_age` - (Optional, String) Advanced cache expiration configuration. When it is turned on, it will compare the max-age value returned by the origin site with the cache expiration time set in CacheRules, and take the minimum value to cache at the node. Valid values are `on` and `off`. Default value is `off`. +* `follow_origin_switch` - (Optional, String) Follow the source station configuration switch. Valid values are `on` and `off`. +* `heuristic_cache_switch` - (Optional, String) Specify whether to enable heuristic cache, only available while `follow_origin_switch` enabled, values: `on`, `off` (Default). +* `heuristic_cache_time` - (Optional, Int) Specify heuristic cache time in second, only available while `follow_origin_switch` and `heuristic_cache_switch` enabled. +* `ignore_cache_control` - (Optional, String) Force caching. After opening, the no-store and no-cache resources returned by the origin site will also be cached in accordance with the CacheRules rules. Valid values are `on` and `off`. Default value is `off`. +* `ignore_set_cookie` - (Optional, String) Ignore the Set-Cookie header of the origin site. Valid values are `on` and `off`. Default value is `off`. This parameter is for white-list customer. +* `no_cache_switch` - (Optional, String) Cache configuration switch. Valid values are `on` and `off`. +* `re_validate` - (Optional, String) Always check back to origin. Valid values are `on` and `off`. Default value is `off`. +* `rule_paths` - (Optional, List) Matching content under the corresponding type of CacheType: `all`: fill *, `file`: fill in the suffix name, such as jpg, txt, `directory`: fill in the path, such as /xxx/test, `path`: fill in the absolute path, such as /xxx/test.html, `index`: fill /. +* `rule_type` - (Optional, String) Rule type. The following types are supported: `all`: all documents take effect, `file`: the specified file suffix takes effect, `directory`: the specified path takes effect, `path`: specify the absolute path to take effect, `index`: home page. +* `switch` - (Optional, String) Cache configuration switch. Valid values are `on` and `off`. + +The `server_certificate_config` object supports the following: + +* `certificate_content` - (Optional, String) Server certificate information. This is required when uploading an external certificate, which should contain the complete certificate chain. +* `certificate_id` - (Optional, String) Server certificate ID. +* `message` - (Optional, String) Certificate remarks. +* `private_key` - (Optional, String) Server key information. This is required when uploading an external certificate. + +The `statistic_item` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `alert_percentage` - (Optional, Int) Alert percentage. +* `alert_switch` - (Optional, String) Switch alert. +* `bps_threshold` - (Optional, Int) threshold of bps. +* `counter_measure` - (Optional, String) Counter measure, values: `RETURN_404`, `RESOLVE_DNS_TO_ORIGIN`. +* `cycle` - (Optional, Int) Cycle of checking in minutes, values `60`, `1440`. +* `metric` - (Optional, String) Metric. +* `type` - (Optional, String) Type of statistic item. +* `unblock_time` - (Optional, Int) Time of auto unblock. + +The `status_code_cache` object supports the following: + +* `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default). +* `cache_rules` - (Optional, List) List of cache rule. + +The `type_a` object supports the following: + +* `expire_time` - (Required, Int) Signature expiration time in second. The maximum value is 630720000. +* `file_extensions` - (Required, List) File extension list settings determining if authentication should be performed. NOTE: If it contains an asterisk (*), this indicates all files. +* `filter_type` - (Required, String) Available values: `whitelist` - all types apart from `file_extensions` are authenticated, `blacklist`: - only the types in the `file_extensions` are authenticated. +* `secret_key` - (Required, String) The key for signature calculation. Only digits, upper and lower-case letters are allowed. Length limit: 6-32 characters. +* `sign_param` - (Required, String) Signature parameter name. Only upper and lower-case letters, digits, and underscores (_) are allowed. It cannot start with a digit. Length limit: 1-100 characters. +* `backup_secret_key` - (Optional, String) Used for calculate a signature. 6-32 characters. Only digits and letters are allowed. + +The `type_b` object supports the following: + +* `expire_time` - (Required, Int) Signature expiration time in second. The maximum value is 630720000. +* `file_extensions` - (Required, List) File extension list settings determining if authentication should be performed. NOTE: If it contains an asterisk (*), this indicates all files. +* `filter_type` - (Required, String) Available values: `whitelist` - all types apart from `file_extensions` are authenticated, `blacklist`: - only the types in the `file_extensions` are authenticated. +* `secret_key` - (Required, String) The key for signature calculation. Only digits, upper and lower-case letters are allowed. Length limit: 6-32 characters. +* `backup_secret_key` - (Optional, String) Used for calculate a signature. 6-32 characters. Only digits and letters are allowed. + +The `type_c` object supports the following: + +* `expire_time` - (Required, Int) Signature expiration time in second. The maximum value is 630720000. +* `file_extensions` - (Required, List) File extension list settings determining if authentication should be performed. NOTE: If it contains an asterisk (*), this indicates all files. +* `filter_type` - (Required, String) Available values: `whitelist` - all types apart from `file_extensions` are authenticated, `blacklist`: - only the types in the `file_extensions` are authenticated. +* `secret_key` - (Required, String) The key for signature calculation. Only digits, upper and lower-case letters are allowed. Length limit: 6-32 characters. +* `backup_secret_key` - (Optional, String) Used for calculate a signature. 6-32 characters. Only digits and letters are allowed. +* `time_format` - (Optional, String) Timestamp formation, available values: `dec`, `hex`. + +The `type_d` object supports the following: + +* `expire_time` - (Required, Int) Signature expiration time in second. The maximum value is 630720000. +* `file_extensions` - (Required, List) File extension list settings determining if authentication should be performed. NOTE: If it contains an asterisk (*), this indicates all files. +* `filter_type` - (Required, String) Available values: `whitelist` - all types apart from `file_extensions` are authenticated, `blacklist`: - only the types in the `file_extensions` are authenticated. +* `secret_key` - (Required, String) The key for signature calculation. Only digits, upper and lower-case letters are allowed. Length limit: 6-32 characters. +* `backup_secret_key` - (Optional, String) Used for calculate a signature. 6-32 characters. Only digits and letters are allowed. +* `time_format` - (Optional, String) Timestamp formation, available values: `dec`, `hex`. +* `time_param` - (Optional, String) Timestamp parameter name. Only upper and lower-case letters, digits, and underscores (_) are allowed. It cannot start with a digit. Length limit: 1-100 characters. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `cname` - CNAME address of domain name. +* `create_time` - Creation time of domain name. +* `dry_run_create_result` - Used for store `dry_run` request json. +* `dry_run_update_result` - Used for store `dry_run` update request json. +* `status` - Acceleration service status. + + +## Import + +CDN domain can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cdn_domain.foo xxxx.com +``` + diff --git a/config/docs/r/cdn_url_purge.html.markdown b/config/docs/r/cdn_url_purge.html.markdown new file mode 100644 index 0000000..7ad33d6 --- /dev/null +++ b/config/docs/r/cdn_url_purge.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Content Delivery Network(CDN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cdn_url_purge" +sidebar_current: "docs-tencentcloud-resource-cdn_url_purge" +description: |- + Provide a resource to invoke a Url Purge Request. +--- + +# tencentcloud_cdn_url_purge + +Provide a resource to invoke a Url Purge Request. + +## Example Usage + +```hcl +resource "tencentcloud_cdn_url_purge" "foo" { + urls = [ + "https://www.example.com/a" + ] +} +``` + +### argument to request new purge task with same urls + +```hcl +resource "tencentcloud_cdn_url_purge" "foo" { + urls = [ + "https://www.example.com/a" + ] + redo = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `urls` - (Required, List: [`String`], ForceNew) List of url to purge. NOTE: urls need include protocol prefix `http://` or `https://`. +* `area` - (Optional, String) Specify purge area. NOTE: only purge same area cache contents. +* `redo` - (Optional, Int) Change to purge again. NOTE: this argument only works while resource update, if set to `0` or null will not be triggered. +* `url_encode` - (Optional, Bool) Whether to encode urls, if set to `true` will auto encode instead of manual process. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `purge_history` - logs of latest purge task. + * `create_time` - Purge task create time. + * `flush_type` - Purge flush type of `flush` or `delete`. + * `purge_type` - Purge category in of `url` or `path`. + * `status` - Purge status of `fail`, `done`, `process`. + * `task_id` - Purge task id. + * `url` - Purge url. +* `task_id` - Task id of last operation. + + diff --git a/config/docs/r/cdn_url_push.html.markdown b/config/docs/r/cdn_url_push.html.markdown new file mode 100644 index 0000000..cc537c0 --- /dev/null +++ b/config/docs/r/cdn_url_push.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Content Delivery Network(CDN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cdn_url_push" +sidebar_current: "docs-tencentcloud-resource-cdn_url_push" +description: |- + Provide a resource to invoke a Url Push request. +--- + +# tencentcloud_cdn_url_push + +Provide a resource to invoke a Url Push request. + +## Example Usage + +```hcl +resource "tencentcloud_cdn_url_push" "foo" { + urls = ["https://www.example.com/b"] +} +``` + +### argument to request new push task with same urls + +```hcl +resource "tencentcloud_cdn_url_push" "foo" { + urls = [ + "https://www.example.com/a" + ] + redo = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `urls` - (Required, List: [`String`], ForceNew) List of url to push. NOTE: urls need include protocol prefix `http://` or `https://`. +* `area` - (Optional, String) Specify push area. NOTE: only push same area cache contents. +* `layer` - (Optional, String) Layer to push. +* `parse_m3u8` - (Optional, Bool) Whether to recursive parse m3u8 files. +* `redo` - (Optional, Int) Change to push again. NOTE: this argument only works while resource update, if set to `0` or null will not be triggered. +* `user_agent` - (Optional, String) Specify `User-Agent` HTTP header, default: `TencentCdn`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `push_history` - logs of latest push task. + * `area` - Push tag area in `mainland`, `overseas` or `global`. + * `create_time` - Push task create time. + * `percent` - Push progress in percent. + * `status` - Push status of `fail`, `done`, `process` or `invalid` (4xx, 5xx response). + * `task_id` - Push task id. + * `update_time` - Push task update time. + * `url` - Push url. +* `task_id` - Push task id. + + diff --git a/config/docs/r/cdwpg_instance.html.markdown b/config/docs/r/cdwpg_instance.html.markdown new file mode 100644 index 0000000..1111db7 --- /dev/null +++ b/config/docs/r/cdwpg_instance.html.markdown @@ -0,0 +1,106 @@ +--- +subcategory: "CDWPG" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cdwpg_instance" +sidebar_current: "docs-tencentcloud-resource-cdwpg_instance" +description: |- + Provides a resource to create a cdwpg instance +--- + +# tencentcloud_cdwpg_instance + +Provides a resource to create a cdwpg instance + +## Example Usage + +```hcl +resource "tencentcloud_cdwpg_instance" "instance" { + instance_name = "test_cdwpg" + zone = "ap-guangzhou-6" + user_vpc_id = "vpc-xxxxxx" + user_subnet_id = "subnet-xxxxxx" + charge_properties { + renew_flag = 0 + time_span = 1 + time_unit = "h" + charge_type = "POSTPAID_BY_HOUR" + + } + admin_password = "xxxxxx" + resources { + spec_name = "S_4_16_H_CN" + count = 2 + disk_spec { + disk_type = "CLOUD_HSSD" + disk_size = 200 + disk_count = 1 + } + type = "cn" + + } + resources { + spec_name = "S_4_16_H_CN" + count = 2 + disk_spec { + disk_type = "CLOUD_HSSD" + disk_size = 20 + disk_count = 10 + } + type = "dn" + + } + tags = { + "tagKey" = "tagValue" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `admin_password` - (Required, String) cluster password. +* `charge_properties` - (Required, List) instance billing mode. +* `instance_name` - (Required, String) instance name. +* `resources` - (Required, List) resource information. +* `user_subnet_id` - (Required, String) subnet. +* `user_vpc_id` - (Required, String) private network. +* `zone` - (Required, String) Availability Zone. +* `tags` - (Optional, Map) Tag description list. + +The `charge_properties` object supports the following: + +* `renew_flag` - (Required, Int) 0-no automatic renewal,1-automatic renewalNote: This field may return null, indicating that a valid value cannot be obtained. +* `time_span` - (Required, Int) Time RangeNote: This field may return null, indicating that a valid value cannot be obtained. +* `time_unit` - (Required, String) Time Unit,Generally h and mNote: This field may return null, indicating that a valid value cannot be obtained. +* `charge_type` - (Optional, String) Charge type, vaild values: PREPAID, POSTPAID_BY_HOUR. + +The `disk_spec` object supports the following: + +* `disk_count` - (Required, Int) disk count. +* `disk_size` - (Required, Int) disk size. +* `disk_type` - (Required, String) disk type. + +The `resources` object supports the following: + +* `count` - (Required, Int) resource count. +* `disk_spec` - (Required, List) disk Information. +* `spec_name` - (Required, String) resource name. +* `type` - (Required, String) resource type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cdwpg instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_cdwpg_instance.instance instance_id +``` + diff --git a/config/docs/r/cfs_access_group.html.markdown b/config/docs/r/cfs_access_group.html.markdown new file mode 100644 index 0000000..b498c0f --- /dev/null +++ b/config/docs/r/cfs_access_group.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_access_group" +sidebar_current: "docs-tencentcloud-resource-cfs_access_group" +description: |- + Provides a resource to create a CFS access group. +--- + +# tencentcloud_cfs_access_group + +Provides a resource to create a CFS access group. + +## Example Usage + +```hcl +resource "tencentcloud_cfs_access_group" "example" { + name = "tx_example" + description = "desc." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the access group, and max length is 64. +* `description` - (Optional, String) Description of the access group, and max length is 255. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the access group. + + +## Import + +CFS access group can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cfs_access_group.example pgroup-7nx89k7l +``` + diff --git a/config/docs/r/cfs_access_rule.html.markdown b/config/docs/r/cfs_access_rule.html.markdown new file mode 100644 index 0000000..080042b --- /dev/null +++ b/config/docs/r/cfs_access_rule.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_access_rule" +sidebar_current: "docs-tencentcloud-resource-cfs_access_rule" +description: |- + Provides a resource to create a CFS access rule. +--- + +# tencentcloud_cfs_access_rule + +Provides a resource to create a CFS access rule. + +## Example Usage + +```hcl +resource "tencentcloud_cfs_access_rule" "foo" { + access_group_id = "pgroup-7nx89k7l" + auth_client_ip = "10.10.1.0/24" + priority = 1 + rw_permission = "RO" + user_permission = "root_squash" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_group_id` - (Required, String, ForceNew) ID of a access group. +* `auth_client_ip` - (Required, String) A single IP or a single IP address range such as 10.1.10.11 or 10.10.1.0/24 indicates that all IPs are allowed. Please note that the IP entered should be CVM's private IP. +* `priority` - (Required, Int) The priority level of rule. Valid value ranges: (1~100). `1` indicates the highest priority. +* `rw_permission` - (Optional, String) Read and write permissions. Valid values are `RO` and `RW`. and default is `RO`. +* `user_permission` - (Optional, String) The permissions of accessing users. Valid values are `all_squash`, `no_all_squash`, `root_squash` and `no_root_squash`. and default is `root_squash`. `all_squash` indicates that all access users are mapped as anonymous users or user groups; `no_all_squash` indicates that access users will match local users first and be mapped to anonymous users or user groups after matching failed; `root_squash` indicates that map access root users to anonymous users or user groups; `no_root_squash` indicates that access root users keep root account permission. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cfs_auto_snapshot_policy.html.markdown b/config/docs/r/cfs_auto_snapshot_policy.html.markdown new file mode 100644 index 0000000..3713416 --- /dev/null +++ b/config/docs/r/cfs_auto_snapshot_policy.html.markdown @@ -0,0 +1,75 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_auto_snapshot_policy" +sidebar_current: "docs-tencentcloud-resource-cfs_auto_snapshot_policy" +description: |- + Provides a resource to create a cfs auto_snapshot_policy +--- + +# tencentcloud_cfs_auto_snapshot_policy + +Provides a resource to create a cfs auto_snapshot_policy + +## Example Usage + +### use day of week + +```hcl +resource "tencentcloud_cfs_auto_snapshot_policy" "auto_snapshot_policy" { + day_of_week = "1,2" + hour = "2,3" + policy_name = "policy_name" + alive_days = 7 +} +``` + +### use day of month + +```hcl +resource "tencentcloud_cfs_auto_snapshot_policy" "auto_snapshot_policy" { + hour = "2,3" + policy_name = "policy_name" + alive_days = 7 + day_of_month = "2,3,4" +} +``` + +### use interval days + +```hcl +resource "tencentcloud_cfs_auto_snapshot_policy" "auto_snapshot_policy" { + hour = "2,3" + policy_name = "policy_name" + alive_days = 7 + interval_days = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `hour` - (Required, String) The time point when to repeat the snapshot operation. +* `alive_days` - (Optional, Int) Snapshot retention period. +* `day_of_month` - (Optional, String) The specific day (day 1 to day 31) of the month on which to create a snapshot. +* `day_of_week` - (Optional, String) The day of the week on which to repeat the snapshot operation. +* `interval_days` - (Optional, Int) The snapshot interval, in days. +* `policy_name` - (Optional, String) Policy name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cfs auto_snapshot_policy can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfs_auto_snapshot_policy.auto_snapshot_policy auto_snapshot_policy_id +``` + diff --git a/config/docs/r/cfs_auto_snapshot_policy_attachment.html.markdown b/config/docs/r/cfs_auto_snapshot_policy_attachment.html.markdown new file mode 100644 index 0000000..9342285 --- /dev/null +++ b/config/docs/r/cfs_auto_snapshot_policy_attachment.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_auto_snapshot_policy_attachment" +sidebar_current: "docs-tencentcloud-resource-cfs_auto_snapshot_policy_attachment" +description: |- + Provides a resource to create a cfs auto_snapshot_policy_attachment +--- + +# tencentcloud_cfs_auto_snapshot_policy_attachment + +Provides a resource to create a cfs auto_snapshot_policy_attachment + +## Example Usage + +```hcl +resource "tencentcloud_cfs_auto_snapshot_policy_attachment" "auto_snapshot_policy_attachment" { + auto_snapshot_policy_id = "asp-basic" + file_system_ids = "cfs-4xzkct19,cfs-iobiaxtj" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_snapshot_policy_id` - (Required, String, ForceNew) ID of the snapshot to be unbound. +* `file_system_ids` - (Required, String, ForceNew) List of IDs of the file systems to be unbound, separated by comma. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cfs auto_snapshot_policy_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfs_auto_snapshot_policy_attachment.auto_snapshot_policy_attachment auto_snapshot_policy_id#file_system_ids +``` + diff --git a/config/docs/r/cfs_file_system.html.markdown b/config/docs/r/cfs_file_system.html.markdown new file mode 100644 index 0000000..929a321 --- /dev/null +++ b/config/docs/r/cfs_file_system.html.markdown @@ -0,0 +1,109 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_file_system" +sidebar_current: "docs-tencentcloud-resource-cfs_file_system" +description: |- + Provides a resource to create a cloud file system(CFS). +--- + +# tencentcloud_cfs_file_system + +Provides a resource to create a cloud file system(CFS). + +## Example Usage + +### Standard Nfs CFS + +```hcl +resource "tencentcloud_cfs_file_system" "foo" { + name = "test_file_system" + availability_zone = "ap-guangzhou-3" + access_group_id = "pgroup-7nx89k7l" + protocol = "NFS" + vpc_id = "vpc-ah9fbkap" + subnet_id = "subnet-9mu2t9iw" +} +``` + +### High-Performance Nfs CFS + +```hcl +resource "tencentcloud_cfs_file_system" "foo" { + name = "test_file_system" + availability_zone = "ap-guangzhou-6" + access_group_id = "pgroup-drwt29od" + protocol = "NFS" + storage_type = "HP" + vpc_id = "vpc-86v957zb" + subnet_id = "subnet-enm92y0m" +} +``` + +### Standard Turbo CFS + +```hcl +resource "tencentcloud_cfs_file_system" "foo" { + name = "test_file_system" + net_interface = "CCN" + availability_zone = "ap-guangzhou-6" + access_group_id = "pgroup-drwt29od" + protocol = "TURBO" + storage_type = "TB" + capacity = 20480 + ccn_id = "ccn-39lqkygf" + cidr_block = "11.0.0.0/24" +} +``` + +### High-Performance Turbo CFS + +```hcl +resource "tencentcloud_cfs_file_system" "foo" { + name = "test_file_system" + net_interface = "CCN" + availability_zone = "ap-guangzhou-6" + access_group_id = "pgroup-drwt29od" + protocol = "TURBO" + storage_type = "TP" + capacity = 10240 + ccn_id = "ccn-39lqkygf" + cidr_block = "11.0.0.0/24" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_group_id` - (Required, String) ID of a access group. +* `availability_zone` - (Required, String, ForceNew) The available zone that the file system locates at. +* `capacity` - (Optional, Int) File system capacity, in GiB (required for the Turbo series). For Standard Turbo, the minimum purchase required is 40,960 GiB (40 TiB) and the expansion increment is 20,480 GiB (20 TiB). For High-Performance Turbo, the minimum purchase required is 20,480 GiB (20 TiB) and the expansion increment is 10,240 GiB (10 TiB). +* `ccn_id` - (Optional, String) CCN instance ID (required if the network type is CCN). +* `cidr_block` - (Optional, String) CCN IP range used by the CFS (required if the network type is CCN), which cannot conflict with other IP ranges bound in CCN. +* `mount_ip` - (Optional, String, ForceNew) IP of mount point. +* `name` - (Optional, String) Name of a file system. +* `net_interface` - (Optional, String) Network type, Default `VPC`. Valid values: `VPC` and `CCN`. Select `VPC` for a Standard or High-Performance file system, and `CCN` for a Standard Turbo or High-Performance Turbo one. +* `protocol` - (Optional, String, ForceNew) File system protocol. Valid values: `NFS`, `CIFS`, `TURBO`. If this parameter is left empty, `NFS` is used by default. For the Turbo series, you must set this parameter to `TURBO`. +* `storage_type` - (Optional, String, ForceNew) Storage type of the file system. Valid values: `SD` (Standard), `HP` (High-Performance), `TB` (Standard Turbo), and `TP` (High-Performance Turbo). Default value: `SD`. +* `subnet_id` - (Optional, String, ForceNew) ID of a subnet. +* `tags` - (Optional, Map) Instance tags. +* `vpc_id` - (Optional, String, ForceNew) ID of a VPC network. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the file system. +* `fs_id` - Mount root-directory. + + +## Import + +Cloud file system can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cfs_file_system.foo cfs-6hgquxmj +``` + diff --git a/config/docs/r/cfs_sign_up_cfs_service.html.markdown b/config/docs/r/cfs_sign_up_cfs_service.html.markdown new file mode 100644 index 0000000..ca1a7fa --- /dev/null +++ b/config/docs/r/cfs_sign_up_cfs_service.html.markdown @@ -0,0 +1,33 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_sign_up_cfs_service" +sidebar_current: "docs-tencentcloud-resource-cfs_sign_up_cfs_service" +description: |- + Provides a resource to create a cfs sign_up_cfs_service +--- + +# tencentcloud_cfs_sign_up_cfs_service + +Provides a resource to create a cfs sign_up_cfs_service + +## Example Usage + +```hcl +resource "tencentcloud_cfs_sign_up_cfs_service" "sign_up_cfs_service" {} +``` + +## Argument Reference + +The following arguments are supported: + + + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `cfs_service_status` - Current status of the CFS service for this user. Valid values: creating (activating); created (activated). + + diff --git a/config/docs/r/cfs_snapshot.html.markdown b/config/docs/r/cfs_snapshot.html.markdown new file mode 100644 index 0000000..d8e6851 --- /dev/null +++ b/config/docs/r/cfs_snapshot.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_snapshot" +sidebar_current: "docs-tencentcloud-resource-cfs_snapshot" +description: |- + Provides a resource to create a cfs snapshot +--- + +# tencentcloud_cfs_snapshot + +Provides a resource to create a cfs snapshot + +## Example Usage + +```hcl +resource "tencentcloud_cfs_snapshot" "snapshot" { + file_system_id = "cfs-iobiaxtj" + snapshot_name = "test" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `file_system_id` - (Required, String, ForceNew) Id of file system. +* `snapshot_name` - (Optional, String) Name of snapshot. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cfs snapshot can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfs_snapshot.snapshot snapshot_id +``` + diff --git a/config/docs/r/cfs_user_quota.html.markdown b/config/docs/r/cfs_user_quota.html.markdown new file mode 100644 index 0000000..c2a7d53 --- /dev/null +++ b/config/docs/r/cfs_user_quota.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud File Storage(CFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfs_user_quota" +sidebar_current: "docs-tencentcloud-resource-cfs_user_quota" +description: |- + Provides a resource to create a cfs user_quota +--- + +# tencentcloud_cfs_user_quota + +Provides a resource to create a cfs user_quota + +## Example Usage + +```hcl +resource "tencentcloud_cfs_user_quota" "user_quota" { + file_system_id = "cfs-4636029bc" + user_type = "Uid" + user_id = "2159973417" + capacity_hard_limit = 10 + file_hard_limit = 10000 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `file_system_id` - (Required, String) File system ID. +* `user_id` - (Required, String) Info of UID/GID. +* `user_type` - (Required, String) Quota type. Valid value: `Uid`, `Gid`. +* `capacity_hard_limit` - (Optional, Int) Capacity Limit(GB). +* `file_hard_limit` - (Optional, Int) File limit. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cfs user_quota can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfs_user_quota.user_quota user_quota_id +``` + diff --git a/config/docs/r/cfw_address_template.html.markdown b/config/docs/r/cfw_address_template.html.markdown new file mode 100644 index 0000000..faf0d69 --- /dev/null +++ b/config/docs/r/cfw_address_template.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_address_template" +sidebar_current: "docs-tencentcloud-resource-cfw_address_template" +description: |- + Provides a resource to create a cfw address_template +--- + +# tencentcloud_cfw_address_template + +Provides a resource to create a cfw address_template + +## Example Usage + +### If type is 1 + +```hcl +resource "tencentcloud_cfw_address_template" "example" { + name = "tf_example" + detail = "test template" + ip_string = "1.1.1.1,2.2.2.2" + type = 1 +} +``` + +### If type is 5 + +```hcl +resource "tencentcloud_cfw_address_template" "example" { + name = "tf_example" + detail = "test template" + ip_string = "www.qq.com,www.tencent.com" + type = 5 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `detail` - (Required, String) Template Detail. +* `ip_string` - (Required, String) Type is 1, ip template eg: 1.1.1.1,2.2.2.2; Type is 5, domain name template eg: www.qq.com, www.tencent.com. +* `name` - (Required, String) Template name. +* `type` - (Required, Int) 1: ip template; 5: domain name templates. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cfw address_template can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfw_address_template.example mb_1300846651_1695611353900 +``` + diff --git a/config/docs/r/cfw_block_ignore.html.markdown b/config/docs/r/cfw_block_ignore.html.markdown new file mode 100644 index 0000000..0dd2236 --- /dev/null +++ b/config/docs/r/cfw_block_ignore.html.markdown @@ -0,0 +1,79 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_block_ignore" +sidebar_current: "docs-tencentcloud-resource-cfw_block_ignore" +description: |- + Provides a resource to create a cfw block_ignore +--- + +# tencentcloud_cfw_block_ignore + +Provides a resource to create a cfw block_ignore + +~> **NOTE:** If create domain rule, `RuleType` not support set 2. + +## Example Usage + +### If create ip rule + +```hcl +resource "tencentcloud_cfw_block_ignore" "example" { + ip = "1.1.1.1" + direction = 0 + comment = "remark." + start_time = "2023-09-01 00:00:00" + end_time = "2023-10-01 00:00:00" + rule_type = 1 +} +``` + +### If create domain rule + +```hcl +resource "tencentcloud_cfw_block_ignore" "example" { + domain = "domain.com" + direction = 1 + comment = "remark." + start_time = "2023-09-01 00:00:00" + end_time = "2023-10-01 00:00:00" + rule_type = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `direction` - (Required, String) Rule direction, 0 outbound, 1 inbound, 3 intranet. +* `end_time` - (Required, String) Rule end time, format: 2006-01-02 15:04:05, must be greater than the current time. +* `rule_type` - (Required, Int) Rule type, 1 block, 2 ignore, domain block is not supported. +* `comment` - (Optional, String) Remarks information, length cannot exceed 50. +* `domain` - (Optional, String) Rule domain name, one of IP and Domain is required. +* `ip` - (Optional, String) Rule IP address, one of IP and Domain is required. +* `start_time` - (Optional, String) Rule start time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cfw block_ignore_list can be imported using the id, e.g. + +If import ip rule + +``` +terraform import tencentcloud_cfw_block_ignore.example 1.1.1.1##0#1 +``` + +If import domain rule + +``` +terraform import tencentcloud_cfw_block_ignore.example domain.com##0#1 +``` + diff --git a/config/docs/r/cfw_edge_firewall_switch.html.markdown b/config/docs/r/cfw_edge_firewall_switch.html.markdown new file mode 100644 index 0000000..3bccd3e --- /dev/null +++ b/config/docs/r/cfw_edge_firewall_switch.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_edge_firewall_switch" +sidebar_current: "docs-tencentcloud-resource-cfw_edge_firewall_switch" +description: |- + Provides a resource to create a cfw edge_firewall_switch +--- + +# tencentcloud_cfw_edge_firewall_switch + +Provides a resource to create a cfw edge_firewall_switch + +## Example Usage + +### If not set subnet_id + +```hcl +data "tencentcloud_cfw_edge_fw_switches" "example" {} + +resource "tencentcloud_cfw_edge_firewall_switch" "example" { + public_ip = data.tencentcloud_cfw_edge_fw_switches.example.data[0].public_ip + switch_mode = 1 + enable = 0 +} +``` + +### If set subnet id + +```hcl +data "tencentcloud_cfw_edge_fw_switches" "example" {} + +resource "tencentcloud_cfw_edge_firewall_switch" "example" { + public_ip = data.tencentcloud_cfw_edge_fw_switches.example.data[0].public_ip + subnet_id = "subnet-id" + switch_mode = 1 + enable = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `enable` - (Required, Int) Switch, 0: off, 1: on. +* `public_ip` - (Required, String, ForceNew) Public Ip. +* `switch_mode` - (Required, Int) 0: bypass; 1: serial. +* `subnet_id` - (Optional, String) The first EIP switch in the vpc is turned on, and you need to specify a subnet to create a private connection. If `switch_mode` is 1 and `enable` is 1, this field is required. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cfw_edge_policy.html.markdown b/config/docs/r/cfw_edge_policy.html.markdown new file mode 100644 index 0000000..8824de6 --- /dev/null +++ b/config/docs/r/cfw_edge_policy.html.markdown @@ -0,0 +1,81 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_edge_policy" +sidebar_current: "docs-tencentcloud-resource-cfw_edge_policy" +description: |- + Provides a resource to create a cfw edge_policy +--- + +# tencentcloud_cfw_edge_policy + +Provides a resource to create a cfw edge_policy + +## Example Usage + +```hcl +resource "tencentcloud_cfw_edge_policy" "example" { + source_content = "1.1.1.1/0" + source_type = "net" + target_content = "0.0.0.0/0" + target_type = "net" + protocol = "TCP" + rule_action = "drop" + port = "-1/-1" + direction = 1 + enable = "true" + description = "policy description." + scope = "all" +} +``` + +### If target_type is tag + +```hcl +resource "tencentcloud_cfw_edge_policy" "example" { + source_content = "0.0.0.0/0" + source_type = "net" + target_content = jsonencode({ "Key" : "test", "Value" : "dddd" }) + target_type = "tag" + protocol = "TCP" + rule_action = "drop" + port = "-1/-1" + direction = 1 + enable = "true" + description = "policy description." + scope = "all" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `direction` - (Required, Int) Rule direction: 1, inbound; 0, outbound. +* `port` - (Required, String) The port for the access control policy. Value: -1/-1: All ports 80: Port 80. +* `protocol` - (Required, String) Protocol. If Direction=1 && Scope=serial, optional values: TCP UDP ICMP ANY HTTP HTTPS HTTP/HTTPS SMTP SMTPS SMTP/SMTPS FTP DNS; If Direction=1 && Scope!=serial, optional values: TCP; If Direction=0 && Scope=serial, optional values: TCP UDP ICMP ANY HTTP HTTPS HTTP/HTTPS SMTP SMTPS SMTP/SMTPS FTP DNS; If Direction=0 && Scope!=serial, optional values: TCP HTTP/HTTPS TLS/SSL. +* `rule_action` - (Required, String) How the traffic set in the access control policy passes through the cloud firewall. Values: accept: allow; drop: reject; log: observe. +* `source_content` - (Required, String) Access source example: net:IP/CIDR(192.168.0.2). +* `source_type` - (Required, String) Access source type: for inbound rules, the type can be net, location, vendor, template; for outbound rules, it can be net, instance, tag, template, group. +* `target_content` - (Required, String) Example of access purpose: net: IP/CIDR(192.168.0.2) domain: domain name rules, such as *.qq.com. +* `target_type` - (Required, String) Access purpose type: For inbound rules, the type can be net, instance, tag, template, group; for outbound rules, it can be net, location, vendor, template. +* `description` - (Optional, String) Description. +* `enable` - (Optional, String) Rule status, true means enabled, false means disabled. Default is true. +* `scope` - (Optional, String) Effective range. serial: serial; side: bypass; all: global, Default is all. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `uuid` - The unique id corresponding to the rule, no need to fill in when creating the rule. + + +## Import + +cfw edge_policy can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfw_edge_policy.example edge_policy_id +``` + diff --git a/config/docs/r/cfw_nat_firewall_switch.html.markdown b/config/docs/r/cfw_nat_firewall_switch.html.markdown new file mode 100644 index 0000000..ca25330 --- /dev/null +++ b/config/docs/r/cfw_nat_firewall_switch.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_nat_firewall_switch" +sidebar_current: "docs-tencentcloud-resource-cfw_nat_firewall_switch" +description: |- + Provides a resource to create a cfw nat_firewall_switch +--- + +# tencentcloud_cfw_nat_firewall_switch + +Provides a resource to create a cfw nat_firewall_switch + +## Example Usage + +### Turn off switch + +```hcl +data "tencentcloud_cfw_nat_fw_switches" "example" { + nat_ins_id = "cfwnat-18d2ba18" +} + +resource "tencentcloud_cfw_nat_firewall_switch" "example" { + nat_ins_id = data.tencentcloud_cfw_nat_fw_switches.example.id + subnet_id = data.tencentcloud_cfw_nat_fw_switches.example.data[0].subnet_id + enable = 0 +} +``` + +### Or turn on switch + +```hcl +data "tencentcloud_cfw_nat_fw_switches" "example" { + nat_ins_id = "cfwnat-18d2ba18" +} + +resource "tencentcloud_cfw_nat_firewall_switch" "example" { + nat_ins_id = data.tencentcloud_cfw_nat_fw_switches.example.id + subnet_id = data.tencentcloud_cfw_nat_fw_switches.example.data[0].subnet_id + enable = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `enable` - (Required, Int) Switch, 0: off, 1: on. +* `nat_ins_id` - (Required, String, ForceNew) Firewall instance id. +* `subnet_id` - (Required, String, ForceNew) subnet id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cfw nat_firewall_switch can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfw_nat_firewall_switch.example cfwnat-18d2ba18#subnet-ef7wyymr +``` + diff --git a/config/docs/r/cfw_nat_instance.html.markdown b/config/docs/r/cfw_nat_instance.html.markdown new file mode 100644 index 0000000..e5221fb --- /dev/null +++ b/config/docs/r/cfw_nat_instance.html.markdown @@ -0,0 +1,89 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_nat_instance" +sidebar_current: "docs-tencentcloud-resource-cfw_nat_instance" +description: |- + Provides a resource to create a cfw nat_instance +--- + +# tencentcloud_cfw_nat_instance + +Provides a resource to create a cfw nat_instance + +## Example Usage + +### If mode is 0 + +```hcl +resource "tencentcloud_cfw_nat_instance" "example" { + name = "tf_example" + width = 20 + mode = 0 + new_mode_items { + vpc_list = [ + "vpc-5063ta4i" + ] + eips = [ + "152.136.168.192" + ] + } + cross_a_zone = 0 + zone_set = [ + "ap-guangzhou-7" + ] +} +``` + +### If mode is 1 + +```hcl +resource "tencentcloud_cfw_nat_instance" "example" { + name = "tf_example" + width = 20 + mode = 1 + nat_gw_list = [ + "nat-9wwkz1kr" + ] + cross_a_zone = 1 + cross_a_zone = 0 + zone_set = [ + "ap-guangzhou-6", + "ap-guangzhou-7" + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `mode` - (Required, Int) Mode 1: access mode; 0: new mode. +* `name` - (Required, String) Firewall instance name. +* `width` - (Required, Int) Bandwidth. +* `zone_set` - (Required, Set: [`String`]) Zone list. +* `cross_a_zone` - (Optional, Int) Off-site disaster recovery 1: use off-site disaster recovery; 0: do not use off-site disaster recovery; if empty, the default is not to use off-site disaster recovery. +* `nat_gw_list` - (Optional, Set: [`String`]) A list of nat gateways connected to the access mode, at least one of NewModeItems and NatgwList is passed. +* `new_mode_items` - (Optional, List) New mode passing parameters are added, at least one of new_mode_items and nat_gw_list is passed. + +The `new_mode_items` object supports the following: + +* `eips` - (Required, Set) List of egress elastic public network IPs bound in the new mode. +* `vpc_list` - (Required, Set) List of vpcs connected in new mode. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cfw nat_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfw_nat_instance.example cfwnat-54a21421 +``` + diff --git a/config/docs/r/cfw_nat_policy.html.markdown b/config/docs/r/cfw_nat_policy.html.markdown new file mode 100644 index 0000000..651bc0d --- /dev/null +++ b/config/docs/r/cfw_nat_policy.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_nat_policy" +sidebar_current: "docs-tencentcloud-resource-cfw_nat_policy" +description: |- + Provides a resource to create a cfw nat_policy +--- + +# tencentcloud_cfw_nat_policy + +Provides a resource to create a cfw nat_policy + +## Example Usage + +```hcl +resource "tencentcloud_cfw_nat_policy" "example" { + source_content = "1.1.1.1/0" + source_type = "net" + target_content = "0.0.0.0/0" + target_type = "net" + protocol = "TCP" + rule_action = "drop" + port = "-1/-1" + direction = 1 + enable = "true" + description = "policy description." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `direction` - (Required, Int) Rule direction: 1, inbound; 0, outbound. +* `port` - (Required, String) The port for the access control policy. Value: -1/-1: All ports 80: Port 80. +* `protocol` - (Required, String) Protocol. If Direction=1, optional values: TCP, UDP, ANY; If Direction=0, optional values: TCP, UDP, ICMP, ANY, HTTP, HTTPS, HTTP/HTTPS, SMTP, SMTPS, SMTP/SMTPS, FTP, and DNS. +* `rule_action` - (Required, String) How the traffic set in the access control policy passes through the cloud firewall. Values: accept: allow; drop: reject; log: observe. +* `source_content` - (Required, String) Access source example: net:IP/CIDR(192.168.0.2). +* `source_type` - (Required, String) Access source type: for inbound rules, the type can be net, location, vendor, template; for outbound rules, it can be net, instance, tag, template, group. +* `target_content` - (Required, String) Example of access purpose: net: IP/CIDR(192.168.0.2) domain: domain name rules, such as *.qq.com. +* `target_type` - (Required, String) Access purpose type: For inbound rules, the type can be net, instance, tag, template, group; for outbound rules, it can be net, location, vendor, template. +* `description` - (Optional, String) Description. +* `enable` - (Optional, String) Rule status, true means enabled, false means disabled. Default is true. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `uuid` - The unique id corresponding to the rule, no need to fill in when creating the rule. + + +## Import + +cfw nat_policy can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfw_nat_policy.example nat_policy_id +``` + diff --git a/config/docs/r/cfw_sync_asset.html.markdown b/config/docs/r/cfw_sync_asset.html.markdown new file mode 100644 index 0000000..b3b75dc --- /dev/null +++ b/config/docs/r/cfw_sync_asset.html.markdown @@ -0,0 +1,33 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_sync_asset" +sidebar_current: "docs-tencentcloud-resource-cfw_sync_asset" +description: |- + Provides a resource to create a cfw sync_asset +--- + +# tencentcloud_cfw_sync_asset + +Provides a resource to create a cfw sync_asset + +## Example Usage + +```hcl +resource "tencentcloud_cfw_sync_asset" "example" {} +``` + +## Argument Reference + +The following arguments are supported: + + + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cfw_sync_route.html.markdown b/config/docs/r/cfw_sync_route.html.markdown new file mode 100644 index 0000000..92d0c44 --- /dev/null +++ b/config/docs/r/cfw_sync_route.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_sync_route" +sidebar_current: "docs-tencentcloud-resource-cfw_sync_route" +description: |- + Provides a resource to create a cfw sync_route +--- + +# tencentcloud_cfw_sync_route + +Provides a resource to create a cfw sync_route + +## Example Usage + +```hcl +resource "tencentcloud_cfw_sync_route" "example" { + sync_type = "Route" + fw_type = "nat" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `sync_type` - (Required, String, ForceNew) Synchronization operation type: Route, synchronize firewall routing. +* `fw_type` - (Optional, String, ForceNew) Firewall type; nat: nat firewall; ew: inter-vpc firewall. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cfw_vpc_firewall_switch.html.markdown b/config/docs/r/cfw_vpc_firewall_switch.html.markdown new file mode 100644 index 0000000..c8a9bfa --- /dev/null +++ b/config/docs/r/cfw_vpc_firewall_switch.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_vpc_firewall_switch" +sidebar_current: "docs-tencentcloud-resource-cfw_vpc_firewall_switch" +description: |- + Provides a resource to create a cfw vpc_firewall_switch +--- + +# tencentcloud_cfw_vpc_firewall_switch + +Provides a resource to create a cfw vpc_firewall_switch + +## Example Usage + +### Turn off switch + +```hcl +data "tencentcloud_cfw_vpc_fw_switches" "example" { + vpc_ins_id = "cfwg-c8c2de41" +} + +resource "tencentcloud_cfw_vpc_firewall_switch" "example" { + vpc_ins_id = data.tencentcloud_cfw_vpc_fw_switches.example.id + switch_id = data.tencentcloud_cfw_vpc_fw_switches.example.switch_list[0].switch_id + enable = 0 +} +``` + +### Or turn on switch + +```hcl +data "tencentcloud_cfw_vpc_fw_switches" "example" { + vpc_ins_id = "cfwg-c8c2de41" +} + +resource "tencentcloud_cfw_vpc_firewall_switch" "example" { + vpc_ins_id = data.tencentcloud_cfw_vpc_fw_switches.example.id + switch_id = data.tencentcloud_cfw_vpc_fw_switches.example.switch_list[0].switch_id + enable = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `enable` - (Required, Int) Turn the switch on or off. 0: turn off the switch; 1: Turn on the switch. +* `switch_id` - (Required, String, ForceNew) Firewall switch ID. +* `vpc_ins_id` - (Required, String, ForceNew) Firewall instance id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cfw vpc_firewall_switch can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfw_vpc_firewall_switch.example cfwg-c8c2de41#cfws-f2c63ded84 +``` + diff --git a/config/docs/r/cfw_vpc_instance.html.markdown b/config/docs/r/cfw_vpc_instance.html.markdown new file mode 100644 index 0000000..992ed42 --- /dev/null +++ b/config/docs/r/cfw_vpc_instance.html.markdown @@ -0,0 +1,109 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_vpc_instance" +sidebar_current: "docs-tencentcloud-resource-cfw_vpc_instance" +description: |- + Provides a resource to create a cfw vpc_instance +--- + +# tencentcloud_cfw_vpc_instance + +Provides a resource to create a cfw vpc_instance + +## Example Usage + +### If mode is 0 + +```hcl +resource "tencentcloud_cfw_vpc_instance" "example" { + name = "tf_example" + mode = 0 + + vpc_fw_instances { + name = "fw_ins_example" + vpc_ids = [ + "vpc-291vnoeu", + "vpc-39ixq9ci" + ] + fw_deploy { + deploy_region = "ap-guangzhou" + width = 1024 + cross_a_zone = 1 + zone_set = [ + "ap-guangzhou-6", + "ap-guangzhou-7" + ] + } + } + + switch_mode = 1 + fw_vpc_cidr = "auto" +} +``` + +### If mode is 1 + +```hcl +resource "tencentcloud_cfw_vpc_instance" "example" { + name = "tf_example" + mode = 1 + + vpc_fw_instances { + name = "fw_ins_example" + fw_deploy { + deploy_region = "ap-guangzhou" + width = 1024 + cross_a_zone = 0 + zone_set = [ + "ap-guangzhou-6" + ] + } + } + + ccn_id = "ccn-peihfqo7" + switch_mode = 1 + fw_vpc_cidr = "auto" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `mode` - (Required, Int) Mode 0: private network mode; 1: CCN cloud networking mode. +* `name` - (Required, String) VPC firewall (group) name. +* `switch_mode` - (Required, Int) Switch mode of firewall instance. 1: Single point intercommunication; 2: Multi-point communication; 4: Custom Routing. +* `vpc_fw_instances` - (Required, List) List of firewall instances under firewall (group). +* `ccn_id` - (Optional, String) Cloud networking id, suitable for cloud networking mode. +* `fw_vpc_cidr` - (Optional, String) auto Automatically select the firewall network segment; 10.10.10.0/24 The firewall network segment entered by the user. + +The `fw_deploy` object supports the following: + +* `deploy_region` - (Required, String) Firewall Deployment Region. +* `width` - (Required, Int) Bandwidth, unit: Mbps. +* `zone_set` - (Required, Set) Zone list. +* `cross_a_zone` - (Optional, Int) Off-site disaster recovery 1: use off-site disaster recovery; 0: do not use off-site disaster recovery; if it is empty, off-site disaster recovery will not be used by default. + +The `vpc_fw_instances` object supports the following: + +* `fw_deploy` - (Required, List) Deploy regional information. +* `name` - (Required, String) Firewall instance name. +* `vpc_ids` - (Optional, Set) List of VpcIds accessed in private network mode; only used in private network mode. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cfw vpc_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfw_vpc_instance.example cfwg-4ee69507 +``` + diff --git a/config/docs/r/cfw_vpc_policy.html.markdown b/config/docs/r/cfw_vpc_policy.html.markdown new file mode 100644 index 0000000..a066b97 --- /dev/null +++ b/config/docs/r/cfw_vpc_policy.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Cloud Firewall(CFW)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cfw_vpc_policy" +sidebar_current: "docs-tencentcloud-resource-cfw_vpc_policy" +description: |- + Provides a resource to create a cfw vpc_policy +--- + +# tencentcloud_cfw_vpc_policy + +Provides a resource to create a cfw vpc_policy + +## Example Usage + +```hcl +resource "tencentcloud_cfw_vpc_policy" "example" { + source_content = "0.0.0.0/0" + source_type = "net" + dest_content = "192.168.0.2" + dest_type = "net" + protocol = "ANY" + rule_action = "log" + port = "-1/-1" + description = "description." + enable = "true" + fw_group_id = "ALL" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `description` - (Required, String) Describe. +* `dest_content` - (Required, String) Access purpose example: net:IP/CIDR(192.168.0.2) domain:domain rule, for example*.qq.com. +* `dest_type` - (Required, String) Access purpose type, the type can be: net, template. +* `port` - (Required, String) The port for the access control policy. Value: -1/-1: All ports; 80: port 80. +* `protocol` - (Required, String) Protocol, optional value:TCP, UDP, ICMP, ANY, HTTP, HTTPS, HTTP/HTTPS, SMTP, SMTPS, SMTP/SMTPS, FTP, DNS, TLS/SSL. +* `rule_action` - (Required, String) How traffic set in the access control policy passes through the cloud firewall. Value: accept:accept, drop:drop, log:log. +* `source_content` - (Required, String) Access source examplnet:IP/CIDR(192.168.0.2). +* `source_type` - (Required, String) Access source type, the type can be: net, template. +* `enable` - (Optional, String) Rule status, true means enabled, false means disabled. Default is true. +* `fw_group_id` - (Optional, String) Firewall instance ID where the rule takes effect. Default is ALL. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `fw_group_name` - Firewall name. +* `internal_uuid` - Uuid used internally, this field is generally not used. +* `uuid` - The unique id corresponding to the rule. + + +## Import + +cfw vpc_policy can be imported using the id, e.g. + +``` +terraform import tencentcloud_cfw_vpc_policy.vpc_policy vpc_policy_id +``` + diff --git a/config/docs/r/chdfs_access_group.html.markdown b/config/docs/r/chdfs_access_group.html.markdown new file mode 100644 index 0000000..c405271 --- /dev/null +++ b/config/docs/r/chdfs_access_group.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud HDFS(CHDFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_chdfs_access_group" +sidebar_current: "docs-tencentcloud-resource-chdfs_access_group" +description: |- + Provides a resource to create a chdfs access_group +--- + +# tencentcloud_chdfs_access_group + +Provides a resource to create a chdfs access_group + +## Example Usage + +```hcl +resource "tencentcloud_chdfs_access_group" "access_group" { + access_group_name = "testAccessGroup" + vpc_type = 1 + vpc_id = "vpc-4owdpnwr" + description = "test access group" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_group_name` - (Required, String) Permission group name. +* `vpc_id` - (Required, String) VPC ID. +* `vpc_type` - (Required, Int) vpc network type(1:CVM, 2:BM 1.0). +* `description` - (Optional, String) Permission group description, default empty. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +chdfs access_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_chdfs_access_group.access_group access_group_id +``` + diff --git a/config/docs/r/chdfs_access_rule.html.markdown b/config/docs/r/chdfs_access_rule.html.markdown new file mode 100644 index 0000000..e90c6da --- /dev/null +++ b/config/docs/r/chdfs_access_rule.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "Cloud HDFS(CHDFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_chdfs_access_rule" +sidebar_current: "docs-tencentcloud-resource-chdfs_access_rule" +description: |- + Provides a resource to create a chdfs access_rule +--- + +# tencentcloud_chdfs_access_rule + +Provides a resource to create a chdfs access_rule + +## Example Usage + +```hcl +resource "tencentcloud_chdfs_access_rule" "access_rule" { + access_group_id = "ag-bvmzrbsm" + + access_rule { + access_mode = 2 + address = "10.0.1.1" + priority = 12 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_group_id` - (Required, String, ForceNew) access group id. +* `access_rule` - (Required, List) rule detail. + +The `access_rule` object supports the following: + +* `access_mode` - (Optional, Int) rule access mode, 1: read only, 2: read & wirte. +* `address` - (Optional, String) rule address, IP OR IP SEG. +* `priority` - (Optional, Int) rule priority, range 1 - 100, value less higher priority. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +chdfs access_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_chdfs_access_rule.access_rule access_group_id#access_rule_id +``` + diff --git a/config/docs/r/chdfs_file_system.html.markdown b/config/docs/r/chdfs_file_system.html.markdown new file mode 100644 index 0000000..170f030 --- /dev/null +++ b/config/docs/r/chdfs_file_system.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Cloud HDFS(CHDFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_chdfs_file_system" +sidebar_current: "docs-tencentcloud-resource-chdfs_file_system" +description: |- + Provides a resource to create a chdfs file_system +--- + +# tencentcloud_chdfs_file_system + +Provides a resource to create a chdfs file_system + +## Example Usage + +```hcl +resource "tencentcloud_chdfs_file_system" "file_system" { + capacity_quota = 10995116277760 + description = "file system for terraform test" + enable_ranger = true + file_system_name = "terraform-test" + posix_acl = false + ranger_service_addresses = [ + "127.0.0.1:80", + "127.0.0.1:8000", + ] + super_users = [ + "terraform", + "iac", + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `capacity_quota` - (Required, Int) file system capacity. min 1GB, max 1PB, CapacityQuota is N * 1073741824. +* `file_system_name` - (Required, String) file system name. +* `posix_acl` - (Required, Bool) check POSIX ACL or not. +* `description` - (Optional, String) desc of the file system. +* `enable_ranger` - (Optional, Bool) check the ranger address or not. +* `ranger_service_addresses` - (Optional, Set: [`String`]) ranger address list, default empty. +* `super_users` - (Optional, Set: [`String`]) super users of the file system, default empty. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +chdfs file_system can be imported using the id, e.g. + +``` +terraform import tencentcloud_chdfs_file_system.file_system file_system_id +``` + diff --git a/config/docs/r/chdfs_life_cycle_rule.html.markdown b/config/docs/r/chdfs_life_cycle_rule.html.markdown new file mode 100644 index 0000000..95b0100 --- /dev/null +++ b/config/docs/r/chdfs_life_cycle_rule.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Cloud HDFS(CHDFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_chdfs_life_cycle_rule" +sidebar_current: "docs-tencentcloud-resource-chdfs_life_cycle_rule" +description: |- + Provides a resource to create a chdfs life_cycle_rule +--- + +# tencentcloud_chdfs_life_cycle_rule + +Provides a resource to create a chdfs life_cycle_rule + +## Example Usage + +```hcl +resource "tencentcloud_chdfs_life_cycle_rule" "life_cycle_rule" { + file_system_id = "f14mpfy5lh4e" + + life_cycle_rule { + life_cycle_rule_name = "terraform-test" + path = "/test" + status = 1 + + transitions { + days = 30 + type = 1 + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `file_system_id` - (Required, String, ForceNew) file system id. +* `life_cycle_rule` - (Required, List) life cycle rule. + +The `life_cycle_rule` object supports the following: + +* `life_cycle_rule_name` - (Optional, String) rule name. +* `path` - (Optional, String) rule op path. +* `status` - (Optional, Int) rule status, 1:open, 2:close. +* `transitions` - (Optional, List) life cycle rule transition list. + +The `transitions` object supports the following: + +* `days` - (Required, Int) trigger days(n day). +* `type` - (Required, Int) transition type, 1: archive, 2: delete, 3: low rate. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +chdfs life_cycle_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_chdfs_life_cycle_rule.life_cycle_rule file_system_id#life_cycle_rule_id +``` + diff --git a/config/docs/r/chdfs_mount_point.html.markdown b/config/docs/r/chdfs_mount_point.html.markdown new file mode 100644 index 0000000..418707e --- /dev/null +++ b/config/docs/r/chdfs_mount_point.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud HDFS(CHDFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_chdfs_mount_point" +sidebar_current: "docs-tencentcloud-resource-chdfs_mount_point" +description: |- + Provides a resource to create a chdfs mount_point +--- + +# tencentcloud_chdfs_mount_point + +Provides a resource to create a chdfs mount_point + +## Example Usage + +```hcl +resource "tencentcloud_chdfs_mount_point" "mount_point" { + file_system_id = "f14mpfy5lh4e" + mount_point_name = "terraform-test" + mount_point_status = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `file_system_id` - (Required, String, ForceNew) file system id you want to mount. +* `mount_point_name` - (Required, String) mount point name. +* `mount_point_status` - (Required, Int) mount status 1:open, 2:close. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +chdfs mount_point can be imported using the id, e.g. + +``` +terraform import tencentcloud_chdfs_mount_point.mount_point mount_point_id +``` + diff --git a/config/docs/r/chdfs_mount_point_attachment.html.markdown b/config/docs/r/chdfs_mount_point_attachment.html.markdown new file mode 100644 index 0000000..6142b46 --- /dev/null +++ b/config/docs/r/chdfs_mount_point_attachment.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Cloud HDFS(CHDFS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_chdfs_mount_point_attachment" +sidebar_current: "docs-tencentcloud-resource-chdfs_mount_point_attachment" +description: |- + Provides a resource to create a chdfs mount_point_attachment +--- + +# tencentcloud_chdfs_mount_point_attachment + +Provides a resource to create a chdfs mount_point_attachment + +## Example Usage + +```hcl +resource "tencentcloud_chdfs_mount_point_attachment" "mount_point_attachment" { + access_group_ids = [ + "ag-bvmzrbsm", + "ag-lairqrgr", + ] + mount_point_id = "f14mpfy5lh4e-KuiL" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_group_ids` - (Required, Set: [`String`], ForceNew) associate access group id. +* `mount_point_id` - (Required, String, ForceNew) associate mount point. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +chdfs mount_point_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_chdfs_mount_point_attachment.mount_point_attachment mount_point_id +``` + diff --git a/config/docs/r/ci_bucket_attachment.html.markdown b/config/docs/r/ci_bucket_attachment.html.markdown new file mode 100644 index 0000000..6ba3c7e --- /dev/null +++ b/config/docs/r/ci_bucket_attachment.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_bucket_attachment" +sidebar_current: "docs-tencentcloud-resource-ci_bucket_attachment" +description: |- + Provides a resource to create a ci bucket +--- + +# tencentcloud_ci_bucket_attachment + +Provides a resource to create a ci bucket + +## Example Usage + +```hcl +resource "tencentcloud_ci_bucket_attachment" "bucket_attachment" { + bucket = "terraform-ci-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) bucket name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `ci_status` - Binding object storage state, `on`: bound, `off`: unbound, `unbinding`: unbinding. + + +## Import + +ci bucket can be imported using the id, e.g. + +``` +terraform import tencentcloud_ci_bucket_attachment.bucket_attachment terraform-ci-xxxxxx +``` + diff --git a/config/docs/r/ci_bucket_pic_style.html.markdown b/config/docs/r/ci_bucket_pic_style.html.markdown new file mode 100644 index 0000000..f8dcaf0 --- /dev/null +++ b/config/docs/r/ci_bucket_pic_style.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_bucket_pic_style" +sidebar_current: "docs-tencentcloud-resource-ci_bucket_pic_style" +description: |- + Provides a resource to create a ci bucket_pic_style +--- + +# tencentcloud_ci_bucket_pic_style + +Provides a resource to create a ci bucket_pic_style + +## Example Usage + +```hcl +resource "tencentcloud_ci_bucket_pic_style" "bucket_pic_style" { + bucket = "terraform-ci-xxxxxx" + style_name = "rayscale_2" + style_body = "imageMogr2/thumbnail/20x/crop/20x20/gravity/center/interlace/0/quality/100" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) bucket name. +* `style_body` - (Required, String, ForceNew) style details, example: mageMogr2/grayscale/1. +* `style_name` - (Required, String, ForceNew) style name, style names are case-sensitive, and a combination of uppercase and lowercase letters, numbers, and `$ + _ ( )` is supported. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci bucket_pic_style can be imported using the bucket#styleName, e.g. + +``` +terraform import tencentcloud_ci_bucket_pic_style.bucket_pic_style terraform-ci-xxxxxx#rayscale_2 +``` + diff --git a/config/docs/r/ci_guetzli.html.markdown b/config/docs/r/ci_guetzli.html.markdown new file mode 100644 index 0000000..852973e --- /dev/null +++ b/config/docs/r/ci_guetzli.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_guetzli" +sidebar_current: "docs-tencentcloud-resource-ci_guetzli" +description: |- + Manage Guetzli compression functionality +--- + +# tencentcloud_ci_guetzli + +Manage Guetzli compression functionality + +## Example Usage + +```hcl +resource "tencentcloud_ci_guetzli" "foo" { + bucket = "examplebucket-1250000000" + status = "on" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) The name of a bucket, the format should be [custom name]-[appid], for example `mycos-1258798060`. +* `status` - (Required, String) Whether Guetzli is set, options: on/off. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Resource guetzli can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_ci_guetzli.example examplebucket-1250000000 +``` + diff --git a/config/docs/r/ci_hot_link.html.markdown b/config/docs/r/ci_hot_link.html.markdown new file mode 100644 index 0000000..acdd6cb --- /dev/null +++ b/config/docs/r/ci_hot_link.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_hot_link" +sidebar_current: "docs-tencentcloud-resource-ci_hot_link" +description: |- + Provides a resource to create a ci hot_link +--- + +# tencentcloud_ci_hot_link + +Provides a resource to create a ci hot_link + +## Example Usage + +```hcl +resource "tencentcloud_ci_hot_link" "hot_link" { + bucket = "terraform-ci-xxxxxx" + url = ["10.0.0.1", "10.0.0.2"] + type = "white" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `type` - (Required, String) Anti-leech type, `white` is whitelist, `black` is blacklist. +* `url` - (Required, Set: [`String`]) domain address. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci hot_link can be imported using the bucket, e.g. + +``` +terraform import tencentcloud_ci_hot_link.hot_link terraform-ci-xxxxxx +``` + diff --git a/config/docs/r/ci_media_animation_template.html.markdown b/config/docs/r/ci_media_animation_template.html.markdown new file mode 100644 index 0000000..67a6f8f --- /dev/null +++ b/config/docs/r/ci_media_animation_template.html.markdown @@ -0,0 +1,79 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_animation_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_animation_template" +description: |- + Provides a resource to create a ci media_animation_template +--- + +# tencentcloud_ci_media_animation_template + +Provides a resource to create a ci media_animation_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_animation_template" "media_animation_template" { + bucket = "terraform-ci-1308919341" + name = "animation_template-002" + container { + format = "gif" + } + video { + codec = "gif" + width = "1280" + height = "" + fps = "20" + animate_only_keep_key_frame = "true" + animate_time_interval_of_frame = "" + animate_frames_per_second = "" + quality = "" + + } + time_interval { + start = "0" + duration = "60" + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `container` - (Required, List) container format. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `time_interval` - (Optional, List) time interval. +* `video` - (Optional, List) video information, do not upload Video, which is equivalent to deleting video information. + +The `container` object supports the following: + +* `format` - (Required, String) Package format. + +The `time_interval` object supports the following: + +* `duration` - (Optional, String) duration, [0 video duration], in seconds, Support float format, the execution accuracy is accurate to milliseconds. +* `start` - (Optional, String) Starting time, [0 video duration], in seconds, Support float format, the execution accuracy is accurate to milliseconds. + +The `video` object supports the following: + +* `codec` - (Required, String) Codec format `gif`, `webp`. +* `animate_frames_per_second` - (Optional, String) Animation per second frame number, Priority: AnimateFramesPerSecond > AnimateOnlyKeepKeyFrame > AnimateTimeIntervalOfFrame. +* `animate_only_keep_key_frame` - (Optional, String) GIFs are kept only Keyframe, Priority: AnimateFramesPerSecond > AnimateOnlyKeepKeyFrame > AnimateTimeIntervalOfFrame. +* `animate_time_interval_of_frame` - (Optional, String) Animation frame extraction every time, (0, video duration], Animation frame extraction time interval, If TimeInterval.Duration is set, it is less than this value. +* `fps` - (Optional, String) Frame rate, value range: (0, 60], Unit: fps. +* `height` - (Optional, String) High, value range: [128, 4096], Unit: px, If only Height is set, Width is calculated according to the original ratio of the video, must be even. +* `quality` - (Optional, String) Set relative quality, [1, 100), webp image quality setting takes effect, gif has no quality parameter. +* `width` - (Optional, String) width, value range: [128, 4096], Unit: px, If only Width is set, Height is calculated according to the original ratio of the video, must be even. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ci_media_concat_template.html.markdown b/config/docs/r/ci_media_concat_template.html.markdown new file mode 100644 index 0000000..7d83404 --- /dev/null +++ b/config/docs/r/ci_media_concat_template.html.markdown @@ -0,0 +1,139 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_concat_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_concat_template" +description: |- + Provides a resource to create a ci media_concat_template +--- + +# tencentcloud_ci_media_concat_template + +Provides a resource to create a ci media_concat_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_concat_template" "media_concat_template" { + bucket = "terraform-ci-xxxxxx" + name = "concat_templates" + concat_template { + concat_fragment { + url = "https://terraform-ci-xxxxxx.cos.ap-guangzhou.myqcloud.com/mp4%2Fmp4-test.mp4" + mode = "Start" + } + concat_fragment { + url = "https://terraform-ci-xxxxxx.cos.ap-guangzhou.myqcloud.com/mp4%2Fmp4-test.mp4" + mode = "End" + } + audio { + codec = "mp3" + samplerate = "" + bitrate = "" + channels = "" + } + video { + codec = "H.264" + width = "1280" + height = "" + bitrate = "1000" + fps = "25" + crf = "" + remove = "" + rotate = "" + } + container { + format = "mp4" + } + audio_mix { + audio_source = "https://terraform-ci-xxxxxx.cos.ap-guangzhou.myqcloud.com/mp3%2Fnizhan-test.mp3" + mix_mode = "Once" + replace = "true" + effect_config { + enable_start_fadein = "true" + start_fadein_time = "3" + enable_end_fadeout = "false" + end_fadeout_time = "0.1" + enable_bgm_fade = "true" + bgm_fade_time = "1.7" + } + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `concat_template` - (Required, List) stitching template. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. + +The `audio_mix` object supports the following: + +* `audio_source` - (Required, String) The media address of the audio track that needs to be mixed. +* `effect_config` - (Optional, List) Mix Fade Configuration. +* `mix_mode` - (Optional, String) Mixing mode Repeat: background sound loop, Once: The background sound is played once. +* `replace` - (Optional, String) Whether to replace the original audio of the Input media file with the mixed audio track media. + +The `audio` object supports the following: + +* `codec` - (Required, String) Codec format, value aac, mp3. +* `bitrate` - (Optional, String) Original audio bit rate, unit: Kbps, Value range: [8, 1000]. +* `channels` - (Optional, String) number of channels- When Codec is set to aac, support 1, 2, 4, 5, 6, 8- When Codec is set to mp3, support 1, 2. +* `samplerate` - (Optional, String) Sampling Rate- Unit: Hz- Optional 11025, 22050, 32000, 44100, 48000, 96000- Different packages, mp3 supports different sampling rates, as shown in the table below. + +The `concat_fragment` object supports the following: + +* `mode` - (Required, String) node type, `start`, `end`. +* `url` - (Required, String) Splicing object address. + +The `concat_template` object supports the following: + +* `concat_fragment` - (Required, List) Package format. +* `container` - (Required, List) Only splicing without transcoding. +* `audio_mix` - (Optional, List) mixing parameters. +* `audio` - (Optional, List) audio parameters, the target file does not require Audio information, need to set Audio.Remove to true. +* `video` - (Optional, List) video information, do not upload Video, which is equivalent to deleting video information. + +The `container` object supports the following: + +* `format` - (Required, String) Container format: mp4, flv, hls, ts, mp3, aac. + +The `effect_config` object supports the following: + +* `bgm_fade_time` - (Optional, String) bgm transition fade-in duration, support floating point numbers. +* `enable_bgm_fade` - (Optional, String) Enable bgm conversion fade in. +* `enable_end_fadeout` - (Optional, String) enable fade out. +* `enable_start_fadein` - (Optional, String) enable fade in. +* `end_fadeout_time` - (Optional, String) fade out time, greater than 0, support floating point numbers. +* `start_fadein_time` - (Optional, String) Fade in duration, greater than 0, support floating point numbers. + +The `video` object supports the following: + +* `codec` - (Required, String) Codec format `H.264`. +* `bitrate` - (Optional, String) Original audio bit rate, unit: Kbps, Value range: [8, 1000]. +* `crf` - (Optional, String) Bit rate-quality control factor, value range: (0, 51], If Crf is set, the setting of Bitrate will be invalid, When Bitrate is empty, the default is 25. +* `fps` - (Optional, String) Frame rate, value range: (0, 60], Unit: fps. +* `height` - (Optional, String) High, value range: [128, 4096], Unit: px, If only Height is set, Width is calculated according to the original ratio of the video, must be even. +* `remove` - (Optional, String) Whether to delete the source audio stream, the value is true, false. +* `rotate` - (Optional, String) Rotation angle, Value range: [0, 360), Unit: degree. +* `width` - (Optional, String) width, value range: [128, 4096], Unit: px, If only Width is set, Height is calculated according to the original ratio of the video, must be even. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_concat_template can be imported using the bucket#templateId, e.g. + +``` +terraform import tencentcloud_ci_media_concat_template.media_concat_template id=terraform-ci-xxxxxx#t1cb115dfa1fcc414284f83b7c69bcedcf +``` + diff --git a/config/docs/r/ci_media_pic_process_template.html.markdown b/config/docs/r/ci_media_pic_process_template.html.markdown new file mode 100644 index 0000000..5a85b9f --- /dev/null +++ b/config/docs/r/ci_media_pic_process_template.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_pic_process_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_pic_process_template" +description: |- + Provides a resource to create a ci media_pic_process_template +--- + +# tencentcloud_ci_media_pic_process_template + +Provides a resource to create a ci media_pic_process_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_pic_process_template" "media_pic_process_template" { + bucket = "terraform-ci-xxxxxx" + name = "pic_process_template" + pic_process { + is_pic_info = "true" + process_rule = "imageMogr2/rotate/90" + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `pic_process` - (Optional, List) container format. + +The `pic_process` object supports the following: + +* `process_rule` - (Required, String) Image processing rules, 1: basic image processing, please refer to the basic image processing document, 2: image compression, please refer to the image compression document, 3: blind watermark, please refer to the blind watermark document. +* `is_pic_info` - (Optional, String) Whether to return the original image information. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_pic_process_template can be imported using the bucket#templateId, e.g. + +``` +terraform import tencentcloud_ci_media_pic_process_template.media_pic_process_template terraform-ci-xxxxx#t184a8a26da4674c80bf260c1e34131a65 +``` + diff --git a/config/docs/r/ci_media_smart_cover_template.html.markdown b/config/docs/r/ci_media_smart_cover_template.html.markdown new file mode 100644 index 0000000..0e264b2 --- /dev/null +++ b/config/docs/r/ci_media_smart_cover_template.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_smart_cover_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_smart_cover_template" +description: |- + Provides a resource to create a ci media_smart_cover_template +--- + +# tencentcloud_ci_media_smart_cover_template + +Provides a resource to create a ci media_smart_cover_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_smart_cover_template" "media_smart_cover_template" { + bucket = "terraform-ci-xxxxxx" + name = "smart_cover_template" + smart_cover { + format = "jpg" + width = "1280" + height = "960" + count = "10" + delete_duplicates = "true" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `smart_cover` - (Required, List) Smart Cover Parameters. + +The `smart_cover` object supports the following: + +* `format` - (Required, String) Image Format, value jpg, png, webp. +* `count` - (Optional, String) Number of screenshots, [1,10]. +* `delete_duplicates` - (Optional, String) cover deduplication, true/false. +* `height` - (Optional, String) Height, value range: [128, 4096], unit: px, if only Height is set, Width is calculated according to the original video ratio. +* `width` - (Optional, String) Width, value range: [128, 4096], unit: px, if only Width is set, Height is calculated according to the original ratio of the video. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_smart_cover_template can be imported using the bucket#templateId, e.g. + +``` +terraform import tencentcloud_ci_media_smart_cover_template.media_smart_cover_template terraform-ci-xxxxxx#t1ede83acc305e423799d638044d859fb7 +``` + diff --git a/config/docs/r/ci_media_snapshot_template.html.markdown b/config/docs/r/ci_media_snapshot_template.html.markdown new file mode 100644 index 0000000..c35d222 --- /dev/null +++ b/config/docs/r/ci_media_snapshot_template.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_snapshot_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_snapshot_template" +description: |- + Provides a resource to create a ci media_snapshot_template +--- + +# tencentcloud_ci_media_snapshot_template + +Provides a resource to create a ci media_snapshot_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_snapshot_template" "media_snapshot_template" { + bucket = "terraform-ci-xxxxxx" + name = "snapshot_template_test" + snapshot { + count = "10" + snapshot_out_mode = "SnapshotAndSprite" + sprite_snapshot_config { + color = "White" + columns = "10" + lines = "10" + margin = "10" + padding = "10" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `snapshot` - (Required, List) screenshot. + +The `snapshot` object supports the following: + +* `count` - (Required, String) Number of screenshots, range (0 10000]. +* `black_level` - (Optional, String) Screenshot black screen detection parameters, Valid when IsCheckBlack=true, Value reference range [30, 100], indicating the proportion of black pixels, the smaller the value, the smaller the proportion of black pixels, Start>0, the parameter setting is invalid, no filter black screen, Start =0 parameter is valid, the start time of the frame capture is the first frame non-black screen start. +* `ci_param` - (Optional, String) Screenshot image processing parameters, for example: imageMogr2/format/png. +* `height` - (Optional, String) high, value range: [128, 4096], Unit: px, If only Height is set, Width is calculated according to the original ratio of the video. +* `is_check_black` - (Optional, String) Whether to enable black screen detection true/false. +* `is_check_count` - (Optional, String) Whether to check the number of screenshots forcibly, when using custom interval mode to take screenshots, the video time is not long enough to capture Count screenshots, you can switch to average screenshot mode to capture Count screenshots. +* `mode` - (Optional, String) Screenshot mode, value range: {Interval, Average, KeyFrame}- Interval means interval mode Average means average mode- KeyFrame represents the key frame mode- Interval mode: Start, TimeInterval, The Count parameter takes effect. When Count is set and TimeInterval is not set, Indicates to capture all frames, a total of Count pictures- Average mode: Start, the Count parameter takes effect. express. +* `pixel_black_threshold` - (Optional, String) Screenshot black screen detection parameters, Valid when IsCheckBlack=true, The threshold for judging whether a pixel is a black point, value range: [0, 255]. +* `snapshot_out_mode` - (Optional, String) Screenshot output mode parameters, Value range: {OnlySnapshot, OnlySprite, SnapshotAndSprite}, OnlySnapshot means output only screenshot mode OnlySprite means only output sprite mode SnapshotAndSprite means output screenshot and sprite mode. +* `sprite_snapshot_config` - (Optional, List) Screenshot output configuration. +* `start` - (Optional, String) Starting time, [0 video duration] in seconds, Support float format, the execution accuracy is accurate to milliseconds. +* `time_interval` - (Optional, String) Screenshot time interval, (0 3600], in seconds, Support float format, the execution accuracy is accurate to milliseconds. +* `width` - (Optional, String) wide, value range: [128, 4096], Unit: px, If only Width is set, Height is calculated according to the original ratio of the video. + +The `sprite_snapshot_config` object supports the following: + +* `color` - (Required, String) See `https://www.ffmpeg.org/ffmpeg-utils.html#color-syntax` for details on supported colors. +* `columns` - (Required, String) Number of screenshot columns, value range: [1, 10000]. +* `lines` - (Required, String) Number of screenshot lines, value range: [1, 10000]. +* `cell_height` - (Optional, String) Single image height Value range: [8, 4096], Unit: px. +* `cell_width` - (Optional, String) Single image width Value range: [8, 4096], Unit: px. +* `margin` - (Optional, String) screenshot margin size, Value range: [8, 4096], Unit: px. +* `padding` - (Optional, String) screenshot padding size, Value range: [8, 4096], Unit: px. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - creation time. +* `template_id` - Template ID. +* `update_time` - update time. + + +## Import + +ci media_snapshot_template can be imported using the bucket#templateId, e.g. + +``` +terraform import tencentcloud_ci_media_snapshot_template.media_snapshot_template terraform-ci-xxxxxx#t18210645f96564eaf80e86b1f58c20152 +``` + diff --git a/config/docs/r/ci_media_speech_recognition_template.html.markdown b/config/docs/r/ci_media_speech_recognition_template.html.markdown new file mode 100644 index 0000000..42cc7d4 --- /dev/null +++ b/config/docs/r/ci_media_speech_recognition_template.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_speech_recognition_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_speech_recognition_template" +description: |- + Provides a resource to create a ci media_speech_recognition_template +--- + +# tencentcloud_ci_media_speech_recognition_template + +Provides a resource to create a ci media_speech_recognition_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_speech_recognition_template" "media_speech_recognition_template" { + bucket = "terraform-ci-1308919341" + name = "speech_recognition_template" + speech_recognition { + engine_model_type = "16k_zh" + channel_num = "1" + res_text_format = "1" + filter_dirty = "0" + filter_modal = "1" + convert_num_mode = "0" + speaker_diarization = "1" + speaker_number = "0" + filter_punc = "0" + output_file_type = "txt" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `speech_recognition` - (Required, List) audio configuration. + +The `speech_recognition` object supports the following: + +* `channel_num` - (Required, String) Number of voice channels: 1 means mono. EngineModelType supports only mono for non-telephone scenarios, and 2 means dual channels (only 8k_zh engine model supports dual channels, which should correspond to both sides of the call). +* `engine_model_type` - (Required, String) Engine model type, divided into phone scene and non-phone scene, phone scene: 8k_zh: phone 8k Chinese Mandarin general (can be used for dual-channel audio), 8k_zh_s: phone 8k Chinese Mandarin speaker separation (only for monophonic audio), 8k_en: Telephone 8k English; non-telephone scene: 16k_zh: 16k Mandarin Chinese, 16k_zh_video: 16k audio and video field, 16k_en: 16k English, 16k_ca: 16k Cantonese, 16k_ja: 16k Japanese, 16k_zh_edu: Chinese education, 16k_en_edu: English education, 16k_zh_medical: medical, 16k_th: Thai, 16k_zh_dialect: multi-dialect, supports 23 dialects. +* `convert_num_mode` - (Optional, String) Whether to perform intelligent conversion of Arabic numerals (currently supports Mandarin Chinese engine): 0 means no conversion, directly output Chinese numbers, 1 means intelligently convert to Arabic numerals according to the scene, 3 means enable math-related digital conversion, the default value is 0. +* `filter_dirty` - (Optional, String) Whether to filter dirty words (currently supports Mandarin Chinese engine): 0 means not to filter dirty words, 1 means to filter dirty words, 2 means to replace dirty words with *, the default value is 0. +* `filter_modal` - (Optional, String) Whether to pass modal particles (currently supports Mandarin Chinese engine): 0 means not to filter modal particles, 1 means partial filtering, 2 means strict filtering, and the default value is 0. +* `filter_punc` - (Optional, String) Whether to filter punctuation (currently supports Mandarin Chinese engine): 0 means no filtering, 1 means filtering end-of-sentence punctuation, 2 means filtering all punctuation, the default value is 0. +* `output_file_type` - (Optional, String) Output file type, optional txt, srt. The default is txt. +* `res_text_format` - (Optional, String) Recognition result return form: 0 means the recognition result text (including segmented time stamps), 1 is the detailed recognition result at the word level granularity, without punctuation, and includes the speech rate value (a list of word time stamps, generally used to generate subtitle scenes), 2 Detailed recognition results at word-level granularity (including punctuation and speech rate values).. +* `speaker_diarization` - (Optional, String) Whether to enable speaker separation: 0 means not enabled, 1 means enabled (only supports 8k_zh, 16k_zh, 16k_zh_video, monophonic audio), the default value is 0, Note: 8K telephony scenarios suggest using dual-channel to distinguish between the two parties, set ChannelNum=2 is enough, no need to enable speaker separation. +* `speaker_number` - (Optional, String) The number of speakers to be separated (need to be used in conjunction with enabling speaker separation), value range: 0-10, 0 means automatic separation (currently only supports <= 6 people), 1-10 represents the number of specified speakers to be separated. The default value is 0. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_speech_recognition_template can be imported using the bucket#templateId, e.g. + +``` +terraform import tencentcloud_ci_media_speech_recognition_template.media_speech_recognition_template terraform-ci-xxxxxx#t1d794430f2f1f4350b11e905ce2c6167e +``` + diff --git a/config/docs/r/ci_media_super_resolution_template.html.markdown b/config/docs/r/ci_media_super_resolution_template.html.markdown new file mode 100644 index 0000000..9246cba --- /dev/null +++ b/config/docs/r/ci_media_super_resolution_template.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_super_resolution_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_super_resolution_template" +description: |- + Provides a resource to create a ci media_super_resolution_template +--- + +# tencentcloud_ci_media_super_resolution_template + +Provides a resource to create a ci media_super_resolution_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_super_resolution_template" "media_super_resolution_template" { + bucket = "terraform-ci-1308919341" + name = "super_resolution_template" + resolution = "sdtohd" + enable_scale_up = "true" + version = "Enhance" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `resolution` - (Required, String) Resolution Options sdtohd: Standard Definition to Ultra Definition, hdto4k: HD to 4K. +* `enable_scale_up` - (Optional, String) Auto scaling switch, off by default. +* `version` - (Optional, String) version, default value Base, Base: basic version, Enhance: enhanced version. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_super_resolution_template can be imported using the bucket#templateId, e.g. + +``` +terraform import tencentcloud_ci_media_super_resolution_template.media_super_resolution_template terraform-ci-xxxxxx#t1d707eb2be3294e22b47123894f85cb8f +``` + diff --git a/config/docs/r/ci_media_transcode_pro_template.html.markdown b/config/docs/r/ci_media_transcode_pro_template.html.markdown new file mode 100644 index 0000000..e285ff9 --- /dev/null +++ b/config/docs/r/ci_media_transcode_pro_template.html.markdown @@ -0,0 +1,131 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_transcode_pro_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_transcode_pro_template" +description: |- + Provides a resource to create a ci media_transcode_pro_template +--- + +# tencentcloud_ci_media_transcode_pro_template + +Provides a resource to create a ci media_transcode_pro_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_transcode_pro_template" "media_transcode_pro_template" { + bucket = "terraform-ci-xxxxxx" + name = "transcode_pro_template" + container { + format = "mxf" + # clip_config { + # duration = "" + # } + + } + video { + codec = "xavc" + profile = "XAVC-HD_422_10bit" + width = "1920" + height = "1080" + interlaced = "true" + fps = "30000/1001" + bitrate = "50000" + # rotate = "" + + } + time_interval { + start = "" + duration = "" + + } + audio { + codec = "pcm_s24le" + remove = "true" + + } + trans_config { + adj_dar_method = "scale" + is_check_reso = "false" + reso_adj_method = "1" + is_check_video_bitrate = "false" + video_bitrate_adj_method = "0" + is_check_audio_bitrate = "false" + audio_bitrate_adj_method = "0" + delete_metadata = "false" + is_hdr2_sdr = "false" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `container` - (Required, List) container format. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `audio` - (Optional, List) Audio information, do not transmit Audio, which is equivalent to deleting audio information. +* `time_interval` - (Optional, List) time interval. +* `trans_config` - (Optional, List) transcoding configuration. +* `video` - (Optional, List) video information, do not upload Video, which is equivalent to deleting video information. + +The `audio` object supports the following: + +* `codec` - (Required, String) Codec format, value aac, mp3, flac, amr, Vorbis, opus, pcm_s16le. +* `remove` - (Optional, String) Whether to delete the source audio stream, the value is true, false. + +The `clip_config` object supports the following: + +* `duration` - (Optional, String) Fragmentation duration, default 5s. + +The `container` object supports the following: + +* `format` - (Required, String) Package format. +* `clip_config` - (Optional, List) Fragment configuration, valid when format is hls and dash. + +The `time_interval` object supports the following: + +* `duration` - (Optional, String) duration, [0 video duration], in seconds, Support float format, the execution accuracy is accurate to milliseconds. +* `start` - (Optional, String) Starting time, [0 video duration], in seconds, Support float format, the execution accuracy is accurate to milliseconds. + +The `trans_config` object supports the following: + +* `adj_dar_method` - (Optional, String) Resolution adjustment method, value scale, crop, pad, none, When the aspect ratio of the output video is different from the original video, adjust the resolution accordingly according to this parameter. +* `audio_bitrate_adj_method` - (Optional, String) Audio bit rate adjustment mode, value 0, 1; when the output audio bit rate is greater than the original audio bit rate, 0 means use the original audio bit rate; 1 means return transcoding failed, Take effect when IsCheckAudioBitrate is true. +* `delete_metadata` - (Optional, String) Whether to delete the MetaData information in the file, true, false, When false, keep source file information. +* `is_check_audio_bitrate` - (Optional, String) Whether to check the audio code rate, true, false, When false, transcode according to configuration parameters. +* `is_check_reso` - (Optional, String) Whether to check the resolution, when it is false, transcode according to the configuration parameters. +* `is_check_video_bitrate` - (Optional, String) Whether to check the video code rate, when it is false, transcode according to the configuration parameters. +* `is_hdr2_sdr` - (Optional, String) Whether to enable HDR to SDR true, false. +* `reso_adj_method` - (Optional, String) Resolution adjustment mode, value 0, 1; 0 means use the original video resolution; 1 means return transcoding failed, Take effect when IsCheckReso is true. +* `video_bitrate_adj_method` - (Optional, String) Video bit rate adjustment method, value 0, 1; when the output video bit rate is greater than the original video bit rate, 0 means use the original video bit rate; 1 means return transcoding failed, Take effect when IsCheckVideoBitrate is true. + +The `video` object supports the following: + +* `bitrate` - (Optional, String) Bit rate of video output file, value range: [10, 50000], unit: Kbps, auto means adaptive bit rate. +* `codec` - (Optional, String) Codec format, default value: `H.264`, when format is WebM, it is VP8, value range: `H.264`, `H.265`, `VP8`, `VP9`, `AV1`. +* `fps` - (Optional, String) Frame rate, value range: (0, 60], Unit: fps. +* `height` - (Optional, String) High, value range: [128, 4096], Unit: px, If only Height is set, Width is calculated according to the original ratio of the video, must be even. +* `interlaced` - (Optional, String) field pattern. +* `profile` - (Optional, String) encoding level, Support baseline, main, high, auto- When Pixfmt is auto, this parameter can only be set to auto, when it is set to other options, the parameter value will be set to auto- baseline: suitable for mobile devices- main: suitable for standard resolution devices- high: suitable for high-resolution devices- Only H.264 supports this parameter. +* `rotate` - (Optional, String) Rotation angle, Value range: [0, 360), Unit: degree. +* `width` - (Optional, String) width, value range: [128, 4096], Unit: px, If only Width is set, Height is calculated according to the original ratio of the video, must be even. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_transcode_pro_template can be imported using the bucket#templateId, e.g. + +``` +terraform import tencentcloud_ci_media_transcode_pro_template.media_transcode_pro_template terraform-ci-xxxxxx#t13ed9af009da0414e9c7c63456ec8f4d2 +``` + diff --git a/config/docs/r/ci_media_transcode_template.html.markdown b/config/docs/r/ci_media_transcode_template.html.markdown new file mode 100644 index 0000000..8679f26 --- /dev/null +++ b/config/docs/r/ci_media_transcode_template.html.markdown @@ -0,0 +1,189 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_transcode_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_transcode_template" +description: |- + Provides a resource to create a ci media_transcode_template +--- + +# tencentcloud_ci_media_transcode_template + +Provides a resource to create a ci media_transcode_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_transcode_template" "media_transcode_template" { + bucket = "terraform-ci-1308919341" + name = "transcode_template" + container { + format = "mp4" + # clip_config { + # duration = "" + # } + } + video { + codec = "H.264" + width = "1280" + # height = "" + fps = "30" + remove = "false" + profile = "high" + bitrate = "1000" + # crf = "" + # gop = "" + preset = "medium" + # bufsize = "" + # maxrate = "" + # pixfmt = "" + long_short_mode = "false" + # rotate = "" + } + time_interval { + start = "0" + duration = "60" + } + audio { + codec = "aac" + samplerate = "44100" + bitrate = "128" + channels = "4" + remove = "false" + keep_two_tracks = "false" + switch_track = "false" + sample_format = "" + } + trans_config { + adj_dar_method = "scale" + is_check_reso = "false" + reso_adj_method = "1" + is_check_video_bitrate = "false" + video_bitrate_adj_method = "0" + is_check_audio_bitrate = "false" + audio_bitrate_adj_method = "0" + delete_metadata = "false" + is_hdr2_sdr = "false" + } + audio_mix { + audio_source = "https://terraform-ci-1308919341.cos.ap-guangzhou.myqcloud.com/mp3%2Fnizhan-test.mp3" + mix_mode = "Once" + replace = "true" + effect_config { + enable_start_fadein = "true" + start_fadein_time = "3" + enable_end_fadeout = "false" + end_fadeout_time = "0" + enable_bgm_fade = "true" + bgm_fade_time = "1.7" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `container` - (Required, List) container format. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `audio_mix` - (Optional, List) mixing parameters. +* `audio` - (Optional, List) Audio information, do not transmit Audio, which is equivalent to deleting audio information. +* `time_interval` - (Optional, List) time interval. +* `trans_config` - (Optional, List) transcoding configuration. +* `video` - (Optional, List) video information, do not upload Video, which is equivalent to deleting video information. + +The `audio_mix` object supports the following: + +* `audio_source` - (Required, String) The media address of the audio track that needs to be mixed. +* `effect_config` - (Optional, List) Mix Fade Configuration. +* `mix_mode` - (Optional, String) Mixing mode Repeat: background sound loop, Once: The background sound is played once. +* `replace` - (Optional, String) Whether to replace the original audio of the Input media file with the mixed audio track media. + +The `audio` object supports the following: + +* `bitrate` - (Optional, String) Original audio bit rate, unit: Kbps, Value range: [8, 1000]. +* `channels` - (Optional, String) number of channels- When Codec is set to aac/flac, support 1, 2, 4, 5, 6, 8- When Codec is set to mp3/opus, support 1, 2- When Codec is set to Vorbis, only 2 is supported- When Codec is set to amr, only 1 is supported- When Codec is set to pcm_s16le, only 1 and 2 are supported- When the encapsulation format is dash, 8 is not supported. +* `codec` - (Optional, String) Codec format, value aac, mp3, flac, amr, Vorbis, opus, pcm_s16le. +* `keep_two_tracks` - (Optional, String) Keep dual audio tracks, the value is true, false. This parameter is invalid when Video.Codec is H.265. +* `remove` - (Optional, String) Whether to delete the source audio stream, the value is true, false. +* `sample_format` - (Optional, String) Sampling bit width- When Codec is set to aac, support fltp- When Codec is set to mp3, fltp, s16p, s32p are supported- When Codec is set to flac, s16, s32, s16p, s32p are supported- When Codec is set to amr, support s16, s16p- When Codec is set to opus, support s16- When Codec is set to pcm_s16le, support s16- When Codec is set to Vorbis, support fltp- This parameter is invalid when Video.Codec is H.265. +* `samplerate` - (Optional, String) Sampling Rate- Unit: Hz- Optional 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000- Different packages, mp3 supports different sampling rates, as shown in the table below- When Codec is set to amr, only 8000 is supported- When Codec is set to opus, it supports 8000, 16000, 24000, 48000. +* `switch_track` - (Optional, String) Convert track, the value is true, false. This parameter is invalid when Video.Codec is H.265. + +The `clip_config` object supports the following: + +* `duration` - (Optional, String) Fragmentation duration, default 5s. + +The `container` object supports the following: + +* `format` - (Required, String) Package format. +* `clip_config` - (Optional, List) Fragment configuration, valid when format is hls and dash. + +The `effect_config` object supports the following: + +* `bgm_fade_time` - (Optional, String) bgm transition fade-in duration, support floating point numbers. +* `enable_bgm_fade` - (Optional, String) Enable bgm conversion fade in. +* `enable_end_fadeout` - (Optional, String) enable fade out. +* `enable_start_fadein` - (Optional, String) enable fade in. +* `end_fadeout_time` - (Optional, String) fade out time, greater than 0, support floating point numbers. +* `start_fadein_time` - (Optional, String) Fade in duration, greater than 0, support floating point numbers. + +The `hls_encrypt` object supports the following: + +* `is_hls_encrypt` - (Optional, String) Whether to enable HLS encryption, support encryption when Container.Format is hls. +* `uri_key` - (Optional, String) HLS encrypted key, this parameter is only meaningful when IsHlsEncrypt is true. + +The `time_interval` object supports the following: + +* `duration` - (Optional, String) duration, [0 video duration], in seconds, Support float format, the execution accuracy is accurate to milliseconds. +* `start` - (Optional, String) Starting time, [0 video duration], in seconds, Support float format, the execution accuracy is accurate to milliseconds. + +The `trans_config` object supports the following: + +* `adj_dar_method` - (Optional, String) Resolution adjustment method, value scale, crop, pad, none, When the aspect ratio of the output video is different from the original video, adjust the resolution accordingly according to this parameter. +* `audio_bitrate_adj_method` - (Optional, String) Audio bit rate adjustment mode, value 0, 1; when the output audio bit rate is greater than the original audio bit rate, 0 means use the original audio bit rate; 1 means return transcoding failed, Take effect when IsCheckAudioBitrate is true. +* `delete_metadata` - (Optional, String) Whether to delete the MetaData information in the file, true, false, When false, keep source file information. +* `hls_encrypt` - (Optional, List) hls encryption configuration. +* `is_check_audio_bitrate` - (Optional, String) Whether to check the audio code rate, true, false, When false, transcode according to configuration parameters. +* `is_check_reso` - (Optional, String) Whether to check the resolution, when it is false, transcode according to the configuration parameters. +* `is_check_video_bitrate` - (Optional, String) Whether to check the video code rate, when it is false, transcode according to the configuration parameters. +* `is_hdr2_sdr` - (Optional, String) Whether to enable HDR to SDR true, false. +* `reso_adj_method` - (Optional, String) Resolution adjustment mode, value 0, 1; 0 means use the original video resolution; 1 means return transcoding failed, Take effect when IsCheckReso is true. +* `video_bitrate_adj_method` - (Optional, String) Video bit rate adjustment method, value 0, 1; when the output video bit rate is greater than the original video bit rate, 0 means use the original video bit rate; 1 means return transcoding failed, Take effect when IsCheckVideoBitrate is true. + +The `video` object supports the following: + +* `bitrate` - (Optional, String) Bit rate of video output file, value range: [10, 50000], unit: Kbps, auto means adaptive bit rate. +* `bufsize` - (Optional, String) buffer size, Value range: [1000, 128000], Unit: Kb, This parameter is not supported when Codec is VP8/VP9. +* `codec` - (Optional, String) Codec format, default value: `H.264`, when format is WebM, it is VP8, value range: `H.264`, `H.265`, `VP8`, `VP9`, `AV1`. +* `crf` - (Optional, String) Bit rate-quality control factor, value range: (0, 51], If Crf is set, the setting of Bitrate will be invalid, When Bitrate is empty, the default is 25. +* `fps` - (Optional, String) Frame rate, value range: (0, 60], Unit: fps. +* `gop` - (Optional, String) The maximum number of frames between key frames, value range: [1, 100000]. +* `height` - (Optional, String) High, value range: [128, 4096], Unit: px, If only Height is set, Width is calculated according to the original ratio of the video, must be even. +* `long_short_mode` - (Optional, String) Adaptive length,true, false, This parameter is not supported when Codec is VP8/VP9/AV1. +* `maxrate` - (Optional, String) Peak video bit rate, Value range: [10, 50000], Unit: Kbps, This parameter is not supported when Codec is VP8/VP9. +* `pixfmt` - (Optional, String) video color format, H.264 support: yuv420p, yuv422p, yuv444p, yuvj420p, yuvj422p, yuvj444p, auto, H.265 support: yuv420p, yuv420p10le, auto, This parameter is not supported when Codec is VP8/VP9/AV1. +* `preset` - (Optional, String) Video Algorithm Presets- H.264 supports this parameter, the values are veryfast, fast, medium, slow, slower- VP8 supports this parameter, the value is good, realtime- AV1 supports this parameter, the value is 5 (recommended value), 4- H.265 and VP9 do not support this parameter. +* `profile` - (Optional, String) encoding level, Support baseline, main, high, auto- When Pixfmt is auto, this parameter can only be set to auto, when it is set to other options, the parameter value will be set to auto- baseline: suitable for mobile devices- main: suitable for standard resolution devices- high: suitable for high-resolution devices- Only H.264 supports this parameter. +* `remove` - (Optional, String) Whether to delete the video stream, true, false. +* `rotate` - (Optional, String) Rotation angle, Value range: [0, 360), Unit: degree. +* `width` - (Optional, String) width, value range: [128, 4096], Unit: px, If only Width is set, Height is calculated according to the original ratio of the video, must be even. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_transcode_template can be imported using the bucket#templateId, e.g. + +``` +terraform import tencentcloud_ci_media_transcode_template.media_transcode_template media_transcode_template_id +``` + diff --git a/config/docs/r/ci_media_tts_template.html.markdown b/config/docs/r/ci_media_tts_template.html.markdown new file mode 100644 index 0000000..dc3bff1 --- /dev/null +++ b/config/docs/r/ci_media_tts_template.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_tts_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_tts_template" +description: |- + Provides a resource to create a ci media_tts_template +--- + +# tencentcloud_ci_media_tts_template + +Provides a resource to create a ci media_tts_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_tts_template" "media_tts_template" { + bucket = "terraform-ci-xxxxxx" + name = "tts_template" + mode = "Asyc" + codec = "pcm" + voice_type = "ruxue" + volume = "0" + speed = "100" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `codec` - (Optional, String) Audio format, default wav (synchronous)/pcm (asynchronous, wav, mp3, pcm. +* `mode` - (Optional, String) Processing mode, default value Asyc, Asyc (asynchronous composition), Sync (synchronous composition), When Asyc is selected, the codec only supports pcm. +* `speed` - (Optional, String) Speech rate, the default value is 100, [50,200]. +* `voice_type` - (Optional, String) Timbre, the default value is ruxue. +* `volume` - (Optional, String) Volume, default value 0, [-10,10]. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_tts_template can be imported using the bucket#templateId, e.g. + +``` +terraform import tencentcloud_ci_media_tts_template.media_tts_template terraform-ci-xxxxxx#t1ed421df8bd2140b6b73474f70f99b0f8 +``` + diff --git a/config/docs/r/ci_media_video_montage_template.html.markdown b/config/docs/r/ci_media_video_montage_template.html.markdown new file mode 100644 index 0000000..30e013c --- /dev/null +++ b/config/docs/r/ci_media_video_montage_template.html.markdown @@ -0,0 +1,124 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_video_montage_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_video_montage_template" +description: |- + Provides a resource to create a ci media_video_montage_template +--- + +# tencentcloud_ci_media_video_montage_template + +Provides a resource to create a ci media_video_montage_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_video_montage_template" "media_video_montage_template" { + bucket = "terraform-ci-xxxxx" + name = "video_montage_template" + duration = "10.5" + audio { + codec = "aac" + samplerate = "44100" + bitrate = "128" + channels = "4" + remove = "false" + + } + video { + codec = "H.264" + width = "1280" + height = "" + bitrate = "1000" + fps = "25" + crf = "" + remove = "" + } + container { + format = "mp4" + + } + audio_mix { + audio_source = "https://terraform-ci-xxxxx.cos.ap-guangzhou.myqcloud.com/mp3%2Fnizhan-test.mp3" + mix_mode = "Once" + replace = "true" + # effect_config { + # enable_start_fadein = "" + # start_fadein_time = "" + # enable_end_fadeout = "" + # end_fadeout_time = "" + # enable_bgm_fade = "" + # bgm_fade_time = "" + # } + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `container` - (Required, List) container format. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `audio_mix` - (Optional, List) mixing parameters. +* `audio` - (Optional, List) audio parameters, the target file does not require Audio information, need to set Audio.Remove to true. +* `duration` - (Optional, String) Collection duration 1: Default automatic analysis duration, 2: The unit is seconds, 3: Support float format, execution accuracy is accurate to milliseconds. +* `video` - (Optional, List) video information, do not upload Video, which is equivalent to deleting video information. + +The `audio_mix` object supports the following: + +* `audio_source` - (Required, String) The media address of the audio track that needs to be mixed. +* `effect_config` - (Optional, List) Mix Fade Configuration. +* `mix_mode` - (Optional, String) Mixing mode Repeat: background sound loop, Once: The background sound is played once. +* `replace` - (Optional, String) Whether to replace the original audio of the Input media file with the mixed audio track media. + +The `audio` object supports the following: + +* `codec` - (Required, String) Codec format, value aac, mp3. +* `bitrate` - (Optional, String) Original audio bit rate, unit: Kbps, Value range: [8, 1000]. +* `channels` - (Optional, String) number of channels- When Codec is set to aac, support 1, 2, 4, 5, 6, 8- When Codec is set to mp3, support 1, 2. +* `remove` - (Optional, String) Whether to delete the source audio stream, the value is true, false. +* `samplerate` - (Optional, String) Sampling Rate- Unit: Hz- Optional 11025, 22050, 32000, 44100, 48000, 96000- Different packages, mp3 supports different sampling rates, as shown in the table below. + +The `container` object supports the following: + +* `format` - (Required, String) Container format: mp4, flv, hls, ts, mkv. + +The `effect_config` object supports the following: + +* `bgm_fade_time` - (Optional, String) bgm transition fade-in duration, support floating point numbers. +* `enable_bgm_fade` - (Optional, String) Enable bgm conversion fade in. +* `enable_end_fadeout` - (Optional, String) enable fade out. +* `enable_start_fadein` - (Optional, String) enable fade in. +* `end_fadeout_time` - (Optional, String) fade out time, greater than 0, support floating point numbers. +* `start_fadein_time` - (Optional, String) Fade in duration, greater than 0, support floating point numbers. + +The `video` object supports the following: + +* `codec` - (Required, String) Codec format `H.264`. +* `bitrate` - (Optional, String) Bit rate of video output file, value range: [10, 50000], unit: Kbps, auto means adaptive bit rate. +* `crf` - (Optional, String) Bit rate-quality control factor, value range: (0, 51], If Crf is set, the setting of Bitrate will be invalid, When Bitrate is empty, the default is 25. +* `fps` - (Optional, String) Frame rate, value range: (0, 60], Unit: fps. +* `height` - (Optional, String) High, value range: [128, 4096], Unit: px, If only Height is set, Width is calculated according to the original ratio of the video, must be even. +* `remove` - (Optional, String) Whether to delete the source audio stream, the value is true, false. +* `width` - (Optional, String) width, value range: [128, 4096], Unit: px, If only Width is set, Height is calculated according to the original ratio of the video, must be even. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_video_montage_template can be imported using the bucket#templateId, e.g. + +``` +terraform import tencentcloud_ci_media_video_montage_template.media_video_montage_template terraform-ci-xxxxxx#t193e5ecc1b8154e57a8376b4405ad9c63 +``` + diff --git a/config/docs/r/ci_media_video_process_template.html.markdown b/config/docs/r/ci_media_video_process_template.html.markdown new file mode 100644 index 0000000..292987c --- /dev/null +++ b/config/docs/r/ci_media_video_process_template.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_video_process_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_video_process_template" +description: |- + Provides a resource to create a ci media_video_process_template +--- + +# tencentcloud_ci_media_video_process_template + +Provides a resource to create a ci media_video_process_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_video_process_template" "media_video_process_template" { + bucket = "terraform-ci-xxxxxx" + name = "video_process_template" + color_enhance { + enable = "true" + contrast = "" + correction = "" + saturation = "" + + } + ms_sharpen { + enable = "false" + sharpen_level = "" + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `color_enhance` - (Optional, List) color enhancement. +* `ms_sharpen` - (Optional, List) detail enhancement, ColorEnhance and MsSharpen cannot both be empty. + +The `color_enhance` object supports the following: + +* `contrast` - (Optional, String) Contrast, value range: [0, 100], empty string (indicates automatic analysis). +* `correction` - (Optional, String) colorcorrection, value range: [0, 100], empty string (indicating automatic analysis). +* `enable` - (Optional, String) Whether color enhancement is turned on. +* `saturation` - (Optional, String) Saturation, value range: [0, 100], empty string (indicating automatic analysis). + +The `ms_sharpen` object supports the following: + +* `enable` - (Optional, String) Whether detail enhancement is enabled. +* `sharpen_level` - (Optional, String) Enhancement level, value range: [0, 10], empty string (indicates automatic analysis). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_video_process_template can be imported using the bucket#templateId, e.g. + +``` +terraform import tencentcloud_ci_media_video_process_template.media_video_process_template terraform-ci-xxxxxx#t1d5694d87639a4593a9fd7e9025d26f52 +``` + diff --git a/config/docs/r/ci_media_voice_separate_template.html.markdown b/config/docs/r/ci_media_voice_separate_template.html.markdown new file mode 100644 index 0000000..98e24c2 --- /dev/null +++ b/config/docs/r/ci_media_voice_separate_template.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_voice_separate_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_voice_separate_template" +description: |- + Provides a resource to create a ci media_voice_separate_template +--- + +# tencentcloud_ci_media_voice_separate_template + +Provides a resource to create a ci media_voice_separate_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_voice_separate_template" "media_voice_separate_template" { + bucket = "terraform-ci-xxxxx" + name = "voice_separate_template" + audio_mode = "IsAudio" + audio_config { + codec = "aac" + samplerate = "44100" + bitrate = "128" + channels = "4" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `audio_config` - (Required, List) audio configuration. +* `audio_mode` - (Required, String) Output audio IsAudio: output human voice, IsBackground: output background sound, AudioAndBackground: output vocal and background sound. +* `bucket` - (Required, String) bucket name. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. + +The `audio_config` object supports the following: + +* `codec` - (Required, String) Codec format, value aac, mp3, flac, amr. +* `bitrate` - (Optional, String) Original audio bit rate, unit: Kbps, Value range: [8, 1000]. +* `channels` - (Optional, String) number of channels- When Codec is set to aac/flac, support 1, 2, 4, 5, 6, 8- When Codec is set to mp3, support 1, 2- When Codec is set to amr, only 1 is supported. +* `samplerate` - (Optional, String) Sampling Rate- 1: Unit: Hz- 2: Optional 8000, 11025, 22050, 32000, 44100, 48000, 96000- 3: When Codec is set to aac/flac, 8000 is not supported- 4: When Codec is set to mp3, 8000 and 96000 are not supported- 5: When Codec is set to amr, only 8000 is supported. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_voice_separate_template can be imported using the id, e.g. + +``` +terraform import tencentcloud_ci_media_voice_separate_template.media_voice_separate_template terraform-ci-xxxxxx#t1c95566664530460d9bc2b6265feb7c32 +``` + diff --git a/config/docs/r/ci_media_watermark_template.html.markdown b/config/docs/r/ci_media_watermark_template.html.markdown new file mode 100644 index 0000000..a8a2eea --- /dev/null +++ b/config/docs/r/ci_media_watermark_template.html.markdown @@ -0,0 +1,99 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_media_watermark_template" +sidebar_current: "docs-tencentcloud-resource-ci_media_watermark_template" +description: |- + Provides a resource to create a ci media_watermark_template +--- + +# tencentcloud_ci_media_watermark_template + +Provides a resource to create a ci media_watermark_template + +## Example Usage + +```hcl +resource "tencentcloud_ci_media_watermark_template" "media_watermark_template" { + bucket = "terraform-ci-1308919341" + name = "watermark_template" + watermark { + type = "Text" + pos = "TopRight" + loc_mode = "Absolute" + dx = "128" + dy = "128" + start_time = "0" + end_time = "100.5" + # image { + # url = "" + # mode = "" + # width = "" + # height = "" + # transparency = "" + # background = "" + # } + text { + font_size = "30" + font_type = "simfang.ttf" + font_color = "0xF0F8F0" + transparency = "30" + text = "watermark-content" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) bucket name. +* `name` - (Required, String) The template name only supports `Chinese`, `English`, `numbers`, `_`, `-` and `*`. +* `watermark` - (Required, List) container format. + +The `image` object supports the following: + +* `background` - (Required, String) Whether the background image. +* `mode` - (Required, String) Size mode, Original: original size, Proportion: proportional, Fixed: fixed size. +* `transparency` - (Required, String) Transparency, value range: [1 100], unit %. +* `url` - (Required, String) Address of watermark map (pass in after Urlencode is required). +* `height` - (Optional, String) High, 1: When the Mode is Original, it does not support setting the width of the watermark image, 2: When the Mode is Proportion, the unit is %, the value range of the background image: [100 300]; the value range of the foreground image: [1 100], relative to Video width, up to 4096px, 3: When Mode is Fixed, the unit is px, value range: [8, 4096], 4: If only Width is set, Height is calculated according to the proportion of the watermark image. +* `width` - (Optional, String) Width, 1: When the Mode is Original, it does not support setting the width of the watermark image, 2: When the Mode is Proportion, the unit is %, the value range of the background image: [100 300]; the value range of the foreground image: [1 100], relative to Video width, up to 4096px, 3: When Mode is Fixed, the unit is px, value range: [8, 4096], 4: If only Width is set, Height is calculated according to the proportion of the watermark image. + +The `text` object supports the following: + +* `font_color` - (Required, String) Font color, format: 0xRRGGBB. +* `font_size` - (Required, String) Font size, value range: [5 100], unit px. +* `font_type` - (Required, String) font type. +* `text` - (Required, String) Watermark content, the length does not exceed 64 characters, only supports Chinese, English, numbers, _, - and *. +* `transparency` - (Required, String) Transparency, value range: [1 100], unit %. + +The `watermark` object supports the following: + +* `dx` - (Required, String) Horizontal offset, 1: In the picture watermark, if Background is true, when locMode is Relativity, it is %, value range: [-300 0]; when locMode is Absolute, it is px, value range: [-4096 0] ], 2: In the picture watermark, if Background is false, when locMode is Relativity, it is %, value range: [0 100]; when locMode is Absolute, it is px, value range: [0 4096], 3: In text watermark, when locMode is Relativity, it is %, value range: [0 100]; when locMode is Absolute, it is px, value range: [0 4096], 4: When Pos is Top, Bottom and Center, the parameter is invalid. +* `dy` - (Required, String) Vertical offset, 1: In the picture watermark, if Background is true, when locMode is Relativity, it is %, value range: [-300 0]; when locMode is Absolute, it is px, value range: [-4096 0] ],2: In the picture watermark, if Background is false, when locMode is Relativity, it is %, value range: [0 100]; when locMode is Absolute, it is px, value range: [0 4096],3: In text watermark, when locMode is Relativity, it is %, value range: [0 100]; when locMode is Absolute, it is px, value range: [0 4096], 4: When Pos is Left, Right and Center, the parameter is invalid. +* `loc_mode` - (Required, String) Offset method, Relativity: proportional, Absolute: fixed position. +* `pos` - (Required, String) Reference position, TopRight, TopLeft, BottomRight, BottomLeft, Left, Right, Top, Bottom, Center. +* `type` - (Required, String) Watermark type, Text: text watermark, Image: image watermark. +* `end_time` - (Optional, String) Watermark end time, 1: [0 video duration], 2: unit is second, 3: support float format, execution accuracy is accurate to milliseconds. +* `image` - (Optional, List) Image watermark node. +* `start_time` - (Optional, String) Watermark start time, 1: [0 video duration], 2: unit is second, 3: support float format, execution accuracy is accurate to milliseconds. +* `text` - (Optional, List) Text Watermark Node. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ci media_watermark_template can be imported using the id, e.g. + +``` +terraform import tencentcloud_ci_media_watermark_template.media_watermark_template media_watermark_template_id +``` + diff --git a/config/docs/r/ci_original_image_protection.html.markdown b/config/docs/r/ci_original_image_protection.html.markdown new file mode 100644 index 0000000..0557156 --- /dev/null +++ b/config/docs/r/ci_original_image_protection.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Infinite(CI)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ci_original_image_protection" +sidebar_current: "docs-tencentcloud-resource-ci_original_image_protection" +description: |- + Manage original image protection functionality +--- + +# tencentcloud_ci_original_image_protection + +Manage original image protection functionality + +## Example Usage + +```hcl +resource "tencentcloud_ci_original_image_protection" "foo" { + bucket = "examplebucket-1250000000" + status = "on" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) The name of a bucket, the format should be [custom name]-[appid], for example `mycos-1258798060`. +* `status` - (Required, String) Whether original image protection is set, options: on/off. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Resource original image protection can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_ci_original_image_protection.example examplebucket-1250000000 +``` + diff --git a/config/docs/r/ciam_user_group.html.markdown b/config/docs/r/ciam_user_group.html.markdown new file mode 100644 index 0000000..0ea4b1e --- /dev/null +++ b/config/docs/r/ciam_user_group.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Customer Identity and Access Management(CIAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ciam_user_group" +sidebar_current: "docs-tencentcloud-resource-ciam_user_group" +description: |- + Provides a resource to create a ciam user group +--- + +# tencentcloud_ciam_user_group + +Provides a resource to create a ciam user group + +## Example Usage + +```hcl +resource "tencentcloud_ciam_user_store" "user_store" { + user_pool_name = "tf_user_store" + user_pool_desc = "for terraform test" + user_pool_logo = "https://ciam-prd-1302490086.cos.ap-guangzhou.myqcloud.com/temporary/92630252a2c5422d9663db5feafd619b.png" +} + +resource "tencentcloud_ciam_user_group" "user_group" { + display_name = "tf_user_group" + user_store_id = tencentcloud_ciam_user_store.user_store.id + description = "for terrafrom test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `display_name` - (Required, String) User Group Name. +* `user_store_id` - (Required, String) User Store ID. +* `description` - (Optional, String) User Group Description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ciam user_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_ciam_user_group.user_group userStoreId#userGroupId +``` + diff --git a/config/docs/r/ciam_user_store.html.markdown b/config/docs/r/ciam_user_store.html.markdown new file mode 100644 index 0000000..14ad79b --- /dev/null +++ b/config/docs/r/ciam_user_store.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Customer Identity and Access Management(CIAM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ciam_user_store" +sidebar_current: "docs-tencentcloud-resource-ciam_user_store" +description: |- + Provides a resource to create a ciam user store +--- + +# tencentcloud_ciam_user_store + +Provides a resource to create a ciam user store + +## Example Usage + +```hcl +resource "tencentcloud_ciam_user_store" "user_store" { + user_pool_name = "tf_user_store" + user_pool_desc = "for terraform test 123" + user_pool_logo = "https://ciam-prd-1302490086.cos.ap-guangzhou.myqcloud.com/temporary/92630252a2c5422d9663db5feafd619b.png" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `user_pool_name` - (Required, String) User Store Name. +* `user_pool_desc` - (Optional, String) User Store Description. +* `user_pool_logo` - (Optional, String) User Store Logo. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ciam user_store can be imported using the id, e.g. + +``` +terraform import tencentcloud_ciam_user_store.user_store userStoreId +``` + diff --git a/config/docs/r/ckafka_acl.html.markdown b/config/docs/r/ckafka_acl.html.markdown new file mode 100644 index 0000000..b983ba9 --- /dev/null +++ b/config/docs/r/ckafka_acl.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_acl" +sidebar_current: "docs-tencentcloud-resource-ckafka_acl" +description: |- + Provides a resource to create a Ckafka Acl. +--- + +# tencentcloud_ckafka_acl + +Provides a resource to create a Ckafka Acl. + +## Example Usage + +### Ckafka Acl + +```hcl +resource "tencentcloud_ckafka_acl" "foo" { + instance_id = "ckafka-f9ife4zz" + resource_type = "TOPIC" + resource_name = "topic-tf-test" + operation_type = "WRITE" + permission_type = "ALLOW" + host = "*" + principal = tencentcloud_ckafka_user.foo.account_name +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of the ckafka instance. +* `operation_type` - (Required, String, ForceNew) ACL operation mode. Valid values: `UNKNOWN`, `ANY`, `ALL`, `READ`, `WRITE`, `CREATE`, `DELETE`, `ALTER`, `DESCRIBE`, `CLUSTER_ACTION`, `DESCRIBE_CONFIGS` and `ALTER_CONFIGS`. +* `resource_name` - (Required, String, ForceNew) ACL resource name, which is related to `resource_type`. For example, if `resource_type` is `TOPIC`, this field indicates the topic name; if `resource_type` is `GROUP`, this field indicates the group name. +* `host` - (Optional, String, ForceNew) The default is *, which means that any host can access it. Support filling in IP or network segment, and support `;`separation. +* `permission_type` - (Optional, String, ForceNew) ACL permission type. Valid values: `UNKNOWN`, `ANY`, `DENY`, `ALLOW`. and `ALLOW` by default. Currently, CKafka supports `ALLOW` (equivalent to allow list), and other fields will be used for future ACLs compatible with open-source Kafka. +* `principal` - (Optional, String, ForceNew) User list. The default value is `*`, which means that any user can access. The current user can only be one included in the user list. For example: `root` meaning user root can access. +* `resource_type` - (Optional, String, ForceNew) ACL resource type. Valid values are `UNKNOWN`, `ANY`, `TOPIC`, `GROUP`, `CLUSTER`, `TRANSACTIONAL_ID`. and `TOPIC` by default. Currently, only `TOPIC` is available, and other fields will be used for future ACLs compatible with open-source Kafka. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Ckafka acl can be imported using the instance_id#permission_type#principal#host#operation_type#resource_type#resource_name, e.g. + +``` +$ terraform import tencentcloud_ckafka_acl.foo ckafka-f9ife4zz#ALLOW#test#*#WRITE#TOPIC#topic-tf-test +``` + diff --git a/config/docs/r/ckafka_acl_rule.html.markdown b/config/docs/r/ckafka_acl_rule.html.markdown new file mode 100644 index 0000000..c84cccf --- /dev/null +++ b/config/docs/r/ckafka_acl_rule.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_acl_rule" +sidebar_current: "docs-tencentcloud-resource-ckafka_acl_rule" +description: |- + Provides a resource to create a ckafka acl_rule +--- + +# tencentcloud_ckafka_acl_rule + +Provides a resource to create a ckafka acl_rule + +## Example Usage + +```hcl +resource "tencentcloud_ckafka_acl_rule" "acl_rule" { + instance_id = "ckafka-xxx" + resource_type = "Topic" + pattern_type = "PREFIXED" + rule_name = "RuleName" + rule_list { + operation = "All" + permission_type = "Deny" + host = "*" + principal = "User:*" + + } + pattern = "prefix" + is_applied = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) instance id. +* `pattern_type` - (Required, String, ForceNew) Match type, currently supports prefix matching and preset strategy, enumeration value list{PREFIXED/PRESET}. +* `resource_type` - (Required, String, ForceNew) Acl resource type, currently only supports Topic, enumeration value list{Topic}. +* `rule_list` - (Required, List, ForceNew) List of configured ACL rules. +* `rule_name` - (Required, String, ForceNew) rule name. +* `is_applied` - (Optional, Int) Whether the preset ACL rule is applied to the newly added topic. +* `pattern` - (Optional, String, ForceNew) A value representing the prefix that the prefix matches. + +The `rule_list` object supports the following: + +* `host` - (Required, String, ForceNew) The default is *, which means that any host can be accessed. Currently, ckafka does not support host and ip network segment. +* `operation` - (Required, String, ForceNew) Acl operation mode, enumeration value (all operations All, read Read, write Write). +* `permission_type` - (Required, String, ForceNew) permission type, (Deny|Allow). +* `principal` - (Required, String, ForceNew) User list, the default is User:, which means that any user can access, and the current user can only be the user included in the user list. The input format needs to be prefixed with [User:]. For example, user A is passed in as User:A. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ckafka acl_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_ckafka_acl_rule.acl_rule acl_rule_id +``` + diff --git a/config/docs/r/ckafka_connect_resource.html.markdown b/config/docs/r/ckafka_connect_resource.html.markdown new file mode 100644 index 0000000..451d58e --- /dev/null +++ b/config/docs/r/ckafka_connect_resource.html.markdown @@ -0,0 +1,174 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_connect_resource" +sidebar_current: "docs-tencentcloud-resource-ckafka_connect_resource" +description: |- + Provides a resource to create a ckafka connect_resource +--- + +# tencentcloud_ckafka_connect_resource + +Provides a resource to create a ckafka connect_resource + +## Example Usage + +```hcl +resource "tencentcloud_ckafka_connect_resource" "connect_resource" { + resource_name = "terraform-test" + type = "MYSQL" + description = "for terraform test" + + mysql_connect_param { + port = 3306 + user_name = "root" + password = "xxxxxxxxx" + resource = "cdb-fitq5t9h" + service_vip = "172.16.80.59" + uniq_vpc_id = "vpc-4owdpnwr" + self_built = false + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_name` - (Required, String) connection source name. +* `type` - (Required, String, ForceNew) connection source type. +* `clickhouse_connect_param` - (Optional, List) ClickHouse configuration, required when Type is CLICKHOUSE. +* `description` - (Optional, String) Connection source description. +* `doris_connect_param` - (Optional, List) Doris configuration, required when Type is DORIS. +* `dts_connect_param` - (Optional, List) Dts configuration, required when Type is DTS. +* `es_connect_param` - (Optional, List) Es configuration, required when Type is ES. +* `kafka_connect_param` - (Optional, List) Kafka configuration, required when Type is KAFKA. +* `mariadb_connect_param` - (Optional, List) Maria DB configuration, required when Type is MARIADB. +* `mongodb_connect_param` - (Optional, List) Mongo DB configuration, required when Type is MONGODB. +* `mysql_connect_param` - (Optional, List) MySQL configuration, required when Type is MYSQL or TDSQL C_MYSQL. +* `postgresql_connect_param` - (Optional, List) Postgresql configuration, required when Type is POSTGRESQL or TDSQL C POSTGRESQL. +* `sqlserver_connect_param` - (Optional, List) SQLServer configuration, required when Type is SQLSERVER. + +The `clickhouse_connect_param` object supports the following: + +* `password` - (Required, String) Password for Clickhouse connection source. +* `port` - (Required, Int) Clickhouse connection port. +* `resource` - (Required, String) Instance resources for Click House connection sources. +* `self_built` - (Required, Bool) Whether the Clickhouse connection source is a self-built cluster. +* `user_name` - (Required, String) The username of the clickhouse connection source. +* `is_update` - (Optional, Bool) Whether to update to the associated Datahub task, default: false. +* `service_vip` - (Optional, String) Instance VIP of the ClickHouse connection source, when it is a Tencent Cloud instance, it is required. +* `uniq_vpc_id` - (Optional, String) The vpc Id of the source of the ClickHouse connection, when it is a Tencent Cloud instance, it is required. + +The `doris_connect_param` object supports the following: + +* `password` - (Required, String) Doris password. +* `port` - (Required, Int) Doris jdbc CLB port, Usually mapped to port 9030 of fe. +* `resource` - (Required, String) Doris instanceId. +* `user_name` - (Required, String) Doris The username of the connection source. +* `be_port` - (Optional, Int) Doris http CLB port, Usually mapped to port 8040 of be. +* `is_update` - (Optional, Bool) Whether to update to the associated Datahub task, default: false. +* `self_built` - (Optional, Bool) Doris Whether the connection source is a self-built cluster, default: false. +* `service_vip` - (Optional, String) Doris vip, When it is a Tencent Cloud instance, it is required. +* `uniq_vpc_id` - (Optional, String) Doris vpcId, When it is a Tencent Cloud instance, it is required. + +The `dts_connect_param` object supports the following: + +* `group_id` - (Required, String) Id of the Dts consumption group. +* `password` - (Required, String) The password of the Dts consumption group. +* `port` - (Required, Int) Dts port. +* `resource` - (Required, String) Dts instance Id. +* `topic` - (Required, String) Topic subscribed by Dts. +* `user_name` - (Required, String) The account number of the Dts consumption group. +* `is_update` - (Optional, Bool) Whether to update to the associated Datahub task, default: false. + +The `es_connect_param` object supports the following: + +* `password` - (Required, String) Es The password of the connection source. +* `port` - (Required, Int) Es port. +* `resource` - (Required, String) Instance resource of Es connection source. +* `self_built` - (Required, Bool) Whether the Es connection source is a self-built cluster. +* `user_name` - (Required, String) Es The username of the connection source. +* `is_update` - (Optional, Bool) Whether to update to the associated Datahub task, default: false. +* `service_vip` - (Optional, String) The instance vip of the Es connection source, when it is a Tencent Cloud instance, it is required. +* `uniq_vpc_id` - (Optional, String) The vpc Id of the Es connection source, when it is a Tencent Cloud instance, it is required. + +The `kafka_connect_param` object supports the following: + +* `broker_address` - (Optional, String) Kafka broker ip, Mandatory when self-built. +* `is_update` - (Optional, Bool) Whether to update to the associated Dip task, default: false. +* `region` - (Optional, String) CKafka instanceId region, Required when crossing regions. +* `resource` - (Optional, String) Kafka instanceId, When it is a Tencent Cloud instance, it is required. +* `self_built` - (Optional, Bool) Whether it is a self-built cluster, default: false. + +The `mariadb_connect_param` object supports the following: + +* `password` - (Required, String) MariaDB password. +* `port` - (Required, Int) MariaDB port. +* `resource` - (Required, String) MariaDB instanceId. +* `user_name` - (Required, String) MariaDB The username of the connection source. +* `is_update` - (Optional, Bool) Whether to update to the associated Datahub task, default: false. +* `service_vip` - (Optional, String) The instance vip of the Maria DB connection source, when it is a Tencent Cloud instance, it is required. +* `uniq_vpc_id` - (Optional, String) MariaDB vpcId, When it is a Tencent Cloud instance, it is required. + +The `mongodb_connect_param` object supports the following: + +* `password` - (Required, String) Password for the source of the Mongo DB connection. +* `port` - (Required, Int) MongoDB port. +* `resource` - (Required, String) Instance resource of Mongo DB connection source. +* `self_built` - (Required, Bool) Whether the Mongo DB connection source is a self-built cluster. +* `user_name` - (Required, String) The username of the Mongo DB connection source. +* `is_update` - (Optional, Bool) Whether to update to the associated Datahub task, default: false. +* `service_vip` - (Optional, String) The instance VIP of the Mongo DB connection source, when it is a Tencent Cloud instance, it is required. +* `uniq_vpc_id` - (Optional, String) The vpc Id of the Mongo DB connection source, which is required when it is a Tencent Cloud instance. + +The `mysql_connect_param` object supports the following: + +* `password` - (Required, String) Mysql connection source password. +* `port` - (Required, Int) MySQL port. +* `resource` - (Required, String) Instance resource of My SQL connection source. +* `user_name` - (Required, String) Username of Mysql connection source. +* `cluster_id` - (Optional, String) Required when type is TDSQL C_MYSQL. +* `is_update` - (Optional, Bool) Whether to update to the associated Datahub task, default: false. +* `self_built` - (Optional, Bool) Mysql Whether the connection source is a self-built cluster, default: false. +* `service_vip` - (Optional, String) The instance vip of the MySQL connection source, when it is a Tencent Cloud instance, it is required. +* `uniq_vpc_id` - (Optional, String) The vpc Id of the My SQL connection source, when it is a Tencent Cloud instance, it is required. + +The `postgresql_connect_param` object supports the following: + +* `password` - (Required, String) PostgreSQL password. +* `port` - (Required, Int) PostgreSQL port. +* `resource` - (Required, String) PostgreSQL instanceId. +* `user_name` - (Required, String) PostgreSQL The username of the connection source. +* `cluster_id` - (Optional, String) Required when type is TDSQL C_POSTGRESQL. +* `is_update` - (Optional, Bool) Whether to update to the associated Datahub task, default: false. +* `self_built` - (Optional, Bool) PostgreSQL Whether the connection source is a self-built cluster, default: false. +* `service_vip` - (Optional, String) The instance VIP of the Postgresql connection source, when it is a Tencent Cloud instance, it is required. +* `uniq_vpc_id` - (Optional, String) The instance vpcId of the Postgresql connection source, when it is a Tencent Cloud instance, it is required. + +The `sqlserver_connect_param` object supports the following: + +* `password` - (Required, String) SQLServer password. +* `port` - (Required, Int) SQLServer port. +* `resource` - (Required, String) SQLServer instanceId. +* `user_name` - (Required, String) SQLServer The username of the connection source. +* `is_update` - (Optional, Bool) Whether to update to the associated Dip task, default: false. +* `service_vip` - (Optional, String) SQLServer instance vip, When it is a Tencent Cloud instance, it is required. +* `uniq_vpc_id` - (Optional, String) SQLServer vpcId, When it is a Tencent Cloud instance, it is required. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ckafka connect_resource can be imported using the id, e.g. + +``` +terraform import tencentcloud_ckafka_connect_resource.connect_resource connect_resource_id +``` + diff --git a/config/docs/r/ckafka_consumer_group.html.markdown b/config/docs/r/ckafka_consumer_group.html.markdown new file mode 100644 index 0000000..fea130d --- /dev/null +++ b/config/docs/r/ckafka_consumer_group.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_consumer_group" +sidebar_current: "docs-tencentcloud-resource-ckafka_consumer_group" +description: |- + Provides a resource to create a ckafka consumer_group +--- + +# tencentcloud_ckafka_consumer_group + +Provides a resource to create a ckafka consumer_group + +## Example Usage + +```hcl +resource "tencentcloud_ckafka_consumer_group" "consumer_group" { + instance_id = "InstanceId" + group_name = "GroupName" + topic_name_list = ["xxxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_name` - (Required, String, ForceNew) GroupName. +* `instance_id` - (Required, String, ForceNew) InstanceId. +* `topic_name_list` - (Optional, Set: [`String`], ForceNew) array of topic names. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ckafka consumer_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_ckafka_consumer_group.consumer_group consumer_group_id +``` + diff --git a/config/docs/r/ckafka_consumer_group_modify_offset.html.markdown b/config/docs/r/ckafka_consumer_group_modify_offset.html.markdown new file mode 100644 index 0000000..4bc9e10 --- /dev/null +++ b/config/docs/r/ckafka_consumer_group_modify_offset.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_consumer_group_modify_offset" +sidebar_current: "docs-tencentcloud-resource-ckafka_consumer_group_modify_offset" +description: |- + Provides a resource to create a ckafka consumer_group_modify_offset +--- + +# tencentcloud_ckafka_consumer_group_modify_offset + +Provides a resource to create a ckafka consumer_group_modify_offset + +## Example Usage + +```hcl +resource "tencentcloud_ckafka_consumer_group_modify_offset" "consumer_group_modify_offset" { + instance_id = "ckafka-xxxxxx" + group = "xxxxxx" + offset = 0 + strategy = 2 + topics = ["xxxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group` - (Required, String, ForceNew) kafka group. +* `instance_id` - (Required, String, ForceNew) Kafka instance id. +* `strategy` - (Required, Int, ForceNew) Reset the policy of offset. +`0`: Move the offset forward or backward shift bar; +`1`: Alignment reference (by-duration,to-datetime,to-earliest,to-latest), which means moving the offset to the location of the specified timestamp; +`2`: Alignment reference (to-offset), which means to move the offset to the specified offset location. +* `offset` - (Optional, Int, ForceNew) The offset location that needs to be reset. When strategy is 2, this field must be included. +* `partitions` - (Optional, Set: [`Int`], ForceNew) The list of partition that needs to be reset if no Topics parameter is specified. Resets the partition in the corresponding Partition list of all topics. When Topics is specified, the partition of the corresponding topic list of the specified Partitions list is reset. +* `shift_timestamp` - (Optional, Int, ForceNew) Unit ms. When strategy is 1, you must include this field, where-2 means to reset the offset to the beginning,-1 means to reset to the latest position (equivalent to emptying), and other values represent the specified time. You will get the offset of the specified time in the topic and then reset it. If there is no message at the specified time, get the last offset. +* `shift` - (Optional, Int, ForceNew) This field must be included when strategy is 0. If it is greater than zero, the offset will be moved backward by shift bars, and if it is less than zero, the offset will be traced back to the number of shift entries. After the correct reset, the new offset should be (old_offset + shift). It should be noted that if the new offset is less than partition's earliest, it will be set to earliest, and if the latest greater than partition will be set to latest. +* `topics` - (Optional, Set: [`String`], ForceNew) Indicates the topics that needs to be reset. Leave it empty means all. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ckafka_datahub_task.html.markdown b/config/docs/r/ckafka_datahub_task.html.markdown new file mode 100644 index 0000000..d5d6261 --- /dev/null +++ b/config/docs/r/ckafka_datahub_task.html.markdown @@ -0,0 +1,681 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_datahub_task" +sidebar_current: "docs-tencentcloud-resource-ckafka_datahub_task" +description: |- + Provides a resource to create a ckafka datahub_task +--- + +# tencentcloud_ckafka_datahub_task + +Provides a resource to create a ckafka datahub_task + +## Example Usage + +```hcl +resource "tencentcloud_ckafka_datahub_task" "datahub_task" { + task_name = "test-task123321" + task_type = "SOURCE" + source_resource { + type = "POSTGRESQL" + postgre_sql_param { + database = "postgres" + table = "*" + resource = "resource-y9nxnw46" + plugin_name = "decoderbufs" + snapshot_mode = "never" + is_table_regular = false + key_columns = "" + record_with_schema = false + } + } + target_resource { + type = "TOPIC" + topic_param { + compression_type = "none" + resource = "1308726196-keep-topic" + use_auto_create_topic = false + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `task_name` - (Required, String) name of the task. +* `task_type` - (Required, String, ForceNew) type of the task, SOURCE(data input), SINK(data output). +* `schema_id` - (Optional, String, ForceNew) SchemaId. +* `source_resource` - (Optional, List, ForceNew) data resource. +* `target_resource` - (Optional, List, ForceNew) Target Resource. +* `transform_param` - (Optional, List, ForceNew) Data Processing Rules. +* `transforms_param` - (Optional, List, ForceNew) Data processing rules. + +The `analyse_result` object supports the following: + +* `key` - (Required, String) KEY. +* `operate` - (Required, String) Operation, DATE system preset - timestamp, CUSTOMIZE customization, MAPPING mapping, JSONPATH. +* `scheme_type` - (Required, String) data type, ORIGINAL, STRING, INT64, FLOAT64, BOOLEAN, MAP, ARRAY. +* `original_value` - (Optional, String) OriginalValue. +* `value_operate` - (Optional, List) VALUE process. +* `value_operates` - (Optional, List) VALUE process chain. +* `value` - (Optional, String) VALUE. + +The `analyse_result` object supports the following: + +* `key` - (Required, String) key. +* `type` - (Optional, String) Type, DEFAULT default, DATE system default - timestamp, CUSTOMIZE custom, MAPPING mapping. +* `value` - (Optional, String) value. + +The `analyse` object supports the following: + +* `format` - (Required, String) Parsing format, JSON, DELIMITER delimiter, REGULAR regular extraction, SOURCE processing all results of the upper layer. +* `input_value_type` - (Optional, String) KEY to be processed again - mode. +* `input_value` - (Optional, String) KEY to be processed again - KEY expression. +* `regex` - (Optional, String) delimiter, regular expression. + +The `batch_analyse` object supports the following: + +* `format` - (Required, String) ONE BY ONE single output, MERGE combined output. + +The `click_house_param` object supports the following: + +* `cluster` - (Required, String) ClickHouse cluster. +* `database` - (Required, String) ClickHouse database name. +* `resource` - (Required, String) resource id. +* `schema` - (Required, List) ClickHouse schema. +* `table` - (Required, String) ClickHouse table. +* `drop_cls` - (Optional, List) When the member parameter Drop Invalid Message To Cls is set to true, the Drop Invalid Message parameter is invalid. +* `drop_invalid_message` - (Optional, Bool) Whether ClickHouse discards the message that fails to parse, the default is true. +* `ip` - (Optional, String) ClickHouse ip. +* `password` - (Optional, String) ClickHouse passwd. +* `port` - (Optional, Int) ClickHouse port. +* `self_built` - (Optional, Bool) Whether it is a self-built cluster. +* `service_vip` - (Optional, String) instance vip. +* `type` - (Optional, String) ClickHouse type, emr-clickhouse: emr;cdw-clickhouse: cdwch; selfBuilt: ``. +* `uniq_vpc_id` - (Optional, String) instance vpc id. +* `user_name` - (Optional, String) ClickHouse user name. + +The `click_house_param` object supports the following: + +* `cluster` - (Required, String) ClickHouse cluster. +* `database` - (Required, String) ClickHouse database name. +* `resource` - (Required, String) resource id. +* `schema` - (Required, List) ClickHouse schema. +* `table` - (Required, String) ClickHouse table. +* `drop_cls` - (Optional, List) When the member parameter Drop Invalid Message To Cls is set to true, the Drop Invalid Message parameter is invalid. +* `drop_invalid_message` - (Optional, Bool) Whether ClickHouse discards the message that fails to parse, the default is true. +* `ip` - (Optional, String) ClickHouse ip. +* `password` - (Optional, String) ClickHouse passwd. +* `port` - (Optional, Int) ClickHouse port. +* `self_built` - (Optional, Bool) Whether it is a self-built cluster. +* `service_vip` - (Optional, String) instance vip. +* `type` - (Optional, String) ClickHouse type, emr-clickhouse: emr;cdw-clickhouse: cdwch;selfBuilt: ``. +* `uniq_vpc_id` - (Optional, String) instance vpc id. +* `user_name` - (Optional, String) ClickHouse user name. + +The `cls_param` object supports the following: + +* `decode_json` - (Required, Bool) Whether the produced information is in json format. +* `resource` - (Required, String) cls id. +* `content_key` - (Optional, String) Required when Decode Json is false. +* `log_set` - (Optional, String) LogSet id. +* `time_field` - (Optional, String) Specify the content of a field in the message as the time of the cls log. The format of the field content needs to be a second-level timestamp. + +The `cos_param` object supports the following: + +* `bucket_name` - (Required, String) cos bucket name. +* `region` - (Required, String) region code. +* `aggregate_batch_size` - (Optional, Int) The size of aggregated messages MB. +* `aggregate_interval` - (Optional, Int) time interval. +* `directory_time_format` - (Optional, String) Partition format formatted according to strptime time. +* `format_output_type` - (Optional, String) The file format after message aggregation csv|json. +* `object_key_prefix` - (Optional, String) Dumped object directory prefix. +* `object_key` - (Optional, String) ObjectKey. + +The `ctsdb_param` object supports the following: + +* `ctsdb_metric` - (Optional, String) Ctsdb metric. +* `resource` - (Optional, String) resource id. + +The `data_target_record_mapping` object supports the following: + +* `allow_null` - (Optional, Bool) Whether the message is allowed to be empty. +* `auto_increment` - (Optional, Bool) Whether it is an auto-increment column. +* `column_name` - (Optional, String) Column Name. +* `column_size` - (Optional, String) current ColumnSize. +* `decimal_digits` - (Optional, String) current Column DecimalDigits. +* `default_value` - (Optional, String) Database table default parameters. +* `extra_info` - (Optional, String) Database table extra fields. +* `json_key` - (Optional, String) The key name of the message. +* `type` - (Optional, String) message type. + +The `data_target_record_mapping` object supports the following: + +* `allow_null` - (Optional, Bool) Whether the message is allowed to be empty. +* `auto_increment` - (Optional, Bool) Whether it is an auto-increment column. +* `column_name` - (Optional, String) Corresponding mapping column name. +* `column_size` - (Optional, String) current column size. +* `decimal_digits` - (Optional, String) current column precision. +* `default_value` - (Optional, String) Database table default parameters. +* `extra_info` - (Optional, String) Database table extra fields. +* `json_key` - (Optional, String) The key name of the message. +* `type` - (Optional, String) message type. + +The `date` object supports the following: + +* `format` - (Optional, String) Time format. +* `target_type` - (Optional, String) input type, string|unix. +* `time_zone` - (Optional, String) default GMT+8. + +The `drop_cls` object supports the following: + +* `drop_cls_log_set` - (Optional, String) cls LogSet id. +* `drop_cls_owneruin` - (Optional, String) account. +* `drop_cls_region` - (Optional, String) The region where the cls is delivered. +* `drop_cls_topic_id` - (Optional, String) cls topic. +* `drop_invalid_message_to_cls` - (Optional, Bool) Whether to deliver to cls. + +The `drop_cls` object supports the following: + +* `drop_cls_log_set` - (Optional, String) cls LogSet id. +* `drop_cls_owneruin` - (Optional, String) cls account. +* `drop_cls_region` - (Optional, String) cls region. +* `drop_cls_topic_id` - (Optional, String) cls topicId. +* `drop_invalid_message_to_cls` - (Optional, Bool) Whether to deliver to cls. + +The `drop_cls` object supports the following: + +* `drop_cls_log_set` - (Optional, String) cls log set. +* `drop_cls_owneruin` - (Optional, String) Delivery account of cls. +* `drop_cls_region` - (Optional, String) The region where the cls is delivered. +* `drop_cls_topic_id` - (Optional, String) topic of cls. +* `drop_invalid_message_to_cls` - (Optional, Bool) Whether to deliver to cls. + +The `drop_dlq` object supports the following: + +* `type` - (Required, String) type, DLQ dead letter queue, IGNORE_ERROR|DROP. +* `dlq_type` - (Optional, String) dlq type, CKAFKA|TOPIC. +* `kafka_param` - (Optional, List) Ckafka type dlq. +* `max_retry_attempts` - (Optional, Int) retry times. +* `retry_interval` - (Optional, Int) retry interval. +* `topic_param` - (Optional, List) DIP Topic type dead letter queue. + +The `dts_param` object supports the following: + +* `resource` - (Required, String) Dts instance Id. +* `group_id` - (Optional, String) Dts consumer group Id. +* `group_password` - (Optional, String) Dts consumer group passwd. +* `group_user` - (Optional, String) Dts account. +* `ip` - (Optional, String) Dts connection ip. +* `port` - (Optional, Int) Dts connection port. +* `topic` - (Optional, String) Dts topic. +* `tran_sql` - (Optional, Bool) False to synchronize the original data, true to synchronize the parsed json format data, the default is true. + +The `es_param` object supports the following: + +* `resource` - (Required, String) Resource. +* `content_key` - (Optional, String) key for data in non-json format. +* `database_primary_key` - (Optional, String) When the message dumped to ES is the binlog of Database, if you need to synchronize database operations, that is, fill in the primary key of the database table when adding, deleting, and modifying operations to ES. +* `date_format` - (Optional, String) Es date suffix. +* `document_id_field` - (Optional, String) The field name of the document ID value dumped into Es. +* `drop_cls` - (Optional, List) When the member parameter Drop Invalid Message To Cls is set to true, the Drop Invalid Message parameter is invalid. +* `drop_dlq` - (Optional, List) dead letter queue. +* `drop_invalid_json_message` - (Optional, Bool) Whether Es discards messages in non-json format. +* `drop_invalid_message` - (Optional, Bool) Whether Es discards the message of parsing failure. +* `index_type` - (Optional, String) Es custom index name type, STRING, JSONPATH, the default is STRING. +* `index` - (Optional, String) Es index name. +* `password` - (Optional, String) Es Password. +* `port` - (Optional, Int) Es connection port. +* `self_built` - (Optional, Bool) Whether it is a self-built cluster. +* `service_vip` - (Optional, String) instance vip. +* `uniq_vpc_id` - (Optional, String) instance vpc id. +* `user_name` - (Optional, String) Es UserName. + +The `event_bus_param` object supports the following: + +* `resource` - (Required, String) instance id. +* `self_built` - (Required, Bool) Whether it is a self-built cluster. +* `type` - (Required, String) resource type, EB_COS/EB_ES/EB_CLS. +* `function_name` - (Optional, String) SCF function name. +* `namespace` - (Optional, String) SCF namespace. +* `qualifier` - (Optional, String) SCF version and alias. + +The `event_bus_param` object supports the following: + +* `resource` - (Required, String) instance id. +* `self_built` - (Required, Bool) Whether it is a self-built cluster. +* `type` - (Required, String) resource type. EB_COS/EB_ES/EB_CLS. +* `function_name` - (Optional, String) SCF function name. +* `namespace` - (Optional, String) SCF namespace. +* `qualifier` - (Optional, String) SCF version and alias. + +The `failure_param` object supports the following: + +* `type` - (Required, String) type, DLQ dead letter queue, IGNORE_ERROR|DROP. +* `dlq_type` - (Optional, String) dlq type, CKAFKA|TOPIC. +* `kafka_param` - (Optional, List) Ckafka type dlq. +* `max_retry_attempts` - (Optional, Int) retry times. +* `retry_interval` - (Optional, Int) retry interval. +* `topic_param` - (Optional, List) DIP Topic type dead letter queue. + +The `field_chain` object supports the following: + +* `analyse` - (Required, List) analyze. +* `analyse_json_result` - (Optional, String) Parsing results in JSON format. +* `analyse_result` - (Optional, List) Analysis result. +* `result` - (Optional, String) Test Results. +* `s_m_t` - (Optional, List) data processing. +* `secondary_analyse_json_result` - (Optional, String) Secondary parsing results in JSON format. +* `secondary_analyse_result` - (Optional, List) Secondary Analysis Results. +* `secondary_analyse` - (Optional, List) secondary analysis. + +The `filter_param` object supports the following: + +* `key` - (Required, String) Key. +* `match_mode` - (Required, String) Matching mode, prefix matches PREFIX, suffix matches SUFFIX, contains matches CONTAINS, except matches EXCEPT, value matches NUMBER, IP matches IP. +* `value` - (Required, String) Value. +* `type` - (Optional, String) REGULAR. + +The `json_path_replace` object supports the following: + +* `new_value` - (Required, String) Replacement value, Jsonpath expression or string. +* `old_value` - (Required, String) Replaced value, Jsonpath expression. + +The `k_v` object supports the following: + +* `delimiter` - (Required, String) delimiter. +* `regex` - (Required, String) Key-value secondary analysis delimiter. +* `keep_original_key` - (Optional, String) Keep the source Key, the default is false not to keep. + +The `kafka_param` object supports the following: + +* `resource` - (Required, String) instance resource. +* `self_built` - (Required, Bool) whether the cluster is built by yourself instead of cloud product. +* `compression_type` - (Optional, String) Whether to compress when writing to the Topic, if it is not enabled, fill in none, if it is enabled, fill in open. +* `enable_toleration` - (Optional, Bool) enable dead letter queue. +* `msg_multiple` - (Optional, Int) 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). +* `offset_type` - (Optional, String) Offset type, from beginning:earliest, from latest:latest, from specific time:timestamp. +* `partition_num` - (Optional, Int) the partition num of the topic. +* `qps_limit` - (Optional, Int) Qps(query per seconds) limit. +* `resource_name` - (Optional, String) instance name. +* `start_time` - (Optional, Int) when Offset type timestamp is required. +* `table_mappings` - (Optional, List) maps of table to topic, required when multi topic is selected. +* `topic_id` - (Optional, String) Topic id. +* `topic` - (Optional, String) Topic name, use `,` when more than 1 topic. +* `use_auto_create_topic` - (Optional, Bool) Does the used topic need to be automatically created (currently only supports SOURCE inflow tasks, if you do not use to distribute to multiple topics, you need to fill in the topic name that needs to be automatically created in the Topic field). +* `use_table_mapping` - (Optional, Bool) whether to use multi table. +* `zone_id` - (Optional, Int) Zone ID. + +The `kafka_param` object supports the following: + +* `resource` - (Required, String) resource id. +* `self_built` - (Required, Bool) Whether it is a self-built cluster. +* `compression_type` - (Optional, String) Whether to compress when writing to the Topic, if it is not enabled, fill in none, if it is enabled, fill in open. +* `enable_toleration` - (Optional, Bool) Enable the fault-tolerant instance and enable the dead-letter queue. +* `msg_multiple` - (Optional, Int) 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). +* `offset_type` - (Optional, String) Offset type, initial position earliest, latest position latest, time point position timestamp. +* `partition_num` - (Optional, Int) Partition num. +* `qps_limit` - (Optional, Int) Qps limit. +* `resource_name` - (Optional, String) resource id name. +* `start_time` - (Optional, Int) It must be passed when the Offset type is timestamp, and the time stamp is passed, accurate to the second. +* `table_mappings` - (Optional, List) The route from Table to Topic must be passed when the Distribute to multiple topics switch is turned on. +* `topic_id` - (Optional, String) Topic Id. +* `topic` - (Optional, String) Topic name, multiple separated by `,`. +* `use_auto_create_topic` - (Optional, Bool) whether the used topic need to be automatically created (currently only supports SOURCE inflow tasks, if you do not use to distribute to multiple topics, you need to fill in the topic name that needs to be automatically created in the Topic field). +* `use_table_mapping` - (Optional, Bool) Distribute to multiple topics switch, the default is false. +* `zone_id` - (Optional, Int) Zone ID. + +The `kafka_param` object supports the following: + +* `resource` - (Required, String) resource id. +* `self_built` - (Required, Bool) Whether it is a self-built cluster. +* `compression_type` - (Optional, String) Whether to compress when writing to the Topic, if it is not enabled, fill in none, if it is enabled, fill in open. +* `enable_toleration` - (Optional, Bool) Enable the fault-tolerant instance and enable the dead-letter queue. +* `msg_multiple` - (Optional, Int) 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). +* `offset_type` - (Optional, String) Offset type, initial position earliest, latest position latest, time point position timestamp. +* `partition_num` - (Optional, Int) Partition num. +* `qps_limit` - (Optional, Int) Qps limit. +* `resource_name` - (Optional, String) resource id name. +* `start_time` - (Optional, Int) It must be passed when the Offset type is timestamp, and the time stamp is passed, accurate to the second. +* `table_mappings` - (Optional, List) The route from Table to Topic must be passed when the Distribute to multiple topics switch is turned on. +* `topic_id` - (Optional, String) Topic Id. +* `topic` - (Optional, String) Topic name, multiple separated by,. +* `use_auto_create_topic` - (Optional, Bool) whether the used topic need to be automatically created (currently only supports SOURCE inflow tasks, if you do not use to distribute to multiple topics, you need to fill in the topic name that needs to be automatically created in the Topic field). +* `use_table_mapping` - (Optional, Bool) Distribute to multiple topics switch, the default is false. +* `zone_id` - (Optional, Int) Zone ID. + +The `map_param` object supports the following: + +* `key` - (Required, String) key. +* `type` - (Optional, String) Type, DEFAULT default, DATE system default - timestamp, CUSTOMIZE custom, MAPPING mapping. +* `value` - (Optional, String) value. + +The `maria_db_param` object supports the following: + +* `database` - (Required, String) MariaDB database name, * for all database. +* `resource` - (Required, String) MariaDB connection Id. +* `table` - (Required, String) MariaDB db name, *is the non-system table in all the monitored databases, you can use, to monitor multiple data tables, but the data table needs to be filled in the format of data database name.data table name. +* `include_content_changes` - (Optional, String) If the value is all, DDL data and DML data will also be written to the selected topic; if the value is dml, only DML data will be written to the selected topic. +* `include_query` - (Optional, Bool) If the value is true, and the value of the binlog rows query log events configuration item in My SQL is ON, the data flowing into the topic contains the original SQL statement; if the value is false, the data flowing into the topic does not contain Original SQL statement. +* `is_table_prefix` - (Optional, Bool) When the Table input is a prefix, the value of this item is true, otherwise it is false. +* `key_columns` - (Optional, String) Format library 1. table 1: field 1, field 2; library 2. table 2: field 2, between tables; (semicolon) separated, between fields, (comma) separated. The table that is not specified defaults to the primary key of the table. +* `output_format` - (Optional, String) output format, DEFAULT, CANAL_1, CANAL_2. +* `record_with_schema` - (Optional, Bool) If the value is true, the message will carry the schema corresponding to the message structure, if the value is false, it will not carry. +* `snapshot_mode` - (Optional, String) schema_only|initial, default initial. + +The `mongo_db_param` object supports the following: + +* `collection` - (Required, String) MongoDB collection. +* `copy_existing` - (Required, Bool) Whether to copy the stock data, the default parameter is true. +* `database` - (Required, String) MongoDB database name. +* `resource` - (Required, String) resource id. +* `ip` - (Optional, String) Mongo DB connection ip. +* `listening_event` - (Optional, String) Listening event type, if it is empty, it means select all. Values include insert, update, replace, delete, invalidate, drop, dropdatabase, rename, used between multiple types, separated by commas. +* `password` - (Optional, String) MongoDB database password. +* `pipeline` - (Optional, String) aggregation pipeline. +* `port` - (Optional, Int) MongoDB connection port. +* `read_preference` - (Optional, String) Master-slave priority, default master node. +* `self_built` - (Optional, Bool) Whether it is a self-built cluster. +* `user_name` - (Optional, String) MongoDB database user name. + +The `my_sql_param` object supports the following: + +* `database` - (Required, String) MySQL database name, * is the whole database. +* `resource` - (Required, String) MySQL connection Id. +* `table` - (Required, String) The name of the MySQL data table, is the non-system table in all the monitored databases, which can be separated by, to monitor multiple data tables, but the data table needs to be filled in the format of data database name.data table name, when a regular expression needs to be filled in, the format is data database name.data table name. +* `data_source_increment_column` - (Optional, String) The name of the column to be monitored. +* `data_source_increment_mode` - (Optional, String) TIMESTAMP indicates that the incremental column is of timestamp type, INCREMENT indicates that the incremental column is of self-incrementing id type'. +* `data_source_monitor_mode` - (Optional, String) TABLE indicates that the read item is a table, QUERY indicates that the read item is a query. +* `data_source_monitor_resource` - (Optional, String) When DataMonitorMode=TABLE, pass in the Table that needs to be read; when DataMonitorMode=QUERY, pass in the query sql statement that needs to be read. +* `data_source_start_from` - (Optional, String) HEAD means copy stock + incremental data, TAIL means copy only incremental data. +* `data_target_insert_mode` - (Optional, String) INSERT means insert using Insert mode, UPSERT means insert using Upsert mode. +* `data_target_primary_key_field` - (Optional, String) When DataInsertMode=UPSERT, pass in the primary key that the current upsert depends on. +* `data_target_record_mapping` - (Optional, List) Mapping relationship between tables and messages. +* `ddl_topic` - (Optional, String) The Topic that stores the Ddl information of My SQL, if it is empty, it will not be stored by default. +* `drop_cls` - (Optional, List) When the member parameter Drop Invalid Message To Cls is set to true, the Drop Invalid Message parameter is invalid. +* `drop_invalid_message` - (Optional, Bool) Whether to discard messages that fail to parse, the default is true. +* `include_content_changes` - (Optional, String) If the value is all, DDL data and DML data will also be written to the selected topic; if the value is dml, only DML data will be written to the selected topic. +* `include_query` - (Optional, Bool) If the value is true, and the value of the binlog rows query log events configuration item in My SQL is ON, the data flowing into the topic contains the original SQL statement; if the value is false, the data flowing into the topic does not contain Original SQL statement. +* `is_table_prefix` - (Optional, Bool) When the Table input is a prefix, the value of this item is true, otherwise it is false. +* `is_table_regular` - (Optional, Bool) Whether the input table is a regular expression, if this option and Is Table Prefix are true at the same time, the judgment priority of this option is higher than Is Table Prefix. +* `key_columns` - (Optional, String) Format library1.table1 field 1,field 2;library 2.table2 field 2, between tables; (semicolon) separated, between fields, (comma) separated. The table that is not specified defaults to the primary key of the table. +* `output_format` - (Optional, String) output format, DEFAULT, CANAL_1, CANAL_2. +* `record_with_schema` - (Optional, Bool) If the value is true, the message will carry the schema corresponding to the message structure, if the value is false, it will not carry. +* `signal_database` - (Optional, String) database name of signal table. +* `snapshot_mode` - (Optional, String) whether to Copy inventory information (schema_only does not copy, initial full amount), the default is initial. +* `topic_regex` - (Optional, String) Regular expression for routing events to specific topics, defaults to (.*). +* `topic_replacement` - (Optional, String) TopicRegex, $1, $2. + +The `my_sql_param` object supports the following: + +* `database` - (Required, String) MySQL database name, * is the whole database. +* `resource` - (Required, String) MySQL connection Id. +* `table` - (Required, String) The name of the MySQL data table, is the non-system table in all the monitored databases, which can be separated by, to monitor multiple data tables, but the data table needs to be filled in the format of data database name.data table name, when a regular expression needs to be filled in, the format is data database name.data table name. +* `data_source_increment_column` - (Optional, String) the name of the column to be monitored. +* `data_source_increment_mode` - (Optional, String) TIMESTAMP indicates that the incremental column is of timestamp type, INCREMENT indicates that the incremental column is of self-incrementing id type. +* `data_source_monitor_mode` - (Optional, String) TABLE indicates that the read item is a table, QUERY indicates that the read item is a query. +* `data_source_monitor_resource` - (Optional, String) When DataMonitorMode=TABLE, pass in the Table that needs to be read; when DataMonitorMode=QUERY, pass in the query sql statement that needs to be read. +* `data_source_start_from` - (Optional, String) HEAD means copy stock + incremental data, TAIL means copy only incremental data. +* `data_target_insert_mode` - (Optional, String) INSERT means insert using Insert mode, UPSERT means insert using Upsert mode. +* `data_target_primary_key_field` - (Optional, String) When DataInsertMode=UPSERT, pass in the primary key that the current upsert depends on. +* `data_target_record_mapping` - (Optional, List) Mapping relationship between tables and messages. +* `ddl_topic` - (Optional, String) The Topic that stores the Ddl information of My SQL, if it is empty, it will not be stored by default. +* `drop_cls` - (Optional, List) When the member parameter Drop Invalid Message To Cls is set to true, the Drop Invalid Message parameter is invalid. +* `drop_invalid_message` - (Optional, Bool) Whether to discard messages that fail to parse, the default is true. +* `include_content_changes` - (Optional, String) If the value is all, DDL data and DML data will also be written to the selected topic; if the value is dml, only DML data will be written to the selected topic. +* `include_query` - (Optional, Bool) If the value is true, and the value of the binlog rows query log events configuration item in My SQL is ON, the data flowing into the topic contains the original SQL statement; if the value is false, the data flowing into the topic does not contain Original SQL statement. +* `is_table_prefix` - (Optional, Bool) When the Table input is a prefix, the value of this item is true, otherwise it is false. +* `is_table_regular` - (Optional, Bool) Whether the input table is a regular expression, if this option and Is Table Prefix are true at the same time, the judgment priority of this option is higher than Is Table Prefix. +* `key_columns` - (Optional, String) Format library1.table1 field 1,field 2;library 2.table2 field 2, between tables; (semicolon) separated, between fields, (comma) separated. The table that is not specified defaults to the primary key of the table. +* `output_format` - (Optional, String) output format, DEFAULT, CANAL_1, CANAL_2. +* `record_with_schema` - (Optional, Bool) If the value is true, the message will carry the schema corresponding to the message structure, if the value is false, it will not carry. +* `signal_database` - (Optional, String) database name of signal table. +* `snapshot_mode` - (Optional, String) whether to Copy inventory information (schema_only does not copy, initial full amount), the default is initial. +* `topic_regex` - (Optional, String) Regular expression for routing events to specific topics, defaults to (.*). +* `topic_replacement` - (Optional, String) TopicRegex, $1, $2. + +The `postgre_sql_param` object supports the following: + +* `database` - (Required, String) PostgreSQL database name. +* `plugin_name` - (Required, String) (decoderbufs/pgoutput), default decoderbufs. +* `resource` - (Required, String) PostgreSQL connection Id. +* `table` - (Required, String) PostgreSQL tableName, * is the non-system table in all the monitored databases, you can use, to monitor multiple data tables, but the data table needs to be filled in the format of Schema name.Data table name, and you need to fill in a regular expression When, the format is Schema name.data table name. +* `data_format` - (Optional, String) Upstream data format (JSON|Debezium), required when the database synchronization mode matches the default field. +* `data_target_insert_mode` - (Optional, String) INSERT means insert using Insert mode, UPSERT means insert using Upsert mode. +* `data_target_primary_key_field` - (Optional, String) When DataInsertMode=UPSERT, pass in the primary key that the current upsert depends on. +* `data_target_record_mapping` - (Optional, List) Mapping relationship between tables and messages. +* `drop_invalid_message` - (Optional, Bool) Whether to discard messages that fail to parse, the default is true. +* `is_table_regular` - (Optional, Bool) Whether the input table is a regular expression. +* `key_columns` - (Optional, String) Format library1.table1:field 1,field2;library2.table2:field2, between tables; (semicolon) separated, between fields, (comma) separated. The table that is not specified defaults to the primary key of the table. +* `record_with_schema` - (Optional, Bool) If the value is true, the message will carry the schema corresponding to the message structure, if the value is false, it will not carry. +* `snapshot_mode` - (Optional, String) never|initial, default initial. + +The `regex_replace` object supports the following: + +* `new_value` - (Required, String) new value. +* `regex` - (Required, String) Regular. + +The `replace` object supports the following: + +* `new_value` - (Required, String) new value. +* `old_value` - (Required, String) been replaced value. + +The `row_param` object supports the following: + +* `row_content` - (Required, String) row content, KEY_VALUE, VALUE. +* `entry_delimiter` - (Optional, String) delimiter. +* `key_value_delimiter` - (Optional, String) key, value delimiter. + +The `s_m_t` object supports the following: + +* `key` - (Required, String) KEY. +* `operate` - (Required, String) Operation, DATE system preset - timestamp, CUSTOMIZE customization, MAPPING mapping, JSONPATH. +* `scheme_type` - (Required, String) data type, ORIGINAL, STRING, INT64, FLOAT64, BOOLEAN, MAP, ARRAY. +* `original_value` - (Optional, String) OriginalValue. +* `value_operate` - (Optional, List) VALUE process. +* `value_operates` - (Optional, List) VALUE process chain. +* `value` - (Optional, String) VALUE. + +The `scf_param` object supports the following: + +* `function_name` - (Required, String) SCF function name. +* `batch_size` - (Optional, Int) The maximum number of messages sent in each batch, the default is 1000. +* `max_retries` - (Optional, Int) The number of retries after the SCF call fails, the default is 5. +* `namespace` - (Optional, String) SCF cloud function namespace, the default is default. +* `qualifier` - (Optional, String) SCF cloud function version and alias, the default is DEFAULT. + +The `schema` object supports the following: + +* `allow_null` - (Required, Bool) Whether the column item is allowed to be empty. +* `column_name` - (Required, String) column name. +* `json_key` - (Required, String) The json Key name corresponding to this column. +* `type` - (Required, String) type of table column. + +The `secondary_analyse_result` object supports the following: + +* `key` - (Required, String) KEY. +* `operate` - (Required, String) Operation, DATE system preset - timestamp, CUSTOMIZE customization, MAPPING mapping, JSONPATH. +* `scheme_type` - (Required, String) data type, ORIGINAL, STRING, INT64, FLOAT64, BOOLEAN, MAP, ARRAY. +* `original_value` - (Optional, String) OriginalValue. +* `value_operate` - (Optional, List) VALUE process. +* `value_operates` - (Optional, List) VALUE process chain. +* `value` - (Optional, String) VALUE. + +The `secondary_analyse` object supports the following: + +* `regex` - (Required, String) delimiter. + +The `source_resource` object supports the following: + +* `type` - (Required, String) resource type. +* `click_house_param` - (Optional, List) ClickHouse config, Type CLICKHOUSE requierd. +* `cls_param` - (Optional, List) Cls configuration, Required when Type is CLS. +* `cos_param` - (Optional, List) Cos configuration, required when Type is COS. +* `ctsdb_param` - (Optional, List) Ctsdb configuration, Required when Type is CTSDB. +* `dts_param` - (Optional, List) Dts configuration, required when Type is DTS. +* `es_param` - (Optional, List) Es configuration, required when Type is ES. +* `event_bus_param` - (Optional, List) EB configuration, required when type is EB. +* `kafka_param` - (Optional, List) ckafka configuration, required when Type is KAFKA. +* `maria_db_param` - (Optional, List) MariaDB configuration, Required when Type is MARIADB. +* `mongo_db_param` - (Optional, List) MongoDB config, Required when Type is MONGODB. +* `my_sql_param` - (Optional, List) MySQL configuration, Required when Type is MYSQL. +* `postgre_sql_param` - (Optional, List) PostgreSQL configuration, Required when Type is POSTGRESQL or TDSQL C_POSTGRESQL. +* `scf_param` - (Optional, List) Scf configuration, Required when Type is SCF. +* `sql_server_param` - (Optional, List) SQLServer configuration, Required when Type is SQLSERVER. +* `tdw_param` - (Optional, List) Tdw configuration, required when Type is TDW. +* `topic_param` - (Optional, List) Topic configuration, Required when Type is Topic. + +The `split` object supports the following: + +* `regex` - (Required, String) delimiter. + +The `sql_server_param` object supports the following: + +* `database` - (Required, String) SQLServer database name. +* `resource` - (Required, String) SQLServer connection Id. +* `table` - (Required, String) SQLServer table, *is the non-system table in all the monitored databases, you can use, to monitor multiple data tables, but the data table needs to be filled in the format of data database name.data table name. +* `snapshot_mode` - (Optional, String) schema_only|initial default initial. + +The `substr` object supports the following: + +* `end` - (Required, Int) cut-off position. +* `start` - (Required, Int) interception starting position. + +The `table_mappings` object supports the following: + +* `database` - (Required, String) database name. +* `table` - (Required, String) Table name, multiple tables, separated by (commas). +* `topic_id` - (Required, String) Topic ID. +* `topic` - (Required, String) Topic name. + +The `table_mappings` object supports the following: + +* `database` - (Required, String) database name. +* `table` - (Required, String) table name,use, to separate. +* `topic_id` - (Required, String) Topic ID. +* `topic` - (Required, String) Topic name. + +The `target_resource` object supports the following: + +* `type` - (Required, String) Resource Type. +* `click_house_param` - (Optional, List) ClickHouse config, Type CLICKHOUSE requierd. +* `cls_param` - (Optional, List) Cls configuration, Required when Type is CLS. +* `cos_param` - (Optional, List) Cos configuration, required when Type is COS. +* `ctsdb_param` - (Optional, List) Ctsdb configuration, Required when Type is CTSDB. +* `dts_param` - (Optional, List) Dts configuration, required when Type is DTS. +* `es_param` - (Optional, List) Es configuration, required when Type is ES. +* `event_bus_param` - (Optional, List) EB configuration, required when type is EB. +* `kafka_param` - (Optional, List) ckafka configuration, required when Type is KAFKA. +* `maria_db_param` - (Optional, List) MariaDB configuration, Required when Type is MARIADB. +* `mongo_db_param` - (Optional, List) MongoDB config, Required when Type is MONGODB. +* `my_sql_param` - (Optional, List) MySQL configuration, Required when Type is MYSQL. +* `postgre_sql_param` - (Optional, List) PostgreSQL configuration, Required when Type is POSTGRESQL or TDSQL C_POSTGRESQL. +* `scf_param` - (Optional, List) Scf configuration, Required when Type is SCF. +* `sql_server_param` - (Optional, List) SQLServer configuration, Required when Type is SQLSERVER. +* `tdw_param` - (Optional, List) Tdw configuration, required when Type is TDW. +* `topic_param` - (Optional, List) Topic configuration, Required when Type is Topic. + +The `tdw_param` object supports the following: + +* `bid` - (Required, String) Tdw bid. +* `tid` - (Required, String) Tdw tid. +* `is_domestic` - (Optional, Bool) default true. +* `tdw_host` - (Optional, String) TDW address, defalt tl-tdbank-tdmanager.tencent-distribute.com. +* `tdw_port` - (Optional, Int) TDW port, default 8099. + +The `topic_param` object supports the following: + +* `resource` - (Required, String) The topic name of the topic sold separately. +* `compression_type` - (Optional, String) Whether to perform compression when writing a topic, if it is not enabled, fill in none, if it is enabled, you can choose one of gzip, snappy, lz4 to fill in. +* `msg_multiple` - (Optional, Int) 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). +* `offset_type` - (Optional, String) Offset type, initial position earliest, latest position latest, time point position timestamp. +* `start_time` - (Optional, Int) It must be passed when the Offset type is timestamp, and the time stamp is passed, accurate to the second. +* `topic_id` - (Optional, String) Topic TopicId. +* `use_auto_create_topic` - (Optional, Bool) whether the used topic need to be automatically created (currently only supports SOURCE inflow tasks). + +The `topic_param` object supports the following: + +* `resource` - (Required, String) The topic name of the topic sold separately. +* `compression_type` - (Optional, String) Whether to perform compression when writing a topic, if it is not enabled, fill in none, if it is enabled, you can choose one of gzip, snappy, lz4 to fill in. +* `msg_multiple` - (Optional, Int) 1 source topic message is amplified into msg Multiple and written to the target topic (this parameter is currently only applicable to ckafka flowing into ckafka). +* `offset_type` - (Optional, String) Offset type, initial position earliest, latest position latest, time point position timestamp. +* `start_time` - (Optional, Int) It must be passed when the Offset type is timestamp, and the time stamp is passed, accurate to the second. +* `topic_id` - (Optional, String) TopicId. +* `use_auto_create_topic` - (Optional, Bool) whether the used topic need to be automatically created (currently only supports SOURCE inflow tasks). + +The `transform_param` object supports the following: + +* `analysis_format` - (Required, String) parsing format, JSON | DELIMITER| REGULAR. +* `content` - (Required, String) Raw data. +* `failure_param` - (Required, List) Whether to keep parsing failure data. +* `output_format` - (Required, String) output format. +* `source_type` - (Required, String) Data source, TOPIC pulls from the source topic, CUSTOMIZE custom. +* `analyse_result` - (Optional, List) Analysis result. +* `filter_param` - (Optional, List) filter. +* `map_param` - (Optional, List) Map. +* `regex` - (Optional, String) delimiter, regular expression. +* `result` - (Optional, String) Test Results. +* `use_event_bus` - (Optional, Bool) Whether the underlying engine uses eb. + +The `transforms_param` object supports the following: + +* `content` - (Required, String) Raw data. +* `field_chain` - (Required, List) processing chain. +* `batch_analyse` - (Optional, List) data process. +* `failure_param` - (Optional, List) fail process. +* `filter_param` - (Optional, List) filter. +* `keep_metadata` - (Optional, Bool) Whether to keep the data source Topic metadata information (source Topic, Partition, Offset), the default is false. +* `output_format` - (Optional, String) output format, JSON, ROW, default JSON. +* `result` - (Optional, String) result. +* `row_param` - (Optional, List) The output format is ROW Required. +* `source_type` - (Optional, String) data source. + +The `url_decode` object supports the following: + +* `charset_name` - (Optional, String) code. + +The `value_operate` object supports the following: + +* `type` - (Required, String) Processing mode, REPLACE replacement, SUBSTR interception, DATE date conversion, TRIM removal of leading and trailing spaces, REGEX REPLACE regular replacement, URL DECODE, LOWERCASE conversion to lowercase. +* `date` - (Optional, List) Time conversion, required when TYPE=DATE. +* `json_path_replace` - (Optional, List) Json Path replacement, must pass when TYPE=JSON PATH REPLACE. +* `k_v` - (Optional, List) Key-value secondary analysis, must be passed when TYPE=KV. +* `regex_replace` - (Optional, List) Regular replacement, required when TYPE=REGEX REPLACE. +* `replace` - (Optional, List) replace, TYPE=REPLACE is required. +* `result` - (Optional, String) result. +* `split` - (Optional, List) The value supports one split and multiple values, required when TYPE=SPLIT. +* `substr` - (Optional, List) Substr, TYPE=SUBSTR is required. +* `url_decode` - (Optional, List) Url parsing. + +The `value_operates` object supports the following: + +* `type` - (Required, String) Processing mode, REPLACE replacement, SUBSTR interception, DATE date conversion, TRIM removal of leading and trailing spaces, REGEX REPLACE regular replacement, URL DECODE, LOWERCASE conversion to lowercase. +* `date` - (Optional, List) Time conversion, required when TYPE=DATE. +* `json_path_replace` - (Optional, List) Json Path replacement, must pass when TYPE=JSON PATH REPLACE. +* `k_v` - (Optional, List) Key-value secondary analysis, must be passed when TYPE=KV. +* `regex_replace` - (Optional, List) Regular replacement, required when TYPE=REGEX REPLACE. +* `replace` - (Optional, List) replace, TYPE=REPLACE is required. +* `result` - (Optional, String) result. +* `split` - (Optional, List) The value supports one split and multiple values, required when TYPE=SPLIT. +* `substr` - (Optional, List) Substr, TYPE=SUBSTR is required. +* `url_decode` - (Optional, List) Url parsing. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ckafka datahub_task can be imported using the id, e.g. + +``` +terraform import tencentcloud_ckafka_datahub_task.datahub_task datahub_task_id +``` + diff --git a/config/docs/r/ckafka_datahub_topic.html.markdown b/config/docs/r/ckafka_datahub_topic.html.markdown new file mode 100644 index 0000000..55c43d7 --- /dev/null +++ b/config/docs/r/ckafka_datahub_topic.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_datahub_topic" +sidebar_current: "docs-tencentcloud-resource-ckafka_datahub_topic" +description: |- + Provides a resource to create a ckafka datahub_topic +--- + +# tencentcloud_ckafka_datahub_topic + +Provides a resource to create a ckafka datahub_topic + +## Example Usage + +```hcl +data "tencentcloud_user_info" "user" {} + +resource "tencentcloud_ckafka_datahub_topic" "datahub_topic" { + name = format("%s-tf", data.tencentcloud_user_info.user.app_id) + partition_num = 20 + retention_ms = 60000 + note = "for test" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String, ForceNew) Name, start with appid, which is a string of no more than 128 characters, must start with a letter, and the rest can contain letters, numbers, and dashes (-). +* `partition_num` - (Required, Int) Number of Partitions, greater than 0. +* `retention_ms` - (Required, Int) Message retention time, in ms, the current minimum value is 60000 ms. +* `note` - (Optional, String) Subject note, which is a string of no more than 64 characters, must start with a letter, and the rest can contain letters, numbers and dashes (-). +* `tags` - (Optional, Map) Tags of dataHub topic. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ckafka datahub_topic can be imported using the id, e.g. + +``` +terraform import tencentcloud_ckafka_datahub_topic.datahub_topic datahub_topic_name +``` + diff --git a/config/docs/r/ckafka_instance.html.markdown b/config/docs/r/ckafka_instance.html.markdown new file mode 100644 index 0000000..2f11ad4 --- /dev/null +++ b/config/docs/r/ckafka_instance.html.markdown @@ -0,0 +1,201 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_instance" +sidebar_current: "docs-tencentcloud-resource-ckafka_instance" +description: |- + Use this resource to create ckafka instance. +--- + +# tencentcloud_ckafka_instance + +Use this resource to create ckafka instance. + +## Example Usage + +### Basic Instance + +```hcl +variable "vpc_id" { + default = "vpc-68vi2d3h" +} + +variable "subnet_id" { + default = "subnet-ob6clqwk" +} + +data "tencentcloud_availability_zones_by_product" "gz" { + name = "ap-guangzhou-3" + product = "ckafka" +} + +resource "tencentcloud_ckafka_instance" "kafka_instance_prepaid" { + instance_name = "ckafka-instance-prepaid" + zone_id = data.tencentcloud_availability_zones_by_product.gz.zones.0.id + period = 1 + vpc_id = var.vpc_id + subnet_id = var.subnet_id + msg_retention_time = 1300 + renew_flag = 0 + kafka_version = "2.4.1" + disk_size = 200 + disk_type = "CLOUD_BASIC" + band_width = 20 + partition = 400 + + specifications_type = "standard" + instance_type = 2 + + config { + auto_create_topic_enable = true + default_num_partitions = 3 + default_replication_factor = 3 + } + + dynamic_retention_config { + enable = 1 + } +} + +resource "tencentcloud_ckafka_instance" "kafka_instance_postpaid" { + instance_name = "ckafka-instance-postpaid" + zone_id = data.tencentcloud_availability_zones_by_product.gz.zones.0.id + vpc_id = var.vpc_id + subnet_id = var.subnet_id + msg_retention_time = 1300 + kafka_version = "1.1.1" + disk_size = 200 + band_width = 20 + disk_type = "CLOUD_BASIC" + partition = 400 + charge_type = "POSTPAID_BY_HOUR" + + config { + auto_create_topic_enable = true + default_num_partitions = 3 + default_replication_factor = 3 + } + + dynamic_retention_config { + enable = 1 + } +} +``` + +### Multi zone Instance + +```hcl +variable "vpc_id" { + default = "vpc-68vi2d3h" +} + +variable "subnet_id" { + default = "subnet-ob6clqwk" +} + +data "tencentcloud_availability_zones_by_product" "gz3" { + name = "ap-guangzhou-3" + product = "ckafka" +} + +data "tencentcloud_availability_zones_by_product" "gz6" { + name = "ap-guangzhou-6" + product = "ckafka" +} + +resource "tencentcloud_ckafka_instance" "kafka_instance" { + instance_name = "ckafka-instance-maz-tf-test" + zone_id = data.tencentcloud_availability_zones_by_product.gz3.zones.0.id + multi_zone_flag = true + zone_ids = [ + data.tencentcloud_availability_zones_by_product.gz3.zones.0.id, + data.tencentcloud_availability_zones_by_product.gz6.zones.0.id + ] + period = 1 + vpc_id = var.vpc_id + subnet_id = var.subnet_id + msg_retention_time = 1300 + renew_flag = 0 + kafka_version = "1.1.1" + disk_size = 500 + disk_type = "CLOUD_BASIC" + + config { + auto_create_topic_enable = true + default_num_partitions = 3 + default_replication_factor = 3 + } + + dynamic_retention_config { + enable = 1 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_name` - (Required, String) Instance name. +* `zone_id` - (Required, Int) Available zone id. +* `band_width` - (Optional, Int) Instance bandwidth in MBps. +* `charge_type` - (Optional, String, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. Default value is `PREPAID`. +* `config` - (Optional, List) Instance configuration. +* `disk_size` - (Optional, Int) Disk Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created. +* `disk_type` - (Optional, String) Type of disk. +* `dynamic_retention_config` - (Optional, List) Dynamic message retention policy configuration. +* `instance_type` - (Optional, Int) Description of instance type. `profession`: 1, `standard`: 1(general), 2(standard), 3(advanced), 4(capacity), 5(specialized-1), 6(specialized-2), 7(specialized-3), 8(specialized-4), 9(exclusive). +* `kafka_version` - (Optional, String) Kafka version (0.10.2/1.1.1/2.4.1). +* `max_message_byte` - (Optional, Int) The size of a single message in bytes at the instance level. Value range: `1024 - 12*1024*1024 bytes (i.e., 1KB-12MB). +* `msg_retention_time` - (Optional, Int) The maximum retention time of instance logs, in minutes. the default is 10080 (7 days), the maximum is 30 days, and the default 0 is not filled, which means that the log retention time recovery policy is not enabled. +* `multi_zone_flag` - (Optional, Bool) Indicates whether the instance is multi zones. NOTE: if set to `true`, `zone_ids` must set together. +* `partition` - (Optional, Int) Partition Size. Its interval varies with bandwidth, and the input must be within the interval, which can be viewed through the control. If it is not within the interval, the plan will cause a change when first created. +* `period` - (Optional, Int) Prepaid purchase time, such as 1, is one month. +* `public_network` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.81.6. If set public network value, it will cause error. Bandwidth of the public network. +* `rebalance_time` - (Optional, Int) Modification of the rebalancing time after upgrade. +* `renew_flag` - (Optional, Int) Prepaid automatic renewal mark, 0 means the default state, the initial state, 1 means automatic renewal, 2 means clear no automatic renewal (user setting). +* `specifications_type` - (Optional, String) Specifications type of instance. Allowed values are `standard`, `profession`. Default is `profession`. +* `subnet_id` - (Optional, String) Subnet id, it will be basic network if not set. +* `tag_set` - (Optional, Map) Tag set of instance. +* `tags` - (Optional, List, **Deprecated**) It has been deprecated from version 1.78.5, because it do not support change. Use `tag_set` instead. Tags of instance. Partition size, the professional version does not need tag. +* `upgrade_strategy` - (Optional, Int) POSTPAID_BY_HOUR scale-down mode +- 1: stable transformation; +- 2: High-speed transformer. +* `vpc_id` - (Optional, String) Vpc id, it will be basic network if not set. +* `zone_ids` - (Optional, Set: [`Int`]) List of available zone id. NOTE: this argument must set together with `multi_zone_flag`. + +The `config` object supports the following: + +* `auto_create_topic_enable` - (Required, Bool) Automatic creation. true: enabled, false: not enabled. +* `default_num_partitions` - (Required, Int) If auto.create.topic.enable is set to true and this value is not set, 3 will be used by default. +* `default_replication_factor` - (Required, Int) If auto.create.topic.enable is set to true but this value is not set, 2 will be used by default. + +The `dynamic_retention_config` object supports the following: + +* `bottom_retention` - (Optional, Int) Minimum retention time, in minutes. +* `disk_quota_percentage` - (Optional, Int) Disk quota threshold (in percentage) for triggering the message retention time change event. +* `enable` - (Optional, Int) Whether the dynamic message retention time configuration is enabled. 0: disabled; 1: enabled. +* `step_forward_percentage` - (Optional, Int) Percentage by which the message retention time is shortened each time. + +The `tags` object supports the following: + +* `key` - (Required, String) Tag key. +* `value` - (Required, String) Tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `vip` - Vip of instance. +* `vport` - Type of instance. + + +## Import + +ckafka instance can be imported using the instance_id, e.g. + +``` +$ terraform import tencentcloud_ckafka_instance.foo ckafka-f9ife4zz +``` + diff --git a/config/docs/r/ckafka_renew_instance.html.markdown b/config/docs/r/ckafka_renew_instance.html.markdown new file mode 100644 index 0000000..d156370 --- /dev/null +++ b/config/docs/r/ckafka_renew_instance.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_renew_instance" +sidebar_current: "docs-tencentcloud-resource-ckafka_renew_instance" +description: |- + Provides a resource to create a ckafka renew_instance +--- + +# tencentcloud_ckafka_renew_instance + +Provides a resource to create a ckafka renew_instance + +## Example Usage + +```hcl +resource "tencentcloud_ckafka_renew_instance" "renew_ckafka_instance" { + instance_id = "InstanceId" + time_span = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) instance id. +* `time_span` - (Optional, Int, ForceNew) Renewal duration, the default is 1, and the unit is month. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ckafka_route.html.markdown b/config/docs/r/ckafka_route.html.markdown new file mode 100644 index 0000000..5d17509 --- /dev/null +++ b/config/docs/r/ckafka_route.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_route" +sidebar_current: "docs-tencentcloud-resource-ckafka_route" +description: |- + Provides a resource to create a ckafka route +--- + +# tencentcloud_ckafka_route + +Provides a resource to create a ckafka route + +## Example Usage + +```hcl +resource "tencentcloud_ckafka_route" "route" { + instance_id = "ckafka-xxxxxx" + vip_type = 3 + vpc_id = "vpc-xxxxxx" + subnet_id = "subnet-xxxxxx" + access_type = 0 + public_network = 3 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance id. +* `vip_type` - (Required, Int) Routing network type (3:vpc routing; 4: standard support routing; 7: professional support routing). +* `access_type` - (Optional, Int) Access type. Valid values: +- 0: PLAINTEXT (in clear text, supported by both the old version and the community version without user information) +- 1: SASL_PLAINTEXT (in clear text, but at the beginning of the data, authentication will be logged in through SASL, which is only supported by the community version) +- 2: SSL (SSL encrypted communication without user information, supported by both older and community versions) +- 3: SASL_SSL (SSL encrypted communication. When the data starts, authentication will be logged in through SASL. Only the community version supports it). +* `auth_flag` - (Optional, Int) Auth flag. +* `caller_appid` - (Optional, Int) Caller appid. +* `ip` - (Optional, String) Ip. +* `public_network` - (Optional, Int) Public network. +* `subnet_id` - (Optional, String) Subnet id. +* `vpc_id` - (Optional, String) Vpc id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `broker_vip_list` - Virtual IP list (1 to 1 broker nodes). + * `vip` - Virtual IP. + * `vport` - Virtual port. +* `vip_list` - Virtual IP list. + * `vip` - Virtual IP. + * `vport` - Virtual port. + + diff --git a/config/docs/r/ckafka_topic.html.markdown b/config/docs/r/ckafka_topic.html.markdown new file mode 100644 index 0000000..0003195 --- /dev/null +++ b/config/docs/r/ckafka_topic.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_topic" +sidebar_current: "docs-tencentcloud-resource-ckafka_topic" +description: |- + Use this resource to create ckafka topic. +--- + +# tencentcloud_ckafka_topic + +Use this resource to create ckafka topic. + +## Example Usage + +```hcl +resource "tencentcloud_ckafka_topic" "foo" { + instance_id = "ckafka-f9ife4zz" + topic_name = "example" + note = "topic note" + replica_num = 2 + partition_num = 1 + enable_white_list = true + ip_white_list = ["ip1", "ip2"] + clean_up_policy = "delete" + sync_replica_min_num = 1 + unclean_leader_election_enable = false + segment = 3600000 + retention = 60000 + max_message_bytes = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Ckafka instance ID. +* `partition_num` - (Required, Int) The number of partition. +* `replica_num` - (Required, Int) The number of replica. +* `topic_name` - (Required, String, ForceNew) Name of the CKafka topic. It must start with a letter, the rest can contain letters, numbers and dashes(-). +* `clean_up_policy` - (Optional, String) Clear log policy, log clear mode, default is `delete`. `delete`: logs are deleted according to the storage time. `compact`: logs are compressed according to the key. `compact, delete`: logs are compressed according to the key and will be deleted according to the storage time. +* `enable_white_list` - (Optional, Bool) Whether to open the ip whitelist, `true`: open, `false`: close. +* `ip_white_list` - (Optional, List: [`String`]) Ip whitelist, quota limit, required when enableWhileList=true. +* `max_message_bytes` - (Optional, Int) Max message bytes. min: 1024 Byte(1KB), max: 8388608 Byte(8MB). +* `note` - (Optional, String) The subject note. It must start with a letter, and the remaining part can contain letters, numbers and dashes (-). +* `retention` - (Optional, Int) Message can be selected. Retention time, unit is ms, the current minimum value is 60000ms. +* `segment` - (Optional, Int) Segment scrolling time, in ms, the current minimum is 3600000ms. +* `sync_replica_min_num` - (Optional, Int) Min number of sync replicas, Default is `1`. +* `unclean_leader_election_enable` - (Optional, Bool) Whether to allow unsynchronized replicas to be selected as leader, default is `false`, `true: `allowed, `false`: not allowed. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the CKafka topic. +* `forward_cos_bucket` - Data backup cos bucket: the bucket address that is dumped to cos. +* `forward_interval` - Periodic frequency of data backup to cos. +* `forward_status` - Data backup cos status. Valid values: `0`, `1`. `1`: do not open data backup, `0`: open data backup. +* `message_storage_location` - Message storage location. +* `segment_bytes` - Number of bytes rolled by shard. + + +## Import + +ckafka topic can be imported using the instance_id#topic_name, e.g. + +``` +$ terraform import tencentcloud_ckafka_topic.foo ckafka-f9ife4zz#example +``` + diff --git a/config/docs/r/ckafka_user.html.markdown b/config/docs/r/ckafka_user.html.markdown new file mode 100644 index 0000000..9f074f8 --- /dev/null +++ b/config/docs/r/ckafka_user.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Cloud Kafka(ckafka)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ckafka_user" +sidebar_current: "docs-tencentcloud-resource-ckafka_user" +description: |- + Provides a resource to create a Ckafka user. +--- + +# tencentcloud_ckafka_user + +Provides a resource to create a Ckafka user. + +## Example Usage + +### Ckafka User + +```hcl +resource "tencentcloud_ckafka_user" "foo" { + instance_id = "ckafka-f9ife4zz" + account_name = "tf-test" + password = "test1234" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account_name` - (Required, String, ForceNew) Account name used to access to ckafka instance. +* `instance_id` - (Required, String, ForceNew) ID of the ckafka instance. +* `password` - (Required, String) Password of the account. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of the account. +* `update_time` - The last update time of the account. + + +## Import + +Ckafka user can be imported using the instance_id#account_name, e.g. + +``` +$ terraform import tencentcloud_ckafka_user.foo ckafka-f9ife4zz#tf-test +``` + diff --git a/config/docs/r/clb_attachment.html.markdown b/config/docs/r/clb_attachment.html.markdown new file mode 100644 index 0000000..055d8b2 --- /dev/null +++ b/config/docs/r/clb_attachment.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_attachment" +sidebar_current: "docs-tencentcloud-resource-clb_attachment" +description: |- + Provides a resource to create a CLB attachment. +--- + +# tencentcloud_clb_attachment + +Provides a resource to create a CLB attachment. + +## Example Usage + +```hcl +resource "tencentcloud_clb_attachment" "foo" { + clb_id = "lb-k2zjp9lv" + listener_id = "lbl-hh141sn9" + rule_id = "loc-4xxr2cy7" + + targets { + instance_id = "ins-1flbqyp8" + port = 80 + weight = 10 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_id` - (Required, String, ForceNew) ID of the CLB. +* `listener_id` - (Required, String, ForceNew) ID of the CLB listener. +* `targets` - (Required, Set) Information of the backends to be attached. +* `rule_id` - (Optional, String, ForceNew) ID of the CLB listener rule. Only supports listeners of `HTTPS` and `HTTP` protocol. + +The `targets` object supports the following: + +* `port` - (Required, Int) Port of the backend server. Valid value ranges: (0~65535). +* `eni_ip` - (Optional, String) Eni IP address of the backend server, conflict with `instance_id` but must specify one of them. +* `instance_id` - (Optional, String) CVM Instance Id of the backend server, conflict with `eni_ip` but must specify one of them. +* `weight` - (Optional, Int) Forwarding weight of the backend service. Valid value ranges: (0~100). defaults to `10`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `protocol_type` - Type of protocol within the listener. + + +## Import + +CLB attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_clb_attachment.foo loc-4xxr2cy7#lbl-hh141sn9#lb-7a0t6zqb +``` + diff --git a/config/docs/r/clb_customized_config.html.markdown b/config/docs/r/clb_customized_config.html.markdown new file mode 100644 index 0000000..16276a2 --- /dev/null +++ b/config/docs/r/clb_customized_config.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_customized_config" +sidebar_current: "docs-tencentcloud-resource-clb_customized_config" +description: |- + Provides a resource to create a CLB customized config. +--- + +# tencentcloud_clb_customized_config + +Provides a resource to create a CLB customized config. + +## Example Usage + +```hcl +resource "tencentcloud_clb_customized_config" "foo" { + config_content = "client_max_body_size 224M;\r\nclient_body_timeout 60s;" + config_name = "helloWorld" + load_balancer_ids = [ + "${tencentcloud_clb_instance.internal_clb.id}", + "${tencentcloud_clb_instance.internal_clb2.id}", + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_content` - (Required, String) Content of Customized Config. +* `config_name` - (Required, String) Name of Customized Config. +* `load_balancer_ids` - (Optional, Set: [`String`]) List of LoadBalancer Ids. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of Customized Config. +* `update_time` - Update time of Customized Config. + + +## Import + +CLB customized config can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_clb_customized_config.foo pz-diowqstq +``` + diff --git a/config/docs/r/clb_function_targets_attachment.html.markdown b/config/docs/r/clb_function_targets_attachment.html.markdown new file mode 100644 index 0000000..e939b8e --- /dev/null +++ b/config/docs/r/clb_function_targets_attachment.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_function_targets_attachment" +sidebar_current: "docs-tencentcloud-resource-clb_function_targets_attachment" +description: |- + Provides a resource to create a clb function_targets_attachment +--- + +# tencentcloud_clb_function_targets_attachment + +Provides a resource to create a clb function_targets_attachment + +## Example Usage + +```hcl +resource "tencentcloud_clb_function_targets_attachment" "function_targets" { + domain = "xxx.com" + listener_id = "lbl-nonkgvc2" + load_balancer_id = "lb-5dnrkgry" + url = "/" + + function_targets { + weight = 10 + + function { + function_name = "keep-tf-test-1675954233" + function_namespace = "default" + function_qualifier = "$LATEST" + function_qualifier_type = "VERSION" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_targets` - (Required, List) List of cloud functions to be bound. +* `listener_id` - (Required, String, ForceNew) Load Balancer Listener ID. +* `load_balancer_id` - (Required, String, ForceNew) Load Balancer Instance ID. +* `domain` - (Optional, String, ForceNew) The domain name of the target forwarding rule. If the LocationId parameter has been entered, this parameter will not take effect. +* `location_id` - (Optional, String, ForceNew) The ID of the target forwarding rule. When binding the cloud function to a layer-7 forwarding rule, this parameter or the Domain+Url parameter must be entered. +* `url` - (Optional, String, ForceNew) The URL of the target forwarding rule. If the LocationId parameter has been entered, this parameter will not take effect. + +The `function_targets` object supports the following: + +* `function` - (Required, List) Information about cloud functions.Note: This field may return null, indicating that no valid value can be obtained. +* `weight` - (Optional, Int) Weight. The default is `10`. + +The `function` object supports the following: + +* `function_name` - (Required, String) The name of function. +* `function_namespace` - (Required, String) The namespace of function. +* `function_qualifier` - (Required, String) The version name or alias of the function. +* `function_qualifier_type` - (Optional, String) Identifies the type of FunctionQualifier parameter, possible values: VERSION, ALIAS.Note: This field may return null, indicating that no valid value can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +clb function_targets_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_clb_function_targets_attachment.function_targets loadBalancerId#listenerId#locationId or loadBalancerId#listenerId#domain#rule +``` + diff --git a/config/docs/r/clb_instance.html.markdown b/config/docs/r/clb_instance.html.markdown new file mode 100644 index 0000000..91537c5 --- /dev/null +++ b/config/docs/r/clb_instance.html.markdown @@ -0,0 +1,280 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_instance" +sidebar_current: "docs-tencentcloud-resource-clb_instance" +description: |- + Provides a resource to create a CLB instance. +--- + +# tencentcloud_clb_instance + +Provides a resource to create a CLB instance. + +## Example Usage + +### INTERNAL CLB + +```hcl +resource "tencentcloud_clb_instance" "internal_clb" { + network_type = "INTERNAL" + clb_name = "myclb" + project_id = 0 + vpc_id = "vpc-7007ll7q" + subnet_id = "subnet-12rastkr" + + tags = { + test = "tf" + } +} +``` + +### LCU-supported CLB + +```hcl +resource "tencentcloud_clb_instance" "internal_clb" { + network_type = "INTERNAL" + clb_name = "myclb" + project_id = 0 + sla_type = "clb.c3.medium" + vpc_id = "vpc-2hfyray3" + subnet_id = "subnet-o3a5nt20" + + tags = { + test = "tf" + } +} +``` + +### OPEN CLB + +```hcl +resource "tencentcloud_clb_instance" "open_clb" { + network_type = "OPEN" + clb_name = "myclb" + project_id = 0 + vpc_id = "vpc-da7ffa61" + security_groups = ["sg-o0ek7r93"] + target_region_info_region = "ap-guangzhou" + target_region_info_vpc_id = "vpc-da7ffa61" + + tags = { + test = "tf" + } +} +``` + +### OPNE CLB with VipIsp + +```hcl +resource "tencentcloud_vpc_bandwidth_package" "example" { + network_type = "SINGLEISP_CMCC" + charge_type = "ENHANCED95_POSTPAID_BY_MONTH" + bandwidth_package_name = "tf-example" + internet_max_bandwidth = 300 + egress = "center_egress1" + + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_clb_instance" "open_clb" { + network_type = "OPEN" + clb_name = "my-open-clb" + project_id = 0 + vpc_id = "vpc-4owdpnwr" + vip_isp = "CMCC" + internet_charge_type = "BANDWIDTH_PACKAGE" + bandwidth_package_id = tencentcloud_vpc_bandwidth_package.example.id + + tags = { + test = "open" + } +} +``` + +### Dynamic Vip Instance + +```hcl +resource "tencentcloud_security_group" "foo" { + name = "clb-instance-open-sg" +} + +resource "tencentcloud_vpc" "foo" { + name = "clb-instance-open-vpc" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_clb_instance" "clb_open" { + network_type = "OPEN" + clb_name = "clb-instance-open" + project_id = 0 + vpc_id = tencentcloud_vpc.foo.id + target_region_info_region = "ap-guangzhou" + target_region_info_vpc_id = tencentcloud_vpc.foo.id + security_groups = [tencentcloud_security_group.foo.id] + + dynamic_vip = true + + tags = { + test = "tf" + } +} + +output "domain" { + value = tencentcloud_clb_instance.clb_open.domain +} +``` + +### Default enable + +```hcl +resource "tencentcloud_subnet" "subnet" { + availability_zone = "ap-guangzhou-1" + name = "sdk-feature-test" + vpc_id = tencentcloud_vpc.foo.id + cidr_block = "10.0.20.0/28" + is_multicast = false +} + +resource "tencentcloud_security_group" "sglab" { + name = "sg_o0ek7r93" + description = "favourite sg" + project_id = 0 +} + +resource "tencentcloud_vpc" "foo" { + name = "for-my-open-clb" + cidr_block = "10.0.0.0/16" + + tags = { + "test" = "mytest" + } +} + +resource "tencentcloud_clb_instance" "open_clb" { + network_type = "OPEN" + clb_name = "my-open-clb" + project_id = 0 + vpc_id = tencentcloud_vpc.foo.id + load_balancer_pass_to_target = true + + security_groups = [tencentcloud_security_group.sglab.id] + target_region_info_region = "ap-guangzhou" + target_region_info_vpc_id = tencentcloud_vpc.foo.id + + tags = { + test = "open" + } +} +``` + +### CREATE multiple instance + +```hcl +resource "tencentcloud_clb_instance" "open_clb1" { + network_type = "OPEN" + clb_name = "hello" + master_zone_id = "ap-guangzhou-3" +} +``` + +### CREATE instance with log + +```hcl +resource "tencentcloud_vpc" "vpc_test" { + name = "clb-test" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_route_table" "rtb_test" { + name = "clb-test" + vpc_id = "${tencentcloud_vpc.vpc_test.id}" +} + +resource "tencentcloud_subnet" "subnet_test" { + name = "clb-test" + cidr_block = "10.0.1.0/24" + availability_zone = "ap-guangzhou-3" + vpc_id = "${tencentcloud_vpc.vpc_test.id}" + route_table_id = "${tencentcloud_route_table.rtb_test.id}" +} + +resource "tencentcloud_clb_log_set" "set" { + period = 7 +} + +resource "tencentcloud_clb_log_topic" "topic" { + log_set_id = "${tencentcloud_clb_log_set.set.id}" + topic_name = "clb-topic" +} + +resource "tencentcloud_clb_instance" "internal_clb" { + network_type = "INTERNAL" + clb_name = "myclb" + project_id = 0 + vpc_id = "${tencentcloud_vpc.vpc_test.id}" + subnet_id = "${tencentcloud_subnet.subnet_test.id}" + load_balancer_pass_to_target = true + log_set_id = "${tencentcloud_clb_log_set.set.id}" + log_topic_id = "${tencentcloud_clb_log_topic.topic.id}" + + tags = { + test = "tf" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_name` - (Required, String) Name of the CLB. The name can only contain Chinese characters, English letters, numbers, underscore and hyphen '-'. +* `network_type` - (Required, String, ForceNew) Type of CLB instance. Valid values: `OPEN` and `INTERNAL`. +* `address_ip_version` - (Optional, String) IP version, only applicable to open CLB. Valid values are `ipv4`, `ipv6` and `IPv6FullChain`. +* `bandwidth_package_id` - (Optional, String) Bandwidth package id. If set, the `internet_charge_type` must be `BANDWIDTH_PACKAGE`. +* `delete_protect` - (Optional, Bool) Whether to enable delete protection. +* `dynamic_vip` - (Optional, Bool) If create dynamic vip CLB instance, `true` or `false`. +* `internet_bandwidth_max_out` - (Optional, Int) Max bandwidth out, only applicable to open CLB. Valid value ranges is [1, 2048]. Unit is MB. +* `internet_charge_type` - (Optional, String) Internet charge type, only applicable to open CLB. Valid values are `TRAFFIC_POSTPAID_BY_HOUR`, `BANDWIDTH_POSTPAID_BY_HOUR` and `BANDWIDTH_PACKAGE`. +* `load_balancer_pass_to_target` - (Optional, Bool) Whether the target allow flow come from clb. If value is true, only check security group of clb, or check both clb and backend instance security group. +* `log_set_id` - (Optional, String) The id of log set. +* `log_topic_id` - (Optional, String) The id of log topic. +* `master_zone_id` - (Optional, String) Setting master zone id of cross available zone disaster recovery, only applicable to open CLB. +* `project_id` - (Optional, Int, ForceNew) ID of the project within the CLB instance, `0` - Default Project. +* `security_groups` - (Optional, List: [`String`]) Security groups of the CLB instance. Supports both `OPEN` and `INTERNAL` CLBs. +* `sla_type` - (Optional, String) This parameter is required to create LCU-supported instances. Values:`SLA`: Super Large 4. When you have activated Super Large models, `SLA` refers to Super Large 4; `clb.c2.medium`: Standard; `clb.c3.small`: Advanced 1; `clb.c3.medium`: Advanced 1; `clb.c4.small`: Super Large 1; `clb.c4.medium`: Super Large 2; `clb.c4.large`: Super Large 3; `clb.c4.xlarge`: Super Large 4. For more details, see [Instance Specifications](https://intl.cloud.tencent.com/document/product/214/84689?from_cn_redirect=1). +* `slave_zone_id` - (Optional, String) Setting slave zone id of cross available zone disaster recovery, only applicable to open CLB. this zone will undertake traffic when the master is down. +* `snat_ips` - (Optional, List) Snat Ip List, required with `snat_pro=true`. NOTE: This argument cannot be read and modified here because dynamic ip is untraceable, please import resource `tencentcloud_clb_snat_ip` to handle fixed ips. +* `snat_pro` - (Optional, Bool) Indicates whether Binding IPs of other VPCs feature switch. +* `subnet_id` - (Optional, String, ForceNew) Subnet ID of the CLB. Effective only for CLB within the VPC. Only supports `INTERNAL` CLBs. Default is `ipv4`. +* `tags` - (Optional, Map) The available tags within this CLB. +* `target_region_info_region` - (Optional, String) Region information of backend services are attached the CLB instance. Only supports `OPEN` CLBs. +* `target_region_info_vpc_id` - (Optional, String) Vpc information of backend services are attached the CLB instance. Only supports `OPEN` CLBs. +* `vip_isp` - (Optional, String, ForceNew) Network operator, only applicable to open CLB. Valid values are `CMCC`(China Mobile), `CTCC`(Telecom), `CUCC`(China Unicom) and `BGP`. If this ISP is specified, network billing method can only use the bandwidth package billing (BANDWIDTH_PACKAGE). +* `vpc_id` - (Optional, String, ForceNew) VPC ID of the CLB. +* `zone_id` - (Optional, String) Available zone id, only applicable to open CLB. + +The `snat_ips` object supports the following: + +* `subnet_id` - (Required, String) Snat subnet ID. +* `ip` - (Optional, String) Snat IP address, If set to empty will auto allocated. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `clb_vips` - The virtual service address table of the CLB. +* `domain` - Domain name of the CLB instance. + + +## Import + +CLB instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_clb_instance.foo lb-7a0t6zqb +``` + diff --git a/config/docs/r/clb_instance_mix_ip_target_config.html.markdown b/config/docs/r/clb_instance_mix_ip_target_config.html.markdown new file mode 100644 index 0000000..4caeeff --- /dev/null +++ b/config/docs/r/clb_instance_mix_ip_target_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_instance_mix_ip_target_config" +sidebar_current: "docs-tencentcloud-resource-clb_instance_mix_ip_target_config" +description: |- + Provides a resource to create a clb instance_mix_ip_target_config +--- + +# tencentcloud_clb_instance_mix_ip_target_config + +Provides a resource to create a clb instance_mix_ip_target_config + +## Example Usage + +```hcl +resource "tencentcloud_clb_instance_mix_ip_target_config" "instance_mix_ip_target_config" { + load_balancer_id = "lb-5dnrkgry" + mix_ip_target = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `load_balancer_id` - (Required, String, ForceNew) ID of CLB instances to be queried. +* `mix_ip_target` - (Required, Bool) False: closed True:open. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +clb instance_mix_ip_target_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_clb_instance_mix_ip_target_config.instance_mix_ip_target_config instance_id +``` + diff --git a/config/docs/r/clb_instance_sla_config.html.markdown b/config/docs/r/clb_instance_sla_config.html.markdown new file mode 100644 index 0000000..f57fe41 --- /dev/null +++ b/config/docs/r/clb_instance_sla_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_instance_sla_config" +sidebar_current: "docs-tencentcloud-resource-clb_instance_sla_config" +description: |- + Provides a resource to create a clb instance_sla_config +--- + +# tencentcloud_clb_instance_sla_config + +Provides a resource to create a clb instance_sla_config + +## Example Usage + +```hcl +resource "tencentcloud_clb_instance_sla_config" "instance_sla_config" { + load_balancer_id = "lb-5dnrkgry" + sla_type = "SLA" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `load_balancer_id` - (Required, String) ID of the CLB instance. +* `sla_type` - (Required, String) This parameter is required to create LCU-supported instances. Values:`SLA`: Super Large 4. When you have activated Super Large models, `SLA` refers to Super Large 4; `clb.c2.medium`: Standard; `clb.c3.small`: Advanced 1; `clb.c3.medium`: Advanced 1; `clb.c4.small`: Super Large 1; `clb.c4.medium`: Super Large 2; `clb.c4.large`: Super Large 3; `clb.c4.xlarge`: Super Large 4. For more details, see [Instance Specifications](https://intl.cloud.tencent.com/document/product/214/84689?from_cn_redirect=1). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +clb instance_sla_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_clb_instance_sla_config.instance_sla_config instance_id +``` + diff --git a/config/docs/r/clb_listener.html.markdown b/config/docs/r/clb_listener.html.markdown new file mode 100644 index 0000000..f15e714 --- /dev/null +++ b/config/docs/r/clb_listener.html.markdown @@ -0,0 +1,220 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_listener" +sidebar_current: "docs-tencentcloud-resource-clb_listener" +description: |- + Provides a resource to create a CLB listener. +--- + +# tencentcloud_clb_listener + +Provides a resource to create a CLB listener. + +## Example Usage + +### HTTP Listener + +```hcl +resource "tencentcloud_clb_listener" "HTTP_listener" { + clb_id = "lb-0lh5au7v" + listener_name = "test_listener" + port = 80 + protocol = "HTTP" +} +``` + +### TCP/UDP Listener + +```hcl +resource "tencentcloud_clb_listener" "TCP_listener" { + clb_id = "lb-0lh5au7v" + listener_name = "test_listener" + port = 80 + protocol = "TCP" + health_check_switch = true + health_check_time_out = 2 + health_check_interval_time = 5 + health_check_health_num = 3 + health_check_unhealth_num = 3 + session_expire_time = 30 + scheduler = "WRR" + health_check_port = 200 + health_check_type = "HTTP" + health_check_http_code = 2 + health_check_http_version = "HTTP/1.0" + health_check_http_method = "GET" +} +``` + +### TCP/UDP Listener with tcp health check + +```hcl +resource "tencentcloud_clb_listener" "listener_tcp" { + clb_id = tencentcloud_clb_instance.clb_basic.id + listener_name = "listener_tcp" + port = 44 + protocol = "TCP" + health_check_switch = true + health_check_time_out = 30 + health_check_interval_time = 100 + health_check_health_num = 2 + health_check_unhealth_num = 2 + session_expire_time = 30 + scheduler = "WRR" + health_check_type = "TCP" + health_check_port = 200 +} +``` + +### TCP/UDP Listener with http health check + +```hcl +resource "tencentcloud_clb_listener" "listener_tcp" { + clb_id = tencentcloud_clb_instance.clb_basic.id + listener_name = "listener_tcp" + port = 44 + protocol = "TCP" + health_check_switch = true + health_check_time_out = 30 + health_check_interval_time = 100 + health_check_health_num = 2 + health_check_unhealth_num = 2 + session_expire_time = 30 + scheduler = "WRR" + health_check_type = "HTTP" + health_check_http_domain = "www.tencent.com" + health_check_http_code = 16 + health_check_http_version = "HTTP/1.1" + health_check_http_method = "HEAD" + health_check_http_path = "/" +} +``` + +### TCP/UDP Listener with customer health check + +```hcl +resource "tencentcloud_clb_listener" "listener_tcp" { + clb_id = tencentcloud_clb_instance.clb_basic.id + listener_name = "listener_tcp" + port = 44 + protocol = "TCP" + health_check_switch = true + health_check_time_out = 30 + health_check_interval_time = 100 + health_check_health_num = 2 + health_check_unhealth_num = 2 + session_expire_time = 30 + scheduler = "WRR" + health_check_type = "CUSTOM" + health_check_context_type = "HEX" + health_check_send_context = "0123456789ABCDEF" + health_check_recv_context = "ABCD" + target_type = "TARGETGROUP" +} +``` + +### HTTPS Listener + +```hcl +resource "tencentcloud_clb_listener" "HTTPS_listener" { + clb_id = "lb-0lh5au7v" + listener_name = "test_listener" + port = "80" + protocol = "HTTPS" + certificate_ssl_mode = "MUTUAL" + certificate_id = "VjANRdz8" + certificate_ca_id = "VfqO4zkB" + sni_switch = true +} +``` + +### TCP SSL Listener + +```hcl +resource "tencentcloud_clb_listener" "TCPSSL_listener" { + clb_id = "lb-0lh5au7v" + listener_name = "test_listener" + port = "80" + protocol = "TCP_SSL" + certificate_ssl_mode = "MUTUAL" + certificate_id = "VjANRdz8" + certificate_ca_id = "VfqO4zkB" + health_check_switch = true + health_check_time_out = 2 + health_check_interval_time = 5 + health_check_health_num = 3 + health_check_unhealth_num = 3 + scheduler = "WRR" + target_type = "TARGETGROUP" +} +``` + +### Port Range Listener + +```hcl +resource "tencentcloud_clb_instance" "clb_basic" { + network_type = "OPEN" + clb_name = "tf-listener-test" +} + +resource "tencentcloud_clb_listener" "listener_basic" { + clb_id = tencentcloud_clb_instance.clb_basic.id + port = 1 + end_port = 6 + protocol = "TCP" + listener_name = "listener_basic" + session_expire_time = 30 + scheduler = "WRR" + target_type = "NODE" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_id` - (Required, String, ForceNew) ID of the CLB. +* `listener_name` - (Required, String) Name of the CLB listener, and available values can only be Chinese characters, English letters, numbers, underscore and hyphen '-'. +* `protocol` - (Required, String, ForceNew) Type of protocol within the listener. Valid values: `TCP`, `UDP`, `HTTP`, `HTTPS`, `TCP_SSL` and `QUIC`. +* `certificate_ca_id` - (Optional, String) ID of the client certificate. NOTES: Only supports listeners of `HTTPS` and `TCP_SSL` protocol and must be set when the ssl mode is `MUTUAL`. +* `certificate_id` - (Optional, String) ID of the server certificate. NOTES: Only supports listeners of `HTTPS` and `TCP_SSL` protocol and must be set when it is available. +* `certificate_ssl_mode` - (Optional, String) Type of certificate. Valid values: `UNIDIRECTIONAL`, `MUTUAL`. NOTES: Only supports listeners of `HTTPS` and `TCP_SSL` protocol and must be set when it is available. +* `end_port` - (Optional, Int, ForceNew) This parameter is used to specify the end port and is required when creating a port range listener. Only one member can be passed in when inputting the `Ports` parameter, which is used to specify the start port. If you want to try the port range feature, please [submit a ticket](https://console.cloud.tencent.com/workorder/category). +* `health_check_context_type` - (Optional, String) Health check protocol. When the value of `health_check_type` of the health check protocol is `CUSTOM`, this field is required, which represents the input format of the health check. Valid values: `HEX`, `TEXT`. +* `health_check_health_num` - (Optional, Int) Health threshold of health check, and the default is `3`. If a success result is returned for the health check for 3 consecutive times, the backend CVM is identified as healthy. The value range is 2-10. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. +* `health_check_http_code` - (Optional, Int) HTTP health check code of TCP listener, Valid value ranges: [1~31]. When the value of `health_check_type` of the health check protocol is `HTTP`, this field is required. Valid values: `1`, `2`, `4`, `8`, `16`. `1` means http_1xx, `2` means http_2xx, `4` means http_3xx, `8` means http_4xx, `16` means http_5xx.If you want multiple return codes to indicate health, need to add the corresponding values. +* `health_check_http_domain` - (Optional, String) HTTP health check domain of TCP listener. +* `health_check_http_method` - (Optional, String) HTTP health check method of TCP listener. Valid values: `HEAD`, `GET`. +* `health_check_http_path` - (Optional, String) HTTP health check path of TCP listener. +* `health_check_http_version` - (Optional, String) The HTTP version of the backend service. When the value of `health_check_type` of the health check protocol is `HTTP`, this field is required. Valid values: `HTTP/1.0`, `HTTP/1.1`. +* `health_check_interval_time` - (Optional, Int) Interval time of health check. Valid value ranges: [2~300] sec. and the default is 5 sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in `tencentcloud_clb_listener_rule`. +* `health_check_port` - (Optional, Int) The health check port is the port of the backend service by default. Unless you want to specify a specific port, it is recommended to leave it blank. Only applicable to TCP/UDP listener. +* `health_check_recv_context` - (Optional, String) It represents the result returned by the health check. When the value of `health_check_type` of the health check protocol is `CUSTOM`, this field is required. Only ASCII visible characters are allowed and the maximum length is 500. When `health_check_context_type` value is `HEX`, the characters of SendContext and RecvContext can only be selected in `0123456789ABCDEF` and the length must be even digits. +* `health_check_send_context` - (Optional, String) It represents the content of the request sent by the health check. When the value of `health_check_type` of the health check protocol is `CUSTOM`, this field is required. Only visible ASCII characters are allowed and the maximum length is 500. When `health_check_context_type` value is `HEX`, the characters of SendContext and RecvContext can only be selected in `0123456789ABCDEF` and the length must be even digits. +* `health_check_switch` - (Optional, Bool) Indicates whether health check is enabled. +* `health_check_time_out` - (Optional, Int) Response timeout of health check. Valid value ranges: [2~60] sec. Default is 2 sec. Response timeout needs to be less than check interval. NOTES: Only supports listeners of `TCP`,`UDP`,`TCP_SSL` protocol. +* `health_check_type` - (Optional, String) Protocol used for health check. Valid values: `CUSTOM`, `TCP`, `HTTP`. +* `health_check_unhealth_num` - (Optional, Int) Unhealthy threshold of health check, and the default is `3`. If a success result is returned for the health check 3 consecutive times, the CVM is identified as unhealthy. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in `tencentcloud_clb_listener_rule`. +* `port` - (Optional, Int, ForceNew) Port of the CLB listener. +* `scheduler` - (Optional, String) Scheduling method of the CLB listener, and available values are 'WRR' and 'LEAST_CONN'. The default is 'WRR'. NOTES: The listener of `HTTP` and `HTTPS` protocol additionally supports the `IP Hash` method. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in `tencentcloud_clb_listener_rule`. +* `session_expire_time` - (Optional, Int) Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as `WRR`, and not available when listener protocol is `TCP_SSL`. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in `tencentcloud_clb_listener_rule`. +* `sni_switch` - (Optional, Bool, ForceNew) Indicates whether SNI is enabled, and only supported with protocol `HTTPS`. If enabled, you can set a certificate for each rule in `tencentcloud_clb_listener_rule`, otherwise all rules have a certificate. +* `target_type` - (Optional, String) Backend target type. Valid values: `NODE`, `TARGETGROUP`. `NODE` means to bind ordinary nodes, `TARGETGROUP` means to bind target group. NOTES: TCP/UDP/TCP_SSL listener must configuration, HTTP/HTTPS listener needs to be configured in tencentcloud_clb_listener_rule. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `listener_id` - ID of this CLB listener. + + +## Import + +CLB listener can be imported using the id (version >= 1.47.0), e.g. + +``` +$ terraform import tencentcloud_clb_listener.foo lb-7a0t6zqb#lbl-hh141sn9 +``` + diff --git a/config/docs/r/clb_listener_rule.html.markdown b/config/docs/r/clb_listener_rule.html.markdown new file mode 100644 index 0000000..46ccba9 --- /dev/null +++ b/config/docs/r/clb_listener_rule.html.markdown @@ -0,0 +1,82 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_listener_rule" +sidebar_current: "docs-tencentcloud-resource-clb_listener_rule" +description: |- + Provides a resource to create a CLB listener rule. +--- + +# tencentcloud_clb_listener_rule + +Provides a resource to create a CLB listener rule. + +-> **NOTE:** This resource only be applied to the HTTP or HTTPS listeners. + +## Example Usage + +```hcl +resource "tencentcloud_clb_listener_rule" "foo" { + listener_id = "lbl-hh141sn9" + clb_id = "lb-k2zjp9lv" + domain = "foo.net" + url = "/bar" + health_check_switch = true + health_check_interval_time = 5 + health_check_health_num = 3 + health_check_unhealth_num = 3 + health_check_http_code = 2 + health_check_http_path = "Default Path" + health_check_http_domain = "Default Domain" + health_check_http_method = "GET" + certificate_ssl_mode = "MUTUAL" + certificate_id = "VjANRdz8" + certificate_ca_id = "VfqO4zkB" + session_expire_time = 30 + scheduler = "WRR" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_id` - (Required, String) ID of CLB instance. +* `domain` - (Required, String) Domain name of the listener rule. +* `listener_id` - (Required, String, ForceNew) ID of CLB listener. +* `url` - (Required, String) Url of the listener rule. +* `certificate_ca_id` - (Optional, String) ID of the client certificate. NOTES: Only supports listeners of HTTPS protocol. +* `certificate_id` - (Optional, String) ID of the server certificate. NOTES: Only supports listeners of HTTPS protocol. +* `certificate_ssl_mode` - (Optional, String, ForceNew) Type of certificate. Valid values: `UNIDIRECTIONAL`, `MUTUAL`. NOTES: Only supports listeners of HTTPS protocol. +* `forward_type` - (Optional, String) Forwarding protocol between the CLB instance and real server. Valid values: `HTTP`, `HTTPS`, `TRPC`. The default is `HTTP`. +* `health_check_health_num` - (Optional, Int) Health threshold of health check, and the default is `3`. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in `tencentcloud_clb_listener_rule`. +* `health_check_http_code` - (Optional, Int) HTTP Status Code. The default is 31. Valid value ranges: [1~31]. `1 means the return value '1xx' is health. `2` means the return value '2xx' is health. `4` means the return value '3xx' is health. `8` means the return value '4xx' is health. 16 means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. NOTES: The 'HTTP' health check of the 'TCP' listener only supports specifying one health check status code. NOTES: Only supports listeners of 'HTTP' and 'HTTPS' protocol. +* `health_check_http_domain` - (Optional, String) Domain name of health check. NOTES: Only supports listeners of `HTTP` and `HTTPS` protocol. +* `health_check_http_method` - (Optional, String) Methods of health check. NOTES: Only supports listeners of `HTTP` and `HTTPS` protocol. The default is `HEAD`, the available value are `HEAD` and `GET`. +* `health_check_http_path` - (Optional, String) Path of health check. NOTES: Only supports listeners of `HTTP` and `HTTPS` protocol. +* `health_check_interval_time` - (Optional, Int) Interval time of health check. Valid value ranges: (2~300) sec. and the default is `5` sec. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in `tencentcloud_clb_listener_rule`. +* `health_check_switch` - (Optional, Bool) Indicates whether health check is enabled. +* `health_check_time_out` - (Optional, Int) Time out of health check. The value range is [2-60](SEC). +* `health_check_type` - (Optional, String) Type of health check. Valid value is `CUSTOM`, `TCP`, `HTTP`. +* `health_check_unhealth_num` - (Optional, Int) Unhealthy threshold of health check, and the default is `3`. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in `tencentcloud_clb_listener_rule`. +* `http2_switch` - (Optional, Bool) Indicate to apply HTTP2.0 protocol or not. +* `scheduler` - (Optional, String) Scheduling method of the CLB listener rules. Valid values: `WRR`, `IP HASH`, `LEAST_CONN`. The default is `WRR`. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in `tencentcloud_clb_listener_rule`. +* `session_expire_time` - (Optional, Int) Time of session persistence within the CLB listener. NOTES: Available when scheduler is specified as `WRR`, and not available when listener protocol is `TCP_SSL`. NOTES: TCP/UDP/TCP_SSL listener allows direct configuration, HTTP/HTTPS listener needs to be configured in `tencentcloud_clb_listener_rule`. +* `target_type` - (Optional, String, ForceNew) Backend target type. Valid values: `NODE`, `TARGETGROUP`. `NODE` means to bind ordinary nodes, `TARGETGROUP` means to bind target group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `rule_id` - ID of this CLB listener rule. + + +## Import + +CLB listener rule can be imported using the id (version >= 1.47.0), e.g. + +``` +$ terraform import tencentcloud_clb_listener_rule.foo lb-7a0t6zqb#lbl-hh141sn9#loc-agg236ys +``` + diff --git a/config/docs/r/clb_log_set.html.markdown b/config/docs/r/clb_log_set.html.markdown new file mode 100644 index 0000000..a57ff66 --- /dev/null +++ b/config/docs/r/clb_log_set.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_log_set" +sidebar_current: "docs-tencentcloud-resource-clb_log_set" +description: |- + Provides a resource to create an exclusive CLB Logset. +--- + +# tencentcloud_clb_log_set + +Provides a resource to create an exclusive CLB Logset. + +## Example Usage + +```hcl +resource "tencentcloud_clb_log_set" "foo" { + period = 7 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `period` - (Optional, Int, ForceNew) Logset retention period in days. Maximun value is `90`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Logset creation time. +* `name` - Logset name, which unique and fixed `clb_logset` among all CLS logsets. +* `topic_count` - Number of log topics in logset. + + +## Import + +CLB log set can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_clb_logset.foo 4eb9e3a8-9c42-4b32-9ddf-e215e9c92764 +``` + diff --git a/config/docs/r/clb_log_topic.html.markdown b/config/docs/r/clb_log_topic.html.markdown new file mode 100644 index 0000000..004e251 --- /dev/null +++ b/config/docs/r/clb_log_topic.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_log_topic" +sidebar_current: "docs-tencentcloud-resource-clb_log_topic" +description: |- + Provides a resource to create a CLB instance topic. +--- + +# tencentcloud_clb_log_topic + +Provides a resource to create a CLB instance topic. + +## Example Usage + +```hcl +resource "tencentcloud_clb_log_topic" "topic" { + log_set_id = "${tencentcloud_clb_log_set.set.id}" + topic_name = "clb-topic" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `log_set_id` - (Required, String, ForceNew) Log topic of CLB instance. +* `topic_name` - (Required, String, ForceNew) Log topic of CLB instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Log topic creation time. +* `status` - The status of log topic. + + +## Import + +CLB log topic can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_clb_log_topic.topic lb-7a0t6zqb + diff --git a/config/docs/r/clb_redirection.html.markdown b/config/docs/r/clb_redirection.html.markdown new file mode 100644 index 0000000..44ed093 --- /dev/null +++ b/config/docs/r/clb_redirection.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_redirection" +sidebar_current: "docs-tencentcloud-resource-clb_redirection" +description: |- + Provides a resource to create a CLB redirection. +--- + +# tencentcloud_clb_redirection + +Provides a resource to create a CLB redirection. + +## Example Usage + +### Manual Rewrite + +```hcl +resource "tencentcloud_clb_redirection" "foo" { + clb_id = "lb-p7olt9e5" + source_listener_id = "lbl-jc1dx6ju" + target_listener_id = "lbl-asj1hzuo" + source_rule_id = "loc-ft8fmngv" + target_rule_id = "loc-4xxr2cy7" +} +``` + +### Auto Rewrite + +```hcl +resource "tencentcloud_clb_redirection" "foo" { + clb_id = "lb-p7olt9e5" + target_listener_id = "lbl-asj1hzuo" + target_rule_id = "loc-4xxr2cy7" + is_auto_rewrite = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_id` - (Required, String, ForceNew) ID of CLB instance. +* `target_listener_id` - (Required, String, ForceNew) ID of source listener. +* `target_rule_id` - (Required, String, ForceNew) Rule ID of target listener. +* `delete_all_auto_rewrite` - (Optional, Bool) Indicates whether delete all auto redirection. Default is `false`. It will take effect only when this redirection is auto-rewrite and this auto-rewrite auto redirected more than one rules. All the auto-rewrite relations will be deleted when this parameter set true. +* `is_auto_rewrite` - (Optional, Bool, ForceNew) Indicates whether automatic forwarding is enable, default is `false`. If enabled, the source listener and location should be empty, the target listener must be https protocol and port is 443. +* `source_listener_id` - (Optional, String, ForceNew) ID of source listener. +* `source_rule_id` - (Optional, String, ForceNew) Rule ID of source listener. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +CLB redirection can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_clb_redirection.foo loc-ft8fmngv#loc-4xxr2cy7#lbl-jc1dx6ju#lbl-asj1hzuo#lb-p7olt9e5 +``` + diff --git a/config/docs/r/clb_replace_cert_for_lbs.html.markdown b/config/docs/r/clb_replace_cert_for_lbs.html.markdown new file mode 100644 index 0000000..40f009c --- /dev/null +++ b/config/docs/r/clb_replace_cert_for_lbs.html.markdown @@ -0,0 +1,99 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_replace_cert_for_lbs" +sidebar_current: "docs-tencentcloud-resource-clb_replace_cert_for_lbs" +description: |- + Provides a resource to create a clb replace_cert_for_lbs +--- + +# tencentcloud_clb_replace_cert_for_lbs + +Provides a resource to create a clb replace_cert_for_lbs + +## Example Usage + +### Replace Server Cert By Cert ID + +```hcl +resource "tencentcloud_clb_replace_cert_for_lbs" "replace_cert_for_lbs" { + old_certificate_id = "zjUMifFK" + certificate { + cert_id = "6vcK02GC" + } +} +``` + +### Replace Server Cert By Cert Content + +```hcl +data "tencentcloud_ssl_certificates" "foo" { + name = "keep-ssl-ca" +} + +resource "tencentcloud_clb_replace_cert_for_lbs" "replace_cert_for_lbs" { + old_certificate_id = data.tencentcloud_ssl_certificates.foo.certificates.0.id + certificate { + cert_name = "tf-test-cert" + cert_content = <<-EOT +-----BEGIN CERTIFICATE----- +xxxxxxxxxxxxxxxxxxxxxxxxxxx +-----END CERTIFICATE----- +EOT + cert_key = <<-EOT +-----BEGIN RSA PRIVATE KEY----- +xxxxxxxxxxxxxxxxxxxxxxxxxxxx +-----END RSA PRIVATE KEY----- +EOT + } +} +``` + +### Replace Client Cert By Cert Content + +```hcl +resource "tencentcloud_clb_replace_cert_for_lbs" "replace_cert_for_lbs" { + old_certificate_id = "zjUMifFK" + certificate { + cert_ca_name = "tf-test-cert" + cert_ca_content = <<-EOT +-----BEGIN CERTIFICATE----- +xxxxxxxxContentxxxxxxxxxxxxxx +-----END CERTIFICATE----- +EOT + } +} +``` + + + +```hcl +terraform import tencentcloud_clb_replace_cert_for_lbs.replace_cert_for_lbs replace_cert_for_lbs_id +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate` - (Required, List, ForceNew) Information such as the content of the new certificate. +* `old_certificate_id` - (Required, String, ForceNew) ID of the certificate to be replaced, which can be a server certificate or a client certificate. + +The `certificate` object supports the following: + +* `cert_ca_content` - (Optional, String) Content of the uploaded client certificate. When SSLMode = mutual, if there is no CertCaId, this parameter is required. +* `cert_ca_id` - (Optional, String) ID of a client certificate. When the listener adopts mutual authentication (i.e., SSLMode = mutual), if you leave this parameter empty, you must upload the client certificate, including CertCaContent and CertCaName. +* `cert_ca_name` - (Optional, String) Name of the uploaded client CA certificate. When SSLMode = mutual, if there is no CertCaId, this parameter is required. +* `cert_content` - (Optional, String) Content of the uploaded server certificate. If there is no CertId, this parameter is required. +* `cert_id` - (Optional, String) ID of a server certificate. If you leave this parameter empty, you must upload the certificate, including CertContent, CertKey, and CertName. +* `cert_key` - (Optional, String) Key of the uploaded server certificate. If there is no CertId, this parameter is required. +* `cert_name` - (Optional, String) Name of the uploaded server certificate. If there is no CertId, this parameter is required. +* `ssl_mode` - (Optional, String) Authentication type. Value range: UNIDIRECTIONAL (unidirectional authentication), MUTUAL (mutual authentication). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/clb_security_group_attachment.html.markdown b/config/docs/r/clb_security_group_attachment.html.markdown new file mode 100644 index 0000000..5adf171 --- /dev/null +++ b/config/docs/r/clb_security_group_attachment.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_security_group_attachment" +sidebar_current: "docs-tencentcloud-resource-clb_security_group_attachment" +description: |- + Provides a resource to create a clb security_group_attachment +--- + +# tencentcloud_clb_security_group_attachment + +Provides a resource to create a clb security_group_attachment + +## Example Usage + +```hcl +resource "tencentcloud_clb_security_group_attachment" "security_group_attachment" { + security_group = "sg-ijato2x1" + load_balancer_ids = ["lb-5dnrkgry"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `load_balancer_ids` - (Required, Set: [`String`], ForceNew) Array of CLB instance IDs. Only support set one security group now. +* `security_group` - (Required, String, ForceNew) Security group ID, such as esg-12345678. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +clb security_group_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_clb_security_group_attachment.security_group_attachment security_group_id#clb_id +``` + diff --git a/config/docs/r/clb_snat_ip.html.markdown b/config/docs/r/clb_snat_ip.html.markdown new file mode 100644 index 0000000..0b9c796 --- /dev/null +++ b/config/docs/r/clb_snat_ip.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_snat_ip" +sidebar_current: "docs-tencentcloud-resource-clb_snat_ip" +description: |- + Provide a resource to create a SnatIp of CLB instance. +--- + +# tencentcloud_clb_snat_ip + +Provide a resource to create a SnatIp of CLB instance. + +~> **NOTE:** Target CLB instance must enable `snat_pro` before creating snat ips. +~> **NOTE:** Dynamic allocate IP doesn't support for now. + +## Example Usage + +```hcl +resource "tencentcloud_clb_instance" "snat_test" { + network_type = "OPEN" + clb_name = "tf-clb-snat-test" +} + +resource "tencentcloud_clb_snat_ip" "foo" { + clb_id = tencentcloud_clb_instance.snat_test.id + ips { + subnet_id = "subnet-12345678" + ip = "172.16.0.1" + } + ips { + subnet_id = "subnet-12345678" + ip = "172.16.0.2" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_id` - (Required, String) CLB instance ID. +* `ips` - (Optional, Set) Snat IP address config. + +The `ips` object supports the following: + +* `ip` - (Required, String) Snat IP. +* `subnet_id` - (Required, String) Subnet ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ClbSnatIp instance can be imported by clb instance id, e.g. +``` +$ terraform import tencentcloud_clb_snat_ip.test clb_id +``` + diff --git a/config/docs/r/clb_target_group.html.markdown b/config/docs/r/clb_target_group.html.markdown new file mode 100644 index 0000000..3e4922a --- /dev/null +++ b/config/docs/r/clb_target_group.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_target_group" +sidebar_current: "docs-tencentcloud-resource-clb_target_group" +description: |- + Provides a resource to create a CLB target group. +--- + +# tencentcloud_clb_target_group + +Provides a resource to create a CLB target group. + +## Example Usage + +```hcl +resource "tencentcloud_clb_target_group" "test" { + target_group_name = "test" + port = 33 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `port` - (Optional, Int) The default port of target group, add server after can use it. +* `target_group_instances` - (Optional, List, **Deprecated**) It has been deprecated from version 1.77.3. please use `tencentcloud_clb_target_group_instance_attachment` instead. The backend server of target group bind. +* `target_group_name` - (Optional, String) Target group name. +* `vpc_id` - (Optional, String, ForceNew) VPC ID, default is based on the network. + +The `target_group_instances` object supports the following: + +* `bind_ip` - (Required, String) The internal ip of target group instance. +* `port` - (Required, Int) The port of target group instance. +* `new_port` - (Optional, Int) The new port of target group instance. +* `weight` - (Optional, Int) The weight of target group instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +CLB target group can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_clb_target_group.test lbtg-3k3io0i0 +``` + diff --git a/config/docs/r/clb_target_group_attachment.html.markdown b/config/docs/r/clb_target_group_attachment.html.markdown new file mode 100644 index 0000000..2e00e92 --- /dev/null +++ b/config/docs/r/clb_target_group_attachment.html.markdown @@ -0,0 +1,76 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_target_group_attachment" +sidebar_current: "docs-tencentcloud-resource-clb_target_group_attachment" +description: |- + Provides a resource to create a CLB target group attachment is bound to the load balancing listener or forwarding rule. +--- + +# tencentcloud_clb_target_group_attachment + +Provides a resource to create a CLB target group attachment is bound to the load balancing listener or forwarding rule. + +## Example Usage + +```hcl +resource "tencentcloud_clb_instance" "clb_basic" { + network_type = "OPEN" + clb_name = "tf-clb-rule-basic" +} + +resource "tencentcloud_clb_listener" "listener_basic" { + clb_id = tencentcloud_clb_instance.clb_basic.id + port = 1 + protocol = "HTTP" + listener_name = "listener_basic" +} + +resource "tencentcloud_clb_listener_rule" "rule_basic" { + clb_id = tencentcloud_clb_instance.clb_basic.id + listener_id = tencentcloud_clb_listener.listener_basic.listener_id + domain = "abc.com" + url = "/" + session_expire_time = 30 + scheduler = "WRR" + target_type = "TARGETGROUP" +} + +resource "tencentcloud_clb_target_group" "test" { + target_group_name = "test-target-keep-1" +} + +resource "tencentcloud_clb_target_group_attachment" "group" { + clb_id = tencentcloud_clb_instance.clb_basic.id + listener_id = tencentcloud_clb_listener.listener_basic.listener_id + rule_id = tencentcloud_clb_listener_rule.rule_basic.rule_id + target_group_id = tencentcloud_clb_target_group.test.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `clb_id` - (Required, String, ForceNew) ID of the CLB. +* `listener_id` - (Required, String, ForceNew) ID of the CLB listener. +* `rule_id` - (Optional, String, ForceNew) ID of the CLB listener rule. +* `target_group_id` - (Optional, String, ForceNew) ID of the CLB target group. +* `targrt_group_id` - (Optional, String, **Deprecated**) It has been deprecated from version 1.47.1. Use `target_group_id` instead. ID of the CLB target group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +CLB target group attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_clb_target_group_attachment.group lbtg-odareyb2#lbl-bicjmx3i#lb-cv0iz74c#loc-ac6uk7b6 +``` + diff --git a/config/docs/r/clb_target_group_instance_attachment.html.markdown b/config/docs/r/clb_target_group_instance_attachment.html.markdown new file mode 100644 index 0000000..18f77fe --- /dev/null +++ b/config/docs/r/clb_target_group_instance_attachment.html.markdown @@ -0,0 +1,112 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clb_target_group_instance_attachment" +sidebar_current: "docs-tencentcloud-resource-clb_target_group_instance_attachment" +description: |- + Provides a resource to create a CLB target group instance attachment. +--- + +# tencentcloud_clb_target_group_instance_attachment + +Provides a resource to create a CLB target group instance attachment. + +## Example Usage + +```hcl +data "tencentcloud_images" "my_favorite_image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "centos" +} + +data "tencentcloud_instance_types" "my_favorite_instance_types" { + filter { + name = "instance-family" + values = ["S3"] + } + + cpu_core_count = 1 + memory_size = 1 +} + +data "tencentcloud_availability_zones" "default" { +} + +resource "tencentcloud_vpc" "app" { + cidr_block = "10.0.0.0/16" + name = "awesome_app_vpc" +} + +resource "tencentcloud_subnet" "app" { + vpc_id = tencentcloud_vpc.app.id + availability_zone = data.tencentcloud_availability_zones.default.zones.0.name + name = "awesome_app_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_instance" "my_awesome_app" { + instance_name = "awesome_app" + availability_zone = data.tencentcloud_availability_zones.default.zones.0.name + image_id = data.tencentcloud_images.my_favorite_image.images.0.image_id + instance_type = data.tencentcloud_instance_types.my_favorite_instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "user" + project_id = 0 + vpc_id = tencentcloud_vpc.app.id + subnet_id = tencentcloud_subnet.app.id + internet_max_bandwidth_out = 20 + + data_disks { + data_disk_type = "CLOUD_PREMIUM" + data_disk_size = 50 + encrypt = false + } + + tags = { + tagKey = "tagValue" + } +} + +data "tencentcloud_instances" "foo" { + instance_id = tencentcloud_instance.my_awesome_app.id +} + +resource "tencentcloud_clb_target_group" "test" { + target_group_name = "test" + vpc_id = tencentcloud_vpc.app.id +} + +resource "tencentcloud_clb_target_group_instance_attachment" "test" { + target_group_id = tencentcloud_clb_target_group.test.id + bind_ip = data.tencentcloud_instances.foo.instance_list[0].private_ip + port = 222 + weight = 3 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bind_ip` - (Required, String, ForceNew) The Intranet IP of the target group instance. +* `port` - (Required, Int, ForceNew) Port of the target group instance. +* `target_group_id` - (Required, String, ForceNew) Target group ID. +* `weight` - (Required, Int) The weight of the target group instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +CLB target group instance attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_clb_target_group_instance_attachment.test lbtg-3k3io0i0#172.16.48.18#222 +``` + diff --git a/config/docs/r/clickhouse_account.html.markdown b/config/docs/r/clickhouse_account.html.markdown new file mode 100644 index 0000000..81662eb --- /dev/null +++ b/config/docs/r/clickhouse_account.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "ClickHouse(CDWCH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clickhouse_account" +sidebar_current: "docs-tencentcloud-resource-clickhouse_account" +description: |- + Provides a resource to create a clickhouse account +--- + +# tencentcloud_clickhouse_account + +Provides a resource to create a clickhouse account + +## Example Usage + +```hcl +resource "tencentcloud_clickhouse_account" "account" { + instance_id = "cdwch-xxxxxx" + user_name = "test" + password = "xxxxxx" + describe = "xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance id. +* `password` - (Required, String) Password. +* `user_name` - (Required, String) User name. +* `describe` - (Optional, String) Description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +clickhouse account can be imported using the id, e.g. + +``` +terraform import tencentcloud_clickhouse_account.account ${instance_id}#${user_name} +``` + diff --git a/config/docs/r/clickhouse_account_permission.html.markdown b/config/docs/r/clickhouse_account_permission.html.markdown new file mode 100644 index 0000000..8b51a0a --- /dev/null +++ b/config/docs/r/clickhouse_account_permission.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "ClickHouse(CDWCH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clickhouse_account_permission" +sidebar_current: "docs-tencentcloud-resource-clickhouse_account_permission" +description: |- + Provides a resource to create a clickhouse account_permission +--- + +# tencentcloud_clickhouse_account_permission + +Provides a resource to create a clickhouse account_permission + +## Example Usage + +```hcl +resource "tencentcloud_clickhouse_account_permission" "account_permission_all_database" { + instance_id = "cdwch-xxxxxx" + cluster = "default_cluster" + user_name = "user1" + all_database = true + global_privileges = ["SELECT", "ALTER"] +} + +resource "tencentcloud_clickhouse_account_permission" "account_permission_not_all_database" { + instance_id = "cdwch-xxxxxx" + cluster = "default_cluster" + user_name = "user2" + all_database = false + database_privilege_list { + database_name = "xxxxxx" + database_privileges = ["SELECT", "ALTER"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `all_database` - (Required, Bool) Whether all database tables. +* `cluster` - (Required, String) Cluster name. +* `instance_id` - (Required, String) Instance id. +* `user_name` - (Required, String) User name. +* `database_privilege_list` - (Optional, List) Database privilege list. +* `global_privileges` - (Optional, Set: [`String`]) Global privileges. + +The `database_privilege_list` object supports the following: + +* `database_name` - (Required, String) Database name. +* `database_privileges` - (Optional, Set) Database privileges. Valid valuse: SELECT, INSERT_ALL, ALTER, TRUNCATE, DROP_TABLE, CREATE_TABLE, DROP_DATABASE. +* `table_privilege_list` - (Optional, List) Table privilege list. + +The `table_privilege_list` object supports the following: + +* `table_name` - (Required, String) Table name. +* `table_privileges` - (Required, Set) Table privileges. Valid values: SELECT, INSERT_ALL, ALTER, TRUNCATE, DROP_TABLE. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +clickhouse account_permission can be imported using the id, e.g. + +``` +terraform import tencentcloud_clickhouse_account_permission.account_permission ${instanceId}#${cluster}#${userName} +``` + diff --git a/config/docs/r/clickhouse_backup.html.markdown b/config/docs/r/clickhouse_backup.html.markdown new file mode 100644 index 0000000..9fcc347 --- /dev/null +++ b/config/docs/r/clickhouse_backup.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "ClickHouse(CDWCH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clickhouse_backup" +sidebar_current: "docs-tencentcloud-resource-clickhouse_backup" +description: |- + Provides a resource to open clickhouse backup +--- + +# tencentcloud_clickhouse_backup + +Provides a resource to open clickhouse backup + +## Example Usage + +```hcl +resource "tencentcloud_clickhouse_backup" "backup" { + instance_id = "cdwch-xxxxxx" + cos_bucket_name = "xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cos_bucket_name` - (Required, String) COS bucket name. +* `instance_id` - (Required, String) Instance id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +clickhouse backup can be imported using the id, e.g. + +``` +terraform import tencentcloud_clickhouse_backup.backup instance_id +``` + diff --git a/config/docs/r/clickhouse_backup_strategy.html.markdown b/config/docs/r/clickhouse_backup_strategy.html.markdown new file mode 100644 index 0000000..1f3e2c5 --- /dev/null +++ b/config/docs/r/clickhouse_backup_strategy.html.markdown @@ -0,0 +1,90 @@ +--- +subcategory: "ClickHouse(CDWCH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clickhouse_backup_strategy" +sidebar_current: "docs-tencentcloud-resource-clickhouse_backup_strategy" +description: |- + Provides a resource to create a clickhouse backup strategy +--- + +# tencentcloud_clickhouse_backup_strategy + +Provides a resource to create a clickhouse backup strategy + +## Example Usage + +```hcl +resource "tencentcloud_clickhouse_backup" "backup" { + instance_id = "cdwch-xxxxxx" + cos_bucket_name = "xxxxxx" +} + +resource "tencentcloud_clickhouse_backup_strategy" "backup_strategy" { + instance_id = "cdwch-xxxxxx" + data_backup_strategy { + week_days = "3" + retain_days = 2 + execute_hour = 1 + back_up_tables { + database = "iac" + table = "my_table" + total_bytes = 0 + v_cluster = "default_cluster" + ips = "10.0.0.35" + } + } + meta_backup_strategy { + week_days = "1" + retain_days = 2 + execute_hour = 3 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_backup_strategy` - (Required, List) Data backup strategy. +* `instance_id` - (Required, String, ForceNew) Instance id. +* `meta_backup_strategy` - (Optional, List) Metadata backup strategy. + +The `back_up_tables` object supports the following: + +* `database` - (Required, String) Database. +* `table` - (Required, String) Table. +* `total_bytes` - (Required, Int) Back up the list of tables. +* `ips` - (Optional, String) Table ip. +* `rip` - (Optional, String) Ip address of cvm. +* `v_cluster` - (Optional, String) Virtual clusters. +* `zoo_path` - (Optional, String) ZK path. + +The `data_backup_strategy` object supports the following: + +* `back_up_tables` - (Required, List) Back up the list of tables. +* `execute_hour` - (Required, Int) Execution hour. +* `retain_days` - (Required, Int) Retention days. +* `week_days` - (Required, String) The day of the week is separated by commas. For example: 2 represents Tuesday. + +The `meta_backup_strategy` object supports the following: + +* `execute_hour` - (Optional, Int) Execution hour. +* `retain_days` - (Optional, Int) Retention days. +* `week_days` - (Optional, String) The day of the week is separated by commas. For example: 2 represents Tuesday. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +clickhouse backup_strategy can be imported using the id, e.g. + +``` +terraform import tencentcloud_clickhouse_backup_strategy.backup_strategy instance_id +``` + diff --git a/config/docs/r/clickhouse_delete_backup_data.html.markdown b/config/docs/r/clickhouse_delete_backup_data.html.markdown new file mode 100644 index 0000000..687c72d --- /dev/null +++ b/config/docs/r/clickhouse_delete_backup_data.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "ClickHouse(CDWCH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clickhouse_delete_backup_data" +sidebar_current: "docs-tencentcloud-resource-clickhouse_delete_backup_data" +description: |- + Provides a resource to delete a clickhouse back up data +--- + +# tencentcloud_clickhouse_delete_backup_data + +Provides a resource to delete a clickhouse back up data + +## Example Usage + +```hcl +resource "tencentcloud_clickhouse_delete_backup_data" "delete_back_up_data" { + instance_id = "cdwch-xxxxxx" + back_up_job_id = 1234 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance id. +* `back_up_job_id` - (Optional, Int, ForceNew) Back up job id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/clickhouse_instance.html.markdown b/config/docs/r/clickhouse_instance.html.markdown new file mode 100644 index 0000000..c85f654 --- /dev/null +++ b/config/docs/r/clickhouse_instance.html.markdown @@ -0,0 +1,112 @@ +--- +subcategory: "ClickHouse(CDWCH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clickhouse_instance" +sidebar_current: "docs-tencentcloud-resource-clickhouse_instance" +description: |- + Provides a resource to create a clickhouse instance. +--- + +# tencentcloud_clickhouse_instance + +Provides a resource to create a clickhouse instance. + +## Example Usage + +```hcl +resource "tencentcloud_clickhouse_instance" "cdwch_instance" { + zone = "ap-guangzhou-6" + ha_flag = true + vpc_id = "vpc-xxxxxx" + subnet_id = "subnet-xxxxxx" + product_version = "21.8.12.29" + data_spec { + spec_name = "SCH6" + count = 2 + disk_size = 300 + } + common_spec { + spec_name = "SCH6" + count = 3 + disk_size = 300 + } + charge_type = "POSTPAID_BY_HOUR" + instance_name = "tf-test-clickhouse" +} +``` + +### PREPAID instance + +```hcl +resource "tencentcloud_clickhouse_instance" "cdwch_instance_prepaid" { + zone = "ap-guangzhou-6" + ha_flag = true + vpc_id = "vpc-xxxxxx" + subnet_id = "subnet-xxxxxx" + product_version = "21.8.12.29" + data_spec { + spec_name = "SCH6" + count = 2 + disk_size = 300 + } + common_spec { + spec_name = "SCH6" + count = 3 + disk_size = 300 + } + charge_type = "PREPAID" + renew_flag = 1 + time_span = 1 + instance_name = "tf-test-clickhouse-prepaid" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `charge_type` - (Required, String) Billing type: `PREPAID` prepaid, `POSTPAID_BY_HOUR` postpaid. +* `data_spec` - (Required, List) Data spec. +* `ha_flag` - (Required, Bool) Whether it is highly available. +* `instance_name` - (Required, String) Instance name. +* `product_version` - (Required, String) Product version. +* `subnet_id` - (Required, String) Subnet. +* `vpc_id` - (Required, String) Private network. +* `zone` - (Required, String) Availability zone. +* `cls_log_set_id` - (Optional, String) CLS log set id. +* `common_spec` - (Optional, List) ZK node. +* `cos_bucket_name` - (Optional, String) COS bucket name. +* `ha_zk` - (Optional, Bool) Whether ZK is highly available. +* `mount_disk_type` - (Optional, Int) Whether it is mounted on a bare disk. +* `renew_flag` - (Optional, Int) PREPAID needs to be passed. Whether to renew automatically. 1 means auto renewal is enabled. +* `tags` - (Optional, Map) Tag description list. +* `time_span` - (Optional, Int) Prepaid needs to be delivered, billing time length, how many months. + +The `common_spec` object supports the following: + +* `count` - (Required, Int) Node count. NOTE: Only support value 3. +* `disk_size` - (Required, Int) Disk size. +* `spec_name` - (Required, String) Spec name. + +The `data_spec` object supports the following: + +* `count` - (Required, Int) Data spec count. +* `disk_size` - (Required, Int) Disk size. +* `spec_name` - (Required, String) Spec name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `expire_time` - Expire time. + + +## Import + +Clickhouse instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_clickhouse_instance.foo cdwch-xxxxxx +``` + diff --git a/config/docs/r/clickhouse_recover_backup_job.html.markdown b/config/docs/r/clickhouse_recover_backup_job.html.markdown new file mode 100644 index 0000000..fb8f1f9 --- /dev/null +++ b/config/docs/r/clickhouse_recover_backup_job.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "ClickHouse(CDWCH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_clickhouse_recover_backup_job" +sidebar_current: "docs-tencentcloud-resource-clickhouse_recover_backup_job" +description: |- + Provides a resource to recover a clickhouse back up +--- + +# tencentcloud_clickhouse_recover_backup_job + +Provides a resource to recover a clickhouse back up + +## Example Usage + +```hcl +resource "tencentcloud_clickhouse_recover_backup_job" "recover_backup_job" { + instance_id = "cdwch-xxxxxx" + back_up_job_id = 1234 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `back_up_job_id` - (Required, Int, ForceNew) Back up job id. +* `instance_id` - (Required, String, ForceNew) Instance id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cls_alarm.html.markdown b/config/docs/r/cls_alarm.html.markdown new file mode 100644 index 0000000..357215a --- /dev/null +++ b/config/docs/r/cls_alarm.html.markdown @@ -0,0 +1,121 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_alarm" +sidebar_current: "docs-tencentcloud-resource-cls_alarm" +description: |- + Provides a resource to create a cls alarm +--- + +# tencentcloud_cls_alarm + +Provides a resource to create a cls alarm + +## Example Usage + +```hcl +resource "tencentcloud_cls_alarm" "alarm" { + name = "terraform-alarm-test" + alarm_notice_ids = [ + "notice-0850756b-245d-4bc7-bb27-2a58fffc780b", + ] + alarm_period = 15 + condition = "test" + message_template = "{{.Label}}" + status = true + tags = { + "createdBy" = "terraform" + } + trigger_count = 1 + + alarm_targets { + end_time_offset = 0 + logset_id = "33aaf0ae-6163-411b-a415-9f27450f68db" + number = 1 + query = "status:>500 | select count(*) as errorCounts" + start_time_offset = -15 + topic_id = "88735a07-bea4-4985-8763-e9deb6da4fad" + } + + analysis { + content = "__FILENAME__" + name = "terraform" + type = "field" + + config_info { + key = "QueryIndex" + value = "1" + } + } + + monitor_time { + time = 1 + type = "Period" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `alarm_notice_ids` - (Required, Set: [`String`]) list of alarm notice id. +* `alarm_period` - (Required, Int) alarm repeat cycle. +* `alarm_targets` - (Required, List) list of alarm target. +* `condition` - (Required, String) triggering conditions. +* `monitor_time` - (Required, List) monitor task execution time. +* `name` - (Required, String) log alarm name. +* `trigger_count` - (Required, Int) continuous cycle. +* `analysis` - (Optional, List) multidimensional analysis. +* `call_back` - (Optional, List) user define callback. +* `message_template` - (Optional, String) user define alarm notice. +* `status` - (Optional, Bool) whether to enable the alarm policy. +* `tags` - (Optional, Map) Tag description list. + +The `alarm_targets` object supports the following: + +* `end_time_offset` - (Required, Int) search end time of offset. +* `logset_id` - (Required, String) logset id. +* `number` - (Required, Int) the number of alarm object. +* `query` - (Required, String) query rules. +* `start_time_offset` - (Required, Int) search start time of offset. +* `topic_id` - (Required, String) topic id. + +The `analysis` object supports the following: + +* `content` - (Required, String) analysis content. +* `name` - (Required, String) analysis name. +* `type` - (Required, String) analysis type. +* `config_info` - (Optional, List) configuration. + +The `call_back` object supports the following: + +* `body` - (Required, String) callback body. +* `headers` - (Optional, Set) callback headers. + +The `config_info` object supports the following: + +* `key` - (Required, String) key. +* `value` - (Required, String) value. + +The `monitor_time` object supports the following: + +* `time` - (Required, Int) time period or point in time. +* `type` - (Required, String) Period for periodic execution, Fixed for regular execution. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls alarm can be imported using the id, e.g. + +``` +terraform import tencentcloud_cls_alarm.alarm alarm_id +``` + diff --git a/config/docs/r/cls_alarm_notice.html.markdown b/config/docs/r/cls_alarm_notice.html.markdown new file mode 100644 index 0000000..a68def7 --- /dev/null +++ b/config/docs/r/cls_alarm_notice.html.markdown @@ -0,0 +1,83 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_alarm_notice" +sidebar_current: "docs-tencentcloud-resource-cls_alarm_notice" +description: |- + Provides a resource to create a cls alarm_notice +--- + +# tencentcloud_cls_alarm_notice + +Provides a resource to create a cls alarm_notice + +## Example Usage + +```hcl +resource "tencentcloud_cls_alarm_notice" "alarm_notice" { + name = "terraform-alarm-notice-test" + tags = { + "createdBy" = "terraform" + } + type = "All" + + notice_receivers { + index = 0 + receiver_channels = [ + "Sms", + ] + receiver_ids = [ + 13478043, + 15972111, + ] + receiver_type = "Uin" + start_time = "00:00:00" + end_time = "23:59:59" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) alarm notice name. +* `type` - (Required, String) notice type. +* `notice_receivers` - (Optional, List) notice receivers. +* `tags` - (Optional, Map) Tag description list. +* `web_callbacks` - (Optional, List) callback info. + +The `notice_receivers` object supports the following: + +* `receiver_channels` - (Required, Set) receiver channels, Email,Sms,WeChat or Phone. +* `receiver_ids` - (Required, Set) receiver id. +* `receiver_type` - (Required, String) receiver type, Uin or Group. +* `end_time` - (Optional, String) end time allowed to receive messages. +* `index` - (Optional, Int) index. +* `start_time` - (Optional, String) start time allowed to receive messages. + +The `web_callbacks` object supports the following: + +* `callback_type` - (Required, String) callback type, WeCom or Http. +* `url` - (Required, String) callback url. +* `body` - (Optional, String) abandoned. +* `headers` - (Optional, Set) abandoned. +* `index` - (Optional, Int) index. +* `method` - (Optional, String) Method, POST or PUT. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls alarm_notice can be imported using the id, e.g. + +``` +terraform import tencentcloud_cls_alarm_notice.alarm_notice alarm_notice_id +``` + diff --git a/config/docs/r/cls_ckafka_consumer.html.markdown b/config/docs/r/cls_ckafka_consumer.html.markdown new file mode 100644 index 0000000..9591de8 --- /dev/null +++ b/config/docs/r/cls_ckafka_consumer.html.markdown @@ -0,0 +1,87 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_ckafka_consumer" +sidebar_current: "docs-tencentcloud-resource-cls_ckafka_consumer" +description: |- + Provides a resource to create a cls ckafka_consumer +--- + +# tencentcloud_cls_ckafka_consumer + +Provides a resource to create a cls ckafka_consumer + +## Example Usage + +```hcl +resource "tencentcloud_cls_ckafka_consumer" "ckafka_consumer" { + compression = 1 + need_content = true + topic_id = "7e34a3a7-635e-4da8-9005-88106c1fde69" + + ckafka { + instance_id = "ckafka-qzoeaqx8" + instance_name = "ckafka-instance" + topic_id = "topic-c6tm4kpm" + topic_name = "name" + vip = "172.16.112.23" + vport = "9092" + } + + content { + enable_tag = true + meta_fields = [ + "__FILENAME__", + "__HOSTNAME__", + "__PKGID__", + "__SOURCE__", + "__TIMESTAMP__", + ] + tag_json_not_tiled = true + timestamp_accuracy = 2 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `topic_id` - (Required, String, ForceNew) topic id. +* `ckafka` - (Optional, List) ckafka info. +* `compression` - (Optional, Int) compression method. 0 for NONE, 2 for SNAPPY, 3 for LZ4. +* `content` - (Optional, List) metadata information. +* `need_content` - (Optional, Bool) whether to deliver the metadata information of the log. + +The `ckafka` object supports the following: + +* `instance_id` - (Required, String) instance id. +* `instance_name` - (Required, String) instance name. +* `topic_id` - (Required, String) topic id of ckafka. +* `topic_name` - (Required, String) topic name of ckafka. +* `vip` - (Required, String) vip. +* `vport` - (Required, String) vport. + +The `content` object supports the following: + +* `enable_tag` - (Required, Bool) whether to deliver the TAG info. +* `meta_fields` - (Required, Set) metadata info list. +* `tag_json_not_tiled` - (Optional, Bool) whether to tiling tag json. +* `timestamp_accuracy` - (Optional, Int) delivery timestamp precision,1 for second, 2 for millisecond. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls ckafka_consumer can be imported using the id, e.g. + +``` +terraform import tencentcloud_cls_ckafka_consumer.ckafka_consumer topic_id +``` + diff --git a/config/docs/r/cls_config.html.markdown b/config/docs/r/cls_config.html.markdown new file mode 100644 index 0000000..effc7b6 --- /dev/null +++ b/config/docs/r/cls_config.html.markdown @@ -0,0 +1,110 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_config" +sidebar_current: "docs-tencentcloud-resource-cls_config" +description: |- + Provides a resource to create a cls config +--- + +# tencentcloud_cls_config + +Provides a resource to create a cls config + +## Example Usage + +```hcl +resource "tencentcloud_cls_config" "config" { + name = "config_hello" + output = "4d07fba0-b93e-4e0b-9a7f-d58542560bbb" + path = "/var/log/kubernetes" + log_type = "json_log" + extract_rule { + filter_key_regex { + key = "key1" + regex = "value1" + } + filter_key_regex { + key = "key2" + regex = "value2" + } + un_match_up_load_switch = true + un_match_log_key = "config" + backtracking = -1 + } + exclude_paths { + type = "Path" + value = "/data" + } + exclude_paths { + type = "File" + value = "/file" + } + # user_define_rule = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `extract_rule` - (Required, List) Extraction rule. If ExtractRule is set, LogType must be set. +* `name` - (Required, String) Collection configuration name. +* `exclude_paths` - (Optional, List) Collection path blocklist. +* `log_type` - (Optional, String) Type of the log to be collected. Valid values: json_log: log in JSON format; delimiter_log: log in delimited format; minimalist_log: minimalist log; multiline_log: log in multi-line format; fullregex_log: log in full regex format. Default value: minimalist_log. +* `output` - (Optional, String) Log topic ID (TopicId) of collection configuration. +* `path` - (Optional, String) Log collection path containing the filename. +* `user_define_rule` - (Optional, String) Custom collection rule, which is a serialized JSON string. + +The `exclude_paths` object supports the following: + +* `type` - (Optional, String) Type. Valid values: File, Path. +* `value` - (Optional, String) Specific content corresponding to Type. + +The `extract_rule` object supports the following: + +* `address` - (Optional, String) syslog system log collection specifies the address and port that the collector listens to. +* `backtracking` - (Optional, Int) Size of the data to be rewound in incremental collection mode. Default value: -1 (full collection). +* `begin_regex` - (Optional, String) First-Line matching rule, which is valid only if log_type is multiline_log or fullregex_log. +* `delimiter` - (Optional, String) Delimiter for delimited log, which is valid only if log_type is delimiter_log. +* `filter_key_regex` - (Optional, List) Log keys to be filtered and the corresponding regex. +* `is_gbk` - (Optional, Int) GBK encoding. Default 0. +* `json_standard` - (Optional, Int) standard json. Default 0. +* `keys` - (Optional, Set) Key name of each extracted field. An empty key indicates to discard the field. This parameter is valid only if log_type is delimiter_log. json_log logs use the key of JSON itself. +* `log_regex` - (Optional, String) Full log matching rule, which is valid only if log_type is fullregex_log. +* `meta_tags` - (Optional, List) metadata tags. +* `metadata_type` - (Optional, Int) metadata type. +* `parse_protocol` - (Optional, String) parse protocol. +* `path_regex` - (Optional, String) metadata path regex. +* `protocol` - (Optional, String) syslog protocol, tcp or udp. +* `time_format` - (Optional, String) Time field format. For more information, please see the output parameters of the time format description of the strftime function in C language. +* `time_key` - (Optional, String) Time field key name. time_key and time_format must appear in pair. +* `un_match_log_key` - (Optional, String) Unmatched log key. +* `un_match_up_load_switch` - (Optional, Bool) Whether to upload the logs that failed to be parsed. Valid values: true: yes; false: no. + +The `filter_key_regex` object supports the following: + +* `key` - (Optional, String) Log key to be filtered. +* `regex` - (Optional, String) Filter rule regex corresponding to key. + +The `meta_tags` object supports the following: + +* `key` - (Optional, String) tag key. +* `value` - (Optional, String) tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls config can be imported using the id, e.g. + +``` +terraform import tencentcloud_cls_config.config config_id +``` + diff --git a/config/docs/r/cls_config_attachment.html.markdown b/config/docs/r/cls_config_attachment.html.markdown new file mode 100644 index 0000000..3721ca3 --- /dev/null +++ b/config/docs/r/cls_config_attachment.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_config_attachment" +sidebar_current: "docs-tencentcloud-resource-cls_config_attachment" +description: |- + Provides a resource to create a cls config attachment +--- + +# tencentcloud_cls_config_attachment + +Provides a resource to create a cls config attachment + +## Example Usage + + + +## Argument Reference + +The following arguments are supported: + +* `config_id` - (Required, String, ForceNew) Collection configuration id. +* `group_id` - (Required, String, ForceNew) Machine group id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls config_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_cls_config_attachment.attach config_id#group_id +``` + +``` + diff --git a/config/docs/r/cls_config_extra.html.markdown b/config/docs/r/cls_config_extra.html.markdown new file mode 100644 index 0000000..7b3798f --- /dev/null +++ b/config/docs/r/cls_config_extra.html.markdown @@ -0,0 +1,178 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_config_extra" +sidebar_current: "docs-tencentcloud-resource-cls_config_extra" +description: |- + Provides a resource to create a cls config extra +--- + +# tencentcloud_cls_config_extra + +Provides a resource to create a cls config extra + +## Example Usage + +```hcl +resource "tencentcloud_cls_logset" "logset" { + logset_name = "tf-config-extra-test" + tags = { + "test" = "test" + } +} + +resource "tencentcloud_cls_topic" "topic" { + auto_split = true + logset_id = tencentcloud_cls_logset.logset.id + max_split_partitions = 20 + partition_count = 1 + period = 10 + storage_type = "hot" + tags = { + "test" = "test" + } + topic_name = "tf-config-extra-test" +} + +resource "tencentcloud_cls_machine_group" "group" { + group_name = "tf-config-extra-test" + service_logging = true + auto_update = true + update_end_time = "19:05:00" + update_start_time = "17:05:00" + + machine_group_type { + type = "ip" + values = [ + "192.168.1.1", + "192.168.1.2", + ] + } +} + +resource "tencentcloud_cls_config_extra" "extra" { + name = "helloworld-test" + topic_id = tencentcloud_cls_topic.topic.id + type = "container_file" + log_type = "json_log" + config_flag = "label_k8s" + logset_id = tencentcloud_cls_logset.logset.id + logset_name = tencentcloud_cls_logset.logset.logset_name + topic_name = tencentcloud_cls_topic.topic.topic_name + container_file { + container = "nginx" + file_pattern = "log" + log_path = "/nginx" + namespace = "default" + workload { + container = "nginx" + kind = "deployment" + name = "nginx" + namespace = "default" + } + } + group_id = tencentcloud_cls_machine_group.group.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_flag` - (Required, String) Collection configuration flag. +* `log_type` - (Required, String) Type of the log to be collected. Valid values: json_log: log in JSON format; delimiter_log: log in delimited format; minimalist_log: minimalist log; multiline_log: log in multi-line format; fullregex_log: log in full regex format. Default value: minimalist_log. +* `logset_id` - (Required, String) Logset Id. +* `logset_name` - (Required, String) Logset Name. +* `name` - (Required, String) Collection configuration name. +* `topic_id` - (Required, String) Log topic ID (TopicId) of collection configuration. +* `topic_name` - (Required, String) Topic Name. +* `type` - (Required, String) Type. Valid values: container_stdout; container_file; host_file. +* `container_file` - (Optional, List) Container file path info. +* `container_stdout` - (Optional, List) Container stdout info. +* `exclude_paths` - (Optional, List) Collection path blocklist. +* `extract_rule` - (Optional, List) Extraction rule. If ExtractRule is set, LogType must be set. +* `group_id` - (Optional, String) Binding group id. +* `group_ids` - (Optional, Set: [`String`], ForceNew) Binding group ids. +* `host_file` - (Optional, List) Node file config info. +* `log_format` - (Optional, String) Log format. +* `user_define_rule` - (Optional, String) Custom collection rule, which is a serialized JSON string. + +The `container_file` object supports the following: + +* `container` - (Required, String) Container name. +* `file_pattern` - (Required, String) log name. +* `log_path` - (Required, String) Log Path. +* `namespace` - (Required, String) Namespace. There can be multiple namespaces, separated by separators, such as A, B. +* `exclude_labels` - (Optional, Set) Pod label to be excluded. +* `exclude_namespace` - (Optional, String) Namespaces to be excluded, separated by separators, such as A, B. +* `include_labels` - (Optional, Set) Pod label info. +* `workload` - (Optional, List) Workload info. + +The `container_stdout` object supports the following: + +* `all_containers` - (Required, Bool) Is all containers. +* `exclude_labels` - (Optional, Set) Pod label to be excluded. +* `exclude_namespace` - (Optional, String) Namespaces to be excluded, separated by separators, such as A, B. +* `include_labels` - (Optional, Set) Pod label info. +* `namespace` - (Optional, String) Namespace. There can be multiple namespaces, separated by separators, such as A, B. +* `workloads` - (Optional, List) Workload info. + +The `exclude_paths` object supports the following: + +* `type` - (Optional, String) Type. Valid values: File, Path. +* `value` - (Optional, String) Specific content corresponding to Type. + +The `extract_rule` object supports the following: + +* `backtracking` - (Optional, Int) Size of the data to be rewound in incremental collection mode. Default value: -1 (full collection). +* `begin_regex` - (Optional, String) First-Line matching rule, which is valid only if log_type is multiline_log or fullregex_log. +* `delimiter` - (Optional, String) Delimiter for delimited log, which is valid only if log_type is delimiter_log. +* `filter_key_regex` - (Optional, List) Log keys to be filtered and the corresponding regex. +* `keys` - (Optional, Set) Key name of each extracted field. An empty key indicates to discard the field. This parameter is valid only if log_type is delimiter_log. json_log logs use the key of JSON itself. +* `log_regex` - (Optional, String) Full log matching rule, which is valid only if log_type is fullregex_log. +* `time_format` - (Optional, String) Time field format. For more information, please see the output parameters of the time format description of the strftime function in C language. +* `time_key` - (Optional, String) Time field key name. time_key and time_format must appear in pair. +* `un_match_log_key` - (Optional, String) Unmatched log key. +* `un_match_up_load_switch` - (Optional, Bool) Whether to upload the logs that failed to be parsed. Valid values: true: yes; false: no. + +The `filter_key_regex` object supports the following: + +* `key` - (Optional, String) Log key to be filtered. +* `regex` - (Optional, String) Filter rule regex corresponding to key. + +The `host_file` object supports the following: + +* `file_pattern` - (Required, String) Log file name. +* `log_path` - (Required, String) Log file dir. +* `custom_labels` - (Optional, Set) Metadata info. + +The `workload` object supports the following: + +* `kind` - (Required, String) workload type. +* `name` - (Required, String) workload name. +* `container` - (Optional, String) container name. +* `namespace` - (Optional, String) namespace. + +The `workloads` object supports the following: + +* `kind` - (Required, String) workload type. +* `name` - (Required, String) workload name. +* `container` - (Optional, String) container name. +* `namespace` - (Optional, String) namespace. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls config_extra can be imported using the id, e.g. + +``` +terraform import tencentcloud_cls_config_extra.config_extra config_extra_id +``` + diff --git a/config/docs/r/cls_cos_recharge.html.markdown b/config/docs/r/cls_cos_recharge.html.markdown new file mode 100644 index 0000000..afe5143 --- /dev/null +++ b/config/docs/r/cls_cos_recharge.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_cos_recharge" +sidebar_current: "docs-tencentcloud-resource-cls_cos_recharge" +description: |- + Provides a resource to create a cls cos_recharge +--- + +# tencentcloud_cls_cos_recharge + +Provides a resource to create a cls cos_recharge + +~> **NOTE:** This resource can not be deleted if you run `terraform destroy`. + +## Example Usage + +```hcl +resource "tencentcloud_cls_cos_recharge" "cos_recharge" { + bucket = "cos-lock-1308919341" + bucket_region = "ap-guangzhou" + log_type = "minimalist_log" + logset_id = "dd426d1a-95bc-4bca-b8c2-baa169261812" + name = "cos_recharge_for_test" + prefix = "test" + topic_id = "7e34a3a7-635e-4da8-9005-88106c1fde69" + + extract_rule_info { + backtracking = 0 + is_gbk = 0 + json_standard = 0 + keys = [] + metadata_type = 0 + un_match_up_load_switch = false + + filter_key_regex { + key = "__CONTENT__" + regex = "dasd" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket_region` - (Required, String) cos bucket region. +* `bucket` - (Required, String) cos bucket. +* `log_type` - (Required, String) log type. +* `logset_id` - (Required, String) logset id. +* `name` - (Required, String) recharge name. +* `prefix` - (Required, String) cos file prefix. +* `topic_id` - (Required, String, ForceNew) topic id. +* `compress` - (Optional, String) supported gzip, lzop, snappy. +* `extract_rule_info` - (Optional, List) extract rule info. + +The `extract_rule_info` object supports the following: + +* `address` - (Optional, String) syslog address. +* `backtracking` - (Optional, Int) backtracking data volume in incremental acquisition mode. +* `begin_regex` - (Optional, String) begin line regex. +* `delimiter` - (Optional, String) log delimiter. +* `filter_key_regex` - (Optional, List) rules that need to filter logs. +* `is_gbk` - (Optional, Int) gbk encoding. +* `json_standard` - (Optional, Int) is standard json. +* `keys` - (Optional, Set) key list. +* `log_regex` - (Optional, String) log regex. +* `meta_tags` - (Optional, List) metadata tag list. +* `metadata_type` - (Optional, Int) metadata type. +* `parse_protocol` - (Optional, String) parse protocol. +* `path_regex` - (Optional, String) metadata path regex. +* `protocol` - (Optional, String) syslog protocol. +* `time_format` - (Optional, String) time format. +* `time_key` - (Optional, String) time key. +* `un_match_log_key` - (Optional, String) parsing failure log key. +* `un_match_up_load_switch` - (Optional, Bool) whether to upload the parsing failure log. + +The `filter_key_regex` object supports the following: + +* `key` - (Required, String) need filter log key. +* `regex` - (Required, String) need filter log regex. + +The `meta_tags` object supports the following: + +* `key` - (Optional, String) metadata key. +* `value` - (Optional, String) metadata value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls cos_recharge can be imported using the id, e.g. + +``` +terraform import tencentcloud_cls_cos_recharge.cos_recharge topic_id#cos_recharge_id +``` + diff --git a/config/docs/r/cls_cos_shipper.html.markdown b/config/docs/r/cls_cos_shipper.html.markdown new file mode 100644 index 0000000..8535230 --- /dev/null +++ b/config/docs/r/cls_cos_shipper.html.markdown @@ -0,0 +1,105 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_cos_shipper" +sidebar_current: "docs-tencentcloud-resource-cls_cos_shipper" +description: |- + Provides a resource to create a cls cos shipper. +--- + +# tencentcloud_cls_cos_shipper + +Provides a resource to create a cls cos shipper. + +## Example Usage + +```hcl +resource "tencentcloud_cls_cos_shipper" "shipper" { + bucket = "preset-scf-bucket-1308919341" + interval = 300 + max_size = 200 + partition = "/%Y/%m/%d/%H/" + prefix = "ap-guangzhou-fffsasad-1649734752" + shipper_name = "ap-guangzhou-fffsasad-1649734752" + topic_id = "4d07fba0-b93e-4e0b-9a7f-d58542560bbb" + + compress { + format = "lzop" + } + + content { + format = "json" + + json { + enable_tag = true + meta_fields = [ + "__FILENAME__", + "__SOURCE__", + "__TIMESTAMP__", + ] + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) Destination bucket in the shipping rule to be created. +* `prefix` - (Required, String) Prefix of the shipping directory in the shipping rule to be created. +* `shipper_name` - (Required, String) Shipping rule name. +* `topic_id` - (Required, String) ID of the log topic to which the shipping rule to be created belongs. +* `compress` - (Optional, List) Compression configuration of shipped log. +* `content` - (Optional, List) Format configuration of shipped log content. +* `filter_rules` - (Optional, List) Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped. +* `interval` - (Optional, Int) Shipping time interval in seconds. Default value: 300. Value range: 300~900. +* `max_size` - (Optional, Int) Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100~256. +* `partition` - (Optional, String) Partition rule of shipped log, which can be represented in strftime time format. + +The `compress` object supports the following: + +* `format` - (Required, String) Compression format. Valid values: gzip, lzop, none (no compression). + +The `content` object supports the following: + +* `format` - (Required, String) Content format. Valid values: json, csv. +* `csv` - (Optional, List) CSV format content description.Note: this field may return null, indicating that no valid values can be obtained. +* `json` - (Optional, List) JSON format content description.Note: this field may return null, indicating that no valid values can be obtained. + +The `csv` object supports the following: + +* `delimiter` - (Required, String) Field delimiter. +* `escape_char` - (Required, String) Field delimiter. +* `keys` - (Required, Set) Names of keys.Note: this field may return null, indicating that no valid values can be obtained. +* `non_existing_field` - (Required, String) Content used to populate non-existing fields. +* `print_key` - (Required, Bool) Whether to print key on the first row of the CSV file. + +The `filter_rules` object supports the following: + +* `key` - (Required, String) Filter rule key. +* `regex` - (Required, String) Filter rule. +* `value` - (Required, String) Filter rule value. + +The `json` object supports the following: + +* `enable_tag` - (Required, Bool) Enablement flag. +* `meta_fields` - (Required, Set) Metadata information list +Note: this field may return null, indicating that no valid values can be obtained.. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls cos shipper can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cls_cos_shipper.shipper 5d1b7b2a-c163-4c48-bb01-9ee00584d761 +``` + diff --git a/config/docs/r/cls_data_transform.html.markdown b/config/docs/r/cls_data_transform.html.markdown new file mode 100644 index 0000000..acb5941 --- /dev/null +++ b/config/docs/r/cls_data_transform.html.markdown @@ -0,0 +1,100 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_data_transform" +sidebar_current: "docs-tencentcloud-resource-cls_data_transform" +description: |- + Provides a resource to create a cls data_transform +--- + +# tencentcloud_cls_data_transform + +Provides a resource to create a cls data_transform + +## Example Usage + +```hcl +resource "tencentcloud_cls_logset" "logset_src" { + logset_name = "tf-example-src" + tags = { + "createdBy" = "terraform" + } +} +resource "tencentcloud_cls_topic" "topic_src" { + topic_name = "tf-example_src" + logset_id = tencentcloud_cls_logset.logset_src.id + auto_split = false + max_split_partitions = 20 + partition_count = 1 + period = 10 + storage_type = "hot" + tags = { + "test" = "test", + } +} +resource "tencentcloud_cls_logset" "logset_dst" { + logset_name = "tf-example-dst" + tags = { + "createdBy" = "terraform" + } +} +resource "tencentcloud_cls_topic" "topic_dst" { + topic_name = "tf-example-dst" + logset_id = tencentcloud_cls_logset.logset_dst.id + auto_split = false + max_split_partitions = 20 + partition_count = 1 + period = 10 + storage_type = "hot" + tags = { + "test" = "test", + } +} +resource "tencentcloud_cls_data_transform" "data_transform" { + func_type = 1 + src_topic_id = tencentcloud_cls_topic.topic_src.id + name = "iac-test-src" + etl_content = "ext_sep(\"content\", \"f1, f2, f3\", sep=\",\", quote=\"\", restrict=False, mode=\"overwrite\")fields_drop(\"content\")" + task_type = 3 + enable_flag = 1 + dst_resources { + topic_id = tencentcloud_cls_topic.topic_dst.id + alias = "iac-test-dst" + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `etl_content` - (Required, String) data transform content. +* `func_type` - (Required, Int) task type. +* `name` - (Required, String) task name. +* `src_topic_id` - (Required, String) src topic id. +* `task_type` - (Required, Int) task type. +* `dst_resources` - (Optional, List) data transform des resources. +* `enable_flag` - (Optional, Int) task enable flag. + +The `dst_resources` object supports the following: + +* `alias` - (Required, String) alias. +* `topic_id` - (Required, String) dst topic id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls data_transform can be imported using the id, e.g. + +``` +terraform import tencentcloud_cls_data_transform.data_transform data_transform_id +``` + diff --git a/config/docs/r/cls_export.html.markdown b/config/docs/r/cls_export.html.markdown new file mode 100644 index 0000000..04ae7c9 --- /dev/null +++ b/config/docs/r/cls_export.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_export" +sidebar_current: "docs-tencentcloud-resource-cls_export" +description: |- + Provides a resource to create a cls export +--- + +# tencentcloud_cls_export + +Provides a resource to create a cls export + +## Example Usage + +```hcl +resource "tencentcloud_cls_export" "export" { + topic_id = "7e34a3a7-635e-4da8-9005-88106c1fde69" + log_count = 2 + query = "select count(*) as count" + from = 1607499107000 + to = 1607499108000 + order = "desc" + format = "json" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `from` - (Required, Int, ForceNew) export start time. +* `log_count` - (Required, Int, ForceNew) export amount of log. +* `query` - (Required, String, ForceNew) export query rules. +* `to` - (Required, Int, ForceNew) export end time. +* `topic_id` - (Required, String, ForceNew) topic id. +* `format` - (Optional, String, ForceNew) log export format. +* `order` - (Optional, String, ForceNew) log export time sorting. desc or asc. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls export can be imported using the id, e.g. + +``` +terraform import tencentcloud_cls_export.export topic_id#export_id +``` + diff --git a/config/docs/r/cls_index.html.markdown b/config/docs/r/cls_index.html.markdown new file mode 100644 index 0000000..8b91122 --- /dev/null +++ b/config/docs/r/cls_index.html.markdown @@ -0,0 +1,128 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_index" +sidebar_current: "docs-tencentcloud-resource-cls_index" +description: |- + Provides a resource to create a cls index. +--- + +# tencentcloud_cls_index + +Provides a resource to create a cls index. + +## Example Usage + +```hcl +resource "tencentcloud_cls_index" "index" { + topic_id = "0937e56f-4008-49d2-ad2d-69c52a9f11cc" + + rule { + full_text { + case_sensitive = true + tokenizer = "@&?|#()='\",;:<>[]{}/ \n\t\r\\" + contain_z_h = true + } + + key_value { + case_sensitive = true + key_values { + key = "hello" + value { + contain_z_h = true + sql_flag = true + tokenizer = "@&?|#()='\",;:<>[]{}/ \n\t\r\\" + type = "text" + } + } + + key_values { + key = "world" + value { + contain_z_h = true + sql_flag = true + tokenizer = "@&?|#()='\",;:<>[]{}/ \n\t\r\\" + type = "text" + } + } + } + + tag { + case_sensitive = true + key_values { + key = "terraform" + value { + contain_z_h = true + sql_flag = true + tokenizer = "@&?|#()='\",;:<>[]{}/ \n\t\r\\" + type = "text" + } + } + } + } + status = true + include_internal_fields = true + metadata_flag = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `topic_id` - (Required, String) Log topic ID. +* `include_internal_fields` - (Optional, Bool) Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields. +* `metadata_flag` - (Optional, Int) Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields).. +* `rule` - (Optional, List) Index rule. +* `status` - (Optional, Bool) Whether to take effect. Default value: true. + +The `full_text` object supports the following: + +* `case_sensitive` - (Required, Bool) Case sensitivity. +* `contain_z_h` - (Required, Bool) Whether Chinese characters are contained. +* `tokenizer` - (Required, String) Full-Text index delimiter. Each character in the string represents a delimiter. + +The `key_value` object supports the following: + +* `case_sensitive` - (Required, Bool) Case sensitivity. +* `key_values` - (Optional, List) Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured. + +The `key_values` object supports the following: + +* `key` - (Required, String) When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with __TAG__. and is consistent with the one when logs are uploaded. __TAG__. will be prefixed automatically for display in the console.. +* `value` - (Optional, List) Field index description information. + +The `rule` object supports the following: + +* `full_text` - (Optional, List) Full-Text index configuration. +* `key_value` - (Optional, List) Key-Value index configuration. +* `tag` - (Optional, List) Metafield index configuration. + +The `tag` object supports the following: + +* `case_sensitive` - (Required, Bool) Case sensitivity. +* `key_values` - (Optional, List) Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured. + +The `value` object supports the following: + +* `type` - (Required, String) Field type. Valid values: long, text, double. +* `contain_z_h` - (Optional, Bool) Whether Chinese characters are contained. +* `sql_flag` - (Optional, Bool) Whether the analysis feature is enabled for the field. +* `tokenizer` - (Optional, String) Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls cos index can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cls_index.index 0937e56f-4008-49d2-ad2d-69c52a9f11cc +``` + diff --git a/config/docs/r/cls_kafka_recharge.html.markdown b/config/docs/r/cls_kafka_recharge.html.markdown new file mode 100644 index 0000000..d794c70 --- /dev/null +++ b/config/docs/r/cls_kafka_recharge.html.markdown @@ -0,0 +1,107 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_kafka_recharge" +sidebar_current: "docs-tencentcloud-resource-cls_kafka_recharge" +description: |- + Provides a resource to create a cls kafka_recharge +--- + +# tencentcloud_cls_kafka_recharge + +Provides a resource to create a cls kafka_recharge + +## Example Usage + +```hcl +resource "tencentcloud_cls_logset" "logset" { + logset_name = "tf-example-logset" + tags = { + "createdBy" = "terraform" + } +} +resource "tencentcloud_cls_topic" "topic" { + topic_name = "tf-example-topic" + logset_id = tencentcloud_cls_logset.logset.id + auto_split = false + max_split_partitions = 20 + partition_count = 1 + period = 10 + storage_type = "hot" + tags = { + "test" = "test", + } +} + +resource "tencentcloud_cls_kafka_recharge" "kafka_recharge" { + topic_id = tencentcloud_cls_topic.topic.id + name = "tf-example-recharge" + kafka_type = 0 + offset = -2 + is_encryption_addr = true + user_kafka_topics = "recharge" + kafka_instance = "ckafka-qzoeaqx8" + log_recharge_rule { + recharge_type = "json_log" + encoding_format = 0 + default_time_switch = true + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `kafka_type` - (Required, Int) kafka recharge type, 0 for CKafka, 1 fro user define Kafka. +* `name` - (Required, String) kafka recharge name. +* `offset` - (Required, Int) The translation is: -2: Earliest (default) -1: Latest. +* `topic_id` - (Required, String) recharge for cls TopicId. +* `user_kafka_topics` - (Required, String) user need recharge kafka topic list. +* `consumer_group_name` - (Optional, String) user consumer group name. +* `is_encryption_addr` - (Optional, Bool) ServerAddr is encryption addr. +* `kafka_instance` - (Optional, String) CKafka Instance id. +* `log_recharge_rule` - (Optional, List) log recharge rule. +* `protocol` - (Optional, List) encryption protocol. +* `server_addr` - (Optional, String) Server addr. + +The `log_recharge_rule` object supports the following: + +* `default_time_switch` - (Required, Bool) user default time. +* `encoding_format` - (Required, Int) encoding format. +* `recharge_type` - (Required, String) recharge type. +* `default_time_src` - (Optional, Int) default time from. +* `keys` - (Optional, Set) log key list. +* `log_regex` - (Optional, String) log regex. +* `metadata` - (Optional, Set) metadata. +* `time_format` - (Optional, String) time format. +* `time_key` - (Optional, String) time key. +* `time_regex` - (Optional, String) time regex. +* `time_zone` - (Optional, String) time zone. +* `un_match_log_key` - (Optional, String) parse failed log key. +* `un_match_log_switch` - (Optional, Bool) is push parse failed log. +* `un_match_log_time_src` - (Optional, Int) parse failed log time from. + +The `protocol` object supports the following: + +* `mechanism` - (Optional, String) encryption type. +* `password` - (Optional, String) user password. +* `protocol` - (Optional, String) protocol type. +* `user_name` - (Optional, String) username. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls kafka_recharge can be imported using the id, e.g. + +``` +terraform import tencentcloud_cls_kafka_recharge.kafka_recharge kafka_recharge_id +``` + diff --git a/config/docs/r/cls_logset.html.markdown b/config/docs/r/cls_logset.html.markdown new file mode 100644 index 0000000..0e7c649 --- /dev/null +++ b/config/docs/r/cls_logset.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_logset" +sidebar_current: "docs-tencentcloud-resource-cls_logset" +description: |- + Provides a resource to create a cls logset +--- + +# tencentcloud_cls_logset + +Provides a resource to create a cls logset + +## Example Usage + +```hcl +resource "tencentcloud_cls_logset" "logset" { + logset_name = "demo" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `logset_name` - (Required, String) Logset name, which must be unique. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time. +* `role_name` - If assumer_uin is not empty, it indicates the service provider who creates the logset. +* `topic_count` - Number of log topics in logset. + + +## Import + +cls logset can be imported using the id, e.g. +``` +$ terraform import tencentcloud_cls_logset.logset logset_id +``` + diff --git a/config/docs/r/cls_machine_group.html.markdown b/config/docs/r/cls_machine_group.html.markdown new file mode 100644 index 0000000..220b813 --- /dev/null +++ b/config/docs/r/cls_machine_group.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_machine_group" +sidebar_current: "docs-tencentcloud-resource-cls_machine_group" +description: |- + Provides a resource to create a cls machine group. +--- + +# tencentcloud_cls_machine_group + +Provides a resource to create a cls machine group. + +## Example Usage + +```hcl +resource "tencentcloud_cls_machine_group" "group" { + group_name = "group" + service_logging = true + tags = { + "test" = "test1" + } + update_end_time = "19:05:40" + update_start_time = "17:05:40" + + machine_group_type { + type = "ip" + values = [ + "192.168.1.1", + "192.168.1.2", + ] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_name` - (Required, String) Machine group name, which must be unique. +* `machine_group_type` - (Required, List) Type of the machine group to be created. +* `auto_update` - (Optional, Bool, ForceNew) Whether to enable automatic update for the machine group. +* `service_logging` - (Optional, Bool) Whether to enable the service log to record the logs generated by the LogListener service itself. After it is enabled, the internal logset cls_service_logging and the loglistener_status, loglistener_alarm, and loglistener_business log topics will be created, which will not incur fees. +* `tags` - (Optional, Map) Tag description list. Up to 10 tag key-value pairs are supported and must be unique. +* `update_end_time` - (Optional, String, ForceNew) Update end time. We recommend you update LogListener during off-peak hours. +* `update_start_time` - (Optional, String, ForceNew) Update start time. We recommend you update LogListener during off-peak hours. + +The `machine_group_type` object supports the following: + +* `type` - (Required, String) Machine group type. Valid values: ip: the IP addresses of collection machines are stored in Values of the machine group; label: the tags of the machines are stored in Values of the machine group. +* `values` - (Required, List) Machine description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls machine group can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cls_machine_group.group caf168e7-32cd-4ac6-bf89-1950a760e09c +``` + diff --git a/config/docs/r/cls_scheduled_sql.html.markdown b/config/docs/r/cls_scheduled_sql.html.markdown new file mode 100644 index 0000000..5356e4a --- /dev/null +++ b/config/docs/r/cls_scheduled_sql.html.markdown @@ -0,0 +1,98 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_scheduled_sql" +sidebar_current: "docs-tencentcloud-resource-cls_scheduled_sql" +description: |- + Provides a resource to create a cls scheduled_sql +--- + +# tencentcloud_cls_scheduled_sql + +Provides a resource to create a cls scheduled_sql + +## Example Usage + +```hcl +resource "tencentcloud_cls_logset" "logset" { + logset_name = "tf-example-logset" + tags = { + "createdBy" = "terraform" + } +} +resource "tencentcloud_cls_topic" "topic" { + topic_name = "tf-example-topic" + logset_id = tencentcloud_cls_logset.logset.id + auto_split = false + max_split_partitions = 20 + partition_count = 1 + period = 10 + storage_type = "hot" + tags = { + "test" = "test", + } +} +resource "tencentcloud_cls_scheduled_sql" "scheduled_sql" { + src_topic_id = tencentcloud_cls_topic.topic.id + name = "tf-example-task" + enable_flag = 1 + dst_resource { + topic_id = tencentcloud_cls_topic.topic.id + region = "ap-guangzhou" + biz_type = 0 + metric_name = "test" + + } + scheduled_sql_content = "xxx" + process_start_time = 1690515360000 + process_type = 1 + process_period = 10 + process_time_window = "@m-15m,@m" + process_delay = 5 + src_topic_region = "ap-guangzhou" + process_end_time = 1690515360000 + syntax_rule = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dst_resource` - (Required, List) scheduled slq dst resource. +* `enable_flag` - (Required, Int) task enable flag. +* `name` - (Required, String) task name. +* `process_delay` - (Required, Int) process delay. +* `process_period` - (Required, Int) process period. +* `process_start_time` - (Required, Int) process start timestamp. +* `process_time_window` - (Required, String) process time window. +* `process_type` - (Required, Int) process type. +* `scheduled_sql_content` - (Required, String) scheduled sql content. +* `src_topic_id` - (Required, String) src topic id. +* `src_topic_region` - (Required, String) src topic region. +* `process_end_time` - (Optional, Int) process end timestamp. +* `syntax_rule` - (Optional, Int) syntax rule. + +The `dst_resource` object supports the following: + +* `topic_id` - (Required, String) dst topic id. +* `biz_type` - (Optional, Int) topic type. +* `metric_name` - (Optional, String) metric name. +* `region` - (Optional, String) topic region. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls scheduled_sql can be imported using the id, e.g. + +``` +terraform import tencentcloud_cls_scheduled_sql.scheduled_sql scheduled_sql_id +``` + diff --git a/config/docs/r/cls_topic.html.markdown b/config/docs/r/cls_topic.html.markdown new file mode 100644 index 0000000..e42a2fe --- /dev/null +++ b/config/docs/r/cls_topic.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Cloud Log Service(CLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cls_topic" +sidebar_current: "docs-tencentcloud-resource-cls_topic" +description: |- + Provides a resource to create a cls topic. +--- + +# tencentcloud_cls_topic + +Provides a resource to create a cls topic. + +## Example Usage + +```hcl +resource "tencentcloud_cls_topic" "topic" { + topic_name = "topic" + logset_id = "5cd3a17e-fb0b-418c-afd7-77b365397426" + auto_split = false + max_split_partitions = 20 + partition_count = 1 + period = 10 + storage_type = "hot" + tags = { + "test" = "test", + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `logset_id` - (Required, String) Logset ID. +* `topic_name` - (Required, String) Log topic name. +* `auto_split` - (Optional, Bool) Whether to enable automatic split. Default value: true. +* `max_split_partitions` - (Optional, Int) Maximum number of partitions to split into for this topic if automatic split is enabled. Default value: 50. +* `partition_count` - (Optional, Int) Number of log topic partitions. Default value: 1. Maximum value: 10. +* `period` - (Optional, Int) Lifecycle in days. Value range: 1~366. Default value: 30. +* `storage_type` - (Optional, String) Log topic storage class. Valid values: hot: real-time storage; cold: offline storage. Default value: hot. If cold is passed in, please contact the customer service to add the log topic to the allowlist first.. +* `tags` - (Optional, Map) Tag description list. Up to 10 tag key-value pairs are supported and must be unique. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cls topic can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cls_topic.topic 2f5764c1-c833-44c5-84c7-950979b2a278 +``` + diff --git a/config/docs/r/container_cluster.html.markdown b/config/docs/r/container_cluster.html.markdown new file mode 100644 index 0000000..9aa52c4 --- /dev/null +++ b/config/docs/r/container_cluster.html.markdown @@ -0,0 +1,94 @@ +--- +subcategory: "Container Cluster" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_container_cluster" +sidebar_current: "docs-tencentcloud-resource-container_cluster" +description: |- + Provides a TencentCloud Container Cluster resource. +--- + +# tencentcloud_container_cluster + +Provides a TencentCloud Container Cluster resource. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_kubernetes_cluster. + +## Example Usage + +```hcl +resource "tencentcloud_container_cluster" "foo" { + cluster_name = "terraform-acc-test" + cpu = 1 + mem = 1 + os_name = "ubuntu16.04.1 LTSx86_64" + bandwidth = 1 + bandwidth_type = "PayByHour" + require_wan_ip = 1 + subnet_id = "subnet-abcdabc" + is_vpc_gateway = 0 + storage_size = 0 + root_size = 50 + goods_num = 1 + password = "Admin12345678" + vpc_id = "vpc-abcdabc" + cluster_cidr = "10.0.2.0/24" + ignore_cluster_cidr_conflict = 0 + cvm_type = "PayByHour" + cluster_desc = "foofoofoo" + period = 1 + zone_id = 100004 + instance_type = "S2.SMALL1" + mount_target = "" + docker_graph_path = "" + instance_name = "bar-vm" + cluster_version = "1.7.8" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bandwidth_type` - (Required, String) The network type of the node. +* `bandwidth` - (Required, Int) The network bandwidth of the node. +* `cluster_cidr` - (Required, String) The CIDR which the cluster is going to use. +* `cluster_name` - (Required, String) The name of the cluster. +* `goods_num` - (Required, Int) The node number is going to create in the cluster. +* `instance_type` - (Required, String) The instance type of the node needed by cvm. +* `is_vpc_gateway` - (Required, Int) Describe whether the node enable the gateway capability. +* `os_name` - (Required, String) The system os name of the node. +* `root_size` - (Required, Int) The size of the root volume. +* `storage_size` - (Required, Int) The size of the data volume. +* `subnet_id` - (Required, String) The subnet id which the node stays in. +* `vpc_id` - (Required, String) Specify vpc which the node(s) stay in. +* `zone_id` - (Required, String) The zone which the node stays in. +* `cluster_desc` - (Optional, String) The description of the cluster. +* `cluster_version` - (Optional, String) The kubernetes version of the cluster. +* `cpu` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.16.0. Set 'instance_type' instead. The cpu of the node. +* `cvm_type` - (Optional, String) The type of node needed by cvm. +* `docker_graph_path` - (Optional, String) The docker graph path is going to mounted. +* `instance_name` - (Optional, String) The name ot node. +* `key_id` - (Optional, String) The key_id of each node(if using key pair to access). +* `mem` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.16.0. Set 'instance_type' instead. The memory of the node. +* `mount_target` - (Optional, String) The path which volume is going to be mounted. +* `password` - (Optional, String) The password of each node. +* `period` - (Optional, Int) The puchase duration of the node needed by cvm. +* `require_wan_ip` - (Optional, Int) Indicate whether wan ip is needed. +* `root_type` - (Optional, String) The type of the root volume. see more from CVM. +* `sg_id` - (Optional, String) The security group id. +* `storage_type` - (Optional, String) The type of the data volume. see more from CVM. +* `unschedulable` - (Optional, Int) Determine whether the node will be schedulable. 0 is the default meaning node will be schedulable. 1 for unschedulable. +* `user_script` - (Optional, String) User defined script in a base64-format. The script runs after the kubernetes component is ready on node. see more from CCS api documents. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `kubernetes_version` - The kubernetes version of the cluster. +* `nodes_num` - The node number of the cluster. +* `nodes_status` - The node status of the cluster. +* `total_cpu` - The total cpu of the cluster. +* `total_mem` - The total memory of the cluster. + + diff --git a/config/docs/r/container_cluster_instance.html.markdown b/config/docs/r/container_cluster_instance.html.markdown new file mode 100644 index 0000000..f28b733 --- /dev/null +++ b/config/docs/r/container_cluster_instance.html.markdown @@ -0,0 +1,80 @@ +--- +subcategory: "Container Cluster" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_container_cluster_instance" +sidebar_current: "docs-tencentcloud-resource-container_cluster_instance" +description: |- + Provides a TencentCloud Container Cluster Instance resource. +--- + +# tencentcloud_container_cluster_instance + +Provides a TencentCloud Container Cluster Instance resource. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_kubernetes_scale_worker. + +## Example Usage + +```hcl +resource "tencentcloud_container_cluster_instance" "bar_instance" { + cpu = 1 + mem = 1 + bandwidth = 1 + bandwidth_type = "PayByHour" + require_wan_ip = 1 + is_vpc_gateway = 0 + storage_size = 10 + root_size = 50 + password = "Admin12345678" + cvm_type = "PayByMonth" + period = 1 + zone_id = 100004 + instance_type = "CVM.S2" + mount_target = "/data" + docker_graph_path = "" + subnet_id = "subnet-abcdedf" + cluster_id = "cls-abcdef" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bandwidth_type` - (Required, String) The network type of the node. +* `bandwidth` - (Required, Int) The network bandwidth of the node. +* `cluster_id` - (Required, String) The id of the cluster. +* `is_vpc_gateway` - (Required, Int) Describe whether the node enable the gateway capability. +* `root_size` - (Required, Int) The size of the root volume. +* `storage_size` - (Required, Int) The size of the data volume. +* `subnet_id` - (Required, String) The subnet id which the node stays in. +* `zone_id` - (Required, String) The zone which the node stays in. +* `cpu` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.16.0. Set 'instance_type' instead. The cpu of the node. +* `cvm_type` - (Optional, String) The type of node needed by cvm. +* `docker_graph_path` - (Optional, String) The docker graph path is going to mounted. +* `instance_name` - (Optional, String) The name ot node. +* `instance_type` - (Optional, String) The instance type of the node needed by cvm. +* `key_id` - (Optional, String) The key_id of each node(if using key pair to access). +* `mem` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.16.0. Set 'instance_type' instead. The memory of the node. +* `mount_target` - (Optional, String) The path which volume is going to be mounted. +* `password` - (Optional, String) The password of each node. +* `period` - (Optional, Int) The puchase duration of the node needed by cvm. +* `require_wan_ip` - (Optional, Int) Indicate whether wan ip is needed. +* `root_type` - (Optional, String) The type of the root volume. see more from CVM. +* `sg_id` - (Optional, String) The security group id. +* `storage_type` - (Optional, String) The type of the data volume. see more from CVM. +* `unschedulable` - (Optional, Int) Determine whether the node will be schedulable. 0 is the default meaning node will be schedulable. 1 for unschedulable. +* `user_script` - (Optional, String) User defined script in a base64-format. The script runs after the kubernetes component is ready on node. see more from CCS api documents. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `abnormal_reason` - Describe the reason when node is in abnormal state(if it was). +* `instance_id` - An id identify the node, provided by cvm. +* `is_normal` - Describe whether the node is normal. +* `lan_ip` - Describe the lan ip of the node. +* `wan_ip` - Describe the wan ip of the node. + + diff --git a/config/docs/r/cos_batch.html.markdown b/config/docs/r/cos_batch.html.markdown new file mode 100644 index 0000000..a4ee603 --- /dev/null +++ b/config/docs/r/cos_batch.html.markdown @@ -0,0 +1,166 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_batch" +sidebar_current: "docs-tencentcloud-resource-cos_batch" +description: |- + Provides a resource to create a cos bucket batch. +--- + +# tencentcloud_cos_batch + +Provides a resource to create a cos bucket batch. + +## Example Usage + +```hcl +resource "tencentcloud_cos_batch" "cos_batch" { + uin = "100022975249" + appid = "1308919341" + confirmation_required = true + description = "cos_batch" + priority = 1 + status = "Cancelled" + role_arn = "qcs::cam::uin/100022975249:roleName/COSBatch_QCSRole" + manifest { + location { + etag = "64357de8fd75a3abae2200135a2c9627" + object_arn = "qcs::cos:ap-guangzhou:uid/1308919341:keep-test-1308919341/cos_bucket_inventory/1308919341/keep-test/test/20230621/manifest.json" + } + spec { + format = "COSInventoryReport_CSV_V1" + } + } + operation { + cos_put_object_copy { + access_control_directive = "Copy" + metadata_directive = "Copy" + prefix_replace = false + storage_class = "STANDARD" + tagging_directive = "Copy" + target_resource = "qcs::cos:ap-guangzhou:uid/1308919341:cos-lock-1308919341" + } + } + report { + bucket = "qcs::cos:ap-guangzhou:uid/1308919341:keep-test-1308919341" + enabled = "true" + format = "Report_CSV_V1" + report_scope = "AllTasks" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `appid` - (Required, Int, ForceNew) Appid. +* `manifest` - (Required, List, ForceNew) List of objects to be processed. +* `operation` - (Required, List, ForceNew) Select the action to be performed on the objects in the manifest file. +* `priority` - (Required, Int) Mission priority. The higher the value, the higher the priority of the task. Priority values range from 0 to 2147483647. +* `report` - (Required, List, ForceNew) Task completion report. +* `role_arn` - (Required, String, ForceNew) COS resource identifier, which is used to identify the role you created. You need this resource identifier to verify your identity. +* `uin` - (Required, String, ForceNew) Uin. +* `confirmation_required` - (Optional, Bool, ForceNew) Whether to confirm before performing the task. The default is false. +* `description` - (Optional, String, ForceNew) Mission description. If you configured this information when you created the task, the content is returned. The description length ranges from 0 to 256 bytes. +* `status` - (Optional, String) Current status of the task. +Legal parameter values include Active, Cancelled, Cancelling, Complete, Completing, Failed, Failing, New, Paused, Pausing, Preparing, Ready, Suspended. +For Update status, when you move a task to the Ready state, COS will assume that you have confirmed the task and will perform it. When you move a task to the Cancelled state, COS cancels the task. Optional parameters include: Ready, Cancelled. + +The `access_control_grants` object supports the following: + +* `identifier` - (Required, String) User ID (UIN) in qcs format. For example: qcs::cam::uin/100000000001:uin/100000000001. +* `permission` - (Required, String) Specify a permission to be granted. Enumerated value: READ,WRITE,FULL_CONTROL. +* `type_identifier` - (Required, String) Specifies the type of Identifier. Currently, only user ID is supported. Enumerated value: ID. +* `display_name` - (Optional, String) User name. + +The `cos_initiate_restore_object` object supports the following: + +* `expiration_in_days` - (Required, Int) Sets the number of days after which the copy will be automatically expired and deleted, an integer in the range of 1-365. +* `job_tier` - (Required, String) Select archive recovery model. Available values: Bulk, Standard. + +The `cos_put_object_copy` object supports the following: + +* `target_resource` - (Required, String) Sets the target bucket for the Copy. Use qcs to specify, for example, qcs::cos:ap-chengdu:uid/1250000000:examplebucket-1250000000. +* `access_control_directive` - (Optional, String) This element specifies how ACL is copied. Valid values: +- Copy: inherits the source object ACL +- Replaced: replace source ACL +- Add: add a new ACL based on the source ACL. +* `access_control_grants` - (Optional, List) Controls the specific access to the object. +* `canned_access_control_list` - (Optional, String) Defines the ACL property of the object. Valid values: private, public-read. +* `metadata_directive` - (Optional, String) This element specifies whether to copy object metadata from the source object or replace it with metadata in the < NewObjectMetadata > element. Valid values are: Copy, Replaced, Add. Copy: inherit source object metadata; Replaced: replace source metadata; Add: add new metadata based on source metadata. +* `modified_since_constraint` - (Optional, Int) When the object is modified after the specified time, the operation is performed, otherwise 412 is returned. +* `new_object_metadata` - (Optional, List) Configure the metadata for the object. +* `new_object_tagging` - (Optional, List) The label of the configuration object, which must be specified when the < TaggingDirective > value is Replace or Add. +* `prefix_replace` - (Optional, Bool) Specifies whether the prefix of the source object needs to be replaced. A value of true indicates the replacement object prefix, which needs to be used with and . Default value: false. +* `resources_prefix` - (Optional, String) This field is valid only when the < PrefixReplace > value is true. Specify the source object prefix to be replaced, and the replacement directory should end with `/`. Can be empty with a maximum length of 1024 bytes. +* `storage_class` - (Optional, String) Sets the storage level of the object. Enumerated value: STANDARD,STANDARD_IA. Default value: STANDARD. +* `tagging_directive` - (Optional, String) This element specifies whether to copy the object tag from the source object or replace it with the tag in the < NewObjectTagging > element. Valid values are: Copy, Replaced, Add. Copy: inherits the source object tag; Replaced: replaces the source tag; Add: adds a new tag based on the source tag. +* `target_key_prefix` - (Optional, String) This field is valid only when the value is true. This value represents the replaced prefix, and the replacement directory should end with /. Can be empty with a maximum length of 1024 bytes. +* `unmodified_since_constraint` - (Optional, Int) When the object has not been modified after the specified time, the operation is performed, otherwise 412 is returned. + +The `location` object supports the following: + +* `etag` - (Required, String) Specifies the etag of the object list. Length 1-1024 bytes. +* `object_arn` - (Required, String) Specifies the unique resource identifier of the object manifest, which is 1-1024 bytes long. +* `object_version_id` - (Optional, String) Specifies the version of the object manifest ID, which is 1-1024 bytes long. + +The `manifest` object supports the following: + +* `location` - (Required, List) The location information of the list of objects. +* `spec` - (Required, List) Format information that describes the list of objects. If it is a CSV file, this element describes the fields contained in the manifest. + +The `new_object_metadata` object supports the following: + +* `cache_control` - (Optional, String) The caching instructions defined in RFC 2616 are saved as object metadata. +* `content_disposition` - (Optional, String) The file name defined in RFC 2616 is saved as object metadata. +* `content_encoding` - (Optional, String) The encoding format defined in RFC 2616 is saved as object metadata. +* `content_type` - (Optional, String) The content types defined in RFC 2616 are saved as object metadata. +* `http_expires_date` - (Optional, String) The cache expiration time defined in RFC 2616 is saved as object metadata. +* `sse_algorithm` - (Optional, String) Server encryption algorithm. Currently, only AES256 is supported. +* `user_metadata` - (Optional, List) Includes user-defined metadata. + +The `new_object_tagging` object supports the following: + +* `key` - (Required, String) key. +* `value` - (Required, String) value. + +The `operation` object supports the following: + +* `cos_initiate_restore_object` - (Optional, List) Specifies the specific parameters for the batch restore operation for archive storage type objects in the inventory. +* `cos_put_object_copy` - (Optional, List) Specifies the specific parameters for the batch copy operation on the objects in the list. + +The `report` object supports the following: + +* `bucket` - (Required, String) Delivery bucket for task completion reports. +* `enabled` - (Required, String) Whether to output the task completion report. +* `format` - (Required, String) Task completion report format information. Legal value: Report_CSV_V1. +* `report_scope` - (Required, String) Task completion report the task information that needs to be recorded to determine whether to record the execution information of all operations or the information of failed operations. Legal values: AllTasks, FailedTasksOnly. +* `prefix` - (Optional, String) Prefix information for the task completion report. Length 0-256 bytes. + +The `spec` object supports the following: + +* `format` - (Required, String) Specifies the format information for the list of objects. Legal fields are: COSBatchOperations_CSV_V1, COSInventoryReport_CSV_V1. +* `fields` - (Optional, List) Describes the fields contained in the listing, which you need to use to specify CSV file fields when Format is COSBatchOperations_CSV_V1. Legal fields are: Ignore, Bucket, Key, VersionId. + +The `user_metadata` object supports the following: + +* `key` - (Required, String) key. +* `value` - (Required, String) value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `job_id` - Job id. + + +## Import + +cos bucket batch can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cos_batch.cos_batch ${uin}#${appid}#{job_id} +``` + diff --git a/config/docs/r/cos_bucket.html.markdown b/config/docs/r/cos_bucket.html.markdown new file mode 100644 index 0000000..978d618 --- /dev/null +++ b/config/docs/r/cos_bucket.html.markdown @@ -0,0 +1,343 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_bucket" +sidebar_current: "docs-tencentcloud-resource-cos_bucket" +description: |- + Provides a COS resource to create a COS bucket and set its attributes. +--- + +# tencentcloud_cos_bucket + +Provides a COS resource to create a COS bucket and set its attributes. + +## Example Usage + +### Private Bucket + +```hcl +data "tencentcloud_user_info" "info" {} + +locals { + app_id = data.tencentcloud_user_info.info.app_id +} + +resource "tencentcloud_cos_bucket" "private_sbucket" { + bucket = "private-bucket-${local.app_id}" + acl = "private" +} +``` + +### Creation of multiple available zone bucket + +```hcl +data "tencentcloud_user_info" "info" {} + +locals { + app_id = data.tencentcloud_user_info.info.app_id +} + +resource "tencentcloud_cos_bucket" "multi_zone_bucket" { + bucket = "multi-zone-bucket-${local.app_id}" + acl = "private" + multi_az = true + versioning_enable = true + force_clean = true +} +``` + +### Using verbose acl + +```hcl +data "tencentcloud_user_info" "info" {} + +locals { + app_id = data.tencentcloud_user_info.info.app_id +} + +resource "tencentcloud_cos_bucket" "bucket_with_acl" { + bucket = "bucketwith-acl-${local.app_id}" + # NOTE: Specify the acl_body by the priority sequence of permission and user type with the following sequence: `CanonicalUser with READ`, `CanonicalUser with WRITE`, `CanonicalUser with FULL_CONTROL`, `CanonicalUser with WRITE_ACP`, `CanonicalUser with READ_ACP`, then specify the `Group` of permissions same as `CanonicalUser`. + acl_body = < + + qcs::cam::uin/100022975249:uin/100022975249 + qcs::cam::uin/100022975249:uin/100022975249 + + + + + http://cam.qcloud.com/groups/global/AllUsers + + READ + + + + qcs::cam::uin/100022975249:uin/100022975249 + qcs::cam::uin/100022975249:uin/100022975249 + + FULL_CONTROL + + + + qcs::cam::uin/100022975249:uin/100022975249 + qcs::cam::uin/100022975249:uin/100022975249 + + WRITE_ACP + + + + http://cam.qcloud.com/groups/global/AllUsers + + READ_ACP + + + + http://cam.qcloud.com/groups/global/AllUsers + + WRITE_ACP + + + + qcs::cam::uin/100022975249:uin/100022975249 + qcs::cam::uin/100022975249:uin/100022975249 + + READ + + + + qcs::cam::uin/100022975249:uin/100022975249 + qcs::cam::uin/100022975249:uin/100022975249 + + WRITE + + + + http://cam.qcloud.com/groups/global/AllUsers + + FULL_CONTROL + + + +EOF +} +``` + +### Static Website + +```hcl +data "tencentcloud_user_info" "info" {} + +locals { + app_id = data.tencentcloud_user_info.info.app_id +} + +resource "tencentcloud_cos_bucket" "bucket_with_static_website" { + bucket = "bucket-with-static-website-${local.app_id}" + + website { + index_document = "index.html" + error_document = "error.html" + } +} + +output "endpoint_test" { + value = tencentcloud_cos_bucket.bucket_with_static_website.website.0.endpoint +} +``` + +### Using CORS + +```hcl +data "tencentcloud_user_info" "info" {} + +locals { + app_id = data.tencentcloud_user_info.info.app_id +} + +resource "tencentcloud_cos_bucket" "bucket_with_cors" { + bucket = "bucket-with-cors-${local.app_id}" + acl = "public-read-write" + + cors_rules { + allowed_origins = ["http://*.abc.com"] + allowed_methods = ["PUT", "POST"] + allowed_headers = ["*"] + max_age_seconds = 300 + expose_headers = ["Etag"] + } +} +``` + +### Using object lifecycle + +```hcl +data "tencentcloud_user_info" "info" {} + +locals { + app_id = data.tencentcloud_user_info.info.app_id +} + +resource "tencentcloud_cos_bucket" "bucket_with_lifecycle" { + bucket = "bucket-with-lifecycle-${local.app_id}" + acl = "public-read-write" + + lifecycle_rules { + filter_prefix = "path1/" + + transition { + days = 30 + storage_class = "STANDARD_IA" + } + + expiration { + days = 90 + } + } +} +``` + +### Using replication + +```hcl +data "tencentcloud_user_info" "info" {} + +locals { + app_id = data.tencentcloud_user_info.info.app_id + uin = data.tencentcloud_user_info.info.uin + owner_uin = data.tencentcloud_user_info.info.owner_uin + region = "ap-guangzhou" +} + +resource "tencentcloud_cos_bucket" "bucket_replicate" { + bucket = "bucket-replicate-${local.app_id}" + acl = "private" + versioning_enable = true +} + +resource "tencentcloud_cos_bucket" "bucket_with_replication" { + bucket = "bucket-with-replication-${local.app_id}" + acl = "private" + versioning_enable = true + replica_role = "qcs::cam::uin/${local.owner_uin}:uin/${local.uin}" + replica_rules { + id = "test-rep1" + status = "Enabled" + prefix = "dist" + destination_bucket = "qcs::cos:${local.region}::${tencentcloud_cos_bucket.bucket_replicate.bucket}" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) The name of a bucket to be created. Bucket format should be [custom name]-[appid], for example `mycos-1258798060`. +* `acceleration_enable` - (Optional, Bool) Enable bucket acceleration. +* `acl_body` - (Optional, String) ACL XML body for multiple grant info. NOTE: this argument will overwrite `acl`. Check https://intl.cloud.tencent.com/document/product/436/7737 for more detail. +* `acl` - (Optional, String) The canned ACL to apply. Valid values: private, public-read, and public-read-write. Defaults to private. +* `cors_rules` - (Optional, List) A rule of Cross-Origin Resource Sharing (documented below). +* `enable_intelligent_tiering` - (Optional, Bool) Enable intelligent tiering. NOTE: When intelligent tiering configuration is enabled, it cannot be turned off or modified. +* `encryption_algorithm` - (Optional, String) The server-side encryption algorithm to use. Valid value is `AES256`. +* `force_clean` - (Optional, Bool) Force cleanup all objects before delete bucket. +* `intelligent_tiering_days` - (Optional, Int) Specifies the limit of days for standard-tier data to low-frequency data in an intelligent tiered storage configuration, with optional days of 30, 60, 90. Default value is 30. +* `intelligent_tiering_request_frequent` - (Optional, Int) Specify the access limit for converting standard layer data into low-frequency layer data in the configuration. The default value is once, which can be used in combination with the number of days to achieve the conversion effect. For example, if the parameter is set to 1 and the number of access days is 30, it means that objects with less than one visit in 30 consecutive days will be reduced from the standard layer to the low frequency layer. +* `lifecycle_rules` - (Optional, List) A configuration of object lifecycle management (documented below). +* `log_enable` - (Optional, Bool) Indicate the access log of this bucket to be saved or not. Default is `false`. If set `true`, the access log will be saved with `log_target_bucket`. To enable log, the full access of log service must be granted. [Full Access Role Policy](https://intl.cloud.tencent.com/document/product/436/16920). +* `log_prefix` - (Optional, String) The prefix log name which saves the access log of this bucket per 5 minutes. Eg. `MyLogPrefix/`. The log access file format is `log_target_bucket`/`log_prefix`{YYYY}/{MM}/{DD}/{time}_{random}_{index}.gz. Only valid when `log_enable` is `true`. +* `log_target_bucket` - (Optional, String) The target bucket name which saves the access log of this bucket per 5 minutes. The log access file format is `log_target_bucket`/`log_prefix`{YYYY}/{MM}/{DD}/{time}_{random}_{index}.gz. Only valid when `log_enable` is `true`. User must have full access on this bucket. +* `multi_az` - (Optional, Bool, ForceNew) Indicates whether to create a bucket of multi available zone. +* `origin_domain_rules` - (Optional, List) Bucket Origin Domain settings. +* `origin_pull_rules` - (Optional, List) Bucket Origin-Pull settings. +* `replica_role` - (Optional, String) Request initiator identifier, format: `qcs::cam::uin/:uin/`. NOTE: only `versioning_enable` is true can configure this argument. +* `replica_rules` - (Optional, List) List of replica rule. NOTE: only `versioning_enable` is true and `replica_role` set can configure this argument. +* `tags` - (Optional, Map) The tags of a bucket. +* `versioning_enable` - (Optional, Bool) Enable bucket versioning. NOTE: The `multi_az` feature is true for the current bucket, cannot disable version control. +* `website` - (Optional, List) A website object(documented below). + +The `cors_rules` object supports the following: + +* `allowed_headers` - (Required, List) Specifies which headers are allowed. +* `allowed_methods` - (Required, List) Specifies which methods are allowed. Can be `GET`, `PUT`, `POST`, `DELETE` or `HEAD`. +* `allowed_origins` - (Required, List) Specifies which origins are allowed. +* `expose_headers` - (Optional, List) Specifies expose header in the response. +* `max_age_seconds` - (Optional, Int) Specifies time in seconds that browser can cache the response for a preflight request. + +The `expiration` object supports the following: + +* `date` - (Optional, String) Specifies the date after which you want the corresponding action to take effect. +* `days` - (Optional, Int) Specifies the number of days after object creation when the specific rule action takes effect. +* `delete_marker` - (Optional, Bool) Indicates whether the delete marker of an expired object will be removed. + +The `lifecycle_rules` object supports the following: + +* `filter_prefix` - (Required, String) Object key prefix identifying one or more objects to which the rule applies. +* `expiration` - (Optional, Set) Specifies a period in the object's expire (documented below). +* `id` - (Optional, String) A unique identifier for the rule. It can be up to 255 characters. +* `non_current_expiration` - (Optional, Set) Specifies when non current object versions shall expire. +* `non_current_transition` - (Optional, Set) Specifies a period in the non current object's transitions. +* `transition` - (Optional, Set) Specifies a period in the object's transitions (documented below). + +The `non_current_expiration` object supports the following: + +* `non_current_days` - (Optional, Int) Number of days after non current object creation when the specific rule action takes effect. The maximum value is 3650. + +The `non_current_transition` object supports the following: + +* `storage_class` - (Required, String) Specifies the storage class to which you want the non current object to transition. Available values include `STANDARD_IA`, `MAZ_STANDARD_IA`, `INTELLIGENT_TIERING`, `MAZ_INTELLIGENT_TIERING`, `ARCHIVE`, `DEEP_ARCHIVE`. For more information, please refer to: https://cloud.tencent.com/document/product/436/33417. +* `non_current_days` - (Optional, Int) Number of days after non current object creation when the specific rule action takes effect. + +The `origin_domain_rules` object supports the following: + +* `domain` - (Required, String) Specify domain host. +* `status` - (Optional, String) Domain status, default: `ENABLED`. +* `type` - (Optional, String) Specify origin domain type, available values: `REST`, `WEBSITE`, `ACCELERATE`, default: `REST`. + +The `origin_pull_rules` object supports the following: + +* `host` - (Required, String) Allows only a domain name or IP address. You can optionally append a port number to the address. +* `priority` - (Required, Int) Priority of origin-pull rules, do not set the same value for multiple rules. +* `custom_http_headers` - (Optional, Map) Specifies the custom headers that you can add for COS to access your origin server. +* `follow_http_headers` - (Optional, Set) Specifies the pass through headers when accessing the origin server. +* `follow_query_string` - (Optional, Bool) Specifies whether to pass through COS request query string when accessing the origin server. +* `follow_redirection` - (Optional, Bool) Specifies whether to follow 3XX redirect to another origin server to pull data from. +* `prefix` - (Optional, String) Triggers the origin-pull rule when the requested file name matches this prefix. +* `protocol` - (Optional, String) the protocol used for COS to access the specified origin server. The available value include `HTTP`, `HTTPS` and `FOLLOW`. +* `sync_back_to_source` - (Optional, Bool) If `true`, COS will not return 3XX status code when pulling data from an origin server. Current available zone: ap-beijing, ap-shanghai, ap-singapore, ap-mumbai. + +The `replica_rules` object supports the following: + +* `destination_bucket` - (Required, String) Destination bucket identifier, format: `qcs::cos:::`. NOTE: destination bucket must enable versioning. +* `status` - (Required, String) Status identifier, available values: `Enabled`, `Disabled`. +* `destination_storage_class` - (Optional, String) Storage class of destination, available values: `STANDARD`, `INTELLIGENT_TIERING`, `STANDARD_IA`. default is following current class of destination. +* `id` - (Optional, String) Name of a specific rule. +* `prefix` - (Optional, String) Prefix matching policy. Policies cannot overlap; otherwise, an error will be returned. To match the root directory, leave this parameter empty. + +The `transition` object supports the following: + +* `storage_class` - (Required, String) Specifies the storage class to which you want the object to transition. Available values include `STANDARD_IA`, `MAZ_STANDARD_IA`, `INTELLIGENT_TIERING`, `MAZ_INTELLIGENT_TIERING`, `ARCHIVE`, `DEEP_ARCHIVE`. For more information, please refer to: https://cloud.tencent.com/document/product/436/33417. +* `date` - (Optional, String) Specifies the date after which you want the corresponding action to take effect. +* `days` - (Optional, Int) Specifies the number of days after object creation when the specific rule action takes effect. + +The `website` object supports the following: + +* `error_document` - (Optional, String) An absolute path to the document to return in case of a 4XX error. +* `index_document` - (Optional, String) COS returns this index document when requests are made to the root domain or any of the subfolders. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `cos_bucket_url` - The URL of this cos bucket. + + +## Import + +COS bucket can be imported, e.g. + +``` +$ terraform import tencentcloud_cos_bucket.bucket bucket-name +``` + diff --git a/config/docs/r/cos_bucket_domain_certificate_attachment.html.markdown b/config/docs/r/cos_bucket_domain_certificate_attachment.html.markdown new file mode 100644 index 0000000..e4cd386 --- /dev/null +++ b/config/docs/r/cos_bucket_domain_certificate_attachment.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_bucket_domain_certificate_attachment" +sidebar_current: "docs-tencentcloud-resource-cos_bucket_domain_certificate_attachment" +description: |- + Provides a resource to attach/detach the corresponding certificate for the domain name in specified cos bucket. +--- + +# tencentcloud_cos_bucket_domain_certificate_attachment + +Provides a resource to attach/detach the corresponding certificate for the domain name in specified cos bucket. + +## Example Usage + +```hcl +resource "tencentcloud_cos_bucket_domain_certificate_attachment" "foo" { + bucket = "" + domain_certificate { + domain = "domain_name" + certificate { + cert_type = "CustomCert" + custom_cert { + cert = "===CERTIFICATE===" + private_key = "===PRIVATE_KEY===" + } + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) Bucket name. +* `domain_certificate` - (Required, List, ForceNew) The certificate of specified doamin. + +The `certificate` object supports the following: + +* `cert_type` - (Required, String) Certificate type. +* `custom_cert` - (Required, List) Custom certificate. + +The `custom_cert` object supports the following: + +* `cert` - (Required, String) Public key of certificate. +* `private_key` - (Required, String) Private key of certificate. + +The `domain_certificate` object supports the following: + +* `certificate` - (Required, List) Certificate info. +* `domain` - (Required, String) The name of domain. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cos_bucket_generate_inventory_immediately_operation.html.markdown b/config/docs/r/cos_bucket_generate_inventory_immediately_operation.html.markdown new file mode 100644 index 0000000..26f2a76 --- /dev/null +++ b/config/docs/r/cos_bucket_generate_inventory_immediately_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_bucket_generate_inventory_immediately_operation" +sidebar_current: "docs-tencentcloud-resource-cos_bucket_generate_inventory_immediately_operation" +description: |- + Provides a resource to generate a cos bucket inventory immediately +--- + +# tencentcloud_cos_bucket_generate_inventory_immediately_operation + +Provides a resource to generate a cos bucket inventory immediately + +## Example Usage + +```hcl +resource "tencentcloud_cos_bucket_generate_inventory_immediately_operation" "generate_inventory_immediately" { + inventory_id = "test" + bucket = "keep-test-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) Bucket. +* `inventory_id` - (Required, String, ForceNew) The id of inventory. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cos_bucket_inventory.html.markdown b/config/docs/r/cos_bucket_inventory.html.markdown new file mode 100644 index 0000000..f5ec04f --- /dev/null +++ b/config/docs/r/cos_bucket_inventory.html.markdown @@ -0,0 +1,101 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_bucket_inventory" +sidebar_current: "docs-tencentcloud-resource-cos_bucket_inventory" +description: |- + Provides a resource to create a cos bucket_inventory +--- + +# tencentcloud_cos_bucket_inventory + +Provides a resource to create a cos bucket_inventory + +## Example Usage + +```hcl +resource "tencentcloud_cos_bucket_inventory" "bucket_inventory" { + name = "test123" + bucket = "keep-test-xxxxxx" + is_enabled = "true" + included_object_versions = "Current" + optional_fields { + fields = ["Size", "ETag"] + } + filter { + period { + start_time = "1687276800" + } + } + schedule { + frequency = "Weekly" + } + destination { + bucket = "qcs::cos:ap-guangzhou::keep-test-xxxxxx" + account_id = "" + format = "CSV" + prefix = "cos_bucket_inventory" + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) Bucket name. +* `destination` - (Required, List) Information about the inventory result destination. +* `included_object_versions` - (Required, String) Whether to include object versions in the inventory. All or No. +* `is_enabled` - (Required, String) Whether to enable the inventory. true or false. +* `name` - (Required, String, ForceNew) Inventory Name. +* `schedule` - (Required, List) Inventory job cycle. +* `filter` - (Optional, List) Filters objects prefixed with the specified value to analyze. +* `optional_fields` - (Optional, List) Analysis items to include in the inventory result . + +The `destination` object supports the following: + +* `bucket` - (Required, String) Bucket name. +* `format` - (Required, String) Format of the inventory result. Valid value: CSV. +* `account_id` - (Optional, String) ID of the bucket owner. +* `encryption` - (Optional, List) Server-side encryption for the inventory result. +* `prefix` - (Optional, String) Prefix of the inventory result. + +The `encryption` object supports the following: + +* `sse_cos` - (Optional, String) Encryption with COS-managed key. This field can be left empty. + +The `filter` object supports the following: + +* `period` - (Optional, List) Creation time range of the objects to analyze. +* `prefix` - (Optional, String) Prefix of the objects to analyze. + +The `optional_fields` object supports the following: + +* `fields` - (Optional, Set) Optional analysis items to include in the inventory result. The optional fields include Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, Tag, Crc64, and x-cos-meta-*. + +The `period` object supports the following: + +* `end_time` - (Optional, String) Creation end time of the objects to analyze. The parameter is a timestamp in seconds, for example, 1568688762. +* `start_time` - (Optional, String) Creation start time of the objects to analyze. The parameter is a timestamp in seconds, for example, 1568688761. + +The `schedule` object supports the following: + +* `frequency` - (Required, String) Frequency of the inventory job. Enumerated values: Daily, Weekly. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cos bucket_inventory can be imported using the id, e.g. + +``` +terraform import tencentcloud_cos_bucket_inventory.bucket_inventory bucket_inventory_id +``` + diff --git a/config/docs/r/cos_bucket_object.html.markdown b/config/docs/r/cos_bucket_object.html.markdown new file mode 100644 index 0000000..b698c62 --- /dev/null +++ b/config/docs/r/cos_bucket_object.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_bucket_object" +sidebar_current: "docs-tencentcloud-resource-cos_bucket_object" +description: |- + Provides a COS object resource to put an object(content or file) to the bucket. +--- + +# tencentcloud_cos_bucket_object + +Provides a COS object resource to put an object(content or file) to the bucket. + +## Example Usage + +### Uploading a file to a bucket + +```hcl +resource "tencentcloud_cos_bucket_object" "myobject" { + bucket = "mycos-1258798060" + key = "new_object_key" + source = "path/to/file" +} +``` + +### Uploading a content to a bucket + +```hcl +resource "tencentcloud_cos_bucket" "mycos" { + bucket = "mycos-1258798060" + acl = "public-read" +} + +resource "tencentcloud_cos_bucket_object" "myobject" { + bucket = tencentcloud_cos_bucket.mycos.bucket + key = "new_object_key" + content = "the content that you want to upload." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) The name of a bucket to use. Bucket format should be [custom name]-[appid], for example `mycos-1258798060`. +* `key` - (Required, String, ForceNew) The name of the object once it is in the bucket. +* `acl` - (Optional, String) The canned ACL to apply. Available values include `private`, `public-read`, and `public-read-write`. Defaults to `private`. +* `cache_control` - (Optional, String) Specifies caching behavior along the request/reply chain. For further details, RFC2616 can be referred. +* `content_disposition` - (Optional, String) Specifies presentational information for the object. +* `content_encoding` - (Optional, String) Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. +* `content_type` - (Optional, String) A standard MIME type describing the format of the object data. +* `content` - (Optional, String) Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text. +* `etag` - (Optional, String) The ETag generated for the object (an MD5 sum of the object content). +* `source` - (Optional, String) The path to the source file being uploaded to the bucket. +* `storage_class` - (Optional, String) Object storage type, Available values include `STANDARD_IA`, `MAZ_STANDARD_IA`, `INTELLIGENT_TIERING`, `MAZ_INTELLIGENT_TIERING`, `ARCHIVE`, `DEEP_ARCHIVE`. For more information, please refer to: https://cloud.tencent.com/document/product/436/33417. +* `tags` - (Optional, Map) Tag of the object. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cos_bucket_policy.html.markdown b/config/docs/r/cos_bucket_policy.html.markdown new file mode 100644 index 0000000..de18bae --- /dev/null +++ b/config/docs/r/cos_bucket_policy.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_bucket_policy" +sidebar_current: "docs-tencentcloud-resource-cos_bucket_policy" +description: |- + Provides a COS resource to create a COS bucket policy and set its attributes. +--- + +# tencentcloud_cos_bucket_policy + +Provides a COS resource to create a COS bucket policy and set its attributes. + +## Example Usage + +```hcl +resource "tencentcloud_cos_bucket_policy" "cos_policy" { + bucket = "mycos-1258798060" + + policy = <:uin/" + ] + }, + "Action": [ + "name/cos:DeleteBucket", + "name/cos:PutBucketACL" + ], + "Effect": "allow", + "Resource": [ + "qcs::cos::uid/:/*" + ] + } + ] +} +EOF +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) The name of a bucket to be created. Bucket format should be [custom name]-[appid], for example `mycos-1258798060`. +* `policy` - (Required, String) The text of the policy. For more info please refer to [Tencent official doc](https://intl.cloud.tencent.com/document/product/436/18023). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +COS bucket policy can be imported, e.g. + +``` +$ terraform import tencentcloud_cos_bucket_policy.bucket bucket-name +``` + diff --git a/config/docs/r/cos_bucket_referer.html.markdown b/config/docs/r/cos_bucket_referer.html.markdown new file mode 100644 index 0000000..304a502 --- /dev/null +++ b/config/docs/r/cos_bucket_referer.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_bucket_referer" +sidebar_current: "docs-tencentcloud-resource-cos_bucket_referer" +description: |- + Provides a resource to create a cos bucket_referer +--- + +# tencentcloud_cos_bucket_referer + +Provides a resource to create a cos bucket_referer + +## Example Usage + +```hcl +resource "tencentcloud_cos_bucket_referer" "bucket_referer" { + bucket = "mycos-1258798060" + status = "Enabled" + referer_type = "Black-List" + domain_list = ["127.0.0.1", "terraform.com"] + empty_refer_configuration = "Allow" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) Bucket format should be [custom name]-[appid], for example `mycos-1258798060`. +* `domain_list` - (Required, Set: [`String`]) A list of domain names in the blocklist/allowlist. +* `referer_type` - (Required, String) Hotlink protection type. Enumerated values: `Black-List`, `White-List`. +* `status` - (Required, String) Whether to enable hotlink protection. Enumerated values: `Enabled`, `Disabled`. +* `empty_refer_configuration` - (Optional, String) Whether to allow access with an empty referer. Enumerated values: `Allow`, `Deny` (default). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cos bucket_referer can be imported using the id, e.g. + +``` +terraform import tencentcloud_cos_bucket_referer.bucket_referer bucket_id +``` + diff --git a/config/docs/r/cos_bucket_version.html.markdown b/config/docs/r/cos_bucket_version.html.markdown new file mode 100644 index 0000000..3e4b160 --- /dev/null +++ b/config/docs/r/cos_bucket_version.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_bucket_version" +sidebar_current: "docs-tencentcloud-resource-cos_bucket_version" +description: |- + Provides a resource to create a cos bucket_version +--- + +# tencentcloud_cos_bucket_version + +Provides a resource to create a cos bucket_version + +## Example Usage + +```hcl +resource "tencentcloud_cos_bucket_version" "bucket_version" { + bucket = "mycos-1258798060" + status = "Enabled" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String) Bucket format should be [custom name]-[appid], for example `mycos-1258798060`. +* `status` - (Required, String) Whether to enable versioning. Valid values: `Suspended`, `Enabled`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cos bucket_version can be imported using the id, e.g. + +``` +terraform import tencentcloud_cos_bucket_version.bucket_version bucket_id +``` + diff --git a/config/docs/r/cos_object_abort_multipart_upload_operation.html.markdown b/config/docs/r/cos_object_abort_multipart_upload_operation.html.markdown new file mode 100644 index 0000000..4b03645 --- /dev/null +++ b/config/docs/r/cos_object_abort_multipart_upload_operation.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_object_abort_multipart_upload_operation" +sidebar_current: "docs-tencentcloud-resource-cos_object_abort_multipart_upload_operation" +description: |- + Provides a resource to abort multipart upload +--- + +# tencentcloud_cos_object_abort_multipart_upload_operation + +Provides a resource to abort multipart upload + +## Example Usage + +```hcl +resource "tencentcloud_cos_object_abort_multipart_upload_operation" "abort_multipart_upload" { + bucket = "keep-test-xxxxxx" + key = "object" + upload_id = "xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) Bucket. +* `key` - (Required, String, ForceNew) Object key. +* `upload_id` - (Required, String, ForceNew) Multipart uploaded id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cos_object_copy_operation.html.markdown b/config/docs/r/cos_object_copy_operation.html.markdown new file mode 100644 index 0000000..fe34721 --- /dev/null +++ b/config/docs/r/cos_object_copy_operation.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_object_copy_operation" +sidebar_current: "docs-tencentcloud-resource-cos_object_copy_operation" +description: |- + Provides a resource to copy object +--- + +# tencentcloud_cos_object_copy_operation + +Provides a resource to copy object + +## Example Usage + +```hcl +resource "tencentcloud_cos_object_copy_operation" "object_copy" { + bucket = "keep-copy-xxxxxxx" + key = "copy-acl.txt" + source_url = "keep-test-xxxxxx.cos.ap-guangzhou.myqcloud.com/acl.txt" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) Bucket. +* `key` - (Required, String, ForceNew) Object key. +* `source_url` - (Required, String, ForceNew) Object key. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cos_object_download_operation.html.markdown b/config/docs/r/cos_object_download_operation.html.markdown new file mode 100644 index 0000000..d6a360f --- /dev/null +++ b/config/docs/r/cos_object_download_operation.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_object_download_operation" +sidebar_current: "docs-tencentcloud-resource-cos_object_download_operation" +description: |- + Provides a resource to download object +--- + +# tencentcloud_cos_object_download_operation + +Provides a resource to download object + +## Example Usage + +```hcl +resource "tencentcloud_cos_object_download_operation" "object_download" { + bucket = "xxxxxxx" + key = "test.txt" + download_path = "/tmp/test.txt" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) Bucket. +* `download_path` - (Required, String, ForceNew) Download path. +* `key` - (Required, String, ForceNew) Object key. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cos_object_restore_operation.html.markdown b/config/docs/r/cos_object_restore_operation.html.markdown new file mode 100644 index 0000000..bec0a9c --- /dev/null +++ b/config/docs/r/cos_object_restore_operation.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Cloud Object Storage(COS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cos_object_restore_operation" +sidebar_current: "docs-tencentcloud-resource-cos_object_restore_operation" +description: |- + Provides a resource to restore object +--- + +# tencentcloud_cos_object_restore_operation + +Provides a resource to restore object + +## Example Usage + +```hcl +resource "tencentcloud_cos_object_restore_operation" "object_restore" { + bucket = "keep-test-1308919341" + key = "test-restore.txt" + tier = "Expedited" + days = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) Bucket. +* `days` - (Required, Int, ForceNew) Specifies the valid duration of the restored temporary copy in days. +* `key` - (Required, String, ForceNew) Object key. +* `tier` - (Required, String, ForceNew) when restoring, Tier can be specified as the supported recovery model. +There are three recovery models for recovering archived storage type data, which are: +- Expedited: quick retrieval mode, and the recovery task can be completed in 1-5 minutes. +- Standard: standard retrieval mode. Recovery task is completed within 3-5 hours. +- Bulk: batch retrieval mode, and the recovery task is completed within 5-12 hours. +For deep recovery archive storage type data, there are two recovery models, which are: +- Standard: standard retrieval mode, recovery time is 12-24 hours. +- Bulk: batch retrieval mode, recovery time is 24-48 hours. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/css_authenticate_domain_owner_operation.html.markdown b/config/docs/r/css_authenticate_domain_owner_operation.html.markdown new file mode 100644 index 0000000..107d4ec --- /dev/null +++ b/config/docs/r/css_authenticate_domain_owner_operation.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_authenticate_domain_owner_operation" +sidebar_current: "docs-tencentcloud-resource-css_authenticate_domain_owner_operation" +description: |- + Provides a resource to verify the domain ownership by specified way when DomainNeedVerifyOwner failed in domain creation. +--- + +# tencentcloud_css_authenticate_domain_owner_operation + +Provides a resource to verify the domain ownership by specified way when DomainNeedVerifyOwner failed in domain creation. + +## Example Usage + +### dnsCheck way: + +```hcl +resource "tencentcloud_css_authenticate_domain_owner_operation" "dnsCheck" { + domain_name = "your_domain_name" + verify_type = "dnsCheck" +} +``` + +### fileCheck way: + +```hcl +resource "tencentcloud_css_authenticate_domain_owner_operation" "fileCheck" { + domain_name = "your_domain_name" + verify_type = "fileCheck" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_name` - (Required, String, ForceNew) The domain name to verify. +* `verify_type` - (Optional, String, ForceNew) Authentication type. Possible values:`dnsCheck`: Immediately verify whether the resolution record of the configured dns is consistent with the content to be verified, and save the record if successful.`fileCheck`: Immediately verify whether the web file is consistent with the content to be verified, and save the record if successful.`dbCheck`: Check if authentication has been successful. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/css_backup_stream.html.markdown b/config/docs/r/css_backup_stream.html.markdown new file mode 100644 index 0000000..c8deb3d --- /dev/null +++ b/config/docs/r/css_backup_stream.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_backup_stream" +sidebar_current: "docs-tencentcloud-resource-css_backup_stream" +description: |- + Provides a resource to create a css backup_stream +--- + +# tencentcloud_css_backup_stream + +Provides a resource to create a css backup_stream + +~> **NOTE:** This resource is only valid when the push stream. When the push stream ends, it will be deleted. + +## Example Usage + +```hcl +resource "tencentcloud_css_backup_stream" "backup_stream" { + push_domain_name = "177154.push.tlivecloud.com" + app_name = "live" + stream_name = "1308919341_test" + upstream_sequence = "2209501773993286139" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `app_name` - (Required, String, ForceNew) App name. +* `push_domain_name` - (Required, String, ForceNew) Push domain. +* `stream_name` - (Required, String, ForceNew) Stream id. +* `upstream_sequence` - (Required, String) Sequence. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css backup_stream can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_backup_stream.backup_stream pushDomainName#appName#streamName +``` + diff --git a/config/docs/r/css_callback_rule_attachment.html.markdown b/config/docs/r/css_callback_rule_attachment.html.markdown new file mode 100644 index 0000000..bff5487 --- /dev/null +++ b/config/docs/r/css_callback_rule_attachment.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_callback_rule_attachment" +sidebar_current: "docs-tencentcloud-resource-css_callback_rule_attachment" +description: |- + Provides a resource to create a css callback_rule +--- + +# tencentcloud_css_callback_rule_attachment + +Provides a resource to create a css callback_rule + +## Example Usage + +```hcl +resource "tencentcloud_css_callback_rule_attachment" "callback_rule" { + domain_name = "177154.push.tlivecloud.com" + template_id = 434039 + app_name = "live" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `app_name` - (Required, String, ForceNew) The streaming path is consistent with the AppName in the streaming and playback addresses. The default is live. +* `domain_name` - (Required, String, ForceNew) Streaming domain name. +* `template_id` - (Required, Int, ForceNew) Template ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css callback_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_callback_rule_attachment.callback_rule templateId#domainName +``` + diff --git a/config/docs/r/css_callback_template.html.markdown b/config/docs/r/css_callback_template.html.markdown new file mode 100644 index 0000000..80e19fa --- /dev/null +++ b/config/docs/r/css_callback_template.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_callback_template" +sidebar_current: "docs-tencentcloud-resource-css_callback_template" +description: |- + Provides a resource to create a css callback_template +--- + +# tencentcloud_css_callback_template + +Provides a resource to create a css callback_template + +## Example Usage + +```hcl +resource "tencentcloud_css_callback_template" "callback_template" { + template_name = "tf-test" + description = "this is demo" + stream_begin_notify_url = "http://www.yourdomain.com/api/notify?action=streamBegin" + stream_end_notify_url = "http://www.yourdomain.com/api/notify?action=streamEnd" + record_notify_url = "http://www.yourdomain.com/api/notify?action=record" + snapshot_notify_url = "http://www.yourdomain.com/api/notify?action=snapshot" + porn_censorship_notify_url = "http://www.yourdomain.com/api/notify?action=porn" + callback_key = "adasda131312" + push_exception_notify_url = "http://www.yourdomain.com/api/notify?action=pushException" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `template_name` - (Required, String) Template name.Maximum length: 255 bytes. Only `Chinese`, `English`, `numbers`, `_`, `-` are supported. +* `callback_key` - (Optional, String) Callback Key, public callback URL. +* `description` - (Optional, String) Description information.Maximum length: 1024 bytes.Only `Chinese`, `English`, `numbers`, `_`, `-` are supported. +* `porn_censorship_notify_url` - (Optional, String) PornCensorship callback URL. +* `push_exception_notify_url` - (Optional, String) Streaming Exception Callback URL. +* `record_notify_url` - (Optional, String) Recording callback URL. +* `snapshot_notify_url` - (Optional, String) Snapshot callback URL. +* `stream_begin_notify_url` - (Optional, String) Launch callback URL. +* `stream_end_notify_url` - (Optional, String) Cutoff callback URL. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css callback_template can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_callback_template.callback_template templateId +``` + diff --git a/config/docs/r/css_domain.html.markdown b/config/docs/r/css_domain.html.markdown new file mode 100644 index 0000000..79769d3 --- /dev/null +++ b/config/docs/r/css_domain.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_domain" +sidebar_current: "docs-tencentcloud-resource-css_domain" +description: |- + Provides a resource to create a css domain +--- + +# tencentcloud_css_domain + +Provides a resource to create a css domain + +## Example Usage + +```hcl +resource "tencentcloud_css_domain" "domain" { + domain_name = "iac-tf.cloud" + domain_type = 0 + play_type = 1 + is_delay_live = 0 + is_mini_program_live = 0 + verify_owner_type = "dbCheck" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_name` - (Required, String) Domain Name. +* `domain_type` - (Required, Int) Domain type: `0`: push stream. `1`: playback. +* `enable` - (Optional, Bool) Switch. true: enable the specified domain, false: disable the specified domain. +* `is_delay_live` - (Optional, Int) Whether it is LCB: `0`: LVB. `1`: LCB. Default value is 0. +* `is_mini_program_live` - (Optional, Int) `0`: LVB. `1`: LVB on Mini Program. Note: this field may return null, indicating that no valid values can be obtained. Default value is 0. +* `play_type` - (Optional, Int) Play Type. This parameter is valid only if `DomainType` is 1. Available values: `1`: in Mainland China. `2`: global. `3`: outside Mainland China. Default value is 1. +* `verify_owner_type` - (Optional, String) Domain name attribution verification type. `dnsCheck`, `fileCheck`, `dbCheck`. The default is `dbCheck`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css domain can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_domain.domain domain_name +``` + diff --git a/config/docs/r/css_domain_config.html.markdown b/config/docs/r/css_domain_config.html.markdown new file mode 100644 index 0000000..37f863b --- /dev/null +++ b/config/docs/r/css_domain_config.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_domain_config" +sidebar_current: "docs-tencentcloud-resource-css_domain_config" +description: |- + Provides a resource to configure(enable/disable) the css domain. +--- + +# tencentcloud_css_domain_config + +Provides a resource to configure(enable/disable) the css domain. + +## Example Usage + +```hcl +resource "tencentcloud_css_domain_config" "enable_domain" { + domain_name = "your_domain_name" + enable_domain = true +} +``` +```hcl +resource "tencentcloud_css_domain_config" "forbid_domain" { + domain_name = "your_domain_name" + enable_domain = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_name` - (Required, String) Domain Name. +* `enable_domain` - (Required, Bool) Switch. true: enable the specified domain, false: disable the specified domain. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/css_domain_referer.html.markdown b/config/docs/r/css_domain_referer.html.markdown new file mode 100644 index 0000000..eb0ab46 --- /dev/null +++ b/config/docs/r/css_domain_referer.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_domain_referer" +sidebar_current: "docs-tencentcloud-resource-css_domain_referer" +description: |- + Provides a resource to create a css domain_referer +--- + +# tencentcloud_css_domain_referer + +Provides a resource to create a css domain_referer + +## Example Usage + +```hcl +resource "tencentcloud_css_domain_referer" "domain_referer" { + allow_empty = 1 + domain_name = "test122.jingxhu.top" + enable = 0 + rules = "example.com" + type = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `allow_empty` - (Required, Int) Allow blank referers, 0: not allowed, 1: allowed. +* `domain_name` - (Required, String) Domain Name. +* `enable` - (Required, Int) Whether to enable the referer blacklist authentication of the current domain name,`0`: off, `1`: on. +* `rules` - (Required, String) The list of referers to; separate. +* `type` - (Required, Int) List type: 0: blacklist, 1: whitelist. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css domain_referer can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_domain_referer.domain_referer domainName +``` + diff --git a/config/docs/r/css_enable_optimal_switching.html.markdown b/config/docs/r/css_enable_optimal_switching.html.markdown new file mode 100644 index 0000000..1eb8f8b --- /dev/null +++ b/config/docs/r/css_enable_optimal_switching.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_enable_optimal_switching" +sidebar_current: "docs-tencentcloud-resource-css_enable_optimal_switching" +description: |- + Provides a resource to create a css enable_optimal_switching +--- + +# tencentcloud_css_enable_optimal_switching + +Provides a resource to create a css enable_optimal_switching + +~> **NOTE:** This resource is only valid when the push stream. When the push stream ends, it will be deleted. + +## Example Usage + +```hcl +resource "tencentcloud_css_enable_optimal_switching" "enable_optimal_switching" { + stream_name = "1308919341_test" + enable_switch = 1 + host_group_name = "test-group" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `stream_name` - (Required, String, ForceNew) Stream id. +* `enable_switch` - (Optional, Int) `0`:disabled, `1`:enable. +* `host_group_name` - (Optional, String, ForceNew) Group name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css domain can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_enable_optimal_switching.enable_optimal_switching streamName +``` + diff --git a/config/docs/r/css_live_transcode_rule_attachment.html.markdown b/config/docs/r/css_live_transcode_rule_attachment.html.markdown new file mode 100644 index 0000000..dbc88ca --- /dev/null +++ b/config/docs/r/css_live_transcode_rule_attachment.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_live_transcode_rule_attachment" +sidebar_current: "docs-tencentcloud-resource-css_live_transcode_rule_attachment" +description: |- + Provides a resource to create a css live_transcode_rule_attachment +--- + +# tencentcloud_css_live_transcode_rule_attachment + +Provides a resource to create a css live_transcode_rule_attachment + +## Example Usage + +```hcl +resource "tencentcloud_css_pull_stream_task" "task" { + source_type = "%s" + source_urls = ["%s"] + domain_name = "%s" + app_name = "%s" + stream_name = "%s" + start_time = "%s" + end_time = "%s" + operator = "%s" + comment = "This is a demo." +} + +resource "tencentcloud_css_live_transcode_template" "temp" { + template_name = "xxx" + acodec = "aac" + video_bitrate = 100 + vcodec = "origin" + description = "This_is_a_tf_test_temp." + need_video = 1 + need_audio = 1 +} + +resource "tencentcloud_css_live_transcode_rule_attachment" "live_transcode_rule_attachment" { + domain_name = tencentcloud_css_pull_stream_task.task.domain_name + app_name = tencentcloud_css_pull_stream_task.task.app_name + stream_name = tencentcloud_css_pull_stream_task.task.stream_name + template_id = tencentcloud_css_live_transcode_template.temp.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `app_name` - (Required, String, ForceNew) app name which you want to bind, can be empty string if not binding specific app name. +* `domain_name` - (Required, String, ForceNew) domain name hich you want to bind the transcode template. +* `stream_name` - (Required, String, ForceNew) stream name which you want to bind, can be empty string if not binding specific stream. +* `template_id` - (Required, Int, ForceNew) template created by css_live_transcode_template. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - create time. +* `update_time` - update time. + + +## Import + +css live_transcode_rule_attachment can be imported using the id, e.g. +``` +$ terraform import tencentcloud_css_live_transcode_rule_attachment.live_transcode_rule_attachment liveTranscodeRuleAttachment_id +``` + diff --git a/config/docs/r/css_live_transcode_template.html.markdown b/config/docs/r/css_live_transcode_template.html.markdown new file mode 100644 index 0000000..3e771b3 --- /dev/null +++ b/config/docs/r/css_live_transcode_template.html.markdown @@ -0,0 +1,84 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_live_transcode_template" +sidebar_current: "docs-tencentcloud-resource-css_live_transcode_template" +description: |- + Provides a resource to create a css live_transcode_template +--- + +# tencentcloud_css_live_transcode_template + +Provides a resource to create a css live_transcode_template + +## Example Usage + +```hcl +resource "tencentcloud_css_live_transcode_template" "live_transcode_template" { + template_name = "template_name" + acodec = "aac" + audio_bitrate = 128 + video_bitrate = 100 + vcodec = "origin" + description = "This_is_a_tf_test_temp." + need_video = 1 + width = 0 + need_audio = 1 + height = 0 + fps = 0 + gop = 2 + rotate = 0 + profile = "baseline" + bitrate_to_orig = 0 + height_to_orig = 0 + fps_to_orig = 0 + ai_trans_code = 0 + adapt_bitrate_percent = 0 + short_edge_as_height = 0 + drm_type = "fairplay" + drm_tracks = "SD" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `template_name` - (Required, String) template name, only support 0-9 and a-z. +* `video_bitrate` - (Required, Int) video bitrate, 0 for origin, range 0kbps - 8000kbps. +* `acodec` - (Optional, String) default aac, not support now. +* `adapt_bitrate_percent` - (Optional, Float64) high speed mode adapt bitrate, support 0 - 0.5. +* `ai_trans_code` - (Optional, Int) enable high speed mode, default 0, 1 for enable, 0 for no. +* `audio_bitrate` - (Optional, Int) default 0, range 0 - 500. +* `bitrate_to_orig` - (Optional, Int) base on origin bitrate if origin bitrate is lower than the setting bitrate. default 0, 1 for yes, 0 for no. +* `description` - (Optional, String) template desc. +* `drm_tracks` - (Optional, String) DRM tracks, support AUDIO/SD/HD/UHD1/UHD2. +* `drm_type` - (Optional, String) DRM type, support fairplay/normalaes/widevine. +* `fps_to_orig` - (Optional, Int) base on origin fps if origin fps is lower than the setting fps. default 0, 1 for yes, 0 for no. +* `fps` - (Optional, Int) video fps, default 0, range 0 - 60. +* `gop` - (Optional, Int) gop of the video, second, default origin of the video, range 2 - 6. +* `height_to_orig` - (Optional, Int) base on origin height if origin height is lower than the setting height. default 0, 1 for yes, 0 for no. +* `height` - (Optional, Int) template height, default 0, range 0 - 3000, must be pow of 2, needed while AiTransCode = 1. +* `need_audio` - (Optional, Int) keep audio or not, default 1 for yes, 0 for no. +* `need_video` - (Optional, Int) keep video or not, default 1 for yes, 0 for no. +* `profile` - (Optional, String) quality of the video, default baseline, support baseline/main/high. +* `rotate` - (Optional, Int) roate degree, default 0, support 0/90/180/270. +* `short_edge_as_height` - (Optional, Int) let the short edge as the height. +* `vcodec` - (Optional, String) video codec, default origin, support h264/h265/origin. +* `width` - (Optional, Int) template width, default 0, range 0 - 3000, must be pow of 2. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css live_transcode_template can be imported using the id, e.g. +``` +$ terraform import tencentcloud_css_live_transcode_template.live_transcode_template liveTranscodeTemplate_id +``` + diff --git a/config/docs/r/css_pad_rule_attachment.html.markdown b/config/docs/r/css_pad_rule_attachment.html.markdown new file mode 100644 index 0000000..2f6bea5 --- /dev/null +++ b/config/docs/r/css_pad_rule_attachment.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_pad_rule_attachment" +sidebar_current: "docs-tencentcloud-resource-css_pad_rule_attachment" +description: |- + Provides a resource to create a css pad_rule_attachment +--- + +# tencentcloud_css_pad_rule_attachment + +Provides a resource to create a css pad_rule_attachment + +## Example Usage + +```hcl +resource "tencentcloud_css_pad_rule_attachment" "pad_rule_attachment" { + domain_name = "177154.push.tlivecloud.com" + template_id = 17067 + app_name = "qqq" + stream_name = "ppp" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_name` - (Required, String, ForceNew) Push domain. +* `template_id` - (Required, Int, ForceNew) Template id. +* `app_name` - (Optional, String, ForceNew) Push path, must same with play path, default is live. +* `stream_name` - (Optional, String, ForceNew) Stream name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css pad_rule_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_pad_rule_attachment.pad_rule_attachment templateId#domainName +``` + diff --git a/config/docs/r/css_pad_template.html.markdown b/config/docs/r/css_pad_template.html.markdown new file mode 100644 index 0000000..11fdfe0 --- /dev/null +++ b/config/docs/r/css_pad_template.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_pad_template" +sidebar_current: "docs-tencentcloud-resource-css_pad_template" +description: |- + Provides a resource to create a css pad_template +--- + +# tencentcloud_css_pad_template + +Provides a resource to create a css pad_template + +## Example Usage + +```hcl +resource "tencentcloud_css_pad_template" "pad_template" { + description = "pad template" + max_duration = 120000 + template_name = "tf-pad" + type = 1 + url = "https://livewatermark-1251132611.cos.ap-guangzhou.myqcloud.com/1308919341/watermark_img_1698736540399_1441698123618_.pic.jpg" + wait_duration = 2000 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `template_name` - (Required, String) Template namelimit 255 bytes. +* `url` - (Required, String) Pad content. +* `description` - (Optional, String) Description content.limit length 1024 bytes. +* `max_duration` - (Optional, Int) Max pad duration.limit: 0 - 9999999 ms. +* `type` - (Optional, Int) Pad content type.1: picture.2: video.default: 1. +* `wait_duration` - (Optional, Int) Stop stream wait time.limit: 0 - 30000 ms. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css pad_template can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_pad_template.pad_template templateId +``` + diff --git a/config/docs/r/css_play_auth_key_config.html.markdown b/config/docs/r/css_play_auth_key_config.html.markdown new file mode 100644 index 0000000..9d969eb --- /dev/null +++ b/config/docs/r/css_play_auth_key_config.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_play_auth_key_config" +sidebar_current: "docs-tencentcloud-resource-css_play_auth_key_config" +description: |- + Provides a resource to create a css play_auth_key_config +--- + +# tencentcloud_css_play_auth_key_config + +Provides a resource to create a css play_auth_key_config + +## Example Usage + +```hcl +resource "tencentcloud_css_play_auth_key_config" "play_auth_key_config" { + domain_name = "your_play_domain_name" + enable = 1 + auth_key = "testauthkey" + auth_delta = 3600 + auth_back_key = "testbackkey" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_name` - (Required, String) Domain Name. +* `auth_back_key` - (Optional, String) Alternate key for authentication. No transfer means that the current value is not modified. +* `auth_delta` - (Optional, Int) Valid time, unit: second. No transfer means that the current value is not modified. +* `auth_key` - (Optional, String) Authentication key. No transfer means that the current value is not modified. +* `enable` - (Optional, Int) Enable or not, 0: Close, 1: Enable. No transfer means that the current value is not modified. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css play_auth_key_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_play_auth_key_config.play_auth_key_config play_auth_key_config_id +``` + diff --git a/config/docs/r/css_play_domain_cert_attachment.html.markdown b/config/docs/r/css_play_domain_cert_attachment.html.markdown new file mode 100644 index 0000000..67aa4b5 --- /dev/null +++ b/config/docs/r/css_play_domain_cert_attachment.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_play_domain_cert_attachment" +sidebar_current: "docs-tencentcloud-resource-css_play_domain_cert_attachment" +description: |- + Provides a resource to create a css play_domain_cert_attachment. This resource is used for binding the play domain and specified certification together. +--- + +# tencentcloud_css_play_domain_cert_attachment + +Provides a resource to create a css play_domain_cert_attachment. This resource is used for binding the play domain and specified certification together. + +## Example Usage + +```hcl +data "tencentcloud_ssl_certificates" "foo" { + name = "your_ssl_cert" +} + +resource "tencentcloud_css_play_domain_cert_attachment" "play_domain_cert_attachment" { + cloud_cert_id = data.tencentcloud_ssl_certificates.foo.certificates.0.id + domain_info { + domain_name = "your_domain_name" + status = 1 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_info` - (Required, List, ForceNew) The playback domains to bind and whether to enable HTTPS for them. If `CloudCertId` is unspecified, and a domain is already bound with a certificate, this API will only update the HTTPS configuration of the domain. +* `cloud_cert_id` - (Optional, String, ForceNew) Tencent cloud ssl certificate Id. Refer to `tencentcloud_ssl_certificate` to create or obtain the resource ID. + +The `domain_info` object supports the following: + +* `domain_name` - (Required, String) domain name. +* `status` - (Required, Int) Whether to enable the https rule for the domain name. 1: enable, 0: disabled, -1: remain unchanged. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `cert_expire_time` - certificate expiration time. +* `cert_id` - certificate ID. +* `cert_type` - certificate type. 0: Self-owned certificate, 1: Tencent Cloud ssl managed certificate. +* `certificate_alias` - certificate remarks. Synonymous with CertName. +* `update_time` - The time when the rule was last updated. + + +## Import + +css play_domain_cert_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_play_domain_cert_attachment.play_domain_cert_attachment domainName#cloudCertId +``` + diff --git a/config/docs/r/css_pull_stream_task.html.markdown b/config/docs/r/css_pull_stream_task.html.markdown new file mode 100644 index 0000000..01a13c3 --- /dev/null +++ b/config/docs/r/css_pull_stream_task.html.markdown @@ -0,0 +1,84 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_pull_stream_task" +sidebar_current: "docs-tencentcloud-resource-css_pull_stream_task" +description: |- + Provides a resource to create a css pull_stream_task +--- + +# tencentcloud_css_pull_stream_task + +Provides a resource to create a css pull_stream_task + +## Example Usage + +```hcl +resource "tencentcloud_css_pull_stream_task" "pull_stream_task" { + source_type = "source_type" + source_urls = ["source_urls"] + domain_name = "domain_name" + app_name = "app_name" + stream_name = "stream_name" + start_time = "2022-11-16T22:09:28Z" + end_time = "2022-11-16T22:09:28Z" + operator = "admin" + comment = "comment." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `app_name` - (Required, String) push app name. +* `domain_name` - (Required, String) push domain name. +* `end_time` - (Required, String) task end time. +* `source_type` - (Required, String) `PullLivePushLive`: SourceUrls live type, `PullVodPushLive`: SourceUrls vod type. +* `source_urls` - (Required, Set: [`String`]) Pull Source media, SourceType=PullLivePushLive only 1 value, SourceType=PullLivePushLive can input multi values. +* `start_time` - (Required, String) task begin time. +* `stream_name` - (Required, String) push stream name. +* `backup_source_type` - (Optional, String) backup pull source type. +* `backup_source_url` - (Optional, String) backup pull source. +* `callback_events` - (Optional, Set: [`String`]) defind the callback event you need, null for all. TaskStart, TaskExit, VodSourceFileStart, VodSourceFileFinish, ResetTaskConfig, PullFileUnstable, PushStreamUnstable, PullFileFailed, PushStreamFailed, FileEndEarly. +* `callback_url` - (Optional, String) task event callback url. +* `comment` - (Optional, String) desc for pull task. +* `extra_cmd` - (Optional, String) ignore_region for ignore the input region and reblance inside the server. +* `file_index` - (Optional, Int) task enable or disable. +* `offset_time` - (Optional, Int) task enable or disable. +* `operator` - (Optional, String) desc operator user name. +* `push_args` - (Optional, String) other pushing args. +* `status` - (Optional, String) task enable or disable. +* `to_url` - (Optional, String) full target push url, DomainName, AppName, StreamName field must be empty. +* `vod_loop_times` - (Optional, Int) loop time for vod. +* `vod_refresh_type` - (Optional, String) vod refresh method. `ImmediateNewSource`: switch to new source at once, `ContinueBreakPoint`: switch to new source while old source finish. +* `watermark_list` - (Optional, List) watermark list, max 4 setting. + +The `watermark_list` object supports the following: + +* `height` - (Required, Int) pic height. +* `location` - (Required, Int) position type, 0:left top, 1:right top, 2:right bot, 3: left bot. +* `picture_url` - (Required, String) watermark picture url. +* `width` - (Required, Int) pic width. +* `x_position` - (Required, Int) x position. +* `y_position` - (Required, Int) y position. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_by` - desc who create the task. +* `create_time` - create time. +* `region` - task run region. +* `update_by` - desc who update the task. +* `update_time` - update time. + + +## Import + +css pull_stream_task can be imported using the id, e.g. +``` +$ terraform import tencentcloud_css_pull_stream_task.pull_stream_task pullStreamTask_id +``` + diff --git a/config/docs/r/css_pull_stream_task_restart.html.markdown b/config/docs/r/css_pull_stream_task_restart.html.markdown new file mode 100644 index 0000000..4a149bf --- /dev/null +++ b/config/docs/r/css_pull_stream_task_restart.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_pull_stream_task_restart" +sidebar_current: "docs-tencentcloud-resource-css_pull_stream_task_restart" +description: |- + Provides a resource to create a css restart_push_task +--- + +# tencentcloud_css_pull_stream_task_restart + +Provides a resource to create a css restart_push_task + +## Example Usage + +```hcl +resource "tencentcloud_css_pull_stream_task_restart" "restart_push_task" { + task_id = "3573" + operator = "tf-test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `operator` - (Required, String, ForceNew) Task operator. +* `task_id` - (Required, String, ForceNew) Task Id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/css_push_auth_key_config.html.markdown b/config/docs/r/css_push_auth_key_config.html.markdown new file mode 100644 index 0000000..cef29aa --- /dev/null +++ b/config/docs/r/css_push_auth_key_config.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_push_auth_key_config" +sidebar_current: "docs-tencentcloud-resource-css_push_auth_key_config" +description: |- + Provides a resource to create a css push_auth_key_config +--- + +# tencentcloud_css_push_auth_key_config + +Provides a resource to create a css push_auth_key_config + +## Example Usage + +```hcl +resource "tencentcloud_css_push_auth_key_config" "push_auth_key_config" { + domain_name = "your_push_domain_name" + enable = 1 + master_auth_key = "testmasterkey" + backup_auth_key = "testbackkey" + auth_delta = 1800 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_name` - (Required, String) Domain Name. +* `auth_delta` - (Optional, Int) Valid time, unit: second. +* `backup_auth_key` - (Optional, String) Standby authentication key. No transfer means that the current value is not modified. +* `enable` - (Optional, Int) Enable or not, 0: Close, 1: Enable. No transfer means that the current value is not modified. +* `master_auth_key` - (Optional, String) Primary authentication key. No transfer means that the current value is not modified. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css push_auth_key_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_push_auth_key_config.push_auth_key_config push_auth_key_config_id +``` + diff --git a/config/docs/r/css_record_rule_attachment.html.markdown b/config/docs/r/css_record_rule_attachment.html.markdown new file mode 100644 index 0000000..dfe42ff --- /dev/null +++ b/config/docs/r/css_record_rule_attachment.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_record_rule_attachment" +sidebar_current: "docs-tencentcloud-resource-css_record_rule_attachment" +description: |- + Provides a resource to create a css record_rule +--- + +# tencentcloud_css_record_rule_attachment + +Provides a resource to create a css record_rule + +## Example Usage + +```hcl +resource "tencentcloud_css_record_rule_attachment" "record_rule" { + domain_name = "177154.push.tlivecloud.com" + template_id = 1262818 + app_name = "qqq" + stream_name = "ppp" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_name` - (Required, String, ForceNew) Streaming domain name. +* `template_id` - (Required, Int, ForceNew) Template ID. +* `app_name` - (Optional, String, ForceNew) The streaming path is consistent with the AppName in the streaming and playback addresses. The default is live. +* `stream_name` - (Optional, String, ForceNew) Stream name. Note: If this parameter is set to a non empty string, the rule will only work on this streaming. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css record_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_record_rule_attachment.record_rule templateId#domainName +``` + diff --git a/config/docs/r/css_snapshot_rule_attachment.html.markdown b/config/docs/r/css_snapshot_rule_attachment.html.markdown new file mode 100644 index 0000000..f5923c4 --- /dev/null +++ b/config/docs/r/css_snapshot_rule_attachment.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_snapshot_rule_attachment" +sidebar_current: "docs-tencentcloud-resource-css_snapshot_rule_attachment" +description: |- + Provides a resource to create a css snapshot_rule +--- + +# tencentcloud_css_snapshot_rule_attachment + +Provides a resource to create a css snapshot_rule + +## Example Usage + +```hcl +resource "tencentcloud_css_snapshot_rule_attachment" "snapshot_rule" { + domain_name = "177154.push.tlivecloud.com" + template_id = 12838073 + app_name = "qqq" + stream_name = "ppp" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_name` - (Required, String, ForceNew) Streaming domain name. +* `template_id` - (Required, Int, ForceNew) Template ID. +* `app_name` - (Optional, String, ForceNew) The streaming path is consistent with the AppName in the streaming and playback addresses. The default is live. +* `stream_name` - (Optional, String, ForceNew) Stream name. Note: If this parameter is set to a non empty string, the rule will only work on this streaming. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css snapshot_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_snapshot_rule_attachment.snapshot_rule templateId#domainName +``` + diff --git a/config/docs/r/css_snapshot_template.html.markdown b/config/docs/r/css_snapshot_template.html.markdown new file mode 100644 index 0000000..dd9e682 --- /dev/null +++ b/config/docs/r/css_snapshot_template.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_snapshot_template" +sidebar_current: "docs-tencentcloud-resource-css_snapshot_template" +description: |- + Provides a resource to create a css snapshot_template +--- + +# tencentcloud_css_snapshot_template + +Provides a resource to create a css snapshot_template + +## Example Usage + +```hcl +resource "tencentcloud_css_snapshot_template" "snapshot_template" { + cos_app_id = 1308919341 + cos_bucket = "keep-bucket" + cos_region = "ap-guangzhou" + description = "snapshot template" + height = 0 + porn_flag = 0 + snapshot_interval = 2 + template_name = "tf-snapshot-template" + width = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cos_app_id` - (Required, Int) Cos application ID. +* `cos_bucket` - (Required, String) Cos bucket name. Note: The CosBucket parameter value cannot include the - [appid] part. +* `cos_region` - (Required, String) Cos region. +* `template_name` - (Required, String) Template name. Maximum length: 255 bytes. Only Chinese, English, numbers, `_`, `-` are supported. +* `cos_file_name` - (Optional, String) Cos file name. If it is empty, set according to the default value {StreamID}-screenshot-{Hour}-{Minute}-{Second}-{Width}x{Height}{Ext}. +* `cos_prefix` - (Optional, String) Cos Bucket folder prefix. If it is empty, set according to the default value /{Year}-{Month}-{Day}/. +* `description` - (Optional, String) Description information. Maximum length: 1024 bytes. Only `Chinese`, `English`, `numbers`, `_`, `-` are supported. +* `height` - (Optional, Int) Screenshot height. Default: 0 (original height). Range: 0-2000. +* `porn_flag` - (Optional, Int) Whether porn is enabled, 0: not enabled, 1: enabled. Default: 0. +* `snapshot_interval` - (Optional, Int) Screenshot interval, unit: s, default: 10s. Range: 2s~300s. +* `width` - (Optional, Int) Screenshot width. Default: 0 (original width). Range: 0-3000. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css snapshot_template can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_snapshot_template.snapshot_template templateId +``` + diff --git a/config/docs/r/css_start_stream_monitor.html.markdown b/config/docs/r/css_start_stream_monitor.html.markdown new file mode 100644 index 0000000..c8727d0 --- /dev/null +++ b/config/docs/r/css_start_stream_monitor.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_start_stream_monitor" +sidebar_current: "docs-tencentcloud-resource-css_start_stream_monitor" +description: |- + Provides a resource to create a css start_stream_monitor +--- + +# tencentcloud_css_start_stream_monitor + +Provides a resource to create a css start_stream_monitor + +## Example Usage + +```hcl +resource "tencentcloud_css_start_stream_monitor" "start_stream_monitor" { + monitor_id = "3d5738dd-1ca2-4601-a6e9-004c5ec75c0b" + audible_input_index_list = [1] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `monitor_id` - (Required, String, ForceNew) Monitor id. +* `audible_input_index_list` - (Optional, Set: [`Int`], ForceNew) The input index for monitoring the screen audio, supports multiple input audio sources.The valid range for InputIndex is that it must already exist.If left blank, there will be no audio output by default. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css start_stream_monitor can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_start_stream_monitor.start_stream_monitor start_stream_monitor_id +``` + diff --git a/config/docs/r/css_stream_monitor.html.markdown b/config/docs/r/css_stream_monitor.html.markdown new file mode 100644 index 0000000..e2ee5e0 --- /dev/null +++ b/config/docs/r/css_stream_monitor.html.markdown @@ -0,0 +1,105 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_stream_monitor" +sidebar_current: "docs-tencentcloud-resource-css_stream_monitor" +description: |- + Provides a resource to create a css stream_monitor +--- + +# tencentcloud_css_stream_monitor + +Provides a resource to create a css stream_monitor + +## Example Usage + +```hcl +resource "tencentcloud_css_stream_monitor" "stream_monitor" { + ai_asr_input_index_list = [ + 1, + ] + ai_format_diagnose = 1 + ai_ocr_input_index_list = [ + 1, + ] + allow_monitor_report = 1 + asr_language = 1 + check_stream_broken = 1 + check_stream_low_frame_rate = 1 + monitor_name = "test" + ocr_language = 1 + + input_list { + input_app = "live" + input_domain = "177154.push.tlivecloud.com" + input_stream_name = "ppp" + } + + notify_policy { + callback_url = "http://example.com/test" + notify_policy_type = 1 + } + + output_info { + output_domain = "test122.jingxhu.top" + output_stream_height = 1080 + output_stream_name = "afc7847d-1fe1-43bc-b1e4-20d86303c393" + output_stream_width = 1920 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `input_list` - (Required, List) Wait monitor input info list. +* `output_info` - (Required, List) Monitor task output info. +* `ai_asr_input_index_list` - (Optional, Set: [`Int`]) AI asr input index list.(first input index is 1.). +* `ai_format_diagnose` - (Optional, Int) If enable format diagnose. +* `ai_ocr_input_index_list` - (Optional, Set: [`Int`]) Ai ocr input index list(first input index is 1.). +* `allow_monitor_report` - (Optional, Int) If store monitor event. +* `asr_language` - (Optional, Int) Asr language.0: close.1: Chinese2: English3: Japanese4: Korean. +* `check_stream_broken` - (Optional, Int) If enable stream broken check. +* `check_stream_low_frame_rate` - (Optional, Int) If enable low frame rate check. +* `monitor_name` - (Optional, String) Monitor task name. +* `notify_policy` - (Optional, List) Monitor event notify policy. +* `ocr_language` - (Optional, Int) Intelligent text recognition language settings: ocr language.0: close.1. Chinese,English. + +The `input_list` object supports the following: + +* `input_stream_name` - (Required, String) Wait monitor input stream name.limit 256 bytes. +* `description` - (Optional, String) Description content.limit 256 bytes. +* `input_app` - (Optional, String) Wait monitor input push path.limit 32 bytes. +* `input_domain` - (Optional, String) Wait monitor input push domain.limit 128 bytes. +* `input_url` - (Optional, String) Wait monitor input stream push url. + +The `notify_policy` object supports the following: + +* `callback_url` - (Optional, String) Callback url.limit [0,512].only http or https. +* `notify_policy_type` - (Optional, Int) Notify policy type.0: not notify.1: use global policy. + +The `output_info` object supports the following: + +* `output_stream_height` - (Required, Int) Monitor task output height, limit[1, 1080]. +* `output_stream_width` - (Required, Int) Output stream width, limit[1, 1920]. +* `output_app` - (Optional, String) Monitor task play path.limit 32 bytes. +* `output_domain` - (Optional, String) Monitor task output play domain.limit 128 bytes. +* `output_stream_name` - (Optional, String) Monitor task output stream name.limit 256 bytes. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css stream_monitor can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_stream_monitor.stream_monitor stream_monitor_id +``` + diff --git a/config/docs/r/css_timeshift_rule_attachment.html.markdown b/config/docs/r/css_timeshift_rule_attachment.html.markdown new file mode 100644 index 0000000..c5da1bd --- /dev/null +++ b/config/docs/r/css_timeshift_rule_attachment.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_timeshift_rule_attachment" +sidebar_current: "docs-tencentcloud-resource-css_timeshift_rule_attachment" +description: |- + Provides a resource to create a css timeshift_rule_attachment +--- + +# tencentcloud_css_timeshift_rule_attachment + +Provides a resource to create a css timeshift_rule_attachment + +## Example Usage + +```hcl +resource "tencentcloud_css_timeshift_rule_attachment" "timeshift_rule_attachment" { + domain_name = "177154.push.tlivecloud.com" + template_id = 252586 + app_name = "qqq" + stream_name = "ppp" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `app_name` - (Required, String, ForceNew) The push path, which should be the same as `AppName` in the push and playback URLs. The default value is `live`. +* `domain_name` - (Required, String, ForceNew) The push domain. +* `stream_name` - (Required, String, ForceNew) The stream name.Note: If you pass in a non-empty string, the rule will only be applied to the specified stream. +* `template_id` - (Required, Int, ForceNew) The template ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css timeshift_rule_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_timeshift_rule_attachment.timeshift_rule_attachment templateId#domainName +``` + diff --git a/config/docs/r/css_timeshift_template.html.markdown b/config/docs/r/css_timeshift_template.html.markdown new file mode 100644 index 0000000..b6a9220 --- /dev/null +++ b/config/docs/r/css_timeshift_template.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_timeshift_template" +sidebar_current: "docs-tencentcloud-resource-css_timeshift_template" +description: |- + Provides a resource to create a css timeshift_template +--- + +# tencentcloud_css_timeshift_template + +Provides a resource to create a css timeshift_template + +## Example Usage + +```hcl +resource "tencentcloud_css_timeshift_template" "timeshift_template" { + area = "Mainland" + description = "timeshift template" + duration = 604800 + item_duration = 5 + remove_watermark = true + template_name = "tf-test" + transcode_template_ids = [] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `duration` - (Required, Int) The time shifting duration.Unit: Second. +* `template_name` - (Required, String) The template name.Maximum length: 255 bytes.Only letters, numbers, underscores, and hyphens are supported. +* `area` - (Optional, String) The region.`Mainland`: The Chinese mainland.`Overseas`: Outside the Chinese mainland.Default value: `Mainland`. +* `description` - (Optional, String) The template description.Only letters, numbers, underscores, and hyphens are supported. +* `item_duration` - (Optional, Int) The segment size.Value range: 3-10.Unit: Second.Default value: 5. +* `remove_watermark` - (Optional, Bool) Whether to remove watermarks.If you pass in `true`, the original stream will be recorded.Default value: `false`. +* `transcode_template_ids` - (Optional, Set: [`Int`]) The transcoding template IDs.This API works only if `RemoveWatermark` is `false`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +css timeshift_template can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_timeshift_template.timeshift_template templateId +``` + diff --git a/config/docs/r/css_watermark.html.markdown b/config/docs/r/css_watermark.html.markdown new file mode 100644 index 0000000..7101694 --- /dev/null +++ b/config/docs/r/css_watermark.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_watermark" +sidebar_current: "docs-tencentcloud-resource-css_watermark" +description: |- + Provides a resource to create a css watermark +--- + +# tencentcloud_css_watermark + +Provides a resource to create a css watermark + +## Example Usage + +```hcl +resource "tencentcloud_css_watermark" "watermark" { + picture_url = "picture_url" + watermark_name = "watermark_name" + x_position = 0 + y_position = 0 + width = 0 + height = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `picture_url` - (Required, String) watermark url. +* `watermark_name` - (Required, String) watermark name. +* `height` - (Optional, Int) height of the picture. +* `width` - (Optional, Int) width of the picture. +* `x_position` - (Optional, Int) x position of the picture. +* `y_position` - (Optional, Int) y position of the picture. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - status. 0: not used, 1: used. + + +## Import + +css watermark can be imported using the id, e.g. +``` +$ terraform import tencentcloud_css_watermark.watermark watermark_id +``` + diff --git a/config/docs/r/css_watermark_rule_attachment.html.markdown b/config/docs/r/css_watermark_rule_attachment.html.markdown new file mode 100644 index 0000000..8f49710 --- /dev/null +++ b/config/docs/r/css_watermark_rule_attachment.html.markdown @@ -0,0 +1,73 @@ +--- +subcategory: "Cloud Streaming Services(CSS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_css_watermark_rule_attachment" +sidebar_current: "docs-tencentcloud-resource-css_watermark_rule_attachment" +description: |- + Provides a resource to create a css watermark_rule +--- + +# tencentcloud_css_watermark_rule_attachment + +Provides a resource to create a css watermark_rule + +## Example Usage + +### Binding watermark rule with a css stream + +```hcl +resource "tencentcloud_css_pull_stream_task" "example" { + stream_name = "tf_example_stream_name" + source_type = "PullLivePushLive" + source_urls = ["rtmp://xxx.com/live/stream"] + domain_name = "test.domain.com" + app_name = "live" + start_time = "2023-09-27T10:28:21Z" + end_time = "2023-09-27T17:28:21Z" + operator = "tf_admin" + comment = "This is a e2e test case." +} + +resource "tencentcloud_css_watermark" "example" { + picture_url = "picture_url" + watermark_name = "watermark_name" + x_position = 0 + y_position = 0 + width = 0 + height = 0 +} + +resource "tencentcloud_css_watermark_rule_attachment" "watermark_rule_attachment" { + domain_name = tencentcloud_css_pull_stream_task.example.domain_name + app_name = tencentcloud_css_pull_stream_task.example.app_name + stream_name = tencentcloud_css_pull_stream_task.example.stream_name + template_id = tencentcloud_css_watermark.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `app_name` - (Required, String, ForceNew) rule app name. +* `domain_name` - (Required, String, ForceNew) rule domain name. +* `stream_name` - (Required, String, ForceNew) rule stream name. +* `template_id` - (Required, Int, ForceNew) The template Id can be acquired by the Id of `tencentcloud_css_watermark`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - create time. +* `update_time` - update time. + + +## Import + +css watermark_rule_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_css_watermark_rule_attachment.watermark_rule domain_name#app_name#stream_name#template_id +``` + diff --git a/config/docs/r/cvm_chc_assist_vpc.html.markdown b/config/docs/r/cvm_chc_assist_vpc.html.markdown new file mode 100644 index 0000000..bcf4cf0 --- /dev/null +++ b/config/docs/r/cvm_chc_assist_vpc.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_chc_assist_vpc" +sidebar_current: "docs-tencentcloud-resource-cvm_chc_assist_vpc" +description: |- + Provides a resource to create a cvm chc_assist_vpc +--- + +# tencentcloud_cvm_chc_assist_vpc + +Provides a resource to create a cvm chc_assist_vpc + +## Example Usage + +```hcl +resource "tencentcloud_cvm_chc_assist_vpc" "chc_assist_vpc" { + chc_id = "chc-xxxxx" + bmc_virtual_private_cloud { + vpc_id = "vpc-xxxxx" + subnet_id = "subnet-xxxxx" + + } + bmc_security_group_ids = ["sg-xxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bmc_virtual_private_cloud` - (Required, List, ForceNew) Out-of-band network information. +* `chc_id` - (Required, String, ForceNew) CHC host ID. +* `bmc_security_group_ids` - (Optional, Set: [`String`], ForceNew) Out-of-band network security group list. +* `deploy_security_group_ids` - (Optional, Set: [`String`], ForceNew) Deployment network security group list. +* `deploy_virtual_private_cloud` - (Optional, List, ForceNew) Deployment network information. + +The `bmc_virtual_private_cloud` object supports the following: + +* `subnet_id` - (Required, String) VPC subnet ID in the format subnet-xxx. To obtain valid subnet IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call DescribeSubnets and look for the unSubnetId fields in the response. If you specify DEFAULT for both SubnetId and VpcId when creating an instance, the default VPC will be used. +* `vpc_id` - (Required, String) VPC ID in the format of vpc-xxx. To obtain valid VPC IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call the DescribeVpcEx API and look for the unVpcId fields in the response. If you specify DEFAULT for both VpcId and SubnetId when creating an instance, the default VPC will be used. +* `as_vpc_gateway` - (Optional, Bool) Whether to use a CVM instance as a public gateway. The public gateway is only available when the instance has a public IP and resides in a VPC. Valid values:<br><li>TRUE: yes;<br><li>FALSE: no<br><br>Default: FALSE. +* `ipv6_address_count` - (Optional, Int) Number of IPv6 addresses randomly generated for the ENI. +* `private_ip_addresses` - (Optional, Set) Array of VPC subnet IPs. You can use this parameter when creating instances or modifying VPC attributes of instances. Currently you can specify multiple IPs in one subnet only when creating multiple instances at the same time. + +The `deploy_virtual_private_cloud` object supports the following: + +* `subnet_id` - (Required, String) VPC subnet ID in the format subnet-xxx. To obtain valid subnet IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call DescribeSubnets and look for the unSubnetId fields in the response. If you specify DEFAULT for both SubnetId and VpcId when creating an instance, the default VPC will be used. +* `vpc_id` - (Required, String) VPC ID in the format of vpc-xxx. To obtain valid VPC IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call the DescribeVpcEx API and look for the unVpcId fields in the response. If you specify DEFAULT for both VpcId and SubnetId when creating an instance, the default VPC will be used. +* `as_vpc_gateway` - (Optional, Bool) Whether to use a CVM instance as a public gateway. The public gateway is only available when the instance has a public IP and resides in a VPC. Valid values:<br><li>TRUE: yes;<br><li>FALSE: no<br><br>Default: FALSE. +* `ipv6_address_count` - (Optional, Int) Number of IPv6 addresses randomly generated for the ENI. +* `private_ip_addresses` - (Optional, Set) Array of VPC subnet IPs. You can use this parameter when creating instances or modifying VPC attributes of instances. Currently you can specify multiple IPs in one subnet only when creating multiple instances at the same time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cvm chc_assist_vpc can be imported using the id, e.g. + +``` +terraform import tencentcloud_cvm_chc_assist_vpc.chc_assist_vpc chc_assist_vpc_id +``` + diff --git a/config/docs/r/cvm_chc_attribute.html.markdown b/config/docs/r/cvm_chc_attribute.html.markdown new file mode 100644 index 0000000..fc221cc --- /dev/null +++ b/config/docs/r/cvm_chc_attribute.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_chc_attribute" +sidebar_current: "docs-tencentcloud-resource-cvm_chc_attribute" +description: |- + Provides a resource to create a cvm chc_attribute +--- + +# tencentcloud_cvm_chc_attribute + +Provides a resource to create a cvm chc_attribute + +## Example Usage + +```hcl +resource "tencentcloud_cvm_chc_attribute" "chc_attribute" { + chc_id = "chc-xxxxx" + instance_name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `chc_id` - (Required, String, ForceNew) CHC host ID. +* `bmc_security_group_ids` - (Optional, Set: [`String`], ForceNew) BMC network security group list. +* `bmc_user` - (Optional, String, ForceNew) Valid characters: Letters, numbers, hyphens and underscores. +* `device_type` - (Optional, String, ForceNew) Server type. +* `instance_name` - (Optional, String, ForceNew) CHC host name. +* `password` - (Optional, String, ForceNew) The password can contain 8 to 16 characters, including letters, numbers and special symbols (()`~!@#$%^&amp;*-+=_|{}). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cvm_chc_config.html.markdown b/config/docs/r/cvm_chc_config.html.markdown new file mode 100644 index 0000000..44b7898 --- /dev/null +++ b/config/docs/r/cvm_chc_config.html.markdown @@ -0,0 +1,82 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_chc_config" +sidebar_current: "docs-tencentcloud-resource-cvm_chc_config" +description: |- + Provides a resource to create a cvm chc_config +--- + +# tencentcloud_cvm_chc_config + +Provides a resource to create a cvm chc_config + +## Example Usage + +```hcl +resource "tencentcloud_cvm_chc_config" "chc_config" { + chc_id = "chc-xxxxxx" + instance_name = "xxxxxx" + bmc_user = "admin" + password = "xxxxxx" + bmc_virtual_private_cloud { + vpc_id = "vpc-xxxxxx" + subnet_id = "subnet-xxxxxx" + + } + bmc_security_group_ids = ["sg-xxxxxx"] + + deploy_virtual_private_cloud { + vpc_id = "vpc-xxxxxx" + subnet_id = "subnet-xxxxxx" + } + deploy_security_group_ids = ["sg-xxxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `chc_id` - (Required, String, ForceNew) CHC host ID. +* `bmc_security_group_ids` - (Optional, List: [`String`], ForceNew) Out-of-band network security group list. +* `bmc_user` - (Optional, String) Valid characters: Letters, numbers, hyphens and underscores. Only set when update password. +* `bmc_virtual_private_cloud` - (Optional, List, ForceNew) Out-of-band network information. +* `deploy_security_group_ids` - (Optional, List: [`String`], ForceNew) Deployment network security group list. +* `deploy_virtual_private_cloud` - (Optional, List, ForceNew) Deployment network information. +* `device_type` - (Optional, String) Server type. +* `instance_name` - (Optional, String) CHC host name. +* `password` - (Optional, String) The password can contain 8 to 16 characters, including letters, numbers and special symbols (()`~!@#$%^&amp;*-+=_|{}). + +The `bmc_virtual_private_cloud` object supports the following: + +* `subnet_id` - (Required, String, ForceNew) VPC subnet ID in the format subnet-xxx. To obtain valid subnet IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call DescribeSubnets and look for the unSubnetId fields in the response. If you specify DEFAULT for both SubnetId and VpcId when creating an instance, the default VPC will be used. +* `vpc_id` - (Required, String, ForceNew) VPC ID in the format of vpc-xxx. To obtain valid VPC IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call the DescribeVpcEx API and look for the unVpcId fields in the response. If you specify DEFAULT for both VpcId and SubnetId when creating an instance, the default VPC will be used. +* `as_vpc_gateway` - (Optional, Bool, ForceNew) Whether to use a CVM instance as a public gateway. The public gateway is only available when the instance has a public IP and resides in a VPC. Valid values:<br><li>TRUE: yes;<br><li>FALSE: no<br><br>Default: FALSE. +* `ipv6_address_count` - (Optional, Int, ForceNew) Number of IPv6 addresses randomly generated for the ENI. +* `private_ip_addresses` - (Optional, List, ForceNew) Array of VPC subnet IPs. You can use this parameter when creating instances or modifying VPC attributes of instances. Currently you can specify multiple IPs in one subnet only when creating multiple instances at the same time. + +The `deploy_virtual_private_cloud` object supports the following: + +* `subnet_id` - (Required, String, ForceNew) VPC subnet ID in the format subnet-xxx. To obtain valid subnet IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call DescribeSubnets and look for the unSubnetId fields in the response. If you specify DEFAULT for both SubnetId and VpcId when creating an instance, the default VPC will be used. +* `vpc_id` - (Required, String, ForceNew) VPC ID in the format of vpc-xxx. To obtain valid VPC IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call the DescribeVpcEx API and look for the unVpcId fields in the response. If you specify DEFAULT for both VpcId and SubnetId when creating an instance, the default VPC will be used. +* `as_vpc_gateway` - (Optional, Bool, ForceNew) Whether to use a CVM instance as a public gateway. The public gateway is only available when the instance has a public IP and resides in a VPC. Valid values:<br><li>TRUE: yes;<br><li>FALSE: no<br><br>Default: FALSE. +* `ipv6_address_count` - (Optional, Int, ForceNew) Number of IPv6 addresses randomly generated for the ENI. +* `private_ip_addresses` - (Optional, List, ForceNew) Array of VPC subnet IPs. You can use this parameter when creating instances or modifying VPC attributes of instances. Currently you can specify multiple IPs in one subnet only when creating multiple instances at the same time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cvm chc_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_cvm_chc_config.chc_config chc_config_id +``` + diff --git a/config/docs/r/cvm_chc_deploy_vpc.html.markdown b/config/docs/r/cvm_chc_deploy_vpc.html.markdown new file mode 100644 index 0000000..4bde7a9 --- /dev/null +++ b/config/docs/r/cvm_chc_deploy_vpc.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_chc_deploy_vpc" +sidebar_current: "docs-tencentcloud-resource-cvm_chc_deploy_vpc" +description: |- + Provides a resource to create a cvm chc_deploy_vpc +--- + +# tencentcloud_cvm_chc_deploy_vpc + +Provides a resource to create a cvm chc_deploy_vpc + +## Example Usage + +```hcl +resource "tencentcloud_cvm_chc_deploy_vpc" "chc_deploy_vpc" { + chc_id = "chc-xxxxx" + deploy_virtual_private_cloud { + vpc_id = "vpc-xxxxx" + subnet_id = "subnet-xxxxx" + } + deploy_security_group_ids = ["sg-xxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `chc_id` - (Required, String, ForceNew) CHC host ID. +* `deploy_virtual_private_cloud` - (Required, List, ForceNew) Deployment network information. +* `deploy_security_group_ids` - (Optional, Set: [`String`], ForceNew) Deployment network security group list. + +The `deploy_virtual_private_cloud` object supports the following: + +* `subnet_id` - (Required, String) VPC subnet ID in the format subnet-xxx. To obtain valid subnet IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call DescribeSubnets and look for the unSubnetId fields in the response. If you specify DEFAULT for both SubnetId and VpcId when creating an instance, the default VPC will be used. +* `vpc_id` - (Required, String) VPC ID in the format of vpc-xxx. To obtain valid VPC IDs, you can log in to the [console](https://console.tencentcloud.com/vpc/vpc?rid=1) or call the DescribeVpcEx API and look for the unVpcId fields in the response. If you specify DEFAULT for both VpcId and SubnetId when creating an instance, the default VPC will be used. +* `as_vpc_gateway` - (Optional, Bool) Whether to use a CVM instance as a public gateway. The public gateway is only available when the instance has a public IP and resides in a VPC. Valid values:<br><li>TRUE: yes;<br><li>FALSE: no<br><br>Default: FALSE. +* `ipv6_address_count` - (Optional, Int) Number of IPv6 addresses randomly generated for the ENI. +* `private_ip_addresses` - (Optional, Set) Array of VPC subnet IPs. You can use this parameter when creating instances or modifying VPC attributes of instances. Currently you can specify multiple IPs in one subnet only when creating multiple instances at the same time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cvm chc_deploy_vpc can be imported using the id, e.g. + +``` +terraform import tencentcloud_cvm_chc_deploy_vpc.chc_deploy_vpc chc_deploy_vpc_id +``` + diff --git a/config/docs/r/cvm_export_images.html.markdown b/config/docs/r/cvm_export_images.html.markdown new file mode 100644 index 0000000..09e867d --- /dev/null +++ b/config/docs/r/cvm_export_images.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_export_images" +sidebar_current: "docs-tencentcloud-resource-cvm_export_images" +description: |- + Provides a resource to create a cvm export_images +--- + +# tencentcloud_cvm_export_images + +Provides a resource to create a cvm export_images + +## Example Usage + +```hcl +resource "tencentcloud_cvm_export_images" "export_images" { + bucket_name = "xxxxxx" + image_id = "img-xxxxxx" + file_name_prefix = "test-" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket_name` - (Required, String, ForceNew) COS bucket name. +* `file_name_prefix` - (Required, String, ForceNew) Prefix of exported file. +* `image_id` - (Required, String, ForceNew) Image ID. +* `dry_run` - (Optional, Bool, ForceNew) Check whether the image can be exported. +* `export_format` - (Optional, String, ForceNew) Format of the exported image file. Valid values: RAW, QCOW2, VHD and VMDK. Default value: RAW. +* `only_export_root_disk` - (Optional, Bool, ForceNew) Whether to export only the system disk. +* `role_name` - (Optional, String, ForceNew) Role name (Default: CVM_QcsRole). Before exporting the images, make sure the role exists, and it has write permission to COS. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cvm_hpc_cluster.html.markdown b/config/docs/r/cvm_hpc_cluster.html.markdown new file mode 100644 index 0000000..79ebe87 --- /dev/null +++ b/config/docs/r/cvm_hpc_cluster.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_hpc_cluster" +sidebar_current: "docs-tencentcloud-resource-cvm_hpc_cluster" +description: |- + Provides a resource to create a cvm hpc_cluster +--- + +# tencentcloud_cvm_hpc_cluster + +Provides a resource to create a cvm hpc_cluster + +## Example Usage + +```hcl +resource "tencentcloud_cvm_hpc_cluster" "hpc_cluster" { + zone = "ap-beijing-6" + name = "terraform-test" + remark = "create for test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of Hpc Cluster. +* `zone` - (Required, String) Available zone. +* `remark` - (Optional, String) Remark of Hpc Cluster. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cvm hpc_cluster can be imported using the id, e.g. + +``` +terraform import tencentcloud_cvm_hpc_cluster.hpc_cluster hpc_cluster_id +``` + diff --git a/config/docs/r/cvm_image_share_permission.html.markdown b/config/docs/r/cvm_image_share_permission.html.markdown new file mode 100644 index 0000000..390b058 --- /dev/null +++ b/config/docs/r/cvm_image_share_permission.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_image_share_permission" +sidebar_current: "docs-tencentcloud-resource-cvm_image_share_permission" +description: |- + Provides a resource to create a cvm image_share_permission +--- + +# tencentcloud_cvm_image_share_permission + +Provides a resource to create a cvm image_share_permission + +## Example Usage + +```hcl +resource "tencentcloud_cvm_image_share_permission" "image_share_permission" { + image_id = "img-xxxxxx" + account_ids = ["xxxxxx"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account_ids` - (Required, Set: [`String`]) List of account IDs with which an image is shared. +* `image_id` - (Required, String, ForceNew) Image ID such as `img-gvbnzy6f`. You can only specify an image in the NORMAL state. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cvm image_share_permission can be imported using the id, e.g. + +``` +terraform import tencentcloud_cvm_image_share_permission.image_share_permission image_share_permission_id +``` + diff --git a/config/docs/r/cvm_launch_template.html.markdown b/config/docs/r/cvm_launch_template.html.markdown new file mode 100644 index 0000000..28bed20 --- /dev/null +++ b/config/docs/r/cvm_launch_template.html.markdown @@ -0,0 +1,180 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_launch_template" +sidebar_current: "docs-tencentcloud-resource-cvm_launch_template" +description: |- + Provides a resource to create a cvm launch template +--- + +# tencentcloud_cvm_launch_template + +Provides a resource to create a cvm launch template + +## Example Usage + +```hcl +data "tencentcloud_images" "my_favorite_image" { + image_type = ["PUBLIC_IMAGE"] + image_name_regex = "Final" +} + +resource "tencentcloud_cvm_launch_template" "demo" { + launch_template_name = "test" + placement { + zone = "ap-guangzhou-6" + project_id = 0 + } + image_id = data.tencentcloud_images.my_favorite_image.images.0.image_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `image_id` - (Required, String, ForceNew) Image ID. +* `launch_template_name` - (Required, String, ForceNew) The name of launch template. +* `placement` - (Required, List, ForceNew) The location of instance. +* `action_timer` - (Optional, List, ForceNew) Timed task. +* `cam_role_name` - (Optional, String, ForceNew) The role name of CAM. +* `client_token` - (Optional, String, ForceNew) A string to used guarantee request idempotency. +* `data_disks` - (Optional, List, ForceNew) Data disk configuration information of the instance. +* `disable_api_termination` - (Optional, Bool, ForceNew) Instance destruction protection flag. +* `disaster_recover_group_ids` - (Optional, Set: [`String`], ForceNew) The ID of disaster recover group. +* `dry_run` - (Optional, Bool, ForceNew) Whether to preflight only this request, true or false. +* `enhanced_service` - (Optional, List, ForceNew) Enhanced service. If this parameter is not specified, cloud monitoring and cloud security services will be enabled by default in public images. +* `host_name` - (Optional, String, ForceNew) The host name of CVM. +* `hpc_cluster_id` - (Optional, String, ForceNew) The ID of HPC cluster. +* `instance_charge_prepaid` - (Optional, List, ForceNew) The configuration of charge prepaid. +* `instance_charge_type` - (Optional, String, ForceNew) The charge type of instance. Default value: POSTPAID_BY_HOUR. +* `instance_count` - (Optional, Int, ForceNew) The number of instances purchased. +* `instance_market_options` - (Optional, List, ForceNew) The marketplace options of instance. +* `instance_name` - (Optional, String, ForceNew) The name of instance. If you do not specify an instance display name, 'Unnamed' is displayed by default. +* `instance_type` - (Optional, String, ForceNew) The type of the instance. If this parameter is not specified, the system will dynamically specify the default model according to the resource sales in the current region. +* `internet_accessible` - (Optional, List, ForceNew) The information settings of public network bandwidth. If you do not specify this parameter, the default Internet bandwidth is 0 Mbps. +* `launch_template_version_description` - (Optional, String, ForceNew) Instance launch template version description. +* `login_settings` - (Optional, List, ForceNew) The login settings of instance. By default, passwords are randomly generated and notified to users via internal messages. +* `security_group_ids` - (Optional, Set: [`String`], ForceNew) The security group ID of instance. If this parameter is not specified, the default security group is bound. +* `system_disk` - (Optional, List, ForceNew) System disk configuration information of the instance. If this parameter is not specified, it is assigned according to the system default. +* `tag_specification` - (Optional, List, ForceNew) Tag description list. +* `tags` - (Optional, Map, ForceNew) Tag description list. +* `user_data` - (Optional, String, ForceNew) The data of users. +* `virtual_private_cloud` - (Optional, List, ForceNew) The configuration information of VPC. If this parameter is not specified, the basic network is used by default. + +The `action_timer` object supports the following: + +* `action_time` - (Optional, String) Execution time. +* `externals` - (Optional, List) Extended data. +* `timer_action` - (Optional, String) Timer name. + +The `automation_service` object supports the following: + +* `enabled` - (Optional, Bool) Whether to enable TencentCloud Automation Tools(TAT), TRUE or FALSE. + +The `data_disks` object supports the following: + +* `disk_size` - (Required, Int) The size of the data disk. +* `cdc_id` - (Optional, String) Cloud Dedicated Cluster(CDC) ID. +* `delete_with_instance` - (Optional, Bool) Whether the data disk is destroyed along with the instance, true or false. +* `disk_id` - (Optional, String) Data disk ID. +* `disk_type` - (Optional, String) The type of data disk. +* `encrypt` - (Optional, Bool) Whether the data disk is encrypted, TRUE or FALSE. +* `kms_key_id` - (Optional, String) The id of custom CMK. +* `snapshot_id` - (Optional, String) Data disk snapshot ID. +* `throughput_performance` - (Optional, Int) Cloud disk performance, MB/s. + +The `enhanced_service` object supports the following: + +* `automation_service` - (Optional, List) Enable TencentCloud Automation Tools(TAT). +* `monitor_service` - (Optional, List) Enable cloud monitor service. +* `security_service` - (Optional, List) Enable cloud security service. + +The `externals` object supports the following: + +* `release_address` - (Optional, Bool) Release address. +* `storage_block_attr` - (Optional, List) HDD local storage attributes. +* `unsupport_networks` - (Optional, Set) Unsupported network type. + +The `instance_charge_prepaid` object supports the following: + +* `period` - (Required, Int) The period of purchasing instances. +* `renew_flag` - (Optional, String) Automatic renew flag. + +The `instance_market_options` object supports the following: + +* `spot_options` - (Required, List) Bidding related options. +* `market_type` - (Optional, String) Market option type, currently only supports value: spot. + +The `internet_accessible` object supports the following: + +* `bandwidth_package_id` - (Optional, String) The ID of bandwidth package. +* `internet_charge_type` - (Optional, String) The type of internet charge. +* `internet_max_bandwidth_out` - (Optional, Int) Internet outbound bandwidth upper limit, Mbps. +* `public_ip_assigned` - (Optional, Bool) Whether to allocate public network IP, TRUE or FALSE. + +The `login_settings` object supports the following: + +* `keep_image_login` - (Optional, String) Keep the original settings of the mirror. +* `key_ids` - (Optional, Set) List of key ID. +* `password` - (Optional, String) The login password of instance. + +The `monitor_service` object supports the following: + +* `enabled` - (Optional, Bool) Whether to enable cloud monitor service, TRUE or FALSE. + +The `placement` object supports the following: + +* `zone` - (Required, String) The available zone ID of the instance. +* `host_ids` - (Optional, Set) The CDH ID list of the instance(input). +* `host_ips` - (Optional, Set) Specify the host machine ip. +* `project_id` - (Optional, Int) The project ID of the instance. + +The `security_service` object supports the following: + +* `enabled` - (Optional, Bool) Whether to enable cloud security service, TRUE or FALSE. + +The `spot_options` object supports the following: + +* `max_price` - (Required, String) Bidding. +* `spot_instance_type` - (Optional, String) Bidding request type, currently only supported type: one-time. + +The `storage_block_attr` object supports the following: + +* `max_size` - (Required, Int) The maximum capacity of HDD local storage. +* `min_size` - (Required, Int) The minimum capacity of HDD local storage. +* `type` - (Required, String) The type of HDD local storage. + +The `system_disk` object supports the following: + +* `cdc_id` - (Optional, String) Cloud Dedicated Cluster(CDC) ID. +* `disk_id` - (Optional, String) System disk ID. +* `disk_size` - (Optional, Int) The size of system disk. +* `disk_type` - (Optional, String) The type of system disk. + +The `tag_specification` object supports the following: + +* `resource_type` - (Required, String) The type of resource. +* `tags` - (Required, List) Tag list. + +The `tags` object supports the following: + +* `key` - (Required, String) The key of tag. +* `value` - (Required, String) The value of tag. + +The `virtual_private_cloud` object supports the following: + +* `subnet_id` - (Required, String) The id of subnet. +* `vpc_id` - (Required, String) The id of VPC. +* `as_vpc_gateway` - (Optional, Bool) Is it used as a Public network gateway, TRUE or FALSE. +* `ipv6_address_count` - (Optional, Int) The number of ipv6 addresses for Elastic Network Interface. +* `private_ip_addresses` - (Optional, Set) The address of private ip. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cvm_launch_template_default_version.html.markdown b/config/docs/r/cvm_launch_template_default_version.html.markdown new file mode 100644 index 0000000..42d2543 --- /dev/null +++ b/config/docs/r/cvm_launch_template_default_version.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_launch_template_default_version" +sidebar_current: "docs-tencentcloud-resource-cvm_launch_template_default_version" +description: |- + Provides a resource to create a cvm launch_template_default_version +--- + +# tencentcloud_cvm_launch_template_default_version + +Provides a resource to create a cvm launch_template_default_version + +## Example Usage + +```hcl +resource "tencentcloud_cvm_launch_template_default_version" "launch_template_default_version" { + launch_template_id = "lt-34vaef8fe" + default_version = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `default_version` - (Required, Int) The number of the version that you want to set as the default version. +* `launch_template_id` - (Required, String, ForceNew) Instance launch template ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cvm launch_template_default_version can be imported using the id, e.g. + +``` +terraform import tencentcloud_cvm_launch_template_default_version.launch_template_default_version launch_template_id +``` + diff --git a/config/docs/r/cvm_launch_template_version.html.markdown b/config/docs/r/cvm_launch_template_version.html.markdown new file mode 100644 index 0000000..2de0c34 --- /dev/null +++ b/config/docs/r/cvm_launch_template_version.html.markdown @@ -0,0 +1,187 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_launch_template_version" +sidebar_current: "docs-tencentcloud-resource-cvm_launch_template_version" +description: |- + Provides a resource to create a cvm launch_template_version +--- + +# tencentcloud_cvm_launch_template_version + +Provides a resource to create a cvm launch_template_version + +## Example Usage + +```hcl +resource "tencentcloud_cvm_launch_template_version" "foo" { + placement { + zone = "ap-guangzhou-6" + project_id = 0 + + } + launch_template_id = "lt-r9ajalbi" + launch_template_version_description = "version description" + disable_api_termination = false + instance_type = "S5.MEDIUM4" + image_id = "img-9qrfy1xt" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `launch_template_id` - (Required, String, ForceNew) Instance launch template ID. This parameter is used as a basis for creating new template versions. +* `placement` - (Required, List, ForceNew) Location of the instance. You can use this parameter to specify the attributes of the instance, such as its availability zone, project, and CDH (for dedicated CVMs). +* `action_timer` - (Optional, List, ForceNew) Scheduled tasks. +* `cam_role_name` - (Optional, String, ForceNew) The role name of CAM. +* `client_token` - (Optional, String, ForceNew) A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idem-potency of the request cannot be guaranteed. +* `data_disks` - (Optional, List, ForceNew) The configuration information of instance data disks. If this parameter is not specified, no data disk will be purchased by default. +* `disable_api_termination` - (Optional, Bool, ForceNew) Whether the termination protection is enabled. `TRUE`: Enable instance protection, which means that this instance can not be deleted by an API action.`FALSE`: Do not enable the instance protection. Default value: `FALSE`. +* `disaster_recover_group_ids` - (Optional, Set: [`String`], ForceNew) Placement group ID. You can only specify one. +* `dry_run` - (Optional, Bool, ForceNew) Whether the request is a dry run only. +* `enhanced_service` - (Optional, List, ForceNew) Enhanced service. You can use this parameter to specify whether to enable services such as Anti-DDoS and Cloud Monitor. If this parameter is not specified, Cloud Monitor and Anti-DDoS are enabled for public images by default. +* `host_name` - (Optional, String, ForceNew) Hostname of a CVM. +* `hpc_cluster_id` - (Optional, String, ForceNew) HPC cluster ID. The HPC cluster must and can only be specified for a high-performance computing instance. +* `image_id` - (Optional, String, ForceNew) Image ID. +* `instance_charge_prepaid` - (Optional, List, ForceNew) Describes the billing method of an instance. +* `instance_charge_type` - (Optional, String, ForceNew) The charge type of instance. +* `instance_count` - (Optional, Int, ForceNew) The number of instances to be purchased. +* `instance_market_options` - (Optional, List, ForceNew) Options related to bidding requests. +* `instance_name` - (Optional, String, ForceNew) Instance name to be displayed. +* `instance_type` - (Optional, String, ForceNew) The type of the instance. If this parameter is not specified, the system will dynamically specify the default model according to the resource sales in the current region. +* `internet_accessible` - (Optional, List, ForceNew) Describes the accessibility of an instance in the public network, including its network billing method, maximum bandwidth, etc. +* `launch_template_version_description` - (Optional, String, ForceNew) Description of instance launch template versions. This parameter can contain 2-256 characters. +* `launch_template_version` - (Optional, Int, ForceNew) This parameter, when specified, is used to create instance launch templates. If this parameter is not specified, the default version will be used. +* `login_settings` - (Optional, List, ForceNew) Describes login settings of an instance. +* `security_group_ids` - (Optional, Set: [`String`], ForceNew) Security groups to which the instance belongs. If this parameter is not specified, the instance will be associated with default security groups. +* `system_disk` - (Optional, List, ForceNew) System disk configuration information of the instance. If this parameter is not specified, it is assigned according to the system default. +* `tag_specification` - (Optional, List, ForceNew) Description of tags associated with resource instances during instance creation. +* `user_data` - (Optional, String, ForceNew) User data provided to the instance. This parameter needs to be encoded in base64 format with the maximum size of 16 KB. +* `virtual_private_cloud` - (Optional, List, ForceNew) Describes information on VPC, including subnets, IP addresses, etc. + +The `action_timer` object supports the following: + +* `action_time` - (Optional, String, ForceNew) Execution time, displayed according to ISO8601 standard, and UTC time is used. The format is YYYY-MM-DDThh:mm:ssZ. For example, 2018-05-29T11:26:40Z, the execution must be at least 5 minutes later than the current time. +* `externals` - (Optional, List, ForceNew) Additional data. +* `timer_action` - (Optional, String, ForceNew) Timer name. Currently TerminateInstances is the only supported value. + +The `automation_service` object supports the following: + +* `enabled` - (Optional, Bool, ForceNew) Whether to enable the TAT service. + +The `data_disks` object supports the following: + +* `disk_size` - (Required, Int, ForceNew) Data disk size (in GB). The minimum adjustment increment is 10 GB. The value range varies by data disk type. +* `cdc_id` - (Optional, String, ForceNew) ID of the dedicated cluster to which the instance belongs. +* `delete_with_instance` - (Optional, Bool, ForceNew) Whether to terminate the data disk when its CVM is terminated. Default value: `true`. +* `disk_id` - (Optional, String, ForceNew) System disk ID. System disks whose type is LOCAL_BASIC or LOCAL_SSD do not have an ID and do not support this parameter. It is only used as a response parameter for APIs such as DescribeInstances, and cannot be used as a request parameter for APIs such as RunInstances. +* `disk_type` - (Optional, String, ForceNew) The type of data disk. +* `encrypt` - (Optional, Bool, ForceNew) Specifies whether the data disk is encrypted. +* `kms_key_id` - (Optional, String, ForceNew) ID of the custom CMK in the format of UUID or `kms-abcd1234`. +* `snapshot_id` - (Optional, String, ForceNew) Data disk snapshot ID. The size of the selected data disk snapshot must be smaller than that of the data disk. Note: This field may return null, indicating that no valid value is found. +* `throughput_performance` - (Optional, Int, ForceNew) Cloud disk performance in MB/s. + +The `enhanced_service` object supports the following: + +* `automation_service` - (Optional, List, ForceNew) Whether to enable the TAT service. If this parameter is not specified, the TAT service is enabled for public images and disabled for other images by default. +* `monitor_service` - (Optional, List, ForceNew) Enables cloud monitor service. If this parameter is not specified, the cloud monitor service will be enabled by default. +* `security_service` - (Optional, List, ForceNew) Enables cloud security service. If this parameter is not specified, the cloud security service will be enabled by default. + +The `externals` object supports the following: + +* `release_address` - (Optional, Bool, ForceNew) Release address. +* `storage_block_attr` - (Optional, List, ForceNew) Information on local HDD storage. +* `unsupport_networks` - (Optional, Set, ForceNew) Not supported network. + +The `instance_charge_prepaid` object supports the following: + +* `period` - (Required, Int, ForceNew) Subscription period; unit: month; valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60. +* `renew_flag` - (Optional, String, ForceNew) 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 <br><br>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. + +The `instance_market_options` object supports the following: + +* `spot_options` - (Required, List, ForceNew) Options related to bidding. +* `market_type` - (Optional, String, ForceNew) Market option type. Currently spot is the only supported value. + +The `internet_accessible` object supports the following: + +* `bandwidth_package_id` - (Optional, String, ForceNew) Bandwidth package ID. +* `internet_charge_type` - (Optional, String, ForceNew) Network connection billing plan. +* `internet_max_bandwidth_out` - (Optional, Int, ForceNew) The maximum outbound bandwidth of the public network, in Mbps. The default value is 0 Mbps. +* `public_ip_assigned` - (Optional, Bool, ForceNew) Whether to assign a public IP. + +The `login_settings` object supports the following: + +* `keep_image_login` - (Optional, String, ForceNew) Whether to keep the original settings of an image. +* `key_ids` - (Optional, Set, ForceNew) List of key IDs. After an instance is associated with a key, you can access the instance with the private key in the key pair. +* `password` - (Optional, String, ForceNew) Login password of the instance. + +The `monitor_service` object supports the following: + +* `enabled` - (Optional, Bool, ForceNew) Whether to enable Cloud Monitor. + +The `placement` object supports the following: + +* `zone` - (Required, String, ForceNew) ID of the availability zone where the instance resides. You can call the DescribeZones API and obtain the ID in the returned Zone field. +* `host_ids` - (Optional, Set, ForceNew) ID list of CDHs from which the instance can be created. If you have purchased CDHs and specify this parameter, the instances you purchase will be randomly deployed on the CDHs. +* `host_ips` - (Optional, Set, ForceNew) IPs of the hosts to create CVMs. +* `project_id` - (Optional, Int, ForceNew) ID of the project to which the instance belongs. This parameter can be obtained from the projectId returned by DescribeProject. If this is left empty, the default project is used. + +The `security_service` object supports the following: + +* `enabled` - (Optional, Bool) Whether to enable Cloud Security. + +The `spot_options` object supports the following: + +* `max_price` - (Required, String, ForceNew) Bidding price. +* `spot_instance_type` - (Optional, String, ForceNew) Bidding request type. Currently only one-time is supported. + +The `storage_block_attr` object supports the following: + +* `max_size` - (Required, Int, ForceNew) Maximum capacity of local HDD storage. +* `min_size` - (Required, Int, ForceNew) Minimum capacity of local HDD storage. +* `type` - (Required, String, ForceNew) Local HDD storage type. Value: LOCAL_PRO. + +The `system_disk` object supports the following: + +* `cdc_id` - (Optional, String, ForceNew) ID of the dedicated cluster to which the instance belongs. +* `disk_id` - (Optional, String, ForceNew) System disk ID. System disks whose type is LOCAL_BASIC or LOCAL_SSD do not have an ID and do not support this parameter. It is only used as a response parameter for APIs such as DescribeInstances, and cannot be used as a request parameter for APIs such as RunInstances. +* `disk_size` - (Optional, Int, ForceNew) System disk size; unit: GB; default value: 50 GB. +* `disk_type` - (Optional, String, ForceNew) The type of system disk. Default value: the type of hard disk currently in stock. + +The `tag_specification` object supports the following: + +* `resource_type` - (Required, String, ForceNew) The type of resource that the tag is bound to. +* `tags` - (Required, List) List of tags. + +The `tags` object supports the following: + +* `key` - (Required, String, ForceNew) Tag key. +* `value` - (Required, String, ForceNew) Tag value. + +The `virtual_private_cloud` object supports the following: + +* `subnet_id` - (Required, String, ForceNew) VPC subnet ID in the format subnet-xxx, if you specify DEFAULT for both VpcId and SubnetId when creating an instance, the default VPC will be used. +* `vpc_id` - (Required, String, ForceNew) VPC ID in the format of vpc-xxx, if you specify DEFAULT for both VpcId and SubnetId when creating an instance, the default VPC will be used. +* `as_vpc_gateway` - (Optional, Bool, ForceNew) Whether to use a CVM instance as a public gateway. The public gateway is only available when the instance has a public IP and resides in a VPC. +* `ipv6_address_count` - (Optional, Int, ForceNew) Number of IPv6 addresses randomly generated for the ENI. +* `private_ip_addresses` - (Optional, Set, ForceNew) Array of VPC subnet IPs. You can use this parameter when creating instances or modifying VPC attributes of instances. Currently you can specify multiple IPs in one subnet only when creating multiple instances at the same time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cvm launch_template_version can be imported using the id, e.g. + +``` +terraform import tencentcloud_cvm_launch_template_version.launch_template_version ${launch_template_id}#${launch_template_version} +``` + diff --git a/config/docs/r/cvm_reboot_instance.html.markdown b/config/docs/r/cvm_reboot_instance.html.markdown new file mode 100644 index 0000000..7284a23 --- /dev/null +++ b/config/docs/r/cvm_reboot_instance.html.markdown @@ -0,0 +1,38 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_reboot_instance" +sidebar_current: "docs-tencentcloud-resource-cvm_reboot_instance" +description: |- + Provides a resource to create a cvm reboot_instance +--- + +# tencentcloud_cvm_reboot_instance + +Provides a resource to create a cvm reboot_instance + +## Example Usage + +```hcl +resource "tencentcloud_cvm_reboot_instance" "reboot_instance" { + instance_id = "ins-f9jr4bd2" + stop_type = "SOFT_FIRST" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `force_reboot` - (Optional, Bool, ForceNew, **Deprecated**) It has been deprecated from version 1.81.21. Please use `stop_type` instead. This parameter has been disused. We recommend using StopType instead. Note that ForceReboot and StopType parameters cannot be specified at the same time. Whether to forcibly restart an instance after a normal restart fails. Valid values are `TRUE` and `FALSE`. Default value: FALSE. +* `stop_type` - (Optional, String, ForceNew) Shutdown type. Valid values: `SOFT`: soft shutdown; `HARD`: hard shutdown; `SOFT_FIRST`: perform a soft shutdown first, and perform a hard shutdown if the soft shutdown fails. Default value: SOFT. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cvm_renew_instance.html.markdown b/config/docs/r/cvm_renew_instance.html.markdown new file mode 100644 index 0000000..8cf621e --- /dev/null +++ b/config/docs/r/cvm_renew_instance.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_renew_instance" +sidebar_current: "docs-tencentcloud-resource-cvm_renew_instance" +description: |- + Provides a resource to create a cvm renew_instance +--- + +# tencentcloud_cvm_renew_instance + +Provides a resource to create a cvm renew_instance + +## Example Usage + +```hcl +resource "tencentcloud_cvm_renew_instance" "renew_instance" { + instance_ids = + instance_charge_prepaid { + period = 1 + renew_flag = "NOTIFY_AND_AUTO_RENEW" + } + renew_portable_data_disk = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `instance_charge_prepaid` - (Optional, List, ForceNew) Prepaid mode, that is, yearly and monthly subscription related parameter settings. Through this parameter, you can specify the renewal duration of the Subscription instance, whether to set automatic renewal, and other attributes. For yearly and monthly subscription instances, this parameter is required. +* `renew_portable_data_disk` - (Optional, Bool, ForceNew) Whether to renew the elastic data disk. Valid values: +- `TRUE`: Indicates to renew the subscription instance and renew the attached elastic data disk at the same time +- `FALSE`: Indicates that the subscription instance will be renewed and the elastic data disk attached to it will not be renewed +Default value: TRUE. + +The `instance_charge_prepaid` object supports the following: + +* `period` - (Required, Int) Subscription period; unit: month; valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60. Note: This field may return null, indicating that no valid value is found. +* `renew_flag` - (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: This field may return null, indicating that no valid value is found. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cvm_security_group_attachment.html.markdown b/config/docs/r/cvm_security_group_attachment.html.markdown new file mode 100644 index 0000000..ad0325c --- /dev/null +++ b/config/docs/r/cvm_security_group_attachment.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_security_group_attachment" +sidebar_current: "docs-tencentcloud-resource-cvm_security_group_attachment" +description: |- + Provides a resource to create a cvm security_group_attachment +--- + +# tencentcloud_cvm_security_group_attachment + +Provides a resource to create a cvm security_group_attachment + +## Example Usage + +```hcl +resource "tencentcloud_cvm_security_group_attachment" "security_group_attachment" { + security_group_id = "sg-xxxxxxx" + instance_id = "ins-xxxxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance id. +* `security_group_id` - (Required, String, ForceNew) Security group id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cvm security_group_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_cvm_security_group_attachment.security_group_attachment ${instance_id}#${security_group_id} +``` + diff --git a/config/docs/r/cvm_sync_image.html.markdown b/config/docs/r/cvm_sync_image.html.markdown new file mode 100644 index 0000000..b8faedf --- /dev/null +++ b/config/docs/r/cvm_sync_image.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cvm_sync_image" +sidebar_current: "docs-tencentcloud-resource-cvm_sync_image" +description: |- + Provides a resource to create a cvm sync_image +--- + +# tencentcloud_cvm_sync_image + +Provides a resource to create a cvm sync_image + +## Example Usage + +```hcl +resource "tencentcloud_cvm_sync_image" "sync_image" { + image_id = "img-xxxxxx" + destination_regions = ["ap-guangzhou", "ap-shanghai"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `destination_regions` - (Required, Set: [`String`], ForceNew) List of destination regions for synchronization. Limits: It must be a valid region. For a custom image, the destination region cannot be the source region. For a shared image, the destination region must be the source region, which indicates to create a copy of the image as a custom image in the same region. +* `image_id` - (Required, String, ForceNew) Image ID. The specified image must meet the following requirement: the images must be in the `NORMAL` state. +* `dry_run` - (Optional, Bool, ForceNew) Checks whether image synchronization can be initiated. +* `image_name` - (Optional, String, ForceNew) Destination image name. +* `image_set_required` - (Optional, Bool, ForceNew) Whether to return the ID of image created in the destination region. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cwp_license_bind_attachment.html.markdown b/config/docs/r/cwp_license_bind_attachment.html.markdown new file mode 100644 index 0000000..84e00a3 --- /dev/null +++ b/config/docs/r/cwp_license_bind_attachment.html.markdown @@ -0,0 +1,78 @@ +--- +subcategory: "Cwp" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cwp_license_bind_attachment" +sidebar_current: "docs-tencentcloud-resource-cwp_license_bind_attachment" +description: |- + Provides a resource to create a cwp license_bind_attachment +--- + +# tencentcloud_cwp_license_bind_attachment + +Provides a resource to create a cwp license_bind_attachment + +## Example Usage + +```hcl +data "tencentcloud_cwp_machines_simple" "example" { + machine_type = "CVM" + machine_region = "ap-guangzhou" + project_ids = [1210293] + + filters { + name = "Version" + values = ["BASIC_VERSION"] + exact_match = true + } +} + +resource "tencentcloud_cwp_license_order" "example" { + alias = "tf_example" + license_type = 0 + license_num = 1 + region_id = 1 + project_id = 0 + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_cwp_license_bind_attachment" "example" { + resource_id = tencentcloud_cwp_license_order.example.resource_id + license_id = tencentcloud_cwp_license_order.example.license_id + license_type = 0 + quuid = data.tencentcloud_cwp_machines_simple.example.machines[0].quuid +} +``` + +## Argument Reference + +The following arguments are supported: + +* `license_id` - (Required, Int, ForceNew) License ID. +* `license_type` - (Required, Int, ForceNew) LicenseType, 0 CWP Pro - Pay as you go, 1 CWP Pro - Monthly subscription, 2 CWP Ultimate - Monthly subscription. Default is 0. +* `quuid` - (Required, String, ForceNew) Machine quota that needs to be bound. +* `resource_id` - (Required, String, ForceNew) Resource ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `agent_status` - agent status. +* `is_switch_bind` - Is it allowed to change the binding, false is not allowed to change the binding. +* `is_unbind` - Allow unbinding, false does not allow unbinding. +* `machine_ip` - machine ip. +* `machine_name` - machine name. +* `machine_wan_ip` - machine wan ip. +* `uuid` - uuid. + + +## Import + +cwp license_bind_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_cwp_license_bind_attachment.example cwplic-ab3edffa#44#2c7e5cce-1cec-4456-8d18-018f160dd987#0 +``` + diff --git a/config/docs/r/cwp_license_order.html.markdown b/config/docs/r/cwp_license_order.html.markdown new file mode 100644 index 0000000..1153391 --- /dev/null +++ b/config/docs/r/cwp_license_order.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "Cwp" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cwp_license_order" +sidebar_current: "docs-tencentcloud-resource-cwp_license_order" +description: |- + Provides a resource to create a cwp license_order +--- + +# tencentcloud_cwp_license_order + +Provides a resource to create a cwp license_order + +## Example Usage + +```hcl +resource "tencentcloud_cwp_license_order" "example" { + alias = "tf_example" + license_type = 0 + license_num = 1 + region_id = 1 + project_id = 0 + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `alias` - (Optional, String) Resource alias. +* `license_num` - (Optional, Int) License quantity, Quantity to be purchased.Default is 1. +* `license_type` - (Optional, Int) LicenseType, 0 CWP Pro - Pay as you go, 1 CWP Pro - Monthly subscription, 2 CWP Ultimate - Monthly subscription. Default is 0. +* `project_id` - (Optional, Int) Project ID. Default is 0. +* `region_id` - (Optional, Int) Purchase order region, only 1 Guangzhou, 9 Singapore is supported here. Guangzhou is recommended. Singapore is whitelisted. Default is 1. +* `tags` - (Optional, Map) Tags of the license order. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `license_id` - license id. +* `resource_id` - resource id. + + +## Import + +cwp license_order can be imported using the id, e.g. + +``` +terraform import tencentcloud_cwp_license_order.example cwplic-130715d2#1 +``` + diff --git a/config/docs/r/cynosdb_account.html.markdown b/config/docs/r/cynosdb_account.html.markdown new file mode 100644 index 0000000..df9b6e8 --- /dev/null +++ b/config/docs/r/cynosdb_account.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_account" +sidebar_current: "docs-tencentcloud-resource-cynosdb_account" +description: |- + Provides a resource to create a cynosdb account +--- + +# tencentcloud_cynosdb_account + +Provides a resource to create a cynosdb account + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_account" "account" { + cluster_id = "cynosdbmysql-bws8h88b" + account_name = "terraform_test" + account_password = "Password@1234" + host = "%" + description = "terraform test" + max_user_connections = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account_name` - (Required, String) Account name, including alphanumeric _, Start with a letter, end with a letter or number, length 1-16. +* `account_password` - (Required, String) Password, with a length range of 8 to 64 characters. +* `cluster_id` - (Required, String) Cluster ID. +* `host` - (Required, String) main engine. +* `description` - (Optional, String) describe. +* `max_user_connections` - (Optional, Int) The maximum number of user connections cannot be greater than 10240. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cynosdb account can be imported using the id, e.g. + +``` +terraform import tencentcloud_cynosdb_account.account account_id +``` + diff --git a/config/docs/r/cynosdb_account_privileges.html.markdown b/config/docs/r/cynosdb_account_privileges.html.markdown new file mode 100644 index 0000000..dd0c5b1 --- /dev/null +++ b/config/docs/r/cynosdb_account_privileges.html.markdown @@ -0,0 +1,88 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_account_privileges" +sidebar_current: "docs-tencentcloud-resource-cynosdb_account_privileges" +description: |- + Provides a resource to create a cynosdb account_privileges +--- + +# tencentcloud_cynosdb_account_privileges + +Provides a resource to create a cynosdb account_privileges + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_account_privileges" "account_privileges" { + cluster_id = "cynosdbmysql-bws8h88b" + account_name = "test" + host = "%" + global_privileges = [ + "CREATE", + "DROP", + "ALTER", + "CREATE TEMPORARY TABLES", + "CREATE VIEW" + ] + database_privileges { + db = "users" + privileges = [ + "DROP", + "REFERENCES", + "INDEX", + "CREATE VIEW", + "INSERT", + "EVENT" + ] + } + table_privileges { + db = "users" + table_name = "tb_user_name" + privileges = [ + "ALTER", + "REFERENCES", + "SHOW VIEW" + ] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account_name` - (Required, String, ForceNew) Account. +* `cluster_id` - (Required, String, ForceNew) Cluster ID. +* `global_privileges` - (Required, Set: [`String`]) Array of global permissions. +* `database_privileges` - (Optional, List) Array of database permissions. +* `host` - (Optional, String, ForceNew) Host, default `%`. +* `table_privileges` - (Optional, List) array of table permissions. + +The `database_privileges` object supports the following: + +* `db` - (Required, String) Database. +* `privileges` - (Required, Set) Database privileges. + +The `table_privileges` object supports the following: + +* `db` - (Required, String) Database name. +* `privileges` - (Required, Set) Table privileges. +* `table_name` - (Required, String) Table name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cynosdb account_privileges can be imported using the id, e.g. + +``` +terraform import tencentcloud_cynosdb_account_privileges.account_privileges account_privileges_id +``` + diff --git a/config/docs/r/cynosdb_audit_log_file.html.markdown b/config/docs/r/cynosdb_audit_log_file.html.markdown new file mode 100644 index 0000000..cffeb14 --- /dev/null +++ b/config/docs/r/cynosdb_audit_log_file.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_audit_log_file" +sidebar_current: "docs-tencentcloud-resource-cynosdb_audit_log_file" +description: |- + Provides a resource to create a cynosdb audit_log_file +--- + +# tencentcloud_cynosdb_audit_log_file + +Provides a resource to create a cynosdb audit_log_file + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_audit_log_file" "audit_log_file" { + instance_id = "cynosdbmysql-ins-afqx1hy0" + start_time = "2022-07-12 10:29:20" + end_time = "2022-08-12 10:29:20" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String, ForceNew) End time. +* `instance_id` - (Required, String, ForceNew) The ID of instance. +* `start_time` - (Required, String, ForceNew) Start time. +* `filter` - (Optional, List, ForceNew) Filter condition. Logs can be filtered according to the filter conditions set. +* `order_by` - (Optional, String, ForceNew) Sort field. supported values are: +`timestamp` - timestamp +`affectRows` - affected rows +`execTime` - execution time. +* `order` - (Optional, String, ForceNew) Sort by. Supported values are: `ASC` - ascending, `DESC` - descending. + +The `filter` object supports the following: + +* `affect_rows` - (Optional, Int) Affects the number of rows. Indicates that the audit log whose number of affected rows is greater than this value is filtered. +* `db_name` - (Optional, Set) The name of database. +* `exec_time` - (Optional, Int) Execution time. The unit is: ms. Indicates to filter audit logs whose execution time is greater than this value. +* `host` - (Optional, Set) Client host. +* `policy_name` - (Optional, Set) The name of audit policy. +* `sent_rows` - (Optional, Int) Return the number of rows. +* `sql_type` - (Optional, String) SQL type. currently supported: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, SET, REPLACE, EXECUTE. +* `sql_types` - (Optional, Set) SQL type. Supports simultaneous query of multiple types. currently supported: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, SET, REPLACE, EXECUTE. +* `sql` - (Optional, String) SQL statement. Support fuzzy matching. +* `sqls` - (Optional, Set) SQL statement. Support passing multiple sql statements. +* `table_name` - (Optional, Set) The name of table. +* `thread_id` - (Optional, Set) The ID of thread. +* `user` - (Optional, Set) User name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Audit log file creation time. The format is 2019-03-20 17:09:13. +* `download_url` - The download address of the audit logs. +* `err_msg` - Error message. +* `file_name` - Audit log file name. +* `file_size` - File size, The unit is KB. + + diff --git a/config/docs/r/cynosdb_binlog_save_days.html.markdown b/config/docs/r/cynosdb_binlog_save_days.html.markdown new file mode 100644 index 0000000..073a4b1 --- /dev/null +++ b/config/docs/r/cynosdb_binlog_save_days.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_binlog_save_days" +sidebar_current: "docs-tencentcloud-resource-cynosdb_binlog_save_days" +description: |- + Provides a resource to create a cynosdb binlog_save_days +--- + +# tencentcloud_cynosdb_binlog_save_days + +Provides a resource to create a cynosdb binlog_save_days + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_binlog_save_days" "binlog_save_days" { + cluster_id = "cynosdbmysql-123" + binlog_save_days = 7 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `binlog_save_days` - (Required, Int) Binlog retention days. +* `cluster_id` - (Required, String, ForceNew) Cluster ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cynosdb binlog_save_days can be imported using the id, e.g. + +``` +terraform import tencentcloud_cynosdb_binlog_save_days.binlog_save_days binlog_save_days_id +``` + diff --git a/config/docs/r/cynosdb_cluster.html.markdown b/config/docs/r/cynosdb_cluster.html.markdown new file mode 100644 index 0000000..f77ad57 --- /dev/null +++ b/config/docs/r/cynosdb_cluster.html.markdown @@ -0,0 +1,143 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_cluster" +sidebar_current: "docs-tencentcloud-resource-cynosdb_cluster" +description: |- + Provide a resource to create a CynosDB cluster. +--- + +# tencentcloud_cynosdb_cluster + +Provide a resource to create a CynosDB cluster. + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_cluster" "foo" { + available_zone = "ap-guangzhou-4" + vpc_id = "vpc-h70b6b49" + subnet_id = "subnet-q6fhy1mi" + db_type = "MYSQL" + db_version = "5.7" + storage_limit = 1000 + cluster_name = "tf-cynosdb" + password = "cynos@123" + instance_maintain_duration = 7200 + instance_maintain_start_time = 10800 + instance_maintain_weekdays = [ + "Fri", + "Mon", + "Sat", + "Sun", + "Thu", + "Wed", + "Tue", + ] + + instance_cpu_core = 1 + instance_memory_size = 2 + + param_item { + name = "character_set_server" + current_value = "utf8mb4" + } + + prarm_template_id = "12345" + + tags = { + test = "test" + } + + force_delete = false + + rw_group_sg = [ + "sg-ibyjkl6r", + ] + ro_group_sg = [ + "sg-ibyjkl6r", + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `available_zone` - (Required, String, ForceNew) The available zone of the CynosDB Cluster. +* `cluster_name` - (Required, String) Name of CynosDB cluster. +* `db_type` - (Required, String, ForceNew) Type of CynosDB, and available values include `MYSQL`. +* `db_version` - (Required, String, ForceNew) Version of CynosDB, which is related to `db_type`. For `MYSQL`, available value is `5.7`. +* `password` - (Required, String, ForceNew) Password of `root` account. +* `subnet_id` - (Required, String) ID of the subnet within this VPC. +* `vpc_id` - (Required, String) ID of the VPC. +* `auto_pause_delay` - (Optional, Int) Specify auto-pause delay in second while `db_mode` is `SERVERLESS`. Value range: `[600, 691200]`. Default: `600`. +* `auto_pause` - (Optional, String) Specify whether the cluster can auto-pause while `db_mode` is `SERVERLESS`. Values: `yes` (default), `no`. +* `auto_renew_flag` - (Optional, Int) Auto renew flag. Valid values are `0`(MANUAL_RENEW), `1`(AUTO_RENEW). Default value is `0`. Only works for PREPAID cluster. +* `charge_type` - (Optional, String, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. Default value is `POSTPAID_BY_HOUR`. +* `db_mode` - (Optional, String) Specify DB mode, only available when `db_type` is `MYSQL`. Values: `NORMAL` (Default), `SERVERLESS`. +* `force_delete` - (Optional, Bool) Indicate whether to delete cluster instance directly or not. Default is false. If set true, the cluster and its `All RELATED INSTANCES` will be deleted instead of staying recycle bin. Note: works for both `PREPAID` and `POSTPAID_BY_HOUR` cluster. +* `instance_cpu_core` - (Optional, Int) The number of CPU cores of read-write type instance in the CynosDB cluster. Required while creating normal cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console. +* `instance_maintain_duration` - (Optional, Int) Duration time for maintenance, unit in second. `3600` by default. +* `instance_maintain_start_time` - (Optional, Int) Offset time from 00:00, unit in second. For example, 03:00am should be `10800`. `10800` by default. +* `instance_maintain_weekdays` - (Optional, Set: [`String`]) Weekdays for maintenance. `["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"]` by default. +* `instance_memory_size` - (Optional, Int) Memory capacity of read-write type instance, unit in GB. Required while creating normal cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console. +* `max_cpu` - (Optional, Float64) Maximum CPU core count, required while `db_mode` is `SERVERLESS`, request DescribeServerlessInstanceSpecs for more reference. +* `min_cpu` - (Optional, Float64) Minimum CPU core count, required while `db_mode` is `SERVERLESS`, request DescribeServerlessInstanceSpecs for more reference. +* `old_ip_reserve_hours` - (Optional, Int) Recycling time of the old address, must be filled in when modifying the vpcRecycling time of the old address, must be filled in when modifying the vpc. +* `param_items` - (Optional, List) Specify parameter list of database. It is valid when prarm_template_id is set in create cluster. Use `data.tencentcloud_mysql_default_params` to query available parameter details. +* `port` - (Optional, Int, ForceNew) Port of CynosDB cluster. +* `prarm_template_id` - (Optional, Int) The ID of the parameter template. +* `prepaid_period` - (Optional, Int, ForceNew) The tenancy (time unit is month) of the prepaid instance. Valid values are `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `24`, `36`. NOTE: it only works when charge_type is set to `PREPAID`. +* `project_id` - (Optional, Int, ForceNew) ID of the project. `0` by default. +* `ro_group_sg` - (Optional, List: [`String`]) IDs of security group for `ro_group`. +* `rw_group_sg` - (Optional, List: [`String`]) IDs of security group for `rw_group`. +* `serverless_status_flag` - (Optional, String) Specify whether to pause or resume serverless cluster. values: `resume`, `pause`. +* `storage_limit` - (Optional, Int) Storage limit of CynosDB cluster instance, unit in GB. The maximum storage of a non-serverless instance in GB. NOTE: If db_type is `MYSQL` and charge_type is `PREPAID`, the value cannot exceed the maximum storage corresponding to the CPU and memory specifications, and the transaction mode is `order and pay`. when charge_type is `POSTPAID_BY_HOUR`, this argument is unnecessary. +* `storage_pay_mode` - (Optional, Int) Cluster storage billing mode, pay-as-you-go: `0`-yearly/monthly: `1`-The default is pay-as-you-go. When the DbType is MYSQL, when the cluster computing billing mode is post-paid (including DbMode is SERVERLESS), the storage billing mode can only be billing by volume; rollback and cloning do not support yearly subscriptions monthly storage. +* `tags` - (Optional, Map) The tags of the CynosDB cluster. + +The `param_items` object supports the following: + +* `current_value` - (Required, String) Param expected value to set. +* `name` - (Required, String) Name of param, e.g. `character_set_server`. +* `old_value` - (Optional, String) Param old value, indicates the value which already set, this value is required when modifying current_value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `charset` - Charset used by CynosDB cluster. +* `cluster_status` - Status of the Cynosdb cluster. +* `create_time` - Creation time of the CynosDB cluster. +* `instance_id` - ID of instance. +* `instance_name` - Name of instance. +* `instance_status` - Status of the instance. +* `instance_storage_size` - Storage size of the instance, unit in GB. +* `ro_group_addr` - Readonly addresses. Each element contains the following attributes: + * `ip` - IP address for readonly connection. + * `port` - Port number for readonly connection. +* `ro_group_id` - ID of read-only instance group. +* `ro_group_instances` - List of instances in the read-only instance group. + * `instance_id` - ID of instance. + * `instance_name` - Name of instance. +* `rw_group_addr` - Read-write addresses. Each element contains the following attributes: + * `ip` - IP address for read-write connection. + * `port` - Port number for read-write connection. +* `rw_group_id` - ID of read-write instance group. +* `rw_group_instances` - List of instances in the read-write instance group. + * `instance_id` - ID of instance. + * `instance_name` - Name of instance. +* `serverless_status` - Serverless cluster status. NOTE: This is a readonly attribute, to modify, please set `serverless_status_flag`. +* `storage_used` - Used storage of CynosDB cluster, unit in MB. + + +## Import + +CynosDB cluster can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cynosdb_cluster.foo cynosdbmysql-dzj5l8gz +``` + diff --git a/config/docs/r/cynosdb_cluster_databases.html.markdown b/config/docs/r/cynosdb_cluster_databases.html.markdown new file mode 100644 index 0000000..27b6f07 --- /dev/null +++ b/config/docs/r/cynosdb_cluster_databases.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_cluster_databases" +sidebar_current: "docs-tencentcloud-resource-cynosdb_cluster_databases" +description: |- + Provides a resource to create a cynosdb cluster_databases +--- + +# tencentcloud_cynosdb_cluster_databases + +Provides a resource to create a cynosdb cluster_databases + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_cluster_databases" "cluster_databases" { + cluster_id = "cynosdbmysql-bws8h88b" + db_name = "terraform-test" + character_set = "utf8" + collate_rule = "utf8_general_ci" + user_host_privileges { + db_user_name = "root" + db_host = "%" + db_privilege = "READ_ONLY" + } + description = "terraform test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `character_set` - (Required, String) Character Set Type. +* `cluster_id` - (Required, String) Cluster ID. +* `collate_rule` - (Required, String) Sort Rules. +* `db_name` - (Required, String) Database name. +* `description` - (Optional, String) Remarks. +* `user_host_privileges` - (Optional, List) Authorize user host permissions. + +The `user_host_privileges` object supports the following: + +* `db_host` - (Required, String) . +* `db_privilege` - (Required, String) . +* `db_user_name` - (Required, String) Authorized Users. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cynosdb cluster_databases can be imported using the id, e.g. + +``` +terraform import tencentcloud_cynosdb_cluster_databases.cluster_databases cluster_databases_id +``` + diff --git a/config/docs/r/cynosdb_cluster_password_complexity.html.markdown b/config/docs/r/cynosdb_cluster_password_complexity.html.markdown new file mode 100644 index 0000000..192dafe --- /dev/null +++ b/config/docs/r/cynosdb_cluster_password_complexity.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_cluster_password_complexity" +sidebar_current: "docs-tencentcloud-resource-cynosdb_cluster_password_complexity" +description: |- + Provides a resource to create a cynosdb cluster_password_complexity +--- + +# tencentcloud_cynosdb_cluster_password_complexity + +Provides a resource to create a cynosdb cluster_password_complexity + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_cluster_password_complexity" "cluster_password_complexity" { + cluster_id = "cynosdbmysql-cgd2gpwr" + validate_password_length = 8 + validate_password_mixed_case_count = 1 + validate_password_special_char_count = 1 + validate_password_number_count = 1 + validate_password_policy = "STRONG" + validate_password_dictionary = [ + "cccc", + "xxxx", + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) Cluster ID. +* `validate_password_length` - (Required, Int) Password length. +* `validate_password_mixed_case_count` - (Required, Int) Number of uppercase and lowercase characters. +* `validate_password_number_count` - (Required, Int) Number of digits. +* `validate_password_policy` - (Required, String) Password strength (MEDIUM, STRONG). +* `validate_password_special_char_count` - (Required, Int) Number of special characters. +* `validate_password_dictionary` - (Optional, Set: [`String`]) Data dictionary. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cynosdb cluster_password_complexity can be imported using the id, e.g. + +``` +terraform import tencentcloud_cynosdb_cluster_password_complexity.cluster_password_complexity cluster_password_complexity_id +``` + diff --git a/config/docs/r/cynosdb_cluster_resource_packages_attachment.html.markdown b/config/docs/r/cynosdb_cluster_resource_packages_attachment.html.markdown new file mode 100644 index 0000000..a7968ad --- /dev/null +++ b/config/docs/r/cynosdb_cluster_resource_packages_attachment.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_cluster_resource_packages_attachment" +sidebar_current: "docs-tencentcloud-resource-cynosdb_cluster_resource_packages_attachment" +description: |- + Provides a resource to create a cynosdb cluster_resource_packages_attachment +--- + +# tencentcloud_cynosdb_cluster_resource_packages_attachment + +Provides a resource to create a cynosdb cluster_resource_packages_attachment + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_cluster_resource_packages_attachment" "cluster_resource_packages_attachment" { + cluster_id = "cynosdbmysql-q1d8151n" + package_ids = ["package-hy4d2ppl"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) Cluster ID. +* `package_ids` - (Required, Set: [`String`], ForceNew) Resource Package Unique ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cynosdb cluster_resource_packages_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_cynosdb_cluster_resource_packages_attachment.cluster_resource_packages_attachment cluster_resource_packages_attachment_id +``` + diff --git a/config/docs/r/cynosdb_cluster_slave_zone.html.markdown b/config/docs/r/cynosdb_cluster_slave_zone.html.markdown new file mode 100644 index 0000000..fa4ed1a --- /dev/null +++ b/config/docs/r/cynosdb_cluster_slave_zone.html.markdown @@ -0,0 +1,142 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_cluster_slave_zone" +sidebar_current: "docs-tencentcloud-resource-cynosdb_cluster_slave_zone" +description: |- + Provides a resource to create a cynosdb cluster slave zone. +--- + +# tencentcloud_cynosdb_cluster_slave_zone + +Provides a resource to create a cynosdb cluster slave zone. + +## Example Usage + +### Set a new slave zone for a cynosdb cluster. + +```hcl +locals { + vpc_id = data.tencentcloud_vpc_subnets.gz3.instance_list.0.vpc_id + subnet_id = data.tencentcloud_vpc_subnets.gz3.instance_list.0.subnet_id + sg_id = data.tencentcloud_security_groups.internal.security_groups.0.security_group_id + sg_id2 = data.tencentcloud_security_groups.exclusive.security_groups.0.security_group_id +} + +variable "fixed_tags" { + default = { + fixed_resource : "do_not_remove" + } +} + +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +variable "new_availability_zone" { + default = "ap-guangzhou-6" +} + +variable "my_param_template" { + default = "15765" +} + +data "tencentcloud_security_groups" "internal" { + name = "default" + tags = var.fixed_tags +} + +data "tencentcloud_security_groups" "exclusive" { + name = "test_preset_sg" +} + +data "tencentcloud_vpc_subnets" "gz3" { + availability_zone = var.default_az + is_default = true +} + +resource "tencentcloud_cynosdb_cluster" "instance" { + available_zone = var.availability_zone + vpc_id = local.vpc_id + subnet_id = local.subnet_id + db_type = "MYSQL" + db_version = "5.7" + storage_limit = 1000 + cluster_name = "tf_test_cynosdb_cluster_slave_zone" + password = "cynos@123" + instance_maintain_duration = 3600 + instance_maintain_start_time = 10800 + instance_maintain_weekdays = [ + "Fri", + "Mon", + "Sat", + "Sun", + "Thu", + "Wed", + "Tue", + ] + + instance_cpu_core = 1 + instance_memory_size = 2 + param_items { + name = "character_set_server" + current_value = "utf8" + } + param_items { + name = "time_zone" + current_value = "+09:00" + } + + force_delete = true + + rw_group_sg = [ + local.sg_id + ] + ro_group_sg = [ + local.sg_id + ] + prarm_template_id = var.my_param_template +} + +resource "tencentcloud_cynosdb_cluster_slave_zone" "cluster_slave_zone" { + cluster_id = tencentcloud_cynosdb_cluster.instance.id + slave_zone = var.new_availability_zone +} +``` + +### Update the slave zone with specified value. + +```hcl +resource "tencentcloud_cynosdb_cluster_slave_zone" "cluster_slave_zone" { + cluster_id = tencentcloud_cynosdb_cluster.instance.id + slave_zone = var.availability_zone + + timeouts { + create = "500s" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) The ID of cluster. +* `slave_zone` - (Required, String) Slave zone. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cynosdb cluster_slave_zone can be imported using the id, e.g. + +``` +terraform import tencentcloud_cynosdb_cluster_slave_zone.cluster_slave_zone cluster_id#slave_zone +``` + diff --git a/config/docs/r/cynosdb_export_instance_error_logs.html.markdown b/config/docs/r/cynosdb_export_instance_error_logs.html.markdown new file mode 100644 index 0000000..c4f1d78 --- /dev/null +++ b/config/docs/r/cynosdb_export_instance_error_logs.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_export_instance_error_logs" +sidebar_current: "docs-tencentcloud-resource-cynosdb_export_instance_error_logs" +description: |- + Provides a resource to create a cynosdb export_instance_error_logs +--- + +# tencentcloud_cynosdb_export_instance_error_logs + +Provides a resource to create a cynosdb export_instance_error_logs + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_export_instance_error_logs" "export_instance_error_logs" { + instance_id = "cynosdbmysql-ins-afqx1hy0" + start_time = "2022-01-01 12:00:00" + end_time = "2022-01-01 14:00:00" + log_levels = ["note"] + key_words = ["content"] + file_type = "csv" + order_by = "Timestamp" + order_by_type = "ASC" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `end_time` - (Optional, String, ForceNew) Latest log time. +* `file_type` - (Optional, String, ForceNew) File type, optional values: csv, original. +* `key_words` - (Optional, Set: [`String`], ForceNew) keyword. +* `log_levels` - (Optional, Set: [`String`], ForceNew) Log level. +* `order_by_type` - (Optional, String, ForceNew) ASC or DESC. +* `order_by` - (Optional, String, ForceNew) Optional value Timestamp. +* `start_time` - (Optional, String, ForceNew) Log earliest time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `error_log_item_export` - List of instances in the read-write instance group. + * `content` - log content. + * `level` - Log level, optional values note, warning, error. + * `timestamp` - time. + + diff --git a/config/docs/r/cynosdb_export_instance_slow_queries.html.markdown b/config/docs/r/cynosdb_export_instance_slow_queries.html.markdown new file mode 100644 index 0000000..b5ac3a1 --- /dev/null +++ b/config/docs/r/cynosdb_export_instance_slow_queries.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_export_instance_slow_queries" +sidebar_current: "docs-tencentcloud-resource-cynosdb_export_instance_slow_queries" +description: |- + Provides a resource to create a cynosdb export_instance_slow_queries +--- + +# tencentcloud_cynosdb_export_instance_slow_queries + +Provides a resource to create a cynosdb export_instance_slow_queries + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_export_instance_slow_queries" "export_instance_slow_queries" { + instance_id = "cynosdbmysql-ins-123" + start_time = "2022-01-01 12:00:00" + end_time = "2022-01-01 14:00:00" + username = "root" + host = "10.10.10.10" + database = "db1" + file_type = "csv" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `database` - (Optional, String, ForceNew) Database name. +* `end_time` - (Optional, String, ForceNew) Latest transaction start time. +* `file_type` - (Optional, String, ForceNew) File type, optional values: csv, original. +* `host` - (Optional, String, ForceNew) Client host. +* `start_time` - (Optional, String, ForceNew) Earliest transaction start time. +* `username` - (Optional, String, ForceNew) user name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `file_content` - Slow query export content. + + diff --git a/config/docs/r/cynosdb_instance_param.html.markdown b/config/docs/r/cynosdb_instance_param.html.markdown new file mode 100644 index 0000000..0ca9c60 --- /dev/null +++ b/config/docs/r/cynosdb_instance_param.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_instance_param" +sidebar_current: "docs-tencentcloud-resource-cynosdb_instance_param" +description: |- + Provides a resource to create a cynosdb instance_param +--- + +# tencentcloud_cynosdb_instance_param + +Provides a resource to create a cynosdb instance_param + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_instance_param" "instance_param" { + cluster_id = "cynosdbmysql-bws8h88b" + instance_id = "cynosdbmysql-ins-rikr6z4o" + is_in_maintain_period = "no" + + instance_param_list { + current_value = "0" + param_name = "init_connect" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) Cluster ID. +* `instance_id` - (Optional, String, ForceNew) Instance ID. +* `instance_param_list` - (Optional, Set) Instance parameter list. +* `is_in_maintain_period` - (Optional, String) Yes: modify within the operation and maintenance time window, no: execute immediately (default value). + +The `instance_param_list` object supports the following: + +* `current_value` - (Required, String) Current value of parameter. +* `param_name` - (Required, String) Parameter Name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cynosdb_isolate_instance.html.markdown b/config/docs/r/cynosdb_isolate_instance.html.markdown new file mode 100644 index 0000000..f9b8131 --- /dev/null +++ b/config/docs/r/cynosdb_isolate_instance.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_isolate_instance" +sidebar_current: "docs-tencentcloud-resource-cynosdb_isolate_instance" +description: |- + Provides a resource to create a cynosdb isolate_instance +--- + +# tencentcloud_cynosdb_isolate_instance + +Provides a resource to create a cynosdb isolate_instance + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_account" "account" { + cluster_id = "cynosdbmysql-bws8h88b" + account_name = "terraform_test" + account_password = "Password@1234" + host = "%" + description = "testx" + max_user_connections = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) Cluster ID. +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `operate` - (Required, String) isolate, activate. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cynosdb_param_template.html.markdown b/config/docs/r/cynosdb_param_template.html.markdown new file mode 100644 index 0000000..19f2b99 --- /dev/null +++ b/config/docs/r/cynosdb_param_template.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_param_template" +sidebar_current: "docs-tencentcloud-resource-cynosdb_param_template" +description: |- + Provides a resource to create a cynosdb param_template +--- + +# tencentcloud_cynosdb_param_template + +Provides a resource to create a cynosdb param_template + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_param_template" "param_template" { + db_mode = "SERVERLESS" + engine_version = "5.7" + template_description = "terraform-template" + template_name = "terraform-template" + + param_list { + current_value = "-1" + param_name = "optimizer_trace_offset" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `engine_version` - (Required, String) MySQL version number. +* `template_name` - (Required, String) Template Name. +* `db_mode` - (Optional, String) Database type, optional values: NORMAL (default), SERVERLESS. +* `param_list` - (Optional, Set) parameter list. +* `template_description` - (Optional, String) Template Description. +* `template_id` - (Optional, Int) Optional parameter, template ID to be copied. + +The `param_list` object supports the following: + +* `current_value` - (Optional, String) Current value. +* `param_name` - (Optional, String) Parameter Name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cynosdb_proxy.html.markdown b/config/docs/r/cynosdb_proxy.html.markdown new file mode 100644 index 0000000..a751ed9 --- /dev/null +++ b/config/docs/r/cynosdb_proxy.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_proxy" +sidebar_current: "docs-tencentcloud-resource-cynosdb_proxy" +description: |- + Provides a resource to create a cynosdb proxy +--- + +# tencentcloud_cynosdb_proxy + +Provides a resource to create a cynosdb proxy + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_proxy" "proxy" { + cluster_id = "cynosdbmysql-bws8h88b" + cpu = 2 + mem = 4000 + unique_vpc_id = "vpc-k1t8ickr" + unique_subnet_id = "subnet-jdi5xn22" + connection_pool_type = "SessionConnectionPool" + open_connection_pool = "yes" + connection_pool_time_out = 30 + security_group_ids = ["sg-baxfiao5"] + description = "desc sample" + proxy_zones { + proxy_node_zone = "ap-guangzhou-7" + proxy_node_count = 2 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `cpu` - (Required, Int) Number of CPU cores. +* `mem` - (Required, Int) Memory. +* `connection_pool_time_out` - (Optional, Int) Connection pool threshold: unit (second). +* `connection_pool_type` - (Optional, String) Connection pool type: SessionConnectionPool (session level Connection pool). +* `description` - (Optional, String) Description. +* `open_connection_pool` - (Optional, String) Whether to enable Connection pool, yes - enable, no - do not enable. +* `proxy_count` - (Optional, Int) Number of database proxy group nodes. If it is set at the same time as the `proxy_zones` field, the `proxy_zones` parameter shall prevail. +* `proxy_zones` - (Optional, List) Database node information. +* `security_group_ids` - (Optional, Set: [`String`]) Security Group ID Array. +* `unique_subnet_id` - (Optional, String) The private network subnet ID is consistent with the cluster subnet ID by default. +* `unique_vpc_id` - (Optional, String) Private network ID, which is consistent with the cluster private network ID by default. + +The `proxy_zones` object supports the following: + +* `proxy_node_count` - (Optional, Int) Number of proxy nodes. +* `proxy_node_zone` - (Optional, String) Proxy node availability zone. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `proxy_group_id` - Proxy Group Id. +* `ro_instances` - Read only instance list. + + diff --git a/config/docs/r/cynosdb_proxy_end_point.html.markdown b/config/docs/r/cynosdb_proxy_end_point.html.markdown new file mode 100644 index 0000000..264bae9 --- /dev/null +++ b/config/docs/r/cynosdb_proxy_end_point.html.markdown @@ -0,0 +1,185 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_proxy_end_point" +sidebar_current: "docs-tencentcloud-resource-cynosdb_proxy_end_point" +description: |- + Provides a resource to create a cynosdb proxy_end_point +--- + +# tencentcloud_cynosdb_proxy_end_point + +Provides a resource to create a cynosdb proxy_end_point + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { + cluster_id = "cynosdbmysql-bws8h88b" + unique_vpc_id = "vpc-4owdpnwr" + unique_subnet_id = "subnet-dwj7ipnc" + instance_weights { + instance_id = "cynosdbmysql-ins-afqx1hy0" + weight = 1 + } +} +``` + + + +```hcl +resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { + cluster_id = "cynosdbmysql-bws8h88b" + unique_vpc_id = "vpc-4owdpnwr" + unique_subnet_id = "subnet-dwj7ipnc" + vip = "172.16.112.108" + vport = "3306" + instance_weights { + instance_id = "cynosdbmysql-ins-afqx1hy0" + weight = 1 + } +} +``` + +### Open connection pool + +```hcl +resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { + cluster_id = "cynosdbmysql-bws8h88b" + unique_vpc_id = "vpc-4owdpnwr" + unique_subnet_id = "subnet-dwj7ipnc" + vip = "172.16.112.108" + vport = "3306" + connection_pool_type = "SessionConnectionPool" + open_connection_pool = "yes" + connection_pool_time_out = 30 + instance_weights { + instance_id = "cynosdbmysql-ins-afqx1hy0" + weight = 1 + } +} +``` + +### Close connection pool + +```hcl +resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { + cluster_id = "cynosdbmysql-bws8h88b" + unique_vpc_id = "vpc-4owdpnwr" + unique_subnet_id = "subnet-dwj7ipnc" + vip = "172.16.112.108" + vport = "3306" + open_connection_pool = "no" + instance_weights { + instance_id = "cynosdbmysql-ins-afqx1hy0" + weight = 1 + } +} +``` + + + +```hcl +resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { + cluster_id = "cynosdbmysql-bws8h88b" + unique_vpc_id = "vpc-4owdpnwr" + unique_subnet_id = "subnet-dwj7ipnc" + vip = "172.16.112.108" + vport = "3306" + open_connection_pool = "no" + fail_over = "yes" + consistency_type = "global" + rw_type = "READWRITE" + consistency_time_out = 30 + instance_weights { + instance_id = "cynosdbmysql-ins-afqx1hy0" + weight = 1 + } +} +``` + + + +```hcl +resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { + cluster_id = "cynosdbmysql-bws8h88b" + unique_vpc_id = "vpc-4owdpnwr" + unique_subnet_id = "subnet-dwj7ipnc" + vip = "172.16.112.108" + vport = "3306" + open_connection_pool = "no" + rw_type = "READONLY" + instance_weights { + instance_id = "cynosdbmysql-ins-rikr6z4o" + weight = 1 + } +} +``` + +### Comprehensive parameter examples + +```hcl +resource "tencentcloud_cynosdb_proxy_end_point" "proxy_end_point" { + cluster_id = "cynosdbmysql-bws8h88b" + unique_vpc_id = "vpc-4owdpnwr" + unique_subnet_id = "subnet-dwj7ipnc" + vip = "172.16.112.118" + vport = "3306" + connection_pool_type = "SessionConnectionPool" + open_connection_pool = "yes" + connection_pool_time_out = 30 + security_group_ids = ["sg-7kpsbxdb"] + description = "desc value" + weight_mode = "system" + auto_add_ro = "yes" + fail_over = "yes" + consistency_type = "global" + rw_type = "READWRITE" + consistency_time_out = 30 + trans_split = true + access_mode = "nearby" + instance_weights { + instance_id = "cynosdbmysql-ins-afqx1hy0" + weight = 1 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `unique_subnet_id` - (Required, String) The private network subnet ID is consistent with the cluster subnet ID by default. +* `unique_vpc_id` - (Required, String) Private network ID, which is consistent with the cluster private network ID by default. +* `access_mode` - (Optional, String) Connection mode: nearby, balance. +* `auto_add_ro` - (Optional, String) Do you want to automatically add read-only instances? Yes - Yes, no - Do not automatically add. +* `connection_pool_time_out` - (Optional, Int) Connection pool threshold: unit (second). +* `connection_pool_type` - (Optional, String) Connection pool type: SessionConnectionPool (session level Connection pool). +* `consistency_time_out` - (Optional, Int) Consistency timeout. +* `consistency_type` - (Optional, String) Consistency type: event, global, session. +* `description` - (Optional, String) Description. +* `fail_over` - (Optional, String) Enable Failover. yes or no. +* `instance_weights` - (Optional, List) Instance Weight. +* `open_connection_pool` - (Optional, String) Whether to enable Connection pool, yes - enable, no - do not enable. +* `rw_type` - (Optional, String) Read and write attributes: READWRITE, READONLY. +* `security_group_ids` - (Optional, Set: [`String`]) Security Group ID Array. +* `trans_split` - (Optional, Bool) Transaction splitting. +* `vip` - (Optional, String) VIP Information. +* `vport` - (Optional, Int) Port Information. +* `weight_mode` - (Optional, String) Weight mode: system system allocation, custom customization. + +The `instance_weights` object supports the following: + +* `instance_id` - (Required, String) Instance Id. +* `weight` - (Required, Int) Instance Weight. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `instance_group_id` - Instance Group ID. +* `proxy_group_id` - Proxy Group ID. + + diff --git a/config/docs/r/cynosdb_read_only_instance_exclusive_access.html.markdown b/config/docs/r/cynosdb_read_only_instance_exclusive_access.html.markdown new file mode 100644 index 0000000..0145187 --- /dev/null +++ b/config/docs/r/cynosdb_read_only_instance_exclusive_access.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_read_only_instance_exclusive_access" +sidebar_current: "docs-tencentcloud-resource-cynosdb_read_only_instance_exclusive_access" +description: |- + Provides a resource to create a cynosdb read_only_instance_exclusive_access +--- + +# tencentcloud_cynosdb_read_only_instance_exclusive_access + +Provides a resource to create a cynosdb read_only_instance_exclusive_access + +## Example Usage + +```hcl +variable "cynosdb_cluster_id" { + default = "default_cynosdb_cluster" +} +variable "cynosdb_cluster_instance_id" { + default = "default_cluster_instance" +} + +variable "cynosdb_cluster_security_group_id" { + default = "default_security_group_id" +} + +data "tencentcloud_vpc_subnets" "gz3" { + availability_zone = var.default_az + is_default = true +} + +locals { + vpc_id = data.tencentcloud_vpc_subnets.gz3.instance_list.0.vpc_id + subnet_id = data.tencentcloud_vpc_subnets.gz3.instance_list.0.subnet_id +} + +resource "tencentcloud_cynosdb_read_only_instance_exclusive_access" "read_only_instance_exclusive_access" { + cluster_id = var.cynosdb_cluster_id + instance_id = var.cynosdb_cluster_instance_id + vpc_id = local.vpc_id + subnet_id = local.subnet_id + port = 1234 + security_group_ids = [var.cynosdb_cluster_security_group_id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) Cluster ID. +* `instance_id` - (Required, String, ForceNew) Need to activate a read-only instance ID with unique access. +* `port` - (Required, Int, ForceNew) port. +* `subnet_id` - (Required, String, ForceNew) The specified subnet ID. +* `vpc_id` - (Required, String, ForceNew) Specified VPC ID. +* `security_group_ids` - (Optional, Set: [`String`], ForceNew) Security Group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cynosdb_readonly_instance.html.markdown b/config/docs/r/cynosdb_readonly_instance.html.markdown new file mode 100644 index 0000000..502eda5 --- /dev/null +++ b/config/docs/r/cynosdb_readonly_instance.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_readonly_instance" +sidebar_current: "docs-tencentcloud-resource-cynosdb_readonly_instance" +description: |- + Provide a resource to create a CynosDB readonly instance. +--- + +# tencentcloud_cynosdb_readonly_instance + +Provide a resource to create a CynosDB readonly instance. + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_readonly_instance" "foo" { + cluster_id = cynosdbmysql-dzj5l8gz + instance_name = "tf-cynosdb-readonly-instance" + force_delete = true + instance_cpu_core = 2 + instance_memory_size = 4 + + instance_maintain_duration = 7200 + instance_maintain_start_time = 21600 + instance_maintain_weekdays = [ + "Fri", + "Mon", + "Sat", + "Sun", + "Thu", + "Wed", + "Tue", + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) Cluster ID which the readonly instance belongs to. +* `instance_name` - (Required, String, ForceNew) Name of instance. +* `force_delete` - (Optional, Bool) Indicate whether to delete readonly instance directly or not. Default is false. If set true, instance will be deleted instead of staying recycle bin. Note: works for both `PREPAID` and `POSTPAID_BY_HOUR` cluster. +* `instance_cpu_core` - (Optional, Int) The number of CPU cores of read-write type instance in the CynosDB cluster. Required while creating normal cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console. +* `instance_maintain_duration` - (Optional, Int) Duration time for maintenance, unit in second. `3600` by default. +* `instance_maintain_start_time` - (Optional, Int) Offset time from 00:00, unit in second. For example, 03:00am should be `10800`. `10800` by default. +* `instance_maintain_weekdays` - (Optional, Set: [`String`]) Weekdays for maintenance. `["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"]` by default. +* `instance_memory_size` - (Optional, Int) Memory capacity of read-write type instance, unit in GB. Required while creating normal cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console. +* `subnet_id` - (Optional, String) ID of the subnet within this VPC. +* `vpc_id` - (Optional, String) ID of the VPC. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `instance_status` - Status of the instance. +* `instance_storage_size` - Storage size of the instance, unit in GB. + + +## Import + +CynosDB readonly instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_cynosdb_readonly_instance.foo cynosdbmysql-ins-dhwynib6 +``` + diff --git a/config/docs/r/cynosdb_reload_proxy_node.html.markdown b/config/docs/r/cynosdb_reload_proxy_node.html.markdown new file mode 100644 index 0000000..740c9d3 --- /dev/null +++ b/config/docs/r/cynosdb_reload_proxy_node.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_reload_proxy_node" +sidebar_current: "docs-tencentcloud-resource-cynosdb_reload_proxy_node" +description: |- + Provides a resource to create a cynosdb reload_proxy_node +--- + +# tencentcloud_cynosdb_reload_proxy_node + +Provides a resource to create a cynosdb reload_proxy_node + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_reload_proxy_node" "reload_proxy_node" { + cluster_id = "cynosdbmysql-cgd2gpwr" + proxy_group_id = "cynosdbmysql-proxy-8lqtl8pk" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) cluster id. +* `proxy_group_id` - (Required, String, ForceNew) proxy group id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cynosdb reload_proxy_node can be imported using the id, e.g. + +``` +terraform import tencentcloud_cynosdb_reload_proxy_node.reload_proxy_node reload_proxy_node_id +``` + diff --git a/config/docs/r/cynosdb_restart_instance.html.markdown b/config/docs/r/cynosdb_restart_instance.html.markdown new file mode 100644 index 0000000..9d9f726 --- /dev/null +++ b/config/docs/r/cynosdb_restart_instance.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_restart_instance" +sidebar_current: "docs-tencentcloud-resource-cynosdb_restart_instance" +description: |- + Provides a resource to create a cynosdb restart_instance +--- + +# tencentcloud_cynosdb_restart_instance + +Provides a resource to create a cynosdb restart_instance + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_restart_instance" "restart_instance" { + instance_id = "cynosdbmysql-ins-afqx1hy0" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - instance state. + + diff --git a/config/docs/r/cynosdb_roll_back_cluster.html.markdown b/config/docs/r/cynosdb_roll_back_cluster.html.markdown new file mode 100644 index 0000000..9d5c117 --- /dev/null +++ b/config/docs/r/cynosdb_roll_back_cluster.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_roll_back_cluster" +sidebar_current: "docs-tencentcloud-resource-cynosdb_roll_back_cluster" +description: |- + Provides a resource to create a cynosdb roll_back_cluster +--- + +# tencentcloud_cynosdb_roll_back_cluster + +Provides a resource to create a cynosdb roll_back_cluster + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_roll_back_cluster" "roll_back_cluster" { + cluster_id = "cynosdbmysql-bws8h88b" + rollback_strategy = "snapRollback" + rollback_id = 732725 + # expect_time = "2022-01-20 00:00:00" + expect_time_thresh = 0 + rollback_databases { + old_database = "users" + new_database = "users_bak_1" + } + rollback_tables { + database = "tf_ci_test" + tables { + old_table = "test" + new_table = "test_bak_111" + } + + } + rollback_mode = "full" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) The ID of cluster. +* `rollback_id` - (Required, Int, ForceNew) Rollback ID. +* `rollback_strategy` - (Required, String, ForceNew) Backfile policy timeRollback - Backfile by point in time snapRollback - Backfile by backup file. +* `expect_time_thresh` - (Optional, Int, ForceNew) Expected Threshold (Obsolete). +* `expect_time` - (Optional, String, ForceNew) Expected rollback Time. +* `rollback_databases` - (Optional, List, ForceNew) Database list. +* `rollback_mode` - (Optional, String, ForceNew) Rollback mode by time point, full: normal; Db: fast; Table: Extreme speed (default is normal). +* `rollback_tables` - (Optional, List, ForceNew) Table list. + +The `rollback_databases` object supports the following: + +* `new_database` - (Required, String) New database name. +* `old_database` - (Required, String) Old database name. + +The `rollback_tables` object supports the following: + +* `database` - (Required, String) New database name. +* `tables` - (Required, List) Tables. + +The `tables` object supports the following: + +* `new_table` - (Required, String) New table name. +* `old_table` - (Required, String) Old table name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cynosdb_security_group.html.markdown b/config/docs/r/cynosdb_security_group.html.markdown new file mode 100644 index 0000000..5ba9b54 --- /dev/null +++ b/config/docs/r/cynosdb_security_group.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_security_group" +sidebar_current: "docs-tencentcloud-resource-cynosdb_security_group" +description: |- + Provides a resource to create a cynosdb security_group +--- + +# tencentcloud_cynosdb_security_group + +Provides a resource to create a cynosdb security_group + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_security_group" "test" { + cluster_id = "cynosdbmysql-bws8h88b" + security_group_ids = ["sg-baxfiao5"] + instance_group_type = "RO" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) Cluster id. +* `instance_group_type` - (Required, String, ForceNew) Instance group type. Available values: +-`HA` - HA group; +-`RO` - Read-only group; +-`ALL` - HA and RO group. +* `security_group_ids` - (Required, Set: [`String`]) A list of security group IDs to be modified, an array of one or more security group IDs. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +cynosdb security_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_cynosdb_security_group.security_group ${cluster_id}#${instance_group_type} +``` + diff --git a/config/docs/r/cynosdb_upgrade_proxy_version.html.markdown b/config/docs/r/cynosdb_upgrade_proxy_version.html.markdown new file mode 100644 index 0000000..aab9d1e --- /dev/null +++ b/config/docs/r/cynosdb_upgrade_proxy_version.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_upgrade_proxy_version" +sidebar_current: "docs-tencentcloud-resource-cynosdb_upgrade_proxy_version" +description: |- + Provides a resource to create a cynosdb upgrade_proxy_version +--- + +# tencentcloud_cynosdb_upgrade_proxy_version + +Provides a resource to create a cynosdb upgrade_proxy_version + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_upgrade_proxy_version" "upgrade_proxy_version" { + cluster_id = "cynosdbmysql-bws8h88b" + dst_proxy_version = "1.3.7" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) Cluster ID. +* `dst_proxy_version` - (Required, String) Database Agent Upgrade Version. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/cynosdb_wan.html.markdown b/config/docs/r/cynosdb_wan.html.markdown new file mode 100644 index 0000000..5fb6679 --- /dev/null +++ b/config/docs/r/cynosdb_wan.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "TDSQL-C MySQL(CynosDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_cynosdb_wan" +sidebar_current: "docs-tencentcloud-resource-cynosdb_wan" +description: |- + Provides a resource to create a cynosdb wan +--- + +# tencentcloud_cynosdb_wan + +Provides a resource to create a cynosdb wan + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_wan" "wan" { + cluster_id = "cynosdbmysql-bws8h88b" + instance_grp_id = "cynosdbmysql-grp-lxav0p9z" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `instance_grp_id` - (Required, String) Instance Group ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `wan_domain` - Domain name. +* `wan_ip` - Network ip. +* `wan_port` - Internet port. +* `wan_status` - Internet status. + + +## Import + +cynosdb wan can be imported using the id, e.g. + +``` +terraform import tencentcloud_cynosdb_wan.wan cynosdbmysql-bws8h88b#cynosdbmysql-grp-lxav0p9z +``` + diff --git a/config/docs/r/dasb_acl.html.markdown b/config/docs/r/dasb_acl.html.markdown new file mode 100644 index 0000000..2670234 --- /dev/null +++ b/config/docs/r/dasb_acl.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_acl" +sidebar_current: "docs-tencentcloud-resource-dasb_acl" +description: |- + Provides a resource to create a dasb acl +--- + +# tencentcloud_dasb_acl + +Provides a resource to create a dasb acl + +## Example Usage + +```hcl +resource "tencentcloud_dasb_acl" "example" { + name = "tf_example" + allow_disk_redirect = true + allow_any_account = false + allow_clip_file_up = true + allow_clip_file_down = true + allow_clip_text_up = true + allow_clip_text_down = true + allow_file_up = true + allow_file_down = true + max_file_up_size = 0 + max_file_down_size = 0 + user_id_set = ["6", "2"] + user_group_id_set = ["6", "36"] + device_id_set = ["39", "81"] + device_group_id_set = ["2", "3"] + account_set = ["root"] + cmd_template_id_set = ["1", "7"] + ac_template_id_set = [] + allow_disk_file_up = true + allow_disk_file_down = true + allow_shell_file_up = true + allow_shell_file_down = true + allow_file_del = true + allow_access_credential = true + department_id = "1.2" + validate_from = "2023-09-22T00:00:00+08:00" + validate_to = "2024-09-23T00:00:00+08:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `allow_any_account` - (Required, Bool) Allow any account. +* `allow_disk_redirect` - (Required, Bool) Allow disk redirect. +* `name` - (Required, String) Acl name. +* `ac_template_id_set` - (Optional, Set: [`String`]) Associate high-risk DB template IDs. +* `account_set` - (Optional, Set: [`String`]) Associated accounts. +* `allow_access_credential` - (Optional, Bool) Allow access credential,default allow. +* `allow_clip_file_down` - (Optional, Bool) Allow clip file down. +* `allow_clip_file_up` - (Optional, Bool) Allow clip file up. +* `allow_clip_text_down` - (Optional, Bool) Allow clip text down. +* `allow_clip_text_up` - (Optional, Bool) Allow clip text up. +* `allow_disk_file_down` - (Optional, Bool) Allow disk file download. +* `allow_disk_file_up` - (Optional, Bool) Allow disk file upload. +* `allow_file_del` - (Optional, Bool) Allow sftp file delete. +* `allow_file_down` - (Optional, Bool) Allow sftp file download. +* `allow_file_up` - (Optional, Bool) Allow sftp up file. +* `allow_shell_file_down` - (Optional, Bool) Allow shell file download. +* `allow_shell_file_up` - (Optional, Bool) Allow shell file upload. +* `cmd_template_id_set` - (Optional, Set: [`Int`]) Associated high-risk command template ID. +* `department_id` - (Optional, String) Department id. +* `device_group_id_set` - (Optional, Set: [`Int`]) Associated device group ID. +* `device_id_set` - (Optional, Set: [`Int`]) Associated collection of device IDs. +* `max_file_down_size` - (Optional, Int) File transfer download size limit (reserved parameter, currently unused). +* `max_file_up_size` - (Optional, Int) File upload transfer size limit (artifact parameter, currently unused). +* `user_group_id_set` - (Optional, Set: [`Int`]) Associated user group ID. +* `user_id_set` - (Optional, Set: [`Int`]) Associated set of user IDs. +* `validate_from` - (Optional, String) Access permission effective time, such as: 2021-09-22T00:00:00+08:00If the effective and expiry time are not filled in, the access rights will be valid for a long time. +* `validate_to` - (Optional, String) Access permission expiration time, such as: 2021-09-23T00:00:00+08:00If the effective and expiry time are not filled in, the access rights will be valid for a long time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dasb acl can be imported using the id, e.g. + +``` +terraform import tencentcloud_dasb_acl.example 132 +``` + diff --git a/config/docs/r/dasb_bind_device_account_password.html.markdown b/config/docs/r/dasb_bind_device_account_password.html.markdown new file mode 100644 index 0000000..70b9771 --- /dev/null +++ b/config/docs/r/dasb_bind_device_account_password.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_bind_device_account_password" +sidebar_current: "docs-tencentcloud-resource-dasb_bind_device_account_password" +description: |- + Provides a resource to create a dasb bind_device_account_password +--- + +# tencentcloud_dasb_bind_device_account_password + +Provides a resource to create a dasb bind_device_account_password + +## Example Usage + +```hcl +resource "tencentcloud_dasb_bind_device_account_password" "example" { + device_account_id = 16 + password = "TerraformPassword" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `device_account_id` - (Required, Int, ForceNew) Host account ID. +* `password` - (Required, String, ForceNew) Host account password. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dasb_bind_device_account_private_key.html.markdown b/config/docs/r/dasb_bind_device_account_private_key.html.markdown new file mode 100644 index 0000000..4a5141b --- /dev/null +++ b/config/docs/r/dasb_bind_device_account_private_key.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_bind_device_account_private_key" +sidebar_current: "docs-tencentcloud-resource-dasb_bind_device_account_private_key" +description: |- + Provides a resource to create a dasb bind_device_account_private_key +--- + +# tencentcloud_dasb_bind_device_account_private_key + +Provides a resource to create a dasb bind_device_account_private_key + +## Example Usage + +```hcl +resource "tencentcloud_dasb_bind_device_account_private_key" "example" { + device_account_id = 16 + private_key = "MIICXAIBAAKBgQCqGKukO1De7zhZj6+H0qtjTkVxwTCpvKe4eCZ0FPqri0cb2JZfXJ/DgYSF6vUpwmJG8wVQZKjeGcjDOL5UlsuusFncCzWBQ7RKNUSesmQRMSGkVb1/3j+skZ6UtW+5u09lHNsj6tQ51s1SPrCBkedbNf0Tp0GbMJDyR4e9T04ZZwIDAQABAoGAFijko56+qGyN8M0RVyaRAXz++xTqHBLh" + private_key_password = "TerraformPassword" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `device_account_id` - (Required, Int, ForceNew) Host account ID. +* `private_key` - (Required, String, ForceNew) Host account private key, the latest length is 128 bytes, the maximum length is 8192 bytes. +* `private_key_password` - (Optional, String, ForceNew) Host account private key password, maximum length 256 bytes. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dasb_bind_device_resource.html.markdown b/config/docs/r/dasb_bind_device_resource.html.markdown new file mode 100644 index 0000000..3cb966b --- /dev/null +++ b/config/docs/r/dasb_bind_device_resource.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_bind_device_resource" +sidebar_current: "docs-tencentcloud-resource-dasb_bind_device_resource" +description: |- + Provides a resource to create a dasb bind_device_resource +--- + +# tencentcloud_dasb_bind_device_resource + +Provides a resource to create a dasb bind_device_resource + +## Example Usage + +```hcl +resource "tencentcloud_dasb_bind_device_resource" "example" { + resource_id = "bh-saas-ocmzo6lgxiv" + device_id_set = [17, 18] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `device_id_set` - (Required, Set: [`Int`], ForceNew) Asset ID collection. +* `resource_id` - (Required, String, ForceNew) Bastion host service ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dasb_cmd_template.html.markdown b/config/docs/r/dasb_cmd_template.html.markdown new file mode 100644 index 0000000..49b2fc8 --- /dev/null +++ b/config/docs/r/dasb_cmd_template.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_cmd_template" +sidebar_current: "docs-tencentcloud-resource-dasb_cmd_template" +description: |- + Provides a resource to create a dasb cmd_template +--- + +# tencentcloud_dasb_cmd_template + +Provides a resource to create a dasb cmd_template + +## Example Usage + +```hcl +resource "tencentcloud_dasb_cmd_template" "example" { + name = "tf_example" + cmd_list = "rm -rf*" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cmd_list` - (Required, String) Command list, n separated, maximum length 32768 bytes. +* `name` - (Required, String) Template name, maximum length 32 characters, cannot contain blank characters. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dasb cmd_template can be imported using the id, e.g. + +``` +terraform import tencentcloud_dasb_cmd_template.example 15 +``` + diff --git a/config/docs/r/dasb_device.html.markdown b/config/docs/r/dasb_device.html.markdown new file mode 100644 index 0000000..474b2db --- /dev/null +++ b/config/docs/r/dasb_device.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_device" +sidebar_current: "docs-tencentcloud-resource-dasb_device" +description: |- + Provides a resource to create a dasb device +--- + +# tencentcloud_dasb_device + +Provides a resource to create a dasb device + +## Example Usage + +```hcl +resource "tencentcloud_dasb_device" "example" { + os_name = "Linux" + ip = "192.168.0.1" + port = 80 + name = "tf_example" + department_id = "1.2.3" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ip` - (Required, String) IP address. +* `os_name` - (Required, String) Operating system name, only Linux, Windows or MySQL. +* `port` - (Required, Int) Management port. +* `department_id` - (Optional, String) The department ID to which the device belongs. +* `ip_port_set` - (Optional, Set: [`String`]) Asset multi-node: fields ip and port. +* `name` - (Optional, String) Hostname, can be empty. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dasb device can be imported using the id, e.g. + +``` +terraform import tencentcloud_dasb_device.example 17 +``` + diff --git a/config/docs/r/dasb_device_account.html.markdown b/config/docs/r/dasb_device_account.html.markdown new file mode 100644 index 0000000..eb66ae3 --- /dev/null +++ b/config/docs/r/dasb_device_account.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_device_account" +sidebar_current: "docs-tencentcloud-resource-dasb_device_account" +description: |- + Provides a resource to create a dasb device_account +--- + +# tencentcloud_dasb_device_account + +Provides a resource to create a dasb device_account + +## Example Usage + +```hcl +resource "tencentcloud_dasb_device_account" "example" { + device_id = 100 + account = "root" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account` - (Required, String, ForceNew) Device account. +* `device_id` - (Required, Int, ForceNew) Device ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dasb device_account can be imported using the id, e.g. + +``` +terraform import tencentcloud_dasb_device_account.example 11 +``` + diff --git a/config/docs/r/dasb_device_group.html.markdown b/config/docs/r/dasb_device_group.html.markdown new file mode 100644 index 0000000..5ebddbd --- /dev/null +++ b/config/docs/r/dasb_device_group.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_device_group" +sidebar_current: "docs-tencentcloud-resource-dasb_device_group" +description: |- + Provides a resource to create a dasb device_group +--- + +# tencentcloud_dasb_device_group + +Provides a resource to create a dasb device_group + +## Example Usage + +```hcl +resource "tencentcloud_dasb_device_group" "example" { + name = "tf_example" + department_id = "1.2" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Device group name, the maximum length is 32 characters. +* `department_id` - (Optional, String) The ID of the department to which the asset group belongs, such as: 1.2.3 name, with a maximum length of 32 characters. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dasb device_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_dasb_device_group.example 36 +``` + diff --git a/config/docs/r/dasb_device_group_members.html.markdown b/config/docs/r/dasb_device_group_members.html.markdown new file mode 100644 index 0000000..026a7cd --- /dev/null +++ b/config/docs/r/dasb_device_group_members.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_device_group_members" +sidebar_current: "docs-tencentcloud-resource-dasb_device_group_members" +description: |- + Provides a resource to create a dasb device_group_members +--- + +# tencentcloud_dasb_device_group_members + +Provides a resource to create a dasb device_group_members + +## Example Usage + +```hcl +resource "tencentcloud_dasb_device_group_members" "example" { + device_group_id = 3 + member_id_set = [1, 2, 3] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `device_group_id` - (Required, Int, ForceNew) Device Group ID. +* `member_id_set` - (Required, Set: [`Int`], ForceNew) A collection of device IDs that need to be added to the device group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dasb device_group_members can be imported using the id, e.g. + +``` +terraform import tencentcloud_dasb_device_group_members.example 3#1,2,3 +``` + diff --git a/config/docs/r/dasb_reset_user.html.markdown b/config/docs/r/dasb_reset_user.html.markdown new file mode 100644 index 0000000..594d26d --- /dev/null +++ b/config/docs/r/dasb_reset_user.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_reset_user" +sidebar_current: "docs-tencentcloud-resource-dasb_reset_user" +description: |- + Provides a resource to create a dasb reset_user +--- + +# tencentcloud_dasb_reset_user + +Provides a resource to create a dasb reset_user + +## Example Usage + +```hcl +resource "tencentcloud_dasb_reset_user" "example" { + user_id = 16 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `user_id` - (Required, Int, ForceNew) User Id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dasb_resource.html.markdown b/config/docs/r/dasb_resource.html.markdown new file mode 100644 index 0000000..25f5998 --- /dev/null +++ b/config/docs/r/dasb_resource.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_resource" +sidebar_current: "docs-tencentcloud-resource-dasb_resource" +description: |- + Provides a resource to create a dasb resource +--- + +# tencentcloud_dasb_resource + +Provides a resource to create a dasb resource + +## Example Usage + +```hcl +resource "tencentcloud_dasb_resource" "example" { + deploy_region = "ap-guangzhou" + vpc_id = "vpc-q1of50wz" + subnet_id = "subnet-7uhvm46o" + resource_edition = "standard" + resource_node = 2 + time_unit = "m" + time_span = 1 + auto_renew_flag = 1 + deploy_zone = "ap-guangzhou-6" + package_bandwidth = 10 + package_node = 50 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_renew_flag` - (Required, Int) Automatic renewal. 1 is auto renew flag, 0 is not. +* `deploy_region` - (Required, String) Deploy region. +* `resource_edition` - (Required, String) Resource type.Value:standard/pro. +* `resource_node` - (Required, Int) Number of resource nodes. +* `subnet_id` - (Required, String) Deploy resource subnetId. +* `time_span` - (Required, Int) Billing time. +* `time_unit` - (Required, String) Billing cycle, only support m: month. +* `vpc_id` - (Required, String) Deploy resource vpcId. +* `deploy_zone` - (Optional, String) Deploy zone. +* `package_bandwidth` - (Optional, Int) Number of bandwidth expansion packets (4M). +* `package_node` - (Optional, Int) Number of authorized point extension packages (50 points). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dasb resource can be imported using the id, e.g. + +``` +terraform import tencentcloud_dasb_resource.example bh-saas-kk5rabk0 +``` + diff --git a/config/docs/r/dasb_user.html.markdown b/config/docs/r/dasb_user.html.markdown new file mode 100644 index 0000000..1eb470d --- /dev/null +++ b/config/docs/r/dasb_user.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_user" +sidebar_current: "docs-tencentcloud-resource-dasb_user" +description: |- + Provides a resource to create a dasb user +--- + +# tencentcloud_dasb_user + +Provides a resource to create a dasb user + +## Example Usage + +```hcl +resource "tencentcloud_dasb_user" "example" { + user_name = "tf_example" + real_name = "terraform" + phone = "+86|18345678782" + email = "demo@tencent.com" + validate_from = "2023-09-22T02:00:00+08:00" + validate_to = "2023-09-23T03:00:00+08:00" + department_id = "1.2" + auth_type = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `real_name` - (Required, String) Real name, maximum length 20 characters, cannot contain blank characters. +* `user_name` - (Required, String) Username, 3-20 characters, must start with an English letter and cannot contain characters other than letters, numbers, '.', '_', '-'. +* `auth_type` - (Optional, Int) Authentication method, 0 - local, 1 - LDAP, 2 - OAuth. If not passed, the default is 0. +* `department_id` - (Optional, String) Department ID, such as: 1.2.3. +* `email` - (Optional, String) Email. +* `group_id_set` - (Optional, Set: [`Int`]) The set of user group IDs to which it belongs. +* `phone` - (Optional, String) Fill in the mainland mobile phone number directly. If it is a number from other countries or regions, enter it in the format of country area code|mobile phone number. For example: +852|xxxxxxxx. +* `validate_from` - (Optional, String) User effective time, such as: 2021-09-22T00:00:00+00:00If the effective and expiry time are not filled in, the user will be valid for a long time. +* `validate_time` - (Optional, String) Access time period limit, a string composed of 0 and 1, length 168 (7 * 24), representing the time period the user is allowed to access in a week. The Nth character in the string represents the Nth hour of the week, 0 - means access is not allowed, 1 - means access is allowed. +* `validate_to` - (Optional, String) User expiration time, such as: 2021-09-23T00:00:00+00:00If the effective and expiry time are not filled in, the user will be valid for a long time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dasb user can be imported using the id, e.g. + +``` +terraform import tencentcloud_dasb_user.example 134 +``` + diff --git a/config/docs/r/dasb_user_group.html.markdown b/config/docs/r/dasb_user_group.html.markdown new file mode 100644 index 0000000..d5c5b37 --- /dev/null +++ b/config/docs/r/dasb_user_group.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_user_group" +sidebar_current: "docs-tencentcloud-resource-dasb_user_group" +description: |- + Provides a resource to create a dasb user_group +--- + +# tencentcloud_dasb_user_group + +Provides a resource to create a dasb user_group + +## Example Usage + +```hcl +resource "tencentcloud_dasb_user_group" "example" { + name = "tf_example_update" +} +``` + +### Or + +```hcl +resource "tencentcloud_dasb_user_group" "example" { + name = "tf_example_update" + department_id = "1.2" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) User group name, maximum length 32 characters. +* `department_id` - (Optional, String) ID of the department to which the user group belongs, such as: 1.2.3. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dasb user_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_dasb_user_group.example 16 +``` + diff --git a/config/docs/r/dasb_user_group_members.html.markdown b/config/docs/r/dasb_user_group_members.html.markdown new file mode 100644 index 0000000..bbdaf1d --- /dev/null +++ b/config/docs/r/dasb_user_group_members.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Bastion Host(BH)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dasb_user_group_members" +sidebar_current: "docs-tencentcloud-resource-dasb_user_group_members" +description: |- + Provides a resource to create a dasb user_group_members +--- + +# tencentcloud_dasb_user_group_members + +Provides a resource to create a dasb user_group_members + +## Example Usage + +```hcl +resource "tencentcloud_dasb_user_group_members" "example" { + user_group_id = 3 + member_id_set = [1, 2, 3] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `member_id_set` - (Required, Set: [`Int`], ForceNew) Collection of member user IDs. +* `user_group_id` - (Required, Int, ForceNew) User Group ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dasb user_group_members can be imported using the id, e.g. + +``` +terraform import tencentcloud_dasb_user_group_members.example 3#1,2,3 +``` + diff --git a/config/docs/r/dayu_cc_http_policy.html.markdown b/config/docs/r/dayu_cc_http_policy.html.markdown new file mode 100644 index 0000000..771a94a --- /dev/null +++ b/config/docs/r/dayu_cc_http_policy.html.markdown @@ -0,0 +1,105 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_cc_http_policy" +sidebar_current: "docs-tencentcloud-resource-dayu_cc_http_policy" +description: |- + Use this resource to create a dayu CC self-define http policy +--- + +# tencentcloud_dayu_cc_http_policy + +Use this resource to create a dayu CC self-define http policy + +## Example Usage + +```hcl +resource "tencentcloud_dayu_cc_http_policy" "test_bgpip" { + resource_type = "bgpip" + resource_id = "bgpip-00000294" + name = "policy_match" + smode = "matching" + action = "drop" + switch = true + rule_list { + skey = "host" + operator = "include" + value = "123" + } +} + +resource "tencentcloud_dayu_cc_http_policy" "test_net" { + resource_type = "net" + resource_id = "net-0000007e" + name = "policy_match" + smode = "matching" + action = "drop" + switch = true + rule_list { + skey = "cgi" + operator = "equal" + value = "123" + } +} + +resource "tencentcloud_dayu_cc_http_policy" "test_bgpmultip" { + resource_type = "bgp-multip" + resource_id = "bgp-0000008o" + name = "policy_match" + smode = "matching" + action = "alg" + switch = true + ip = "111.230.178.25" + + rule_list { + skey = "referer" + operator = "not_include" + value = "123" + } +} + +resource "tencentcloud_dayu_cc_http_policy" "test_bgp" { + resource_type = "bgp" + resource_id = "bgp-000006mq" + name = "policy_match" + smode = "matching" + action = "alg" + switch = true + + rule_list { + skey = "ua" + operator = "not_include" + value = "123" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String, ForceNew) Name of the CC self-define http policy. Length should between 1 and 20. +* `resource_id` - (Required, String, ForceNew) ID of the resource that the CC self-define http policy works for. +* `resource_type` - (Required, String, ForceNew) Type of the resource that the CC self-define http policy works for, valid values are `bgpip`, `bgp`, `bgp-multip` and `net`. +* `action` - (Optional, String) Action mode, only valid when `smode` is `matching`. Valid values are `alg` and `drop`. +* `frequency` - (Optional, Int) Max frequency per minute, only valid when `smode` is `speedlimit`, the valid value ranges from 1 to 10000. +* `ip` - (Optional, String) Ip of the CC self-define http policy, only valid when `resource_type` is `bgp-multip`. The num of list items can only be set one. +* `rule_list` - (Optional, Set) Rule list of the CC self-define http policy, only valid when `smode` is `matching`. +* `smode` - (Optional, String) Match mode, and valid values are `matching`, `speedlimit`. Note: the speed limit type CC self-define policy can only set one. +* `switch` - (Optional, Bool) Indicate the CC self-define http policy takes effect or not. + +The `rule_list` object supports the following: + +* `operator` - (Optional, String) Operator of the rule. Valid values: `include`, `not_include`, `equal`. +* `skey` - (Optional, String) Key of the rule. Valid values: `host`, `cgi`, `ua`, `referer`. +* `value` - (Optional, String) Rule value, then length should be less than 31 bytes. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the CC self-define http policy. +* `policy_id` - Id of the CC self-define http policy. + + diff --git a/config/docs/r/dayu_cc_https_policy.html.markdown b/config/docs/r/dayu_cc_https_policy.html.markdown new file mode 100644 index 0000000..6d9e718 --- /dev/null +++ b/config/docs/r/dayu_cc_https_policy.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_cc_https_policy" +sidebar_current: "docs-tencentcloud-resource-dayu_cc_https_policy" +description: |- + Use this resource to create a dayu CC self-define https policy +--- + +# tencentcloud_dayu_cc_https_policy + +Use this resource to create a dayu CC self-define https policy + +~> **NOTE:** creating CC self-define https policy need a valid resource `tencentcloud_dayu_l7_rule`; The resource only support Anti-DDoS of resource type `bgpip`. + +## Example Usage + +```hcl +resource "tencentcloud_dayu_cc_https_policy" "test_policy" { + resource_type = tencentcloud_dayu_l7_rule.test_rule.resource_type + resource_id = tencentcloud_dayu_l7_rule.test_rule.resource_id + rule_id = tencentcloud_dayu_l7_rule.test_rule.rule_id + domain = tencentcloud_dayu_l7_rule.test_rule.domain + name = "policy_test" + action = "drop" + switch = true + + rule_list { + skey = "cgi" + operator = "include" + value = "123" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Domain that the CC self-define https policy works for, only valid when `protocol` is `https`. +* `name` - (Required, String, ForceNew) Name of the CC self-define https policy. Length should between 1 and 20. +* `resource_id` - (Required, String, ForceNew) ID of the resource that the CC self-define https policy works for. +* `resource_type` - (Required, String, ForceNew) Type of the resource that the CC self-define https policy works for, valid value is `bgpip`. +* `rule_id` - (Required, String, ForceNew) Rule id of the domain that the CC self-define https policy works for, only valid when `protocol` is `https`. +* `rule_list` - (Required, Set) Rule list of the CC self-define https policy. +* `action` - (Optional, String) Action mode. Valid values are `alg` and `drop`. +* `switch` - (Optional, Bool) Indicate the CC self-define https policy takes effect or not. + +The `rule_list` object supports the following: + +* `operator` - (Required, String) Operator of the rule. Valid values are `include` and `equal`. +* `skey` - (Required, String) Key of the rule. Valid values are `cgi`, `ua` and `referer`. +* `value` - (Required, String) Rule value, then length should be less than 31 bytes. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the CC self-define https policy. +* `ip_list` - Ip of the CC self-define https policy. +* `policy_id` - Id of the CC self-define https policy. + + diff --git a/config/docs/r/dayu_cc_policy_v2.html.markdown b/config/docs/r/dayu_cc_policy_v2.html.markdown new file mode 100644 index 0000000..8d1213c --- /dev/null +++ b/config/docs/r/dayu_cc_policy_v2.html.markdown @@ -0,0 +1,141 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_cc_policy_v2" +sidebar_current: "docs-tencentcloud-resource-dayu_cc_policy_v2" +description: |- + Use this resource to create a dayu CC policy +--- + +# tencentcloud_dayu_cc_policy_v2 + +Use this resource to create a dayu CC policy + +## Example Usage + +```hcl +resource "tencentcloud_dayu_cc_policy_v2" "demo" { + resource_id = "bgpip-000004xf" + business = "bgpip" + thresholds { + domain = "12.com" + threshold = 0 + } + cc_geo_ip_policys { + action = "drop" + region_type = "china" + domain = "12.com" + protocol = "http" + } + + cc_black_white_ips { + protocol = "http" + domain = "12.com" + black_white_ip = "1.2.3.4" + type = "black" + } + cc_precision_policys { + policy_action = "drop" + domain = "1.com" + protocol = "http" + ip = "162.62.163.34" + policys { + field_name = "cgi" + field_type = "value" + value = "12123.com" + value_operator = "equal" + } + } + cc_precision_req_limits { + domain = "11.com" + protocol = "http" + level = "loose" + policys { + action = "alg" + execute_duration = 2 + mode = "equal" + period = 5 + request_num = 12 + uri = "15.com" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `business` - (Required, String) Business of resource instance. bgpip indicates anti-anti-ip ip; bgp means exclusive package; bgp-multip means shared packet; net indicates anti-anti-ip pro version. +* `resource_id` - (Required, String) The ID of the resource instance. +* `cc_black_white_ips` - (Optional, List) Blacklist and whitelist. +* `cc_geo_ip_policys` - (Optional, List) Details of the CC region blocking policy list. +* `cc_precision_policys` - (Optional, List) CC Precision Protection List. +* `cc_precision_req_limits` - (Optional, List) CC frequency throttling policy. +* `thresholds` - (Optional, List) List of protection threshold configurations. + +The `cc_black_white_ips` object supports the following: + +* `black_white_ip` - (Required, String) Blacklist and whitelist IP addresses. +* `domain` - (Required, String) Domain. +* `protocol` - (Required, String) Protocol. +* `type` - (Required, String) IP type, value [black(blacklist IP), white (whitelist IP)]. +* `create_time` - (Optional, String) Create time. +* `modify_time` - (Optional, String) Modify time. + +The `cc_geo_ip_policys` object supports the following: + +* `action` - (Required, String) User action, drop or arg. +* `domain` - (Required, String) domain. +* `protocol` - (Required, String) Protocol, preferably HTTP, HTTPS. +* `region_type` - (Required, String) Regional types, divided into china, oversea and customized. +* `area_list` - (Optional, List) The list of region IDs that the user selects to block. +* `create_time` - (Optional, String) Create time. +* `modify_time` - (Optional, String) Modify time. + +The `cc_precision_policys` object supports the following: + +* `domain` - (Required, String) Domain. +* `ip` - (Required, String) Ip address. +* `policy_action` - (Required, String) Policy mode (discard or captcha). +* `policys` - (Required, List) A list of policies. +* `protocol` - (Required, String) Protocol. + +The `cc_precision_req_limits` object supports the following: + +* `domain` - (Required, String) Domain. +* `level` - (Required, String) Protection rating, the optional value of default means default policy, loose means loose, and strict means strict. +* `policys` - (Required, List) The CC Frequency Limit Policy Item field. +* `protocol` - (Required, String) Protocol, preferably HTTP, HTTPS. + +The `policys` object supports the following: + +* `action` - (Required, String) The frequency limit policy mode, the optional value of arg indicates the verification code, and drop indicates the discard. +* `execute_duration` - (Required, Int) The duration of the frequency limit policy can be taken from 1 to 86400 per second. +* `mode` - (Required, String) The policy item is compared, and the optional value include indicates inclusion, and equal means equal. +* `period` - (Required, Int) Statistical period, take values 1, 10, 30, 60, in seconds. +* `request_num` - (Required, Int) The number of requests, the value is 1 to 20000. +* `cookie` - (Optional, String) Cookies, one of the three policy entries can only be filled in. +* `uri` - (Optional, String) Uri, one of the three policy entries can only be filled in. +* `user_agent` - (Optional, String) User-Agent, only one of the three policy entries can be filled in. + +The `policys` object supports the following: + +* `field_name` - (Required, String) Configuration item types, currently only support value. +* `field_type` - (Required, String) Configuration fields with the desirable values cgi, ua, cookie, referer, accept, srcip. +* `value_operator` - (Required, String) Configure the item-value comparison mode, which can be taken as the value of evaluate, not_equal, include. +* `value` - (Required, String) Configure the value. + +The `thresholds` object supports the following: + +* `domain` - (Required, String) domain. +* `threshold` - (Required, Int) Cleaning threshold, -1 indicates that the `default` mode is turned on. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dayu_ddos_ip_attachment_v2.html.markdown b/config/docs/r/dayu_ddos_ip_attachment_v2.html.markdown new file mode 100644 index 0000000..ea49d5a --- /dev/null +++ b/config/docs/r/dayu_ddos_ip_attachment_v2.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_ddos_ip_attachment_v2" +sidebar_current: "docs-tencentcloud-resource-dayu_ddos_ip_attachment_v2" +description: |- + Provides a resource to create a antiddos ip. Only support for bgp-multip. +--- + +# tencentcloud_dayu_ddos_ip_attachment_v2 + +Provides a resource to create a antiddos ip. Only support for bgp-multip. + +## Example Usage + +```hcl +resource "tencentcloud_dayu_ddos_ip_attachment_v2" "boundip" { + id = "bgp-xxxxxx" + bound_ip_list { + ip = "1.1.1.1" + biz_type = "public" + instance_id = "ins-xxx" + device_type = "cvm" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bgp_instance_id` - (Required, String, ForceNew) Anti-DDoS instance ID. +* `bound_ip_list` - (Optional, List, ForceNew) Array of IPs to bind to the Anti-DDoS instance. For Anti-DDoS Pro Single IP instance, the array contains only one IP. If there are no IPs to bind, it is empty; however, either BoundDevList or UnBoundDevList must not be empty. + +The `bound_ip_list` object supports the following: + +* `ip` - (Required, String) IP address. +* `biz_type` - (Optional, String) Category of product that can be bound. Valid values: public (CVM and CLB), bm (BM), eni (ENI), vpngw (VPN gateway), natgw (NAT gateway), waf (WAF), fpc (financial products), gaap (GAAP), and other (hosted IP). This field is required when you perform binding. +* `device_type` - (Optional, String) Sub-product category. Valid values: cvm (CVM), lb (Load balancer), eni (ENI), vpngw (VPN gateway), natgw (NAT gateway), waf (WAF), fpc (financial products), gaap (GAAP), eip (BM EIP) and other (managed IP). This field is required when you perform binding. +* `instance_id` - (Optional, String) Anti-DDoS instance ID of the IP. This field is required only when the instance is bound to an IP. For example, this field InstanceId will be eni-* if the instance ID is bound to an ENI IP; none if there is no instance to bind to a managed IP. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dayu_ddos_policy.html.markdown b/config/docs/r/dayu_ddos_policy.html.markdown new file mode 100644 index 0000000..03efcf7 --- /dev/null +++ b/config/docs/r/dayu_ddos_policy.html.markdown @@ -0,0 +1,160 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_ddos_policy" +sidebar_current: "docs-tencentcloud-resource-dayu_ddos_policy" +description: |- + Use this resource to create dayu DDoS policy +--- + +# tencentcloud_dayu_ddos_policy + +Use this resource to create dayu DDoS policy + +## Example Usage + +```hcl +resource "tencentcloud_dayu_ddos_policy" "test_policy" { + resource_type = "bgpip" + name = "tf_test_policy" + black_ips = ["1.1.1.1"] + white_ips = ["2.2.2.2"] + + drop_options { + drop_tcp = true + drop_udp = true + drop_icmp = true + drop_other = true + drop_abroad = true + check_sync_conn = true + s_new_limit = 100 + d_new_limit = 100 + s_conn_limit = 100 + d_conn_limit = 100 + tcp_mbps_limit = 100 + udp_mbps_limit = 100 + icmp_mbps_limit = 100 + other_mbps_limit = 100 + bad_conn_threshold = 100 + null_conn_enable = true + conn_timeout = 500 + syn_rate = 50 + syn_limit = 100 + } + + port_filters { + start_port = "2000" + end_port = "2500" + protocol = "all" + action = "drop" + kind = 1 + } + + packet_filters { + protocol = "tcp" + action = "drop" + d_start_port = 1000 + d_end_port = 1500 + s_start_port = 2000 + s_end_port = 2500 + pkt_length_max = 1400 + pkt_length_min = 1000 + is_include = true + match_begin = "begin_l5" + match_type = "pcre" + depth = 1000 + offset = 500 + } + + watermark_filters { + tcp_port_list = ["2000-3000", "3500-4000"] + udp_port_list = ["5000-6000"] + offset = 50 + auto_remove = true + open_switch = true + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `drop_options` - (Required, List) Option list of abnormal check of the DDos policy, should set at least one policy. +* `name` - (Required, String) Name of the DDoS policy. Length should between 1 and 32. +* `resource_type` - (Required, String, ForceNew) Type of the resource that the DDoS policy works for. Valid values: `bgpip`, `bgp`, `bgp-multip` and `net`. +* `black_ips` - (Optional, Set: [`String`]) Black IP list. +* `packet_filters` - (Optional, List) Message filter options list. +* `port_filters` - (Optional, List) Port limits of abnormal check of the DDos policy. +* `watermark_filters` - (Optional, List) Watermark policy options, and only support one watermark policy at most. +* `white_ips` - (Optional, Set: [`String`]) White IP list. + +The `drop_options` object supports the following: + +* `bad_conn_threshold` - (Required, Int) The number of new connections based on destination IP that trigger suppression of connections. Valid value ranges: (0~4294967295). +* `check_sync_conn` - (Required, Bool) Indicate whether to check null connection or not. +* `conn_timeout` - (Required, Int) Connection timeout of abnormal connection check. Valid value ranges: (0~65535). +* `d_conn_limit` - (Required, Int) The limit of concurrent connections based on destination IP. Valid value ranges: (0~4294967295). +* `d_new_limit` - (Required, Int) The limit of new connections based on destination IP. Valid value ranges: (0~4294967295). +* `drop_abroad` - (Required, Bool) Indicate whether to drop abroad traffic or not. +* `drop_icmp` - (Required, Bool) Indicate whether to drop ICMP protocol or not. +* `drop_other` - (Required, Bool) Indicate whether to drop other protocols(exclude TCP/UDP/ICMP) or not. +* `drop_tcp` - (Required, Bool) Indicate whether to drop TCP protocol or not. +* `drop_udp` - (Required, Bool) Indicate to drop UDP protocol or not. +* `icmp_mbps_limit` - (Required, Int) The limit of ICMP traffic rate. Valid value ranges: (0~4294967295)(Mbps). +* `null_conn_enable` - (Required, Bool) Indicate to enable null connection or not. +* `other_mbps_limit` - (Required, Int) The limit of other protocols(exclude TCP/UDP/ICMP) traffic rate. Valid value ranges: (0~4294967295)(Mbps). +* `s_conn_limit` - (Required, Int) The limit of concurrent connections based on source IP. Valid value ranges: (0~4294967295). +* `s_new_limit` - (Required, Int) The limit of new connections based on source IP. Valid value ranges: (0~4294967295). +* `syn_limit` - (Required, Int) The limit of syn of abnormal connection check. Valid value ranges: (0~100). +* `tcp_mbps_limit` - (Required, Int) The limit of TCP traffic. Valid value ranges: (0~4294967295)(Mbps). +* `udp_mbps_limit` - (Required, Int) The limit of UDP traffic rate. Valid value ranges: (0~4294967295)(Mbps). +* `syn_rate` - (Optional, Int) The percentage of syn in ack of abnormal connection check. Valid value ranges: (0~100). + +The `packet_filters` object supports the following: + +* `action` - (Optional, String) Action of port to take. Valid values: `drop`, `drop_black`,`drop_rst`,`drop_black_rst`,`transmit`.`drop`(drop the packet), `drop_black`(drop the packet and black the ip),`drop_rst`(drop the packet and disconnect),`drop_black_rst`(drop the packet, black the ip and disconnect),`transmit`(transmit the packet). +* `d_end_port` - (Optional, Int) End port of the destination. Valid value ranges: (0~65535). It must be greater than `d_start_port`. +* `d_start_port` - (Optional, Int) Start port of the destination. Valid value ranges: (0~65535). +* `depth` - (Optional, Int) The depth of match. Valid value ranges: (0~1500). +* `is_include` - (Optional, Bool) Indicate whether to include the key word/regular expression or not. +* `match_begin` - (Optional, String) Indicate whether to check load or not, `begin_l5` means to match and `no_match` means not. +* `match_str` - (Optional, String) The key word or regular expression. +* `match_type` - (Optional, String) Match type. Valid values: `sunday` and `pcre`. `sunday` means key word match while `pcre` means regular match. +* `offset` - (Optional, Int) The offset of match. Valid value ranges: (0~1500). +* `pkt_length_max` - (Optional, Int) The max length of the packet. Valid value ranges: (0~1500)(Mbps). It must be greater than `pkt_length_min`. +* `pkt_length_min` - (Optional, Int) The minimum length of the packet. Valid value ranges: (0~1500)(Mbps). +* `protocol` - (Optional, String) Protocol. Valid values: `tcp`, `udp`, `icmp`, `all`. +* `s_end_port` - (Optional, Int) End port of the source. Valid value ranges: (0~65535). It must be greater than `s_start_port`. +* `s_start_port` - (Optional, Int) Start port of the source. Valid value ranges: (0~65535). + +The `port_filters` object supports the following: + +* `action` - (Optional, String) Action of port to take. Valid values: `drop`, `transmit`. +* `end_port` - (Optional, Int) End port. Valid value ranges: (0~65535). It must be greater than `start_port`. +* `kind` - (Optional, Int) The type of forbidden port. Valid values: `0`, `1`, `2`. `0` for destination ports make effect, `1` for source ports make effect. `2` for both destination and source ports. +* `protocol` - (Optional, String) Protocol. Valid values are `tcp`, `udp`, `icmp`, `all`. +* `start_port` - (Optional, Int) Start port. Valid value ranges: (0~65535). + +The `watermark_filters` object supports the following: + +* `auto_remove` - (Optional, Bool) Indicate whether to auto-remove the watermark or not. +* `offset` - (Optional, Int) The offset of watermark. Valid value ranges: (0~1500). +* `open_switch` - (Optional, Bool) Indicate whether to open watermark or not. It muse be set `true` when any field of watermark was set. +* `tcp_port_list` - (Optional, List) Port range of TCP, the format is like `2000-3000`. +* `udp_port_list` - (Optional, List) Port range of TCP, the format is like `2000-3000`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the DDoS policy. +* `policy_id` - Id of policy. +* `scene_id` - Id of policy case that the DDoS policy works for. +* `watermark_key` - Watermark content. + * `content` - Content of the watermark. + * `id` - Id of the watermark. + * `open_switch` - Indicate whether to auto-remove the watermark or not. + + diff --git a/config/docs/r/dayu_ddos_policy_attachment.html.markdown b/config/docs/r/dayu_ddos_policy_attachment.html.markdown new file mode 100644 index 0000000..fff2a94 --- /dev/null +++ b/config/docs/r/dayu_ddos_policy_attachment.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_ddos_policy_attachment" +sidebar_current: "docs-tencentcloud-resource-dayu_ddos_policy_attachment" +description: |- + Provides a resource to create a dayu DDoS policy attachment. +--- + +# tencentcloud_dayu_ddos_policy_attachment + +Provides a resource to create a dayu DDoS policy attachment. + +## Example Usage + +```hcl +resource "tencentcloud_dayu_ddos_policy_attachment" "dayu_ddos_policy_attachment_basic" { + resource_type = tencentcloud_dayu_ddos_policy.test_policy.resource_type + resource_id = "bgpip-00000294" + policy_id = tencentcloud_dayu_ddos_policy.test_policy.policy_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy_id` - (Required, String, ForceNew) ID of the policy. +* `resource_id` - (Required, String, ForceNew) ID of the attached resource. +* `resource_type` - (Required, String, ForceNew) Type of the resource that the DDoS policy works for. Valid values are `bgpip`, `bgp`, `bgp-multip`, `net`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dayu_ddos_policy_case.html.markdown b/config/docs/r/dayu_ddos_policy_case.html.markdown new file mode 100644 index 0000000..74b164a --- /dev/null +++ b/config/docs/r/dayu_ddos_policy_case.html.markdown @@ -0,0 +1,80 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_ddos_policy_case" +sidebar_current: "docs-tencentcloud-resource-dayu_ddos_policy_case" +description: |- + Use this resource to create dayu DDoS policy case +--- + +# tencentcloud_dayu_ddos_policy_case + +Use this resource to create dayu DDoS policy case + +~> **NOTE:** when a dayu DDoS policy case is created, there will be a dayu DDoS policy created with the same prefix name in the same time. This resource only supports Anti-DDoS of type `bgp`, `bgp-multip` and `bgpip`. One Anti-DDoS resource can only has one DDoS policy case resource. When there is only one Anti-DDoS resource and one policy case, those two resource will be bind automatically. + +## Example Usage + +```hcl +resource "tencentcloud_dayu_ddos_policy_case" "foo" { + resource_type = "bgpip" + name = "tf_test_policy_case" + platform_types = ["PC", "MOBILE"] + app_type = "WEB" + app_protocols = ["tcp", "udp"] + tcp_start_port = "1000" + tcp_end_port = "2000" + udp_start_port = "3000" + udp_end_port = "4000" + has_abroad = "yes" + has_initiate_tcp = "yes" + has_initiate_udp = "yes" + peer_tcp_port = "1111" + peer_udp_port = "3333" + tcp_footprint = "511" + udp_footprint = "500" + web_api_urls = ["abc.com", "test.cn/aaa.png"] + min_tcp_package_len = "1000" + max_tcp_package_len = "1200" + min_udp_package_len = "1000" + max_udp_package_len = "1200" + has_vpn = "yes" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `app_protocols` - (Required, Set: [`String`]) App protocol set of the DDoS policy case. +* `app_type` - (Required, String) App type of the DDoS policy case. Valid values: `WEB`, `GAME`, `APP` and `OTHER`. +* `has_abroad` - (Required, String) Indicate whether the service involves overseas or not. Valid values: `no` and `yes`. +* `has_initiate_tcp` - (Required, String) Indicate whether the service actively initiates TCP requests or not. Valid values: `no` and `yes`. +* `name` - (Required, String, ForceNew) Name of the DDoS policy case. Length should between 1 and 64. +* `platform_types` - (Required, Set: [`String`]) Platform set of the DDoS policy case. +* `resource_type` - (Required, String, ForceNew) Type of the resource that the DDoS policy case works for. Valid values: `bgpip`, `bgp` and `bgp-multip`. +* `tcp_end_port` - (Required, String) End port of the TCP service. Valid value ranges: (0~65535). It must be greater than `tcp_start_port`. +* `tcp_start_port` - (Required, String) Start port of the TCP service. Valid value ranges: (0~65535). +* `udp_end_port` - (Required, String) End port of the UDP service. Valid value ranges: (0~65535). It must be greater than `udp_start_port`. +* `udp_start_port` - (Required, String) Start port of the UDP service. Valid value ranges: (0~65535). +* `web_api_urls` - (Required, Set: [`String`]) Web API url set. +* `has_initiate_udp` - (Optional, String) Indicate whether the actively initiate UDP requests or not. Valid values: `no` and `yes`. +* `has_vpn` - (Optional, String) Indicate whether the service involves VPN service or not. Valid values: `no` and `yes`. +* `max_tcp_package_len` - (Optional, String) The max length of TCP message package, valid value length should be greater than 0 and less than 1500. It should be greater than `min_tcp_package_len`. +* `max_udp_package_len` - (Optional, String) The max length of UDP message package, valid value length should be greater than 0 and less than 1500. It should be greater than `min_udp_package_len`. +* `min_tcp_package_len` - (Optional, String) The minimum length of TCP message package, valid value length should be greater than 0 and less than 1500. +* `min_udp_package_len` - (Optional, String) The minimum length of UDP message package, valid value length should be greater than 0 and less than 1500. +* `peer_tcp_port` - (Optional, String) The port that actively initiates TCP requests. Valid value ranges: (1~65535). +* `peer_udp_port` - (Optional, String) The port that actively initiates UDP requests. Valid value ranges: (1~65535). +* `tcp_footprint` - (Optional, String) The fixed signature of TCP protocol load, valid value length is range from 1 to 512. +* `udp_footprint` - (Optional, String) The fixed signature of TCP protocol load, valid value length is range from 1 to 512. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the DDoS policy case. +* `scene_id` - ID of the DDoS policy case. + + diff --git a/config/docs/r/dayu_ddos_policy_v2.html.markdown b/config/docs/r/dayu_ddos_policy_v2.html.markdown new file mode 100644 index 0000000..0f0b0d8 --- /dev/null +++ b/config/docs/r/dayu_ddos_policy_v2.html.markdown @@ -0,0 +1,211 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_ddos_policy_v2" +sidebar_current: "docs-tencentcloud-resource-dayu_ddos_policy_v2" +description: |- + Use this resource to create dayu DDoS policy v2 +--- + +# tencentcloud_dayu_ddos_policy_v2 + +Use this resource to create dayu DDoS policy v2 + +## Example Usage + +```hcl +resource "tencentcloud_dayu_ddos_policy_v2" "ddos_v2" { + resource_id = "bgpip-000004xf" + business = "bgpip" + ddos_threshold = "100" + ddos_level = "low" + black_white_ips { + ip = "1.2.3.4" + ip_type = "black" + } + acls { + action = "transmit" + d_port_start = 1 + d_port_end = 10 + s_port_start = 10 + s_port_end = 20 + priority = 9 + forward_protocol = "all" + } + protocol_block_config { + drop_icmp = 1 + drop_tcp = 0 + drop_udp = 0 + drop_other = 0 + } + ddos_connect_limit { + sd_new_limit = 10 + sd_conn_limit = 11 + dst_new_limit = 20 + dst_conn_limit = 21 + bad_conn_threshold = 30 + syn_rate = 10 + syn_limit = 20 + conn_timeout = 30 + null_conn_enable = 1 + } + ddos_ai = "on" + ddos_geo_ip_block_config { + action = "drop" + area_list = ["100001"] + region_type = "customized" + } + ddos_speed_limit_config { + protocol_list = "TCP" + dst_port_list = "10" + mode = 1 + packet_rate = 10 + bandwidth = 20 + } + packet_filters { + action = "drop" + protocol = "all" + s_port_start = 10 + s_port_end = 10 + d_port_start = 20 + d_port_end = 20 + pktlen_min = 30 + pktlen_max = 30 + str = "12" + str2 = "30" + match_logic = "and" + match_type = "pcre" + match_type2 = "pcre" + match_begin = "begin_l3" + match_begin2 = "begin_l3" + depth = 2 + depth2 = 3 + offset = 1 + offset2 = 2 + is_not = 0 + is_not2 = 0 + } + water_print_config { + offset = 1 + open_status = 1 + listeners { + frontend_port = 90 + forward_protocol = "TCP" + frontend_port_end = 90 + } + verify = "checkall" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_id` - (Required, String, ForceNew) The ID of the resource instance. +* `acls` - (Optional, List) Port ACL policy for DDoS protection. +* `black_white_ips` - (Optional, List) DDoS-protected IP blacklist and whitelist. +* `business` - (Optional, String) Business of resource instance. bgpip indicates anti-anti-ip ip; bgp means exclusive package; bgp-multip means shared packet; net indicates anti-anti-ip pro version. +* `ddos_ai` - (Optional, String) AI protection switch, take the value [`on`, `off`]. +* `ddos_connect_limit` - (Optional, List) DDoS connection suppression options. +* `ddos_geo_ip_block_config` - (Optional, List) DDoS-protected area block configuration. +* `ddos_level` - (Optional, String) Protection class, value [`low`, `middle`, `high`]. +* `ddos_speed_limit_config` - (Optional, List) Access speed limit configuration for DDoS protection. +* `ddos_threshold` - (Optional, Int) DDoS cleaning threshold, value[0, 60, 80, 100, 150, 200, 250, 300, 400, 500, 700, 1000]; When the value is set to 0, it means that the default value is adopted. +* `packet_filters` - (Optional, List) Feature filtering rules for DDoS protection. +* `protocol_block_config` - (Optional, List) Protocol block configuration for DDoS protection. +* `water_print_config` - (Optional, List) Water print config. + +The `acls` object supports the following: + +* `action` - (Required, String) Action, optional values: drop, transmit, forward. +* `d_port_end` - (Required, Int) The destination port ends, and the value range is 0~65535. +* `d_port_start` - (Required, Int) The destination port starts, and the value range is 0~65535. +* `forward_protocol` - (Required, String) Protocol type, desirable values tcp, udp, all. +* `priority` - (Required, Int) Policy priority, the lower the number, the higher the level, the higher the rule matches, taking a value of 1-1000.Note: This field may return null, indicating that a valid value could not be retrieved. +* `s_port_end` - (Required, Int) The source port ends, and the acceptable value ranges from 0 to 65535. +* `s_port_start` - (Required, Int) The source port starts, and the value range is 0~65535. + +The `black_white_ips` object supports the following: + +* `ip_type` - (Required, String) IP type, value [`black`(blacklist IP), `white` (whitelist IP)]. +* `ip` - (Required, String) Ip of resource instance. + +The `ddos_connect_limit` object supports the following: + +* `bad_conn_threshold` - (Required, Int) Based on connection suppression trigger threshold, value range [0,4294967295]. +* `conn_timeout` - (Required, Int) Abnormal connection detection condition, connection timeout, value range [0,65535]. +* `dst_conn_limit` - (Required, Int) Concurrent connection control based on destination IP+ destination port. +* `dst_new_limit` - (Required, Int) Limit on the number of news per second based on the destination IP. +* `null_conn_enable` - (Required, Int) Abnormal connection detection conditions, empty connection guard switch, value range[0,1]. +* `sd_conn_limit` - (Required, Int) Concurrent connection control based on source IP + destination IP. +* `sd_new_limit` - (Required, Int) The limit on the number of news per second based on source IP + destination IP. +* `syn_limit` - (Required, Int) Anomaly connection detection condition, syn threshold, value range [0,100]. +* `syn_rate` - (Required, Int) Anomalous connection detection condition, percentage of syn ack, value range [0,100]. + +The `ddos_geo_ip_block_config` object supports the following: + +* `action` - (Required, String) Block action, take the value [`drop`, `trans`]. +* `area_list` - (Required, List) When the RegionType is customized, the AreaList must be filled in, and a maximum of 128 must be filled in. +* `region_type` - (Required, String) Zone type, value [oversea (overseas),china (domestic),customized (custom region)]. + +The `ddos_speed_limit_config` object supports the following: + +* `bandwidth` - (Required, Int) Bandwidth bps. +* `dst_port_list` - (Required, String) List of port ranges, up to 8, multiple; Separated, the range is represented with -; this port range must be filled in; fill in the style 1:0-65535, style 2:80; 443; 1000-2000. +* `mode` - (Required, Int) Speed limit mode, take the value [1 (speed limit based on source IP),2 (speed limit based on destination port)]. +* `packet_rate` - (Required, Int) Packet rate pps. +* `protocol_list` - (Required, String) IP protocol numbers, take the value[ ALL (all protocols),TCP (tcp protocol),UDP (udp protocol),SMP (smp protocol),1; 2-100 (custom protocol number range, up to 8)]. + +The `listeners` object supports the following: + +* `forward_protocol` - (Required, String) Forwarding protocol, value [TCP, UDP]. +* `frontend_port_end` - (Required, Int) Upper limit of forwarding listening port. Values: [1-65535]. +* `frontend_port` - (Required, Int) Lower limit of forwarding listening port. Values: [1-65535]. + +The `packet_filters` object supports the following: + +* `action` - (Required, String) Action, take the value [drop,transmit,drop_black (discard and black out),drop_rst (Interception),drop_black_rst (intercept and block),forward]. +* `d_port_end` - (Required, Int) The end destination port, take the value 1~65535, which must be greater than or equal to the starting destination port. +* `d_port_start` - (Required, Int) From the destination port, take the value 0~65535. +* `depth2` - (Required, Int) Second detection depth starting from the second detection position, value [0,1500]. +* `depth` - (Required, Int) Detection depth from the detection position, value [0,1500]. +* `is_not2` - (Required, Int) Whether the second detection contains the detected value, the value [0 (included),1 (not included)]. +* `is_not` - (Required, Int) Whether to include the detected value, take the value [0 (included),1 (not included)]. +* `match_begin2` - (Required, String) The second detection position. take the value [begin_l3 (IP header),begin_l4 (TCP/UDP header),begin_l5 (T load), no_match (mismatch)]. +* `match_begin` - (Required, String) Detect position, take the value [begin_l3 (IP header),begin_l4 (TCP/UDP header),begin_l5 (T load), no_match (mismatch)]. +* `match_logic` - (Required, String) When there is a second detection condition, the and/or relationship with the first detection condition, takes the value [And (and relationship),none (fill in this value when there is no second detection condition)]. +* `match_type2` - (Required, String) The second type of detection, takes the value [sunday (keyword),pcre (regular expression)]. +* `match_type` - (Required, String) Detection type, value [sunday (keyword),pcre (regular expression)]. +* `offset2` - (Required, Int) Offset from the second detection position, value range [0,Depth2]. +* `offset` - (Required, Int) Offset from detection position, value range [0, Depth]. +* `pktlen_max` - (Required, Int) The maximum message length, taken from 1 to 1500, must be greater than or equal to the minimum message length. +* `pktlen_min` - (Required, Int) Minimum message length, 1-1500. +* `protocol` - (Required, String) Protocol, value [tcp udp icmp all]. +* `s_port_end` - (Required, Int) End source port, take the value 1~65535, must be greater than or equal to the starting source port. +* `s_port_start` - (Required, Int) Start the source port, take the value 0~65535. +* `str2` - (Required, String) The second detection value, the key string or regular expression, takes the value [When the detection type is sunday, please fill in the string or hexadecimal bytecode, for example 13233 corresponds to the hexadecimal bytecode of the string `123`;When the detection type is pcre, please fill in the regular expression string;]. +* `str` - (Required, String) Detect values, key strings or regular expressions, take the value [When the detection type is sunday, please fill in the string or hexadecimal bytecode, for example 13233 corresponds to the hexadecimal bytecode of the string `123`;When the detection type is pcre, please fill in the regular expression string;]. + +The `protocol_block_config` object supports the following: + +* `drop_icmp` - (Required, Int) ICMP block, value [0 (block off), 1 (block on)]. +* `drop_other` - (Required, Int) Other block, value [0 (block off), 1 (block on)]. +* `drop_tcp` - (Required, Int) TCP block, value [0 (block off), 1 (block on)]. +* `drop_udp` - (Required, Int) UDP block, value [0 (block off), 1 (block on)]. + +The `water_print_config` object supports the following: + +* `listeners` - (Required, List) List of forwarding listeners to which the watermark belongs. +* `offset` - (Required, Int) Watermark offset, value range: [0-100]. +* `open_status` - (Required, Int) Whether it is enabled, value [0 (manual open), 1 (immediate operation)]. +* `verify` - (Required, String) Watermark check mode, value [`checkall`(normal mode), `shortfpcheckall`(simplified mode)]. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dayu_eip.html.markdown b/config/docs/r/dayu_eip.html.markdown new file mode 100644 index 0000000..1e7c6f5 --- /dev/null +++ b/config/docs/r/dayu_eip.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_eip" +sidebar_current: "docs-tencentcloud-resource-dayu_eip" +description: |- + Use this resource to create dayu eip rule +--- + +# tencentcloud_dayu_eip + +Use this resource to create dayu eip rule + +## Example Usage + +```hcl +resource "tencentcloud_dayu_eip" "test" { + resource_id = "bgpip-000004xg" + eip = "162.62.163.50" + bind_resource_id = "ins-4m0jvxic" + bind_resource_region = "hk" + bind_resource_type = "cvm" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bind_resource_id` - (Required, String, ForceNew) Resource id to bind. +* `bind_resource_region` - (Required, String, ForceNew) Resource region to bind. +* `bind_resource_type` - (Required, String, ForceNew) Resource type to bind, value range [`clb`, `cvm`]. +* `eip` - (Required, String, ForceNew) Eip of the resource. +* `resource_id` - (Required, String, ForceNew) ID of the resource. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `created_time` - Created time of the resource instance. +* `eip_address_status` - Eip address status of the resource instance. +* `eip_bound_rsc_eni` - Eip bound rsc eni of the resource instance. +* `eip_bound_rsc_ins` - Eip bound rsc ins of the resource instance. +* `eip_bound_rsc_vip` - Eip bound rsc vip of the resource instance. +* `expired_time` - Expired time of the resource instance. +* `modify_time` - Modify time of the resource instance. +* `protection_status` - Protection status of the resource instance. +* `resource_region` - Region of the resource instance. + + diff --git a/config/docs/r/dayu_l4_rule.html.markdown b/config/docs/r/dayu_l4_rule.html.markdown new file mode 100644 index 0000000..78b0477 --- /dev/null +++ b/config/docs/r/dayu_l4_rule.html.markdown @@ -0,0 +1,79 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_l4_rule" +sidebar_current: "docs-tencentcloud-resource-dayu_l4_rule" +description: |- + Use this resource to create dayu layer 4 rule +--- + +# tencentcloud_dayu_l4_rule + +Use this resource to create dayu layer 4 rule + +~> **NOTE:** This resource only support resource Anti-DDoS of type `bgpip` and `net` + +## Example Usage + +```hcl +resource "tencentcloud_dayu_l4_rule" "test_rule" { + resource_type = "bgpip" + resource_id = "bgpip-00000294" + name = "rule_test" + protocol = "TCP" + s_port = 80 + d_port = 60 + source_type = 2 + health_check_switch = true + health_check_timeout = 30 + health_check_interval = 35 + health_check_health_num = 5 + health_check_unhealth_num = 10 + session_switch = false + session_time = 300 + + source_list { + source = "1.1.1.1" + weight = 100 + } + source_list { + source = "2.2.2.2" + weight = 50 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `d_port` - (Required, Int) The destination port of the L4 rule. +* `name` - (Required, String, ForceNew) Name of the rule. When the `resource_type` is `net`, this field should be set with valid domain. +* `protocol` - (Required, String) Protocol of the rule. Valid values: `http`, `https`. When `source_type` is 1(host source), the value of this field can only set with `tcp`. +* `resource_id` - (Required, String, ForceNew) ID of the resource that the layer 4 rule works for. +* `resource_type` - (Required, String, ForceNew) Type of the resource that the layer 4 rule works for. Valid values: `bgpip` and `net`. +* `s_port` - (Required, Int) The source port of the L4 rule. +* `source_list` - (Required, Set) Source list of the rule, it can be a set of ip sources or a set of domain sources. The number of items ranges from 1 to 20. +* `source_type` - (Required, Int, ForceNew) Source type, `1` for source of host, `2` for source of IP. +* `health_check_health_num` - (Optional, Int) Health threshold of health check, and the default is 3. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is 2-10. +* `health_check_interval` - (Optional, Int) Interval time of health check. The value range is 10-60 sec, and the default is 15 sec. +* `health_check_switch` - (Optional, Bool) Indicates whether health check is enabled. The default is `false`. Only valid when source list has more than one source item. +* `health_check_timeout` - (Optional, Int) HTTP Status Code. The default is 26 and value range is 2-60. +* `health_check_unhealth_num` - (Optional, Int) Unhealthy threshold of health check, and the default is 3. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is 2-10. +* `session_switch` - (Optional, Bool) Indicate that the session will keep or not, and default value is `false`. +* `session_time` - (Optional, Int) Session keep time, only valid when `session_switch` is true, the available value ranges from 1 to 300 and unit is second. + +The `source_list` object supports the following: + +* `source` - (Required, String) Source IP or domain, valid format of ip is like `1.1.1.1` and valid format of host source is like `abc.com`. +* `weight` - (Required, Int) Weight of the source, the valid value ranges from 0 to 100. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `lb_type` - LB type of the rule. Valid values: `1`, `2`. `1` for weight cycling and `2` for IP hash. +* `rule_id` - ID of the layer 4 rule. + + diff --git a/config/docs/r/dayu_l7_rule.html.markdown b/config/docs/r/dayu_l7_rule.html.markdown new file mode 100644 index 0000000..755cf64 --- /dev/null +++ b/config/docs/r/dayu_l7_rule.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "Anti-DDoS(Dayu)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_l7_rule" +sidebar_current: "docs-tencentcloud-resource-dayu_l7_rule" +description: |- + Use this resource to create dayu layer 7 rule +--- + +# tencentcloud_dayu_l7_rule + +Use this resource to create dayu layer 7 rule + +~> **NOTE:** This resource only support resource Anti-DDoS of type `bgpip` + +## Example Usage + +```hcl +resource "tencentcloud_dayu_l7_rule" "test_rule" { + resource_type = "bgpip" + resource_id = "bgpip-00000294" + name = "rule_test" + domain = "zhaoshaona.com" + protocol = "https" + switch = true + source_type = 2 + source_list = ["1.1.1.1:80", "2.2.2.2"] + ssl_id = "%s" + health_check_switch = true + health_check_code = 31 + health_check_interval = 30 + health_check_method = "GET" + health_check_path = "/" + health_check_health_num = 5 + health_check_unhealth_num = 10 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Domain that the layer 7 rule works for. Valid string length ranges from 0 to 80. +* `name` - (Required, String, ForceNew) Name of the rule. +* `protocol` - (Required, String) Protocol of the rule. Valid values: `http`, `https`. +* `resource_id` - (Required, String, ForceNew) ID of the resource that the layer 7 rule works for. +* `resource_type` - (Required, String, ForceNew) Type of the resource that the layer 7 rule works for, valid value is `bgpip`. +* `source_list` - (Required, Set: [`String`]) Source list of the rule, it can be a set of ip sources or a set of domain sources. The number of items ranges from 1 to 16. +* `source_type` - (Required, Int) Source type, `1` for source of host, `2` for source of IP. +* `switch` - (Required, Bool) Indicate the rule will take effect or not. +* `health_check_code` - (Optional, Int) HTTP Status Code. The default is `26`. Valid value ranges: [1~31]. `1` means the return value '1xx' is health. `2` means the return value '2xx' is health. `4` means the return value '3xx' is health. `8` means the return value '4xx' is health. `16` means the return value '5xx' is health. If you want multiple return codes to indicate health, need to add the corresponding values. +* `health_check_health_num` - (Optional, Int) Health threshold of health check, and the default is `3`. If a success result is returned for the health check 3 consecutive times, indicates that the forwarding is normal. The value range is [2-10]. +* `health_check_interval` - (Optional, Int) Interval time of health check. Valid value ranges: [10~60]sec. The default is 15 sec. +* `health_check_method` - (Optional, String) Methods of health check. The default is 'HEAD', the available value are 'HEAD' and 'GET'. +* `health_check_path` - (Optional, String) Path of health check. The default is `/`. +* `health_check_switch` - (Optional, Bool) Indicates whether health check is enabled. The default is `false`. +* `health_check_unhealth_num` - (Optional, Int) Unhealthy threshold of health check, and the default is `3`. If the unhealthy result is returned 3 consecutive times, indicates that the forwarding is abnormal. The value range is [2-10]. +* `ssl_id` - (Optional, String) SSL ID, when the `protocol` is `https`, the field should be set with valid SSL id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `rule_id` - ID of the layer 7 rule. +* `status` - Status of the rule. `0` for create/modify success, `2` for create/modify fail, `3` for delete success, `5` for delete failed, `6` for waiting to be created/modified, `7` for waiting to be deleted and 8 for waiting to get SSL ID. + + diff --git a/config/docs/r/dayu_l7_rule_v2.html.markdown b/config/docs/r/dayu_l7_rule_v2.html.markdown new file mode 100644 index 0000000..dea91fe --- /dev/null +++ b/config/docs/r/dayu_l7_rule_v2.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Anti-DDoS(DayuV2)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dayu_l7_rule_v2" +sidebar_current: "docs-tencentcloud-resource-dayu_l7_rule_v2" +description: |- + Use this resource to create dayu new layer 7 rule +--- + +# tencentcloud_dayu_l7_rule_v2 + +Use this resource to create dayu new layer 7 rule + +~> **NOTE:** This resource only support resource Anti-DDoS of type `bgpip` + +## Example Usage + +```hcl +resource "tencentcloud_dayu_l7_rule_v2" "tencentcloud_dayu_l7_rule_v2" { + resource_type = "bgpip" + resource_id = "bgpip-000004xe" + resource_ip = "119.28.217.162" + rule { + keep_enable = false + keeptime = 0 + source_list { + source = "1.2.3.5" + weight = 100 + } + source_list { + source = "1.2.3.6" + weight = 100 + } + lb_type = 1 + protocol = "http" + source_type = 2 + domain = "github.com" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_id` - (Required, String, ForceNew) ID of the resource that the layer 7 rule works for. +* `resource_ip` - (Required, String, ForceNew) Ip of the resource that the layer 7 rule works for. +* `resource_type` - (Required, String, ForceNew) Type of the resource that the layer 7 rule works for, valid value is `bgpip`. +* `rule` - (Required, List) A list of layer 7 rules. Each element contains the following attributes: + +The `rule` object supports the following: + +* `domain` - (Required, String) Domain of the rule. +* `keep_enable` - (Required, Int) session hold switch. +* `keeptime` - (Required, Int) The keeptime of the layer 4 rule. +* `lb_type` - (Required, Int) LB type of the rule, `1` for weight cycling and `2` for IP hash. +* `protocol` - (Required, String) Protocol of the rule. +* `source_list` - (Required, List) +* `source_type` - (Required, Int) Source type, `1` for source of host, `2` for source of IP. +* `cc_enable` - (Optional, Int) HTTPS protocol CC protection status, value [0 (off), 1 (on)], defaule is 0. +* `cert_type` - (Optional, Int) The source of the certificate must be filled in when the forwarding protocol is https, the value [2 (Tencent Cloud Hosting Certificate)], and 0 when the forwarding protocol is http. +* `https_to_http_enable` - (Optional, Int) Whether to enable the Https protocol to use Http back-to-source, take the value [0 (off), 1 (on)], do not fill in the default is off, defaule is 0. +* `ssl_id` - (Optional, String) When the certificate source is a Tencent Cloud managed certificate, this field must be filled in with the managed certificate ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dbbrain_db_diag_report_task.html.markdown b/config/docs/r/dbbrain_db_diag_report_task.html.markdown new file mode 100644 index 0000000..bc9c35a --- /dev/null +++ b/config/docs/r/dbbrain_db_diag_report_task.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_db_diag_report_task" +sidebar_current: "docs-tencentcloud-resource-dbbrain_db_diag_report_task" +description: |- + Provides a resource to create a dbbrain db_diag_report_task +--- + +# tencentcloud_dbbrain_db_diag_report_task + +Provides a resource to create a dbbrain db_diag_report_task + +## Example Usage + +```hcl +resource "tencentcloud_dbbrain_db_diag_report_task" "db_diag_report_task" { + instance_id = "%s" + start_time = "%s" + end_time = "%s" + send_mail_flag = 0 + product = "mysql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String, ForceNew) End time, such as 2020-11-09T14:00:00+08:00. +* `instance_id` - (Required, String, ForceNew) instance id. +* `product` - (Required, String, ForceNew) Service product type, supported values include: mysql - cloud database MySQL, cynosdb - cloud database CynosDB for MySQL. +* `send_mail_flag` - (Required, Int, ForceNew) Whether to send mail: 0 - no, 1 - yes. +* `start_time` - (Required, String, ForceNew) Start time, such as 2020-11-08T14:00:00+08:00. +* `contact_group` - (Optional, Set: [`Int`], ForceNew) An array of contact group IDs to receive mail from. +* `contact_person` - (Optional, Set: [`Int`], ForceNew) An array of contact IDs to receive emails from. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dbbrain_modify_diag_db_instance_operation.html.markdown b/config/docs/r/dbbrain_modify_diag_db_instance_operation.html.markdown new file mode 100644 index 0000000..ece04f8 --- /dev/null +++ b/config/docs/r/dbbrain_modify_diag_db_instance_operation.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_modify_diag_db_instance_operation" +sidebar_current: "docs-tencentcloud-resource-dbbrain_modify_diag_db_instance_operation" +description: |- + Provides a resource to create a dbbrain modify_diag_db_instance_conf +--- + +# tencentcloud_dbbrain_modify_diag_db_instance_operation + +Provides a resource to create a dbbrain modify_diag_db_instance_conf + +## Example Usage + +```hcl +resource "tencentcloud_dbbrain_modify_diag_db_instance_operation" "on" { + instance_confs { + daily_inspection = "Yes" + overview_display = "Yes" + } + product = "mysql" + instance_ids = ["%s"] +} +``` + + + +```hcl +resource "tencentcloud_dbbrain_modify_diag_db_instance_operation" "off" { + instance_confs { + daily_inspection = "No" + overview_display = "No" + } + product = "mysql" + instance_ids = ["%s"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_confs` - (Required, List, ForceNew) Instance configuration, including inspection, overview switch, etc. +* `product` - (Required, String, ForceNew) Service product type, supported values include: mysql - cloud database MySQL, cynosdb - cloud database CynosDB for MySQL. +* `instance_ids` - (Optional, Set: [`String`], ForceNew) Specifies the ID of the instance whose inspection status is changed. +* `regions` - (Optional, String, ForceNew) Effective instance region, the value is All, which means all regions. + +The `instance_confs` object supports the following: + +* `daily_inspection` - (Optional, String) Database inspection switch, Yes/No. +* `overview_display` - (Optional, String) Instance overview switch, Yes/No. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dbbrain_security_audit_log_export_task.html.markdown b/config/docs/r/dbbrain_security_audit_log_export_task.html.markdown new file mode 100644 index 0000000..d7459e7 --- /dev/null +++ b/config/docs/r/dbbrain_security_audit_log_export_task.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_security_audit_log_export_task" +sidebar_current: "docs-tencentcloud-resource-dbbrain_security_audit_log_export_task" +description: |- + Provides a resource to create a dbbrain security_audit_log_export_task +--- + +# tencentcloud_dbbrain_security_audit_log_export_task + +Provides a resource to create a dbbrain security_audit_log_export_task + +## Example Usage + +```hcl +resource "tencentcloud_dbbrain_security_audit_log_export_task" "task" { + sec_audit_group_id = "sec_audit_group_id" + start_time = "2020-12-28 00:00:00" + end_time = "2020-12-28 01:00:00" + product = "mysql" + danger_levels = [0, 1, 2] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String, ForceNew) end time. +* `product` - (Required, String, ForceNew) product, optional value is mysql. +* `sec_audit_group_id` - (Required, String, ForceNew) security audit group id. +* `start_time` - (Required, String, ForceNew) start time. +* `danger_levels` - (Optional, Set: [`Int`], ForceNew) List of log risk levels, supported values include: 0 no risk; 1 low risk; 2 medium risk; 3 high risk. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `async_request_id` - request of async id. + + diff --git a/config/docs/r/dbbrain_sql_filter.html.markdown b/config/docs/r/dbbrain_sql_filter.html.markdown new file mode 100644 index 0000000..0fe4270 --- /dev/null +++ b/config/docs/r/dbbrain_sql_filter.html.markdown @@ -0,0 +1,70 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_sql_filter" +sidebar_current: "docs-tencentcloud-resource-dbbrain_sql_filter" +description: |- + Provides a resource to create a dbbrain sql_filter. +--- + +# tencentcloud_dbbrain_sql_filter + +Provides a resource to create a dbbrain sql_filter. + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} +variable "region" { + default = "ap-guangzhou" +} + +data "tencentcloud_mysql_instance" "mysql" { + instance_name = "instance_name" +} + +locals { + mysql_id = data.tencentcloud_mysql_instance.mysql.instance_list.0.mysql_id +} + +resource "tencentcloud_dbbrain_sql_filter" "sql_filter" { + instance_id = local.mysql_id + session_token { + user = "test" + password = "===password===" + } + sql_type = "SELECT" + filter_key = "filter_key" + max_concurrency = 10 + duration = 3600 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `duration` - (Required, Int) filter duration. +* `filter_key` - (Required, String) filter key. +* `instance_id` - (Required, String) instance id. +* `max_concurrency` - (Required, Int) maximum concurreny. +* `session_token` - (Required, List) session token. +* `sql_type` - (Required, String) sql type, optional value is SELECT, UPDATE, DELETE, INSERT, REPLACE. +* `product` - (Optional, String) product, optional value is &#39;mysql&#39;, &#39;cynosdb&#39;. +* `status` - (Optional, String) filter status. + +The `session_token` object supports the following: + +* `password` - (Required, String) password. +* `user` - (Required, String) user name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `filter_id` - filter id. + + diff --git a/config/docs/r/dbbrain_tdsql_audit_log.html.markdown b/config/docs/r/dbbrain_tdsql_audit_log.html.markdown new file mode 100644 index 0000000..7529366 --- /dev/null +++ b/config/docs/r/dbbrain_tdsql_audit_log.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "TencentDB for DBbrain(dbbrain)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dbbrain_tdsql_audit_log" +sidebar_current: "docs-tencentcloud-resource-dbbrain_tdsql_audit_log" +description: |- + Provides a resource to create a dbbrain tdsql_audit_log +--- + +# tencentcloud_dbbrain_tdsql_audit_log + +Provides a resource to create a dbbrain tdsql_audit_log + +## Example Usage + +```hcl +resource "tencentcloud_dbbrain_tdsql_audit_log" "my_log" { + product = "dcdb" + node_request_type = "dcdb" + instance_id = "%s" + start_time = "%s" + end_time = "%s" + filter { + host = ["%%", "127.0.0.1"] + user = ["tf_test", "mysql"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String, ForceNew) Deadline time, such as `2019-09-11 10:13:14`. +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `node_request_type` - (Required, String, ForceNew) Consistent with Product. For example: dcdb, mariadb. +* `product` - (Required, String, ForceNew) Service product type, supported values include: dcdb - cloud database Tdsql, mariadb - cloud database MariaDB for MariaDB.. +* `start_time` - (Required, String, ForceNew) Start time, such as `2019-09-10 12:13:14`. +* `filter` - (Optional, List, ForceNew) Filter conditions. Logs can be filtered according to the filter conditions set. + +The `filter` object supports the following: + +* `affect_rows` - (Optional, Int, ForceNew) Number of affected rows. Indicates filtering audit logs whose affected rows are greater than this value. +* `db_name` - (Optional, Set, ForceNew) Database name. +* `exec_time` - (Optional, Int, ForceNew) Execution time. The unit is: us. It means to filter the audit logs whose execution time is greater than this value. +* `host` - (Optional, Set, ForceNew) Client Address. +* `sent_rows` - (Optional, Int, ForceNew) Return the number of rows. It means to filter the audit log with the number of returned rows greater than this value. +* `user` - (Optional, Set, ForceNew) Username. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dc_gateway.html.markdown b/config/docs/r/dc_gateway.html.markdown new file mode 100644 index 0000000..5d80e12 --- /dev/null +++ b/config/docs/r/dc_gateway.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "Direct Connect Gateway(DCG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_gateway" +sidebar_current: "docs-tencentcloud-resource-dc_gateway" +description: |- + Provides a resource to creating direct connect gateway instance. +--- + +# tencentcloud_dc_gateway + +Provides a resource to creating direct connect gateway instance. + +## Example Usage + +```hcl +resource "tencentcloud_vpc" "main" { + name = "ci-vpc-instance-test" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_dc_gateway" "vpc_main" { + name = "ci-cdg-vpc-test" + network_instance_id = tencentcloud_vpc.main.id + network_type = "VPC" + gateway_type = "NAT" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the DCG. +* `network_instance_id` - (Required, String, ForceNew) If the `network_type` value is `VPC`, the available value is VPC ID. But when the `network_type` value is `CCN`, the available value is CCN instance ID. +* `network_type` - (Required, String, ForceNew) Type of associated network. Valid value: `VPC` and `CCN`. +* `gateway_type` - (Optional, String, ForceNew) Type of the gateway. Valid value: `NORMAL` and `NAT`. Default is `NORMAL`. NOTES: CCN only supports `NORMAL` and a VPC can create two DCGs, the one is NAT type and the other is non-NAT type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `cnn_route_type` - Type of CCN route. Valid value: `BGP` and `STATIC`. The property is available when the DCG type is CCN gateway and BGP enabled. +* `create_time` - Creation time of resource. +* `enable_bgp` - Indicates whether the BGP is enabled. + + +## Import + +Direct connect gateway instance can be imported, e.g. + +``` +$ terraform import tencentcloud_dc_gateway.instance dcg-id +``` + diff --git a/config/docs/r/dc_gateway_attachment.html.markdown b/config/docs/r/dc_gateway_attachment.html.markdown new file mode 100644 index 0000000..2f70e37 --- /dev/null +++ b/config/docs/r/dc_gateway_attachment.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Direct Connect Gateway(DCG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_gateway_attachment" +sidebar_current: "docs-tencentcloud-resource-dc_gateway_attachment" +description: |- + Provides a resource to create a dc_gateway_attachment +--- + +# tencentcloud_dc_gateway_attachment + +Provides a resource to create a dc_gateway_attachment + +## Example Usage + +```hcl +resource "tencentcloud_dc_gateway_attachment" "dc_gateway_attachment" { + vpc_id = "vpc-4h9v4mo3" + nat_gateway_id = "nat-7kanjc6y" + direct_connect_gateway_id = "dcg-dmbhf7jf" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `direct_connect_gateway_id` - (Required, String, ForceNew) DirectConnectGatewayId. +* `nat_gateway_id` - (Required, String, ForceNew) NatGatewayId. +* `vpc_id` - (Required, String, ForceNew) vpc id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dc_gateway_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_dc_gateway_attachment.dc_gateway_attachment vpcId#dcgId#ngId +``` + diff --git a/config/docs/r/dc_gateway_ccn_route.html.markdown b/config/docs/r/dc_gateway_ccn_route.html.markdown new file mode 100644 index 0000000..c6763ce --- /dev/null +++ b/config/docs/r/dc_gateway_ccn_route.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Direct Connect Gateway(DCG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_gateway_ccn_route" +sidebar_current: "docs-tencentcloud-resource-dc_gateway_ccn_route" +description: |- + Provides a resource to creating direct connect gateway route entry. +--- + +# tencentcloud_dc_gateway_ccn_route + +Provides a resource to creating direct connect gateway route entry. + +## Example Usage + +```hcl +resource "tencentcloud_ccn" "main" { + name = "ci-temp-test-ccn" + description = "ci-temp-test-ccn-des" + qos = "AG" +} + +resource "tencentcloud_dc_gateway" "ccn_main" { + name = "ci-cdg-ccn-test" + network_instance_id = tencentcloud_ccn.main.id + network_type = "CCN" + gateway_type = "NORMAL" +} + +resource "tencentcloud_dc_gateway_ccn_route" "route1" { + dcg_id = tencentcloud_dc_gateway.ccn_main.id + cidr_block = "10.1.1.0/32" +} + +resource "tencentcloud_dc_gateway_ccn_route" "route2" { + dcg_id = tencentcloud_dc_gateway.ccn_main.id + cidr_block = "192.1.1.0/32" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cidr_block` - (Required, String, ForceNew) A network address segment of IDC. +* `dcg_id` - (Required, String, ForceNew) ID of the DCG. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `as_path` - As path list of the BGP. + + diff --git a/config/docs/r/dc_instance.html.markdown b/config/docs/r/dc_instance.html.markdown new file mode 100644 index 0000000..1313bce --- /dev/null +++ b/config/docs/r/dc_instance.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_instance" +sidebar_current: "docs-tencentcloud-resource-dc_instance" +description: |- + Provides a resource to create a dc instance +--- + +# tencentcloud_dc_instance + +Provides a resource to create a dc instance + +## Example Usage + +```hcl +resource "tencentcloud_dc_instance" "instance" { + access_point_id = "ap-shenzhen-b-ft" + bandwidth = 10 + customer_contact_number = "0" + direct_connect_name = "terraform-for-test" + line_operator = "In-houseWiring" + port_type = "10GBase-LR" + sign_law = true + vlan = -1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_point_id` - (Required, String) Access point of connection.You can call `DescribeAccessPoints` to get the region ID. The selected access point must exist and be available. +* `direct_connect_name` - (Required, String) Connection name. +* `line_operator` - (Required, String) ISP that provides connections. Valid values: ChinaTelecom (China Telecom), ChinaMobile (China Mobile), ChinaUnicom (China Unicom), In-houseWiring (in-house wiring), ChinaOther (other Chinese ISPs), InternationalOperator (international ISPs). +* `port_type` - (Required, String) Port type of connection. Valid values: 100Base-T (100-Megabit electrical Ethernet interface), 1000Base-T (1-Gigabit electrical Ethernet interface), 1000Base-LX (1-Gigabit single-module optical Ethernet interface; 10 KM), 10GBase-T (10-Gigabit electrical Ethernet interface), 10GBase-LR (10-Gigabit single-module optical Ethernet interface; 10 KM). Default value: 1000Base-LX. +* `bandwidth` - (Optional, Int) Connection port bandwidth in Mbps. Value range: [2,10240]. Default value: 1000. +* `circuit_code` - (Optional, String) Circuit code of a connection, which is provided by the ISP or connection provider. +* `customer_address` - (Optional, String) User-side IP address for connection debugging, which is automatically assigned by default. +* `customer_contact_mail` - (Optional, String) Email address of connection applicant, which is obtained from the account system by default. +* `customer_contact_number` - (Optional, String) Contact number of connection applicant, which is obtained from the account system by default. +* `customer_name` - (Optional, String) Name of connection applicant, which is obtained from the account system by default. +* `fault_report_contact_number` - (Optional, String) Fault reporting contact number. +* `fault_report_contact_person` - (Optional, String) Fault reporting contact person. +* `location` - (Optional, String) Local IDC location. +* `redundant_direct_connect_id` - (Optional, String) ID of redundant connection. +* `sign_law` - (Optional, Bool) Whether the connection applicant has signed the service agreement. Default value: true. +* `tencent_address` - (Optional, String) Tencent-side IP address for connection debugging, which is automatically assigned by default. +* `vlan` - (Optional, Int) VLAN for connection debugging, which is enabled and automatically assigned by default. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dc instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_dc_instance.instance dc_id +``` + diff --git a/config/docs/r/dc_internet_address.html.markdown b/config/docs/r/dc_internet_address.html.markdown new file mode 100644 index 0000000..44eb669 --- /dev/null +++ b/config/docs/r/dc_internet_address.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_internet_address" +sidebar_current: "docs-tencentcloud-resource-dc_internet_address" +description: |- + Provides a resource to create a dc internet_address +--- + +# tencentcloud_dc_internet_address + +Provides a resource to create a dc internet_address + +## Example Usage + +```hcl +resource "tencentcloud_dc_internet_address" "internet_address" { + mask_len = 30 + addr_type = 2 + addr_proto = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `addr_proto` - (Required, Int, ForceNew) 0: IPv4, 1: IPv6. +* `addr_type` - (Required, Int, ForceNew) 0: BGP, 1: china telecom, 2: china mobile, 3: china unicom. +* `mask_len` - (Required, Int, ForceNew) CIDR address mask. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dc internet_address can be imported using the id, e.g. + +``` +terraform import tencentcloud_dc_internet_address.internet_address internet_address_id +``` + diff --git a/config/docs/r/dc_internet_address_config.html.markdown b/config/docs/r/dc_internet_address_config.html.markdown new file mode 100644 index 0000000..1ffffff --- /dev/null +++ b/config/docs/r/dc_internet_address_config.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_internet_address_config" +sidebar_current: "docs-tencentcloud-resource-dc_internet_address_config" +description: |- + Provides a resource to create a dc internet_address_config +--- + +# tencentcloud_dc_internet_address_config + +Provides a resource to create a dc internet_address_config + +## Example Usage + +```hcl +resource "tencentcloud_dc_internet_address" "internet_address" { + mask_len = 30 + addr_type = 2 + addr_proto = 0 +} + +resource "tencentcloud_dc_internet_address_config" "internet_address_config" { + instance_id = tencentcloud_dc_internet_address.internet_address.id + enable = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `enable` - (Required, Bool) whether enable internet address. +* `instance_id` - (Required, String) internet public address id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dc internet_address_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_dc_internet_address_config.internet_address_config internet_address_id +``` + diff --git a/config/docs/r/dc_share_dcx_config.html.markdown b/config/docs/r/dc_share_dcx_config.html.markdown new file mode 100644 index 0000000..13f2ce2 --- /dev/null +++ b/config/docs/r/dc_share_dcx_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dc_share_dcx_config" +sidebar_current: "docs-tencentcloud-resource-dc_share_dcx_config" +description: |- + Provides a resource to create a dc share_dcx_config +--- + +# tencentcloud_dc_share_dcx_config + +Provides a resource to create a dc share_dcx_config + +## Example Usage + +```hcl +resource "tencentcloud_dc_share_dcx_config" "share_dcx_config" { + direct_connect_tunnel_id = "dcx-4z49tnws" + enable = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `direct_connect_tunnel_id` - (Required, String) the direct connect owner accept or reject the apply of direct connect tunnel. +* `enable` - (Required, Bool) if accept or reject direct connect tunnel. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dc share_dcx_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_dc_share_dcx_config.share_dcx_config dcx_id +``` + diff --git a/config/docs/r/dcdb_account.html.markdown b/config/docs/r/dcdb_account.html.markdown new file mode 100644 index 0000000..35b2e99 --- /dev/null +++ b/config/docs/r/dcdb_account.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_account" +sidebar_current: "docs-tencentcloud-resource-dcdb_account" +description: |- + Provides a resource to create a dcdb account +--- + +# tencentcloud_dcdb_account + +Provides a resource to create a dcdb account + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_account" "account" { + instance_id = "tdsqlshard-kkpoxvnv" + user_name = "mysql" + host = "127.0.0.1" + password = "===password===" + read_only = 0 + description = "this is a test account" + max_user_connections = 10 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `host` - (Required, String) db host. +* `instance_id` - (Required, String) instance id. +* `password` - (Required, String) password. +* `user_name` - (Required, String) account name. +* `description` - (Optional, String) description for account. +* `max_user_connections` - (Optional, Int) max user connections. +* `read_only` - (Optional, Int) whether the account is readonly. 0 means not a readonly account. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dcdb account can be imported using the id, e.g. +``` +$ terraform import tencentcloud_dcdb_account.account account_id +``` + diff --git a/config/docs/r/dcdb_account_privileges.html.markdown b/config/docs/r/dcdb_account_privileges.html.markdown new file mode 100644 index 0000000..6afa877 --- /dev/null +++ b/config/docs/r/dcdb_account_privileges.html.markdown @@ -0,0 +1,93 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_account_privileges" +sidebar_current: "docs-tencentcloud-resource-dcdb_account_privileges" +description: |- + Provides a resource to create a dcdb account_privileges +--- + +# tencentcloud_dcdb_account_privileges + +Provides a resource to create a dcdb account_privileges + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_account_privileges" "account_privileges" { + instance_id = "%s" + account { + user = "tf_test" + host = "%s" + } + global_privileges = ["SHOW DATABASES", "SHOW VIEW"] + database_privileges { + privileges = ["SELECT", "INSERT", "UPDATE", "DELETE", "CREATE"] + database = "tf_test_db" + } + + table_privileges { + database = "tf_test_db" + table = "tf_test_table" + privileges = ["SELECT", "INSERT", "UPDATE", "DELETE", "CREATE"] + + } +``` + +## Argument Reference + +The following arguments are supported: + +* `account` - (Required, List) The account of the database, including username and host. +* `instance_id` - (Required, String) The ID of instance. +* `column_privileges` - (Optional, List) Permissions for columns in database tables. Optional values for the Privileges permission are: SELECT, INSERT, UPDATE, REFERENCES. Note that if this parameter is not passed, the existing privileges are reserved. If you need to clear them, please pass an empty array in the complex type Privileges field. +* `database_privileges` - (Optional, List) Database permissions. Optional values for the Privileges permission are: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER. Note that if this parameter is not passed, the existing privileges are reserved. If you need to clear them, please pass an empty array in the complex type Privileges field. +* `global_privileges` - (Optional, Set: [`String`]) Global permissions. Among them, the optional value of the permission in GlobalPrivileges is: SELECT, INSERT, UPDATE, DELETE, CREATE, PROCESS, DROP, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER. Note that if this parameter is not passed, it means that the existing permissions are reserved. If it needs to be cleared, pass an empty array in this field. +* `table_privileges` - (Optional, List) Permissions for tables in the database. Optional values for the Privileges permission are: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE VIEW, SHOW VIEW, TRIGGER. Note that if this parameter is not passed, the existing privileges are reserved. If you need to clear them, please pass an empty array in the complex type Privileges field. +* `view_privileges` - (Optional, List) Permissions for database views. Optional values for the Privileges permission are: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE VIEW, SHOW VIEW, TRIGGER. Note that if this parameter is not passed, the existing privileges are reserved. If you need to clear them, please pass an empty array in the complex type Privileges field. + +The `account` object supports the following: + +* `host` - (Required, String) account host. +* `user` - (Required, String) account name. + +The `column_privileges` object supports the following: + +* `column` - (Required, String) Database column name. +* `database` - (Required, String) The name of database. +* `privileges` - (Required, Set) Permission information. +* `table` - (Required, String) Database table name. + +The `database_privileges` object supports the following: + +* `database` - (Required, String) The name of database. +* `privileges` - (Required, Set) Permission information. + +The `table_privileges` object supports the following: + +* `database` - (Required, String) The name of database. +* `privileges` - (Required, Set) Permission information. +* `table` - (Required, String) Database table name. + +The `view_privileges` object supports the following: + +* `database` - (Required, String) The name of database. +* `privileges` - (Required, Set) Permission information. +* `view` - (Required, String) Database view name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dcdb account_privileges can be imported using the id, e.g. + +``` +terraform import tencentcloud_dcdb_account_privileges.account_privileges instanceId#userName#host#dbName#tabName#viewName#colName +``` + diff --git a/config/docs/r/dcdb_activate_hour_instance_operation.html.markdown b/config/docs/r/dcdb_activate_hour_instance_operation.html.markdown new file mode 100644 index 0000000..93568a8 --- /dev/null +++ b/config/docs/r/dcdb_activate_hour_instance_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_activate_hour_instance_operation" +sidebar_current: "docs-tencentcloud-resource-dcdb_activate_hour_instance_operation" +description: |- + Provides a resource to create a dcdb activate_hour_instance_operation +--- + +# tencentcloud_dcdb_activate_hour_instance_operation + +Provides a resource to create a dcdb activate_hour_instance_operation + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_activate_hour_instance_operation" "activate_hour_instance_operation" { + instance_id = local.dcdb_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) instance ID in the format of dcdbt-ow728lmc, which can be obtained through the `DescribeDCDBInstances` API. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dcdb_cancel_dcn_job_operation.html.markdown b/config/docs/r/dcdb_cancel_dcn_job_operation.html.markdown new file mode 100644 index 0000000..436b452 --- /dev/null +++ b/config/docs/r/dcdb_cancel_dcn_job_operation.html.markdown @@ -0,0 +1,76 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_cancel_dcn_job_operation" +sidebar_current: "docs-tencentcloud-resource-dcdb_cancel_dcn_job_operation" +description: |- + Provides a resource to create a dcdb cancel_dcn_job_operation +--- + +# tencentcloud_dcdb_cancel_dcn_job_operation + +Provides a resource to create a dcdb cancel_dcn_job_operation + +## Example Usage + +```hcl +data "tencentcloud_security_groups" "internal" { + name = "default" +} + +data "tencentcloud_vpc_instances" "vpc" { + name = "Default-VPC" +} + +data "tencentcloud_vpc_subnets" "subnet" { + vpc_id = data.tencentcloud_vpc_instances.vpc.instance_list.0.vpc_id +} + +locals { + vpc_id = data.tencentcloud_vpc_subnets.subnet.instance_list.0.vpc_id + subnet_id = data.tencentcloud_vpc_subnets.subnet.instance_list.0.subnet_id + sg_id = data.tencentcloud_security_groups.internal.security_groups.0.security_group_id +} + +resource "tencentcloud_dcdb_hourdb_instance" "hourdb_instance_dcn" { + instance_name = "test_dcdb_db_hourdb_instance_dcn" + zones = [var.default_az] + shard_memory = "2" + shard_storage = "10" + shard_node_count = "2" + shard_count = "2" + vpc_id = local.vpc_id + subnet_id = local.subnet_id + security_group_id = local.sg_id + db_version_id = "8.0" + dcn_region = "ap-guangzhou" + dcn_instance_id = local.dcdb_id //master_instance + resource_tags { + tag_key = "aaa" + tag_value = "bbb" + } +} + +locals { + dcn_dcdb_id = tencentcloud_dcdb_hourdb_instance.hourdb_instance_dcn.id +} + +resource "tencentcloud_dcdb_cancel_dcn_job_operation" "cancel_operation" { + instance_id = local.dcn_dcdb_id // cancel the dcn/readonly instance +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dcdb_db_instance.html.markdown b/config/docs/r/dcdb_db_instance.html.markdown new file mode 100644 index 0000000..8428105 --- /dev/null +++ b/config/docs/r/dcdb_db_instance.html.markdown @@ -0,0 +1,102 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_db_instance" +sidebar_current: "docs-tencentcloud-resource-dcdb_db_instance" +description: |- + Provides a resource to create a dcdb db_instance +--- + +# tencentcloud_dcdb_db_instance + +Provides a resource to create a dcdb db_instance + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_db_instance" "db_instance" { + instance_name = "test_dcdb_db_instance" + zones = ["ap-guangzhou-5"] + period = 1 + shard_memory = "2" + shard_storage = "10" + shard_node_count = "2" + shard_count = "2" + vpc_id = local.vpc_id + subnet_id = local.subnet_id + db_version_id = "8.0" + resource_tags { + tag_key = "aaa" + tag_value = "bbb" + } + init_params { + param = "character_set_server" + value = "utf8mb4" + } + init_params { + param = "lower_case_table_names" + value = "1" + } + init_params { + param = "sync_mode" + value = "2" + } + init_params { + param = "innodb_page_size" + value = "16384" + } + security_group_ids = [local.sg_id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `period` - (Required, Int) The length of time you want to buy, unit: month. +* `shard_count` - (Required, Int) The number of instance fragments, the optional range is 2-8, and new fragments can be added to a maximum of 64 fragments by upgrading the instance. +* `shard_memory` - (Required, Int) &quot;Shard memory size, unit: GB, can pass DescribeShardSpec&quot;&quot;Query the instance specification to obtain.&quot;. +* `shard_node_count` - (Required, Int) &quot;Number of single shard nodes, can pass DescribeShardSpec&quot;&quot;Query the instance specification to obtain.&quot;. +* `shard_storage` - (Required, Int) &quot;Shard storage size, unit: GB, can pass DescribeShardSpec&quot;&quot;Query the instance specification to obtain.&quot;. +* `zones` - (Required, Set: [`String`]) &quot;The availability zone distribution of shard nodes can be filled with up to two availability zones. When the shard specification is one master and two slaves, two of the nodes are in the first availability zone.&quot;&quot;Note that the current availability zone that can be sold needs to be pulled through the DescribeDCDBSaleInfo interface.&quot;. +* `auto_renew_flag` - (Optional, Int) &quot;Automatic renewal flag, 0 means the default state (the user has not set it, that is, the initial state is manual renewal, and the user has activated the prepaid non-stop privilege and will also perform automatic renewal).&quot;&quot;1 means automatic renewal, 2 means no automatic renewal (user setting).&quot;&quot;if the business has no concept of renewal or automatic renewal is not required, it needs to be set to 0.&quot;. +* `auto_voucher` - (Optional, Bool) Whether to automatically use vouchers for payment, not used by default. +* `db_version_id` - (Optional, String) &quot;Database engine version, currently available: 8.0.18, 10.1.9, 5.7.17.&quot;&quot;8.0.18 - MySQL 8.0.18;&quot;&quot;10.1.9 - Mariadb 10.1.9;&quot;&quot;5.7.17 - Percona 5.7.17&quot;&quot;If not filled, the default is 5.7.17, which means Percona 5.7.17.&quot;. +* `dcn_instance_id` - (Optional, String) DCN source instance ID. +* `dcn_region` - (Optional, String) DCN source region. +* `init_params` - (Optional, List) &quot;parameter list. The optional values of this interface are:&quot;&quot;character_set_server (character set, must be passed),&quot;&quot;lower_case_table_names (table name is case sensitive, must be passed, 0 - sensitive; 1 - insensitive),&quot;&quot;innodb_page_size (innodb data page, default 16K),&quot;&quot;sync_mode ( Synchronous mode: 0 - asynchronous; 1 - strong synchronous; 2 - strong synchronous degenerate. The default is strong synchronous degenerate)&quot;. +* `instance_name` - (Optional, String) Instance name, you can set the name of the instance independently through this field. +* `ipv6_flag` - (Optional, Int) Whether to support IPv6. +* `project_id` - (Optional, Int) Project ID, which can be obtained by viewing the project list, if not passed, it will be associated with the default project. +* `resource_tags` - (Optional, List) Array of tag key-value pairs. +* `security_group_ids` - (Optional, Set: [`String`]) Security group ids, the security group can be passed in the form of an array, compatible with the previous SecurityGroupId parameter. +* `subnet_id` - (Optional, String) Virtual private network subnet ID, required when VpcId is not empty. +* `voucher_ids` - (Optional, Set: [`String`]) Voucher ID list, currently only supports specifying one voucher. +* `vpc_id` - (Optional, String) Virtual private network ID, if not passed or passed empty, it means that it is created as a basic network. + +The `init_params` object supports the following: + +* `param` - (Required, String) The name of parameter. +* `value` - (Required, String) The value of parameter. + +The `resource_tags` object supports the following: + +* `tag_key` - (Required, String) The key of tag. +* `tag_value` - (Required, String) The value of tag. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dcdb db_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_dcdb_db_instance.db_instance db_instance_id +``` + diff --git a/config/docs/r/dcdb_db_parameters.html.markdown b/config/docs/r/dcdb_db_parameters.html.markdown new file mode 100644 index 0000000..cf15091 --- /dev/null +++ b/config/docs/r/dcdb_db_parameters.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_db_parameters" +sidebar_current: "docs-tencentcloud-resource-dcdb_db_parameters" +description: |- + Provides a resource to create a dcdb db_parameters +--- + +# tencentcloud_dcdb_db_parameters + +Provides a resource to create a dcdb db_parameters + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_db_parameters" "db_parameters" { + instance_id = "%s" + params { + param = "max_connections" + value = "9999" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of instance. +* `params` - (Required, List) Parameter list, each element is a combination of Param and Value. + +The `params` object supports the following: + +* `param` - (Required, String) The name of parameter. +* `value` - (Required, String) The value of parameter. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dcdb db_parameters can be imported using the id, e.g. + +``` +terraform import tencentcloud_dcdb_db_parameters.db_parameters instanceId#paramName +``` + diff --git a/config/docs/r/dcdb_db_sync_mode_config.html.markdown b/config/docs/r/dcdb_db_sync_mode_config.html.markdown new file mode 100644 index 0000000..3453f01 --- /dev/null +++ b/config/docs/r/dcdb_db_sync_mode_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_db_sync_mode_config" +sidebar_current: "docs-tencentcloud-resource-dcdb_db_sync_mode_config" +description: |- + Provides a resource to create a dcdb db_sync_mode_config +--- + +# tencentcloud_dcdb_db_sync_mode_config + +Provides a resource to create a dcdb db_sync_mode_config + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_db_sync_mode_config" "config" { + instance_id = "%s" + sync_mode = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) ID of the instance for which to modify the sync mode. The ID is in the format of `tdsql-ow728lmc`. +* `sync_mode` - (Required, Int) Sync mode. Valid values: `0` (async), `1` (strong sync), `2` (downgradable strong sync). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dcdb db_sync_mode_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_dcdb_db_sync_mode_config.db_sync_mode_config db_sync_mode_config_id +``` + diff --git a/config/docs/r/dcdb_encrypt_attributes_config.html.markdown b/config/docs/r/dcdb_encrypt_attributes_config.html.markdown new file mode 100644 index 0000000..b200027 --- /dev/null +++ b/config/docs/r/dcdb_encrypt_attributes_config.html.markdown @@ -0,0 +1,112 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_encrypt_attributes_config" +sidebar_current: "docs-tencentcloud-resource-dcdb_encrypt_attributes_config" +description: |- + Provides a resource to create a dcdb encrypt_attributes_config +--- + +# tencentcloud_dcdb_encrypt_attributes_config + +Provides a resource to create a dcdb encrypt_attributes_config + +~> **NOTE:** This resource currently only supports the newly created MySQL 8.0.24 version. + +## Example Usage + +```hcl +data "tencentcloud_security_groups" "internal" { + name = "default" +} + +data "tencentcloud_vpc_instances" "vpc" { + name = "Default-VPC" +} + +data "tencentcloud_vpc_subnets" "subnet" { + vpc_id = data.tencentcloud_vpc_instances.vpc.instance_list.0.vpc_id +} + +locals { + vpc_id = data.tencentcloud_vpc_subnets.subnet.instance_list.0.vpc_id + subnet_id = data.tencentcloud_vpc_subnets.subnet.instance_list.0.subnet_id + sg_id = data.tencentcloud_security_groups.internal.security_groups.0.security_group_id +} + +resource "tencentcloud_dcdb_db_instance" "prepaid_instance" { + instance_name = "test_dcdb_db_post_instance" + zones = [var.default_az] + period = 1 + shard_memory = "2" + shard_storage = "10" + shard_node_count = "2" + shard_count = "2" + vpc_id = local.vpc_id + subnet_id = local.subnet_id + db_version_id = "8.0" + resource_tags { + tag_key = "aaa" + tag_value = "bbb" + } + security_group_ids = [local.sg_id] +} + +resource "tencentcloud_dcdb_hourdb_instance" "hourdb_instance" { + instance_name = "test_dcdb_db_hourdb_instance" + zones = [var.default_az] + shard_memory = "2" + shard_storage = "10" + shard_node_count = "2" + shard_count = "2" + vpc_id = local.vpc_id + subnet_id = local.subnet_id + security_group_id = local.sg_id + db_version_id = "8.0" + resource_tags { + tag_key = "aaa" + tag_value = "bbb" + } +} + +locals { + prepaid_dcdb_id = tencentcloud_dcdb_db_instance.prepaid_instance.id + hourdb_dcdb_id = tencentcloud_dcdb_hourdb_instance.hourdb_instance.id +} + +// for postpaid instance +resource "tencentcloud_dcdb_encrypt_attributes_config" "config_hourdb" { + instance_id = local.hourdb_dcdb_id + encrypt_enabled = 1 +} + +// for prepaid instance +resource "tencentcloud_dcdb_encrypt_attributes_config" "config_prepaid" { + instance_id = local.prepaid_dcdb_id + encrypt_enabled = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `encrypt_enabled` - (Required, Int) whether to enable data encryption. Notice: it is not supported to turn it off after it is turned on. The optional values: 0-disable, 1-enable. +* `instance_id` - (Required, String) instance id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dcdb encrypt_attributes_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_dcdb_encrypt_attributes_config.encrypt_attributes_config encrypt_attributes_config_id +``` + diff --git a/config/docs/r/dcdb_flush_binlog_operation.html.markdown b/config/docs/r/dcdb_flush_binlog_operation.html.markdown new file mode 100644 index 0000000..b791f73 --- /dev/null +++ b/config/docs/r/dcdb_flush_binlog_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_flush_binlog_operation" +sidebar_current: "docs-tencentcloud-resource-dcdb_flush_binlog_operation" +description: |- + Provides a resource to create a dcdb flush_binlog_operation +--- + +# tencentcloud_dcdb_flush_binlog_operation + +Provides a resource to create a dcdb flush_binlog_operation + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_flush_binlog_operation" "flush_operation" { + instance_id = local.dcdb_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dcdb_hourdb_instance.html.markdown b/config/docs/r/dcdb_hourdb_instance.html.markdown new file mode 100644 index 0000000..0232f07 --- /dev/null +++ b/config/docs/r/dcdb_hourdb_instance.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_hourdb_instance" +sidebar_current: "docs-tencentcloud-resource-dcdb_hourdb_instance" +description: |- + Provides a resource to create a dcdb hourdb_instance +--- + +# tencentcloud_dcdb_hourdb_instance + +Provides a resource to create a dcdb hourdb_instance + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_hourdb_instance" "hourdb_instance" { + instance_name = "test_dcdc_dc_instance" + zones = ["ap-guangzhou-5", "ap-guangzhou-6"] + shard_memory = "2" + shard_storage = "10" + shard_node_count = "2" + shard_count = "2" + vpc_id = local.vpc_id + subnet_id = local.subnet_id + security_group_id = local.sg_id + db_version_id = "8.0" + resource_tags { + tag_key = "aaa" + tag_value = "bbb" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `shard_count` - (Required, Int) instance shard count. +* `shard_memory` - (Required, Int) memory(GB) for each shard. It can be obtained by querying api DescribeShardSpec. +* `shard_node_count` - (Required, Int) node count for each shard. It can be obtained by querying api DescribeShardSpec. +* `shard_storage` - (Required, Int) storage(GB) for each shard. It can be obtained by querying api DescribeShardSpec. +* `db_version_id` - (Optional, String) db engine version, default to Percona 5.7.17. +* `dcn_instance_id` - (Optional, String) DCN source instance ID. +* `dcn_region` - (Optional, String) DCN source region. +* `extranet_access` - (Optional, Bool) Whether to open the extranet access. +* `instance_name` - (Optional, String) name of this instance. +* `ipv6_flag` - (Optional, Int) Whether to support IPv6. +* `project_id` - (Optional, Int) project id. +* `resource_tags` - (Optional, List) resource tags. +* `security_group_id` - (Optional, String) security group id. +* `subnet_id` - (Optional, String) subnet id, its required when vpcId is set. +* `vip` - (Optional, String) The field is required to specify VIP. +* `vipv6` - (Optional, String) The field is required to specify VIPv6. +* `vpc_id` - (Optional, String) vpc id. +* `zones` - (Optional, Set: [`String`]) available zone. + +The `resource_tags` object supports the following: + +* `tag_key` - (Required, String) tag key. +* `tag_value` - (Required, String) tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `vport` - Intranet port. + + +## Import + +dcdb hourdb_instance can be imported using the id, e.g. +``` +$ terraform import tencentcloud_dcdb_hourdb_instance.hourdb_instance hourdbInstance_id +``` + diff --git a/config/docs/r/dcdb_instance_config.html.markdown b/config/docs/r/dcdb_instance_config.html.markdown new file mode 100644 index 0000000..061bfa5 --- /dev/null +++ b/config/docs/r/dcdb_instance_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_instance_config" +sidebar_current: "docs-tencentcloud-resource-dcdb_instance_config" +description: |- + Provides a resource to create a dcdb instance_config +--- + +# tencentcloud_dcdb_instance_config + +Provides a resource to create a dcdb instance_config + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_instance_config" "instance_config" { + instance_id = local.dcdb_id + rs_access_strategy = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `rs_access_strategy` - (Required, Int) RS nearest access mode, 0-no policy, 1-nearest access. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dcdb instance_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_dcdb_instance_config.instance_config instance_config_id +``` + diff --git a/config/docs/r/dcdb_isolate_hour_instance_operation.html.markdown b/config/docs/r/dcdb_isolate_hour_instance_operation.html.markdown new file mode 100644 index 0000000..4888c48 --- /dev/null +++ b/config/docs/r/dcdb_isolate_hour_instance_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_isolate_hour_instance_operation" +sidebar_current: "docs-tencentcloud-resource-dcdb_isolate_hour_instance_operation" +description: |- + Provides a resource to create a dcdb isolate_hour_instance_operation +--- + +# tencentcloud_dcdb_isolate_hour_instance_operation + +Provides a resource to create a dcdb isolate_hour_instance_operation + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_isolate_hour_instance_operation" "isolate_hour_instance_operation" { + instance_ids = local.dcdb_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dcdb_security_group_attachment.html.markdown b/config/docs/r/dcdb_security_group_attachment.html.markdown new file mode 100644 index 0000000..e9aa12c --- /dev/null +++ b/config/docs/r/dcdb_security_group_attachment.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_security_group_attachment" +sidebar_current: "docs-tencentcloud-resource-dcdb_security_group_attachment" +description: |- + Provides a resource to create a dcdb security_group_attachment +--- + +# tencentcloud_dcdb_security_group_attachment + +Provides a resource to create a dcdb security_group_attachment + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_security_group_attachment" "security_group_attachment" { + security_group_id = "" + instance_id = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) attached instance id. +* `security_group_id` - (Required, String, ForceNew) security group id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dcdb security_group_attachment can be imported using the id, e.g. +``` +$ terraform import tencentcloud_dcdb_security_group_attachment.security_group_attachment securityGroupAttachment_id +``` + diff --git a/config/docs/r/dcdb_switch_db_instance_ha_operation.html.markdown b/config/docs/r/dcdb_switch_db_instance_ha_operation.html.markdown new file mode 100644 index 0000000..3bb1de0 --- /dev/null +++ b/config/docs/r/dcdb_switch_db_instance_ha_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TDSQL for MySQL(DCDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcdb_switch_db_instance_ha_operation" +sidebar_current: "docs-tencentcloud-resource-dcdb_switch_db_instance_ha_operation" +description: |- + Provides a resource to create a dcdb switch_db_instance_ha_operation +--- + +# tencentcloud_dcdb_switch_db_instance_ha_operation + +Provides a resource to create a dcdb switch_db_instance_ha_operation + +## Example Usage + +```hcl +resource "tencentcloud_dcdb_switch_db_instance_ha_operation" "switch_operation" { + instance_id = local.dcdb_id + zone = "ap-guangzhou-4" //3 to 4 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID in the format of tdsqlshard-ow728lmc. +* `zone` - (Required, String, ForceNew) Target AZ. The node with the lowest delay in the target AZ will be automatically promoted to primary node. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dcx.html.markdown b/config/docs/r/dcx.html.markdown new file mode 100644 index 0000000..97c5730 --- /dev/null +++ b/config/docs/r/dcx.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcx" +sidebar_current: "docs-tencentcloud-resource-dcx" +description: |- + Provides a resource to creating dedicated tunnels instances. +--- + +# tencentcloud_dcx + +Provides a resource to creating dedicated tunnels instances. + +~> **NOTE:** 1. ID of the DC is queried, can only apply for this resource offline. + +## Example Usage + +```hcl +variable "dc_id" { + default = "dc-kax48sg7" +} + +variable "dcg_id" { + default = "dcg-dmbhf7jf" +} + +variable "vpc_id" { + default = "vpc-4h9v4mo3" +} + +resource "tencentcloud_dcx" "bgp_main" { + bandwidth = 900 + dc_id = var.dc_id + dcg_id = var.dcg_id + name = "bgp_main" + network_type = "VPC" + route_type = "BGP" + vlan = 306 + vpc_id = var.vpc_id +} + +resource "tencentcloud_dcx" "static_main" { + bandwidth = 900 + dc_id = var.dc_id + dcg_id = var.dcg_id + name = "static_main" + dc_owner_account = "xxxxxxxx" + network_type = "VPC" + route_type = "STATIC" + vlan = 301 + vpc_id = var.vpc_id + route_filter_prefixes = ["10.10.10.101/32"] + tencent_address = "100.93.46.1/30" + customer_address = "100.93.46.2/30" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dc_id` - (Required, String, ForceNew) ID of the DC to be queried, application deployment offline. +* `dcg_id` - (Required, String, ForceNew) ID of the DC Gateway. Currently only new in the console. +* `name` - (Required, String) Name of the dedicated tunnel. +* `bandwidth` - (Optional, Int, ForceNew) Bandwidth of the DC. +* `bgp_asn` - (Optional, Int, ForceNew) BGP ASN of the user. A required field within BGP. +* `bgp_auth_key` - (Optional, String, ForceNew) BGP key of the user. +* `customer_address` - (Optional, String, ForceNew) Interconnect IP of the DC within client. +* `dc_owner_account` - (Optional, String, ForceNew) Connection owner, who is the current customer by default. The developer account ID should be entered for shared connections. +* `network_type` - (Optional, String, ForceNew) Type of the network. Valid value: `VPC`, `BMVPC` and `CCN`. The default value is `VPC`. +* `route_filter_prefixes` - (Optional, Set: [`String`], ForceNew) Static route, the network address of the user IDC. It can be modified after setting but cannot be deleted. AN unable field within BGP. +* `route_type` - (Optional, String, ForceNew) Type of the route, and available values include BGP and STATIC. The default value is `BGP`. +* `tencent_address` - (Optional, String, ForceNew) Interconnect IP of the DC within Tencent. +* `vlan` - (Optional, Int, ForceNew) Vlan of the dedicated tunnels. Valid value ranges: (0~3000). `0` means that only one tunnel can be created for the physical connect. +* `vpc_id` - (Optional, String, ForceNew) ID of the VPC or BMVPC. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of resource. +* `state` - State of the dedicated tunnels. Valid value: `PENDING`, `ALLOCATING`, `ALLOCATED`, `ALTERING`, `DELETING`, `DELETED`, `COMFIRMING` and `REJECTED`. + + diff --git a/config/docs/r/dcx_extra_config.html.markdown b/config/docs/r/dcx_extra_config.html.markdown new file mode 100644 index 0000000..ccd0183 --- /dev/null +++ b/config/docs/r/dcx_extra_config.html.markdown @@ -0,0 +1,106 @@ +--- +subcategory: "Direct Connect(DC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dcx_extra_config" +sidebar_current: "docs-tencentcloud-resource-dcx_extra_config" +description: |- + Provides a resource to create a dc dcx_extra_config +--- + +# tencentcloud_dcx_extra_config + +Provides a resource to create a dc dcx_extra_config + +## Example Usage + +```hcl +resource "tencentcloud_dcx_extra_config" "dcx_extra_config" { + direct_connect_tunnel_id = "dcx-4z49tnws" + vlan = 123 + bgp_peer { + asn = 65101 + auth_key = "test123" + + } + route_filter_prefixes { + cidr = "192.168.0.0/24" + } + tencent_address = "192.168.1.1" + tencent_backup_address = "192.168.1.2" + customer_address = "192.168.1.4" + bandwidth = 10 + enable_bgp_community = false + bfd_enable = 0 + nqa_enable = 1 + bfd_info { + probe_failed_times = 3 + interval = 100 + + } + nqa_info { + probe_failed_times = 3 + interval = 100 + destination_ip = "192.168.2.2" + + } + ipv6_enable = 0 + jumbo_enable = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `direct_connect_tunnel_id` - (Required, String) direct connect tunnel id. +* `bandwidth` - (Optional, Int) direct connect tunnel bandwidth. +* `bfd_enable` - (Optional, Int) be enabled BFD. +* `bfd_info` - (Optional, List) BFD config info. +* `bgp_peer` - (Optional, List) idc BGP, Asn, AuthKey. +* `customer_address` - (Optional, String) direct connect tunnel user idc connect ip. +* `enable_bgp_community` - (Optional, Bool) BGP community attribute. +* `ipv6_enable` - (Optional, Int) 0: disable IPv61: enable IPv6. +* `jumbo_enable` - (Optional, Int) direct connect tunnel support jumbo frame1: enable direct connect tunnel jumbo frame0: disable direct connect tunnel jumbo frame. +* `nqa_enable` - (Optional, Int) be enabled NQA. +* `nqa_info` - (Optional, List) NQA config info. +* `route_filter_prefixes` - (Optional, List) user filter network prefixes. +* `tencent_address` - (Optional, String) direct connect tunnel tencent cloud connect ip. +* `tencent_backup_address` - (Optional, String) direct connect tunnel tencent cloud backup connect ip. +* `vlan` - (Optional, Int) direct connect tunnel vlan id. + +The `bfd_info` object supports the following: + +* `interval` - (Optional, Int) detect interval. +* `probe_failed_times` - (Optional, Int) detect times. + +The `bgp_peer` object supports the following: + +* `asn` - (Optional, Int) user idc BGP Asn. +* `auth_key` - (Optional, String) user bgp key. + +The `nqa_info` object supports the following: + +* `destination_ip` - (Optional, String) detect ip. +* `interval` - (Optional, Int) detect interval. +* `probe_failed_times` - (Optional, Int) detect times. + +The `route_filter_prefixes` object supports the following: + +* `cidr` - (Optional, String) user network prefixes. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dc dcx_extra_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_dcx_extra_config.dcx_extra_config dcx_id +``` + diff --git a/config/docs/r/dlc_add_users_to_work_group_attachment.html.markdown b/config/docs/r/dlc_add_users_to_work_group_attachment.html.markdown new file mode 100644 index 0000000..1a87c26 --- /dev/null +++ b/config/docs/r/dlc_add_users_to_work_group_attachment.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_add_users_to_work_group_attachment" +sidebar_current: "docs-tencentcloud-resource-dlc_add_users_to_work_group_attachment" +description: |- + Provides a resource to create a dlc add_users_to_work_group_attachment +--- + +# tencentcloud_dlc_add_users_to_work_group_attachment + +Provides a resource to create a dlc add_users_to_work_group_attachment + +## Example Usage + +```hcl +resource "tencentcloud_dlc_add_users_to_work_group_attachment" "add_users_to_work_group_attachment" { + add_info { + work_group_id = 23184 + user_ids = [100032676511] + } +} +} +``` + +## Argument Reference + +The following arguments are supported: + +* `add_info` - (Required, List, ForceNew) Work group and user information to operate on. + +The `add_info` object supports the following: + +* `user_ids` - (Required, Set) User id set, matched with CAM side uin. +* `work_group_id` - (Required, Int) Work group id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dlc add_users_to_work_group_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_add_users_to_work_group_attachment.add_users_to_work_group_attachment add_users_to_work_group_attachment_id +``` + diff --git a/config/docs/r/dlc_bind_work_groups_to_user_attachment.html.markdown b/config/docs/r/dlc_bind_work_groups_to_user_attachment.html.markdown new file mode 100644 index 0000000..81e02a5 --- /dev/null +++ b/config/docs/r/dlc_bind_work_groups_to_user_attachment.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_bind_work_groups_to_user_attachment" +sidebar_current: "docs-tencentcloud-resource-dlc_bind_work_groups_to_user_attachment" +description: |- + Provides a resource to create a dlc bind_work_groups_to_user +--- + +# tencentcloud_dlc_bind_work_groups_to_user_attachment + +Provides a resource to create a dlc bind_work_groups_to_user + +## Example Usage + +```hcl +resource "tencentcloud_dlc_bind_work_groups_to_user_attachment" "bind_work_groups_to_user" { + add_info { + user_id = "100032772113" + work_group_ids = [23184, 23181] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `add_info` - (Required, List, ForceNew) Bind user and workgroup information. + +The `add_info` object supports the following: + +* `user_id` - (Required, String) User id, matched with CAM side uin. +* `work_group_ids` - (Required, Set) Work group id set. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dlc bind_work_groups_to_user can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_bind_work_groups_to_user_attachment.bind_work_groups_to_user bind_work_groups_to_user_id +``` + diff --git a/config/docs/r/dlc_data_engine.html.markdown b/config/docs/r/dlc_data_engine.html.markdown new file mode 100644 index 0000000..20e8d1a --- /dev/null +++ b/config/docs/r/dlc_data_engine.html.markdown @@ -0,0 +1,105 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_data_engine" +sidebar_current: "docs-tencentcloud-resource-dlc_data_engine" +description: |- + Provides a resource to create a dlc data_engine +--- + +# tencentcloud_dlc_data_engine + +Provides a resource to create a dlc data_engine + +## Example Usage + +```hcl +resource "tencentcloud_dlc_data_engine" "data_engine" { + engine_type = "spark" + data_engine_name = "testSpark" + cluster_type = "spark_cu" + mode = 1 + auto_resume = false + size = 16 + pay_mode = 0 + min_clusters = 1 + max_clusters = 1 + default_data_engine = false + cidr_block = "10.255.0.0/16" + message = "test spark1" + time_span = 1 + time_unit = "h" + auto_suspend = false + crontab_resume_suspend = 0 + engine_exec_type = "BATCH" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_resume` - (Required, Bool) Whether to automatically start the cluster, prepay not support. +* `cluster_type` - (Required, String) Engine cluster type, only support: spark_cu/presto_cu. +* `data_engine_name` - (Required, String) Engine name. +* `engine_type` - (Required, String) Engine type, only support: spark/presto. +* `mode` - (Required, Int) Engine mode, only support 1: ByAmount, 2: YearlyAndMonthly. +* `auto_renew` - (Optional, Int) Engine auto renew, only support 0: Default, 1: AutoRenewON, 2: AutoRenewOFF. +* `auto_suspend_time` - (Optional, Int) Cluster automatic suspension time, default 10 minutes. +* `auto_suspend` - (Optional, Bool) Whether to automatically suspend the cluster, prepay not support. +* `cidr_block` - (Optional, String) Engine VPC network segment, just like 192.0.2.1/24. +* `crontab_resume_suspend_strategy` - (Optional, List) Engine auto suspend strategy, when AutoSuspend is true, CrontabResumeSuspend must stop. +* `crontab_resume_suspend` - (Optional, Int) Engine crontab resume or suspend strategy, only support: 0: Wait(default), 1: Kill. +* `data_engine_config_pairs` - (Optional, List) Cluster advanced configuration. +* `default_data_engine` - (Optional, Bool) Whether it is the default virtual cluster. +* `elastic_limit` - (Optional, Int) For spark Batch ExecType, yearly and monthly cluster elastic limit. +* `elastic_switch` - (Optional, Bool) For spark Batch ExecType, yearly and monthly cluster whether to enable elasticity. +* `engine_exec_type` - (Optional, String) Engine exec type, only support SQL(default) or BATCH. +* `image_version_name` - (Optional, String) Cluster image version name. Such as SuperSQL-P 1.1; SuperSQL-S 3.2, etc., do not upload, and create a cluster with the latest mirror version by default. +* `main_cluster_name` - (Optional, String) Primary cluster name, specified when creating a disaster recovery cluster. +* `max_clusters` - (Optional, Int) Engine max cluster size, MaxClusters less than or equal to 10 and MaxClusters bigger than MinClusters. +* `max_concurrency` - (Optional, Int) Maximum number of concurrent tasks in a single cluster, default 5. +* `message` - (Optional, String) Engine description information. +* `min_clusters` - (Optional, Int) Engine min size, greater than or equal to 1 and MaxClusters bigger than MinClusters. +* `pay_mode` - (Optional, Int) Engine pay mode type, only support 0: postPay, 1: prePay(default). +* `resource_type` - (Optional, String) Engine resource type not match, only support: Standard_CU/Memory_CU(only BATCH ExecType). +* `session_resource_template` - (Optional, List) For spark Batch ExecType, cluster session resource configuration template. +* `size` - (Optional, Int) Cluster size. Required when updating. +* `time_span` - (Optional, Int) Engine TimeSpan, prePay: minimum of 1, representing one month of purchasing resources, with a maximum of 120, default 3600, postPay: fixed fee of 3600. +* `time_unit` - (Optional, String) Engine TimeUnit, prePay: use m(default), postPay: use h. +* `tolerable_queue_time` - (Optional, Int) Tolerable queuing time, default 0. scaling may be triggered when tasks are queued for longer than the tolerable time. if this parameter is 0, it means that capacity expansion may be triggered immediately once a task is queued. + +The `crontab_resume_suspend_strategy` object supports the following: + +* `resume_time` - (Optional, String) Scheduled pull-up time: For example: 8 o&#39;clock on Monday is expressed as 1000000-08:00:00. +* `suspend_strategy` - (Optional, Int) Suspend configuration: 0 (default): wait for the task to end before suspending, 1: force suspend. +* `suspend_time` - (Optional, String) Scheduled suspension time: For example: 20 o&#39;clock on Monday is expressed as 1000000-20:00:00. + +The `data_engine_config_pairs` object supports the following: + +* `config_item` - (Required, String) Configuration items. +* `config_value` - (Required, String) Configuration value. + +The `session_resource_template` object supports the following: + +* `driver_size` - (Optional, String) Engine driver size specification only supports: small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge. +* `executor_max_numbers` - (Optional, Int) Specify the executor max number (in a dynamic configuration scenario), the minimum value is 1, and the maximum value is less than the cluster specification (when ExecutorMaxNumbers is less than ExecutorNums, the value is set to ExecutorNums). +* `executor_nums` - (Optional, Int) Specify the number of executors. The minimum value is 1 and the maximum value is less than the cluster specification. +* `executor_size` - (Optional, String) Engine executor size specification only supports: small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dlc data_engine can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_data_engine.data_engine data_engine_id +``` + diff --git a/config/docs/r/dlc_modify_data_engine_description_operation.html.markdown b/config/docs/r/dlc_modify_data_engine_description_operation.html.markdown new file mode 100644 index 0000000..60f0547 --- /dev/null +++ b/config/docs/r/dlc_modify_data_engine_description_operation.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_modify_data_engine_description_operation" +sidebar_current: "docs-tencentcloud-resource-dlc_modify_data_engine_description_operation" +description: |- + Provides a resource to create a dlc modify_data_engine_description_operation +--- + +# tencentcloud_dlc_modify_data_engine_description_operation + +Provides a resource to create a dlc modify_data_engine_description_operation + +## Example Usage + +```hcl +resource "tencentcloud_dlc_modify_data_engine_description_operation" "modify_data_engine_description_operation" { + data_engine_name = "testEngine" + message = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_name` - (Required, String, ForceNew) The name of the engine to modify. +* `message` - (Required, String, ForceNew) Engine description information, the maximum length is 250. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dlc modify_data_engine_description_operation can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_modify_data_engine_description_operation.modify_data_engine_description_operation modify_data_engine_description_operation_id +``` + diff --git a/config/docs/r/dlc_modify_user_typ_operation.html.markdown b/config/docs/r/dlc_modify_user_typ_operation.html.markdown new file mode 100644 index 0000000..4058963 --- /dev/null +++ b/config/docs/r/dlc_modify_user_typ_operation.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_modify_user_typ_operation" +sidebar_current: "docs-tencentcloud-resource-dlc_modify_user_typ_operation" +description: |- + Provides a resource to create a dlc modify_user_typ_operation +--- + +# tencentcloud_dlc_modify_user_typ_operation + +Provides a resource to create a dlc modify_user_typ_operation + +## Example Usage + +```hcl +resource "tencentcloud_dlc_modify_user_typ_operation" "modify_user_typ_operation" { + user_id = "127382378" + user_type = "ADMIN" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `user_id` - (Required, String, ForceNew) User id (uin), if left blank, it defaults to the caller's sub-uin. +* `user_type` - (Required, String, ForceNew) User type, only support: ADMIN: ddministrator/COMMON: ordinary user. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dlc modify_user_typ_operation can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_modify_user_typ_operation.modify_user_typ_operation modify_user_typ_operation_id +``` + diff --git a/config/docs/r/dlc_renew_data_engine_operation.html.markdown b/config/docs/r/dlc_renew_data_engine_operation.html.markdown new file mode 100644 index 0000000..598fe80 --- /dev/null +++ b/config/docs/r/dlc_renew_data_engine_operation.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_renew_data_engine_operation" +sidebar_current: "docs-tencentcloud-resource-dlc_renew_data_engine_operation" +description: |- + Provides a resource to create a dlc renew_data_engine +--- + +# tencentcloud_dlc_renew_data_engine_operation + +Provides a resource to create a dlc renew_data_engine + +## Example Usage + +```hcl +resource "tencentcloud_dlc_renew_data_engine_operation" "renew_data_engine" { + data_engine_name = "testEngine" + time_span = 3600 + pay_mode = 1 + time_unit = "m" + renew_flag = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_name` - (Required, String, ForceNew) Data engine name. +* `time_span` - (Required, Int, ForceNew) Engine TimeSpan, prePay: minimum of 1, representing one month of purchasing resources, with a maximum of 120, default 3600, postPay: fixed fee of 3600. +* `pay_mode` - (Optional, Int, ForceNew) Engine pay mode type, only support 0: postPay, 1: prePay(default). +* `renew_flag` - (Optional, Int, ForceNew) Automatic renewal flag, 0, initial state, automatic renewal is not performed by default. if the user has prepaid non-stop service privileges, automatic renewal will occur. 1: Automatic renewal. 2: make it clear that there will be no automatic renewal. if this parameter is not passed, the default value is 0. +* `time_unit` - (Optional, String, ForceNew) Engine TimeUnit, prePay: use m(default), postPay: use h. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dlc renew_data_engine can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_renew_data_engine_operation.renew_data_engine renew_data_engine_id +``` + diff --git a/config/docs/r/dlc_restart_data_engine_operation.html.markdown b/config/docs/r/dlc_restart_data_engine_operation.html.markdown new file mode 100644 index 0000000..d78b351 --- /dev/null +++ b/config/docs/r/dlc_restart_data_engine_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_restart_data_engine_operation" +sidebar_current: "docs-tencentcloud-resource-dlc_restart_data_engine_operation" +description: |- + Provides a resource to create a dlc restart_data_engine +--- + +# tencentcloud_dlc_restart_data_engine_operation + +Provides a resource to create a dlc restart_data_engine + +## Example Usage + +```hcl +resource "tencentcloud_dlc_restart_data_engine_operation" "restart_data_engine" { + data_engine_id = "DataEngine-g5ds87d8" + forced_operation = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_id` - (Required, String, ForceNew) Engine unique id. +* `forced_operation` - (Optional, Bool, ForceNew) Whether to force restart and ignore tasks. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dlc_rollback_data_engine_image_operation.html.markdown b/config/docs/r/dlc_rollback_data_engine_image_operation.html.markdown new file mode 100644 index 0000000..99add08 --- /dev/null +++ b/config/docs/r/dlc_rollback_data_engine_image_operation.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_rollback_data_engine_image_operation" +sidebar_current: "docs-tencentcloud-resource-dlc_rollback_data_engine_image_operation" +description: |- + Provides a resource to create a dlc rollback_data_engine_image +--- + +# tencentcloud_dlc_rollback_data_engine_image_operation + +Provides a resource to create a dlc rollback_data_engine_image + +## Example Usage + +```hcl +data "tencentcloud_dlc_check_data_engine_image_can_be_rollback" "check_data_engine_image_can_be_rollback" { + data_engine_id = "DataEngine-cgkvbas6" +} +resource "tencentcloud_dlc_rollback_data_engine_image_operation" "rollback_data_engine_image" { + data_engine_id = "DataEngine-cgkvbas6" + from_record_id = data.tencentcloud_dlc_check_data_engine_image_can_be_rollback.check_data_engine_image_can_be_rollback.from_record_id + to_record_id = data.tencentcloud_dlc_check_data_engine_image_can_be_rollback.check_data_engine_image_can_be_rollback.to_record_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_id` - (Required, String, ForceNew) Engine unique id. +* `from_record_id` - (Optional, String, ForceNew) Log record id before rollback. +* `to_record_id` - (Optional, String, ForceNew) Log record id after rollback. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dlc rollback_data_engine_image can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_rollback_data_engine_image_operation.rollback_data_engine_image rollback_data_engine_image_id +``` + diff --git a/config/docs/r/dlc_store_location_config.html.markdown b/config/docs/r/dlc_store_location_config.html.markdown new file mode 100644 index 0000000..6ca0d47 --- /dev/null +++ b/config/docs/r/dlc_store_location_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_store_location_config" +sidebar_current: "docs-tencentcloud-resource-dlc_store_location_config" +description: |- + Provides a resource to create a dlc store_location_config +--- + +# tencentcloud_dlc_store_location_config + +Provides a resource to create a dlc store_location_config + +## Example Usage + +```hcl +resource "tencentcloud_dlc_store_location_config" "store_location_config" { + store_location = "cosn://bucketname/" + enable = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `enable` - (Required, Int) Whether to enable advanced settings: 0-no, 1-yes. +* `store_location` - (Required, String) The calculation results are stored in the cos path, such as: cosn://bucketname/. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dlc store_location_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_store_location_config.store_location_config store_location_config_id +``` + diff --git a/config/docs/r/dlc_suspend_resume_data_engine.html.markdown b/config/docs/r/dlc_suspend_resume_data_engine.html.markdown new file mode 100644 index 0000000..1f5e22a --- /dev/null +++ b/config/docs/r/dlc_suspend_resume_data_engine.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_suspend_resume_data_engine" +sidebar_current: "docs-tencentcloud-resource-dlc_suspend_resume_data_engine" +description: |- + Provides a resource to create a dlc suspend_resume_data_engine +--- + +# tencentcloud_dlc_suspend_resume_data_engine + +Provides a resource to create a dlc suspend_resume_data_engine + +## Example Usage + +```hcl +resource "tencentcloud_dlc_suspend_resume_data_engine" "suspend_resume_data_engine" { + data_engine_name = "example-iac" + operate = "suspend" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_name` - (Required, String, ForceNew) Engine name. +* `operate` - (Required, String, ForceNew) Engine operate tye: suspend/resume. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dlc suspend_resume_data_engine can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_suspend_resume_data_engine.suspend_resume_data_engine suspend_resume_data_engine_id +``` + diff --git a/config/docs/r/dlc_switch_data_engine_image_operation.html.markdown b/config/docs/r/dlc_switch_data_engine_image_operation.html.markdown new file mode 100644 index 0000000..ec66243 --- /dev/null +++ b/config/docs/r/dlc_switch_data_engine_image_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_switch_data_engine_image_operation" +sidebar_current: "docs-tencentcloud-resource-dlc_switch_data_engine_image_operation" +description: |- + Provides a resource to create a dlc switch_data_engine_image_operation +--- + +# tencentcloud_dlc_switch_data_engine_image_operation + +Provides a resource to create a dlc switch_data_engine_image_operation + +## Example Usage + +```hcl +resource "tencentcloud_dlc_switch_data_engine_image_operation" "switch_data_engine_image_operation" { + data_engine_id = "DataEngine-g5ds87d8" + new_image_version_id = "344ba1c6-b7a9-403a-a255-422fffed6d38" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_id` - (Required, String, ForceNew) Engine unique id. +* `new_image_version_id` - (Required, String, ForceNew) New image version id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dlc_update_data_engine_config_operation.html.markdown b/config/docs/r/dlc_update_data_engine_config_operation.html.markdown new file mode 100644 index 0000000..bddcd03 --- /dev/null +++ b/config/docs/r/dlc_update_data_engine_config_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_update_data_engine_config_operation" +sidebar_current: "docs-tencentcloud-resource-dlc_update_data_engine_config_operation" +description: |- + Provides a resource to create a dlc update_data_engine_config_operation +--- + +# tencentcloud_dlc_update_data_engine_config_operation + +Provides a resource to create a dlc update_data_engine_config_operation + +## Example Usage + +```hcl +resource "tencentcloud_dlc_update_data_engine_config_operation" "update_data_engine_config_operation" { + data_engine_id = "DataEngine-o3lzpqpo" + data_engine_config_command = "UpdateSparkSQLLakefsPath" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_config_command` - (Required, String, ForceNew) Engine configuration command, supports UpdateSparkSQLLakefsPath (update native table configuration), UpdateSparkSQLResultPath (update result path configuration). +* `data_engine_id` - (Required, String, ForceNew) Engine unique id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dlc_update_row_filter_operation.html.markdown b/config/docs/r/dlc_update_row_filter_operation.html.markdown new file mode 100644 index 0000000..9cc1b5e --- /dev/null +++ b/config/docs/r/dlc_update_row_filter_operation.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_update_row_filter_operation" +sidebar_current: "docs-tencentcloud-resource-dlc_update_row_filter_operation" +description: |- + Provides a resource to create a dlc update_row_filter_operation +--- + +# tencentcloud_dlc_update_row_filter_operation + +Provides a resource to create a dlc update_row_filter_operation + +## Example Usage + +```hcl +resource "tencentcloud_dlc_update_row_filter_operation" "update_row_filter_operation" { + policy_id = 103704 + policy { + database = "test_iac_keep" + catalog = "DataLakeCatalog" + table = "test_table" + operation = "value!=\"0\"" + policy_type = "ROWFILTER" + function = "" + view = "" + column = "" + source = "USER" + mode = "SENIOR" + re_auth = false + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy_id` - (Required, Int, ForceNew) The id of the row filtering policy. +* `policy` - (Required, List, ForceNew) New filtering strategy. + +The `policy` object supports the following: + +* `catalog` - (Required, String) For the data source name that requires authorization, only * (representing all resources at this level) is supported under the administrator level; in the case of data source level and database level authentication, only COSDataCatalog or * is supported; in data table level authentication, it is possible Fill in the user-defined data source. If left blank, it defaults to DataLakeCatalog. note: If a user-defined data source is authenticated, the permissions that dlc can manage are a subset of the accounts provided by the user when accessing the data source. +* `database` - (Required, String) Database name that requires authorization, fill in * to represent all databases under the current catalog. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level, only blanks are allowed to be filled in. For other types, the database can be specified arbitrarily. +* `operation` - (Required, String) Authorized permission operations provide different operations for different levels of authentication. administrator permissions: ALL, default is ALL if left blank; data connection level authentication: CREATE; database level authentication: ALL, CREATE, ALTER, DROP; data table permissions: ALL, SELECT, INSERT, ALTER, DELETE, DROP, UPDATE. note: under data table permissions, only SELECT operations are supported when the specified data source is not COSDataCatalog. +* `table` - (Required, String) For the table name that requires authorization, fill in * to represent all tables under the current database. when the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. For other types, data tables can be specified arbitrarily. +* `column` - (Optional, String) For columns that require authorization, fill in * to represent all current columns. When the authorization type is administrator level, only * is allowed. +* `create_time` - (Optional, String) The time when the permission was created. Leave the input parameter blank. +* `data_engine` - (Optional, String) Data engines that require authorization, fill in * to represent all current engines. when the authorization type is administrator level, only * is allowed. +* `function` - (Optional, String) For the function name that requires authorization, fill in * to represent all functions under the current catalog. when the authorization type is administrator level, only * is allowed to be filled in. When the authorization type is data connection level, only blanks are allowed to be filled in. in other types, functions can be specified arbitrarily. +* `id` - (Optional, Int) Policy id. +* `mode` - (Optional, String) Authorization mode, please leave this parameter blank. COMMON: normal mode; SENIOR: advanced mode. +* `operator` - (Optional, String) Operator, do not fill in the input parameters. +* `policy_type` - (Optional, String) Authorization type, currently supports eight authorization types: ADMIN: Administrator level authentication DATASOURCE: data connection level authentication DATABASE: database level authentication TABLE: Table level authentication VIEW: view level authentication FUNCTION: Function level authentication COLUMN: Column level authentication ENGINE: Data engine authentication. if left blank, the default is administrator level authentication. +* `re_auth` - (Optional, Bool) Whether the user can perform secondary authorization. when it is true, the authorized user can re-authorize the permissions obtained this time to other sub-users. default is false. +* `source_id` - (Optional, Int) The id of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the Source field is WORKGROUP. +* `source_name` - (Optional, String) The name of the workgroup to which the permission belongs. this value only exists when the source of the permission is a workgroup. that is, this field has a value only when the value of the source field is WORKGROUP. +* `source` - (Optional, String) Permission source, please leave it blank. USER: permissions come from the user itself; WORKGROUP: permissions come from the bound workgroup. +* `view` - (Optional, String) For views that require authorization, fill in * to represent all views under the current database. When the authorization type is administrator level, only * is allowed to be filled in. when the authorization type is data connection level or database level, only blanks are allowed to be filled in. for other types, the view can be specified arbitrarily. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dlc_upgrade_data_engine_image_operation.html.markdown b/config/docs/r/dlc_upgrade_data_engine_image_operation.html.markdown new file mode 100644 index 0000000..457aa85 --- /dev/null +++ b/config/docs/r/dlc_upgrade_data_engine_image_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_upgrade_data_engine_image_operation" +sidebar_current: "docs-tencentcloud-resource-dlc_upgrade_data_engine_image_operation" +description: |- + Provides a resource to create a dlc upgrade_data_engine_image_operation +--- + +# tencentcloud_dlc_upgrade_data_engine_image_operation + +Provides a resource to create a dlc upgrade_data_engine_image_operation + +## Example Usage + +```hcl +resource "tencentcloud_dlc_upgrade_data_engine_image_operation" "upgrade_data_engine_image_operation" { + data_engine_id = "DataEngine-g5ds87d8" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_id` - (Required, String, ForceNew) Engine unique id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dlc_user.html.markdown b/config/docs/r/dlc_user.html.markdown new file mode 100644 index 0000000..cc6e887 --- /dev/null +++ b/config/docs/r/dlc_user.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_user" +sidebar_current: "docs-tencentcloud-resource-dlc_user" +description: |- + Provides a resource to create a dlc user +--- + +# tencentcloud_dlc_user + +Provides a resource to create a dlc user + +## Example Usage + +```hcl +resource "tencentcloud_dlc_user" "user" { + user_id = "100027012454" + user_type = "COMMON" + user_alias = "terraform-test" + user_description = "for terraform test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `user_id` - (Required, String, ForceNew) The sub-user uin that needs to be authorized. +* `user_alias` - (Optional, String) User alias, the character length is less than 50. +* `user_description` - (Optional, String) User description information, easy to distinguish between different users. +* `user_type` - (Optional, String) User Type. `ADMIN` or `COMMONN`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `work_group_ids` - A collection of workgroup IDs bound to the user. + + +## Import + +dlc user can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_user.user user_id +``` + diff --git a/config/docs/r/dlc_user_data_engine_config.html.markdown b/config/docs/r/dlc_user_data_engine_config.html.markdown new file mode 100644 index 0000000..4c16f48 --- /dev/null +++ b/config/docs/r/dlc_user_data_engine_config.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_user_data_engine_config" +sidebar_current: "docs-tencentcloud-resource-dlc_user_data_engine_config" +description: |- + Provides a resource to create a dlc user_data_engine_config +--- + +# tencentcloud_dlc_user_data_engine_config + +Provides a resource to create a dlc user_data_engine_config + +## Example Usage + +```hcl +resource "tencentcloud_dlc_user_data_engine_config" "user_data_engine_config" { + data_engine_id = "DataEngine-cgkvbas6" + data_engine_config_pairs { + config_item = "qq" + config_value = "ff" + } + session_resource_template { + driver_size = "small" + executor_size = "small" + executor_nums = 1 + executor_max_numbers = 1 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_engine_id` - (Required, String) Engine unique id. +* `data_engine_config_pairs` - (Optional, List) Engine configuration items. +* `session_resource_template` - (Optional, List) Job engine resource configuration template. + +The `data_engine_config_pairs` object supports the following: + +* `config_item` - (Required, String) Config key. +* `config_value` - (Required, String) Config value. + +The `session_resource_template` object supports the following: + +* `driver_size` - (Optional, String) Engine driver size specification only supports: small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge. +* `executor_max_numbers` - (Optional, Int) Specify the executor max number (in a dynamic configuration scenario), the minimum value is 1, and the maximum value is less than the cluster specification (when ExecutorMaxNumbers is less than ExecutorNums, the value is set to ExecutorNums). +* `executor_nums` - (Optional, Int) Specify the number of executors. The minimum value is 1 and the maximum value is less than the cluster specification. +* `executor_size` - (Optional, String) Engine executor size specification only supports: small/medium/large/xlarge/m.small/m.medium/m.large/m.xlarge. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dlc user_data_engine_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_user_data_engine_config.user_data_engine_config user_data_engine_config_id +``` + diff --git a/config/docs/r/dlc_work_group.html.markdown b/config/docs/r/dlc_work_group.html.markdown new file mode 100644 index 0000000..91a50d5 --- /dev/null +++ b/config/docs/r/dlc_work_group.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Data Lake Compute(DLC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dlc_work_group" +sidebar_current: "docs-tencentcloud-resource-dlc_work_group" +description: |- + Provides a resource to create a dlc work_group +--- + +# tencentcloud_dlc_work_group + +Provides a resource to create a dlc work_group + +## Example Usage + +```hcl +resource "tencentcloud_dlc_work_group" "work_group" { + work_group_name = "tf-demo" + work_group_description = "dlc workgroup test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `work_group_name` - (Required, String, ForceNew) Name of Work Group. +* `work_group_description` - (Optional, String) Description of Work Group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `user_ids` - A collection of user IDs that has been bound to the workgroup. + + +## Import + +dlc work_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_dlc_work_group.work_group work_group_id +``` + diff --git a/config/docs/r/dnat.html.markdown b/config/docs/r/dnat.html.markdown new file mode 100644 index 0000000..85c7be1 --- /dev/null +++ b/config/docs/r/dnat.html.markdown @@ -0,0 +1,122 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnat" +sidebar_current: "docs-tencentcloud-resource-dnat" +description: |- + Provides a resource to create a NAT forwarding. +--- + +# tencentcloud_dnat + +Provides a resource to create a NAT forwarding. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +data "tencentcloud_images" "example" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + name = "example-vpc" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_eip" "eip_example" { + name = "tf_nat_gateway_eip" +} + +resource "tencentcloud_nat_gateway" "example" { + name = "tf_example_nat_gateway" + vpc_id = tencentcloud_vpc.vpc.id + bandwidth = 100 + max_concurrent = 1000000 + assigned_eip_set = [ + tencentcloud_eip.eip_example.public_ip, + ] + tags = { + tf_tag_key = "tf_tag_value" + } +} + +resource "tencentcloud_instance" "example" { + instance_name = "tf_example_instance" + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + image_id = data.tencentcloud_images.example.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + allocate_public_ip = true + internet_max_bandwidth_out = 10 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_dnat" "example" { + vpc_id = tencentcloud_vpc.vpc.id + nat_id = tencentcloud_nat_gateway.example.id + protocol = "TCP" + elastic_ip = tencentcloud_eip.eip_example.public_ip + elastic_port = 80 + private_ip = tencentcloud_instance.example.private_ip + private_port = 9090 + description = "desc." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `elastic_ip` - (Required, String, ForceNew) Network address of the EIP. +* `elastic_port` - (Required, String, ForceNew) Port of the EIP. +* `nat_id` - (Required, String, ForceNew) ID of the NAT gateway. +* `private_ip` - (Required, String, ForceNew) Network address of the backend service. +* `private_port` - (Required, String, ForceNew) Port of intranet. +* `protocol` - (Required, String, ForceNew) Type of the network protocol. Valid value: `TCP` and `UDP`. +* `vpc_id` - (Required, String, ForceNew) ID of the VPC. +* `description` - (Optional, String) Description of the NAT forward. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +NAT forwarding can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_dnat.foo tcp://vpc-asg3sfa3:nat-1asg3t63@127.15.2.3:8080 +``` + diff --git a/config/docs/r/dnspod_custom_line.html.markdown b/config/docs/r/dnspod_custom_line.html.markdown new file mode 100644 index 0000000..b17e54c --- /dev/null +++ b/config/docs/r/dnspod_custom_line.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_custom_line" +sidebar_current: "docs-tencentcloud-resource-dnspod_custom_line" +description: |- + Provides a resource to create a dnspod custom_line +--- + +# tencentcloud_dnspod_custom_line + +Provides a resource to create a dnspod custom_line + +~> **NOTE:** Terraform uses the combined id of doamin and name when importing. When the name changes, the combined id will also change. + +## Example Usage + +```hcl +resource "tencentcloud_dnspod_custom_line" "custom_line" { + domain = "dnspod.com" + name = "testline8" + area = "6.6.6.1-6.6.6.2" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `area` - (Required, String) The IP segment of custom line, split with `-`. +* `domain` - (Required, String, ForceNew) Domain. +* `name` - (Required, String) The Name of custom line. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dnspod custom_line can be imported using the id, e.g. + +``` +terraform import tencentcloud_dnspod_custom_line.custom_line domain#name +``` + diff --git a/config/docs/r/dnspod_domain_alias.html.markdown b/config/docs/r/dnspod_domain_alias.html.markdown new file mode 100644 index 0000000..23762bb --- /dev/null +++ b/config/docs/r/dnspod_domain_alias.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_domain_alias" +sidebar_current: "docs-tencentcloud-resource-dnspod_domain_alias" +description: |- + Provides a resource to create a dnspod domain_alias +--- + +# tencentcloud_dnspod_domain_alias + +Provides a resource to create a dnspod domain_alias + +## Example Usage + +```hcl +resource "tencentcloud_dnspod_domain_alias" "domain_alias" { + domain_alias = "dnspod.com" + domain = "dnspod.cn" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_alias` - (Required, String, ForceNew) Domain alias. +* `domain` - (Required, String, ForceNew) Domain. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `domain_alias_id` - Domain alias ID. + + +## Import + +dnspod domain_alias can be imported using the id, e.g. + +``` +terraform import tencentcloud_dnspod_domain_alias.domain_alias domain#domain_alias_id +``` + diff --git a/config/docs/r/dnspod_domain_instance.html.markdown b/config/docs/r/dnspod_domain_instance.html.markdown new file mode 100644 index 0000000..c92143a --- /dev/null +++ b/config/docs/r/dnspod_domain_instance.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_domain_instance" +sidebar_current: "docs-tencentcloud-resource-dnspod_domain_instance" +description: |- + Provide a resource to create a DnsPod Domain instance. +--- + +# tencentcloud_dnspod_domain_instance + +Provide a resource to create a DnsPod Domain instance. + +## Example Usage + +```hcl +resource "tencentcloud_dnspod_domain_instance" "foo" { + domain = "hello.com" + remark = "this is demo" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) The Domain. +* `group_id` - (Optional, Int, ForceNew) The Group Id of Domain. +* `is_mark` - (Optional, String, ForceNew) Whether to Mark the Domain. +* `remark` - (Optional, String) The remark of Domain. +* `status` - (Optional, String) The status of Domain. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the domain. + + +## Import + +DnsPod Domain instance can be imported, e.g. + +``` +$ terraform import tencentcloud_dnspod_domain_instance.foo domain +``` + diff --git a/config/docs/r/dnspod_domain_lock.html.markdown b/config/docs/r/dnspod_domain_lock.html.markdown new file mode 100644 index 0000000..fc9efa5 --- /dev/null +++ b/config/docs/r/dnspod_domain_lock.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_domain_lock" +sidebar_current: "docs-tencentcloud-resource-dnspod_domain_lock" +description: |- + Provides a resource to create a dnspod domain_lock +--- + +# tencentcloud_dnspod_domain_lock + +Provides a resource to create a dnspod domain_lock + +## Example Usage + +```hcl +resource "tencentcloud_dnspod_domain_lock" "domain_lock" { + domain = "dnspod.cn" + lock_days = 30 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Domain name. +* `lock_days` - (Required, Int, ForceNew) The number of max days to lock the domain+ Old packages: D_FREE 30 days, D_PLUS 90 days, D_EXTRA 30 days, D_EXPERT 60 days, D_ULTRA 365 days+ New packages: DP_FREE 365 days, DP_PLUS 365 days, DP_EXTRA 365 days, DP_EXPERT 365 days, DP_ULTRA 365 days. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `lock_code` - Domain unlock code, can be obtained through the ModifyDomainLock interface. + + diff --git a/config/docs/r/dnspod_download_snapshot_operation.html.markdown b/config/docs/r/dnspod_download_snapshot_operation.html.markdown new file mode 100644 index 0000000..648407d --- /dev/null +++ b/config/docs/r/dnspod_download_snapshot_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_download_snapshot_operation" +sidebar_current: "docs-tencentcloud-resource-dnspod_download_snapshot_operation" +description: |- + Provides a resource to create a dnspod download_snapshot +--- + +# tencentcloud_dnspod_download_snapshot_operation + +Provides a resource to create a dnspod download_snapshot + +## Example Usage + +```hcl +resource "tencentcloud_dnspod_download_snapshot_operation" "download_snapshot" { + domain = "dnspod.cn" + snapshot_id = "456" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Domain. +* `snapshot_id` - (Required, String, ForceNew) Snapshot ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `cos_url` - Snapshot download url. + + diff --git a/config/docs/r/dnspod_modify_domain_owner_operation.html.markdown b/config/docs/r/dnspod_modify_domain_owner_operation.html.markdown new file mode 100644 index 0000000..3d2d39b --- /dev/null +++ b/config/docs/r/dnspod_modify_domain_owner_operation.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_modify_domain_owner_operation" +sidebar_current: "docs-tencentcloud-resource-dnspod_modify_domain_owner_operation" +description: |- + Provides a resource to create a dnspod modify_domain_owner +--- + +# tencentcloud_dnspod_modify_domain_owner_operation + +Provides a resource to create a dnspod modify_domain_owner + +## Example Usage + +```hcl +resource "tencentcloud_dnspod_modify_domain_owner_operation" "modify_domain_owner" { + domain = "dnspod.cn" + account = "xxxxxxxxx" + domain_id = 123 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account` - (Required, String, ForceNew) The account to which the domain needs to be transferred, supporting Uin or email format. +* `domain` - (Required, String, ForceNew) Domain. +* `domain_id` - (Optional, Int, ForceNew) Domain ID. The parameter DomainId has a higher priority than the parameter Domain. If the parameter DomainId is passed, the parameter Domain will be ignored. You can find all Domains and DomainIds through the DescribeDomainList interface. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dnspod_modify_record_group_operation.html.markdown b/config/docs/r/dnspod_modify_record_group_operation.html.markdown new file mode 100644 index 0000000..ddd88c1 --- /dev/null +++ b/config/docs/r/dnspod_modify_record_group_operation.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_modify_record_group_operation" +sidebar_current: "docs-tencentcloud-resource-dnspod_modify_record_group_operation" +description: |- + Provides a resource to create a dnspod tencentcloud_dnspod_modify_record_group_operation +--- + +# tencentcloud_dnspod_modify_record_group_operation + +Provides a resource to create a dnspod tencentcloud_dnspod_modify_record_group_operation + +## Example Usage + +```hcl +resource "tencentcloud_dnspod_modify_record_group_operation" "modify_record_group" { + domain = "dnspod.cn" + group_id = 1 + record_id = "234|345" + domain_id = 123 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Domain. +* `group_id` - (Required, Int, ForceNew) Record Group ID. +* `record_id` - (Required, String, ForceNew) Record ID, multiple IDs are separated by a vertical line |. +* `domain_id` - (Optional, Int, ForceNew) Domain ID. The parameter DomainId has a higher priority than the parameter Domain. If the parameter DomainId is passed, the parameter Domain will be ignored. You can find all Domains and DomainIds through the DescribeDomainList interface. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dnspod_record.html.markdown b/config/docs/r/dnspod_record.html.markdown new file mode 100644 index 0000000..87a9154 --- /dev/null +++ b/config/docs/r/dnspod_record.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_record" +sidebar_current: "docs-tencentcloud-resource-dnspod_record" +description: |- + Provide a resource to create a DnsPod record. +--- + +# tencentcloud_dnspod_record + +Provide a resource to create a DnsPod record. + +~> **NOTE:** Versions before v1.81.43 (including v1.81.43) do not support modifying remark or modifying remark has bug. + +## Example Usage + +```hcl +resource "tencentcloud_dnspod_record" "demo" { + domain = "mikatong.com" + record_type = "A" + record_line = "默认" + value = "1.2.3.9" + sub_domain = "demo" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) The Domain. +* `record_line` - (Required, String) The record line. +* `record_type` - (Required, String) The record type. +* `value` - (Required, String) The record value. +* `mx` - (Optional, Int) MX priority, valid when the record type is MX, range 1-20. Note: must set when record type equal MX. +* `remark` - (Optional, String) The Remark of record. +* `status` - (Optional, String) Records the initial state, with values ranging from ENABLE and DISABLE. The default is ENABLE, and if DISABLE is passed in, resolution will not take effect and the limits of load balancing will not be verified. +* `sub_domain` - (Optional, String) The host records, default value is `@`. +* `ttl` - (Optional, Int) TTL, the range is 1-604800, and the minimum value of different levels of domain names is different. Default is 600. +* `weight` - (Optional, Int) Weight information. An integer from 0 to 100. Only enterprise VIP domain names are available, 0 means off, does not pass this parameter, means that the weight information is not set. Default is 0. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `monitor_status` - The monitoring status of the record. + + +## Import + +DnsPod Domain record can be imported using the Domain#RecordId, e.g. + +``` +$ terraform import tencentcloud_dnspod_record.demo arunma.com#1194109872 +``` + diff --git a/config/docs/r/dnspod_record_group.html.markdown b/config/docs/r/dnspod_record_group.html.markdown new file mode 100644 index 0000000..8ab74e9 --- /dev/null +++ b/config/docs/r/dnspod_record_group.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_record_group" +sidebar_current: "docs-tencentcloud-resource-dnspod_record_group" +description: |- + Provides a resource to create a dnspod record_group +--- + +# tencentcloud_dnspod_record_group + +Provides a resource to create a dnspod record_group + +## Example Usage + +```hcl +resource "tencentcloud_dnspod_record_group" "record_group" { + domain = "dnspod.cn" + group_name = "group_demo" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Domain. +* `group_name` - (Required, String) Record Group Name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `group_id` - Group ID. + + +## Import + +dnspod record_group can be imported using the domain#groupId, e.g. + +``` +terraform import tencentcloud_dnspod_record_group.record_group domain#groupId +``` + diff --git a/config/docs/r/dnspod_snapshot_config.html.markdown b/config/docs/r/dnspod_snapshot_config.html.markdown new file mode 100644 index 0000000..4f0bd97 --- /dev/null +++ b/config/docs/r/dnspod_snapshot_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "DNSPOD" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dnspod_snapshot_config" +sidebar_current: "docs-tencentcloud-resource-dnspod_snapshot_config" +description: |- + Provides a resource to create a dnspod snapshot_config +--- + +# tencentcloud_dnspod_snapshot_config + +Provides a resource to create a dnspod snapshot_config + +## Example Usage + +```hcl +resource "tencentcloud_dnspod_snapshot_config" "snapshot_config" { + domain = "dnspod.cn" + period = "hourly" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Domain name. +* `period` - (Required, String) Backup interval: empty string - no backup, half_hour - every half hour, hourly - every hour, daily - every day, monthly - every month. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dnspod snapshot_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_dnspod_snapshot_config.snapshot_config domain +``` + diff --git a/config/docs/r/dts_compare_task.html.markdown b/config/docs/r/dts_compare_task.html.markdown new file mode 100644 index 0000000..8973f95 --- /dev/null +++ b/config/docs/r/dts_compare_task.html.markdown @@ -0,0 +1,80 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_compare_task" +sidebar_current: "docs-tencentcloud-resource-dts_compare_task" +description: |- + Provides a resource to create a dts compare_task +--- + +# tencentcloud_dts_compare_task + +Provides a resource to create a dts compare_task + +## Example Usage + +```hcl +resource "tencentcloud_dts_compare_task" "compare_task" { + job_id = "" + task_name = "" + object_mode = "" + objects { + object_mode = "" + object_items { + db_name = "" + db_mode = "" + schema_name = "" + table_mode = "" + tables { + table_name = "" + } + view_mode = "" + views { + view_name = "" + } + } + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String) job id. +* `object_mode` - (Optional, String) object mode. +* `objects` - (Optional, List) objects. +* `task_name` - (Optional, String) task name. + +The `object_items` object supports the following: + +* `db_mode` - (Optional, String) database mode. +* `db_name` - (Optional, String) database name. +* `schema_name` - (Optional, String) schema name. +* `table_mode` - (Optional, String) table mode. +* `tables` - (Optional, List) table list. +* `view_mode` - (Optional, String) view mode. +* `views` - (Optional, List) view list. + +The `objects` object supports the following: + +* `object_mode` - (Required, String) object mode. +* `object_items` - (Optional, List) object items. + +The `tables` object supports the following: + +* `table_name` - (Optional, String) table name. + +The `views` object supports the following: + +* `view_name` - (Optional, String) view name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `compare_task_id` - compare task id. + + diff --git a/config/docs/r/dts_compare_task_stop_operation.html.markdown b/config/docs/r/dts_compare_task_stop_operation.html.markdown new file mode 100644 index 0000000..56cc9f0 --- /dev/null +++ b/config/docs/r/dts_compare_task_stop_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_compare_task_stop_operation" +sidebar_current: "docs-tencentcloud-resource-dts_compare_task_stop_operation" +description: |- + Provides a resource to create a dts compare_task_stop_operation +--- + +# tencentcloud_dts_compare_task_stop_operation + +Provides a resource to create a dts compare_task_stop_operation + +## Example Usage + +```hcl +resource "tencentcloud_dts_compare_task_stop_operation" "compare_task_stop_operation" { + job_id = "dts-8yv4w2i1" + compare_task_id = "dts-8yv4w2i1-cmp-37skmii9" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `compare_task_id` - (Required, String, ForceNew) Compare task id. +* `job_id` - (Required, String, ForceNew) job id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_migrate_job.html.markdown b/config/docs/r/dts_migrate_job.html.markdown new file mode 100644 index 0000000..ec2a981 --- /dev/null +++ b/config/docs/r/dts_migrate_job.html.markdown @@ -0,0 +1,284 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_migrate_job" +sidebar_current: "docs-tencentcloud-resource-dts_migrate_job" +description: |- + Provides a resource to create a dts migrate_job +--- + +# tencentcloud_dts_migrate_job + +Provides a resource to create a dts migrate_job + +## Example Usage + +```hcl +resource "tencentcloud_cynosdb_cluster" "foo" { + available_zone = var.availability_zone + vpc_id = local.vpc_id + subnet_id = local.subnet_id + db_type = "MYSQL" + db_version = "5.7" + storage_limit = 1000 + cluster_name = "tf-cynosdb-mysql" + password = "cynos@123" + instance_maintain_duration = 3600 + instance_maintain_start_time = 10800 + instance_maintain_weekdays = [ + "Fri", + "Mon", + "Sat", + "Sun", + "Thu", + "Wed", + "Tue", + ] + + instance_cpu_core = 1 + instance_memory_size = 2 + param_items { + name = "character_set_server" + current_value = "utf8" + } + param_items { + name = "time_zone" + current_value = "+09:00" + } + param_items { + name = "lower_case_table_names" + current_value = "1" + } + + force_delete = true + + rw_group_sg = [ + local.sg_id + ] + ro_group_sg = [ + local.sg_id + ] + prarm_template_id = var.my_param_template +} + +resource "tencentcloud_dts_migrate_service" "service" { + src_database_type = "mysql" + dst_database_type = "cynosdbmysql" + src_region = "ap-guangzhou" + dst_region = "ap-guangzhou" + instance_class = "small" + job_name = "tf_test_migration_service_1" + tags { + tag_key = "aaa" + tag_value = "bbb" + } +} + +resource "tencentcloud_dts_migrate_job" "job" { + service_id = tencentcloud_dts_migrate_service.service.id + run_mode = "immediate" + migrate_option { + database_table { + object_mode = "partial" + databases { + db_name = "tf_ci_test" + db_mode = "partial" + table_mode = "partial" + tables { + table_name = "test" + new_table_name = "test_%s" + table_edit_mode = "rename" + } + } + } + } + src_info { + region = "ap-guangzhou" + access_type = "cdb" + database_type = "mysql" + node_type = "simple" + info { + user = "user_name" + password = "your_pw" + instance_id = "cdb-fitq5t9h" + } + + } + dst_info { + region = "ap-guangzhou" + access_type = "cdb" + database_type = "cynosdbmysql" + node_type = "simple" + info { + user = "user_name" + password = "your_pw" + instance_id = tencentcloud_cynosdb_cluster.foo.id + } + } + auto_retry_time_range_minutes = 0 +} + +resource "tencentcloud_dts_migrate_job_start_operation" "start" { + job_id = tencentcloud_dts_migrate_job.job.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dst_info` - (Required, List) DstInfo. +* `migrate_option` - (Required, List) Migration job configuration options, used to describe how the task performs migration. +* `run_mode` - (Required, String) Run Mode. eg:immediate,timed. +* `service_id` - (Required, String) Migrate service Id from `tencentcloud_dts_migrate_service`. +* `src_info` - (Required, List) SrcInfo. +* `auto_retry_time_range_minutes` - (Optional, Int) AutoRetryTimeRangeMinutes. +* `expect_run_time` - (Optional, String) ExpectRunTime. + +The `consistency` object supports the following: + +* `mode` - (Optional, String) ConsistencyOption. + +The `database_table` object supports the following: + +* `object_mode` - (Required, String) Object mode. eg:all,partial. +* `advanced_objects` - (Optional, Set) AdvancedObjects. +* `databases` - (Optional, List) The database list. + +The `databases` object supports the following: + +* `db_mode` - (Optional, String) DB selection mode:all (for all objects under the current object), partial (partial objects), when the ObjectMode is partial, this item is required. +* `db_name` - (Optional, String) database name. +* `event_mode` - (Optional, String) EventMode. +* `events` - (Optional, Set) Events. +* `function_mode` - (Optional, String) FunctionMode. +* `functions` - (Optional, Set) Functions. +* `new_db_name` - (Optional, String) New database name. +* `new_schema_name` - (Optional, String) schema name after migration or synchronization. +* `procedure_mode` - (Optional, String) ProcedureMode. +* `procedures` - (Optional, Set) Procedures. +* `role_mode` - (Optional, String) RoleMode. +* `roles` - (Optional, List) Roles. +* `schema_mode` - (Optional, String) schema mode: all,partial. +* `schema_name` - (Optional, String) schema name. +* `table_mode` - (Optional, String) table mode: all,partial. +* `tables` - (Optional, List) tables list. +* `trigger_mode` - (Optional, String) TriggerMode. +* `triggers` - (Optional, Set) Triggers. +* `view_mode` - (Optional, String) ViewMode. +* `views` - (Optional, List) Views. + +The `dst_info` object supports the following: + +* `access_type` - (Required, String) AccessType. +* `database_type` - (Required, String) DatabaseType. +* `info` - (Required, List) Info. +* `node_type` - (Required, String) NodeType. +* `region` - (Required, String) Region. +* `extra_attr` - (Optional, List) ExtraAttr. +* `supplier` - (Optional, String) Supplier. + +The `extra_attr` object supports the following: + +* `key` - (Optional, String) Key. +* `value` - (Optional, String) Value. + +The `info` object supports the following: + +* `account_mode` - (Optional, String) Account Mode. +* `account_role` - (Optional, String) Account Role. +* `account` - (Optional, String) Account. +* `ccn_gw_id` - (Optional, String) CcnGwId. +* `cvm_instance_id` - (Optional, String) CvmInstanceId. +* `db_kernel` - (Optional, String) DbKernel. +* `engine_version` - (Optional, String) Engine Version. +* `host` - (Optional, String) Host. +* `instance_id` - (Optional, String) InstanceId. +* `password` - (Optional, String) Password. +* `port` - (Optional, Int) Port. +* `role` - (Optional, String) Role. +* `subnet_id` - (Optional, String) SubnetId. +* `tmp_secret_id` - (Optional, String) Tmp SecretId. +* `tmp_secret_key` - (Optional, String) Tmp SecretKey. +* `tmp_token` - (Optional, String) Tmp Token. +* `uniq_dcg_id` - (Optional, String) UniqDcgId. +* `uniq_vpn_gw_id` - (Optional, String) UniqVpnGwId. +* `user` - (Optional, String) User. +* `vpc_id` - (Optional, String) VpcId. + +The `info` object supports the following: + +* `account_mode` - (Optional, String) AccountMode. +* `account_role` - (Optional, String) AccountRole. +* `account` - (Optional, String) Account. +* `ccn_gw_id` - (Optional, String) CcnGwId. +* `cvm_instance_id` - (Optional, String) CvmInstanceId. +* `db_kernel` - (Optional, String) DbKernel. +* `engine_version` - (Optional, String) EngineVersion. +* `host` - (Optional, String) Host. +* `instance_id` - (Optional, String) InstanceId. +* `password` - (Optional, String) Password. +* `port` - (Optional, Int) Port. +* `role` - (Optional, String) Role. +* `subnet_id` - (Optional, String) SubnetId. +* `tmp_secret_id` - (Optional, String) TmpSecretId. +* `tmp_secret_key` - (Optional, String) TmpSecretKey. +* `tmp_token` - (Optional, String) TmpToken. +* `uniq_dcg_id` - (Optional, String) UniqDcgId. +* `uniq_vpn_gw_id` - (Optional, String) UniqVpnGwId. +* `user` - (Optional, String) User. +* `vpc_id` - (Optional, String) VpcId. + +The `migrate_option` object supports the following: + +* `database_table` - (Required, List) Migration object option, you need to tell the migration service which library table objects to migrate. +* `consistency` - (Optional, List) Consistency. +* `extra_attr` - (Optional, List) ExtraAttr. +* `is_dst_read_only` - (Optional, Bool) IsDstReadOnly. +* `is_migrate_account` - (Optional, Bool) IsMigrateAccount. +* `is_override_root` - (Optional, Bool) IsOverrideRoot. +* `migrate_type` - (Optional, String) MigrateType. + +The `roles` object supports the following: + +* `new_role_name` - (Optional, String) NewRoleName. +* `role_name` - (Optional, String) RoleName. + +The `src_info` object supports the following: + +* `access_type` - (Required, String) AccessType. +* `database_type` - (Required, String) DatabaseType. +* `info` - (Required, List) Info. +* `node_type` - (Required, String) NodeType. +* `region` - (Required, String) Region. +* `extra_attr` - (Optional, List) ExtraAttr. +* `supplier` - (Optional, String) Supplier. + +The `tables` object supports the following: + +* `new_table_name` - (Optional, String) new table name. +* `table_edit_mode` - (Optional, String) table edit mode. +* `table_name` - (Optional, String) table name. +* `tmp_tables` - (Optional, Set) temporary tables. + +The `views` object supports the following: + +* `new_view_name` - (Optional, String) NewViewName. +* `view_name` - (Optional, String) ViewName. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - Migrate job status. + + +## Import + +dts migrate_job can be imported using the id, e.g. + +``` +terraform import tencentcloud_dts_migrate_job.migrate_job migrate_config_id +``` + diff --git a/config/docs/r/dts_migrate_job_config.html.markdown b/config/docs/r/dts_migrate_job_config.html.markdown new file mode 100644 index 0000000..9c9ba91 --- /dev/null +++ b/config/docs/r/dts_migrate_job_config.html.markdown @@ -0,0 +1,145 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_migrate_job_config" +sidebar_current: "docs-tencentcloud-resource-dts_migrate_job_config" +description: |- + Provides a resource to create a dts migrate_job_config +--- + +# tencentcloud_dts_migrate_job_config + +Provides a resource to create a dts migrate_job_config + +## Example Usage + +```hcl +resource "tencentcloud_dts_migrate_service" "service" { + src_database_type = "mysql" + dst_database_type = "cynosdbmysql" + src_region = "ap-guangzhou" + dst_region = "ap-guangzhou" + instance_class = "small" + job_name = "tf_test_xxx" + tags { + tag_key = "aaa" + tag_value = "bbb" + } +} + +resource "tencentcloud_dts_migrate_job" "job" { + service_id = tencentcloud_dts_migrate_service.service.id + run_mode = "immediate" + migrate_option { + database_table { + object_mode = "partial" + databases { + db_name = "tf_ci_test" + db_mode = "partial" + table_mode = "partial" + tables { + table_name = "test" + new_table_name = "test_xxx" + table_edit_mode = "rename" + } + } + } + } + src_info { + region = "ap-guangzhou" + access_type = "cdb" + database_type = "mysql" + node_type = "simple" + info { + user = "root" + password = "xxx" + instance_id = "id" + } + + } + dst_info { + region = "ap-guangzhou" + access_type = "cdb" + database_type = "cynosdbmysql" + node_type = "simple" + info { + user = "user" + password = "xxx" + instance_id = "id" + } + } + auto_retry_time_range_minutes = 0 +} + +resource "tencentcloud_dts_migrate_job_start_operation" "start" { + job_id = tencentcloud_dts_migrate_job.job.id +} + +// pause the migration job +resource "tencentcloud_dts_migrate_job_config" "config" { + job_id = tencentcloud_dts_migrate_job_start_operation.start.id + action = "pause" +} +``` + +### Continue the a migration job + +```hcl +resource "tencentcloud_dts_migrate_job_config" "config" { + job_id = tencentcloud_dts_migrate_job_start_operation.start.id + action = "continue" +} +``` + +### Complete a migration job when the status is readyComplete + +```hcl +resource "tencentcloud_dts_migrate_job_config" "config" { + job_id = tencentcloud_dts_migrate_job_start_operation.start.id + action = "continue" +} +``` + +### Stop a running migration job + +```hcl +resource "tencentcloud_dts_migrate_job_config" "config" { + job_id = tencentcloud_dts_migrate_job_start_operation.start.id + action = "stop" +} +``` + +### Isolate a stopped/canceled migration job + +```hcl +resource "tencentcloud_dts_migrate_job_config" "config" { + job_id = tencentcloud_dts_migrate_job_start_operation.start.id + action = "isolate" +} +``` + +### Recover a isolated migration job + +```hcl +resource "tencentcloud_dts_migrate_job_config" "config" { + job_id = tencentcloud_dts_migrate_job_start_operation.start.id + action = "recover" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `action` - (Required, String) The operation want to perform. Valid values are: `pause`, `continue`, `complete`, `recover`,`stop`. +* `job_id` - (Required, String) job id. +* `complete_mode` - (Optional, String) complete mode, optional value is waitForSync or immediately. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_migrate_job_resume_operation.html.markdown b/config/docs/r/dts_migrate_job_resume_operation.html.markdown new file mode 100644 index 0000000..e5d4c11 --- /dev/null +++ b/config/docs/r/dts_migrate_job_resume_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_migrate_job_resume_operation" +sidebar_current: "docs-tencentcloud-resource-dts_migrate_job_resume_operation" +description: |- + Provides a resource to create a dts migrate_job_resume_operation +--- + +# tencentcloud_dts_migrate_job_resume_operation + +Provides a resource to create a dts migrate_job_resume_operation + +## Example Usage + +```hcl +resource "tencentcloud_dts_migrate_job_resume_operation" "resume" { + job_id = "job_id" + resume_option = "normal" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) job id. +* `resume_option` - (Required, String, ForceNew) resume mode: 1.clearData-Clear target data; 2.overwrite-The task is executed in overwrite mode; 3.normal-No extra action. Note that clearData and overwrite are valid only for redis links, normal is valid only for non-Redis links. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_migrate_job_start_operation.html.markdown b/config/docs/r/dts_migrate_job_start_operation.html.markdown new file mode 100644 index 0000000..59d0f7f --- /dev/null +++ b/config/docs/r/dts_migrate_job_start_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_migrate_job_start_operation" +sidebar_current: "docs-tencentcloud-resource-dts_migrate_job_start_operation" +description: |- + Provides a resource to start a dts migrate_job +--- + +# tencentcloud_dts_migrate_job_start_operation + +Provides a resource to start a dts migrate_job + +## Example Usage + +```hcl +resource "tencentcloud_dts_migrate_job_start_operation" "start" { + job_id = tencentcloud_dts_migrate_job.job.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Job Id from `tencentcloud_dts_migrate_job`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_migrate_service.html.markdown b/config/docs/r/dts_migrate_service.html.markdown new file mode 100644 index 0000000..1ad60dc --- /dev/null +++ b/config/docs/r/dts_migrate_service.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_migrate_service" +sidebar_current: "docs-tencentcloud-resource-dts_migrate_service" +description: |- + Provides a resource to create a dts migrate_service +--- + +# tencentcloud_dts_migrate_service + +Provides a resource to create a dts migrate_service + +## Example Usage + +```hcl +resource "tencentcloud_dts_migrate_service" "migrate_service" { + src_database_type = "mysql" + dst_database_type = "cynosdbmysql" + src_region = "ap-guangzhou" + dst_region = "ap-guangzhou" + instance_class = "small" + job_name = "tf_test_migration_job" + tags { + tag_key = "aaa" + tag_value = "bbb" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dst_database_type` - (Required, String) destination database type, optional value is mysql/redis/percona/mongodb/postgresql/sqlserver/mariadb. +* `dst_region` - (Required, String) destination region. +* `instance_class` - (Required, String) instance class, optional value is small/medium/large/xlarge/2xlarge. +* `src_database_type` - (Required, String) source database type, optional value is mysql/redis/percona/mongodb/postgresql/sqlserver/mariadb. +* `src_region` - (Required, String) source region. +* `job_name` - (Optional, String) job name. +* `tags` - (Optional, List) tags. + +The `tags` object supports the following: + +* `tag_key` - (Optional, String) tag key. +* `tag_value` - (Optional, String) tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dts migrate_service can be imported using the id, e.g. +``` +$ terraform import tencentcloud_dts_migrate_service.migrate_service migrateService_id +``` + diff --git a/config/docs/r/dts_sync_check_job_operation.html.markdown b/config/docs/r/dts_sync_check_job_operation.html.markdown new file mode 100644 index 0000000..8875864 --- /dev/null +++ b/config/docs/r/dts_sync_check_job_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_check_job_operation" +sidebar_current: "docs-tencentcloud-resource-dts_sync_check_job_operation" +description: |- + Provides a resource to create a dts sync_check_job_operation +--- + +# tencentcloud_dts_sync_check_job_operation + +Provides a resource to create a dts sync_check_job_operation + +## Example Usage + +```hcl +resource "tencentcloud_dts_sync_check_job_operation" "sync_check_job_operation" { + job_id = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Sync job id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_sync_config.html.markdown b/config/docs/r/dts_sync_config.html.markdown new file mode 100644 index 0000000..3c4d608 --- /dev/null +++ b/config/docs/r/dts_sync_config.html.markdown @@ -0,0 +1,355 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_config" +sidebar_current: "docs-tencentcloud-resource-dts_sync_config" +description: |- + Provides a resource to create a dts sync_config +--- + +# tencentcloud_dts_sync_config + +Provides a resource to create a dts sync_config + +## Example Usage + +### Sync mysql database to cynosdb through cdb access type + +```hcl +resource "tencentcloud_cynosdb_cluster" "foo" { + available_zone = var.availability_zone + vpc_id = local.vpc_id + subnet_id = local.subnet_id + db_type = "MYSQL" + db_version = "5.7" + storage_limit = 1000 + cluster_name = "tf-cynosdb-mysql-sync-dst" + password = "*" + instance_maintain_duration = 3600 + instance_maintain_start_time = 10800 + instance_maintain_weekdays = [ + "Fri", + "Mon", + "Sat", + "Sun", + "Thu", + "Wed", + "Tue", + ] + + instance_cpu_core = 1 + instance_memory_size = 2 + param_items { + name = "character_set_server" + current_value = "utf8" + } + param_items { + name = "time_zone" + current_value = "+09:00" + } + param_items { + name = "lower_case_table_names" + current_value = "1" + } + + force_delete = true + + rw_group_sg = [ + local.sg_id + ] + ro_group_sg = [ + local.sg_id + ] + prarm_template_id = var.my_param_template +} + +resource "tencentcloud_dts_sync_job" "sync_job" { + pay_mode = "PostPay" + src_database_type = "mysql" + src_region = "ap-guangzhou" + dst_database_type = "cynosdbmysql" + dst_region = "ap-guangzhou" + tags { + tag_key = "aaa" + tag_value = "bbb" + } + auto_renew = 0 + instance_class = "micro" +} + +resource "tencentcloud_dts_sync_config" "sync_config" { + job_id = tencentcloud_dts_sync_job.sync_job.job_id + src_access_type = "cdb" + dst_access_type = "cdb" + + job_name = "tf_test_sync_config" + job_mode = "liteMode" + run_mode = "Immediate" + + objects { + mode = "Partial" + databases { + db_name = "tf_ci_test" + new_db_name = "tf_ci_test_new" + db_mode = "Partial" + table_mode = "All" + tables { + table_name = "test" + new_table_name = "test_new" + } + } + } + src_info { + region = "ap-guangzhou" + instance_id = "cdb-fitq5t9h" + user = "your_user_name" + password = "*" + db_name = "tf_ci_test" + vpc_id = local.vpc_id + subnet_id = local.subnet_id + } + dst_info { + region = "ap-guangzhou" + instance_id = tencentcloud_cynosdb_cluster.foo.id + user = "root" + password = "*" + db_name = "tf_ci_test_new" + vpc_id = local.vpc_id + subnet_id = local.subnet_id + } + auto_retry_time_range_minutes = 0 +} +``` + +### Sync mysql database using CCN to route from ap-shanghai to ap-guangzhou + +```hcl +locals { + vpc_id_sh = "vpc-evtcyb3g" + subnet_id_sh = "subnet-1t83cxkp" + src_ip = data.tencentcloud_mysql_instance.src_mysql.instance_list.0.intranet_ip + src_port = data.tencentcloud_mysql_instance.src_mysql.instance_list.0.intranet_port + ccn_id = data.tencentcloud_ccn_instances.ccns.instance_list.0.ccn_id + dst_mysql_id = data.tencentcloud_mysql_instance.dst_mysql.instance_list.0.mysql_id +} + +variable "src_az_sh" { + default = "ap-shanghai" +} + +variable "dst_az_gz" { + default = "ap-guangzhou" +} + +data "tencentcloud_dts_sync_jobs" "sync_jobs" { + job_name = "keep_sync_config_ccn_2_cdb" +} + +data "tencentcloud_ccn_instances" "ccns" { + name = "keep-ccn-dts-sh" +} + +data "tencentcloud_mysql_instance" "src_mysql" { + instance_name = "your_user_name_mysql_src" +} + +data "tencentcloud_mysql_instance" "dst_mysql" { + instance_name = "your_user_name_mysql_src" +} + +resource "tencentcloud_dts_sync_config" "sync_config" { + job_id = data.tencentcloud_dts_sync_jobs.sync_jobs.list.0.job_id + src_access_type = "ccn" + dst_access_type = "cdb" + + job_mode = "liteMode" + run_mode = "Immediate" + + objects { + mode = "Partial" + databases { + db_name = "tf_ci_test" + new_db_name = "tf_ci_test_new" + db_mode = "Partial" + table_mode = "All" + tables { + table_name = "test" + new_table_name = "test_new" + } + } + } + src_info { // shanghai to guangzhou via ccn + region = var.src_az_sh + user = "your_user_name" + password = "your_pass_word" + ip = local.src_ip + port = local.src_port + vpc_id = local.vpc_id_sh + subnet_id = local.subnet_id_sh + ccn_id = local.ccn_id + database_net_env = "TencentVPC" + } + dst_info { + region = var.dst_az_gz + instance_id = local.dst_mysql_id + user = "your_user_name" + password = "your_pass_word" + } + auto_retry_time_range_minutes = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dst_access_type` - (Required, String) Target end access type, cdb (cloud database), cvm (cloud host self-built), vpc (private network), extranet (external network), vpncloud (vpn access), dcg (dedicated line access), ccn (cloud networking ), intranet (self-developed cloud), noProxy, note that the specific optional value depends on the current link. +* `job_id` - (Required, String) Synchronization instance id (i.e. identifies a synchronization job). +* `objects` - (Required, List) Synchronize database table object information. +* `src_access_type` - (Required, String) Source access type, cdb (cloud database), cvm (cloud host self-built), vpc (private network), extranet (external network), vpncloud (vpn access), dcg (dedicated line access), ccn (cloud networking ), intranet (self-developed cloud), noProxy, note that the specific optional value depends on the current link. +* `auto_retry_time_range_minutes` - (Optional, Int) The time period of automatic retry, can be set from 5 to 720 minutes, 0 means no retry. +* `dst_info` - (Optional, List) Target information, single-node database use. +* `expect_run_time` - (Optional, String) Expected start time, when the value of RunMode is Timed, this value is required, such as: 2006-01-02 15:04:05. +* `job_mode` - (Optional, String) The enumeration values are liteMode and fullMode, corresponding to lite mode or normal mode respectively. +* `job_name` - (Optional, String) Sync job name. +* `options` - (Optional, List) Sync Task Options. +* `run_mode` - (Optional, String) Operation mode, such as: Immediate (indicates immediate operation, the default value is this value), Timed (indicates scheduled operation). +* `src_info` - (Optional, List) Source information, single-node database use. + +The `conflict_handle_option` object supports the following: + +* `condition_column` - (Optional, String) Columns covered by the condition. Note: This field may return null, indicating that no valid value can be obtained. +* `condition_operator` - (Optional, String) Conditional Override Operation. Note: This field may return null, indicating that no valid value can be obtained. +* `condition_order_in_src_and_dst` - (Optional, String) Conditional Override Priority Processing. Note: This field may return null, indicating that no valid value can be obtained. + +The `databases` object supports the following: + +* `db_mode` - (Optional, String) DB selection mode: All (for all objects under the current object), Partial (for some objects), when the Mode is Partial, this item is required. Note that synchronization of advanced objects does not depend on this value. Note: This field may return null, indicating that no valid value can be obtained. +* `db_name` - (Optional, String) The name of the library that needs to be migrated or synchronized. This item is required when the ObjectMode is Partial. Note: This field may return null, indicating that no valid value can be obtained. +* `event_mode` - (Optional, String) Event migration mode, all (for all objects under the current object), partial (partial objects). Note: This field may return null, indicating that no valid value can be obtained. +* `events` - (Optional, Set) When EventMode is partial, specify the name of the event to be migrated. Note: This field may return null, indicating that no valid value can be obtained. +* `function_mode` - (Optional, String) Select the mode to be synchronized, Partial is a part, all is an entire selection. Note: This field may return null, indicating that no valid value can be obtained. +* `functions` - (Optional, Set) Required when the FunctionMode value is Partial. Note: This field may return null, indicating that no valid value can be obtained. +* `new_db_name` - (Optional, String) The name of the library after migration or synchronization, which is the same as the source library by default. Note: This field may return null, indicating that no valid value can be obtained. +* `new_schema_name` - (Optional, String) Schema name after migration or synchronization. Note: This field may return null, indicating that no valid value can be obtained. +* `procedure_mode` - (Optional, String) Select the mode to be synchronized, Partial is part, All is the whole selection. Note: This field may return null, indicating that no valid value can be obtained. +* `procedures` - (Optional, Set) Required when the value of ProcedureMode is Partial. Note: This field may return null, indicating that no valid value can be obtained. +* `schema_name` - (Optional, String) Migrated or synchronized schemaNote: This field may return null, indicating that no valid value can be obtained. +* `table_mode` - (Optional, String) Table selection mode: All (for all objects under the current object), Partial (for some objects), this item is required when the DBMode is Partial. Note: This field may return null, indicating that no valid value can be obtained. +* `tables` - (Optional, List) A collection of table graph objects, when TableMode is Partial, this item needs to be filled in. Note: This field may return null, indicating that no valid value can be obtained. +* `trigger_mode` - (Optional, String) Trigger migration mode, all (for all objects under the current object), partial (partial objects). Note: This field may return null, indicating that no valid value can be obtained. +* `triggers` - (Optional, Set) When TriggerMode is partial, specify the name of the trigger to be migrated. Note: This field may return null, indicating that no valid value can be obtained. +* `view_mode` - (Optional, String) View selection mode: All is all view objects under the current object, Partial is part of the view objects. Note: This field may return null, indicating that no valid value can be obtained. +* `views` - (Optional, List) View object collection, when ViewMode is Partial, this item needs to be filled in. Note: This field may return null, indicating that no valid value can be obtained. + +The `ddl_options` object supports the following: + +* `ddl_object` - (Optional, String) Ddl type, such as Database, Table, View, Index, etc. Note: This field may return null, indicating that no valid value can be obtained. +* `ddl_value` - (Optional, Set) The specific value of ddl, the possible values for Database [Create,Drop,Alter].The possible values for Table [Create,Drop,Alter,Truncate,Rename].The possible values for View[Create,Drop].For the possible values of Index [Create, Drop]. Note: This field may return null, indicating that no valid value can be obtained. + +The `dst_info` object supports the following: + +* `account_mode` - (Optional, String) The account to which the resource belongs is empty or self (represents resources within this account), other (represents cross-account resources). Note: This field may return null, indicating that no valid value can be obtained. +* `account_role` - (Optional, String) The role during cross-account synchronization, only [a-zA-Z0-9-_]+ is allowed, if it is a cross-account instance, this field is required. Note: This field may return null, indicating that no valid value can be obtained. +* `account` - (Optional, String) The account to which the instance belongs. This field is required if it is a cross-account instance. Note: This field may return null, indicating that no valid value can be obtained. +* `ccn_id` - (Optional, String) Cloud networking ID, which is required for the cloud networking access type. Note: This field may return null, indicating that no valid value can be obtained. +* `cvm_instance_id` - (Optional, String) CVM instance short ID, which is the same as the instance ID displayed on the cloud server console page. If it is a self-built instance of CVM, this field needs to be passed. Note: This field may return null, indicating that no valid value can be obtained. +* `database_net_env` - (Optional, String) The network environment to which the database belongs. It is required when AccessType is Cloud Network (CCN). `UserIDC` represents the user IDC. `TencentVPC` represents Tencent Cloud VPC. Note: This field may return null, indicating that no valid value can be obtained. +* `db_kernel` - (Optional, String) Database kernel type, used to distinguish different kernels in tdsql: percona, mariadb, mysql. Note: This field may return null, indicating that no valid value can be obtained. +* `db_name` - (Optional, String) Database name, when the database is cdwpg, it needs to be provided. Note: This field may return null, indicating that no valid value can be obtained. +* `encrypt_conn` - (Optional, String) Whether to use encrypted transmission, UnEncrypted means not to use encrypted transmission, Encrypted means to use encrypted transmission, the default is UnEncrypted. Note: This field may return null, indicating that no valid value can be obtained. +* `engine_version` - (Optional, String) Database version, valid only when the instance is an RDS instance, ignored by other instances, the format is: 5.6 or 5.7, the default is 5.6. Note: This field may return null, indicating that no valid value can be obtained. +* `instance_id` - (Optional, String) Database instance id. Note: This field may return null, indicating that no valid value can be obtained. +* `ip` - (Optional, String) The IP address of the instance, which is required when the access type is non-cdb. Note: This field may return null, indicating that no valid value can be obtained. +* `password` - (Optional, String) Password, required for instances that require username and password authentication for access. Note: This field may return null, indicating that no valid value can be obtained. +* `port` - (Optional, Int) Instance port, this item is required when the access type is non-cdb. Note: This field may return null, indicating that no valid value can be obtained. +* `region` - (Optional, String) The english name of region. Note: This field may return null, indicating that no valid value can be obtained. +* `role_external_id` - (Optional, String) External role id. Note: This field may return null, indicating that no valid value can be obtained. +* `role` - (Optional, String) The node type of tdsql mysql version, the enumeration value is proxy, set. Note: This field may return null, indicating that no valid value can be obtained. +* `subnet_id` - (Optional, String) The subnet ID under the private network, this item is required for the private network, leased line, and VPN access methods. Note: This field may return null, indicating that no valid value can be obtained. +* `supplier` - (Optional, String) Cloud vendor type, when the instance is an RDS instance, fill in aliyun, in other cases fill in others, the default is others. Note: This field may return null, indicating that no valid value can be obtained. +* `tmp_secret_id` - (Optional, String) Temporary key Id, required if it is a cross-account instance. Note: This field may return null, indicating that no valid value can be obtained. +* `tmp_secret_key` - (Optional, String) Temporary key Key, required if it is a cross-account instance. Note: This field may return null, indicating that no valid value can be obtained. +* `tmp_token` - (Optional, String) Temporary Token, required if it is a cross-account instance. Note: This field may return null, indicating that no valid value can be obtained. +* `uniq_dcg_id` - (Optional, String) Leased line gateway ID, which is required for the leased line access type. Note: This field may return null, indicating that no valid value can be obtained. +* `uniq_vpn_gw_id` - (Optional, String) VPN gateway ID, which is required for the VPN access type. Note: This field may return null, indicating that no valid value can be obtained. +* `user` - (Optional, String) Username, required for instances that require username and password authentication for access. Note: This field may return null, indicating that no valid value can be obtained. +* `vpc_id` - (Optional, String) Private network ID, which is required for access methods of private network, leased line, and VPN. Note: This field may return null, indicating that no valid value can be obtained. + +The `objects` object supports the following: + +* `advanced_objects` - (Optional, Set) For advanced object types, such as function and procedure, when an advanced object needs to be synchronized, the initialization type must include the structure initialization type, that is, the value of the Options.InitType field is Structure or Full. Note: This field may return null, indicating that no valid value can be obtained. +* `databases` - (Optional, List) Synchronization object, not null when Mode is Partial. Note: This field may return null, indicating that no valid value can be obtained. +* `mode` - (Optional, String) Migration object type Partial (partial object). Note: This field may return null, indicating that no valid value can be obtained. +* `online_ddl` - (Optional, List) OnlineDDL type. Note: This field may return null, indicating that no valid value can be obtained. + +The `online_ddl` object supports the following: + +* `status` - (Optional, String) status. + +The `options` object supports the following: + +* `add_additional_column` - (Optional, Bool) Whether to add additional columns. Note: This field may return null, indicating that no valid value can be obtained. +* `conflict_handle_option` - (Optional, List) Detailed options for conflict handling, such as conditional rows and conditional actions in conditional overrides. Note: This field may return null, indicating that no valid value can be obtained. +* `conflict_handle_type` - (Optional, String) Conflict handling options, ReportError (error report, the default value), Ignore (ignore), Cover (cover), ConditionCover (condition coverage). Note: This field may return null, indicating that no valid value can be obtained. +* `ddl_options` - (Optional, List) DDL synchronization options, specifically describe which DDLs to synchronize. Note: This field may return null, indicating that no valid value can be obtained. +* `deal_of_exist_same_table` - (Optional, String) The processing of the table with the same name, ReportErrorAfterCheck (pre-check and report error, default), InitializeAfterDelete (delete and re-initialize), ExecuteAfterIgnore (ignore and continue to execute). Note: This field may return null, indicating that no valid value can be obtained. +* `init_type` - (Optional, String) Synchronous initialization options, Data (full data initialization), Structure (structure initialization), Full (full data and structure initialization, default), None (incremental only). Note: This field may return null, indicating that no valid value can be obtained. +* `op_types` - (Optional, Set) DML and DDL options to be synchronized, Insert (insert operation), Update (update operation), Delete (delete operation), DDL (structure synchronization), leave blank (not selected), PartialDDL (custom, work with DdlOptions). Note: This field may return null, indicating that no valid value can be obtained. + +The `src_info` object supports the following: + +* `account_mode` - (Optional, String) The account to which the resource belongs is empty or self (represents resources within this account), other (represents cross-account resources). Note: This field may return null, indicating that no valid value can be obtained. +* `account_role` - (Optional, String) The role during cross-account synchronization, only [a-zA-Z0-9-_]+ is allowed, if it is a cross-account instance, this field is required. Note: This field may return null, indicating that no valid value can be obtained. +* `account` - (Optional, String) The account to which the instance belongs. This field is required if it is a cross-account instance. Note: This field may return null, indicating that no valid value can be obtained. +* `ccn_id` - (Optional, String) Cloud networking ID, which is required for the cloud networking access type. Note: This field may return null, indicating that no valid value can be obtained. +* `cvm_instance_id` - (Optional, String) CVM instance short ID, which is the same as the instance ID displayed on the cloud server console page. If it is a self-built instance of CVM, this field needs to be passed. Note: This field may return null, indicating that no valid value can be obtained. +* `database_net_env` - (Optional, String) The network environment to which the database belongs. It is required when AccessType is Cloud Network (CCN). `UserIDC` represents the user IDC. `TencentVPC` represents Tencent Cloud VPC. Note: This field may return null, indicating that no valid value can be obtained. +* `db_kernel` - (Optional, String) Database kernel type, used to distinguish different kernels in tdsql: percona, mariadb, mysql. Note: This field may return null, indicating that no valid value can be obtained. +* `db_name` - (Optional, String) Database name, when the database is cdwpg, it needs to be provided. Note: This field may return null, indicating that no valid value can be obtained. +* `encrypt_conn` - (Optional, String) Whether to use encrypted transmission, UnEncrypted means not to use encrypted transmission, Encrypted means to use encrypted transmission, the default is UnEncrypted. Note: This field may return null, indicating that no valid value can be obtained. +* `engine_version` - (Optional, String) Database version, valid only when the instance is an RDS instance, ignored by other instances, the format is: 5.6 or 5.7, the default is 5.6. Note: This field may return null, indicating that no valid value can be obtained. +* `instance_id` - (Optional, String) Database instance id. Note: This field may return null, indicating that no valid value can be obtained. +* `ip` - (Optional, String) The IP address of the instance, which is required when the access type is non-cdb. Note: This field may return null, indicating that no valid value can be obtained. +* `password` - (Optional, String) Password, required for instances that require username and password authentication for access. Note: This field may return null, indicating that no valid value can be obtained. +* `port` - (Optional, Int) Instance port, this item is required when the access type is non-cdb. Note: This field may return null, indicating that no valid value can be obtained. +* `region` - (Optional, String) The english name of region. Note: This field may return null, indicating that no valid value can be obtained. +* `role_external_id` - (Optional, String) External role id. Note: This field may return null, indicating that no valid value can be obtained. +* `role` - (Optional, String) The node type of tdsql mysql version, the enumeration value is proxy, set. Note: This field may return null, indicating that no valid value can be obtained. +* `subnet_id` - (Optional, String) The subnet ID under the private network, this item is required for the private network, leased line, and VPN access methods. Note: This field may return null, indicating that no valid value can be obtained. +* `supplier` - (Optional, String) Cloud vendor type, when the instance is an RDS instance, fill in aliyun, in other cases fill in others, the default is others. Note: This field may return null, indicating that no valid value can be obtained. +* `tmp_secret_id` - (Optional, String) Temporary key Id, required if it is a cross-account instance. Note: This field may return null, indicating that no valid value can be obtained. +* `tmp_secret_key` - (Optional, String) Temporary key Key, required if it is a cross-account instance. Note: This field may return null, indicating that no valid value can be obtained. +* `tmp_token` - (Optional, String) Temporary Token, required if it is a cross-account instance. Note: This field may return null, indicating that no valid value can be obtained. +* `uniq_dcg_id` - (Optional, String) Leased line gateway ID, which is required for the leased line access type. Note: This field may return null, indicating that no valid value can be obtained. +* `uniq_vpn_gw_id` - (Optional, String) VPN gateway ID, which is required for the VPN access type. Note: This field may return null, indicating that no valid value can be obtained. +* `user` - (Optional, String) Username, required for instances that require username and password authentication for access. Note: This field may return null, indicating that no valid value can be obtained. +* `vpc_id` - (Optional, String) Private network ID, which is required for access methods of private network, leased line, and VPN. Note: This field may return null, indicating that no valid value can be obtained. + +The `tables` object supports the following: + +* `filter_condition` - (Optional, String) Filter condition. Note: This field may return null, indicating that no valid value can be obtained. +* `new_table_name` - (Optional, String) New table name. Note: This field may return null, indicating that no valid value can be obtained. +* `table_name` - (Optional, String) Table name. Note: This field may return null, indicating that no valid value can be obtained. + +The `views` object supports the following: + +* `new_view_name` - (Optional, String) New view name. Note: This field may return null, indicating that no valid value can be obtained. +* `view_name` - (Optional, String) View name. Note: This field may return null, indicating that no valid value can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +dts sync_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_dts_sync_config.sync_config sync_config_id +``` + diff --git a/config/docs/r/dts_sync_job.html.markdown b/config/docs/r/dts_sync_job.html.markdown new file mode 100644 index 0000000..ef49cf9 --- /dev/null +++ b/config/docs/r/dts_sync_job.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_job" +sidebar_current: "docs-tencentcloud-resource-dts_sync_job" +description: |- + Provides a resource to create a dts sync_job +--- + +# tencentcloud_dts_sync_job + +Provides a resource to create a dts sync_job + +## Example Usage + +```hcl +resource "tencentcloud_dts_sync_job" "sync_job" { + pay_mode = "PostPay" + src_database_type = "mysql" + src_region = "ap-guangzhou" + dst_database_type = "cynosdbmysql" + dst_region = "ap-guangzhou" + tags { + tag_key = "aaa" + tag_value = "bbb" + } + auto_renew = 0 + instance_class = "micro" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dst_database_type` - (Required, String, ForceNew) destination database type. +* `dst_region` - (Required, String, ForceNew) destination region. +* `pay_mode` - (Required, String, ForceNew) pay mode, optional value is PrePay or PostPay. +* `src_database_type` - (Required, String, ForceNew) source database type. +* `src_region` - (Required, String, ForceNew) source region. +* `auto_renew` - (Optional, Int, ForceNew) auto renew. +* `existed_job_id` - (Optional, String, ForceNew) existed job id. +* `instance_class` - (Optional, String, ForceNew) instance class. +* `job_name` - (Optional, String, ForceNew) job name. +* `specification` - (Optional, String, ForceNew) specification. +* `tags` - (Optional, List, ForceNew) tags. + +The `tags` object supports the following: + +* `tag_key` - (Optional, String) tag key. +* `tag_value` - (Optional, String) tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `job_id` - job id. + + diff --git a/config/docs/r/dts_sync_job_continue_operation.html.markdown b/config/docs/r/dts_sync_job_continue_operation.html.markdown new file mode 100644 index 0000000..6c64586 --- /dev/null +++ b/config/docs/r/dts_sync_job_continue_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_job_continue_operation" +sidebar_current: "docs-tencentcloud-resource-dts_sync_job_continue_operation" +description: |- + Provides a resource to create a dts sync_job_continue_operation +--- + +# tencentcloud_dts_sync_job_continue_operation + +Provides a resource to create a dts sync_job_continue_operation + +## Example Usage + +```hcl +resource "tencentcloud_dts_sync_job_continue_operation" "sync_job_continue_operation" { + job_id = "sync-werwfs23" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Synchronization instance id (i.e. identifies a synchronization job). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_sync_job_isolate_operation.html.markdown b/config/docs/r/dts_sync_job_isolate_operation.html.markdown new file mode 100644 index 0000000..fcd1015 --- /dev/null +++ b/config/docs/r/dts_sync_job_isolate_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_job_isolate_operation" +sidebar_current: "docs-tencentcloud-resource-dts_sync_job_isolate_operation" +description: |- + Provides a resource to create a dts sync_job_isolate_operation +--- + +# tencentcloud_dts_sync_job_isolate_operation + +Provides a resource to create a dts sync_job_isolate_operation + +## Example Usage + +```hcl +resource "tencentcloud_dts_sync_job_isolate_operation" "sync_job_isolate_operation" { + job_id = "sync-werwfs23" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Synchronization instance id (i.e. identifies a synchronization job). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_sync_job_pause_operation.html.markdown b/config/docs/r/dts_sync_job_pause_operation.html.markdown new file mode 100644 index 0000000..66ed14f --- /dev/null +++ b/config/docs/r/dts_sync_job_pause_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_job_pause_operation" +sidebar_current: "docs-tencentcloud-resource-dts_sync_job_pause_operation" +description: |- + Provides a resource to create a dts sync_job_pause_operation +--- + +# tencentcloud_dts_sync_job_pause_operation + +Provides a resource to create a dts sync_job_pause_operation + +## Example Usage + +```hcl +resource "tencentcloud_dts_sync_job_pause_operation" "sync_job_pause_operation" { + job_id = "sync-werwfs23" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Synchronization instance id (i.e. identifies a synchronization job). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_sync_job_recover_operation.html.markdown b/config/docs/r/dts_sync_job_recover_operation.html.markdown new file mode 100644 index 0000000..491e88b --- /dev/null +++ b/config/docs/r/dts_sync_job_recover_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_job_recover_operation" +sidebar_current: "docs-tencentcloud-resource-dts_sync_job_recover_operation" +description: |- + Provides a resource to create a dts sync_job_recover_operation +--- + +# tencentcloud_dts_sync_job_recover_operation + +Provides a resource to create a dts sync_job_recover_operation + +## Example Usage + +```hcl +resource "tencentcloud_dts_sync_job_recover_operation" "sync_job_recover_operation" { + job_id = "sync-werwfs23" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Synchronization instance id (i.e. identifies a synchronization job). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_sync_job_resize_operation.html.markdown b/config/docs/r/dts_sync_job_resize_operation.html.markdown new file mode 100644 index 0000000..92f811b --- /dev/null +++ b/config/docs/r/dts_sync_job_resize_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_job_resize_operation" +sidebar_current: "docs-tencentcloud-resource-dts_sync_job_resize_operation" +description: |- + Provides a resource to create a dts sync_job_resize_operation +--- + +# tencentcloud_dts_sync_job_resize_operation + +Provides a resource to create a dts sync_job_resize_operation + +## Example Usage + +```hcl +resource "tencentcloud_dts_sync_job_resize_operation" "sync_job_resize_operation" { + job_id = "sync-werwfs23" + new_instance_class = "large" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Synchronization instance id (i.e. identifies a synchronization job). +* `new_instance_class` - (Required, String, ForceNew) Task specification. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_sync_job_resume_operation.html.markdown b/config/docs/r/dts_sync_job_resume_operation.html.markdown new file mode 100644 index 0000000..9f9e941 --- /dev/null +++ b/config/docs/r/dts_sync_job_resume_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_job_resume_operation" +sidebar_current: "docs-tencentcloud-resource-dts_sync_job_resume_operation" +description: |- + Provides a resource to create a dts sync_job_resume_operation +--- + +# tencentcloud_dts_sync_job_resume_operation + +Provides a resource to create a dts sync_job_resume_operation + +## Example Usage + +```hcl +resource "tencentcloud_dts_sync_job_resume_operation" "sync_job_resume_operation" { + job_id = "sync-werwfs23" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Synchronization instance id (i.e. identifies a synchronization job). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_sync_job_start_operation.html.markdown b/config/docs/r/dts_sync_job_start_operation.html.markdown new file mode 100644 index 0000000..9d8e28b --- /dev/null +++ b/config/docs/r/dts_sync_job_start_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_job_start_operation" +sidebar_current: "docs-tencentcloud-resource-dts_sync_job_start_operation" +description: |- + Provides a resource to create a dts sync_job_start_operation +--- + +# tencentcloud_dts_sync_job_start_operation + +Provides a resource to create a dts sync_job_start_operation + +## Example Usage + +```hcl +resource "tencentcloud_dts_sync_job_start_operation" "sync_job_start_operation" { + job_id = "sync-werwfs23" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Synchronization instance id (i.e. identifies a synchronization job). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/dts_sync_job_stop_operation.html.markdown b/config/docs/r/dts_sync_job_stop_operation.html.markdown new file mode 100644 index 0000000..53fd81a --- /dev/null +++ b/config/docs/r/dts_sync_job_stop_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Data Transmission Service(DTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_dts_sync_job_stop_operation" +sidebar_current: "docs-tencentcloud-resource-dts_sync_job_stop_operation" +description: |- + Provides a resource to create a dts sync_job_stop_operation +--- + +# tencentcloud_dts_sync_job_stop_operation + +Provides a resource to create a dts sync_job_stop_operation + +## Example Usage + +```hcl +resource "tencentcloud_dts_sync_job_stop_operation" "sync_job_stop_operation" { + job_id = "sync-werwfs23" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Synchronization instance id (i.e. identifies a synchronization job). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/eb_event_bus.html.markdown b/config/docs/r/eb_event_bus.html.markdown new file mode 100644 index 0000000..a584843 --- /dev/null +++ b/config/docs/r/eb_event_bus.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_event_bus" +sidebar_current: "docs-tencentcloud-resource-eb_event_bus" +description: |- + Provides a resource to create a eb event_bus +--- + +# tencentcloud_eb_event_bus + +Provides a resource to create a eb event_bus + +## Example Usage + +```hcl +resource "tencentcloud_eb_event_bus" "foo" { + event_bus_name = "tf-event_bus" + description = "event bus desc" + enable_store = false + save_days = 1 + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `event_bus_name` - (Required, String) Event set name, which can only contain letters, numbers, underscores, hyphens, starts with a letter and ends with a number or letter, 2~60 characters. +* `description` - (Optional, String) Event set description, unlimited character type, description within 200 characters. +* `enable_store` - (Optional, Bool) Whether the EB storage is enabled. +* `save_days` - (Optional, Int) EB storage duration. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +eb event_bus can be imported using the id, e.g. + +``` +terraform import tencentcloud_eb_event_bus.event_bus event_bus_id +``` + diff --git a/config/docs/r/eb_event_connector.html.markdown b/config/docs/r/eb_event_connector.html.markdown new file mode 100644 index 0000000..50443f1 --- /dev/null +++ b/config/docs/r/eb_event_connector.html.markdown @@ -0,0 +1,166 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_event_connector" +sidebar_current: "docs-tencentcloud-resource-eb_event_connector" +description: |- + Provides a resource to create a eb event_connector +--- + +# tencentcloud_eb_event_connector + +Provides a resource to create a eb event_connector + +~> **NOTE:** When the type is `apigw`, the import function is not supported. + +## Example Usage + +### Create ckafka event connector + +```hcl +data "tencentcloud_user_info" "foo" {} + +resource "tencentcloud_eb_event_bus" "foo" { + event_bus_name = "tf-event_bus" + description = "event bus desc" + enable_store = false + save_days = 1 + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_ckafka_instance" "kafka_instance" { + instance_name = "ckafka-instance-maz-tf-test" + zone_id = 100003 + multi_zone_flag = true + zone_ids = [100003, 100006] + period = 1 + vpc_id = var.vpc_id + subnet_id = var.subnet_id + msg_retention_time = 1300 + renew_flag = 0 + kafka_version = "1.1.1" + disk_size = 500 + disk_type = "CLOUD_BASIC" + + config { + auto_create_topic_enable = true + default_num_partitions = 3 + default_replication_factor = 3 + } + + dynamic_retention_config { + enable = 1 + } +} + +locals { + ckafka_id = tencentcloud_ckafka_instance.kafka_instance.id + uin = data.tencentcloud_user_info.foo.owner_uin +} + +resource "tencentcloud_eb_event_connector" "event_connector" { + event_bus_id = tencentcloud_eb_event_bus.foo.id + connection_name = "tf-event-connector" + description = "event connector desc1" + enable = true + type = "ckafka" + connection_description { + resource_description = "qcs::ckafka:ap-guangzhou:uin/${local.uin}:ckafkaId/uin/${local.uin}/${local.ckafka_id}" + ckafka_params { + offset = "latest" + topic_name = "dasdasd" + } + } +} +``` + +### Create api_gateway event connector + +```hcl +data "tencentcloud_user_info" "foo" {} + +resource "tencentcloud_eb_event_bus" "foo" { + event_bus_name = "tf-event_bus" + description = "event bus desc" + enable_store = false + save_days = 1 + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_api_gateway_service" "service" { + service_name = "tf-eb-service" + protocol = "http&https" + service_desc = "your nice service" + net_type = ["INNER", "OUTER"] + ip_version = "IPv4" +} + +locals { + uin = data.tencentcloud_user_info.foo.owner_uin + service_id = tencentcloud_api_gateway_service.service.id +} + +resource "tencentcloud_eb_event_connector" "event_connector" { + event_bus_id = tencentcloud_eb_event_bus.foo.id + connection_name = "tf-event-connector" + description = "event connector desc1" + enable = false + type = "apigw" + + connection_description { + resource_description = "qcs::apigw:ap-guangzhou:uin/${local.uin}:serviceid/${local.service_id}" + api_gw_params { + protocol = "HTTP" + method = "GET" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `connection_description` - (Required, List) Connector description. +* `connection_name` - (Required, String) connector name. +* `event_bus_id` - (Required, String, ForceNew) event bus Id. +* `description` - (Optional, String) description. +* `enable` - (Optional, Bool) switch. +* `type` - (Optional, String) type. + +The `api_gw_params` object supports the following: + +* `method` - (Required, String) POST. +* `protocol` - (Required, String) HTTPS. + +The `ckafka_params` object supports the following: + +* `offset` - (Required, String) kafka offset. +* `topic_name` - (Required, String) ckafka topic. + +The `connection_description` object supports the following: + +* `resource_description` - (Required, String) Resource qcs six-segment style, more reference [resource six-segment style](https://cloud.tencent.com/document/product/598/10606). +* `api_gw_params` - (Optional, List) apigw parameter,Note: This field may return null, indicating that no valid value can be obtained. +* `ckafka_params` - (Optional, List) ckafka parameter, note: this field may return null, indicating that no valid value can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +eb event_connector can be imported using the id, e.g. + +``` +terraform import tencentcloud_eb_event_connector.event_connector eventBusId#connectionId +``` + diff --git a/config/docs/r/eb_event_rule.html.markdown b/config/docs/r/eb_event_rule.html.markdown new file mode 100644 index 0000000..50eaa3f --- /dev/null +++ b/config/docs/r/eb_event_rule.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_event_rule" +sidebar_current: "docs-tencentcloud-resource-eb_event_rule" +description: |- + Provides a resource to create a eb event_rule +--- + +# tencentcloud_eb_event_rule + +Provides a resource to create a eb event_rule + +## Example Usage + +```hcl +resource "tencentcloud_eb_event_bus" "foo" { + event_bus_name = "tf-event_bus" + description = "event bus desc" + enable_store = false + save_days = 1 + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_eb_event_rule" "event_rule" { + event_bus_id = tencentcloud_eb_event_bus.foo.id + rule_name = "tf-event_rule" + description = "event rule desc" + enable = true + event_pattern = jsonencode( + { + source = "apigw.cloud.tencent" + type = [ + "connector:apigw", + ] + } + ) + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `event_bus_id` - (Required, String) event bus Id. +* `event_pattern` - (Required, String) Reference: [Event Mode](https://cloud.tencent.com/document/product/1359/56084). +* `rule_name` - (Required, String) Event rule name, which can only contain letters, numbers, underscores, hyphens, starts with a letter and ends with a number or letter, 2~60 characters. +* `description` - (Optional, String) Event set description, unlimited character type, description within 200 characters. +* `enable` - (Optional, Bool) Enable switch. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `rule_id` - event rule id. + + +## Import + +eb event_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_eb_event_rule.event_rule event_rule_id +``` + diff --git a/config/docs/r/eb_event_target.html.markdown b/config/docs/r/eb_event_target.html.markdown new file mode 100644 index 0000000..b4f98c2 --- /dev/null +++ b/config/docs/r/eb_event_target.html.markdown @@ -0,0 +1,166 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_event_target" +sidebar_current: "docs-tencentcloud-resource-eb_event_target" +description: |- + Provides a resource to create a eb event_target +--- + +# tencentcloud_eb_event_target + +Provides a resource to create a eb event_target + +## Example Usage + +### Create an event target of type scf + +```hcl +variable "zone" { + default = "ap-guangzhou" +} + +variable "namespace" { + default = "default" +} + +variable "function" { + default = "keep-1676351130" +} + +variable "function_version" { + default = "$LATEST" +} + +data "tencentcloud_cam_users" "foo" { +} + +resource "tencentcloud_eb_event_bus" "foo" { + event_bus_name = "tf-event_bus" + description = "event bus desc" + enable_store = false + save_days = 1 + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_eb_event_rule" "foo" { + event_bus_id = tencentcloud_eb_event_bus.foo.id + rule_name = "tf-event_rule" + description = "event rule desc" + enable = true + event_pattern = jsonencode( + { + source = "apigw.cloud.tencent" + type = [ + "connector:apigw", + ] + } + ) + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_eb_event_target" "scf_target" { + event_bus_id = tencentcloud_eb_event_bus.foo.id + rule_id = tencentcloud_eb_event_rule.foo.rule_id + type = "scf" + + target_description { + resource_description = "qcs::scf:${var.zone}:uin/${data.tencentcloud_cam_users.foo.user_list.0.uin}:namespace/${var.namespace}/function/${var.function}/${var.function_version}" + + scf_params { + batch_event_count = 1 + batch_timeout = 1 + enable_batch_delivery = true + } + } +} +``` + +### Create an event target of type ckafka + +```hcl +variable "ckafka" { + default = "ckafka-qzoeaqx8" +} + +resource "tencentcloud_eb_event_target" "ckafka_target" { + event_bus_id = tencentcloud_eb_event_bus.foo.id + rule_id = tencentcloud_eb_event_rule.foo.rule_id + type = "ckafka" + + target_description { + resource_description = "qcs::scf:${var.zone}:uin/${data.tencentcloud_cam_users.foo.user_list.0.uin}:ckafkaId/uin/${data.tencentcloud_cam_users.foo.user_list.0.uin}/${var.ckafka}" + + ckafka_target_params { + topic_name = "dasdasd" + + retry_policy { + max_retry_attempts = 360 + retry_interval = 60 + } + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `event_bus_id` - (Required, String) event bus id. +* `rule_id` - (Required, String) event rule id. +* `target_description` - (Required, List) target description. +* `type` - (Required, String) target type. + +The `ckafka_target_params` object supports the following: + +* `retry_policy` - (Required, List) retry strategy. +* `topic_name` - (Required, String) The ckafka topic to deliver to. + +The `es_target_params` object supports the following: + +* `index_prefix` - (Required, String) index prefix. +* `index_suffix_mode` - (Required, String) DTS index configuration. +* `net_mode` - (Required, String) network connection type. +* `output_mode` - (Required, String) DTS event configuration. +* `rotation_interval` - (Required, String) es log rotation granularity. +* `index_template_type` - (Optional, String) es template type. + +The `retry_policy` object supports the following: + +* `max_retry_attempts` - (Required, Int) Maximum number of retries. +* `retry_interval` - (Required, Int) Retry Interval Unit: Seconds. + +The `scf_params` object supports the following: + +* `batch_event_count` - (Optional, Int) Maximum number of events for batch delivery. +* `batch_timeout` - (Optional, Int) Maximum waiting time for bulk delivery. +* `enable_batch_delivery` - (Optional, Bool) Enable batch delivery. + +The `target_description` object supports the following: + +* `resource_description` - (Required, String) QCS resource six-stage format, more references [resource six-stage format](https://cloud.tencent.com/document/product/598/10606). +* `ckafka_target_params` - (Optional, List) Ckafka parameters. +* `es_target_params` - (Optional, List) ElasticSearch parameters. +* `scf_params` - (Optional, List) cloud function parameters. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +eb event_target can be imported using the id, e.g. + +``` +terraform import tencentcloud_eb_event_target.event_target event_target_id +``` + diff --git a/config/docs/r/eb_event_transform.html.markdown b/config/docs/r/eb_event_transform.html.markdown new file mode 100644 index 0000000..b95f4bb --- /dev/null +++ b/config/docs/r/eb_event_transform.html.markdown @@ -0,0 +1,154 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_event_transform" +sidebar_current: "docs-tencentcloud-resource-eb_event_transform" +description: |- + Provides a resource to create a eb eb_transform +--- + +# tencentcloud_eb_event_transform + +Provides a resource to create a eb eb_transform + +## Example Usage + +```hcl +resource "tencentcloud_eb_event_bus" "foo" { + event_bus_name = "tf-event_bus" + description = "event bus desc" + enable_store = false + save_days = 1 + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_eb_event_rule" "foo" { + event_bus_id = tencentcloud_eb_event_bus.foo.id + rule_name = "tf-event_rule" + description = "event rule desc" + enable = true + event_pattern = jsonencode( + { + source = "apigw.cloud.tencent" + type = [ + "connector:apigw", + ] + } + ) + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_eb_event_transform" "foo" { + event_bus_id = tencentcloud_eb_event_bus.foo.id + rule_id = tencentcloud_eb_event_rule.foo.rule_id + + transformations { + + extraction { + extraction_input_path = "$" + format = "JSON" + } + + transform { + output_structs { + key = "type" + value = "connector:ckafka" + value_type = "STRING" + } + output_structs { + key = "source" + value = "ckafka.cloud.tencent" + value_type = "STRING" + } + output_structs { + key = "region" + value = "ap-guangzhou" + value_type = "STRING" + } + output_structs { + key = "datacontenttype" + value = "application/json;charset=utf-8" + value_type = "STRING" + } + output_structs { + key = "status" + value = "-" + value_type = "STRING" + } + output_structs { + key = "data" + value = jsonencode( + { + Partition = 1 + msgBody = "Hello from Ckafka again!" + msgKey = "test" + offset = 37 + topic = "test-topic" + } + ) + value_type = "STRING" + } + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `event_bus_id` - (Required, String) event bus Id. +* `rule_id` - (Required, String) ruleId. +* `transformations` - (Required, List) A list of transformation rules, currently only one. + +The `etl_filter` object supports the following: + +* `filter` - (Required, String) Grammatical Rules are consistent. + +The `extraction` object supports the following: + +* `extraction_input_path` - (Required, String) JsonPath, if not specified, the default value $. +* `format` - (Required, String) Value: `TEXT`, `JSON`. +* `text_params` - (Optional, List) Only Text needs to be passed. + +The `output_structs` object supports the following: + +* `key` - (Required, String) Corresponding to the key in the output json. +* `value_type` - (Required, String) The data type of value, optional values: `STRING`, `NUMBER`, `BOOLEAN`, `NULL`, `SYS_VARIABLE`, `JSONPATH`. +* `value` - (Required, String) You can fill in the json-path and also support constants or built-in keyword date types. + +The `text_params` object supports the following: + +* `regex` - (Optional, String) Fill in the regular expression: length 128. +* `separator` - (Optional, String) `Comma`, `|`, `tab`, `space`, `newline`, `%`, `#`, the limit length is 1. + +The `transform` object supports the following: + +* `output_structs` - (Required, List) Describe how the data is transformed. + +The `transformations` object supports the following: + +* `etl_filter` - (Optional, List) Describe how to filter data. +* `extraction` - (Optional, List) Describe how to extract data. +* `transform` - (Optional, List) Describe how to convert data. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +eb eb_transform can be imported using the id, e.g. + +``` +terraform import tencentcloud_eb_event_transform.eb_transform eb_transform_id +``` + diff --git a/config/docs/r/eb_put_events.html.markdown b/config/docs/r/eb_put_events.html.markdown new file mode 100644 index 0000000..db8e869 --- /dev/null +++ b/config/docs/r/eb_put_events.html.markdown @@ -0,0 +1,70 @@ +--- +subcategory: "EventBridge(EB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eb_put_events" +sidebar_current: "docs-tencentcloud-resource-eb_put_events" +description: |- + Provides a resource to create a eb put_events +--- + +# tencentcloud_eb_put_events + +Provides a resource to create a eb put_events + +## Example Usage + +```hcl +resource "tencentcloud_eb_event_bus" "foo" { + event_bus_name = "tf-event_bus" + description = "event bus desc" + enable_store = false + save_days = 1 + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_eb_put_events" "put_events" { + event_list { + source = "ckafka.cloud.tencent" + data = jsonencode( + { + "topic" : "test-topic", + "Partition" : 1, + "offset" : 37, + "msgKey" : "test", + "msgBody" : "Hello from Ckafka again!" + } + ) + type = "connector:ckafka" + subject = "qcs::ckafka:ap-guangzhou:uin/1250000000:ckafkaId/uin/1250000000/ckafka-123456" + time = 1691572461939 + + } + event_bus_id = tencentcloud_eb_event_bus.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `event_bus_id` - (Required, String, ForceNew) event bus Id. +* `event_list` - (Required, List, ForceNew) event list. + +The `event_list` object supports the following: + +* `data` - (Required, String) Event data, the content is controlled by the system that created the event, the current datacontenttype only supports application/json;charset=utf-8, so this field is a json string. +* `source` - (Required, String) Event source information, new product reporting must comply with EB specifications. +* `subject` - (Required, String) Detailed description of the event source, customizable, optional. The cloud service defaults to the standard qcs resource representation syntax: qcs::dts:ap-guangzhou:appid/uin:xxx. +* `type` - (Required, String) Event type, customizable, optional. The cloud service writes COS:Created:PostObject by default, use: to separate the type field. +* `time` - (Optional, Int) The timestamp in milliseconds when the event occurred,time.Now().UnixNano()/1e6. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/eip.html.markdown b/config/docs/r/eip.html.markdown new file mode 100644 index 0000000..22c8e78 --- /dev/null +++ b/config/docs/r/eip.html.markdown @@ -0,0 +1,90 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eip" +sidebar_current: "docs-tencentcloud-resource-eip" +description: |- + Provides an EIP resource. +--- + +# tencentcloud_eip + +Provides an EIP resource. + +## Example Usage + +### Paid by the bandwidth package + +```hcl +resource "tencentcloud_eip" "foo" { + name = "awesome_gateway_ip" + bandwidth_package_id = "bwp-jtvzuky6" + internet_charge_type = "BANDWIDTH_PACKAGE" + type = "EIP" +} +``` + +### AntiDDos Eip + +```hcl +resource "tencentcloud_eip" "foo" { + name = "awesome_gateway_ip" + bandwidth_package_id = "bwp-4ocyia9s" + internet_charge_type = "BANDWIDTH_PACKAGE" + type = "AntiDDoSEIP" + anti_ddos_package_id = "xxxxxxxx" + + tags = { + "test" = "test" + } +} +``` + +### Eip With Network Egress + +```hcl +resource "tencentcloud_eip" "foo" { + name = "egress_eip" + egress = "center_egress2" + internet_charge_type = "BANDWIDTH_PACKAGE" + internet_service_provider = "CMCC" + internet_max_bandwidth_out = 1 + type = "EIP" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `anti_ddos_package_id` - (Optional, String) ID of anti DDos package, it must set when `type` is `AntiDDoSEIP`. +* `anycast_zone` - (Optional, String, ForceNew) The zone of anycast. Valid value: `ANYCAST_ZONE_GLOBAL` and `ANYCAST_ZONE_OVERSEAS`. +* `applicable_for_clb` - (Optional, Bool, **Deprecated**) It has been deprecated from version 1.27.0. Indicates whether the anycast eip can be associated to a CLB. +* `auto_renew_flag` - (Optional, Int) Auto renew flag. 0 - default state (manual renew); 1 - automatic renew; 2 - explicit no automatic renew. NOTES: Only supported prepaid EIP. +* `bandwidth_package_id` - (Optional, String) ID of bandwidth package, it will set when `internet_charge_type` is `BANDWIDTH_PACKAGE`. +* `egress` - (Optional, String) Network egress. It defaults to `center_egress1`. If you want to try the egress feature, please [submit a ticket](https://console.cloud.tencent.com/workorder/category). +* `internet_charge_type` - (Optional, String) The charge type of eip. Valid values: `BANDWIDTH_PACKAGE`, `BANDWIDTH_POSTPAID_BY_HOUR`, `BANDWIDTH_PREPAID_BY_MONTH` and `TRAFFIC_POSTPAID_BY_HOUR`. +* `internet_max_bandwidth_out` - (Optional, Int) The bandwidth limit of EIP, unit is Mbps. +* `internet_service_provider` - (Optional, String, ForceNew) Internet service provider of eip. Valid value: `BGP`, `CMCC`, `CTCC` and `CUCC`. +* `name` - (Optional, String) The name of eip. +* `prepaid_period` - (Optional, Int) Period of instance. Default value: `1`. Valid value: `1`, `2`, `3`, `4`, `6`, `7`, `8`, `9`, `12`, `24`, `36`. NOTES: must set when `internet_charge_type` is `BANDWIDTH_PREPAID_BY_MONTH`. +* `tags` - (Optional, Map) The tags of eip. +* `type` - (Optional, String, ForceNew) The type of eip. Valid value: `EIP` and `AnycastEIP` and `HighQualityEIP` and `AntiDDoSEIP`. Default is `EIP`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `public_ip` - The elastic IP address. +* `status` - The EIP current status. + + +## Import + +EIP can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_eip.foo eip-nyvf60va +``` + diff --git a/config/docs/r/eip_address_transform.html.markdown b/config/docs/r/eip_address_transform.html.markdown new file mode 100644 index 0000000..c6ca203 --- /dev/null +++ b/config/docs/r/eip_address_transform.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eip_address_transform" +sidebar_current: "docs-tencentcloud-resource-eip_address_transform" +description: |- + Provides a resource to create a eip address_transform +--- + +# tencentcloud_eip_address_transform + +Provides a resource to create a eip address_transform + +## Example Usage + +```hcl +resource "tencentcloud_eip_address_transform" "address_transform" { + instance_id = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) the instance ID of a normal public network IP to be operated. eg:ins-23mk45jn. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +eip address_transform can be imported using the id, e.g. + +``` +terraform import tencentcloud_eip_address_transform.address_transform address_transform_id +``` + diff --git a/config/docs/r/eip_association.html.markdown b/config/docs/r/eip_association.html.markdown new file mode 100644 index 0000000..bd1293b --- /dev/null +++ b/config/docs/r/eip_association.html.markdown @@ -0,0 +1,143 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eip_association" +sidebar_current: "docs-tencentcloud-resource-eip_association" +description: |- + Provides an eip resource associated with other resource like CVM, ENI and CLB. +--- + +# tencentcloud_eip_association + +Provides an eip resource associated with other resource like CVM, ENI and CLB. + +~> **NOTE:** Please DO NOT define `allocate_public_ip` in `tencentcloud_instance` resource when using `tencentcloud_eip_association`. + +## Example Usage + +### Bind elastic public IP By Instance ID + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + image_name_regex = "Final" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_vpc" "vpc" { + name = "example-vpc" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + name = "example-vpc" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_eip" "eip" { + name = "example-eip" + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + type = "EIP" +} + +resource "tencentcloud_instance" "example" { + instance_name = "example-cvm" + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + image_id = data.tencentcloud_images.image.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + disable_security_service = true + disable_monitor_service = true + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_eip_association" "example" { + eip_id = tencentcloud_eip.eip.id + instance_id = tencentcloud_instance.example.id +} +``` + +### Bind elastic public IP By elastic network card + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +resource "tencentcloud_vpc" "vpc" { + name = "example-vpc" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + name = "example-vpc" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_eni" "eni" { + name = "example-eni" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + description = "eni desc" + ipv4_count = 1 +} + +resource "tencentcloud_eip" "eip" { + name = "example-eip" + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + type = "EIP" +} + +resource "tencentcloud_eip_association" "example" { + eip_id = tencentcloud_eip.eip.id + network_interface_id = tencentcloud_eni.eni.id + private_ip = tencentcloud_eni.eni.ipv4_info[0].ip +} +``` + +## Argument Reference + +The following arguments are supported: + +* `eip_id` - (Required, String, ForceNew) The ID of EIP. +* `instance_id` - (Optional, String, ForceNew) The CVM or CLB instance id going to bind with the EIP. This field is conflict with `network_interface_id` and `private_ip fields`. +* `network_interface_id` - (Optional, String, ForceNew) Indicates the network interface id like `eni-xxxxxx`. This field is conflict with `instance_id`. +* `private_ip` - (Optional, String, ForceNew) Indicates an IP belongs to the `network_interface_id`. This field is conflict with `instance_id`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Eip association can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_eip_association.bar eip-41s6jwy4::ins-34jwj3 +``` + diff --git a/config/docs/r/eip_normal_address_return.html.markdown b/config/docs/r/eip_normal_address_return.html.markdown new file mode 100644 index 0000000..215739e --- /dev/null +++ b/config/docs/r/eip_normal_address_return.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eip_normal_address_return" +sidebar_current: "docs-tencentcloud-resource-eip_normal_address_return" +description: |- + Provides a resource to create a vpc normal_address_return +--- + +# tencentcloud_eip_normal_address_return + +Provides a resource to create a vpc normal_address_return + +## Example Usage + +```hcl +resource "tencentcloud_eip_normal_address_return" "normal_address_return" { + address_ips = +} +``` + +## Argument Reference + +The following arguments are supported: + +* `address_ips` - (Optional, Set: [`String`], ForceNew) The IP address of the EIP, example: 101.35.139.183. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/eip_public_address_adjust.html.markdown b/config/docs/r/eip_public_address_adjust.html.markdown new file mode 100644 index 0000000..181178d --- /dev/null +++ b/config/docs/r/eip_public_address_adjust.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eip_public_address_adjust" +sidebar_current: "docs-tencentcloud-resource-eip_public_address_adjust" +description: |- + Provides a resource to create a eip public_address_adjust +--- + +# tencentcloud_eip_public_address_adjust + +Provides a resource to create a eip public_address_adjust + +## Example Usage + +```hcl +resource "tencentcloud_eip_public_address_adjust" "public_address_adjust" { + instance_id = "ins-cr2rfq78" + address_id = "eip-erft45fu" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `address_id` - (Optional, String, ForceNew) A unique ID that identifies an EIP instance. The unique ID of EIP is in the form:`eip-erft45fu`. +* `instance_id` - (Optional, String, ForceNew) A unique ID that identifies the CVM instance. The unique ID of CVM is in the form:`ins-osckfnm7`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/elasticsearch_diagnose.html.markdown b/config/docs/r/elasticsearch_diagnose.html.markdown new file mode 100644 index 0000000..88edf0d --- /dev/null +++ b/config/docs/r/elasticsearch_diagnose.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_diagnose" +sidebar_current: "docs-tencentcloud-resource-elasticsearch_diagnose" +description: |- + Provides a resource to create a elasticsearch diagnose +--- + +# tencentcloud_elasticsearch_diagnose + +Provides a resource to create a elasticsearch diagnose + +## Example Usage + +```hcl +resource "tencentcloud_elasticsearch_diagnose" "diagnose" { + instance_id = "es-xxxxxx" + cron_time = "15:00:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance id. +* `cron_time` - (Optional, String) Intelligent operation and maintenance staff regularly patrol the inspection time every day, the time format is HH:00:00, such as 15:00:00. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `diagnose_job_metas` - Diagnostic items and meta-information of intelligent operation and maintenance. + * `job_description` - Intelligent operation and maintenance diagnostic item description. + * `job_name` - English name of diagnosis item for intelligent operation and maintenance. + * `job_zh_name` - Chinese name of intelligent operation and maintenance diagnosis item. +* `max_count` - The maximum number of manual triggers per day for intelligent operation and maintenance staff. + + +## Import + +es diagnose can be imported using the id, e.g. + +``` +terraform import tencentcloud_elasticsearch_diagnose.diagnose diagnose_id +``` + diff --git a/config/docs/r/elasticsearch_diagnose_instance.html.markdown b/config/docs/r/elasticsearch_diagnose_instance.html.markdown new file mode 100644 index 0000000..3af5932 --- /dev/null +++ b/config/docs/r/elasticsearch_diagnose_instance.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_diagnose_instance" +sidebar_current: "docs-tencentcloud-resource-elasticsearch_diagnose_instance" +description: |- + Provides a resource to create a elasticsearch diagnose instance +--- + +# tencentcloud_elasticsearch_diagnose_instance + +Provides a resource to create a elasticsearch diagnose instance + +## Example Usage + +```hcl +resource "tencentcloud_elasticsearch_diagnose_instance" "diagnose_instance" { + instance_id = "es-xxxxxx" + diagnose_jobs = ["cluster_health"] + diagnose_indices = "*" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance id. +* `diagnose_indices` - (Optional, String, ForceNew) Indexes that need to be diagnosed. Wildcards are supported. +* `diagnose_jobs` - (Optional, Set: [`String`], ForceNew) Diagnostic items that need to be triggered. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/elasticsearch_index.html.markdown b/config/docs/r/elasticsearch_index.html.markdown new file mode 100644 index 0000000..78bd356 --- /dev/null +++ b/config/docs/r/elasticsearch_index.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_index" +sidebar_current: "docs-tencentcloud-resource-elasticsearch_index" +description: |- + Provides a resource to create a elasticsearch index +--- + +# tencentcloud_elasticsearch_index + +Provides a resource to create a elasticsearch index + +## Example Usage + +```hcl +resource "tencentcloud_elasticsearch_index" "index" { + instance_id = "es-xxxxxx" + index_type = "normal" + index_name = "test-es-index" + index_meta_json = "{\"mappings\":{},\"settings\":{\"index.number_of_replicas\":1,\"index.number_of_shards\":1,\"index.refresh_interval\":\"30s\"}}" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `index_name` - (Required, String) index name to create. +* `index_type` - (Required, String) type of the index to be created. auto: autonomous index. normal: indicates a common index. +* `instance_id` - (Required, String) es instance id. +* `index_meta_json` - (Optional, String) Create index metadata JSON, such as mappings, settings. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +elasticsearch index can be imported using the id, e.g. + +``` +terraform import tencentcloud_elasticsearch_index.index index_id +``` + diff --git a/config/docs/r/elasticsearch_instance.html.markdown b/config/docs/r/elasticsearch_instance.html.markdown new file mode 100644 index 0000000..dabb9fe --- /dev/null +++ b/config/docs/r/elasticsearch_instance.html.markdown @@ -0,0 +1,219 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_instance" +sidebar_current: "docs-tencentcloud-resource-elasticsearch_instance" +description: |- + Provides an elasticsearch instance resource. +--- + +# tencentcloud_elasticsearch_instance + +Provides an elasticsearch instance resource. + +## Example Usage + +### Create a basic version of elasticsearch instance paid by the hour + +```hcl +data "tencentcloud_availability_zones_by_product" "availability_zone" { + product = "es" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_es_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_availability_zones_by_product.availability_zone.zones.0.name + name = "tf_es_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_elasticsearch_instance" "example" { + instance_name = "tf_example_es" + availability_zone = data.tencentcloud_availability_zones_by_product.availability_zone.zones.0.name + version = "7.10.1" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + password = "Test12345" + license_type = "basic" + basic_security_type = 2 + + web_node_type_info { + node_num = 1 + node_type = "ES.S1.MEDIUM4" + } + + node_info_list { + node_num = 2 + node_type = "ES.S1.MEDIUM8" + encrypt = false + } + + es_acl { + # black_list = [ + # "9.9.9.9", + # "8.8.8.8", + # ] + white_list = [ + "127.0.0.1", + ] + } + + tags = { + test = "test" + } +} +``` + +### Create a basic version of elasticsearch instance for multi-availability zone deployment + +```hcl +data "tencentcloud_availability_zones_by_product" "availability_zone" { + product = "es" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_es_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_availability_zones_by_product.availability_zone.zones.0.name + name = "tf_es_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_subnet" "subnet_multi_zone" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_availability_zones_by_product.availability_zone.zones.1.name + name = "tf_es_subnet" + cidr_block = "10.0.2.0/24" +} + +resource "tencentcloud_elasticsearch_instance" "example_multi_zone" { + instance_name = "tf_example_es" + availability_zone = "-" + version = "7.10.1" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = "-" + password = "Test12345" + license_type = "basic" + basic_security_type = 2 + deploy_mode = 1 + + multi_zone_infos { + availability_zone = data.tencentcloud_availability_zones_by_product.availability_zone.zones.0.name + subnet_id = tencentcloud_subnet.subnet.id + } + + multi_zone_infos { + availability_zone = data.tencentcloud_availability_zones_by_product.availability_zone.zones.1.name + subnet_id = tencentcloud_subnet.subnet_multi_zone.id + } + + web_node_type_info { + node_num = 1 + node_type = "ES.S1.MEDIUM4" + } + + node_info_list { + type = "dedicatedMaster" + node_num = 3 + node_type = "ES.S1.MEDIUM8" + encrypt = false + } + + node_info_list { + type = "hotData" + node_num = 2 + node_type = "ES.S1.MEDIUM8" + encrypt = false + } + + es_acl { + # black_list = [ + # "9.9.9.9", + # "8.8.8.8", + # ] + white_list = [ + "127.0.0.1", + ] + } + + tags = { + test = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `node_info_list` - (Required, List) Node information list, which is used to describe the specification information of various types of nodes in the cluster, such as node type, node quantity, node specification, disk type, and disk size. +* `password` - (Required, String) Password to an instance, the password needs to be 8 to 16 characters, including at least two items ([a-z,A-Z], [0-9] and [-!@#$%&^*+=_:;,.?] special symbols. +* `version` - (Required, String) Version of the instance. Valid values are `5.6.4`, `6.4.3`, `6.8.2`, `7.5.1` and `7.10.1`. +* `vpc_id` - (Required, String, ForceNew) The ID of a VPC network. +* `availability_zone` - (Optional, String, ForceNew) Availability zone. When create multi-az es, this parameter must be omitted or `-`. +* `basic_security_type` - (Optional, Int) Whether to enable X-Pack security authentication in Basic Edition 6.8 and above. Valid values are `1` and `2`. `1` is disabled, `2` is enabled, and default value is `1`. Notice: this parameter is only take effect on `basic` license. +* `charge_period` - (Optional, Int, ForceNew) The tenancy of the prepaid instance, and uint is month. NOTE: it only works when charge_type is set to `PREPAID`. +* `charge_type` - (Optional, String, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. +* `deploy_mode` - (Optional, Int, ForceNew) Cluster deployment mode. Valid values are `0` and `1`. `0` is single-AZ deployment, and `1` is multi-AZ deployment. Default value is `0`. +* `es_acl` - (Optional, List) Kibana Access Control Configuration. +* `instance_name` - (Optional, String) Name of the instance, which can contain 1 to 50 English letters, Chinese characters, digits, dashes(-), or underscores(_). +* `license_type` - (Optional, String) License type. Valid values are `oss`, `basic` and `platinum`. The default value is `platinum`. +* `multi_zone_infos` - (Optional, List, ForceNew) Details of AZs in multi-AZ deployment mode (which is required when deploy_mode is `1`). +* `renew_flag` - (Optional, String, ForceNew) When enabled, the instance will be renew automatically when it reach the end of the prepaid tenancy. Valid values are `RENEW_FLAG_AUTO` and `RENEW_FLAG_MANUAL`. NOTE: it only works when charge_type is set to `PREPAID`. +* `subnet_id` - (Optional, String, ForceNew) The ID of a VPC subnetwork. When create multi-az es, this parameter must be omitted or `-`. +* `tags` - (Optional, Map) A mapping of tags to assign to the instance. For tag limits, please refer to [Use Limits](https://intl.cloud.tencent.com/document/product/651/13354). +* `web_node_type_info` - (Optional, List) Visual node configuration. + +The `es_acl` object supports the following: + +* `black_list` - (Optional, Set) Blacklist of kibana access. +* `white_list` - (Optional, Set) Whitelist of kibana access. + +The `multi_zone_infos` object supports the following: + +* `availability_zone` - (Required, String) Availability zone. +* `subnet_id` - (Required, String) The ID of a VPC subnetwork. + +The `node_info_list` object supports the following: + +* `node_num` - (Required, Int) Number of nodes. +* `node_type` - (Required, String) Node specification, and valid values refer to [document of tencentcloud](https://intl.cloud.tencent.com/document/product/845/18376). +* `disk_size` - (Optional, Int) Node disk size. Unit is GB, and default value is `100`. +* `disk_type` - (Optional, String) Node disk type. Valid values are `CLOUD_SSD` and `CLOUD_PREMIUM`, `CLOUD_HSSD`. The default value is `CLOUD_SSD`. +* `encrypt` - (Optional, Bool) Decides to encrypt this disk or not. +* `type` - (Optional, String) Node type. Valid values are `hotData`, `warmData` and `dedicatedMaster`. The default value is 'hotData`. + +The `web_node_type_info` object supports the following: + +* `node_num` - (Required, Int) Visual node number. +* `node_type` - (Required, String) Visual node specifications. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Instance creation time. +* `elasticsearch_domain` - Elasticsearch domain name. +* `elasticsearch_port` - Elasticsearch port. +* `elasticsearch_vip` - Elasticsearch VIP. +* `kibana_url` - Kibana access URL. + + +## Import + +Elasticsearch instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_elasticsearch_instance.foo es-17634f05 +``` + diff --git a/config/docs/r/elasticsearch_logstash.html.markdown b/config/docs/r/elasticsearch_logstash.html.markdown new file mode 100644 index 0000000..3d18219 --- /dev/null +++ b/config/docs/r/elasticsearch_logstash.html.markdown @@ -0,0 +1,93 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_logstash" +sidebar_current: "docs-tencentcloud-resource-elasticsearch_logstash" +description: |- + Provides a resource to create a elasticsearch logstash +--- + +# tencentcloud_elasticsearch_logstash + +Provides a resource to create a elasticsearch logstash + +## Example Usage + +```hcl +resource "tencentcloud_elasticsearch_logstash" "logstash" { + instance_name = "logstash-test" + zone = "ap-guangzhou-6" + logstash_version = "7.14.2" + vpc_id = "vpc-4owdpnwr" + subnet_id = "subnet-4o0zd840" + node_num = 1 + charge_type = "POSTPAID_BY_HOUR" + node_type = "LOGSTASH.SA2.MEDIUM4" + disk_type = "CLOUD_SSD" + disk_size = 20 + license_type = "xpack" + operation_duration { + periods = [1, 2, 3, 4, 5, 6, 0] + time_start = "02:00" + time_end = "06:00" + time_zone = "UTC+8" + } + tags = { + tagKey = "tagValue" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_name` - (Required, String) Instance name (compose of 1-50 letter, number, - or _). +* `logstash_version` - (Required, String) Instance version(6.8.13, 7.10.1). +* `subnet_id` - (Required, String) Subnet id. +* `vpc_id` - (Required, String) VPC id. +* `zone` - (Required, String) Available zone. +* `auto_voucher` - (Optional, Int) whether to use voucher auto, 1 when use, else 0. +* `charge_period` - (Optional, Int) Period when charged by months or years(unit depends on TimeUnit). +* `charge_type` - (Optional, String) Charge type. PREPAID: charged by months or years; POSTPAID_BY_HOUR: charged by hours; default vaule: POSTPAID_BY_HOUR. +* `disk_size` - (Optional, Int) node disk size (unit GB). +* `disk_type` - (Optional, String) Disk type. CLOUD_SSD: SSD cloud disk; CLOUD_PREMIUM: high hard energy cloud disk; default: CLOUD_SSD. +* `license_type` - (Optional, String) License type. oss: open source version; xpack:xpack version; default: xpack. +* `node_num` - (Optional, Int) Node num(range 2-50). +* `node_type` - (Optional, String) Node type. Valid values: +- LOGSTASH.S1.SMALL2: 1 core 2G; +- LOGSTASH.S1.MEDIUM4:2 core 4G; +- LOGSTASH.S1.MEDIUM8:2 core 8G; +- LOGSTASH.S1.LARGE16:4 core 16G; +- LOGSTASH.S1.2XLARGE32:8 core 32G; +- LOGSTASH.S1.4XLARGE32:16 core 32G; +- LOGSTASH.S1.4XLARGE64:16 core 64G. +* `operation_duration` - (Optional, List) operation time by tencent clound. +* `renew_flag` - (Optional, String) Automatic renewal flag. RENEW_FLAG_AUTO: auto renewal; RENEW_FLAG_MANUAL: do not renew automatically, users renew manually. It needs to be set when ChargeType is PREPAID. If this parameter is not passed, ordinary users will not renew automatically by default, and SVIP users will renew automatically. +* `tags` - (Optional, Map) Tag description list. +* `time_unit` - (Optional, String) charge time unit(set when ChargeType is PREPAID, default value: ms). +* `voucher_ids` - (Optional, Set: [`String`]) Voucher list(only can use one voucher by now). + +The `operation_duration` object supports the following: + +* `periods` - (Required, Set) day of week, from Monday to Sunday, value range: [0, 6]notes: may return null when missing. +* `time_end` - (Required, String) operation end time. +* `time_start` - (Required, String) operation start time. +* `time_zone` - (Required, String) time zone, for example: UTC+8. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +elasticsearch logstash can be imported using the id, e.g. + +``` +terraform import tencentcloud_elasticsearch_logstash.logstash logstash_id +``` + diff --git a/config/docs/r/elasticsearch_logstash_pipeline.html.markdown b/config/docs/r/elasticsearch_logstash_pipeline.html.markdown new file mode 100644 index 0000000..efae361 --- /dev/null +++ b/config/docs/r/elasticsearch_logstash_pipeline.html.markdown @@ -0,0 +1,79 @@ +--- +subcategory: "Elasticsearch Service(ES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_elasticsearch_logstash_pipeline" +sidebar_current: "docs-tencentcloud-resource-elasticsearch_logstash_pipeline" +description: |- + Provides a resource to create a elasticsearch logstash pipeline +--- + +# tencentcloud_elasticsearch_logstash_pipeline + +Provides a resource to create a elasticsearch logstash pipeline + +## Example Usage + +```hcl +resource "tencentcloud_elasticsearch_logstash_pipeline" "logstash_pipeline" { + instance_id = "ls-xxxxxx" + pipeline { + pipeline_id = "logstash-pipeline-test" + pipeline_desc = "" + config = <not support, 1=>support). +* `time_span` - (Required, Int) The length of time the instance was purchased. Use with TimeUnit.When TimeUnit is s, the parameter can only be filled in at 3600, representing a metered instance. +When TimeUnit is m, the number filled in by this parameter indicates the length of purchase of the monthly instance of the package year, such as 1 for one month of purchase. +* `time_unit` - (Required, String) The unit of time in which the instance was purchased. When PayMode is 0, TimeUnit can only take values of s(second). When PayMode is 1, TimeUnit can only take the value m(month). +* `vpc_settings` - (Required, Map, ForceNew) The private net config of EMR instance. +* `extend_fs_field` - (Optional, String) Access the external file system. +* `need_master_wan` - (Optional, String, ForceNew) Whether to enable the cluster Master node public network. Value range: + - NEED_MASTER_WAN: Indicates that the cluster Master node public network is enabled. + - NOT_NEED_MASTER_WAN: Indicates that it is not turned on. + By default, the cluster Master node internet is enabled. +* `resource_spec` - (Optional, List) Resource specification of EMR instance. +* `sg_id` - (Optional, String, ForceNew) The ID of the security group to which the instance belongs, in the form of sg-xxxxxxxx. +* `tags` - (Optional, Map) Tag description list. + +The `resource_spec` object supports the following: + +* `common_count` - (Optional, Int, ForceNew) The number of common node. +* `common_resource_spec` - (Optional, List, ForceNew) +* `core_count` - (Optional, Int) The number of core node. +* `core_resource_spec` - (Optional, List, ForceNew) +* `master_count` - (Optional, Int) The number of master node. +* `master_resource_spec` - (Optional, List, ForceNew) +* `task_count` - (Optional, Int) The number of core node. +* `task_resource_spec` - (Optional, List, ForceNew) + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `instance_id` - Created EMR instance id. + + diff --git a/config/docs/r/emr_user_manager.html.markdown b/config/docs/r/emr_user_manager.html.markdown new file mode 100644 index 0000000..7b2fc8c --- /dev/null +++ b/config/docs/r/emr_user_manager.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "MapReduce(EMR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_emr_user_manager" +sidebar_current: "docs-tencentcloud-resource-emr_user_manager" +description: |- + Provides a resource to create a emr user +--- + +# tencentcloud_emr_user_manager + +Provides a resource to create a emr user + +## Example Usage + +```hcl +data "tencentcloud_emr" "my_emr" { + display_strategy = "clusterList" +} + +resource "tencentcloud_emr_user_manager" "user_manager" { + instance_id = data.tencentcloud_emr.my_emr.clusters.0.cluster_id + user_name = "tf-test" + user_group = "group1" + password = "tf@123456" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Cluster string ID. +* `password` - (Required, String) PassWord. +* `user_group` - (Required, String, ForceNew) User group membership. +* `user_name` - (Required, String, ForceNew) Username. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time. +* `download_keytab_url` - Download keytab url. +* `support_download_keytab` - If support download keytab. +* `user_type` - User type. + + +## Import + +emr user_manager can be imported using the id, e.g. + +``` +terraform import tencentcloud_emr_user_manager.user_manager instanceId#userName +``` + diff --git a/config/docs/r/eni.html.markdown b/config/docs/r/eni.html.markdown new file mode 100644 index 0000000..875df72 --- /dev/null +++ b/config/docs/r/eni.html.markdown @@ -0,0 +1,108 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eni" +sidebar_current: "docs-tencentcloud-resource-eni" +description: |- + Provides a resource to create an ENI. +--- + +# tencentcloud_eni + +Provides a resource to create an ENI. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "vpc" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "example1" { + name = "tf-example-sg1" + description = "sg desc." + project_id = 0 + + tags = { + "example" = "test" + } +} + +resource "tencentcloud_security_group" "example2" { + name = "tf-example-sg2" + description = "sg desc." + project_id = 0 + + tags = { + "example" = "test" + } +} + +resource "tencentcloud_eni" "example" { + name = "tf-example-eni" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + description = "eni desc." + ipv4_count = 1 + security_groups = [ + tencentcloud_security_group.example1.id, + tencentcloud_security_group.example2.id + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the ENI, maximum length 60. +* `subnet_id` - (Required, String, ForceNew) ID of the subnet within this vpc. +* `vpc_id` - (Required, String, ForceNew) ID of the vpc. +* `description` - (Optional, String) Description of the ENI, maximum length 60. +* `ipv4_count` - (Optional, Int) The number of intranet IPv4s. When it is greater than 1, there is only one primary intranet IP. The others are auxiliary intranet IPs, which conflict with `ipv4s`. +* `ipv4s` - (Optional, Set) Applying for intranet IPv4s collection, conflict with `ipv4_count`. When there are multiple ipv4s, can only be one primary IP, and the maximum length of the array is 30. Each element contains the following attributes: +* `security_groups` - (Optional, Set: [`String`]) A set of security group IDs. +* `tags` - (Optional, Map) Tags of the ENI. + +The `ipv4s` object supports the following: + +* `ip` - (Required, String) Intranet IP. +* `primary` - (Required, Bool) Indicates whether the IP is primary. +* `description` - (Optional, String) Description of the IP, maximum length 25. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of the ENI. +* `ipv4_info` - An information list of IPv4s. Each element contains the following attributes: + * `description` - Description of the IP. + * `ip` - Intranet IP. + * `primary` - Indicates whether the IP is primary. +* `mac` - MAC address. +* `primary` - Indicates whether the IP is primary. +* `state` - State of the ENI. + + +## Import + +ENI can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_eni.foo eni-qka182br +``` + diff --git a/config/docs/r/eni_attachment.html.markdown b/config/docs/r/eni_attachment.html.markdown new file mode 100644 index 0000000..d40e140 --- /dev/null +++ b/config/docs/r/eni_attachment.html.markdown @@ -0,0 +1,96 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eni_attachment" +sidebar_current: "docs-tencentcloud-resource-eni_attachment" +description: |- + Provides a resource to detailed information of attached backend server to an ENI. +--- + +# tencentcloud_eni_attachment + +Provides a resource to detailed information of attached backend server to an ENI. + +## Example Usage + +```hcl +resource "tencentcloud_vpc" "foo" { + name = "ci-test-eni-vpc" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "foo" { + availability_zone = "ap-guangzhou-3" + name = "ci-test-eni-subnet" + vpc_id = tencentcloud_vpc.foo.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_eni" "foo" { + name = "ci-test-eni" + vpc_id = tencentcloud_vpc.foo.id + subnet_id = tencentcloud_subnet.foo.id + description = "eni desc" + ipv4_count = 1 +} + +data "tencentcloud_images" "my_favorite_image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "centos" +} + +data "tencentcloud_instance_types" "my_favorite_instance_types" { + filter { + name = "instance-family" + values = ["S3"] + } + + cpu_core_count = 1 + memory_size = 1 +} + +data "tencentcloud_availability_zones" "my_favorite_zones" { +} + +resource "tencentcloud_instance" "foo" { + instance_name = "ci-test-eni-attach" + availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name + image_id = data.tencentcloud_images.my_favorite_image.images.0.image_id + instance_type = data.tencentcloud_instance_types.my_favorite_instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + disable_security_service = true + disable_monitor_service = true + vpc_id = tencentcloud_vpc.foo.id + subnet_id = tencentcloud_subnet.foo.id +} + +resource "tencentcloud_eni_attachment" "foo" { + eni_id = tencentcloud_eni.foo.id + instance_id = tencentcloud_instance.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `eni_id` - (Required, String, ForceNew) ID of the ENI. +* `instance_id` - (Required, String, ForceNew) ID of the instance which bind the ENI. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ENI attachment can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_eni_attachment.foo eni-gtlvkjvz+ins-0h3a5new +``` + diff --git a/config/docs/r/eni_sg_attachment.html.markdown b/config/docs/r/eni_sg_attachment.html.markdown new file mode 100644 index 0000000..55e809e --- /dev/null +++ b/config/docs/r/eni_sg_attachment.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_eni_sg_attachment" +sidebar_current: "docs-tencentcloud-resource-eni_sg_attachment" +description: |- + Provides a resource to create a eni_sg_attachment +--- + +# tencentcloud_eni_sg_attachment + +Provides a resource to create a eni_sg_attachment + +-> **Note:** If this resource is used to bind security groups to eni, it cannot be linked to `tentcloud_eni` binding security group for simultaneous use. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "vpc" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "example1" { + name = "tf-example-sg1" + description = "sg desc." + project_id = 0 + + tags = { + "example" = "test" + } +} + +resource "tencentcloud_security_group" "example2" { + name = "tf-example-sg2" + description = "sg desc." + project_id = 0 + + tags = { + "example" = "test" + } +} + +resource "tencentcloud_eni" "example" { + name = "tf-example-eni" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + description = "eni desc." + ipv4_count = 1 +} + +resource "tencentcloud_eni_sg_attachment" "eni_sg_attachment" { + network_interface_ids = [tencentcloud_eni.example.id] + security_group_ids = [ + tencentcloud_security_group.example1.id, + tencentcloud_security_group.example2.id + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `network_interface_ids` - (Required, Set: [`String`], ForceNew) ENI instance ID. Such as:eni-pxir56ns. It Only support set one eni instance now. +* `security_group_ids` - (Required, Set: [`String`], ForceNew) Security group instance ID, for example:sg-33ocnj9n, can be obtained through DescribeSecurityGroups. There is a limit of 100 instances per request. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc eni_sg_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_eni_sg_attachment.eni_sg_attachment eni_sg_attachment_id +``` + diff --git a/config/docs/r/gaap_certificate.html.markdown b/config/docs/r/gaap_certificate.html.markdown new file mode 100644 index 0000000..65ed511 --- /dev/null +++ b/config/docs/r/gaap_certificate.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_certificate" +sidebar_current: "docs-tencentcloud-resource-gaap_certificate" +description: |- + Provides a resource to create a certificate of GAAP. +--- + +# tencentcloud_gaap_certificate + +Provides a resource to create a certificate of GAAP. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_certificate" "foo" { + type = "BASIC" + content = "test:tx2KGdo3zJg/." + name = "test_certificate" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `content` - (Required, String, ForceNew) Content of the certificate, and URL encoding. When the certificate is basic authentication, use the `user:xxx password:xxx` format, where the password is encrypted with `htpasswd` or `openssl`; When the certificate is `CA` or `SSL`, the format is `pem`. +* `type` - (Required, String, ForceNew) Type of the certificate. Valid value: `BASIC`, `CLIENT`, `SERVER`, `REALSERVER` and `PROXY`. `BASIC` means basic certificate; `CLIENT` means client CA certificate; `SERVER` means server SSL certificate; `REALSERVER` means realserver CA certificate; `PROXY` means proxy SSL certificate. +* `key` - (Optional, String, ForceNew) Key of the `SSL` certificate. +* `name` - (Optional, String) Name of the certificate. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `begin_time` - Beginning time of the certificate. +* `create_time` - Creation time of the certificate. +* `end_time` - Ending time of the certificate. +* `issuer_cn` - Issuer name of the certificate. +* `subject_cn` - Subject name of the certificate. + + +## Import + +GAAP certificate can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_gaap_certificate.foo cert-d5y6ei3b +``` + diff --git a/config/docs/r/gaap_domain_error_page.html.markdown b/config/docs/r/gaap_domain_error_page.html.markdown new file mode 100644 index 0000000..2292469 --- /dev/null +++ b/config/docs/r/gaap_domain_error_page.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_domain_error_page" +sidebar_current: "docs-tencentcloud-resource-gaap_domain_error_page" +description: |- + Provide a resource to custom error page info for a GAAP HTTP domain. +--- + +# tencentcloud_gaap_domain_error_page + +Provide a resource to custom error page info for a GAAP HTTP domain. + +## Example Usage + +```hcl +resource tencentcloud_gaap_proxy "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource tencentcloud_gaap_layer7_listener "foo" { + protocol = "HTTP" + name = "ci-test-gaap-l7-listener" + port = 80 + proxy_id = tencentcloud_gaap_proxy.foo.id +} + +resource tencentcloud_gaap_http_domain "foo" { + listener_id = tencentcloud_gaap_layer7_listener.foo.id + domain = "www.qq.com" +} + +resource tencentcloud_gaap_domain_error_page "foo" { + listener_id = tencentcloud_gaap_layer7_listener.foo.id + domain = tencentcloud_gaap_http_domain.foo.domain + error_codes = [404, 503] + body = "bad request" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `body` - (Required, String, ForceNew) New response body. +* `domain` - (Required, String, ForceNew) HTTP domain. +* `error_codes` - (Required, Set: [`Int`], ForceNew) Original error codes. +* `listener_id` - (Required, String, ForceNew) ID of the layer7 listener. +* `clear_headers` - (Optional, Set: [`String`], ForceNew) Response headers to be removed. +* `new_error_code` - (Optional, Int, ForceNew) New error code. +* `set_headers` - (Optional, Map, ForceNew) Response headers to be set. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/gaap_global_domain.html.markdown b/config/docs/r/gaap_global_domain.html.markdown new file mode 100644 index 0000000..39e51f8 --- /dev/null +++ b/config/docs/r/gaap_global_domain.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_global_domain" +sidebar_current: "docs-tencentcloud-resource-gaap_global_domain" +description: |- + Provides a resource to create a gaap global domain +--- + +# tencentcloud_gaap_global_domain + +Provides a resource to create a gaap global domain + +## Example Usage + +```hcl +resource "tencentcloud_gaap_global_domain" "global_domain" { + project_id = 0 + default_value = "xxxxxx.com" + alias = "demo" + tags = { + key = "value" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `default_value` - (Required, String) Domain name default entry. +* `project_id` - (Required, Int) Domain Name Project ID. +* `alias` - (Optional, String) alias. +* `tags` - (Optional, Map) Instance tags. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +gaap global_domain can be imported using the id, e.g. + +``` +terraform import tencentcloud_gaap_global_domain.global_domain ${projectId}#${domainId} +``` + diff --git a/config/docs/r/gaap_global_domain_dns.html.markdown b/config/docs/r/gaap_global_domain_dns.html.markdown new file mode 100644 index 0000000..add7359 --- /dev/null +++ b/config/docs/r/gaap_global_domain_dns.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_global_domain_dns" +sidebar_current: "docs-tencentcloud-resource-gaap_global_domain_dns" +description: |- + Provides a resource to create a gaap global domain dns +--- + +# tencentcloud_gaap_global_domain_dns + +Provides a resource to create a gaap global domain dns + +## Example Usage + +```hcl +resource "tencentcloud_gaap_global_domain_dns" "global_domain_dns" { + domain_id = "dm-xxxxxx" + proxy_id_list = ["link-xxxxxx"] + nation_country_inner_codes = ["101001"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_id` - (Required, String) Domain Id. +* `nation_country_inner_codes` - (Required, Set: [`String`]) Nation Country Inner Codes. +* `proxy_id_list` - (Required, Set: [`String`]) Proxy Id List. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +gaap global_domain_dns can be imported using the id, e.g. + +``` +terraform import tencentcloud_gaap_global_domain_dns.global_domain_dns ${domainId}#${dnsRecordId} +``` + diff --git a/config/docs/r/gaap_http_domain.html.markdown b/config/docs/r/gaap_http_domain.html.markdown new file mode 100644 index 0000000..a3dd460 --- /dev/null +++ b/config/docs/r/gaap_http_domain.html.markdown @@ -0,0 +1,73 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_http_domain" +sidebar_current: "docs-tencentcloud-resource-gaap_http_domain" +description: |- + Provides a resource to create a forward domain of layer7 listener. +--- + +# tencentcloud_gaap_http_domain + +Provides a resource to create a forward domain of layer7 listener. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_layer7_listener" "foo" { + protocol = "HTTP" + name = "ci-test-gaap-l7-listener" + port = 80 + proxy_id = tencentcloud_gaap_proxy.foo.id +} + +resource "tencentcloud_gaap_http_domain" "foo" { + listener_id = tencentcloud_gaap_layer7_listener.foo.id + domain = "www.qq.com" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Forward domain of the layer7 listener. +* `listener_id` - (Required, String, ForceNew) ID of the layer7 listener. +* `basic_auth_id` - (Optional, String) ID of the basic authentication. +* `basic_auth` - (Optional, Bool) Indicates whether basic authentication is enable, default value is `false`. +* `certificate_id` - (Optional, String) ID of the server certificate, default value is `default`. +* `client_certificate_id` - (Optional, String, **Deprecated**) It has been deprecated from version 1.26.0. Set `client_certificate_ids` instead. ID of the client certificate, default value is `default`. +* `client_certificate_ids` - (Optional, Set: [`String`]) ID list of the poly client certificate. +* `gaap_auth_id` - (Optional, String) ID of the SSL certificate. +* `gaap_auth` - (Optional, Bool) Indicates whether SSL certificate authentication is enable, default value is `false`. +* `realserver_auth` - (Optional, Bool) Indicates whether realserver authentication is enable, default value is `false`. +* `realserver_certificate_domain` - (Optional, String) CA certificate domain of the realserver. It has been deprecated. +* `realserver_certificate_id` - (Optional, String, **Deprecated**) It has been deprecated from version 1.28.0. Set `realserver_certificate_ids` instead. CA certificate ID of the realserver. +* `realserver_certificate_ids` - (Optional, Set: [`String`]) CA certificate ID list of the realserver. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +GAAP http domain can be imported using the id, e.g. + +-> **NOTE:** The format of tencentcloud_gaap_http_domain id is `[listener-id]+[protocol]+[domain]`. + +``` + $ terraform import tencentcloud_gaap_http_domain.foo listener-11112222+HTTP+www.qq.com +``` + diff --git a/config/docs/r/gaap_http_rule.html.markdown b/config/docs/r/gaap_http_rule.html.markdown new file mode 100644 index 0000000..c6063a2 --- /dev/null +++ b/config/docs/r/gaap_http_rule.html.markdown @@ -0,0 +1,113 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_http_rule" +sidebar_current: "docs-tencentcloud-resource-gaap_http_rule" +description: |- + Provides a resource to create a forward rule of layer7 listener. +--- + +# tencentcloud_gaap_http_rule + +Provides a resource to create a forward rule of layer7 listener. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_layer7_listener" "foo" { + protocol = "HTTP" + name = "ci-test-gaap-l7-listener" + port = 80 + proxy_id = tencentcloud_gaap_proxy.foo.id +} + +resource "tencentcloud_gaap_realserver" "foo" { + ip = "1.1.1.1" + name = "ci-test-gaap-realserver" +} + +resource "tencentcloud_gaap_realserver" "bar" { + ip = "8.8.8.8" + name = "ci-test-gaap-realserver" +} + +resource "tencentcloud_gaap_http_domain" "foo" { + listener_id = tencentcloud_gaap_layer7_listener.foo.id + domain = "www.qq.com" +} + +resource "tencentcloud_gaap_http_rule" "foo" { + listener_id = tencentcloud_gaap_layer7_listener.foo.id + domain = tencentcloud_gaap_http_domain.foo.domain + path = "/" + realserver_type = "IP" + health_check = true + health_check_path = "/" + health_check_method = "GET" + health_check_status_codes = [200] + + realservers { + id = tencentcloud_gaap_realserver.foo.id + ip = tencentcloud_gaap_realserver.foo.ip + port = 80 + } + + realservers { + id = tencentcloud_gaap_realserver.bar.id + ip = tencentcloud_gaap_realserver.bar.ip + port = 80 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Forward domain of the forward rule. +* `health_check` - (Required, Bool) Indicates whether health check is enable. +* `listener_id` - (Required, String, ForceNew) ID of the layer7 listener. +* `path` - (Required, String) Path of the forward rule. Maximum length is 80. +* `realserver_type` - (Required, String, ForceNew) Type of the realserver. Valid value: `IP` and `DOMAIN`. +* `connect_timeout` - (Optional, Int) Timeout of the health check response, default value is 2s. +* `forward_host` - (Optional, String) The default value of requested host which is forwarded to the realserver by the listener is `default`. +* `health_check_method` - (Optional, String) Method of the health check. Valid value: `GET` and `HEAD`. +* `health_check_path` - (Optional, String) Path of health check. Maximum length is 80. +* `health_check_status_codes` - (Optional, Set: [`Int`]) Return code of confirmed normal. Valid value: `100`, `200`, `300`, `400` and `500`. +* `interval` - (Optional, Int) Interval of the health check, default value is 5s. +* `realservers` - (Optional, Set) An information list of GAAP realserver. +* `scheduler` - (Optional, String) Scheduling policy of the forward rule, default value is `rr`. Valid value: `rr`, `wrr` and `lc`. +* `sni_switch` - (Optional, String) ServerNameIndication (SNI) switch. ON means on and OFF means off. +* `sni` - (Optional, String) ServerNameIndication (SNI) is required when the SNI switch is turned on. + +The `realservers` object supports the following: + +* `id` - (Required, String) ID of the GAAP realserver. +* `ip` - (Required, String) IP of the GAAP realserver. +* `port` - (Required, Int) Port of the GAAP realserver. +* `weight` - (Optional, Int) Scheduling weight, default value is `1`. Valid value ranges: (1~100). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +GAAP http rule can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_gaap_http_rule.foo rule-3bsuu01r +``` + diff --git a/config/docs/r/gaap_layer4_listener.html.markdown b/config/docs/r/gaap_layer4_listener.html.markdown new file mode 100644 index 0000000..5a68691 --- /dev/null +++ b/config/docs/r/gaap_layer4_listener.html.markdown @@ -0,0 +1,96 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_layer4_listener" +sidebar_current: "docs-tencentcloud-resource-gaap_layer4_listener" +description: |- + Provides a resource to create a layer4 listener of GAAP. +--- + +# tencentcloud_gaap_layer4_listener + +Provides a resource to create a layer4 listener of GAAP. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_realserver" "foo" { + ip = "1.1.1.1" + name = "ci-test-gaap-realserver" +} + +resource "tencentcloud_gaap_realserver" "bar" { + ip = "119.29.29.29" + name = "ci-test-gaap-realserver2" +} + +resource "tencentcloud_gaap_layer4_listener" "foo" { + protocol = "TCP" + name = "ci-test-gaap-4-listener" + port = 80 + realserver_type = "IP" + proxy_id = tencentcloud_gaap_proxy.foo.id + health_check = true + + realserver_bind_set { + id = tencentcloud_gaap_realserver.foo.id + ip = tencentcloud_gaap_realserver.foo.ip + port = 80 + } + + realserver_bind_set { + id = tencentcloud_gaap_realserver.bar.id + ip = tencentcloud_gaap_realserver.bar.ip + port = 80 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the layer4 listener, the maximum length is 30. +* `port` - (Required, Int, ForceNew) Port of the layer4 listener. +* `protocol` - (Required, String, ForceNew) Protocol of the layer4 listener. Valid value: `TCP` and `UDP`. +* `proxy_id` - (Required, String, ForceNew) ID of the GAAP proxy. +* `realserver_type` - (Required, String, ForceNew) Type of the realserver. Valid value: `IP` and `DOMAIN`. NOTES: when the `protocol` is specified as `TCP` and the `scheduler` is specified as `wrr`, the item can only be set to `IP`. +* `client_ip_method` - (Optional, Int, ForceNew) The way the listener gets the client IP, 0 for TOA, 1 for Proxy Protocol, default value is 0. NOTES: Only supports listeners of `TCP` protocol. +* `connect_timeout` - (Optional, Int) Timeout of the health check response, should less than interval, default value is 2s. NOTES: Only supports listeners of `TCP` protocol and require less than `interval`. +* `health_check` - (Optional, Bool) Indicates whether health check is enable, default value is `false`. NOTES: Only supports listeners of `TCP` protocol. +* `interval` - (Optional, Int) Interval of the health check, default value is 5s. NOTES: Only supports listeners of `TCP` protocol. +* `realserver_bind_set` - (Optional, Set) An information list of GAAP realserver. +* `scheduler` - (Optional, String) Scheduling policy of the layer4 listener, default value is `rr`. Valid value: `rr`, `wrr` and `lc`. + +The `realserver_bind_set` object supports the following: + +* `id` - (Required, String) ID of the GAAP realserver. +* `ip` - (Required, String) IP of the GAAP realserver. +* `port` - (Required, Int) Port of the GAAP realserver. +* `weight` - (Optional, Int) Scheduling weight, default value is `1`. The range of values is [1,100]. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of the layer4 listener. +* `status` - Status of the layer4 listener. + + +## Import + +GAAP layer4 listener can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_gaap_layer4_listener.foo listener-11112222 +``` + diff --git a/config/docs/r/gaap_layer7_listener.html.markdown b/config/docs/r/gaap_layer7_listener.html.markdown new file mode 100644 index 0000000..15345c5 --- /dev/null +++ b/config/docs/r/gaap_layer7_listener.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_layer7_listener" +sidebar_current: "docs-tencentcloud-resource-gaap_layer7_listener" +description: |- + Provides a resource to create a layer7 listener of GAAP. +--- + +# tencentcloud_gaap_layer7_listener + +Provides a resource to create a layer7 listener of GAAP. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_layer7_listener" "foo" { + protocol = "HTTP" + name = "ci-test-gaap-l7-listener" + port = 80 + proxy_id = tencentcloud_gaap_proxy.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the layer7 listener, the maximum length is 30. +* `port` - (Required, Int, ForceNew) Port of the layer7 listener. +* `protocol` - (Required, String, ForceNew) Protocol of the layer7 listener. Valid value: `HTTP` and `HTTPS`. +* `proxy_id` - (Required, String, ForceNew) ID of the GAAP proxy. +* `auth_type` - (Optional, Int, ForceNew) Authentication type of the layer7 listener. `0` is one-way authentication and `1` is mutual authentication. NOTES: Only supports listeners of `HTTPS` protocol. +* `certificate_id` - (Optional, String) Certificate ID of the layer7 listener. NOTES: Only supports listeners of `HTTPS` protocol. +* `client_certificate_id` - (Optional, String, **Deprecated**) It has been deprecated from version 1.26.0. Set `client_certificate_ids` instead. ID of the client certificate. Set only when `auth_type` is specified as mutual authentication. NOTES: Only supports listeners of `HTTPS` protocol. +* `client_certificate_ids` - (Optional, Set: [`String`]) ID list of the client certificate. Set only when `auth_type` is specified as mutual authentication. NOTES: Only supports listeners of `HTTPS` protocol. +* `forward_protocol` - (Optional, String, ForceNew) Protocol type of the forwarding. Valid value: `HTTP` and `HTTPS`. NOTES: Only supports listeners of `HTTPS` protocol. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of the layer7 listener. +* `status` - Status of the layer7 listener. + + +## Import + +GAAP layer7 listener can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_gaap_layer7_listener.foo listener-11112222 +``` + diff --git a/config/docs/r/gaap_proxy.html.markdown b/config/docs/r/gaap_proxy.html.markdown new file mode 100644 index 0000000..92b33cb --- /dev/null +++ b/config/docs/r/gaap_proxy.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_proxy" +sidebar_current: "docs-tencentcloud-resource-gaap_proxy" +description: |- + Provides a resource to create a GAAP proxy. +--- + +# tencentcloud_gaap_proxy + +Provides a resource to create a GAAP proxy. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" + + tags = { + test = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_region` - (Required, String, ForceNew) Access region of the GAAP proxy. Valid value: `Hongkong`, `SoutheastAsia`, `Korea`, `Europe`, `NorthAmerica`, `Canada`, `WestIndia`, `Thailand`, `Virginia`, `Japan`, `Taipei`, `SL_AZURE_NorthUAE`, `SL_AZURE_EastAUS`, `SL_AZURE_NorthCentralUSA`, `SL_AZURE_SouthIndia`, `SL_AZURE_SouthBrazil`, `SL_AZURE_NorthZAF`, `SL_AZURE_SoutheastAsia`, `SL_AZURE_CentralFrance`, `SL_AZURE_SouthEngland`, `SL_AZURE_EastUS`, `SL_AZURE_WestUS`, `SL_AZURE_SouthCentralUSA`, `Jakarta`, `Beijing`, `Shanghai`, `Guangzhou`, `Chengdu`, `SL_AZURE_NorwayEast`, `Chongqing`, `Nanjing`, `SaoPaulo`, `SL_AZURE_JapanEast`, `Changsha`, `Xian`, `Wuhan`, `Fuzhou`, `Shenyang`, `Zhengzhou`, `Jinan`, `Hangzhou`, `Shijiazhuang`, `Hefei`. +* `bandwidth` - (Required, Int) Maximum bandwidth of the GAAP proxy, unit is Mbps. Valid value: `10`, `20`, `50`, `100`, `200`, `500`, `1000`, `2000`, `5000` and `10000`. To set `2000`, `5000` or `10000`, you need to apply for a whitelist from Tencent Cloud. +* `concurrent` - (Required, Int) Maximum concurrency of the GAAP proxy, unit is 10k. Valid value: `2`, `5`, `10`, `20`, `30`, `40`, `50`, `60`, `70`, `80`, `90`, `100`, `150`, `200`, `250` and `300`. To set `150`, `200`, `250` or `300`, you need to apply for a whitelist from Tencent Cloud. +* `name` - (Required, String) Name of the GAAP proxy, the maximum length is 30. +* `realserver_region` - (Required, String, ForceNew) Region of the GAAP realserver. Valid value: `Hongkong`, `SoutheastAsia`, `Korea`, `Europe`, `NorthAmerica`, `Canada`, `WestIndia`, `Thailand`, `Virginia`, `Japan`, `Taipei`, `SL_AZURE_NorthUAE`, `SL_AZURE_EastAUS`, `SL_AZURE_NorthCentralUSA`, `SL_AZURE_SouthIndia`, `SL_AZURE_SouthBrazil`, `SL_AZURE_NorthZAF`, `SL_AZURE_SoutheastAsia`, `SL_AZURE_CentralFrance`, `SL_AZURE_SouthEngland`, `SL_AZURE_EastUS`, `SL_AZURE_WestUS`, `SL_AZURE_SouthCentralUSA`, `Jakarta`, `Beijing`, `Shanghai`, `Guangzhou`, `Chengdu`, `SL_AZURE_NorwayEast`, `Chongqing`, `Nanjing`, `SaoPaulo`, `SL_AZURE_JapanEast`. +* `enable` - (Optional, Bool) Indicates whether GAAP proxy is enabled, default value is `true`. +* `network_type` - (Optional, String, ForceNew) Network type. `normal`: regular BGP, `cn2`: boutique BGP, `triple`: triple play. +* `project_id` - (Optional, Int) ID of the project within the GAAP proxy, `0` means is default project. +* `tags` - (Optional, Map) Tags of the GAAP proxy. Tags that do not exist are not created automatically. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of the GAAP proxy. +* `domain` - Access domain of the GAAP proxy. +* `forward_ip` - Forwarding IP of the GAAP proxy. +* `ip` - Access IP of the GAAP proxy. +* `scalable` - Indicates whether GAAP proxy can scalable. +* `status` - Status of the GAAP proxy. +* `support_protocols` - Supported protocols of the GAAP proxy. + + +## Import + +GAAP proxy can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_gaap_proxy.foo link-11112222 +``` + diff --git a/config/docs/r/gaap_realserver.html.markdown b/config/docs/r/gaap_realserver.html.markdown new file mode 100644 index 0000000..5f72858 --- /dev/null +++ b/config/docs/r/gaap_realserver.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_realserver" +sidebar_current: "docs-tencentcloud-resource-gaap_realserver" +description: |- + Provides a resource to create a GAAP realserver. +--- + +# tencentcloud_gaap_realserver + +Provides a resource to create a GAAP realserver. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_realserver" "foo" { + ip = "1.1.1.1" + name = "ci-test-gaap-realserver" + + tags = { + test = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the GAAP realserver, the maximum length is 30. +* `domain` - (Optional, String, ForceNew) Domain of the GAAP realserver, conflict with `ip`. +* `ip` - (Optional, String, ForceNew) IP of the GAAP realserver, conflict with `domain`. +* `project_id` - (Optional, Int, ForceNew) ID of the project within the GAAP realserver, '0' means is default project. +* `tags` - (Optional, Map) Tags of the GAAP realserver. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +GAAP realserver can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_gaap_realserver.foo rs-4ftghy6 +``` + diff --git a/config/docs/r/gaap_security_policy.html.markdown b/config/docs/r/gaap_security_policy.html.markdown new file mode 100644 index 0000000..c88e4a9 --- /dev/null +++ b/config/docs/r/gaap_security_policy.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_security_policy" +sidebar_current: "docs-tencentcloud-resource-gaap_security_policy" +description: |- + Provides a resource to create a security policy of GAAP proxy. +--- + +# tencentcloud_gaap_security_policy + +Provides a resource to create a security policy of GAAP proxy. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_security_policy" "foo" { + proxy_id = tencentcloud_gaap_proxy.foo.id + action = "DROP" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `action` - (Required, String, ForceNew) Default policy. Valid value: `ACCEPT` and `DROP`. +* `proxy_id` - (Required, String, ForceNew) ID of the GAAP proxy. +* `enable` - (Optional, Bool) Indicates whether policy is enable, default value is `true`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +GAAP security policy can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_gaap_security_policy.foo pl-xxxx +``` + diff --git a/config/docs/r/gaap_security_rule.html.markdown b/config/docs/r/gaap_security_rule.html.markdown new file mode 100644 index 0000000..2d8e36c --- /dev/null +++ b/config/docs/r/gaap_security_rule.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Global Application Acceleration(GAAP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_gaap_security_rule" +sidebar_current: "docs-tencentcloud-resource-gaap_security_rule" +description: |- + Provides a resource to create a security policy rule. +--- + +# tencentcloud_gaap_security_rule + +Provides a resource to create a security policy rule. + +## Example Usage + +```hcl +resource "tencentcloud_gaap_proxy" "foo" { + name = "ci-test-gaap-proxy" + bandwidth = 10 + concurrent = 2 + access_region = "SouthChina" + realserver_region = "NorthChina" +} + +resource "tencentcloud_gaap_security_policy" "foo" { + proxy_id = tencentcloud_gaap_proxy.foo.id + action = "ACCEPT" +} + +resource "tencentcloud_gaap_security_rule" "foo" { + policy_id = tencentcloud_gaap_security_policy.foo.id + cidr_ip = "1.1.1.1" + action = "ACCEPT" + protocol = "TCP" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `action` - (Required, String) Policy of the rule. Valid value: `ACCEPT` and `DROP`. +* `cidr_ip` - (Required, String) A network address block of the request source. +* `policy_id` - (Required, String, ForceNew) ID of the security policy. +* `name` - (Optional, String) Name of the security policy rule. Maximum length is 30. +* `port` - (Optional, String) Target port. Default value is `ALL`. Valid examples: `80`, `80,443` and `3306-20000`. +* `protocol` - (Optional, String) Protocol of the security policy rule. Default value is `ALL`. Valid value: `TCP`, `UDP` and `ALL`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +GAAP security rule can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_gaap_security_rule.foo sr-xxxxxxxx +``` + diff --git a/config/docs/r/ha_vip.html.markdown b/config/docs/r/ha_vip.html.markdown new file mode 100644 index 0000000..7c5d2e2 --- /dev/null +++ b/config/docs/r/ha_vip.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ha_vip" +sidebar_current: "docs-tencentcloud-resource-ha_vip" +description: |- + Provides a resource to create a HA VIP. +--- + +# tencentcloud_ha_vip + +Provides a resource to create a HA VIP. + +## Example Usage + +```hcl +resource "tencentcloud_ha_vip" "foo" { + name = "terraform_test" + vpc_id = "vpc-gzea3dd7" + subnet_id = "subnet-4d4m4cd4s" + vip = "10.0.4.16" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the HA VIP. The length of character is limited to 1-60. +* `subnet_id` - (Required, String, ForceNew) Subnet ID. +* `vpc_id` - (Required, String, ForceNew) VPC ID. +* `vip` - (Optional, String, ForceNew) Virtual IP address, it must not be occupied and in this VPC network segment. If not set, it will be assigned after resource created automatically. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `address_ip` - EIP that is associated. +* `create_time` - Create time of the HA VIP. +* `instance_id` - Instance ID that is associated. +* `network_interface_id` - Network interface ID that is associated. +* `state` - State of the HA VIP. Valid value: `AVAILABLE`, `UNBIND`. + + +## Import + +HA VIP can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_ha_vip.foo havip-kjqwe4ba +``` + diff --git a/config/docs/r/ha_vip_eip_attachment.html.markdown b/config/docs/r/ha_vip_eip_attachment.html.markdown new file mode 100644 index 0000000..c55f3b8 --- /dev/null +++ b/config/docs/r/ha_vip_eip_attachment.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ha_vip_eip_attachment" +sidebar_current: "docs-tencentcloud-resource-ha_vip_eip_attachment" +description: |- + Provides a resource to create a HA VIP EIP attachment. +--- + +# tencentcloud_ha_vip_eip_attachment + +Provides a resource to create a HA VIP EIP attachment. + +## Example Usage + +```hcl +resource "tencentcloud_ha_vip_eip_attachment" "foo" { + havip_id = "havip-kjqwe4ba" + address_ip = "1.1.1.1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `address_ip` - (Required, String, ForceNew) Public address of the EIP. +* `havip_id` - (Required, String, ForceNew) ID of the attached HA VIP. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +HA VIP EIP attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_ha_vip_eip_attachment.foo havip-kjqwe4ba#1.1.1.1 +``` + diff --git a/config/docs/r/image.html.markdown b/config/docs/r/image.html.markdown new file mode 100644 index 0000000..5c413cb --- /dev/null +++ b/config/docs/r/image.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_image" +sidebar_current: "docs-tencentcloud-resource-image" +description: |- + Provide a resource to manage image. +--- + +# tencentcloud_image + +Provide a resource to manage image. + +## Example Usage + +```hcl +resource "tencentcloud_image" "image_snap" { + image_name = "image-snapshot-keep" + snapshot_ids = ["snap-nbp3xy1d", "snap-nvzu3dmh"] + force_poweroff = true + image_description = "create image with snapshot" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `image_name` - (Required, String) Image name. +* `data_disk_ids` - (Optional, Set: [`String`], ForceNew) Cloud disk ID list, When creating a whole machine image based on an instance, specify the data disk ID contained in the image. +* `force_poweroff` - (Optional, Bool) Set whether to force shutdown during mirroring. The default value is `false`, when set to true, it means that the mirror will be made after shutdown. +* `image_description` - (Optional, String) Image Description. +* `instance_id` - (Optional, String, ForceNew) Cloud server instance ID. +* `snapshot_ids` - (Optional, Set: [`String`], ForceNew) Cloud disk snapshot ID list; creating a mirror based on a snapshot must include a system disk snapshot. It cannot be passed in simultaneously with InstanceId. +* `sysprep` - (Optional, Bool) Sysprep function under Windows. When creating a Windows image, you can select true or false to enable or disable the Syspre function. +* `tags` - (Optional, Map) Tags of the image. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +image instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_image.image_snap img-gf7jspk6 +``` + diff --git a/config/docs/r/instance.html.markdown b/config/docs/r/instance.html.markdown new file mode 100644 index 0000000..e48019f --- /dev/null +++ b/config/docs/r/instance.html.markdown @@ -0,0 +1,181 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_instance" +sidebar_current: "docs-tencentcloud-resource-instance" +description: |- + Provides a CVM instance resource. +--- + +# tencentcloud_instance + +Provides a CVM instance resource. + +~> **NOTE:** You can launch an CVM instance for a VPC network via specifying parameter `vpc_id`. One instance can only belong to one VPC. + +~> **NOTE:** At present, 'PREPAID' instance cannot be deleted directly and must wait it to be outdated and released automatically. + +## Example Usage + +```hcl +data "tencentcloud_images" "my_favorite_image" { + image_type = ["PUBLIC_IMAGE"] + image_name_regex = "Final" +} + +data "tencentcloud_instance_types" "my_favorite_instance_types" { + filter { + name = "instance-family" + values = ["S1", "S2", "S3", "S4", "S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +data "tencentcloud_availability_zones" "my_favorite_zones" { +} + +// Create VPC resource +resource "tencentcloud_vpc" "app" { + cidr_block = "10.0.0.0/16" + name = "awesome_app_vpc" +} + +resource "tencentcloud_subnet" "app" { + vpc_id = tencentcloud_vpc.app.id + availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name + name = "awesome_app_subnet" + cidr_block = "10.0.1.0/24" +} + +// Create a POSTPAID_BY_HOUR CVM instance +resource "tencentcloud_instance" "cvm_postpaid" { + instance_name = "cvm_postpaid" + availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name + image_id = data.tencentcloud_images.my_favorite_image.images.0.image_id + instance_type = data.tencentcloud_instance_types.my_favorite_instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "user" + project_id = 0 + vpc_id = tencentcloud_vpc.app.id + subnet_id = tencentcloud_subnet.app.id + + data_disks { + data_disk_type = "CLOUD_PREMIUM" + data_disk_size = 50 + encrypt = false + } + + tags = { + tagKey = "tagValue" + } +} + +// Create a PREPAID CVM instance +resource "tencentcloud_instance" "cvm_prepaid" { + timeouts { + create = "30m" + } + instance_name = "cvm_prepaid" + availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name + image_id = data.tencentcloud_images.my_favorite_image.images.0.image_id + instance_type = data.tencentcloud_instance_types.my_favorite_instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "user" + project_id = 0 + vpc_id = tencentcloud_vpc.app.id + subnet_id = tencentcloud_subnet.app.id + instance_charge_type = "PREPAID" + instance_charge_type_prepaid_period = 1 + instance_charge_type_prepaid_renew_flag = "NOTIFY_AND_MANUAL_RENEW" + data_disks { + data_disk_type = "CLOUD_PREMIUM" + data_disk_size = 50 + encrypt = false + } + force_delete = true + tags = { + tagKey = "tagValue" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Required, String, ForceNew) The available zone for the CVM instance. +* `image_id` - (Required, String) The image to use for the instance. Changing `image_id` will cause the instance reset. +* `allocate_public_ip` - (Optional, Bool, ForceNew) Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false. +* `bandwidth_package_id` - (Optional, String) bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id. +* `cam_role_name` - (Optional, String, ForceNew) CAM role name authorized to access. +* `cdh_host_id` - (Optional, String, ForceNew) Id of cdh instance. Note: it only works when instance_charge_type is set to `CDHPAID`. +* `cdh_instance_type` - (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`. +* `data_disks` - (Optional, List, ForceNew) Settings for data disks. +* `disable_api_termination` - (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. +* `disable_monitor_service` - (Optional, Bool) Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifying will cause the instance reset. +* `disable_security_service` - (Optional, Bool) Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifying will cause the instance reset. +* `force_delete` - (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. +* `hostname` - (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. +* `instance_charge_type_prepaid_period` - (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`. +* `instance_charge_type_prepaid_renew_flag` - (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`. +* `instance_charge_type` - (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`. +* `instance_count` - (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. +* `instance_name` - (Optional, String) The name of the instance. The max length of instance_name is 60, and default value is `Terraform-CVM-Instance`. +* `instance_type` - (Optional, String) The type of the instance. +* `internet_charge_type` - (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. +* `internet_max_bandwidth_out` - (Optional, Int) Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when `allocate_public_ip` is false. +* `keep_image_login` - (Optional, Bool) Whether to keep image login or not, default is `false`. When the image type is private or shared or imported, this parameter can be set `true`. Modifying will cause the instance reset. +* `key_ids` - (Optional, Set: [`String`]) The key pair to use for the instance, it looks like `skey-16jig7tx`. Modifying will cause the instance reset. +* `key_name` - (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. +* `orderly_security_groups` - (Optional, List: [`String`]) A list of orderly security group IDs to associate with. +* `password` - (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. +* `placement_group_id` - (Optional, String, ForceNew) The ID of a placement group. +* `private_ip` - (Optional, String) The private IP to be assigned to this instance, must be in the provided subnet and available. +* `project_id` - (Optional, Int) The project the instance belongs to, default to 0. +* `running_flag` - (Optional, Bool) Set instance to running or stop. Default value is true, the instance will shutdown when this flag is false. +* `security_groups` - (Optional, Set: [`String`], **Deprecated**) It will be deprecated. Use `orderly_security_groups` instead. A list of security group IDs to associate with. +* `spot_instance_type` - (Optional, String) Type of spot instance, only support `ONE-TIME` now. Note: it only works when instance_charge_type is set to `SPOTPAID`. +* `spot_max_price` - (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`. +* `stopped_mode` - (Optional, String) Billing method of a pay-as-you-go instance after shutdown. Available values: `KEEP_CHARGING`,`STOP_CHARGING`. Default `KEEP_CHARGING`. +* `subnet_id` - (Optional, String) The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set. +* `system_disk_id` - (Optional, String) System disk snapshot ID used to initialize the system disk. When system disk type is `LOCAL_BASIC` and `LOCAL_SSD`, disk id is not supported. +* `system_disk_size` - (Optional, Int) Size of the system disk. unit is GB, Default is 50GB. If modified, the instance may force stop. +* `system_disk_type` - (Optional, String) System disk type. For more information on limits of system 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, `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. +* `tags` - (Optional, Map) A mapping of tags to assign to the resource. For tag limits, please refer to [Use Limits](https://intl.cloud.tencent.com/document/product/651/13354). +* `user_data_raw` - (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. +* `user_data` - (Optional, String, ForceNew) The user data to be injected into this instance. Must be base64 encoded and up to 16 KB. +* `vpc_id` - (Optional, String) The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set. + +The `data_disks` object supports the following: + +* `data_disk_size` - (Required, Int) Size of the data disk, and unit is GB. +* `data_disk_type` - (Required, String, ForceNew) 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. +* `data_disk_id` - (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. +* `data_disk_snapshot_id` - (Optional, String, ForceNew) Snapshot ID of the data disk. The selected data disk snapshot size must be smaller than the data disk size. +* `delete_with_instance` - (Optional, Bool, ForceNew) 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. +* `encrypt` - (Optional, Bool, ForceNew) Decides whether the disk is encrypted. Default is `false`. +* `throughput_performance` - (Optional, Int, ForceNew) Add extra performance to the data disk. Only works when disk type is `CLOUD_TSSD` or `CLOUD_HSSD`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the instance. +* `expired_time` - Expired time of the instance. +* `instance_status` - Current status of the instance. +* `public_ip` - Public IP of the instance. + + +## Import + +CVM instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_instance.foo ins-2qol3a80 +``` + diff --git a/config/docs/r/instance_set.html.markdown b/config/docs/r/instance_set.html.markdown new file mode 100644 index 0000000..655cfdb --- /dev/null +++ b/config/docs/r/instance_set.html.markdown @@ -0,0 +1,121 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_instance_set" +sidebar_current: "docs-tencentcloud-resource-instance_set" +description: |- + Provides a CVM instance set resource. +--- + +# tencentcloud_instance_set + +Provides a CVM instance set resource. + +~> **NOTE:** You can launch an CVM instance for a VPC network via specifying parameter `vpc_id`. One instance can only belong to one VPC. + +~> **NOTE:** This resource is designed to cater for the scenario of creating CVM in large batches. + +~> **NOTE:** After run command `terraform apply`, must wait all cvms is ready, then run command `terraform plan`, either it will cause state change. + +## Example Usage + +```hcl +data "tencentcloud_images" "my_favorite_image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "Tencent Linux release 3.2 (Final)" +} + +data "tencentcloud_instance_types" "my_favorite_instance_types" { + filter { + name = "instance-family" + values = ["S3"] + } + + cpu_core_count = 1 + memory_size = 1 +} + +data "tencentcloud_availability_zones" "my_favorite_zones" { +} + +// Create VPC resource +resource "tencentcloud_vpc" "app" { + cidr_block = "10.0.0.0/16" + name = "awesome_app_vpc" +} + +resource "tencentcloud_subnet" "app" { + vpc_id = tencentcloud_vpc.app.id + availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name + name = "awesome_app_subnet" + cidr_block = "10.0.1.0/24" +} + +// Create 10 CVM instances to host awesome_app +resource "tencentcloud_instance_set" "my_awesome_app" { + timeouts { + create = "5m" + read = "20s" + delete = "1h" + } + + instance_count = 10 + instance_name = "awesome_app" + availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name + image_id = data.tencentcloud_images.my_favorite_image.images.0.image_id + instance_type = data.tencentcloud_instance_types.my_favorite_instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "user" + project_id = 0 + vpc_id = tencentcloud_vpc.app.id + subnet_id = tencentcloud_subnet.app.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Required, String, ForceNew) The available zone for the CVM instance. +* `image_id` - (Required, String, ForceNew) The image to use for the instance. Changing `image_id` will cause the instance reset. +* `allocate_public_ip` - (Optional, Bool, ForceNew) Associate a public IP address with an instance in a VPC or Classic. Boolean value, Default is false. +* `bandwidth_package_id` - (Optional, String) bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id. +* `cam_role_name` - (Optional, String, ForceNew) CAM role name authorized to access. +* `disable_monitor_service` - (Optional, Bool) Disable enhance service for monitor, it is enabled by default. When this options is set, monitor agent won't be installed. Modifying will cause the instance reset. +* `disable_security_service` - (Optional, Bool) Disable enhance service for security, it is enabled by default. When this options is set, security agent won't be installed. Modifying will cause the instance reset. +* `exclude_instance_ids` - (Optional, Set: [`String`]) instance ids list to exclude. +* `hostname` - (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. +* `instance_charge_type` - (Optional, String) The charge type of instance. Only support `POSTPAID_BY_HOUR`. +* `instance_count` - (Optional, Int) The number of instances to be purchased. Value range:[1,100]; default value: 1. +* `instance_name` - (Optional, String) The name of the instance. The max length of instance_name is 60, and default value is `Terraform-CVM-Instance`. +* `instance_type` - (Optional, String) The type of the instance. +* `internet_charge_type` - (Optional, String, ForceNew) Internet charge type of the instance, Valid values are `BANDWIDTH_PREPAID`, `TRAFFIC_POSTPAID_BY_HOUR`, `BANDWIDTH_POSTPAID_BY_HOUR` and `BANDWIDTH_PACKAGE`. This value does not need to be set when `allocate_public_ip` is false. +* `internet_max_bandwidth_out` - (Optional, Int) Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bits per second). This value does not need to be set when `allocate_public_ip` is false. +* `keep_image_login` - (Optional, Bool) Whether to keep image login or not, default is `false`. When the image type is private or shared or imported, this parameter can be set `true`. Modifying will cause the instance reset. +* `key_name` - (Optional, String) The key pair to use for the instance, it looks like `skey-16jig7tx`. Modifying will cause the instance reset. +* `password` - (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. +* `placement_group_id` - (Optional, String, ForceNew) The ID of a placement group. +* `private_ip` - (Optional, String) The private IP to be assigned to this instance, must be in the provided subnet and available. +* `project_id` - (Optional, Int) The project the instance belongs to, default to 0. +* `security_groups` - (Optional, Set: [`String`]) A list of security group IDs to associate with. +* `subnet_id` - (Optional, String) The ID of a VPC subnet. If you want to create instances in a VPC network, this parameter must be set. +* `system_disk_id` - (Optional, String) System disk snapshot ID used to initialize the system disk. When system disk type is `LOCAL_BASIC` and `LOCAL_SSD`, disk id is not supported. +* `system_disk_size` - (Optional, Int) Size of the system disk. Valid value ranges: (50~1000). and unit is GB. Default is 50GB. If modified, the instance may force stop. +* `system_disk_type` - (Optional, String) System disk type. For more information on limits of system 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, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage, `CLOUD_BSSD`: Basic SSD. NOTE: If modified, the instance may force stop. +* `user_data_raw` - (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. +* `user_data` - (Optional, String, ForceNew) The user data to be injected into this instance. Must be base64 encoded and up to 16 KB. +* `vpc_id` - (Optional, String) The ID of a VPC network. If you want to create instances in a VPC network, this parameter must be set. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the instance. +* `expired_time` - Expired time of the instance. +* `instance_ids` - instance id list. +* `instance_status` - Current status of the instance. +* `public_ip` - Public IP of the instance. + + diff --git a/config/docs/r/ipv6_address_bandwidth.html.markdown b/config/docs/r/ipv6_address_bandwidth.html.markdown new file mode 100644 index 0000000..c4b2a60 --- /dev/null +++ b/config/docs/r/ipv6_address_bandwidth.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ipv6_address_bandwidth" +sidebar_current: "docs-tencentcloud-resource-ipv6_address_bandwidth" +description: |- + Provides a resource to create a ipv6_address_bandwidth +--- + +# tencentcloud_ipv6_address_bandwidth + +Provides a resource to create a ipv6_address_bandwidth + +## Example Usage + +```hcl +resource "tencentcloud_ipv6_address_bandwidth" "ipv6_address_bandwidth" { + ipv6_address = "2402:4e00:1019:9400:0:9905:a90b:2ef0" + internet_max_bandwidth_out = 6 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + # bandwidth_package_id = "bwp-34rfgt56" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ipv6_address` - (Required, String, ForceNew) IPV6 address that needs to be enabled for public network access. +* `bandwidth_package_id` - (Optional, String) The bandwidth package id, the Legacy account and the ipv6 address to apply for the bandwidth package charge type need to be passed in. +* `internet_charge_type` - (Optional, String) Network billing mode. IPV6 currently supports: `TRAFFIC_POSTPAID_BY_HOUR`, for standard account types; `BANDWIDTH_PACKAGE`, for traditional account types. The default network billing mode is: `TRAFFIC_POSTPAID_BY_HOUR`. +* `internet_max_bandwidth_out` - (Optional, Int) Bandwidth, in Mbps. The default is 1Mbps. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/key_pair.html.markdown b/config/docs/r/key_pair.html.markdown new file mode 100644 index 0000000..664d021 --- /dev/null +++ b/config/docs/r/key_pair.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_key_pair" +sidebar_current: "docs-tencentcloud-resource-key_pair" +description: |- + Provides a key pair resource. +--- + +# tencentcloud_key_pair + +Provides a key pair resource. + +## Example Usage + +```hcl +resource "tencentcloud_key_pair" "foo" { + key_name = "terraform_test" +} + +resource "tencentcloud_key_pair" "foo1" { + key_name = "terraform_test" + public_key = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDjd8fTnp7Dcuj4mLaQxf9Zs/ORgUL9fQxRCNKkPgP1paTy1I513maMX126i36Lxxl3+FUB52oVbo/FgwlIfX8hyCnv8MCxqnuSDozf1CD0/wRYHcTWAtgHQHBPCC2nJtod6cVC3kB18KeV4U7zsxmwFeBIxojMOOmcOBuh7+trRw==" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_name` - (Required, String) The key pair's name. It is the only in one TencentCloud account. +* `project_id` - (Optional, Int, ForceNew) Specifys to which project the key pair belongs. +* `public_key` - (Optional, String, ForceNew) You can import an existing public key and using TencentCloud key pair to manage it. +* `tags` - (Optional, Map) Tags of the key pair. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Key pair can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_key_pair.foo skey-17634f05 +``` + diff --git a/config/docs/r/kms_cloud_resource_attachment.html.markdown b/config/docs/r/kms_cloud_resource_attachment.html.markdown new file mode 100644 index 0000000..3b01ba0 --- /dev/null +++ b/config/docs/r/kms_cloud_resource_attachment.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_cloud_resource_attachment" +sidebar_current: "docs-tencentcloud-resource-kms_cloud_resource_attachment" +description: |- + Provides a resource to create a kms cloud_resource_attachment +--- + +# tencentcloud_kms_cloud_resource_attachment + +Provides a resource to create a kms cloud_resource_attachment + +## Example Usage + +```hcl +resource "tencentcloud_kms_cloud_resource_attachment" "example" { + key_id = "72688f39-1fe8-11ee-9f1a-525400cf25a4" + product_id = "mysql" + resource_id = "cdb-fitq5t9h" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_id` - (Required, String, ForceNew) CMK unique identifier. +* `product_id` - (Required, String, ForceNew) A unique identifier for the cloud product. +* `resource_id` - (Required, String, ForceNew) The resource/instance ID of the cloud product. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `alias` - Alias. +* `description` - Description. +* `key_state` - Key state. +* `key_usage` - Key usage. +* `owner` - owner. + + +## Import + +kms cloud_resource_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_kms_cloud_resource_attachment.example 72688f39-1fe8-11ee-9f1a-525400cf25a4#mysql#cdb-fitq5t9h +``` + diff --git a/config/docs/r/kms_external_key.html.markdown b/config/docs/r/kms_external_key.html.markdown new file mode 100644 index 0000000..1818c49 --- /dev/null +++ b/config/docs/r/kms_external_key.html.markdown @@ -0,0 +1,90 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_external_key" +sidebar_current: "docs-tencentcloud-resource-kms_external_key" +description: |- + Provide a resource to create a KMS external key. +--- + +# tencentcloud_kms_external_key + +Provide a resource to create a KMS external key. + +## Example Usage + +### Create a basic instance. + +```hcl +resource "tencentcloud_kms_external_key" "example" { + alias = "tf-example-kms-externalkey" + description = "example of kms external key" + + tags = { + "createdBy" = "terraform" + } +} +``` + +### Specify the encryption algorithm and public key. + +```hcl +resource "tencentcloud_kms_external_key" "example" { + alias = "tf-example-kms-externalkey" + description = "example of kms external key" + wrapping_algorithm = "RSAES_PKCS1_V1_5" + key_material_base64 = "your_public_key_base64_encoded" + is_enabled = true + + tags = { + "createdBy" = "terraform" + } +} +``` + +### Disable the external kms key. + +```hcl +resource "tencentcloud_kms_external_key" "example" { + alias = "tf-example-kms-externalkey" + description = "example of kms external key" + wrapping_algorithm = "RSAES_PKCS1_V1_5" + key_material_base64 = "your_public_key_base64_encoded" + is_enabled = false + + tags = { + "test-tag" = "unit-test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `alias` - (Required, String) Name of CMK. The name can only contain English letters, numbers, underscore and hyphen '-'. The first character must be a letter or number. +* `description` - (Optional, String) Description of CMK. The maximum is 1024 bytes. +* `is_archived` - (Optional, Bool) Specify whether to archive key. Default value is `false`. This field is conflict with `is_enabled`, valid when key_state is `Enabled`, `Disabled`, `Archived`. +* `is_enabled` - (Optional, Bool) Specify whether to enable key. Default value is `false`. This field is conflict with `is_archived`, valid when key_state is `Enabled`, `Disabled`, `Archived`. +* `key_material_base64` - (Optional, String) The base64-encoded key material encrypted with the public_key. For regions using the national secret version, the length of the imported key material is required to be 128 bits, and for regions using the FIPS version, the length of the imported key material is required to be 256 bits. +* `pending_delete_window_in_days` - (Optional, Int) Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 30 days. Defaults to 7 days. +* `tags` - (Optional, Map) Tags of CMK. +* `valid_to` - (Optional, Int) This value means the effective timestamp of the key material, 0 means it does not expire. Need to be greater than the current timestamp, the maximum support is 2147443200. +* `wrapping_algorithm` - (Optional, String) The algorithm for encrypting key material. Available values include `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1` and `RSAES_OAEP_SHA_256`. Default value is `RSAES_PKCS1_V1_5`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `key_state` - State of CMK. + + +## Import + +KMS external keys can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_kms_external_key.example 287e8f40-7cbb-11eb-9a3a-xxxxx +``` + diff --git a/config/docs/r/kms_key.html.markdown b/config/docs/r/kms_key.html.markdown new file mode 100644 index 0000000..8ad3cf1 --- /dev/null +++ b/config/docs/r/kms_key.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_key" +sidebar_current: "docs-tencentcloud-resource-kms_key" +description: |- + Provide a resource to create a KMS key. +--- + +# tencentcloud_kms_key + +Provide a resource to create a KMS key. + +## Example Usage + +### Create and enable a instance. + +```hcl +resource "tencentcloud_kms_key" "example" { + alias = "tf-example-kms-key" + description = "example of kms key" + key_rotation_enabled = false + is_enabled = true + + tags = { + "createdBy" = "terraform" + } +} +``` + +### Specify the Key Usage as an asymmetry method. + +```hcl +resource "tencentcloud_kms_key" "example2" { + alias = "tf-example-kms-key" + description = "example of kms key" + key_usage = "ASYMMETRIC_DECRYPT_RSA_2048" + is_enabled = false +} +``` + +### Disable the kms key instance. + +```hcl +resource "tencentcloud_kms_key" "example3" { + alias = "tf-example-kms-key" + description = "example of kms key" + key_rotation_enabled = false + is_enabled = false + + tags = { + "test-tag" = "unit-test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `alias` - (Required, String) Name of CMK. The name can only contain English letters, numbers, underscore and hyphen '-'. The first character must be a letter or number. +* `description` - (Optional, String) Description of CMK. The maximum is 1024 bytes. +* `is_archived` - (Optional, Bool) Specify whether to archive key. Default value is `false`. This field is conflict with `is_enabled`, valid when key_state is `Enabled`, `Disabled`, `Archived`. +* `is_enabled` - (Optional, Bool) Specify whether to enable key. Default value is `false`. This field is conflict with `is_archived`, valid when key_state is `Enabled`, `Disabled`, `Archived`. +* `key_rotation_enabled` - (Optional, Bool) Specify whether to enable key rotation, valid when key_usage is `ENCRYPT_DECRYPT`. Default value is `false`. +* `key_usage` - (Optional, String, ForceNew) Usage of CMK. Available values include `ENCRYPT_DECRYPT`, `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, `ASYMMETRIC_SIGN_VERIFY_ECC`. Default value is `ENCRYPT_DECRYPT`. +* `pending_delete_window_in_days` - (Optional, Int) Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 30 days. Defaults to 7 days. +* `tags` - (Optional, Map) Tags of CMK. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `key_state` - State of CMK. + + +## Import + +KMS keys can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_kms_key.foo 287e8f40-7cbb-11eb-9a3a-5254004f7f94 +``` + diff --git a/config/docs/r/kms_overwrite_white_box_device_fingerprints.html.markdown b/config/docs/r/kms_overwrite_white_box_device_fingerprints.html.markdown new file mode 100644 index 0000000..ab6db0f --- /dev/null +++ b/config/docs/r/kms_overwrite_white_box_device_fingerprints.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_overwrite_white_box_device_fingerprints" +sidebar_current: "docs-tencentcloud-resource-kms_overwrite_white_box_device_fingerprints" +description: |- + Provides a resource to create a kms overwrite_white_box_device_fingerprints +--- + +# tencentcloud_kms_overwrite_white_box_device_fingerprints + +Provides a resource to create a kms overwrite_white_box_device_fingerprints + +## Example Usage + +```hcl +resource "tencentcloud_kms_overwrite_white_box_device_fingerprints" "example" { + key_id = "23e80852-1e38-11e9-b129-5cb9019b4b01" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_id` - (Required, String, ForceNew) CMK unique identifier. +* `device_fingerprints` - (Optional, List, ForceNew) Device fingerprint list. + +The `device_fingerprints` object supports the following: + +* `identity` - (Required, String) identity. +* `description` - (Optional, String) Description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/kms_white_box_key.html.markdown b/config/docs/r/kms_white_box_key.html.markdown new file mode 100644 index 0000000..456904b --- /dev/null +++ b/config/docs/r/kms_white_box_key.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Key Management Service(KMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kms_white_box_key" +sidebar_current: "docs-tencentcloud-resource-kms_white_box_key" +description: |- + Provides a resource to create a kms white_box_key +--- + +# tencentcloud_kms_white_box_key + +Provides a resource to create a kms white_box_key + +## Example Usage + +```hcl +resource "tencentcloud_kms_white_box_key" "example" { + alias = "tf_example" + description = "test desc." + algorithm = "SM4" + status = "Enabled" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `algorithm` - (Required, String) All algorithm types for creating keys, supported values: AES_256, SM4. +* `alias` - (Required, String) As an alias for the key to be easier to identify and easier to understand, it cannot be empty and is a combination of 1-60 alphanumeric characters - _. The first character must be a letter or number. Alias are not repeatable. +* `description` - (Optional, String) Description of the key, up to 1024 bytes. +* `status` - (Optional, String) Whether to enable the key. Enabled or Disabled. Default is Enabled. +* `tags` - (Optional, Map) The tags of Key. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +kms white_box_key can be imported using the id, e.g. + +``` +terraform import tencentcloud_kms_white_box_key.example 244dab8c-6dad-11ea-80c6-5254006d0810 +``` + diff --git a/config/docs/r/kubernetes_addon_attachment.html.markdown b/config/docs/r/kubernetes_addon_attachment.html.markdown new file mode 100644 index 0000000..0b07a55 --- /dev/null +++ b/config/docs/r/kubernetes_addon_attachment.html.markdown @@ -0,0 +1,158 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_addon_attachment" +sidebar_current: "docs-tencentcloud-resource-kubernetes_addon_attachment" +description: |- + Provide a resource to configure kubernetes cluster app addons. +--- + +# tencentcloud_kubernetes_addon_attachment + +Provide a resource to configure kubernetes cluster app addons. + +~> **NOTE**: Avoid to using legacy "1.0.0" version, leave the versions empty so we can fetch the latest while creating. + +## Example Usage + +### Install cbs addon by passing values + +```hcl +resource "tencentcloud_kubernetes_addon_attachment" "addon_cbs" { + cluster_id = "cls-xxxxxxxx" + name = "cbs" + # version = "1.0.5" + values = [ + "rootdir=/var/lib/kubelet" + ] +} +``` + +### Install tcr addon by passing values + +```hcl +resource "tencentcloud_kubernetes_addon_attachment" "addon_tcr" { + cluster_id = "cls-xxxxxxxx" #specify your tke cluster id + name = "tcr" + version = "1.0.0" + values = [ + # imagePullSecretsCrs is an array which can configure image pull + "global.imagePullSecretsCrs[0].name=${local.tcr_id}-vpc", #specify a unique name, invalid format as: `${tcrId}-vpc` + "global.imagePullSecretsCrs[0].namespaces=${local.ns_name}", #input the specified namespaces of the cluster, or input `*` for all. + "global.imagePullSecretsCrs[0].serviceAccounts=*", #input the specified service account of the cluster, or input `*` for all. + "global.imagePullSecretsCrs[0].type=docker", #only support docker now + "global.imagePullSecretsCrs[0].dockerUsername=${local.user_name}", #input the access username, or you can create it from `tencentcloud_tcr_token` + "global.imagePullSecretsCrs[0].dockerPassword=${local.token}", #input the access token, or you can create it from `tencentcloud_tcr_token` + "global.imagePullSecretsCrs[0].dockerServer=${local.tcr_name}-vpc.tencentcloudcr.com", #invalid format as: `${tcr_name}-vpc.tencentcloudcr.com` + "global.imagePullSecretsCrs[1].name=${local.tcr_id}-public", #specify a unique name, invalid format as: `${tcr_id}-public` + "global.imagePullSecretsCrs[1].namespaces=${local.ns_name}", + "global.imagePullSecretsCrs[1].serviceAccounts=*", + "global.imagePullSecretsCrs[1].type=docker", + "global.imagePullSecretsCrs[1].dockerUsername=${local.user_name}", #refer to previous description + "global.imagePullSecretsCrs[1].dockerPassword=${local.token}", #refer to previous description + "global.imagePullSecretsCrs[1].dockerServer=${local.tcr_name}.tencentcloudcr.com", #invalid format as: `${tcr_name}.tencentcloudcr.com` + "global.cluster.region=gz", + "global.cluster.longregion=ap-guangzhou", + # Specify global hosts(optional), the numbers of hosts must be matched with the numbers of imagePullSecretsCrs + "global.hosts[0].domain=${local.tcr_name}-vpc.tencentcloudcr.com", #Corresponds to the dockerServer in the imagePullSecretsCrs above + "global.hosts[0].ip=${local.end_point}", #input InternalEndpoint of tcr instance, you can get it from data source `tencentcloud_tcr_instances` + "global.hosts[0].disabled=false", #disabled this host config or not + "global.hosts[1].domain=${local.tcr_name}.tencentcloudcr.com", + "global.hosts[1].ip=${local.end_point}", + "global.hosts[1].disabled=false", + ] +} + +locals { + tcr_id = tencentcloud_tcr_instance.mytcr.id + tcr_name = tencentcloud_tcr_instance.mytcr.name + ns_name = tencentcloud_tcr_namespace.my_ns.name + user_name = tencentcloud_tcr_token.my_token.user_name + token = tencentcloud_tcr_token.my_token.token + end_point = data.tencentcloud_tcr_instances.my_ins.instance_list.0.internal_end_point +} + +resource "tencentcloud_tcr_token" "my_token" { + instance_id = local.tcr_id + description = "tcr token" +} + +data "tencentcloud_tcr_instances" "my_ins" { + instance_id = local.tcr_id +} + +resource "tencentcloud_tcr_instance" "mytcr" { + name = "tf-test-tcr-addon" + instance_type = "basic" + delete_bucket = true + + tags = { + test = "test" + } +} + +resource "tencentcloud_tcr_namespace" "my_ns" { + instance_id = local.tcr_id + name = "tf_test_tcr_ns_addon" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "cve-xxxxx" + } +} +``` + +### Install new addon by passing spec json to req_body directly + +```hcl +resource "tencentcloud_kubernetes_addon_attachment" "addon_cbs" { + cluster_id = "cls-xxxxxxxx" + request_body = < **NOTE:** Only available for cluster version >= 1.20 + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +variable "cluster_cidr" { + default = "172.16.0.0/16" +} + +variable "default_instance_type" { + default = "S1.SMALL1" +} + +data "tencentcloud_images" "default" { + image_type = ["PUBLIC_IMAGE"] + os_name = "centos" +} + +data "tencentcloud_vpc_subnets" "vpc" { + is_default = true + availability_zone = var.availability_zone +} + +resource "tencentcloud_kubernetes_cluster" "managed_cluster" { + vpc_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.vpc_id + cluster_cidr = "10.31.0.0/16" + cluster_max_pod_num = 32 + cluster_name = "keep" + cluster_desc = "test cluster desc" + cluster_version = "1.20.6" + cluster_max_service_num = 32 + + worker_config { + count = 1 + availability_zone = var.availability_zone + instance_type = var.default_instance_type + system_disk_type = "CLOUD_SSD" + system_disk_size = 60 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + subnet_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.subnet_id + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + password = "ZZXXccvv1212" + } + + cluster_deploy_type = "MANAGED_CLUSTER" +} + +resource "tencentcloud_kubernetes_auth_attachment" "test_auth_attach" { + cluster_id = tencentcloud_kubernetes_cluster.managed_cluster.id + jwks_uri = "https://${tencentcloud_kubernetes_cluster.managed_cluster.id}.ccs.tencent-cloud.com/openid/v1/jwks" + issuer = "https://${tencentcloud_kubernetes_cluster.managed_cluster.id}.ccs.tencent-cloud.com" + auto_create_discovery_anonymous_auth = true +} +``` + +### Use the TKE default issuer and jwks_uri + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +variable "cluster_cidr" { + default = "172.16.0.0/16" +} + +variable "default_instance_type" { + default = "S1.SMALL1" +} + +data "tencentcloud_images" "default" { + image_type = ["PUBLIC_IMAGE"] + os_name = "centos" +} + +data "tencentcloud_vpc_subnets" "vpc" { + is_default = true + availability_zone = var.availability_zone +} + +resource "tencentcloud_kubernetes_cluster" "managed_cluster" { + vpc_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.vpc_id + cluster_cidr = "10.31.0.0/16" + cluster_max_pod_num = 32 + cluster_name = "keep" + cluster_desc = "test cluster desc" + cluster_version = "1.20.6" + cluster_max_service_num = 32 + + worker_config { + count = 1 + availability_zone = var.availability_zone + instance_type = var.default_instance_type + system_disk_type = "CLOUD_SSD" + system_disk_size = 60 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + subnet_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.subnet_id + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + password = "ZZXXccvv1212" + } + + cluster_deploy_type = "MANAGED_CLUSTER" +} + +# if you want to use tke default issuer and jwks_uri, please set use_tke_default to true and set issuer to empty string. +resource "tencentcloud_kubernetes_auth_attachment" "test_use_tke_default_auth_attach" { + cluster_id = tencentcloud_kubernetes_cluster.managed_cluster.id + auto_create_discovery_anonymous_auth = true + use_tke_default = true +} +``` + +### Use OIDC Config + +```hcl +resource "tencentcloud_kubernetes_auth_attachment" "test_auth_attach" { + cluster_id = tencentcloud_kubernetes_cluster.managed_cluster.id + use_tke_default = true + auto_create_discovery_anonymous_auth = true + auto_create_oidc_config = true + auto_install_pod_identity_webhook_addon = true +} + +data "tencentcloud_cam_oidc_config" "oidc_config" { + name = tencentcloud_kubernetes_cluster.managed_cluster.id + depends_on = [ + tencentcloud_kubernetes_auth_attachment.test_auth_attach + ] +} + +output "identity_key" { + value = data.tencentcloud_cam_oidc_config.oidc_config.identity_key +} + +output "identity_url" { + value = data.tencentcloud_cam_oidc_config.oidc_config.identity_url +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) ID of clusters. +* `auto_create_client_id` - (Optional, Set: [`String`]) Creating ClientId of the identity provider. +* `auto_create_discovery_anonymous_auth` - (Optional, Bool) If set to `true`, the rbac rule will be created automatically which allow anonymous user to access '/.well-known/openid-configuration' and '/openid/v1/jwks'. +* `auto_create_oidc_config` - (Optional, Bool) Creating an identity provider. +* `auto_install_pod_identity_webhook_addon` - (Optional, Bool) Creating the PodIdentityWebhook component. if `auto_create_oidc_config` is true, this field must set true. +* `issuer` - (Optional, String) Specify service-account-issuer. If use_tke_default is set to `true`, please do not set this field. +* `jwks_uri` - (Optional, String) Specify service-account-jwks-uri. If use_tke_default is set to `true`, please do not set this field. +* `use_tke_default` - (Optional, Bool) If set to `true`, the issuer and jwks_uri will be generated automatically by tke, please do not set issuer and jwks_uri. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `tke_default_issuer` - The default issuer of tke. If use_tke_default is set to `true`, this parameter will be set to the default value. +* `tke_default_jwks_uri` - The default jwks_uri of tke. If use_tke_default is set to `true`, this parameter will be set to the default value. + + diff --git a/config/docs/r/kubernetes_backup_storage_location.html.markdown b/config/docs/r/kubernetes_backup_storage_location.html.markdown new file mode 100644 index 0000000..05ccd52 --- /dev/null +++ b/config/docs/r/kubernetes_backup_storage_location.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_backup_storage_location" +sidebar_current: "docs-tencentcloud-resource-kubernetes_backup_storage_location" +description: |- + Provide a resource to create tke backup storage location. +--- + +# tencentcloud_kubernetes_backup_storage_location + +Provide a resource to create tke backup storage location. + +~> **NOTE:** To create this resource, you need to create a cos bucket with prefix "tke-backup" in advance. + +## Example Usage + +```hcl +resource "tencentcloud_kubernetes_backup_storage_location" "example_backup" { + name = "example-backup-1" + storage_region = "ap-guangzhou" # region of you pre-created COS bucket + bucket = "tke-backup-example-1" # bucket name of your pre-created COS bucket +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket` - (Required, String, ForceNew) Name of the bucket. +* `name` - (Required, String, ForceNew) Name of the backup storage location. +* `storage_region` - (Required, String, ForceNew) Region of the storage. +* `path` - (Optional, String, ForceNew) Prefix of the bucket. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `message` - Message of the backup storage location. +* `state` - State of the backup storage location. + + +## Import + +tke backup storage location can be imported, e.g. + +``` +$ terraform import tencentcloud_kubernetes_backup_storage_location.test xxx +``` + diff --git a/config/docs/r/kubernetes_cluster.html.markdown b/config/docs/r/kubernetes_cluster.html.markdown new file mode 100644 index 0000000..554fce7 --- /dev/null +++ b/config/docs/r/kubernetes_cluster.html.markdown @@ -0,0 +1,1006 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_cluster" +sidebar_current: "docs-tencentcloud-resource-kubernetes_cluster" +description: |- + Provide a resource to create a kubernetes cluster. +--- + +# tencentcloud_kubernetes_cluster + +Provide a resource to create a kubernetes cluster. + +~> **NOTE:** To use the custom Kubernetes component startup parameter function (parameter `extra_args`), you need to submit a ticket for application. + +~> **NOTE:** We recommend this usage that uses the `tencentcloud_kubernetes_cluster` resource to create a cluster without any `worker_config`, then adds nodes by the `tencentcloud_kubernetes_node_pool` resource. +It's more flexible than managing worker config directly with `tencentcloud_kubernetes_cluster`, `tencentcloud_kubernetes_scale_worker`, or existing node management of `tencentcloud_kubernetes_attachment`. The reason is that `worker_config` is unchangeable and may cause the whole cluster resource to `ForceNew`. + +## Example Usage + +### Create a basic cluster with two worker nodes + +```hcl +variable "default_instance_type" { + default = "SA2.2XLARGE16" +} + +variable "availability_zone_first" { + default = "ap-guangzhou-3" +} + +variable "availability_zone_second" { + default = "ap-guangzhou-4" +} + +variable "example_cluster_cidr" { + default = "10.31.0.0/16" +} + +locals { + first_vpc_id = data.tencentcloud_vpc_subnets.vpc_one.instance_list.0.vpc_id + first_subnet_id = data.tencentcloud_vpc_subnets.vpc_one.instance_list.0.subnet_id + second_vpc_id = data.tencentcloud_vpc_subnets.vpc_two.instance_list.0.vpc_id + second_subnet_id = data.tencentcloud_vpc_subnets.vpc_two.instance_list.0.subnet_id + sg_id = tencentcloud_security_group.sg.id + image_id = data.tencentcloud_images.default.image_id +} + +data "tencentcloud_vpc_subnets" "vpc_one" { + is_default = true + availability_zone = var.availability_zone_first +} + +data "tencentcloud_vpc_subnets" "vpc_two" { + is_default = true + availability_zone = var.availability_zone_second +} + +resource "tencentcloud_security_group" "sg" { + name = "tf-example-sg" +} + +resource "tencentcloud_security_group_lite_rule" "sg_rule" { + security_group_id = tencentcloud_security_group.sg.id + + ingress = [ + "ACCEPT#10.0.0.0/16#ALL#ALL", + "ACCEPT#172.16.0.0/22#ALL#ALL", + "DROP#0.0.0.0/0#ALL#ALL", + ] + + egress = [ + "ACCEPT#172.16.0.0/22#ALL#ALL", + ] +} + +data "tencentcloud_images" "default" { + image_type = ["PUBLIC_IMAGE"] + image_name_regex = "Final" +} + +resource "tencentcloud_kubernetes_cluster" "example" { + vpc_id = local.first_vpc_id + cluster_cidr = var.example_cluster_cidr + cluster_max_pod_num = 32 + cluster_name = "tf_example_cluster" + cluster_desc = "example for tke cluster" + cluster_max_service_num = 32 + cluster_internet = false + cluster_internet_security_group = local.sg_id + cluster_version = "1.22.5" + cluster_deploy_type = "MANAGED_CLUSTER" + + worker_config { + count = 1 + availability_zone = var.availability_zone_first + instance_type = var.default_instance_type + system_disk_type = "CLOUD_SSD" + system_disk_size = 60 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + subnet_id = local.first_subnet_id + img_id = local.image_id + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + # key_ids = ["skey-11112222"] + password = "ZZXXccvv1212" // Optional, should be set if key_ids not set. + } + + worker_config { + count = 1 + availability_zone = var.availability_zone_second + instance_type = var.default_instance_type + system_disk_type = "CLOUD_SSD" + system_disk_size = 60 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + subnet_id = local.second_subnet_id + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + key_ids = ["skey-11112222"] + cam_role_name = "CVM_QcsRole" + # password = "ZZXXccvv1212" // Optional, should be set if key_ids not set. + } + + labels = { + "test1" = "test1", + "test2" = "test2", + } +} +``` + +### Create an empty cluster with a node pool + +The cluster does not have any nodes, nodes will be added through node pool. + +```hcl +variable "default_instance_type" { + default = "SA2.2XLARGE16" +} + +variable "availability_zone_first" { + default = "ap-guangzhou-3" +} + +variable "availability_zone_second" { + default = "ap-guangzhou-4" +} + +variable "example_cluster_cidr" { + default = "10.31.0.0/16" +} + +locals { + first_vpc_id = data.tencentcloud_vpc_subnets.vpc_one.instance_list.0.vpc_id + first_subnet_id = data.tencentcloud_vpc_subnets.vpc_one.instance_list.0.subnet_id + sg_id = tencentcloud_security_group.sg.id +} + +data "tencentcloud_vpc_subnets" "vpc_one" { + is_default = true + availability_zone = var.availability_zone_first +} + +data "tencentcloud_vpc_subnets" "vpc_two" { + is_default = true + availability_zone = var.availability_zone_second +} + +resource "tencentcloud_security_group" "sg" { + name = "tf-example-np-sg" +} + +resource "tencentcloud_security_group_lite_rule" "sg_rule" { + security_group_id = tencentcloud_security_group.sg.id + + ingress = [ + "ACCEPT#10.0.0.0/16#ALL#ALL", + "ACCEPT#172.16.0.0/22#ALL#ALL", + "DROP#0.0.0.0/0#ALL#ALL", + ] + + egress = [ + "ACCEPT#172.16.0.0/22#ALL#ALL", + ] +} + +resource "tencentcloud_kubernetes_cluster" "example" { + vpc_id = local.first_vpc_id + cluster_cidr = var.example_cluster_cidr + cluster_max_pod_num = 32 + cluster_name = "tf_example_cluster_np" + cluster_desc = "example for tke cluster" + cluster_max_service_num = 32 + cluster_version = "1.22.5" + cluster_deploy_type = "MANAGED_CLUSTER" + # without any worker config +} + +resource "tencentcloud_kubernetes_node_pool" "example" { + name = "tf_example_node_pool" + cluster_id = tencentcloud_kubernetes_cluster.example.id + max_size = 6 # set the node scaling range [1,6] + min_size = 1 + vpc_id = local.first_vpc_id + subnet_ids = [local.first_subnet_id] + retry_policy = "INCREMENTAL_INTERVALS" + desired_capacity = 4 + enable_auto_scale = true + multi_zone_subnet_policy = "EQUALITY" + + auto_scaling_config { + instance_type = var.default_instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = "50" + orderly_security_group_ids = [local.sg_id] + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 10 + public_ip_assigned = true + password = "test123#" + enhanced_security_service = false + enhanced_monitor_service = false + host_name = "12.123.0.0" + host_name_style = "ORIGINAL" + } + + labels = { + "test1" = "test1", + "test2" = "test2", + } + + taints { + key = "test_taint" + value = "taint_value" + effect = "PreferNoSchedule" + } + + taints { + key = "test_taint2" + value = "taint_value2" + effect = "PreferNoSchedule" + } + + node_config { + extra_args = [ + "root-dir=/var/lib/kubelet" + ] + } +} +``` + +### Create a cluster with a node pool and open the network access with cluster endpoint + +The cluster's internet and intranet access will be opened after nodes are added through node pool. + +```hcl +variable "default_instance_type" { + default = "SA2.2XLARGE16" +} + +variable "availability_zone_first" { + default = "ap-guangzhou-3" +} + +variable "availability_zone_second" { + default = "ap-guangzhou-4" +} + +variable "example_cluster_cidr" { + default = "10.31.0.0/16" +} + +locals { + first_vpc_id = data.tencentcloud_vpc_subnets.vpc_one.instance_list.0.vpc_id + first_subnet_id = data.tencentcloud_vpc_subnets.vpc_one.instance_list.0.subnet_id + sg_id = tencentcloud_security_group.sg.id +} + +data "tencentcloud_vpc_subnets" "vpc_one" { + is_default = true + availability_zone = var.availability_zone_first +} + +data "tencentcloud_vpc_subnets" "vpc_two" { + is_default = true + availability_zone = var.availability_zone_second +} + +resource "tencentcloud_security_group" "sg" { + name = "tf-example-np-ep-sg" +} + +resource "tencentcloud_security_group_lite_rule" "sg_rule" { + security_group_id = tencentcloud_security_group.sg.id + + ingress = [ + "ACCEPT#10.0.0.0/16#ALL#ALL", + "ACCEPT#172.16.0.0/22#ALL#ALL", + "DROP#0.0.0.0/0#ALL#ALL", + ] + + egress = [ + "ACCEPT#172.16.0.0/22#ALL#ALL", + ] +} + +resource "tencentcloud_kubernetes_cluster" "example" { + vpc_id = local.first_vpc_id + cluster_cidr = var.example_cluster_cidr + cluster_max_pod_num = 32 + cluster_name = "tf_example_cluster" + cluster_desc = "example for tke cluster" + cluster_max_service_num = 32 + cluster_internet = false # (can be ignored) open it after the nodes added + cluster_version = "1.22.5" + cluster_deploy_type = "MANAGED_CLUSTER" + # without any worker config +} + +resource "tencentcloud_kubernetes_node_pool" "example" { + name = "tf_example_node_pool" + cluster_id = tencentcloud_kubernetes_cluster.example.id + max_size = 6 # set the node scaling range [1,6] + min_size = 1 + vpc_id = local.first_vpc_id + subnet_ids = [local.first_subnet_id] + retry_policy = "INCREMENTAL_INTERVALS" + desired_capacity = 4 + enable_auto_scale = true + multi_zone_subnet_policy = "EQUALITY" + + auto_scaling_config { + instance_type = var.default_instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = "50" + orderly_security_group_ids = [local.sg_id] + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 10 + public_ip_assigned = true + password = "test123#" + enhanced_security_service = false + enhanced_monitor_service = false + host_name = "12.123.0.0" + host_name_style = "ORIGINAL" + } + + labels = { + "test1" = "test1", + "test2" = "test2", + } + + taints { + key = "test_taint" + value = "taint_value" + effect = "PreferNoSchedule" + } + + taints { + key = "test_taint2" + value = "taint_value2" + effect = "PreferNoSchedule" + } + + node_config { + extra_args = [ + "root-dir=/var/lib/kubelet" + ] + } +} + +resource "tencentcloud_kubernetes_cluster_endpoint" "example" { + cluster_id = tencentcloud_kubernetes_cluster.example.id + cluster_internet = true # open the internet here + cluster_intranet = true + cluster_internet_security_group = local.sg_id + cluster_intranet_subnet_id = local.first_subnet_id + depends_on = [ # wait for the node pool ready + tencentcloud_kubernetes_node_pool.example + ] +} +``` + +### Use Kubelet + +```hcl +# Create a baisc kubernetes cluster with two nodes. +variable "default_instance_type" { + default = "SA2.2XLARGE16" +} + +variable "availability_zone_first" { + default = "ap-guangzhou-3" +} + +variable "availability_zone_second" { + default = "ap-guangzhou-4" +} + +variable "example_cluster_cidr" { + default = "10.31.0.0/16" +} + +locals { + first_vpc_id = data.tencentcloud_vpc_subnets.vpc_one.instance_list.0.vpc_id + first_subnet_id = data.tencentcloud_vpc_subnets.vpc_one.instance_list.0.subnet_id + second_vpc_id = data.tencentcloud_vpc_subnets.vpc_two.instance_list.0.vpc_id + second_subnet_id = data.tencentcloud_vpc_subnets.vpc_two.instance_list.0.subnet_id + sg_id = tencentcloud_security_group.sg.id + image_id = data.tencentcloud_images.default.image_id +} + +data "tencentcloud_vpc_subnets" "vpc_one" { + is_default = true + availability_zone = var.availability_zone_first +} + +data "tencentcloud_vpc_subnets" "vpc_two" { + is_default = true + availability_zone = var.availability_zone_second +} + +resource "tencentcloud_security_group" "sg" { + name = "tf-example-sg" +} + +resource "tencentcloud_security_group_lite_rule" "sg_rule" { + security_group_id = tencentcloud_security_group.sg.id + + ingress = [ + "ACCEPT#10.0.0.0/16#ALL#ALL", + "ACCEPT#172.16.0.0/22#ALL#ALL", + "DROP#0.0.0.0/0#ALL#ALL", + ] + + egress = [ + "ACCEPT#172.16.0.0/22#ALL#ALL", + ] +} + +data "tencentcloud_images" "default" { + image_type = ["PUBLIC_IMAGE"] + image_name_regex = "Final" +} + +resource "tencentcloud_kubernetes_cluster" "example" { + vpc_id = local.first_vpc_id + cluster_cidr = var.example_cluster_cidr + cluster_max_pod_num = 32 + cluster_name = "tf_example_cluster" + cluster_desc = "example for tke cluster" + cluster_max_service_num = 32 + cluster_internet = false + cluster_internet_security_group = local.sg_id + cluster_version = "1.22.5" + cluster_deploy_type = "MANAGED_CLUSTER" + + worker_config { + count = 1 + availability_zone = var.availability_zone_first + instance_type = var.default_instance_type + system_disk_type = "CLOUD_SSD" + system_disk_size = 60 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + subnet_id = local.first_subnet_id + img_id = local.image_id + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + encrypt = false + } + + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + disaster_recover_group_ids = [] + security_group_ids = [] + key_ids = [] + password = "ZZXXccvv1212" // Optional, should be set if key_ids not set. + } + + worker_config { + count = 1 + availability_zone = var.availability_zone_second + instance_type = var.default_instance_type + system_disk_type = "CLOUD_SSD" + system_disk_size = 60 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + subnet_id = local.second_subnet_id + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + disaster_recover_group_ids = [] + security_group_ids = [] + key_ids = [] + cam_role_name = "CVM_QcsRole" + password = "ZZXXccvv1212" // Optional, should be set if key_ids not set. + } + + labels = { + "test1" = "test1", + "test2" = "test2", + } + + extra_args = [ + "root-dir=/var/lib/kubelet" + ] +} +``` + +### Use extension addons + +```hcl +variable "availability_zone_first" { + default = "ap-guangzhou-3" +} + +variable "cluster_cidr" { + default = "10.31.0.0/16" +} + +variable "default_instance_type" { + default = "S5.SMALL1" +} + +data "tencentcloud_vpc_subnets" "vpc_first" { + is_default = true + availability_zone = var.availability_zone_first +} + +# fetch latest addon(chart) versions +data "tencentcloud_kubernetes_charts" "charts" {} + +locals { + chartNames = data.tencentcloud_kubernetes_charts.charts.chart_list.*.name + chartVersions = data.tencentcloud_kubernetes_charts.charts.chart_list.*.latest_version + chartMap = zipmap(local.chartNames, local.chartVersions) +} + +resource "tencentcloud_kubernetes_cluster" "cluster_with_addon" { + vpc_id = data.tencentcloud_vpc_subnets.vpc_first.instance_list.0.vpc_id + cluster_cidr = var.cluster_cidr + cluster_max_pod_num = 32 + cluster_name = "test" + cluster_desc = "test cluster desc" + cluster_max_service_num = 32 + cluster_internet = true + # managed_cluster_internet_security_policies = ["3.3.3.3", "1.1.1.1"] + cluster_deploy_type = "MANAGED_CLUSTER" + + worker_config { + count = 1 + availability_zone = var.availability_zone_first + instance_type = var.default_instance_type + system_disk_type = "CLOUD_SSD" + system_disk_size = 60 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + subnet_id = data.tencentcloud_vpc_subnets.vpc_first.instance_list.0.subnet_id + img_id = "img-rkiynh11" + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + # password = "ZZXXccvv1212" // Optional, should be set if key_ids not set. + key_ids = "skey-11112222" + } + + extension_addon { + name = "COS" + param = jsonencode({ + "kind" : "App", "spec" : { + "chart" : { "chartName" : "cos", "chartVersion" : local.chartMap["cos"] }, + "values" : { "values" : [], "rawValues" : "e30=", "rawValuesType" : "json" } + } + }) + } + extension_addon { + name = "SecurityGroupPolicy" + param = jsonencode({ + "kind" : "App", "spec" : { "chart" : { "chartName" : "securitygrouppolicy", "chartVersion" : local.chartMap["securitygrouppolicy"] } } + }) + } + extension_addon { + name = "OOMGuard" + param = jsonencode({ + "kind" : "App", "spec" : { "chart" : { "chartName" : "oomguard", "chartVersion" : local.chartMap["oomguard"] } } + }) + } + extension_addon { + name = "OLM" + param = jsonencode({ + "kind" : "App", "spec" : { "chart" : { "chartName" : "olm", "chartVersion" : local.chartMap["olm"] } } + }) + } +} +``` + +### Use node pool global config + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +variable "vpc" { + default = "vpc-dk8zmwuf" +} + +variable "subnet" { + default = "subnet-pqfek0t8" +} + +variable "default_instance_type" { + default = "SA1.LARGE8" +} + +resource "tencentcloud_kubernetes_cluster" "test_node_pool_global_config" { + vpc_id = var.vpc + cluster_cidr = "10.1.0.0/16" + cluster_max_pod_num = 32 + cluster_name = "test" + cluster_desc = "test cluster desc" + cluster_max_service_num = 32 + cluster_internet = true + # managed_cluster_internet_security_policies = ["3.3.3.3", "1.1.1.1"] + cluster_deploy_type = "MANAGED_CLUSTER" + + worker_config { + count = 1 + availability_zone = var.availability_zone + instance_type = var.default_instance_type + system_disk_type = "CLOUD_SSD" + system_disk_size = 60 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + subnet_id = var.subnet + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + # password = "ZZXXccvv1212" // Optional, should be set if key_ids not set. + key_ids = "skey-11112222" + } + + node_pool_global_config { + is_scale_in_enabled = true + expander = "random" + ignore_daemon_sets_utilization = true + max_concurrent_scale_in = 5 + scale_in_delay = 15 + scale_in_unneeded_time = 15 + scale_in_utilization_threshold = 30 + skip_nodes_with_local_storage = false + skip_nodes_with_system_pods = true + } + + labels = { + "test1" = "test1", + "test2" = "test2", + } +} +``` + +### Using VPC-CNI network type + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-1" +} + +variable "vpc" { + default = "vpc-r1m1fyx5" +} + +variable "default_instance_type" { + default = "SA2.SMALL2" +} + +resource "tencentcloud_kubernetes_cluster" "managed_cluster" { + vpc_id = var.vpc + cluster_max_pod_num = 32 + cluster_name = "test" + cluster_desc = "test cluster desc" + cluster_max_service_num = 256 + cluster_internet = true + # managed_cluster_internet_security_policies = ["3.3.3.3", "1.1.1.1"] + cluster_deploy_type = "MANAGED_CLUSTER" + network_type = "VPC-CNI" + eni_subnet_ids = ["subnet-bk1etlyu"] + service_cidr = "10.1.0.0/24" + + worker_config { + count = 1 + availability_zone = var.availability_zone + instance_type = var.default_instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 60 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + subnet_id = "subnet-t5dv27rs" + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + # password = "ZZXXccvv1212" // Optional, should be set if key_ids not set. + key_ids = "skey-11112222" + } + + labels = { + "test1" = "test1", + "test2" = "test2", + } +} +``` + +### Using ops options + +```hcl +resource "tencentcloud_kubernetes_cluster" "managed_cluster" { + # ...your basic fields + + log_agent { + enabled = true + kubelet_root_dir = "" # optional + } + + event_persistence { + enabled = true + log_set_id = "" # optional + topic_id = "" # optional + } + + cluster_audit { + enabled = true + log_set_id = "" # optional + topic_id = "" # optional + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `vpc_id` - (Required, String, ForceNew) Vpc Id of the cluster. +* `acquire_cluster_admin_role` - (Optional, Bool) If set to true, it will acquire the ClusterRole tke:admin. NOTE: this arguments cannot revoke to `false` after acquired. +* `auth_options` - (Optional, List) Specify cluster authentication configuration. Only available for managed cluster and `cluster_version` >= 1.20. +* `auto_upgrade_cluster_level` - (Optional, Bool) Whether the cluster level auto upgraded, valid for managed cluster. +* `base_pod_num` - (Optional, Int, ForceNew) The number of basic pods. valid when enable_customized_pod_cidr=true. +* `claim_expired_seconds` - (Optional, Int) Claim expired seconds to recycle ENI. This field can only set when field `network_type` is 'VPC-CNI'. `claim_expired_seconds` must greater or equal than 300 and less than 15768000. +* `cluster_audit` - (Optional, List) Specify Cluster Audit config. NOTE: Please make sure your TKE CamRole have permission to access CLS service. +* `cluster_cidr` - (Optional, String, ForceNew) A network address block of the cluster. Different from vpc cidr and cidr of other clusters within this vpc. Must be in 10./192.168/172.[16-31] segments. +* `cluster_deploy_type` - (Optional, String, ForceNew) Deployment type of the cluster, the available values include: 'MANAGED_CLUSTER' and 'INDEPENDENT_CLUSTER'. Default is 'MANAGED_CLUSTER'. +* `cluster_desc` - (Optional, String) Description of the cluster. +* `cluster_extra_args` - (Optional, List, ForceNew) Customized parameters for master component,such as kube-apiserver, kube-controller-manager, kube-scheduler. +* `cluster_internet_domain` - (Optional, String) Domain name for cluster Kube-apiserver internet access. Be careful if you modify value of this parameter, the cluster_external_endpoint value may be changed automatically too. +* `cluster_internet_security_group` - (Optional, String) Specify security group, NOTE: This argument must not be empty if cluster internet enabled. +* `cluster_internet` - (Optional, Bool) Open internet access or not. If this field is set 'true', the field below `worker_config` must be set. Because only cluster with node is allowed enable access endpoint. You may open it through `tencentcloud_kubernetes_cluster_endpoint`. +* `cluster_intranet_domain` - (Optional, String) Domain name for cluster Kube-apiserver intranet access. Be careful if you modify value of this parameter, the pgw_endpoint value may be changed automatically too. +* `cluster_intranet_subnet_id` - (Optional, String) Subnet id who can access this independent cluster, this field must and can only set when `cluster_intranet` is true. `cluster_intranet_subnet_id` can not modify once be set. +* `cluster_intranet` - (Optional, Bool) Open intranet access or not. If this field is set 'true', the field below `worker_config` must be set. Because only cluster with node is allowed enable access endpoint. You may open it through `tencentcloud_kubernetes_cluster_endpoint`. +* `cluster_ipvs` - (Optional, Bool, ForceNew) Indicates whether `ipvs` is enabled. Default is true. False means `iptables` is enabled. +* `cluster_level` - (Optional, String) Specify cluster level, valid for managed cluster, use data source `tencentcloud_kubernetes_cluster_levels` to query available levels. Available value examples `L5`, `L20`, `L50`, `L100`, etc. +* `cluster_max_pod_num` - (Optional, Int, ForceNew) The maximum number of Pods per node in the cluster. Default is 256. The minimum value is 4. When its power unequal to 2, it will round upward to the closest power of 2. +* `cluster_max_service_num` - (Optional, Int, ForceNew) The maximum number of services in the cluster. Default is 256. The range is from 32 to 32768. When its power unequal to 2, it will round upward to the closest power of 2. +* `cluster_name` - (Optional, String) Name of the cluster. +* `cluster_os_type` - (Optional, String, ForceNew) Image type of the cluster os, the available values include: 'GENERAL'. Default is 'GENERAL'. +* `cluster_os` - (Optional, String, ForceNew) Operating system of the cluster, the available values include: 'centos7.6.0_x64','ubuntu18.04.1x86_64','tlinux2.4x86_64'. Default is 'tlinux2.4x86_64'. +* `cluster_subnet_id` - (Optional, String) Subnet ID of the cluster, such as: subnet-b3p7d7q5. +* `cluster_version` - (Optional, String) Version of the cluster. Use `tencentcloud_kubernetes_available_cluster_versions` to get the upgradable cluster version. +* `container_runtime` - (Optional, String, ForceNew) Runtime type of the cluster, the available values include: 'docker' and 'containerd'.The Kubernetes v1.24 has removed dockershim, so please use containerd in v1.24 or higher.Default is 'docker'. +* `deletion_protection` - (Optional, Bool) Indicates whether cluster deletion protection is enabled. Default is false. +* `docker_graph_path` - (Optional, String, ForceNew) Docker graph path. Default is `/var/lib/docker`. +* `enable_customized_pod_cidr` - (Optional, Bool) Whether to enable the custom mode of node podCIDR size. Default is false. +* `eni_subnet_ids` - (Optional, List: [`String`]) Subnet Ids for cluster with VPC-CNI network mode. This field can only set when field `network_type` is 'VPC-CNI'. `eni_subnet_ids` can not empty once be set. +* `event_persistence` - (Optional, List) Specify cluster Event Persistence config. NOTE: Please make sure your TKE CamRole have permission to access CLS service. +* `exist_instance` - (Optional, List, ForceNew) create tke cluster by existed instances. +* `extension_addon` - (Optional, List) Information of the add-on to be installed. +* `extra_args` - (Optional, List: [`String`], ForceNew) Custom parameter information related to the node. +* `globe_desired_pod_num` - (Optional, Int, ForceNew) Indicate to set desired pod number in node. valid when enable_customized_pod_cidr=true, and it takes effect for all nodes. +* `ignore_cluster_cidr_conflict` - (Optional, Bool, ForceNew) Indicates whether to ignore the cluster cidr conflict error. Default is false. +* `is_non_static_ip_mode` - (Optional, Bool, ForceNew) Indicates whether non-static ip mode is enabled. Default is false. +* `kube_proxy_mode` - (Optional, String) Cluster kube-proxy mode, the available values include: 'kube-proxy-bpf'. Default is not set.When set to kube-proxy-bpf, cluster version greater than 1.14 and with Tencent Linux 2.4 is required. +* `labels` - (Optional, Map, ForceNew) Labels of tke cluster nodes. +* `log_agent` - (Optional, List) Specify cluster log agent config. +* `managed_cluster_internet_security_policies` - (Optional, List: [`String`], **Deprecated**) this argument was deprecated, use `cluster_internet_security_group` instead. Security policies for managed cluster internet, like:'192.168.1.0/24' or '113.116.51.27', '0.0.0.0/0' means all. This field can only set when field `cluster_deploy_type` is 'MANAGED_CLUSTER' and `cluster_internet` is true. `managed_cluster_internet_security_policies` can not delete or empty once be set. +* `master_config` - (Optional, List, ForceNew) Deploy the machine configuration information of the 'MASTER_ETCD' service, and create <=7 units for common users. +* `mount_target` - (Optional, String, ForceNew) Mount target. Default is not mounting. +* `network_type` - (Optional, String, ForceNew) Cluster network type, the available values include: 'GR' and 'VPC-CNI' and 'CiliumOverlay'. Default is GR. +* `node_name_type` - (Optional, String, ForceNew) Node name type of Cluster, the available values include: 'lan-ip' and 'hostname', Default is 'lan-ip'. +* `node_pool_global_config` - (Optional, List) Global config effective for all node pools. +* `project_id` - (Optional, Int) Project ID, default value is 0. +* `runtime_version` - (Optional, String) Container Runtime version. +* `service_cidr` - (Optional, String, ForceNew) A network address block of the service. Different from vpc cidr and cidr of other clusters within this vpc. Must be in 10./192.168/172.[16-31] segments. +* `tags` - (Optional, Map) The tags of the cluster. +* `unschedulable` - (Optional, Int, ForceNew) Sets whether the joining node participates in the schedule. Default is '0'. Participate in scheduling. +* `upgrade_instances_follow_cluster` - (Optional, Bool) Indicates whether upgrade all instances when cluster_version change. Default is false. +* `vpc_cni_type` - (Optional, String) Distinguish between shared network card multi-IP mode and independent network card mode. Fill in `tke-route-eni` for shared network card multi-IP mode and `tke-direct-eni` for independent network card mode. The default is shared network card mode. When it is necessary to turn off the vpc-cni container network capability, both `eni_subnet_ids` and `vpc_cni_type` must be set to empty. +* `worker_config` - (Optional, List, ForceNew) Deploy the machine configuration information of the 'WORKER' service, and create <=20 units for common users. The other 'WORK' service are added by 'tencentcloud_kubernetes_worker'. + +The `auth_options` object supports the following: + +* `auto_create_discovery_anonymous_auth` - (Optional, Bool) If set to `true`, the rbac rule will be created automatically which allow anonymous user to access '/.well-known/openid-configuration' and '/openid/v1/jwks'. +* `issuer` - (Optional, String) Specify service-account-issuer. If use_tke_default is set to `true`, please do not set this field, it will be ignored anyway. +* `jwks_uri` - (Optional, String) Specify service-account-jwks-uri. If use_tke_default is set to `true`, please do not set this field, it will be ignored anyway. +* `use_tke_default` - (Optional, Bool) If set to `true`, the issuer and jwks_uri will be generated automatically by tke, please do not set issuer and jwks_uri, and they will be ignored. + +The `cluster_audit` object supports the following: + +* `enabled` - (Required, Bool) Specify weather the Cluster Audit enabled. NOTE: Enable Cluster Audit will also auto install Log Agent. +* `delete_audit_log_and_topic` - (Optional, Bool) when you want to close the cluster audit log or delete the cluster, you can use this parameter to determine whether the audit log set and topic created by default will be deleted. +* `log_set_id` - (Optional, String) Specify id of existing CLS log set, or auto create a new set by leave it empty. +* `topic_id` - (Optional, String) Specify id of existing CLS log topic, or auto create a new topic by leave it empty. + +The `cluster_extra_args` object supports the following: + +* `kube_apiserver` - (Optional, List, ForceNew) The customized parameters for kube-apiserver. +* `kube_controller_manager` - (Optional, List, ForceNew) The customized parameters for kube-controller-manager. +* `kube_scheduler` - (Optional, List, ForceNew) The customized parameters for kube-scheduler. + +The `data_disk` object supports the following: + +* `auto_format_and_mount` - (Optional, Bool, ForceNew) Indicate whether to auto format and mount or not. Default is `false`. +* `disk_partition` - (Optional, String, ForceNew) The name of the device or partition to mount. +* `disk_size` - (Optional, Int, ForceNew) Volume of disk in GB. Default is `0`. +* `disk_type` - (Optional, String, ForceNew) Types of disk, available values: `CLOUD_PREMIUM` and `CLOUD_SSD` and `CLOUD_HSSD` and `CLOUD_TSSD`. +* `encrypt` - (Optional, Bool) Indicates whether to encrypt data disk, default `false`. +* `file_system` - (Optional, String, ForceNew) File system, e.g. `ext3/ext4/xfs`. +* `kms_key_id` - (Optional, String) ID of the custom CMK in the format of UUID or `kms-abcd1234`. This parameter is used to encrypt cloud disks. +* `mount_target` - (Optional, String, ForceNew) Mount target. +* `snapshot_id` - (Optional, String, ForceNew) Data disk snapshot ID. + +The `event_persistence` object supports the following: + +* `enabled` - (Required, Bool) Specify weather the Event Persistence enabled. +* `delete_event_log_and_topic` - (Optional, Bool) when you want to close the cluster event persistence or delete the cluster, you can use this parameter to determine whether the event persistence log set and topic created by default will be deleted. +* `log_set_id` - (Optional, String) Specify id of existing CLS log set, or auto create a new set by leave it empty. +* `topic_id` - (Optional, String) Specify id of existing CLS log topic, or auto create a new topic by leave it empty. + +The `exist_instance` object supports the following: + +* `desired_pod_numbers` - (Optional, List, ForceNew) Custom mode cluster, you can specify the number of pods for each node. corresponding to the existed_instances_para.instance_ids parameter. +* `instances_para` - (Optional, List, ForceNew) Reinstallation parameters of an existing instance. +* `node_role` - (Optional, String, ForceNew) Role of existed node. value:MASTER_ETCD or WORKER. + +The `extension_addon` object supports the following: + +* `name` - (Required, String) Add-on name. +* `param` - (Required, String) Parameter of the add-on resource object in JSON string format, please check the example at the top of page for reference. + +The `instances_para` object supports the following: + +* `instance_ids` - (Required, List, ForceNew) Cluster IDs. + +The `log_agent` object supports the following: + +* `enabled` - (Required, Bool) Whether the log agent enabled. +* `kubelet_root_dir` - (Optional, String) Kubelet root directory as the literal. + +The `master_config` object supports the following: + +* `instance_type` - (Required, String, ForceNew) Specified types of CVM instance. +* `subnet_id` - (Required, String, ForceNew) Private network ID. +* `availability_zone` - (Optional, String, ForceNew) Indicates which availability zone will be used. +* `bandwidth_package_id` - (Optional, String) bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id. +* `cam_role_name` - (Optional, String, ForceNew) CAM role name authorized to access. +* `count` - (Optional, Int, ForceNew) Number of cvm. +* `data_disk` - (Optional, List, ForceNew) Configurations of data disk. +* `desired_pod_num` - (Optional, Int, ForceNew) Indicate to set desired pod number in node. valid when enable_customized_pod_cidr=true, and it override `[globe_]desired_pod_num` for current node. Either all the fields `desired_pod_num` or none. +* `disaster_recover_group_ids` - (Optional, List, ForceNew) Disaster recover groups to which a CVM instance belongs. Only support maximum 1. +* `enhanced_monitor_service` - (Optional, Bool, ForceNew) To specify whether to enable cloud monitor service. Default is TRUE. +* `enhanced_security_service` - (Optional, Bool, ForceNew) To specify whether to enable cloud security service. Default is TRUE. +* `hostname` - (Optional, String, ForceNew) The host name of the attached instance. Dot (.) and dash (-) cannot be used as the first and last characters of HostName and cannot be used consecutively. Windows example: The length of the name character is [2, 15], letters (capitalization is not restricted), numbers and dashes (-) are allowed, dots (.) are not supported, and not all numbers are allowed. Examples of other types (Linux, etc.): The character length is [2, 60], and multiple dots are allowed. There is a segment between the dots. Each segment allows letters (with no limitation on capitalization), numbers and dashes (-). +* `hpc_cluster_id` - (Optional, String) Id of cvm hpc cluster. +* `img_id` - (Optional, String) The valid image id, format of img-xxx. +* `instance_charge_type_prepaid_period` - (Optional, Int, ForceNew) 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`. +* `instance_charge_type_prepaid_renew_flag` - (Optional, String, ForceNew) 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`. +* `instance_charge_type` - (Optional, String, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. The default is `POSTPAID_BY_HOUR`. Note: TencentCloud International only supports `POSTPAID_BY_HOUR`, `PREPAID` instance will not terminated after cluster deleted, and may not allow to delete before expired. +* `instance_name` - (Optional, String, ForceNew) Name of the CVMs. +* `internet_charge_type` - (Optional, String, ForceNew) Charge types for network traffic. Available values include `TRAFFIC_POSTPAID_BY_HOUR`. +* `internet_max_bandwidth_out` - (Optional, Int) Max bandwidth of Internet access in Mbps. Default is 0. +* `key_ids` - (Optional, List, ForceNew) ID list of keys, should be set if `password` not set. +* `password` - (Optional, String, ForceNew) Password to access, should be set if `key_ids` not set. +* `public_ip_assigned` - (Optional, Bool, ForceNew) Specify whether to assign an Internet IP address. +* `security_group_ids` - (Optional, List, ForceNew) Security groups to which a CVM instance belongs. +* `system_disk_size` - (Optional, Int, ForceNew) Volume of system disk in GB. Default is `50`. +* `system_disk_type` - (Optional, String, ForceNew) System disk type. For more information on limits of system 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, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage. NOTE: `CLOUD_BASIC`, `LOCAL_BASIC` and `LOCAL_SSD` are deprecated. +* `user_data` - (Optional, String, ForceNew) ase64-encoded User Data text, the length limit is 16KB. + +The `node_pool_global_config` object supports the following: + +* `expander` - (Optional, String) Indicates which scale-out method will be used when there are multiple scaling groups. Valid values: `random` - select a random scaling group, `most-pods` - select the scaling group that can schedule the most pods, `least-waste` - select the scaling group that can ensure the fewest remaining resources after Pod scheduling. +* `ignore_daemon_sets_utilization` - (Optional, Bool) Whether to ignore DaemonSet pods by default when calculating resource usage. +* `is_scale_in_enabled` - (Optional, Bool) Indicates whether to enable scale-in. +* `max_concurrent_scale_in` - (Optional, Int) Max concurrent scale-in volume. +* `scale_in_delay` - (Optional, Int) Number of minutes after cluster scale-out when the system starts judging whether to perform scale-in. +* `scale_in_unneeded_time` - (Optional, Int) Number of consecutive minutes of idleness after which the node is subject to scale-in. +* `scale_in_utilization_threshold` - (Optional, Int) Percentage of node resource usage below which the node is considered to be idle. +* `skip_nodes_with_local_storage` - (Optional, Bool) During scale-in, ignore nodes with local storage pods. +* `skip_nodes_with_system_pods` - (Optional, Bool) During scale-in, ignore nodes with pods in the kube-system namespace that are not managed by DaemonSet. + +The `worker_config` object supports the following: + +* `instance_type` - (Required, String, ForceNew) Specified types of CVM instance. +* `subnet_id` - (Required, String, ForceNew) Private network ID. +* `availability_zone` - (Optional, String, ForceNew) Indicates which availability zone will be used. +* `bandwidth_package_id` - (Optional, String) bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id. +* `cam_role_name` - (Optional, String, ForceNew) CAM role name authorized to access. +* `count` - (Optional, Int, ForceNew) Number of cvm. +* `data_disk` - (Optional, List, ForceNew) Configurations of data disk. +* `desired_pod_num` - (Optional, Int, ForceNew) Indicate to set desired pod number in node. valid when enable_customized_pod_cidr=true, and it override `[globe_]desired_pod_num` for current node. Either all the fields `desired_pod_num` or none. +* `disaster_recover_group_ids` - (Optional, List, ForceNew) Disaster recover groups to which a CVM instance belongs. Only support maximum 1. +* `enhanced_monitor_service` - (Optional, Bool, ForceNew) To specify whether to enable cloud monitor service. Default is TRUE. +* `enhanced_security_service` - (Optional, Bool, ForceNew) To specify whether to enable cloud security service. Default is TRUE. +* `hostname` - (Optional, String, ForceNew) The host name of the attached instance. Dot (.) and dash (-) cannot be used as the first and last characters of HostName and cannot be used consecutively. Windows example: The length of the name character is [2, 15], letters (capitalization is not restricted), numbers and dashes (-) are allowed, dots (.) are not supported, and not all numbers are allowed. Examples of other types (Linux, etc.): The character length is [2, 60], and multiple dots are allowed. There is a segment between the dots. Each segment allows letters (with no limitation on capitalization), numbers and dashes (-). +* `hpc_cluster_id` - (Optional, String) Id of cvm hpc cluster. +* `img_id` - (Optional, String) The valid image id, format of img-xxx. +* `instance_charge_type_prepaid_period` - (Optional, Int, ForceNew) 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`. +* `instance_charge_type_prepaid_renew_flag` - (Optional, String, ForceNew) 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`. +* `instance_charge_type` - (Optional, String, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. The default is `POSTPAID_BY_HOUR`. Note: TencentCloud International only supports `POSTPAID_BY_HOUR`, `PREPAID` instance will not terminated after cluster deleted, and may not allow to delete before expired. +* `instance_name` - (Optional, String, ForceNew) Name of the CVMs. +* `internet_charge_type` - (Optional, String, ForceNew) Charge types for network traffic. Available values include `TRAFFIC_POSTPAID_BY_HOUR`. +* `internet_max_bandwidth_out` - (Optional, Int) Max bandwidth of Internet access in Mbps. Default is 0. +* `key_ids` - (Optional, List, ForceNew) ID list of keys, should be set if `password` not set. +* `password` - (Optional, String, ForceNew) Password to access, should be set if `key_ids` not set. +* `public_ip_assigned` - (Optional, Bool, ForceNew) Specify whether to assign an Internet IP address. +* `security_group_ids` - (Optional, List, ForceNew) Security groups to which a CVM instance belongs. +* `system_disk_size` - (Optional, Int, ForceNew) Volume of system disk in GB. Default is `50`. +* `system_disk_type` - (Optional, String, ForceNew) System disk type. For more information on limits of system 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, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage. NOTE: `CLOUD_BASIC`, `LOCAL_BASIC` and `LOCAL_SSD` are deprecated. +* `user_data` - (Optional, String, ForceNew) ase64-encoded User Data text, the length limit is 16KB. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `certification_authority` - The certificate used for access. +* `cluster_as_enabled` - (**Deprecated**) This argument is deprecated because the TKE auto-scaling group was no longer available. Indicates whether to enable cluster node auto scaling. Default is false. +* `cluster_external_endpoint` - External network address to access. +* `cluster_node_num` - Number of nodes in the cluster. +* `domain` - Domain name for access. +* `kube_config_intranet` - Kubernetes config of private network. +* `kube_config` - Kubernetes config. +* `password` - Password of account. +* `pgw_endpoint` - The Intranet address used for access. +* `security_policy` - Access policy. +* `user_name` - User name of account. +* `worker_instances_list` - An information list of cvm within the 'WORKER' clusters. Each element contains the following attributes: + * `failed_reason` - Information of the cvm when it is failed. + * `instance_id` - ID of the cvm. + * `instance_role` - Role of the cvm. + * `instance_state` - State of the cvm. + * `lan_ip` - LAN IP of the cvm. + + diff --git a/config/docs/r/kubernetes_cluster_attachment.html.markdown b/config/docs/r/kubernetes_cluster_attachment.html.markdown new file mode 100644 index 0000000..60d6fc3 --- /dev/null +++ b/config/docs/r/kubernetes_cluster_attachment.html.markdown @@ -0,0 +1,168 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_cluster_attachment" +sidebar_current: "docs-tencentcloud-resource-kubernetes_cluster_attachment" +description: |- + Provide a resource to attach an existing cvm to kubernetes cluster. +--- + +# tencentcloud_kubernetes_cluster_attachment + +Provide a resource to attach an existing cvm to kubernetes cluster. + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +variable "cluster_cidr" { + default = "172.16.0.0/16" +} + +variable "default_instance_type" { + default = "S1.SMALL1" +} + +data "tencentcloud_images" "default" { + image_type = ["PUBLIC_IMAGE"] + os_name = "centos" +} + +data "tencentcloud_vpc_subnets" "vpc" { + is_default = true + availability_zone = var.availability_zone +} + +data "tencentcloud_instance_types" "default" { + filter { + name = "instance-family" + values = ["SA2"] + } + + cpu_core_count = 8 + memory_size = 16 +} + +resource "tencentcloud_instance" "foo" { + instance_name = "tf-auto-test-1-1" + availability_zone = var.availability_zone + image_id = data.tencentcloud_images.default.images.0.image_id + instance_type = var.default_instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 +} + +resource "tencentcloud_kubernetes_cluster" "managed_cluster" { + vpc_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.vpc_id + cluster_cidr = "10.1.0.0/16" + cluster_max_pod_num = 32 + cluster_name = "keep" + cluster_desc = "test cluster desc" + cluster_max_service_num = 32 + + worker_config { + count = 1 + availability_zone = var.availability_zone + instance_type = var.default_instance_type + system_disk_type = "CLOUD_SSD" + system_disk_size = 60 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + subnet_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.subnet_id + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + password = "ZZXXccvv1212" + } + + cluster_deploy_type = "MANAGED_CLUSTER" +} + +resource "tencentcloud_kubernetes_cluster_attachment" "test_attach" { + cluster_id = tencentcloud_kubernetes_cluster.managed_cluster.id + instance_id = tencentcloud_instance.foo.id + password = "Lo4wbdit" + + labels = { + "test1" = "test1", + "test2" = "test2", + } + + worker_config_overrides { + desired_pod_num = 8 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) ID of the cluster. +* `instance_id` - (Required, String, ForceNew) ID of the CVM instance, this cvm will reinstall the system. +* `hostname` - (Optional, String, ForceNew) The host name of the attached instance. Dot (.) and dash (-) cannot be used as the first and last characters of HostName and cannot be used consecutively. Windows example: The length of the name character is [2, 15], letters (capitalization is not restricted), numbers and dashes (-) are allowed, dots (.) are not supported, and not all numbers are allowed. Examples of other types (Linux, etc.): The character length is [2, 60], and multiple dots are allowed. There is a segment between the dots. Each segment allows letters (with no limitation on capitalization), numbers and dashes (-). +* `key_ids` - (Optional, List: [`String`], ForceNew) The key pair to use for the instance, it looks like skey-16jig7tx, it should be set if `password` not set. +* `labels` - (Optional, Map, ForceNew) Labels of tke attachment exits CVM. +* `password` - (Optional, String, ForceNew) Password to access, should be set if `key_ids` not set. +* `unschedulable` - (Optional, Int, ForceNew) Sets whether the joining node participates in the schedule. Default is '0'. Participate in scheduling. +* `worker_config_overrides` - (Optional, List, ForceNew) Override variable worker_config, commonly used to attach existing instances. +* `worker_config` - (Optional, List, ForceNew) Deploy the machine configuration information of the 'WORKER', commonly used to attach existing instances. + +The `data_disk` object supports the following: + +* `auto_format_and_mount` - (Optional, Bool, ForceNew) Indicate whether to auto format and mount or not. Default is `false`. +* `disk_partition` - (Optional, String, ForceNew) The name of the device or partition to mount. NOTE: this argument doesn't support setting in node pool, or will leads to mount error. +* `disk_size` - (Optional, Int, ForceNew) Volume of disk in GB. Default is `0`. +* `disk_type` - (Optional, String, ForceNew) Types of disk, available values: `CLOUD_PREMIUM` and `CLOUD_SSD`. +* `file_system` - (Optional, String, ForceNew) File system, e.g. `ext3/ext4/xfs`. +* `mount_target` - (Optional, String, ForceNew) Mount target. + +The `gpu_args` object supports the following: + +* `cuda` - (Optional, Map) CUDA version. Format like: `{ version: String, name: String }`. `version`: Version of GPU driver or CUDA; `name`: Name of GPU driver or CUDA. +* `cudnn` - (Optional, Map) cuDNN version. Format like: `{ version: String, name: String, doc_name: String, dev_name: String }`. `version`: cuDNN version; `name`: cuDNN name; `doc_name`: Doc name of cuDNN; `dev_name`: Dev name of cuDNN. +* `custom_driver` - (Optional, Map) Custom GPU driver. Format like: `{address: String}`. `address`: URL of custom GPU driver address. +* `driver` - (Optional, Map) GPU driver version. Format like: `{ version: String, name: String }`. `version`: Version of GPU driver or CUDA; `name`: Name of GPU driver or CUDA. +* `mig_enable` - (Optional, Bool) Whether to enable MIG. + +The `worker_config_overrides` object supports the following: + +* `data_disk` - (Optional, List, ForceNew) Configurations of data disk. +* `desired_pod_num` - (Optional, Int, ForceNew) Indicate to set desired pod number in node. valid when the cluster is podCIDR. +* `docker_graph_path` - (Optional, String, ForceNew) Docker graph path. Default is `/var/lib/docker`. +* `extra_args` - (Optional, List, ForceNew) Custom parameter information related to the node. This is a white-list parameter. +* `gpu_args` - (Optional, List, ForceNew) GPU driver parameters. +* `is_schedule` - (Optional, Bool, ForceNew) Indicate to schedule the adding node or not. Default is true. +* `mount_target` - (Optional, String, ForceNew) Mount target. Default is not mounting. +* `user_data` - (Optional, String, ForceNew) Base64-encoded User Data text, the length limit is 16KB. + +The `worker_config` object supports the following: + +* `data_disk` - (Optional, List, ForceNew) Configurations of data disk. +* `desired_pod_num` - (Optional, Int, ForceNew) Indicate to set desired pod number in node. valid when the cluster is podCIDR. +* `docker_graph_path` - (Optional, String, ForceNew) Docker graph path. Default is `/var/lib/docker`. +* `extra_args` - (Optional, List, ForceNew) Custom parameter information related to the node. This is a white-list parameter. +* `gpu_args` - (Optional, List, ForceNew) GPU driver parameters. +* `is_schedule` - (Optional, Bool, ForceNew) Indicate to schedule the adding node or not. Default is true. +* `mount_target` - (Optional, String, ForceNew) Mount target. Default is not mounting. +* `user_data` - (Optional, String, ForceNew) Base64-encoded User Data text, the length limit is 16KB. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `security_groups` - A list of security group IDs after attach to cluster. +* `state` - State of the node. + + diff --git a/config/docs/r/kubernetes_cluster_endpoint.html.markdown b/config/docs/r/kubernetes_cluster_endpoint.html.markdown new file mode 100644 index 0000000..dc2a241 --- /dev/null +++ b/config/docs/r/kubernetes_cluster_endpoint.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_cluster_endpoint" +sidebar_current: "docs-tencentcloud-resource-kubernetes_cluster_endpoint" +description: |- + Provide a resource to create a KubernetesClusterEndpoint. This resource allows you to create an empty cluster first without any workers. Only all attached node depends create complete, cluster endpoint will finally be enabled. +--- + +# tencentcloud_kubernetes_cluster_endpoint + +Provide a resource to create a KubernetesClusterEndpoint. This resource allows you to create an empty cluster first without any workers. Only all attached node depends create complete, cluster endpoint will finally be enabled. + +~> **NOTE:** Recommend using `depends_on` to make sure endpoint create after node pools or workers does. + +## Example Usage + +```hcl +resource "tencentcloud_kubernetes_node_pool" "pool1" {} + +resource "tencentcloud_kubernetes_cluster_endpoint" "foo" { + cluster_id = "cls-xxxxxxxx" + cluster_internet = true + cluster_intranet = true + # managed_cluster_internet_security_policies = [ + "192.168.0.0/24" +] +cluster_intranet_subnet_id = "subnet-xxxxxxxx" +depends_on = [ + tencentcloud_kubernetes_node_pool.pool1 +] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Specify cluster ID. +* `cluster_internet_domain` - (Optional, String) Domain name for cluster Kube-apiserver internet access. Be careful if you modify value of this parameter, the cluster_external_endpoint value may be changed automatically too. +* `cluster_internet_security_group` - (Optional, String) Specify security group, NOTE: This argument must not be empty if cluster internet enabled. +* `cluster_internet` - (Optional, Bool) Open internet access or not. +* `cluster_intranet_domain` - (Optional, String) Domain name for cluster Kube-apiserver intranet access. Be careful if you modify value of this parameter, the pgw_endpoint value may be changed automatically too. +* `cluster_intranet_subnet_id` - (Optional, String) Subnet id who can access this independent cluster, this field must and can only set when `cluster_intranet` is true. `cluster_intranet_subnet_id` can not modify once be set. +* `cluster_intranet` - (Optional, Bool) Open intranet access or not. +* `extensive_parameters` - (Optional, String, ForceNew) The LB parameter. Only used for public network access. +* `managed_cluster_internet_security_policies` - (Optional, List: [`String`], **Deprecated**) this argument was deprecated, use `cluster_internet_security_group` instead. Security policies for managed cluster internet, like:'192.168.1.0/24' or '113.116.51.27', '0.0.0.0/0' means all. This field can only set when field `cluster_deploy_type` is 'MANAGED_CLUSTER' and `cluster_internet` is true. `managed_cluster_internet_security_policies` can not delete or empty once be set. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `certification_authority` - The certificate used for access. +* `cluster_deploy_type` - Cluster deploy type of `MANAGED_CLUSTER` or `INDEPENDENT_CLUSTER`. +* `cluster_external_endpoint` - External network address to access. +* `domain` - Domain name for access. +* `password` - Password of account. +* `pgw_endpoint` - The Intranet address used for access. +* `user_name` - User name of account. + + +## Import + +KubernetesClusterEndpoint instance can be imported by passing cluster id, e.g. +``` +$ terraform import tencentcloud_kubernetes_cluster_endpoint.test cluster-id +``` + diff --git a/config/docs/r/kubernetes_encryption_protection.html.markdown b/config/docs/r/kubernetes_encryption_protection.html.markdown new file mode 100644 index 0000000..ea08043 --- /dev/null +++ b/config/docs/r/kubernetes_encryption_protection.html.markdown @@ -0,0 +1,81 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_encryption_protection" +sidebar_current: "docs-tencentcloud-resource-kubernetes_encryption_protection" +description: |- + Provides a resource to create a tke encryption_protection +--- + +# tencentcloud_kubernetes_encryption_protection + +Provides a resource to create a tke encryption_protection + +## Example Usage + +### Enable tke encryption protection + +```hcl +variable "example_region" { + default = "ap-guangzhou" +} + +variable "example_cluster_cidr" { + default = "10.32.0.0/16" +} + +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +data "tencentcloud_vpc_subnets" "vpc" { + is_default = true + availability_zone = var.availability_zone +} + +resource "tencentcloud_kubernetes_cluster" "example" { + vpc_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.vpc_id + cluster_cidr = var.example_cluster_cidr + cluster_max_pod_num = 32 + cluster_name = "tf_example_cluster" + cluster_desc = "a tf example cluster for the kms test" + cluster_max_service_num = 32 + cluster_deploy_type = "MANAGED_CLUSTER" +} + +resource "tencentcloud_kms_key" "example" { + alias = "tf-example-kms-key" + description = "example of kms key instance" + key_usage = "ENCRYPT_DECRYPT" + is_enabled = true +} + +resource "tencentcloud_kubernetes_encryption_protection" "example" { + cluster_id = tencentcloud_kubernetes_cluster.example.id + kms_configuration { + key_id = tencentcloud_kms_key.example.id + kms_region = var.example_region + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) cluster id. +* `kms_configuration` - (Required, List, ForceNew) kms encryption configuration. + +The `kms_configuration` object supports the following: + +* `key_id` - (Optional, String) kms id. +* `kms_region` - (Optional, String) kms region. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - kms encryption status. + + diff --git a/config/docs/r/kubernetes_node_pool.html.markdown b/config/docs/r/kubernetes_node_pool.html.markdown new file mode 100644 index 0000000..80a9fb8 --- /dev/null +++ b/config/docs/r/kubernetes_node_pool.html.markdown @@ -0,0 +1,269 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_node_pool" +sidebar_current: "docs-tencentcloud-resource-kubernetes_node_pool" +description: |- + Provide a resource to create an auto scaling group for kubernetes cluster. +--- + +# tencentcloud_kubernetes_node_pool + +Provide a resource to create an auto scaling group for kubernetes cluster. + +~> **NOTE:** We recommend the usage of one cluster with essential worker config + node pool to manage cluster and nodes. Its a more flexible way than manage worker config with tencentcloud_kubernetes_cluster, tencentcloud_kubernetes_scale_worker or exist node management of `tencentcloud_kubernetes_attachment`. Cause some unchangeable parameters of `worker_config` may cause the whole cluster resource `force new`. + +~> **NOTE:** In order to ensure the integrity of customer data, if you destroy nodepool instance, it will keep the cvm instance associate with nodepool by default. If you want to destroy together, please set `delete_keep_instance` to `false`. + +~> **NOTE:** In order to ensure the integrity of customer data, if the cvm instance was destroyed due to shrinking, it will keep the cbs associate with cvm by default. If you want to destroy together, please set `delete_with_instance` to `true`. + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +variable "cluster_cidr" { + default = "172.31.0.0/16" +} + +data "tencentcloud_vpc_subnets" "vpc" { + is_default = true + availability_zone = var.availability_zone +} + +variable "default_instance_type" { + default = "S1.SMALL1" +} + +//this is the cluster with empty worker config +resource "tencentcloud_kubernetes_cluster" "managed_cluster" { + vpc_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.vpc_id + cluster_cidr = var.cluster_cidr + cluster_max_pod_num = 32 + cluster_name = "tf-tke-unit-test" + cluster_desc = "test cluster desc" + cluster_max_service_num = 32 + cluster_version = "1.18.4" + cluster_deploy_type = "MANAGED_CLUSTER" +} + +//this is one example of managing node using node pool +resource "tencentcloud_kubernetes_node_pool" "mynodepool" { + name = "mynodepool" + cluster_id = tencentcloud_kubernetes_cluster.managed_cluster.id + max_size = 6 + min_size = 1 + vpc_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.vpc_id + subnet_ids = [data.tencentcloud_vpc_subnets.vpc.instance_list.0.subnet_id] + retry_policy = "INCREMENTAL_INTERVALS" + desired_capacity = 4 + enable_auto_scale = true + multi_zone_subnet_policy = "EQUALITY" + + auto_scaling_config { + instance_type = var.default_instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = "50" + orderly_security_group_ids = ["sg-24vswocp"] + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 10 + public_ip_assigned = true + password = "test123#" + enhanced_security_service = false + enhanced_monitor_service = false + host_name = "12.123.0.0" + host_name_style = "ORIGINAL" + } + + labels = { + "test1" = "test1", + "test2" = "test2", + } + + taints { + key = "test_taint" + value = "taint_value" + effect = "PreferNoSchedule" + } + + taints { + key = "test_taint2" + value = "taint_value2" + effect = "PreferNoSchedule" + } + + node_config { + extra_args = [ + "root-dir=/var/lib/kubelet" + ] + } +} +``` + +### Using Spot CVM Instance + +```hcl +resource "tencentcloud_kubernetes_node_pool" "mynodepool" { + name = "mynodepool" + cluster_id = tencentcloud_kubernetes_cluster.managed_cluster.id + max_size = 6 + min_size = 1 + vpc_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.vpc_id + subnet_ids = [data.tencentcloud_vpc_subnets.vpc.instance_list.0.subnet_id] + retry_policy = "INCREMENTAL_INTERVALS" + desired_capacity = 4 + enable_auto_scale = true + multi_zone_subnet_policy = "EQUALITY" + + auto_scaling_config { + instance_type = var.default_instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = "50" + orderly_security_group_ids = ["sg-24vswocp", "sg-3qntci2v", "sg-7y1t2wax"] + instance_charge_type = "SPOTPAID" + spot_instance_type = "one-time" + spot_max_price = "1000" + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 10 + public_ip_assigned = true + password = "test123#" + enhanced_security_service = false + enhanced_monitor_service = false + } + + labels = { + "test1" = "test1", + "test2" = "test2", + } + +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_scaling_config` - (Required, List) Auto scaling config parameters. +* `cluster_id` - (Required, String, ForceNew) ID of the cluster. +* `max_size` - (Required, Int) Maximum number of node. +* `min_size` - (Required, Int) Minimum number of node. +* `name` - (Required, String) Name of the node pool. The name does not exceed 25 characters, and only supports Chinese, English, numbers, underscores, separators (`-`) and decimal points. +* `vpc_id` - (Required, String, ForceNew) ID of VPC network. +* `default_cooldown` - (Optional, Int) Seconds of scaling group cool down. Default value is `300`. +* `delete_keep_instance` - (Optional, Bool) Indicate to keep the CVM instance when delete the node pool. Default is `true`. +* `deletion_protection` - (Optional, Bool) Indicates whether the node pool deletion protection is enabled. +* `desired_capacity` - (Optional, Int) Desired capacity of the node. If `enable_auto_scale` is set `true`, this will be a computed parameter. +* `enable_auto_scale` - (Optional, Bool) Indicate whether to enable auto scaling or not. +* `labels` - (Optional, Map) Labels of kubernetes node pool created nodes. The label key name does not exceed 63 characters, only supports English, numbers,'/','-', and does not allow beginning with ('/'). +* `multi_zone_subnet_policy` - (Optional, String) Multi-availability zone/subnet policy. Valid values: PRIORITY and EQUALITY. Default value: PRIORITY. +* `node_config` - (Optional, List) Node config. +* `node_os_type` - (Optional, String) The image version of the node. Valida values are `DOCKER_CUSTOMIZE` and `GENERAL`. Default is `GENERAL`. This parameter will only affect new nodes, not including the existing nodes. +* `node_os` - (Optional, String) Operating system of the cluster. Please refer to [TencentCloud Documentation](https://www.tencentcloud.com/document/product/457/46750?lang=en&pg=#list-of-public-images-supported-by-tke) for available values. Default is 'tlinux2.4x86_64'. This parameter will only affect new nodes, not including the existing nodes. +* `retry_policy` - (Optional, String, ForceNew) Available values for retry policies include `IMMEDIATE_RETRY` and `INCREMENTAL_INTERVALS`. +* `scaling_group_name` - (Optional, String) Name of relative scaling group. +* `scaling_group_project_id` - (Optional, Int) Project ID the scaling group belongs to. +* `scaling_mode` - (Optional, String, ForceNew) Auto scaling mode. Valid values are `CLASSIC_SCALING`(scaling by create/destroy instances), `WAKE_UP_STOPPED_SCALING`(Boot priority for expansion. When expanding the capacity, the shutdown operation is given priority to the shutdown of the instance. If the number of instances is still lower than the expected number of instances after the startup, the instance will be created, and the method of destroying the instance will still be used for shrinking). +* `subnet_ids` - (Optional, List: [`String`], ForceNew) ID list of subnet, and for VPC it is required. +* `tags` - (Optional, Map) Node pool tag specifications, will passthroughs to the scaling instances. +* `taints` - (Optional, List) Taints of kubernetes node pool created nodes. +* `termination_policies` - (Optional, List: [`String`]) Policy of scaling group termination. Available values: `["OLDEST_INSTANCE"]`, `["NEWEST_INSTANCE"]`. +* `unschedulable` - (Optional, Int, ForceNew) Sets whether the joining node participates in the schedule. Default is '0'. Participate in scheduling. +* `zones` - (Optional, List: [`String`]) List of auto scaling group available zones, for Basic network it is required. + +The `auto_scaling_config` object supports the following: + +* `instance_type` - (Required, String, ForceNew) Specified types of CVM instance. +* `backup_instance_types` - (Optional, List) Backup CVM instance types if specified instance type sold out or mismatch. +* `bandwidth_package_id` - (Optional, String) bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id. +* `cam_role_name` - (Optional, String, ForceNew) Name of cam role. +* `data_disk` - (Optional, List) Configurations of data disk. +* `enhanced_monitor_service` - (Optional, Bool, ForceNew) To specify whether to enable cloud monitor service. Default is TRUE. +* `enhanced_security_service` - (Optional, Bool) To specify whether to enable cloud security service. Default is TRUE. +* `host_name_style` - (Optional, String) The style of the host name of the cloud server, the value range includes ORIGINAL and UNIQUE, and the default is ORIGINAL. For usage, refer to `HostNameSettings` in https://www.tencentcloud.com/document/product/377/31001. +* `host_name` - (Optional, String) The hostname of the cloud server, dot (.) and dash (-) cannot be used as the first and last characters of HostName and cannot be used consecutively. Windows instances are not supported. Examples of other types (Linux, etc.): The character length is [2, 40], multiple periods are allowed, and there is a paragraph between the dots, and each paragraph is allowed to consist of letters (unlimited case), numbers and dashes (-). Pure numbers are not allowed. For usage, refer to `HostNameSettings` in https://www.tencentcloud.com/document/product/377/31001. +* `instance_charge_type_prepaid_period` - (Optional, Int) The tenancy (in 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`. +* `instance_charge_type_prepaid_renew_flag` - (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`. +* `instance_charge_type` - (Optional, String) Charge type of instance. Valid values are `PREPAID`, `POSTPAID_BY_HOUR`, `SPOTPAID`. The default is `POSTPAID_BY_HOUR`. NOTE: `SPOTPAID` instance must set `spot_instance_type` and `spot_max_price` at the same time. +* `instance_name` - (Optional, String) Instance name, no more than 60 characters. For usage, refer to `InstanceNameSettings` in https://www.tencentcloud.com/document/product/377/31001. +* `internet_charge_type` - (Optional, String) Charge types for network traffic. Valid value: `BANDWIDTH_PREPAID`, `TRAFFIC_POSTPAID_BY_HOUR` and `BANDWIDTH_PACKAGE`. +* `internet_max_bandwidth_out` - (Optional, Int) Max bandwidth of Internet access in Mbps. Default is `0`. +* `key_ids` - (Optional, List, ForceNew) ID list of keys. +* `orderly_security_group_ids` - (Optional, List) Ordered security groups to which a CVM instance belongs. +* `password` - (Optional, String, ForceNew) Password to access. +* `public_ip_assigned` - (Optional, Bool) Specify whether to assign an Internet IP address. +* `security_group_ids` - (Optional, Set) (**Deprecated**) The order of elements in this field cannot be guaranteed. Use `orderly_security_group_ids` instead. Security groups to which a CVM instance belongs. +* `spot_instance_type` - (Optional, String) Type of spot instance, only support `one-time` now. Note: it only works when instance_charge_type is set to `SPOTPAID`. +* `spot_max_price` - (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`. +* `system_disk_size` - (Optional, Int) Volume of system disk in GB. Default is `50`. +* `system_disk_type` - (Optional, String) Type of a CVM disk. Valid value: `CLOUD_PREMIUM` and `CLOUD_SSD`. Default is `CLOUD_PREMIUM`. + +The `data_disk` object supports the following: + +* `auto_format_and_mount` - (Optional, Bool, ForceNew) Indicate whether to auto format and mount or not. Default is `false`. +* `disk_partition` - (Optional, String, ForceNew) The name of the device or partition to mount. NOTE: this argument doesn't support setting in node pool, or will leads to mount error. +* `disk_size` - (Optional, Int, ForceNew) Volume of disk in GB. Default is `0`. +* `disk_type` - (Optional, String, ForceNew) Types of disk, available values: `CLOUD_PREMIUM` and `CLOUD_SSD`. +* `file_system` - (Optional, String, ForceNew) File system, e.g. `ext3/ext4/xfs`. +* `mount_target` - (Optional, String, ForceNew) Mount target. + +The `data_disk` object supports the following: + +* `delete_with_instance` - (Optional, Bool) Indicates whether the disk remove after instance terminated. Default is `false`. +* `disk_size` - (Optional, Int) Volume of disk in GB. Default is `0`. +* `disk_type` - (Optional, String) Types of disk. Valid value: `CLOUD_PREMIUM` and `CLOUD_SSD`. +* `encrypt` - (Optional, Bool) Specify whether to encrypt data disk, default: false. NOTE: Make sure the instance type is offering and the cam role `QcloudKMSAccessForCVMRole` was provided. +* `snapshot_id` - (Optional, String, ForceNew) Data disk snapshot ID. +* `throughput_performance` - (Optional, Int) Add extra performance to the data disk. Only works when disk type is `CLOUD_TSSD` or `CLOUD_HSSD` and `data_size` > 460GB. + +The `gpu_args` object supports the following: + +* `cuda` - (Optional, Map) CUDA version. Format like: `{ version: String, name: String }`. `version`: Version of GPU driver or CUDA; `name`: Name of GPU driver or CUDA. +* `cudnn` - (Optional, Map) cuDNN version. Format like: `{ version: String, name: String, doc_name: String, dev_name: String }`. `version`: cuDNN version; `name`: cuDNN name; `doc_name`: Doc name of cuDNN; `dev_name`: Dev name of cuDNN. +* `custom_driver` - (Optional, Map) Custom GPU driver. Format like: `{address: String}`. `address`: URL of custom GPU driver address. +* `driver` - (Optional, Map) GPU driver version. Format like: `{ version: String, name: String }`. `version`: Version of GPU driver or CUDA; `name`: Name of GPU driver or CUDA. +* `mig_enable` - (Optional, Bool) Whether to enable MIG. + +The `node_config` object supports the following: + +* `data_disk` - (Optional, List, ForceNew) Configurations of data disk. +* `desired_pod_num` - (Optional, Int, ForceNew) Indicate to set desired pod number in node. valid when the cluster is podCIDR. +* `docker_graph_path` - (Optional, String, ForceNew) Docker graph path. Default is `/var/lib/docker`. +* `extra_args` - (Optional, List, ForceNew) Custom parameter information related to the node. This is a white-list parameter. +* `gpu_args` - (Optional, List, ForceNew) GPU driver parameters. +* `is_schedule` - (Optional, Bool, ForceNew) Indicate to schedule the adding node or not. Default is true. +* `mount_target` - (Optional, String, ForceNew) Mount target. Default is not mounting. +* `user_data` - (Optional, String, ForceNew) Base64-encoded User Data text, the length limit is 16KB. + +The `taints` object supports the following: + +* `effect` - (Required, String) Effect of the taint. Valid values are: `NoSchedule`, `PreferNoSchedule`, `NoExecute`. +* `key` - (Required, String) Key of the taint. The taint key name does not exceed 63 characters, only supports English, numbers,'/','-', and does not allow beginning with ('/'). +* `value` - (Required, String) Value of the taint. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `auto_scaling_group_id` - The auto scaling group ID. +* `autoscaling_added_total` - The total of autoscaling added node. +* `launch_config_id` - The launch config ID. +* `manually_added_total` - The total of manually added node. +* `node_count` - The total node count. +* `status` - Status of the node pool. + + diff --git a/config/docs/r/kubernetes_scale_worker.html.markdown b/config/docs/r/kubernetes_scale_worker.html.markdown new file mode 100644 index 0000000..e9bfee0 --- /dev/null +++ b/config/docs/r/kubernetes_scale_worker.html.markdown @@ -0,0 +1,200 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_scale_worker" +sidebar_current: "docs-tencentcloud-resource-kubernetes_scale_worker" +description: |- + Provide a resource to increase instance to cluster +--- + +# tencentcloud_kubernetes_scale_worker + +Provide a resource to increase instance to cluster + +~> **NOTE:** To use the custom Kubernetes component startup parameter function (parameter `extra_args`), you need to submit a ticket for application. + +~> **NOTE:** Import Node: Currently, only one node can be imported at a time. + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +variable "subnet" { + default = "subnet-pqfek0t8" +} + +variable "scale_instance_type" { + default = "S2.LARGE16" +} + +resource tencentcloud_kubernetes_scale_worker test_scale { + cluster_id = "cls-godovr32" + desired_pod_num = 16 + labels = { + "test1" = "test1", + "test2" = "test2", + } + worker_config { + count = 3 + availability_zone = var.availability_zone + instance_type = var.scale_instance_type + subnet_id = var.subnet + system_disk_type = "CLOUD_SSD" + system_disk_size = 50 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + password = "AABBccdd1122" + } +} +``` + +### Use Kubelet + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +variable "subnet" { + default = "subnet-pqfek0t8" +} + +variable "scale_instance_type" { + default = "S2.LARGE16" +} + +resource tencentcloud_kubernetes_scale_worker test_scale { + cluster_id = "cls-godovr32" + + extra_args = [ + "root-dir=/var/lib/kubelet" + ] + + labels = { + "test1" = "test1", + "test2" = "test2", + } + + worker_config { + count = 3 + availability_zone = var.availability_zone + instance_type = var.scale_instance_type + subnet_id = var.subnet + system_disk_type = "CLOUD_SSD" + system_disk_size = 50 + internet_charge_type = "TRAFFIC_POSTPAID_BY_HOUR" + internet_max_bandwidth_out = 100 + public_ip_assigned = true + + data_disk { + disk_type = "CLOUD_PREMIUM" + disk_size = 50 + } + + enhanced_security_service = false + enhanced_monitor_service = false + user_data = "dGVzdA==" + password = "AABBccdd1122" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) ID of the cluster. +* `worker_config` - (Required, List, ForceNew) Deploy the machine configuration information of the 'WORK' service, and create <=20 units for common users. +* `data_disk` - (Optional, List, ForceNew) Configurations of data disk. +* `desired_pod_num` - (Optional, Int, ForceNew) Indicate to set desired pod number in current node. Valid when the cluster enable customized pod cidr. +* `docker_graph_path` - (Optional, String, ForceNew) Docker graph path. Default is `/var/lib/docker`. +* `extra_args` - (Optional, List: [`String`], ForceNew) Custom parameter information related to the node. +* `gpu_args` - (Optional, List, ForceNew) GPU driver parameters. +* `labels` - (Optional, Map, ForceNew) Labels of kubernetes scale worker created nodes. +* `mount_target` - (Optional, String, ForceNew) Mount target. Default is not mounting. +* `unschedulable` - (Optional, Int, ForceNew) Sets whether the joining node participates in the schedule. Default is '0'. Participate in scheduling. + +The `data_disk` object supports the following: + +* `auto_format_and_mount` - (Optional, Bool, ForceNew) Indicate whether to auto format and mount or not. Default is `false`. +* `disk_partition` - (Optional, String, ForceNew) The name of the device or partition to mount. +* `disk_size` - (Optional, Int, ForceNew) Volume of disk in GB. Default is `0`. +* `disk_type` - (Optional, String, ForceNew) Types of disk, available values: `CLOUD_PREMIUM` and `CLOUD_SSD` and `CLOUD_HSSD` and `CLOUD_TSSD`. +* `encrypt` - (Optional, Bool) Indicates whether to encrypt data disk, default `false`. +* `file_system` - (Optional, String, ForceNew) File system, e.g. `ext3/ext4/xfs`. +* `kms_key_id` - (Optional, String) ID of the custom CMK in the format of UUID or `kms-abcd1234`. This parameter is used to encrypt cloud disks. +* `mount_target` - (Optional, String, ForceNew) Mount target. +* `snapshot_id` - (Optional, String, ForceNew) Data disk snapshot ID. + +The `data_disk` object supports the following: + +* `auto_format_and_mount` - (Optional, Bool, ForceNew) Indicate whether to auto format and mount or not. Default is `false`. +* `disk_size` - (Optional, Int, ForceNew) Volume of disk in GB. Default is `0`. +* `disk_type` - (Optional, String, ForceNew) Types of disk, available values: `CLOUD_PREMIUM` and `CLOUD_SSD` and `CLOUD_HSSD` and `CLOUD_TSSD`. +* `file_system` - (Optional, String, ForceNew) File system, e.g. `ext3/ext4/xfs`. +* `mount_target` - (Optional, String, ForceNew) Mount target. + +The `gpu_args` object supports the following: + +* `cuda` - (Optional, Map) CUDA version. Format like: `{ version: String, name: String }`. `version`: Version of GPU driver or CUDA; `name`: Name of GPU driver or CUDA. +* `cudnn` - (Optional, Map) cuDNN version. Format like: `{ version: String, name: String, doc_name: String, dev_name: String }`. `version`: cuDNN version; `name`: cuDNN name; `doc_name`: Doc name of cuDNN; `dev_name`: Dev name of cuDNN. +* `custom_driver` - (Optional, Map) Custom GPU driver. Format like: `{address: String}`. `address`: URL of custom GPU driver address. +* `driver` - (Optional, Map) GPU driver version. Format like: `{ version: String, name: String }`. `version`: Version of GPU driver or CUDA; `name`: Name of GPU driver or CUDA. +* `mig_enable` - (Optional, Bool) Whether to enable MIG. + +The `worker_config` object supports the following: + +* `instance_type` - (Required, String, ForceNew) Specified types of CVM instance. +* `subnet_id` - (Required, String, ForceNew) Private network ID. +* `availability_zone` - (Optional, String, ForceNew) Indicates which availability zone will be used. +* `bandwidth_package_id` - (Optional, String) bandwidth package id. if user is standard user, then the bandwidth_package_id is needed, or default has bandwidth_package_id. +* `cam_role_name` - (Optional, String, ForceNew) CAM role name authorized to access. +* `count` - (Optional, Int, ForceNew) Number of cvm. +* `data_disk` - (Optional, List, ForceNew) Configurations of data disk. +* `desired_pod_num` - (Optional, Int, ForceNew) Indicate to set desired pod number in node. valid when enable_customized_pod_cidr=true, and it override `[globe_]desired_pod_num` for current node. Either all the fields `desired_pod_num` or none. +* `disaster_recover_group_ids` - (Optional, List, ForceNew) Disaster recover groups to which a CVM instance belongs. Only support maximum 1. +* `enhanced_monitor_service` - (Optional, Bool, ForceNew) To specify whether to enable cloud monitor service. Default is TRUE. +* `enhanced_security_service` - (Optional, Bool, ForceNew) To specify whether to enable cloud security service. Default is TRUE. +* `hostname` - (Optional, String, ForceNew) The host name of the attached instance. Dot (.) and dash (-) cannot be used as the first and last characters of HostName and cannot be used consecutively. Windows example: The length of the name character is [2, 15], letters (capitalization is not restricted), numbers and dashes (-) are allowed, dots (.) are not supported, and not all numbers are allowed. Examples of other types (Linux, etc.): The character length is [2, 60], and multiple dots are allowed. There is a segment between the dots. Each segment allows letters (with no limitation on capitalization), numbers and dashes (-). +* `hpc_cluster_id` - (Optional, String) Id of cvm hpc cluster. +* `img_id` - (Optional, String) The valid image id, format of img-xxx. +* `instance_charge_type_prepaid_period` - (Optional, Int, ForceNew) 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`. +* `instance_charge_type_prepaid_renew_flag` - (Optional, String, ForceNew) 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`. +* `instance_charge_type` - (Optional, String, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. The default is `POSTPAID_BY_HOUR`. Note: TencentCloud International only supports `POSTPAID_BY_HOUR`, `PREPAID` instance will not terminated after cluster deleted, and may not allow to delete before expired. +* `instance_name` - (Optional, String, ForceNew) Name of the CVMs. +* `internet_charge_type` - (Optional, String, ForceNew) Charge types for network traffic. Available values include `TRAFFIC_POSTPAID_BY_HOUR`. +* `internet_max_bandwidth_out` - (Optional, Int) Max bandwidth of Internet access in Mbps. Default is 0. +* `key_ids` - (Optional, List, ForceNew) ID list of keys, should be set if `password` not set. +* `password` - (Optional, String, ForceNew) Password to access, should be set if `key_ids` not set. +* `public_ip_assigned` - (Optional, Bool, ForceNew) Specify whether to assign an Internet IP address. +* `security_group_ids` - (Optional, List, ForceNew) Security groups to which a CVM instance belongs. +* `system_disk_size` - (Optional, Int, ForceNew) Volume of system disk in GB. Default is `50`. +* `system_disk_type` - (Optional, String, ForceNew) System disk type. For more information on limits of system 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, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage. NOTE: `CLOUD_BASIC`, `LOCAL_BASIC` and `LOCAL_SSD` are deprecated. +* `user_data` - (Optional, String, ForceNew) ase64-encoded User Data text, the length limit is 16KB. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `worker_instances_list` - An information list of kubernetes cluster 'WORKER'. Each element contains the following attributes: + * `failed_reason` - Information of the cvm when it is failed. + * `instance_id` - ID of the cvm. + * `instance_role` - Role of the cvm. + * `instance_state` - State of the cvm. + * `lan_ip` - LAN IP of the cvm. + + diff --git a/config/docs/r/kubernetes_serverless_node_pool.html.markdown b/config/docs/r/kubernetes_serverless_node_pool.html.markdown new file mode 100644 index 0000000..a45cfa0 --- /dev/null +++ b/config/docs/r/kubernetes_serverless_node_pool.html.markdown @@ -0,0 +1,151 @@ +--- +subcategory: "Tencent Kubernetes Engine(TKE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_kubernetes_serverless_node_pool" +sidebar_current: "docs-tencentcloud-resource-kubernetes_serverless_node_pool" +description: |- + Provide a resource to create serverless node pool of cluster. +--- + +# tencentcloud_kubernetes_serverless_node_pool + +Provide a resource to create serverless node pool of cluster. + +## Example Usage + +### Add serverless node pool to a cluster + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +variable "example_cluster_cidr" { + default = "10.31.0.0/16" +} + +locals { + vpc_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.vpc_id + subnet_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.subnet_id + sg_id = data.tencentcloud_security_groups.sg.security_groups.0.security_group_id +} + +data "tencentcloud_vpc_subnets" "vpc" { + is_default = true + availability_zone = var.availability_zone +} + +data "tencentcloud_security_groups" "sg" { + name = "default" +} + +resource "tencentcloud_kubernetes_cluster" "example" { + vpc_id = local.vpc_id + cluster_cidr = var.example_cluster_cidr + cluster_max_pod_num = 32 + cluster_name = "tf_example_cluster" + cluster_desc = "tf example cluster" + cluster_max_service_num = 32 + cluster_version = "1.18.4" + cluster_deploy_type = "MANAGED_CLUSTER" +} + +resource "tencentcloud_kubernetes_serverless_node_pool" "example" { + cluster_id = tencentcloud_kubernetes_cluster.example.id + name = "tf_example_serverless_node_pool" + + serverless_nodes { + display_name = "tf_example_serverless_node1" + subnet_id = local.subnet_id + } + + serverless_nodes { + display_name = "tf_example_serverless_node2" + subnet_id = local.subnet_id + } + + security_group_ids = [local.sg_id] + labels = { + "label1" : "value1", + "label2" : "value2", + } +} +``` + +### Adding taints to the virtual nodes under this node pool + +The pods without appropriate tolerations will not be scheduled on this node. Refer [taint-and-toleration](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) for more details. + +```hcl +resource "tencentcloud_kubernetes_serverless_node_pool" "example" { + cluster_id = tencentcloud_kubernetes_cluster.example.id + name = "tf_example_serverless_node_pool" + + serverless_nodes { + display_name = "tf_example_serverless_node1" + subnet_id = local.subnet_id + } + + serverless_nodes { + display_name = "tf_example_serverless_node2" + subnet_id = local.subnet_id + } + + security_group_ids = [local.sg_id] + labels = { + "label1" : "value1", + "label2" : "value2", + } + + taints { + key = "key1" + value = "value1" + effect = "NoSchedule" + } + + taints { + key = "key1" + value = "value1" + effect = "NoExecute" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) cluster id of serverless node pool. +* `serverless_nodes` - (Required, List, ForceNew) node list of serverless node pool. +* `labels` - (Optional, Map) labels of serverless node. +* `name` - (Optional, String) serverless node pool name. +* `security_group_ids` - (Optional, List: [`String`], ForceNew) security groups of serverless node pool. +* `taints` - (Optional, List) taints of serverless node. + +The `serverless_nodes` object supports the following: + +* `subnet_id` - (Required, String) subnet id of serverless node. +* `display_name` - (Optional, String) display name of serverless node. + +The `taints` object supports the following: + +* `effect` - (Required, String) Effect of the taint. Valid values are: `NoSchedule`, `PreferNoSchedule`, `NoExecute`. +* `key` - (Required, String) Key of the taint. The taint key name does not exceed 63 characters, only supports English, numbers,'/','-', and does not allow beginning with ('/'). +* `value` - (Required, String) Value of the taint. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `life_state` - life state of serverless node pool. + + +## Import + +serverless node pool can be imported, e.g. + +``` +$ terraform import tencentcloud_kubernetes_serverless_node_pool.test cls-xxx#np-xxx +``` + diff --git a/config/docs/r/lb.html.markdown b/config/docs/r/lb.html.markdown new file mode 100644 index 0000000..650e4ce --- /dev/null +++ b/config/docs/r/lb.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Cloud Load Balancer(CLB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lb" +sidebar_current: "docs-tencentcloud-resource-lb" +description: |- + Provides a Load Balancer resource. +--- + +# tencentcloud_lb + +Provides a Load Balancer resource. + +~> **NOTE:** It has been deprecated and replaced by `tencentcloud_clb_instance`. + +## Example Usage + +```hcl +resource "tencentcloud_lb" "classic" { + type = "OPEN" + forward = "APPLICATION" + name = "tf-test-classic" + project_id = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `type` - (Required, String, ForceNew) The network type of the LB. Valid value: 'OPEN', 'INTERNAL'. +* `forward` - (Optional, String, ForceNew) The type of the LB. Valid value: 'CLASSIC', 'APPLICATION'. +* `name` - (Optional, String) The name of the LB. +* `project_id` - (Optional, Int, ForceNew) The project id of the LB, unspecified or 0 stands for default project. +* `vpc_id` - (Optional, String, ForceNew) The VPC ID of the LB, unspecified or 0 stands for CVM basic network. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - The status of the LB. + + diff --git a/config/docs/r/lighthouse_apply_disk_backup.html.markdown b/config/docs/r/lighthouse_apply_disk_backup.html.markdown new file mode 100644 index 0000000..cadf5e4 --- /dev/null +++ b/config/docs/r/lighthouse_apply_disk_backup.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_apply_disk_backup" +sidebar_current: "docs-tencentcloud-resource-lighthouse_apply_disk_backup" +description: |- + Provides a resource to create a lighthouse apply_disk_backup +--- + +# tencentcloud_lighthouse_apply_disk_backup + +Provides a resource to create a lighthouse apply_disk_backup + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_apply_disk_backup" "apply_disk_backup" { + disk_id = "lhdisk-xxxxxx" + disk_backup_id = "lhbak-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `disk_backup_id` - (Required, String, ForceNew) Disk backup ID. +* `disk_id` - (Required, String, ForceNew) Disk ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/lighthouse_apply_instance_snapshot.html.markdown b/config/docs/r/lighthouse_apply_instance_snapshot.html.markdown new file mode 100644 index 0000000..b319a65 --- /dev/null +++ b/config/docs/r/lighthouse_apply_instance_snapshot.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_apply_instance_snapshot" +sidebar_current: "docs-tencentcloud-resource-lighthouse_apply_instance_snapshot" +description: |- + Provides a resource to create a lighthouse apply_instance_snapshot +--- + +# tencentcloud_lighthouse_apply_instance_snapshot + +Provides a resource to create a lighthouse apply_instance_snapshot + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_apply_instance_snapshot" "apply_instance_snapshot" { + instance_id = "lhins-123456" + snapshot_id = "lhsnap-123456" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `snapshot_id` - (Required, String, ForceNew) Snapshot ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/lighthouse_blueprint.html.markdown b/config/docs/r/lighthouse_blueprint.html.markdown new file mode 100644 index 0000000..e46c0dc --- /dev/null +++ b/config/docs/r/lighthouse_blueprint.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_blueprint" +sidebar_current: "docs-tencentcloud-resource-lighthouse_blueprint" +description: |- + Provides a resource to create a lighthouse blueprint +--- + +# tencentcloud_lighthouse_blueprint + +Provides a resource to create a lighthouse blueprint + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_blueprint" "blueprint" { + blueprint_name = "blueprint_name_test" + description = "blueprint_description_test" + instance_id = "lhins-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `blueprint_name` - (Required, String) Blueprint name, which can contain up to 60 characters. +* `description` - (Optional, String) Blueprint description, which can contain up to 60 characters. +* `instance_id` - (Optional, String) ID of the instance for which to make a blueprint. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +lighthouse blueprint can be imported using the id, e.g. + +``` +terraform import tencentcloud_lighthouse_blueprint.blueprint blueprint_id +``` + diff --git a/config/docs/r/lighthouse_disk.html.markdown b/config/docs/r/lighthouse_disk.html.markdown new file mode 100644 index 0000000..4851c03 --- /dev/null +++ b/config/docs/r/lighthouse_disk.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_disk" +sidebar_current: "docs-tencentcloud-resource-lighthouse_disk" +description: |- + Provides a resource to create a lighthouse disk +--- + +# tencentcloud_lighthouse_disk + +Provides a resource to create a lighthouse disk + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_disk" "disk" { + zone = "ap-hongkong-2" + disk_size = 20 + disk_type = "CLOUD_SSD" + disk_charge_prepaid { + period = 1 + renew_flag = "NOTIFY_AND_AUTO_RENEW" + time_unit = "m" + + } + disk_name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `disk_charge_prepaid` - (Required, List) Disk subscription related parameter settings. +* `disk_size` - (Required, Int) Disk size, unit: GB. +* `disk_type` - (Required, String) Disk type. Value:CLOUD_PREMIUM, CLOUD_SSD. +* `zone` - (Required, String) Availability zone. +* `auto_mount_configuration` - (Optional, List) Automatically mount and initialize data disks. +* `auto_voucher` - (Optional, Bool) Whether to automatically use the voucher. Not used by default. +* `disk_backup_quota` - (Optional, Int) Specify the disk backup quota. If not uploaded, the default is no backup quota. Currently, only one disk backup quota is supported. +* `disk_count` - (Optional, Int) Disk count. Values: [1, 30]. Default: 1. +* `disk_name` - (Optional, String) Disk name. Maximum length 60. + +The `auto_mount_configuration` object supports the following: + +* `instance_id` - (Required, String) Instance ID to be mounted. The specified instance must be in the Running state. +* `file_system_type` - (Optional, String) The file system type. Value: ext4, xfs. Only instances of the Linux operating system can pass in this parameter, and if it is not passed, it defaults to ext4. +* `mount_point` - (Optional, String) The mount point within the instance. Only instances of the Linux operating system can pass in this parameter, and if it is not passed, it will be mounted under the /data/disk path by default. + +The `disk_charge_prepaid` object supports the following: + +* `period` - (Required, Int) new purchase cycle. +* `renew_flag` - (Optional, String) Automatic renewal flag. Value: `NOTIFY_AND_AUTO_RENEW`: Notice expires and auto-renews. `NOTIFY_AND_MANUAL_RENEW`: Notification expires without automatic renewal, users need to manually renew. `DISABLE_NOTIFY_AND_AUTO_RENEW`: No automatic renewal and no notification. Default: `NOTIFY_AND_MANUAL_RENEW`. If this parameter is specified as `NOTIFY_AND_AUTO_RENEW`, the disk will be automatically renewed monthly when the account balance is sufficient. +* `time_unit` - (Optional, String) newly purchased unit. Default: m. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/lighthouse_disk_attachment.html.markdown b/config/docs/r/lighthouse_disk_attachment.html.markdown new file mode 100644 index 0000000..3adcb95 --- /dev/null +++ b/config/docs/r/lighthouse_disk_attachment.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_disk_attachment" +sidebar_current: "docs-tencentcloud-resource-lighthouse_disk_attachment" +description: |- + Provides a resource to create a lighthouse disk_attachment +--- + +# tencentcloud_lighthouse_disk_attachment + +Provides a resource to create a lighthouse disk_attachment + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_disk_attachment" "disk_attachment" { + disk_id = "lhdisk-xxxxxx" + instance_id = "lhins-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `disk_id` - (Required, String, ForceNew) Disk id. +* `instance_id` - (Required, String, ForceNew) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +lighthouse disk_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_lighthouse_disk_attachment.disk_attachment disk_attachment_id +``` + diff --git a/config/docs/r/lighthouse_disk_backup.html.markdown b/config/docs/r/lighthouse_disk_backup.html.markdown new file mode 100644 index 0000000..fcddc62 --- /dev/null +++ b/config/docs/r/lighthouse_disk_backup.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_disk_backup" +sidebar_current: "docs-tencentcloud-resource-lighthouse_disk_backup" +description: |- + Provides a resource to create a lighthouse disk_backup +--- + +# tencentcloud_lighthouse_disk_backup + +Provides a resource to create a lighthouse disk_backup + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_disk_backup" "disk_backup" { + disk_id = "lhdisk-xxxxx" + disk_backup_name = "disk-backup" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `disk_id` - (Required, String, ForceNew) Disk ID. Only data disks are supported to create disk backup. +* `disk_backup_name` - (Optional, String) Disk backup name. The maximum length is 90 characters. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +lighthouse disk_backup can be imported using the id, e.g. + +``` +terraform import tencentcloud_lighthouse_disk_backup.disk_backup disk_backup_id +``` + diff --git a/config/docs/r/lighthouse_firewall_rule.html.markdown b/config/docs/r/lighthouse_firewall_rule.html.markdown new file mode 100644 index 0000000..32c121e --- /dev/null +++ b/config/docs/r/lighthouse_firewall_rule.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_firewall_rule" +sidebar_current: "docs-tencentcloud-resource-lighthouse_firewall_rule" +description: |- + Provides a resource to create a lighthouse firewall rule +--- + +# tencentcloud_lighthouse_firewall_rule + +Provides a resource to create a lighthouse firewall rule + +~> **NOTE:** Use an empty template to clean up the default rules before using this resource manage firewall rules. + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_firewall_rule" "firewall_rule" { + instance_id = "lhins-xxxxxxx" + firewall_rules { + protocol = "TCP" + port = "80" + cidr_block = "10.0.0.1" + action = "ACCEPT" + firewall_rule_description = "description 1" + } + firewall_rules { + protocol = "TCP" + port = "80" + cidr_block = "10.0.0.2" + action = "ACCEPT" + firewall_rule_description = "description 2" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `firewall_rules` - (Required, List) Firewall rule list. +* `instance_id` - (Required, String, ForceNew) Instance ID. + +The `firewall_rules` object supports the following: + +* `protocol` - (Required, String) Protocol. Valid values are TCP, UDP, ICMP, ALL. +* `action` - (Optional, String) Valid values are ACCEPT, DROP. Default value is ACCEPT. +* `cidr_block` - (Optional, String) IP range or IP (mutually exclusive). Default value is 0.0.0.0/0, which indicates all sources. +* `firewall_rule_description` - (Optional, String) Firewall rule description. +* `port` - (Optional, String) Port. Valid values are ALL, one single port, multiple ports separated by commas, or port range indicated by a minus sign. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +lighthouse firewall_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_lighthouse_firewall_rule.firewall_rule lighthouse_instance_id +``` + diff --git a/config/docs/r/lighthouse_firewall_template.html.markdown b/config/docs/r/lighthouse_firewall_template.html.markdown new file mode 100644 index 0000000..9b395e7 --- /dev/null +++ b/config/docs/r/lighthouse_firewall_template.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_firewall_template" +sidebar_current: "docs-tencentcloud-resource-lighthouse_firewall_template" +description: |- + Provides a resource to create a lighthouse firewall template +--- + +# tencentcloud_lighthouse_firewall_template + +Provides a resource to create a lighthouse firewall template + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_firewall_template" "firewall_template" { + template_name = "firewall-template-test" + template_rules { + protocol = "TCP" + port = "8080" + cidr_block = "127.0.0.1" + action = "ACCEPT" + firewall_rule_description = "test description" + } + template_rules { + protocol = "TCP" + port = "8090" + cidr_block = "127.0.0.0/24" + action = "DROP" + firewall_rule_description = "test description" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `template_name` - (Required, String) Template name. +* `template_rules` - (Optional, List) List of firewall rules. + +The `template_rules` object supports the following: + +* `protocol` - (Required, String) Protocol. Values: TCP, UDP, ICMP, ALL. +* `action` - (Optional, String) Action. Values: ACCEPT, DROP. The default is `ACCEPT`. +* `cidr_block` - (Optional, String) Network segment or IP (mutually exclusive). The default is `0.0.0.0`, indicating all sources. +* `firewall_rule_description` - (Optional, String) Firewall rule description. +* `port` - (Optional, String) Port. Values: ALL, Separate ports, comma-separated discrete ports, minus sign-separated port ranges. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +lighthouse firewall_template can be imported using the id, e.g. + +``` +terraform import tencentcloud_lighthouse_firewall_template.firewall_template firewall_template_id +``` + diff --git a/config/docs/r/lighthouse_instance.html.markdown b/config/docs/r/lighthouse_instance.html.markdown new file mode 100644 index 0000000..f4c9443 --- /dev/null +++ b/config/docs/r/lighthouse_instance.html.markdown @@ -0,0 +1,146 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_instance" +sidebar_current: "docs-tencentcloud-resource-lighthouse_instance" +description: |- + Provides a resource to create a lighthouse instance. +--- + +# tencentcloud_lighthouse_instance + +Provides a resource to create a lighthouse instance. + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_firewall_template" "firewall_template" { + template_name = "empty-template" +} + +resource "tencentcloud_lighthouse_instance" "lighthouse" { + bundle_id = "bundle2022_gen_01" + blueprint_id = "lhbp-f1lkcd41" + + period = 1 + renew_flag = "NOTIFY_AND_AUTO_RENEW" + + instance_name = "hello world" + zone = "ap-guangzhou-3" + + containers { + container_image = "ccr.ccs.tencentyun.com/qcloud/nginx" + container_name = "nginx" + envs { + key = "key" + value = "value" + } + envs { + key = "key2" + value = "value2" + } + publish_ports { + host_port = 80 + container_port = 80 + ip = "127.0.0.1" + protocol = "tcp" + } + publish_ports { + host_port = 36000 + container_port = 36000 + ip = "127.0.0.1" + protocol = "tcp" + } + volumes { + container_path = "/data" + host_path = "/tmp" + } + volumes { + container_path = "/var" + host_path = "/tmp" + } + command = "ls -l" + } + + containers { + container_image = "ccr.ccs.tencentyun.com/qcloud/resty" + container_name = "resty" + envs { + key = "key2" + value = "value2" + } + publish_ports { + host_port = 80 + container_port = 80 + ip = "127.0.0.1" + protocol = "udp" + } + + volumes { + container_path = "/var" + host_path = "/tmp" + } + command = "echo \"hello\"" + } + firewall_template_id = tencentcloud_lighthouse_firewall_template.firewall_template.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `blueprint_id` - (Required, String) ID of the Lighthouse image. +* `bundle_id` - (Required, String) ID of the Lighthouse package. +* `instance_name` - (Required, String) The display name of the Lighthouse instance. +* `period` - (Required, Int) Subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60. +* `renew_flag` - (Required, 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. You need to manually renew DISABLE_NOTIFY_AND_AUTO_RENEW: neither notify upon expiration nor renew automatically. Default value: NOTIFY_AND_MANUAL_RENEW. +* `client_token` - (Optional, String) A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idem-potency of the request cannot be guaranteed. +* `containers` - (Optional, List) Configuration of the containers to create. +* `dry_run` - (Optional, Bool) Whether the request is a dry run only.true: dry run only. The request will not create instance(s). A dry run can check whether all the required parameters are specified, whether the request format is right, whether the request exceeds service limits, and whether the specified CVMs are available. If the dry run fails, the corresponding error code will be returned.If the dry run succeeds, the RequestId will be returned.false (default value): send a normal request and create instance(s) if all the requirements are met. +* `firewall_template_id` - (Optional, String) Firewall template ID. If this parameter is not specified, the default firewall policy is used. +* `is_update_bundle_id_auto_voucher` - (Optional, Bool) Whether the voucher is deducted automatically when update bundle id. Value range: `true`: indicates automatic deduction of vouchers, `false`: does not automatically deduct vouchers. Default value: `false`. +* `isolate_data_disk` - (Optional, Bool) Whether to return the mounted data disk. `true`: returns both the instance and the mounted data disk; `false`: returns the instance and no longer returns its mounted data disk. Default: `true`. +* `login_configuration` - (Optional, List) Login password of the instance. It is only available for Windows instances. If it is not specified, it means that the user choose to set the login password after the instance creation. +* `permit_default_key_pair_login` - (Optional, String, **Deprecated**) It has been deprecated from version v1.81.8. Use `tencentcloud_lighthouse_key_pair_attachment` manage key pair. Whether to allow login using the default key pair. `YES`: allow login; `NO`: disable login. Default: `YES`. +* `zone` - (Optional, String) List of availability zones. A random AZ is selected by default. + +The `containers` object supports the following: + +* `command` - (Optional, String) The command to run. +* `container_image` - (Optional, String) Container image address. +* `container_name` - (Optional, String) Container name. +* `envs` - (Optional, List) List of environment variables. +* `publish_ports` - (Optional, List) List of mappings of container ports and host ports. +* `volumes` - (Optional, List) List of container mount volumes. + +The `envs` object supports the following: + +* `key` - (Required, String) Environment variable key. +* `value` - (Required, String) Environment variable value. + +The `login_configuration` object supports the following: + +* `auto_generate_password` - (Required, String) whether auto generate password. if false, need set password. +* `password` - (Optional, String) Login password. + +The `publish_ports` object supports the following: + +* `container_port` - (Required, Int) Container port. +* `host_port` - (Required, Int) Host port. +* `ip` - (Optional, String) External IP. It defaults to 0.0.0.0. +* `protocol` - (Optional, String) The protocol defaults to tcp. Valid values: tcp, udp and sctp. + +The `volumes` object supports the following: + +* `container_path` - (Required, String) Container path. +* `host_path` - (Required, String) Host path. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/lighthouse_key_pair.html.markdown b/config/docs/r/lighthouse_key_pair.html.markdown new file mode 100644 index 0000000..2ccf40c --- /dev/null +++ b/config/docs/r/lighthouse_key_pair.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_key_pair" +sidebar_current: "docs-tencentcloud-resource-lighthouse_key_pair" +description: |- + Provides a resource to create a lighthouse key_pair +--- + +# tencentcloud_lighthouse_key_pair + +Provides a resource to create a lighthouse key_pair + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_key_pair" "key_pair" { + key_name = "key_name_test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `key_name` - (Required, String, ForceNew) Key pair name, which can contain up to 25 digits, letters, and underscores. +* `public_key` - (Optional, String, ForceNew) Public key content of the key pair, which is in the OpenSSH RSA format. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `created_time` - Creation time. Expressed according to the ISO8601 standard, and using UTC time. Format: YYYY-MM-DDThh:mm:ssZ. +* `private_key` - Key to private key. + + +## Import + +lighthouse key_pair can be imported using the id, e.g. + +``` +terraform import tencentcloud_lighthouse_key_pair.key_pair key_pair_id +``` + diff --git a/config/docs/r/lighthouse_key_pair_attachment.html.markdown b/config/docs/r/lighthouse_key_pair_attachment.html.markdown new file mode 100644 index 0000000..a5e7d46 --- /dev/null +++ b/config/docs/r/lighthouse_key_pair_attachment.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_key_pair_attachment" +sidebar_current: "docs-tencentcloud-resource-lighthouse_key_pair_attachment" +description: |- + Provides a resource to create a lighthouse key_pair_attachment +--- + +# tencentcloud_lighthouse_key_pair_attachment + +Provides a resource to create a lighthouse key_pair_attachment + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_key_pair_attachment" "key_pair_attachment" { + key_id = "lhkp-xxxxxx" + instance_id = "lhins-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `key_id` - (Required, String, ForceNew) Key pair ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +lighthouse key_pair_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_lighthouse_key_pair_attachment.key_pair_attachment key_pair_attachment_id +``` + diff --git a/config/docs/r/lighthouse_reboot_instance.html.markdown b/config/docs/r/lighthouse_reboot_instance.html.markdown new file mode 100644 index 0000000..cc5e9a2 --- /dev/null +++ b/config/docs/r/lighthouse_reboot_instance.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_reboot_instance" +sidebar_current: "docs-tencentcloud-resource-lighthouse_reboot_instance" +description: |- + Provides a resource to create a lighthouse reboot_instance +--- + +# tencentcloud_lighthouse_reboot_instance + +Provides a resource to create a lighthouse reboot_instance + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_reboot_instance" "reboot_instance" { + instance_id = "lhins-xxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/lighthouse_renew_disk.html.markdown b/config/docs/r/lighthouse_renew_disk.html.markdown new file mode 100644 index 0000000..4475f11 --- /dev/null +++ b/config/docs/r/lighthouse_renew_disk.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_renew_disk" +sidebar_current: "docs-tencentcloud-resource-lighthouse_renew_disk" +description: |- + Provides a resource to create a lighthouse renew_disk +--- + +# tencentcloud_lighthouse_renew_disk + +Provides a resource to create a lighthouse renew_disk + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_renew_disk" "renew_disk" { + disk_id = "lhdisk-xxxxxx" + renew_disk_charge_prepaid { + period = 1 + renew_flag = "NOTIFY_AND_AUTO_RENEW" + time_unit = "m" + } + auto_voucher = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `disk_id` - (Required, String, ForceNew) List of disk ID. +* `renew_disk_charge_prepaid` - (Required, List, ForceNew) Renew cloud hard disk subscription related parameter settings. +* `auto_voucher` - (Optional, Bool, ForceNew) Whether to automatically use the voucher. Not used by default. + +The `renew_disk_charge_prepaid` object supports the following: + +* `cur_instance_deadline` - (Optional, String) Current instance expiration time. Such as 2018-01-01 00:00:00. Specifying this parameter can align the expiration time of the instance attached to the disk. One of this parameter and Period must be specified, and cannot be specified at the same time. +* `period` - (Optional, Int) Renewal period. +* `renew_flag` - (Optional, String) Automatic renewal falg. Value:NOTIFY_AND_AUTO_RENEW: Notice expires and auto-renews.NOTIFY_AND_MANUAL_RENEW: Notification expires without automatic renewal, users need to manually renew.DISABLE_NOTIFY_AND_AUTO_RENEW: No automatic renewal and no notification.Default: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the disk will be automatically renewed monthly when the account balance is sufficient. +* `time_unit` - (Optional, String) newly purchased unit. Default: m. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/lighthouse_renew_instance.html.markdown b/config/docs/r/lighthouse_renew_instance.html.markdown new file mode 100644 index 0000000..574e209 --- /dev/null +++ b/config/docs/r/lighthouse_renew_instance.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_renew_instance" +sidebar_current: "docs-tencentcloud-resource-lighthouse_renew_instance" +description: |- + Provides a resource to create a lighthouse renew_instance +--- + +# tencentcloud_lighthouse_renew_instance + +Provides a resource to create a lighthouse renew_instance + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_renew_instance" "renew_instance" { + instance_id = + instance_charge_prepaid { + period = 1 + renew_flag = "NOTIFY_AND_MANUAL_RENEW" + + } + renew_data_disk = true + auto_voucher = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_charge_prepaid` - (Required, List, ForceNew) Prepaid mode, that is, yearly and monthly subscription related parameter settings. Through this parameter, you can specify attributes such as the purchase duration of the Subscription instance and whether to set automatic renewal. +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `auto_voucher` - (Optional, Bool, ForceNew) Whether to automatically deduct vouchers. Valid values: +- true: Automatically deduct vouchers. +-false:Do not automatically deduct vouchers. Default value: false. +* `renew_data_disk` - (Optional, Bool, ForceNew) Whether to renew the data disk. Valid values:true: Indicates that the renewal instance also renews the data disk attached to it.false: Indicates that the instance will be renewed and the data disk attached to it will not be renewed at the same time.Default value: true. + +The `instance_charge_prepaid` object supports the following: + +* `period` - (Required, Int) The duration of purchasing an instance. Unit is month. Valid values are (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60). +* `renew_flag` - (Optional, String) Automatic renewal logo. Values: +- `NOTIFY_AND_AUTO_RENEW`: notify expiration and renew automatically; +- `NOTIFY_AND_MANUAL_RENEW`: notification of expiration does not renew automatically. Users need to renew manually; +- `DISABLE_NOTIFY_AND_AUTO_RENEW`: no automatic renewal and no notification; +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 after expiration, when the account balance is sufficient. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/lighthouse_snapshot.html.markdown b/config/docs/r/lighthouse_snapshot.html.markdown new file mode 100644 index 0000000..8f93c80 --- /dev/null +++ b/config/docs/r/lighthouse_snapshot.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_snapshot" +sidebar_current: "docs-tencentcloud-resource-lighthouse_snapshot" +description: |- + Provides a resource to create a lighthouse snapshot +--- + +# tencentcloud_lighthouse_snapshot + +Provides a resource to create a lighthouse snapshot + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_snapshot" "snapshot" { + instance_id = "lhins-acd1234" + snapshot_name = "snap_20200903" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of the instance for which to create a snapshot. +* `snapshot_name` - (Optional, String) Snapshot name, which can contain up to 60 characters. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/lighthouse_start_instance.html.markdown b/config/docs/r/lighthouse_start_instance.html.markdown new file mode 100644 index 0000000..895e4c2 --- /dev/null +++ b/config/docs/r/lighthouse_start_instance.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_start_instance" +sidebar_current: "docs-tencentcloud-resource-lighthouse_start_instance" +description: |- + Provides a resource to create a lighthouse start_instance +--- + +# tencentcloud_lighthouse_start_instance + +Provides a resource to create a lighthouse start_instance + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_start_instance" "start_instance" { + instance_id = "lhins-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/lighthouse_stop_instance.html.markdown b/config/docs/r/lighthouse_stop_instance.html.markdown new file mode 100644 index 0000000..fd15402 --- /dev/null +++ b/config/docs/r/lighthouse_stop_instance.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentCloud Lighthouse(Lighthouse)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_lighthouse_stop_instance" +sidebar_current: "docs-tencentcloud-resource-lighthouse_stop_instance" +description: |- + Provides a resource to create a lighthouse stop_instance +--- + +# tencentcloud_lighthouse_stop_instance + +Provides a resource to create a lighthouse stop_instance + +## Example Usage + +```hcl +resource "tencentcloud_lighthouse_stop_instance" "stop_instance" { + instance_id = "lhins-xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_account.html.markdown b/config/docs/r/mariadb_account.html.markdown new file mode 100644 index 0000000..ed47096 --- /dev/null +++ b/config/docs/r/mariadb_account.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_account" +sidebar_current: "docs-tencentcloud-resource-mariadb_account" +description: |- + Provides a resource to create a mariadb account +--- + +# tencentcloud_mariadb_account + +Provides a resource to create a mariadb account + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_account" "account" { + instance_id = "tdsql-4pzs5b67" + user_name = "account-test" + host = "10.101.202.22" + password = "Password123." + read_only = 0 + description = "desc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `host` - (Required, String) host. +* `instance_id` - (Required, String) instance id. +* `password` - (Required, String) account password. +* `user_name` - (Required, String) user name. +* `description` - (Optional, String) account description. +* `read_only` - (Optional, Int) wether account is read only, 0 means not a read only account. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mariadb account can be imported using the instance_id#user_name#host, e.g. +``` +$ terraform import tencentcloud_mariadb_account.account tdsql-4pzs5b67#account-test#10.101.202.22 +``` + diff --git a/config/docs/r/mariadb_account_privileges.html.markdown b/config/docs/r/mariadb_account_privileges.html.markdown new file mode 100644 index 0000000..1356565 --- /dev/null +++ b/config/docs/r/mariadb_account_privileges.html.markdown @@ -0,0 +1,97 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_account_privileges" +sidebar_current: "docs-tencentcloud-resource-mariadb_account_privileges" +description: |- + Provides a resource to create a mariadb account_privileges +--- + +# tencentcloud_mariadb_account_privileges + +Provides a resource to create a mariadb account_privileges + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_account_privileges" "account_privileges" { + instance_id = "tdsql-9vqvls95" + accounts { + user = "keep-modify-privileges" + host = "127.0.0.1" + } + global_privileges = ["ALTER", "CREATE", "DELETE", "SELECT", "UPDATE", "DROP"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `accounts` - (Required, List, ForceNew) account information. +* `instance_id` - (Required, String, ForceNew) instance id. +* `column_privileges` - (Optional, List) Column permission. Valid values of `Privileges`: `SELECT`, `INSERT`, `UPDATE`, `REFERENCES`.Note: if the parameter is left empty, no change will be made to the granted column permissions. To clear the granted column permissions, set `Privileges` to an empty array. +* `database_privileges` - (Optional, List) Database permission. Valid values of `Privileges`: `SELECT`, `INSERT`, `UPDATE`, `DELETE`, `CREATE`, `DROP`, `REFERENCES`, `INDEX`, `ALTER`, `CREATE TEMPORARY TABLES`, `LOCK TABLES`, `EXECUTE`, `CREATE VIEW`, `SHOW VIEW`, `CREATE ROUTINE`, `ALTER ROUTINE`, `EVENT`, `TRIGGER`.Note: if the parameter is left empty, no change will be made to the granted database permissions. To clear the granted database permissions, set `Privileges` to an empty array. +* `function_privileges` - (Optional, List) Database function permissions. Valid values of `Privileges`: `ALTER ROUTINE`, `EXECUTE`.Note: if the parameter is not passed in, no change will be made to the granted function permissions. To clear the granted function permissions, set `Privileges` to an empty array. +* `global_privileges` - (Optional, Set: [`String`]) Global permission. Valid values of `GlobalPrivileges`: `SELECT`, `INSERT`, `UPDATE`, `DELETE`, `CREATE`, `PROCESS`, `DROP`, `REFERENCES`, `INDEX`, `ALTER`, `SHOW DATABASES`, `CREATE TEMPORARY TABLES`, `LOCK TABLES`, `EXECUTE`, `CREATE VIEW`, `SHOW VIEW`, `CREATE ROUTINE`, `ALTER ROUTINE`, `EVENT`, `TRIGGER`.Note: if the parameter is left empty, no change will be made to the granted global permissions. To clear the granted global permissions, set the parameter to an empty array. +* `procedure_privileges` - (Optional, List) Database stored procedure permission. Valid values of `Privileges`: `ALTER ROUTINE`, `EXECUTE`.Note: if the parameter is not passed in, no change will be made to the granted stored procedure permissions. To clear the granted stored procedure permissions, set `Privileges` to an empty array. +* `table_privileges` - (Optional, List) `SELECT`, `INSERT`, `UPDATE`, `DELETE`, `CREATE`, `DROP`, `REFERENCES`, `INDEX`, `ALTER`, `CREATE VIEW`, `SHOW VIEW`, `TRIGGER`.Note: if the parameter is not passed in, no change will be made to the granted table permissions. To clear the granted table permissions, set `Privileges` to an empty array. +* `view_privileges` - (Optional, List) Database view permission. Valid values of `Privileges`: `SELECT`, `INSERT`, `UPDATE`, `DELETE`, `CREATE`, `DROP`, `REFERENCES`, `INDEX`, `ALTER`, `CREATE VIEW`, `SHOW VIEW`, `TRIGGER`.Note: if the parameter is not passed in, no change will be made to the granted view permissions. To clear the granted view permissions, set `Privileges` to an empty array. + +The `accounts` object supports the following: + +* `host` - (Required, String) user host. +* `user` - (Required, String) user name. + +The `column_privileges` object supports the following: + +* `column` - (Required, String) Column name. +* `database` - (Required, String) Database name. +* `privileges` - (Required, Set) Permission information. +* `table` - (Required, String) Table name. + +The `database_privileges` object supports the following: + +* `database` - (Required, String) Database name. +* `privileges` - (Required, Set) Permission information. + +The `function_privileges` object supports the following: + +* `database` - (Required, String) Database name. +* `function_name` - (Required, String) Function name. +* `privileges` - (Required, Set) Permission information. + +The `procedure_privileges` object supports the following: + +* `database` - (Required, String) Database name. +* `privileges` - (Required, Set) Permission information. +* `procedure` - (Required, String) Procedure name. + +The `table_privileges` object supports the following: + +* `database` - (Required, String) Database name. +* `privileges` - (Required, Set) Permission information. +* `table` - (Required, String) Table name. + +The `view_privileges` object supports the following: + +* `database` - (Required, String) Database name. +* `privileges` - (Required, Set) Permission information. +* `view` - (Required, String) View name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mariadb account_privileges can be imported using the id, e.g. + +``` +terraform import tencentcloud_mariadb_account_privileges.account_privileges account_privileges_id +``` + diff --git a/config/docs/r/mariadb_activate_hour_db_instance.html.markdown b/config/docs/r/mariadb_activate_hour_db_instance.html.markdown new file mode 100644 index 0000000..1b176f8 --- /dev/null +++ b/config/docs/r/mariadb_activate_hour_db_instance.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_activate_hour_db_instance" +sidebar_current: "docs-tencentcloud-resource-mariadb_activate_hour_db_instance" +description: |- + Provides a resource to create a mariadb activate_hour_db_instance +--- + +# tencentcloud_mariadb_activate_hour_db_instance + +Provides a resource to create a mariadb activate_hour_db_instance + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_activate_hour_db_instance" "activate_hour_db_instance" { + instance_id = "tdsql-9vqvls95" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_backup_time.html.markdown b/config/docs/r/mariadb_backup_time.html.markdown new file mode 100644 index 0000000..42829fe --- /dev/null +++ b/config/docs/r/mariadb_backup_time.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_backup_time" +sidebar_current: "docs-tencentcloud-resource-mariadb_backup_time" +description: |- + Provides a resource to create a mariadb backup_time +--- + +# tencentcloud_mariadb_backup_time + +Provides a resource to create a mariadb backup_time + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_backup_time" "backup_time" { + instance_id = "tdsql-9vqvls95" + start_backup_time = "01:00" + end_backup_time = "04:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_backup_time` - (Required, String) End time of daily backup window in the format of `mm:ss`, such as 23:59. +* `instance_id` - (Required, String) instance id. +* `start_backup_time` - (Required, String) Start time of daily backup window in the format of `mm:ss`, such as 22:00. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mariadb backup_time can be imported using the id, e.g. + +``` +terraform import tencentcloud_mariadb_backup_time.backup_time backup_time_id +``` + diff --git a/config/docs/r/mariadb_cancel_dcn_job.html.markdown b/config/docs/r/mariadb_cancel_dcn_job.html.markdown new file mode 100644 index 0000000..61a7c9e --- /dev/null +++ b/config/docs/r/mariadb_cancel_dcn_job.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_cancel_dcn_job" +sidebar_current: "docs-tencentcloud-resource-mariadb_cancel_dcn_job" +description: |- + Provides a resource to create a mariadb cancel_dcn_job +--- + +# tencentcloud_mariadb_cancel_dcn_job + +Provides a resource to create a mariadb cancel_dcn_job + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_cancel_dcn_job" "cancel_dcn_job" { + instance_id = "tdsql-9vqvls95" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_clone_account.html.markdown b/config/docs/r/mariadb_clone_account.html.markdown new file mode 100644 index 0000000..30d37c9 --- /dev/null +++ b/config/docs/r/mariadb_clone_account.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_clone_account" +sidebar_current: "docs-tencentcloud-resource-mariadb_clone_account" +description: |- + Provides a resource to create a mariadb clone_account +--- + +# tencentcloud_mariadb_clone_account + +Provides a resource to create a mariadb clone_account + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_clone_account" "clone_account" { + instance_id = "tdsql-9vqvls95" + src_user = "srcuser" + src_host = "10.13.1.%" + dst_user = "dstuser" + dst_host = "10.13.23.%" + dst_desc = "test clone" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dst_host` - (Required, String, ForceNew) Target user host. +* `dst_user` - (Required, String, ForceNew) Target user account name. +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `src_host` - (Required, String, ForceNew) Source user host. +* `src_user` - (Required, String, ForceNew) Source user account name. +* `dst_desc` - (Optional, String, ForceNew) Target account description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_close_db_extranet_access.html.markdown b/config/docs/r/mariadb_close_db_extranet_access.html.markdown new file mode 100644 index 0000000..faff946 --- /dev/null +++ b/config/docs/r/mariadb_close_db_extranet_access.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_close_db_extranet_access" +sidebar_current: "docs-tencentcloud-resource-mariadb_close_db_extranet_access" +description: |- + Provides a resource to create a mariadb close_db_extranet_access +--- + +# tencentcloud_mariadb_close_db_extranet_access + +Provides a resource to create a mariadb close_db_extranet_access + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_close_db_extranet_access" "close_db_extranet_access" { + instance_id = "tdsql-9vqvls95" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of instance for which to enable public network access. The ID is in the format of `tdsql-ow728lmc` and can be obtained through the `DescribeDBInstances` API. +* `ipv6_flag` - (Optional, Int, ForceNew) Whether IPv6 is used. Default value: 0. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_copy_account_privileges.html.markdown b/config/docs/r/mariadb_copy_account_privileges.html.markdown new file mode 100644 index 0000000..a55c746 --- /dev/null +++ b/config/docs/r/mariadb_copy_account_privileges.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_copy_account_privileges" +sidebar_current: "docs-tencentcloud-resource-mariadb_copy_account_privileges" +description: |- + Provides a resource to create a mariadb copy_account_privileges +--- + +# tencentcloud_mariadb_copy_account_privileges + +Provides a resource to create a mariadb copy_account_privileges + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_copy_account_privileges" "copy_account_privileges" { + instance_id = "tdsql-9vqvls95" + src_user_name = "keep-modify-privileges" + src_host = "127.0.0.1" + dst_user_name = "keep-copy-user" + dst_host = "127.0.0.1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dst_host` - (Required, String, ForceNew) Access host allowed for target user. +* `dst_user_name` - (Required, String, ForceNew) Target username. +* `instance_id` - (Required, String, ForceNew) Instance ID, which is in the format of `tdsql-ow728lmc` and can be obtained through the `DescribeDBInstances` API. +* `src_host` - (Required, String, ForceNew) Access host allowed for source user. +* `src_user_name` - (Required, String, ForceNew) Source username. +* `dst_read_only` - (Optional, String, ForceNew) `ReadOnly` attribute of target account. +* `src_read_only` - (Optional, String, ForceNew) `ReadOnly` attribute of source account. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_create_tmp_instance.html.markdown b/config/docs/r/mariadb_create_tmp_instance.html.markdown new file mode 100644 index 0000000..7fbda74 --- /dev/null +++ b/config/docs/r/mariadb_create_tmp_instance.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_create_tmp_instance" +sidebar_current: "docs-tencentcloud-resource-mariadb_create_tmp_instance" +description: |- + Provides a resource to create a mariadb create_tmp_instance +--- + +# tencentcloud_mariadb_create_tmp_instance + +Provides a resource to create a mariadb create_tmp_instance + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_create_tmp_instance" "create_tmp_instance" { + instance_id = "tdsql-9vqvls95" + rollback_time = "2023-06-05 01:00:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `rollback_time` - (Required, String, ForceNew) Rollback time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_dedicatedcluster_db_instance.html.markdown b/config/docs/r/mariadb_dedicatedcluster_db_instance.html.markdown new file mode 100644 index 0000000..088f56e --- /dev/null +++ b/config/docs/r/mariadb_dedicatedcluster_db_instance.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_dedicatedcluster_db_instance" +sidebar_current: "docs-tencentcloud-resource-mariadb_dedicatedcluster_db_instance" +description: |- + Provides a resource to create a mariadb dedicatedcluster_db_instance +--- + +# tencentcloud_mariadb_dedicatedcluster_db_instance + +Provides a resource to create a mariadb dedicatedcluster_db_instance + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_dedicatedcluster_db_instance" "dedicatedcluster_db_instance" { + goods_num = 1 + memory = 2 + storage = 10 + cluster_id = "dbdc-24odnuhr" + vpc_id = "vpc-ii1jfbhl" + subnet_id = "subnet-3ku415by" + db_version_id = "8.0" + instance_name = "cluster-mariadb-test-1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) dedicated cluster id. +* `goods_num` - (Required, Int) number of instance. +* `memory` - (Required, Int) instance memory. +* `storage` - (Required, Int) instance disk storage. +* `db_version_id` - (Optional, String) db engine version, default to 0. +* `instance_name` - (Optional, String) name of this instance. +* `project_id` - (Optional, Int) project id. +* `subnet_id` - (Optional, String) subnet id, it&#39;s required when vpcId is set. +* `tags` - (Optional, Map) Tag description list. +* `vip` - (Optional, String) vip. +* `vpc_id` - (Optional, String) vpc id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mariadb dedicatedcluster_db_instance can be imported using the id, e.g. +``` +$ terraform import tencentcloud_mariadb_dedicatedcluster_db_instance.dedicatedcluster_db_instance tdsql-050g3fmv +``` + diff --git a/config/docs/r/mariadb_flush_binlog.html.markdown b/config/docs/r/mariadb_flush_binlog.html.markdown new file mode 100644 index 0000000..500017a --- /dev/null +++ b/config/docs/r/mariadb_flush_binlog.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_flush_binlog" +sidebar_current: "docs-tencentcloud-resource-mariadb_flush_binlog" +description: |- + Provides a resource to create a mariadb flush_binlog +--- + +# tencentcloud_mariadb_flush_binlog + +Provides a resource to create a mariadb flush_binlog + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_flush_binlog" "flush_binlog" { + instance_id = "tdsql-9vqvls95" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_grant_account_privileges.html.markdown b/config/docs/r/mariadb_grant_account_privileges.html.markdown new file mode 100644 index 0000000..8f5029b --- /dev/null +++ b/config/docs/r/mariadb_grant_account_privileges.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_grant_account_privileges" +sidebar_current: "docs-tencentcloud-resource-mariadb_grant_account_privileges" +description: |- + Provides a resource to create a mariadb grant_account_privileges +--- + +# tencentcloud_mariadb_grant_account_privileges + +Provides a resource to create a mariadb grant_account_privileges + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_grant_account_privileges" "grant_account_privileges" { + instance_id = "tdsql-9vqvls95" + user_name = "keep-modify-privileges" + host = "127.0.0.1" + db_name = "*" + privileges = ["SELECT", "INSERT"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_name` - (Required, String, ForceNew) Database name. `*` indicates that global permissions will be set (i.e., `*.*`), in which case the `Type` and `Object ` parameters will be ignored. If `DbName` is not `*`, the input parameter `Type` is required. +* `host` - (Required, String, ForceNew) Access host allowed for user. An account is uniquely identified by username and host. +* `instance_id` - (Required, String, ForceNew) Instance ID, which is in the format of `tdsql-ow728lmc` and can be obtained through the `DescribeDBInstances` API. +* `privileges` - (Required, Set: [`String`], ForceNew) Global permissions: SELECT, Insert, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALT, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALT ROUTINE, EVENT, TRIGGER, SHOW DATABASES, REPLICATION CLIENT, REPLICATION SLAVE Library permissions: SELECT, Insert, UPDATE, DELETE, CRAVE EATE, DROP, REFERENCES, INDEX, ALT, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALT ROUTINE, EVENT, TRIGGER Table/View Permissions: SELECT, Insert, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALT, CREATE VIEW, SHOW VIEW, TRIGGER Stored Procedure/Function Permissions: ALT ROUTINE, EXECUTE Field Permissions: Insert, REFERENCES, SELECT, UPDATE. +* `user_name` - (Required, String, ForceNew) Login username. +* `col_name` - (Optional, String, ForceNew) If `Type` is `table` and `ColName` is `*`, the permissions will be granted to the table; if `ColName` is a specific field name, the permissions will be granted to the field. +* `object` - (Optional, String, ForceNew) Type name. For example, if `Type` is `table`, `Object` indicates a specific table name; if both `DbName` and `Type` are specific names, it indicates a specific object name and cannot be `*` or empty. +* `type` - (Optional, String, ForceNew) Type. Valid values: table, view, proc, func, *. If `DbName` is a specific database name and `Type` is `*`, the permissions of the database will be set (i.e., `db.*`), in which case the `Object` parameter will be ignored. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_hour_db_instance.html.markdown b/config/docs/r/mariadb_hour_db_instance.html.markdown new file mode 100644 index 0000000..fb2bbf8 --- /dev/null +++ b/config/docs/r/mariadb_hour_db_instance.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_hour_db_instance" +sidebar_current: "docs-tencentcloud-resource-mariadb_hour_db_instance" +description: |- + Provides a resource to create a mariadb hour_db_instance +--- + +# tencentcloud_mariadb_hour_db_instance + +Provides a resource to create a mariadb hour_db_instance + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_hour_db_instance" "basic" { + db_version_id = "10.0" + instance_name = "db-test-del" + memory = 2 + node_count = 2 + storage = 10 + subnet_id = "subnet-jdi5xn22" + vpc_id = "vpc-k1t8ickr" + vip = "10.0.0.197" + zones = [ + "ap-guangzhou-6", + "ap-guangzhou-7", + ] + tags = { + createdBy = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `memory` - (Required, Int) instance memory. +* `node_count` - (Required, Int) number of node for instance. +* `storage` - (Required, Int) instance disk storage. +* `zones` - (Required, Set: [`String`]) available zone of instance. +* `db_version_id` - (Optional, String) db engine version, default to 10.1.9. +* `instance_name` - (Optional, String) name of this instance. +* `project_id` - (Optional, Int) project id. +* `subnet_id` - (Optional, String) subnet id, it&#39;s required when vpcId is set. +* `tags` - (Optional, Map) Tag description list. +* `vip` - (Optional, String) vip. +* `vpc_id` - (Optional, String) vpc id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mariadb hour_db_instance can be imported using the id, e.g. +``` +$ terraform import tencentcloud_mariadb_hour_db_instance.hour_db_instance tdsql-kjqih9nn +``` + diff --git a/config/docs/r/mariadb_instance.html.markdown b/config/docs/r/mariadb_instance.html.markdown new file mode 100644 index 0000000..33f9dc4 --- /dev/null +++ b/config/docs/r/mariadb_instance.html.markdown @@ -0,0 +1,134 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_instance" +sidebar_current: "docs-tencentcloud-resource-mariadb_instance" +description: |- + Provides a resource to create a mariadb instance +--- + +# tencentcloud_mariadb_instance + +Provides a resource to create a mariadb instance + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_instance" "instance" { + zones = ["ap-guangzhou-3", ] + node_count = 2 + memory = 8 + storage = 10 + period = 1 + # auto_voucher = + # voucher_ids = + vpc_id = "vpc-ii1jfbhl" + subnet_id = "subnet-3ku415by" + # project_id = "" + db_version_id = "8.0" + instance_name = "terraform-test" + # security_group_ids = "" + auto_renew_flag = 1 + ipv6_flag = 0 + tags = { + "createby" = "terrafrom-2" + } + init_params { + param = "character_set_server" + value = "utf8mb4" + } + init_params { + param = "lower_case_table_names" + value = "0" + } + init_params { + param = "innodb_page_size" + value = "16384" + } + init_params { + param = "sync_mode" + value = "1" + } + dcn_region = "" + dcn_instance_id = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `memory` - (Required, Int) Memory size, unit: GB, can be obtained by querying instance specifications through DescribeDBInstanceSpecs. +* `node_count` - (Required, Int) Number of nodes, 2 is one master and one slave, 3 is one master and two slaves. +* `storage` - (Required, Int) Storage size, unit: GB. You can query instance specifications through DescribeDBInstanceSpecs to obtain the lower and upper limits of disk specifications corresponding to different memory sizes. +* `zones` - (Required, Set: [`String`]) Instance node availability zone distribution, up to two availability zones can be filled. When the shard specification is one master and two slaves, two of the nodes are in the first availability zone. +* `auto_renew_flag` - (Optional, Int) Automatic renewal flag, 1: automatic renewal, 2: no automatic renewal. +* `auto_voucher` - (Optional, Bool, ForceNew) Whether to automatically use the voucher for payment, the default is not used. +* `db_version_id` - (Optional, String) Database engine version, currently available: 8.0.18, 10.1.9, 5.7.17. If not passed, the default is Percona 5.7.17. +* `dcn_instance_id` - (Optional, String, ForceNew) DCN source instance ID. +* `dcn_region` - (Optional, String, ForceNew) DCN source region. +* `init_params` - (Optional, List, ForceNew) Parameter list. The optional values of this interface are: character_set_server (character set, required) enum: utf8,latin1,gbk,utf8mb4,gb18030, lower_case_table_names (table name case sensitive, required, 0 - sensitive; 1 - insensitive), innodb_page_size (innodb data page, Default 16K), sync_mode (sync mode: 0 - asynchronous; 1 - strong synchronous; 2 - strong synchronous can degenerate. The default is strong synchronous can degenerate). +* `instance_name` - (Optional, String) Instance name, you can set the name of the instance independently through this field. +* `ipv6_flag` - (Optional, Int) Whether IPv6 is supported. +* `period` - (Optional, Int, ForceNew) The duration of the purchase, unit: month. +* `project_id` - (Optional, Int) Project ID, which can be obtained by viewing the project list, if not passed, it will be associated with the default project. +* `security_group_ids` - (Optional, Set: [`String`]) Security group ID list. +* `subnet_id` - (Optional, String) Virtual private network subnet ID, required when VpcId is not empty. +* `tags` - (Optional, Map) tag list. +* `vip` - (Optional, String) Intranet IP address. +* `voucher_ids` - (Optional, Set: [`String`], ForceNew) A list of voucher IDs. Currently, only one voucher can be specified. +* `vpc_id` - (Optional, String) Virtual private network ID, if not passed, it means that it is created as a basic network. + +The `init_params` object supports the following: + +* `param` - (Required, String) parameter name. +* `value` - (Required, String) parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `app_id` - ID of the application to which the instance belongs. +* `cpu` - Number of CPU cores of the instance. +* `create_time` - Instance creation time, the format is 2006-01-02 15:04:05. +* `db_engine` - Database Engine. +* `dcn_dst_num` - Number of DCN disaster recovery instances. +* `dcn_flag` - DCN flag, 0-none, 1-primary instance, 2-disaster backup instance. +* `dcn_status` - DCN status, 0-none, 1-creating, 2-synchronizing, 3-disconnected. +* `excluster_id` - Exclusive cluster ID, if it is empty, it means a normal instance. +* `instance_id` - Instance ID, uniquely identifies a TDSQL instance. +* `instance_type` - 1: primary instance (exclusive), 2: primary instance, 3: disaster recovery instance, 4: disaster recovery instance (exclusive type). +* `is_audit_supported` - Whether the instance supports auditing. 1-supported; 0-not supported. +* `is_encrypt_supported` - Whether data encryption is supported. 1-supported; 0-not supported. +* `is_tmp` - Whether it is a temporary instance, 0 means no, non-zero means yes. +* `locker` - Asynchronous task process ID when the instance is in an asynchronous task. +* `machine` - Machine Model. +* `paymode` - Payment Mode. +* `period_end_time` - Instance expiration time, the format is 2006-01-02 15:04:05. +* `pid` - Product Type ID. +* `qps` - Maximum Qps value. +* `region` - The name of the region where the instance is located, such as ap-shanghai. +* `status_desc` - Description of the current running state of the instance. +* `status` - Instance status: 0 creating, 1 process processing, 2 running, 3 instance not initialized, -1 instance isolated, 4 instance initializing, 5 instance deleting, 6 instance restarting, 7 data migration. +* `tdsql_version` - TDSQL version information. +* `uin` - The account to which the instance belongs. +* `update_time` - The last update time of the instance in the format of 2006-01-02 15:04:05. +* `vipv6` - Intranet IPv6. +* `vport` - Intranet port. +* `wan_domain` - The domain name accessed from the external network, which can be resolved by the public network. +* `wan_port_ipv6` - Internet IPv6 port. +* `wan_port` - Internet port. +* `wan_status_ipv6` - Internet IPv6 status. +* `wan_status` - External network status, 0-unopened; 1-opened; 2-closed; 3-opening. +* `wan_vip` - Extranet IP address, accessible from the public network. +* `wan_vipv6` - Internet IPv6. + + +## Import + +mariadb tencentcloud_mariadb_instance can be imported using the id, e.g. +``` +$ terraform import tencentcloud_mariadb_instance.instance tdsql-4pzs5b67 +``` + diff --git a/config/docs/r/mariadb_instance_config.html.markdown b/config/docs/r/mariadb_instance_config.html.markdown new file mode 100644 index 0000000..f095a33 --- /dev/null +++ b/config/docs/r/mariadb_instance_config.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_instance_config" +sidebar_current: "docs-tencentcloud-resource-mariadb_instance_config" +description: |- + Provides a resource to create a mariadb instance_config +--- + +# tencentcloud_mariadb_instance_config + +Provides a resource to create a mariadb instance_config + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_instance_config" "test" { + instance_id = "tdsql-9vqvls95" + vpc_id = "vpc-ii1jfbhl" + subnet_id = "subnet-3ku415by" + rs_access_strategy = 1 + extranet_access = 0 + vip = "127.0.0.1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) instance id. +* `extranet_access` - (Optional, Int) External network status, 0-closed; 1- Opening; Default not enabled. +* `rs_access_strategy` - (Optional, Int) RS proximity mode, 0- no strategy, 1- access to the nearest available zone. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mariadb instance_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_mariadb_instance_config.test id +``` + diff --git a/config/docs/r/mariadb_log_file_retention_period.html.markdown b/config/docs/r/mariadb_log_file_retention_period.html.markdown new file mode 100644 index 0000000..aafb16b --- /dev/null +++ b/config/docs/r/mariadb_log_file_retention_period.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_log_file_retention_period" +sidebar_current: "docs-tencentcloud-resource-mariadb_log_file_retention_period" +description: |- + Provides a resource to create a mariadb log_file_retention_period +--- + +# tencentcloud_mariadb_log_file_retention_period + +Provides a resource to create a mariadb log_file_retention_period + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_log_file_retention_period" "log_file_retention_period" { + instance_id = "tdsql-4pzs5b67" + days = "8" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `days` - (Required, Int) The number of days to save, cannot exceed 30. +* `instance_id` - (Required, String) instance id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mariadb log_file_retention_period can be imported using the id, e.g. +``` +$ terraform import tencentcloud_mariadb_log_file_retention_period.log_file_retention_period tdsql-4pzs5b67 +``` + diff --git a/config/docs/r/mariadb_operate_hour_db_instance.html.markdown b/config/docs/r/mariadb_operate_hour_db_instance.html.markdown new file mode 100644 index 0000000..6a8b23b --- /dev/null +++ b/config/docs/r/mariadb_operate_hour_db_instance.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_operate_hour_db_instance" +sidebar_current: "docs-tencentcloud-resource-mariadb_operate_hour_db_instance" +description: |- + Provides a resource to create a mariadb activate_hour_db_instance +--- + +# tencentcloud_mariadb_operate_hour_db_instance + +Provides a resource to create a mariadb activate_hour_db_instance + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_operate_hour_db_instance" "activate_hour_db_instance" { + instance_id = "tdsql-9vqvls95" + operate = "activate" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `operate` - (Required, String) Operation, `activate`- activate the hour db instance, `isolate`- isolate the hour db instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_parameters.html.markdown b/config/docs/r/mariadb_parameters.html.markdown new file mode 100644 index 0000000..022f227 --- /dev/null +++ b/config/docs/r/mariadb_parameters.html.markdown @@ -0,0 +1,309 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_parameters" +sidebar_current: "docs-tencentcloud-resource-mariadb_parameters" +description: |- + Provides a resource to create a mariadb parameters +--- + +# tencentcloud_mariadb_parameters + +Provides a resource to create a mariadb parameters + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_parameters" "parameters" { + instance_id = "tdsql-4pzs5b67" + + params { + param = "auto_increment_increment" + value = "1" + } + params { + param = "auto_increment_offset" + value = "1" + } + params { + param = "autocommit" + value = "ON" + } + params { + param = "character_set_server" + value = "utf8mb4" + } + params { + param = "collation_connection" + value = "utf8mb4_general_ci" + } + params { + param = "collation_database" + value = "utf8mb4_general_ci" + } + params { + param = "collation_server" + value = "utf8mb4_general_ci" + } + params { + param = "connect_timeout" + value = "10" + } + params { + param = "default_collation_for_utf8mb4" + value = "utf8mb4_general_ci" + } + params { + param = "default_week_format" + value = "0" + } + params { + param = "delay_key_write" + value = "ON" + } + params { + param = "delayed_insert_limit" + value = "100" + } + params { + param = "delayed_insert_timeout" + value = "300" + } + params { + param = "delayed_queue_size" + value = "1000" + } + params { + param = "div_precision_increment" + value = "4" + } + params { + param = "event_scheduler" + value = "ON" + } + params { + param = "group_concat_max_len" + value = "1024" + } + params { + param = "innodb_concurrency_tickets" + value = "5000" + } + params { + param = "innodb_flush_log_at_trx_commit" + value = "1" + } + params { + param = "innodb_lock_wait_timeout" + value = "20" + } + params { + param = "innodb_max_dirty_pages_pct" + value = "70.000000" + } + params { + param = "innodb_old_blocks_pct" + value = "37" + } + params { + param = "innodb_old_blocks_time" + value = "1000" + } + params { + param = "innodb_purge_batch_size" + value = "1000" + } + params { + param = "innodb_read_ahead_threshold" + value = "56" + } + params { + param = "innodb_stats_method" + value = "nulls_equal" + } + params { + param = "innodb_stats_on_metadata" + value = "OFF" + } + params { + param = "innodb_strict_mode" + value = "OFF" + } + params { + param = "innodb_table_locks" + value = "ON" + } + params { + param = "innodb_thread_concurrency" + value = "0" + } + params { + param = "interactive_timeout" + value = "28800" + } + params { + param = "key_cache_age_threshold" + value = "300" + } + params { + param = "key_cache_block_size" + value = "1024" + } + params { + param = "key_cache_division_limit" + value = "100" + } + params { + param = "local_infile" + value = "OFF" + } + params { + param = "lock_wait_timeout" + value = "5" + } + params { + param = "log_queries_not_using_indexes" + value = "OFF" + } + params { + param = "long_query_time" + value = "1.000000" + } + params { + param = "low_priority_updates" + value = "OFF" + } + params { + param = "max_allowed_packet" + value = "1073741824" + } + params { + param = "max_binlog_size" + value = "536870912" + } + params { + param = "max_connect_errors" + value = "2000" + } + params { + param = "max_connections" + value = "10000" + } + params { + param = "max_execution_time" + value = "0" + } + params { + param = "max_prepared_stmt_count" + value = "200000" + } + params { + param = "myisam_sort_buffer_size" + value = "4194304" + } + params { + param = "net_buffer_length" + value = "16384" + } + params { + param = "net_read_timeout" + value = "150" + } + params { + param = "net_retry_count" + value = "10" + } + params { + param = "net_write_timeout" + value = "300" + } + params { + param = "query_alloc_block_size" + value = "16384" + } + params { + param = "query_prealloc_size" + value = "24576" + } + params { + param = "slow_launch_time" + value = "2" + } + params { + param = "sort_buffer_size" + value = "2097152" + } + params { + param = "sql_mode" + value = "NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES" + } + params { + param = "sql_require_primary_key" + value = "ON" + } + params { + param = "sql_safe_updates" + value = "OFF" + } + params { + param = "sqlasyntimeout" + value = "30" + } + params { + param = "sync_binlog" + value = "1" + } + params { + param = "table_definition_cache" + value = "10240" + } + params { + param = "table_open_cache" + value = "20480" + } + params { + param = "time_zone" + value = "+08:00" + } + params { + param = "tmp_table_size" + value = "33554432" + } + params { + param = "tx_isolation" + value = "READ-COMMITTED" + } + params { + param = "wait_timeout" + value = "28800" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `params` - (Required, List) Number of days to keep, no more than 30. + +The `params` object supports the following: + +* `param` - (Required, String) parameter name. +* `value` - (Required, String) parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mariadb parameters can be imported using the id, e.g. +``` +$ terraform import tencentcloud_mariadb_parameters.parameters tdsql-4pzs5b67 +``` + diff --git a/config/docs/r/mariadb_renew_instance.html.markdown b/config/docs/r/mariadb_renew_instance.html.markdown new file mode 100644 index 0000000..4c3fc86 --- /dev/null +++ b/config/docs/r/mariadb_renew_instance.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_renew_instance" +sidebar_current: "docs-tencentcloud-resource-mariadb_renew_instance" +description: |- + Provides a resource to create a mariadb renew_instance +--- + +# tencentcloud_mariadb_renew_instance + +Provides a resource to create a mariadb renew_instance + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_renew_instance" "renew_instance" { + instance_id = "tdsql-9vqvls95" + period = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `period` - (Required, Int, ForceNew) Renewal duration, unit: month. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_restart_instance.html.markdown b/config/docs/r/mariadb_restart_instance.html.markdown new file mode 100644 index 0000000..e75eac9 --- /dev/null +++ b/config/docs/r/mariadb_restart_instance.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_restart_instance" +sidebar_current: "docs-tencentcloud-resource-mariadb_restart_instance" +description: |- + Provides a resource to create a mariadb restart_instance +--- + +# tencentcloud_mariadb_restart_instance + +Provides a resource to create a mariadb restart_instance + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_restart_instance" "restart_instance" { + instance_id = "tdsql-9vqvls95" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) instance ID. +* `restart_time` - (Optional, String, ForceNew) expected restart time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mariadb_security_groups.html.markdown b/config/docs/r/mariadb_security_groups.html.markdown new file mode 100644 index 0000000..bc32a23 --- /dev/null +++ b/config/docs/r/mariadb_security_groups.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_security_groups" +sidebar_current: "docs-tencentcloud-resource-mariadb_security_groups" +description: |- + Provides a resource to create a mariadb security_groups +--- + +# tencentcloud_mariadb_security_groups + +Provides a resource to create a mariadb security_groups + +~> **NOTE:** If you use this resource, please do not use security_group_ids in tencentcloud_mariadb_instance resource + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_security_groups" "security_groups" { + instance_id = "tdsql-4pzs5b67" + security_group_id = "sg-7kpsbxdb" + product = "mariadb" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) instance id. +* `product` - (Required, String) product name, fixed to mariadb. +* `security_group_id` - (Required, String) security group id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mariadb security_groups can be imported using the id, e.g. +``` +$ terraform import tencentcloud_mariadb_security_groups.security_groups tdsql-4pzs5b67#sg-7kpsbxdb#mariadb +``` + diff --git a/config/docs/r/mariadb_switch_ha.html.markdown b/config/docs/r/mariadb_switch_ha.html.markdown new file mode 100644 index 0000000..8201b58 --- /dev/null +++ b/config/docs/r/mariadb_switch_ha.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for MariaDB(MariaDB)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mariadb_switch_ha" +sidebar_current: "docs-tencentcloud-resource-mariadb_switch_ha" +description: |- + Provides a resource to create a mariadb switch_h_a +--- + +# tencentcloud_mariadb_switch_ha + +Provides a resource to create a mariadb switch_h_a + +## Example Usage + +```hcl +resource "tencentcloud_mariadb_switch_ha" "switch_ha" { + instance_id = "tdsql-9vqvls95" + zone = "ap-guangzhou-2" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID in the format of tdsql-ow728lmc. +* `zone` - (Required, String, ForceNew) Target AZ. The node with the lowest delay in the target AZ will be automatically promoted to primary node. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mdl_stream_live_input.html.markdown b/config/docs/r/mdl_stream_live_input.html.markdown new file mode 100644 index 0000000..1760d00 --- /dev/null +++ b/config/docs/r/mdl_stream_live_input.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "StreamLive(MDL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mdl_stream_live_input" +sidebar_current: "docs-tencentcloud-resource-mdl_stream_live_input" +description: |- + Provides a resource to create a mdl streamlive_input +--- + +# tencentcloud_mdl_stream_live_input + +Provides a resource to create a mdl streamlive_input + +## Example Usage + +```hcl +resource "tencentcloud_mdl_stream_live_input" "stream_live_input" { + name = "terraform_test" + type = "RTP_PUSH" + security_group_ids = [ + "6405DF9D000007DFB4EC" + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Input name, which can contain 1-32 case-sensitive letters, digits, and underscores and must be unique at the region level. +* `type` - (Required, String, ForceNew) Input typeValid values: `RTMP_PUSH`, `RTP_PUSH`, `UDP_PUSH`, `RTMP_PULL`, `HLS_PULL`, `MP4_PULL`. +* `input_settings` - (Optional, List) Input settings. For the type `RTMP_PUSH`, `RTMP_PULL`, `HLS_PULL`, or `MP4_PULL`, 1 or 2 inputs of the corresponding type can be configured. +* `security_group_ids` - (Optional, Set: [`String`]) ID of the input security group to attachYou can attach only one security group to an input. + +The `input_settings` object supports the following: + +* `app_name` - (Optional, String) Application name, which is valid if `Type` is `RTMP_PUSH` and can contain 1-32 letters and digitsNote: This field may return `null`, indicating that no valid value was found. +* `delay_time` - (Optional, Int) Delayed time (ms) for playback, which is valid if `Type` is `RTMP_PUSH`Value range: 0 (default) or 10000-600000The value must be a multiple of 1,000.Note: This field may return `null`, indicating that no valid value was found. +* `input_address` - (Optional, String) RTP/UDP input address, which does not need to be entered for the input parameter.Note: this field may return null, indicating that no valid values can be obtained. +* `input_domain` - (Optional, String) The domain of an SRT_PUSH address. If this is a request parameter, you do not need to specify it.Note: This field may return `null`, indicating that no valid value was found. +* `password` - (Optional, String) The password, which is used for authentication.Note: This field may return `null`, indicating that no valid value was found. +* `source_type` - (Optional, String) Source type for stream pulling and relaying. To pull content from private-read COS buckets under the current account, set this parameter to `TencentCOS`; otherwise, leave it empty.Note: this field may return `null`, indicating that no valid value was found. +* `source_url` - (Optional, String) Source URL, which is valid if `Type` is `RTMP_PULL`, `HLS_PULL`, or `MP4_PULL` and can contain 1-512 charactersNote: This field may return `null`, indicating that no valid value was found. +* `stream_name` - (Optional, String) Stream name, which is valid if `Type` is `RTMP_PUSH` and can contain 1-32 letters and digitsNote: This field may return `null`, indicating that no valid value was found. +* `user_name` - (Optional, String) The username, which is used for authentication.Note: This field may return `null`, indicating that no valid value was found. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mdl stream_live_input can be imported using the id, e.g. + +``` +terraform import tencentcloud_mdl_stream_live_input.stream_live_input id +``` + diff --git a/config/docs/r/mongodb_instance.html.markdown b/config/docs/r/mongodb_instance.html.markdown new file mode 100644 index 0000000..d9c0c83 --- /dev/null +++ b/config/docs/r/mongodb_instance.html.markdown @@ -0,0 +1,79 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_instance" +sidebar_current: "docs-tencentcloud-resource-mongodb_instance" +description: |- + Provide a resource to create a Mongodb instance. +--- + +# tencentcloud_mongodb_instance + +Provide a resource to create a Mongodb instance. + +## Example Usage + +```hcl +resource "tencentcloud_mongodb_instance" "mongodb" { + instance_name = "mongodb" + memory = 4 + volume = 100 + engine_version = "MONGO_36_WT" + machine_type = "HIO10G" + available_zone = "ap-guangzhou-2" + vpc_id = "vpc-xxxxxx" + subnet_id = "subnet-xxxxxx" + project_id = 0 + password = "password1234" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `available_zone` - (Required, String, ForceNew) The available zone of the Mongodb. +* `engine_version` - (Required, String, ForceNew) Version of the Mongodb, and available values include `MONGO_36_WT` (MongoDB 3.6 WiredTiger Edition), `MONGO_40_WT` (MongoDB 4.0 WiredTiger Edition) and `MONGO_42_WT` (MongoDB 4.2 WiredTiger Edition). NOTE: `MONGO_3_WT` (MongoDB 3.2 WiredTiger Edition) and `MONGO_3_ROCKS` (MongoDB 3.2 RocksDB Edition) will deprecated. +* `instance_name` - (Required, String) Name of the Mongodb instance. +* `machine_type` - (Required, String, ForceNew) Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated, represents high IO) and `HIO10G`(or `TGIO` which will be deprecated, represents 10-gigabit high IO). +* `memory` - (Required, Int) Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. +* `volume` - (Required, Int) Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. +* `auto_renew_flag` - (Optional, Int) Auto renew flag. Valid values are `0`(NOTIFY_AND_MANUAL_RENEW), `1`(NOTIFY_AND_AUTO_RENEW) and `2`(DISABLE_NOTIFY_AND_MANUAL_RENEW). Default value is `0`. Note: only works for PREPAID instance. Only supports`0` and `1` for creation. +* `availability_zone_list` - (Optional, List: [`String`]) A list of nodes deployed in multiple availability zones. For more information, please use the API DescribeSpecInfo. + - Multi-availability zone deployment nodes can only be deployed in 3 different availability zones. It is not supported to deploy most nodes of the cluster in the same availability zone. For example, a 3-node cluster does not support the deployment of 2 nodes in the same zone. + - Version 4.2 and above are not supported. + - Read-only disaster recovery instances are not supported. + - Basic network cannot be selected. +* `charge_type` - (Optional, String, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. Default value is `POSTPAID_BY_HOUR`. Note: TencentCloud International only supports `POSTPAID_BY_HOUR`. Caution that update operation on this field will delete old instances and create new one with new charge type. +* `hidden_zone` - (Optional, String) The availability zone to which the Hidden node belongs. This parameter must be configured to deploy instances across availability zones. +* `node_num` - (Optional, Int) The number of nodes in each replica set. Default value: 3. +* `password` - (Optional, String) Password of this Mongodb account. +* `prepaid_period` - (Optional, Int) The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to `PREPAID`. +* `project_id` - (Optional, Int) ID of the project which the instance belongs. +* `security_groups` - (Optional, Set: [`String`], ForceNew) ID of the security group. +* `subnet_id` - (Optional, String, ForceNew) ID of the subnet within this VPC. The value is required if `vpc_id` is set. +* `tags` - (Optional, Map) The tags of the Mongodb. Key name `project` is system reserved and can't be used. +* `vpc_id` - (Optional, String, ForceNew) ID of the VPC. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of the Mongodb instance. +* `standby_instance_list` - List of standby instances' info. + * `standby_instance_id` - Indicates the ID of standby instance. + * `standby_instance_region` - Indicates the region of standby instance. +* `status` - Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2). +* `vip` - IP of the Mongodb instance. +* `vport` - IP port of the Mongodb instance. + + +## Import + +Mongodb instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_mongodb_instance.mongodb cmgo-41s6jwy4 +``` + diff --git a/config/docs/r/mongodb_instance_account.html.markdown b/config/docs/r/mongodb_instance_account.html.markdown new file mode 100644 index 0000000..fe23191 --- /dev/null +++ b/config/docs/r/mongodb_instance_account.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_instance_account" +sidebar_current: "docs-tencentcloud-resource-mongodb_instance_account" +description: |- + Provides a resource to create a mongodb instance_account +--- + +# tencentcloud_mongodb_instance_account + +Provides a resource to create a mongodb instance_account + +## Example Usage + +```hcl +resource "tencentcloud_mongodb_instance_account" "instance_account" { + instance_id = "cmgo-lxaz2c9b" + user_name = "test_account" + password = "xxxxxxxx" + mongo_user_password = "xxxxxxxxx" + user_desc = "test account" + auth_role { + mask = 0 + namespace = "*" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page. +* `mongo_user_password` - (Required, String, ForceNew) The password corresponding to the mongouser account. mongouser is the system default account, which is the password set when creating an instance. +* `password` - (Required, String) New account password. Password complexity requirements are as follows: character length range [8,32]. Contains at least letters, numbers and special characters (exclamation point!, at@, pound sign #, percent sign %, caret ^, asterisk *, parentheses (), underscore _). +* `user_name` - (Required, String, ForceNew) The new account name. Its format requirements are as follows: character range [1,32]. Characters in the range of [A,Z], [a,z], [1,9] as well as underscore _ and dash - can be input. +* `auth_role` - (Optional, List) The read and write permission information of the account. +* `user_desc` - (Optional, String) Account remarks. + +The `auth_role` object supports the following: + +* `mask` - (Required, Int) Permission information of the current account. 0: No permission. 1: read-only. 2: Write only. 3: Read and write. +* `namespace` - (Required, String) Refers to the name of the database with the current account permissions.*: Indicates all databases. db.name: Indicates the database of a specific name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mongodb_instance_backup.html.markdown b/config/docs/r/mongodb_instance_backup.html.markdown new file mode 100644 index 0000000..8899595 --- /dev/null +++ b/config/docs/r/mongodb_instance_backup.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_instance_backup" +sidebar_current: "docs-tencentcloud-resource-mongodb_instance_backup" +description: |- + Provides a resource to create a mongodb instance_backup +--- + +# tencentcloud_mongodb_instance_backup + +Provides a resource to create a mongodb instance_backup + +## Example Usage + +```hcl +resource "tencentcloud_mongodb_instance_backup" "instance_backup" { + instance_id = "cmgo-9d0p6umb" + backup_method = 0 + backup_remark = "my backup" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_method` - (Required, Int, ForceNew) 0:logical backup, 1:physical backup. +* `instance_id` - (Required, String, ForceNew) Instance ID, the format is: cmgo-9d0p6umb.Same as the instance ID displayed in the cloud database console page. +* `backup_remark` - (Optional, String, ForceNew) backup notes. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mongodb_sharding_instance.html.markdown b/config/docs/r/mongodb_sharding_instance.html.markdown new file mode 100644 index 0000000..262c556 --- /dev/null +++ b/config/docs/r/mongodb_sharding_instance.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_sharding_instance" +sidebar_current: "docs-tencentcloud-resource-mongodb_sharding_instance" +description: |- + Provide a resource to create a Mongodb sharding instance. +--- + +# tencentcloud_mongodb_sharding_instance + +Provide a resource to create a Mongodb sharding instance. + +## Example Usage + +```hcl +resource "tencentcloud_mongodb_sharding_instance" "mongodb" { + instance_name = "mongodb" + shard_quantity = 2 + nodes_per_shard = 3 + memory = 4 + volume = 100 + engine_version = "MONGO_36_WT" + machine_type = "HIO10G" + available_zone = "ap-guangzhou-3" + vpc_id = "vpc-mz3efvbw" + subnet_id = "subnet-lk0svi3p" + project_id = 0 + password = "password1234" + mongos_cpu = 1 + mongos_memory = 2 + mongos_node_num = 3 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `available_zone` - (Required, String, ForceNew) The available zone of the Mongodb. +* `engine_version` - (Required, String, ForceNew) Version of the Mongodb, and available values include `MONGO_36_WT` (MongoDB 3.6 WiredTiger Edition), `MONGO_40_WT` (MongoDB 4.0 WiredTiger Edition) and `MONGO_42_WT` (MongoDB 4.2 WiredTiger Edition). NOTE: `MONGO_3_WT` (MongoDB 3.2 WiredTiger Edition) and `MONGO_3_ROCKS` (MongoDB 3.2 RocksDB Edition) will deprecated. +* `instance_name` - (Required, String) Name of the Mongodb instance. +* `machine_type` - (Required, String, ForceNew) Type of Mongodb instance, and available values include `HIO`(or `GIO` which will be deprecated, represents high IO) and `HIO10G`(or `TGIO` which will be deprecated, represents 10-gigabit high IO). +* `memory` - (Required, Int) Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. +* `nodes_per_shard` - (Required, Int, ForceNew) Number of nodes per shard, at least 3(one master and two slaves). +* `shard_quantity` - (Required, Int, ForceNew) Number of sharding. +* `volume` - (Required, Int) Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. +* `auto_renew_flag` - (Optional, Int) Auto renew flag. Valid values are `0`(NOTIFY_AND_MANUAL_RENEW), `1`(NOTIFY_AND_AUTO_RENEW) and `2`(DISABLE_NOTIFY_AND_MANUAL_RENEW). Default value is `0`. Note: only works for PREPAID instance. Only supports`0` and `1` for creation. +* `availability_zone_list` - (Optional, List: [`String`]) A list of nodes deployed in multiple availability zones. For more information, please use the API DescribeSpecInfo. + - Multi-availability zone deployment nodes can only be deployed in 3 different availability zones. It is not supported to deploy most nodes of the cluster in the same availability zone. For example, a 3-node cluster does not support the deployment of 2 nodes in the same zone. + - Version 4.2 and above are not supported. + - Read-only disaster recovery instances are not supported. + - Basic network cannot be selected. +* `charge_type` - (Optional, String, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. Default value is `POSTPAID_BY_HOUR`. Note: TencentCloud International only supports `POSTPAID_BY_HOUR`. Caution that update operation on this field will delete old instances and create new one with new charge type. +* `hidden_zone` - (Optional, String) The availability zone to which the Hidden node belongs. This parameter must be configured to deploy instances across availability zones. +* `mongos_cpu` - (Optional, Int) Number of mongos cpu. +* `mongos_memory` - (Optional, Int) Mongos memory size in GB. +* `mongos_node_num` - (Optional, Int) Number of mongos. +* `password` - (Optional, String) Password of this Mongodb account. +* `prepaid_period` - (Optional, Int) The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to `PREPAID`. +* `project_id` - (Optional, Int) ID of the project which the instance belongs. +* `security_groups` - (Optional, Set: [`String`], ForceNew) ID of the security group. +* `subnet_id` - (Optional, String, ForceNew) ID of the subnet within this VPC. The value is required if `vpc_id` is set. +* `tags` - (Optional, Map) The tags of the Mongodb. Key name `project` is system reserved and can't be used. +* `vpc_id` - (Optional, String, ForceNew) ID of the VPC. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of the Mongodb instance. +* `status` - Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2). +* `vip` - IP of the Mongodb instance. +* `vport` - IP port of the Mongodb instance. + + +## Import + +Mongodb sharding instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_mongodb_sharding_instance.mongodb cmgo-41s6jwy4 +``` + diff --git a/config/docs/r/mongodb_standby_instance.html.markdown b/config/docs/r/mongodb_standby_instance.html.markdown new file mode 100644 index 0000000..9dea42a --- /dev/null +++ b/config/docs/r/mongodb_standby_instance.html.markdown @@ -0,0 +1,96 @@ +--- +subcategory: "TencentDB for MongoDB(mongodb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mongodb_standby_instance" +sidebar_current: "docs-tencentcloud-resource-mongodb_standby_instance" +description: |- + Provide a resource to create a Mongodb standby instance. +--- + +# tencentcloud_mongodb_standby_instance + +Provide a resource to create a Mongodb standby instance. + +## Example Usage + +```hcl +provider "tencentcloud" { + region = "ap-guangzhou" +} + +provider "tencentcloud" { + alias = "shanghai" + region = "ap-shanghai" +} + +resource "tencentcloud_mongodb_instance" "mongodb" { + instance_name = "tf-mongodb-test" + memory = 4 + volume = 100 + engine_version = "MONGO_40_WT" + machine_type = "HIO10G" + available_zone = var.availability_zone + project_id = 0 + password = "test1234" + + tags = { + test = "test" + } +} + +resource "tencentcloud_mongodb_standby_instance" "mongodb" { + provider = tencentcloud.shanghai + instance_name = "tf-mongodb-standby-test" + memory = 4 + volume = 100 + available_zone = "ap-shanghai-2" + project_id = 0 + father_instance_id = tencentcloud_mongodb_instance.mongodb.id + father_instance_region = "ap-guangzhou" + + tags = { + test = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `available_zone` - (Required, String, ForceNew) The available zone of the Mongodb standby instance. NOTE: must not be same with father instance's. +* `father_instance_id` - (Required, String, ForceNew) Indicates the main instance ID of standby instances. +* `father_instance_region` - (Required, String, ForceNew) Indicates the region of main instance. +* `instance_name` - (Required, String) Name of the Mongodb instance. +* `memory` - (Required, Int) Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. +* `volume` - (Required, Int) Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously. +* `auto_renew_flag` - (Optional, Int) Auto renew flag. Valid values are `0`(NOTIFY_AND_MANUAL_RENEW), `1`(NOTIFY_AND_AUTO_RENEW) and `2`(DISABLE_NOTIFY_AND_MANUAL_RENEW). Default value is `0`. Note: only works for PREPAID instance. Only supports`0` and `1` for creation. +* `charge_type` - (Optional, String, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. Default value is `POSTPAID_BY_HOUR`. Note: TencentCloud International only supports `POSTPAID_BY_HOUR`. Caution that update operation on this field will delete old instances and create new one with new charge type. +* `prepaid_period` - (Optional, Int) The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to `PREPAID`. +* `project_id` - (Optional, Int) ID of the project which the instance belongs. +* `security_groups` - (Optional, Set: [`String`], ForceNew) ID of the security group. +* `subnet_id` - (Optional, String, ForceNew) ID of the subnet within this VPC. The value is required if `vpc_id` is set. +* `tags` - (Optional, Map) The tags of the Mongodb. Key name `project` is system reserved and can't be used. +* `vpc_id` - (Optional, String, ForceNew) ID of the VPC. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of the Mongodb instance. +* `engine_version` - Version of the standby Mongodb instance and must be same as the version of main instance. +* `machine_type` - Type of standby Mongodb instance and must be same as the type of main instance. +* `status` - Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2). +* `vip` - IP of the Mongodb instance. +* `vport` - IP port of the Mongodb instance. + + +## Import + +Mongodb instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_mongodb_standby_instance.mongodb cmgo-41s6jwy4 +``` + diff --git a/config/docs/r/monitor_alarm_notice.html.markdown b/config/docs/r/monitor_alarm_notice.html.markdown new file mode 100644 index 0000000..d076e9c --- /dev/null +++ b/config/docs/r/monitor_alarm_notice.html.markdown @@ -0,0 +1,132 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_notice" +sidebar_current: "docs-tencentcloud-resource-monitor_alarm_notice" +description: |- + Provides a alarm notice resource for monitor. +--- + +# tencentcloud_monitor_alarm_notice + +Provides a alarm notice resource for monitor. + +## Example Usage + +```hcl +resource "tencentcloud_monitor_alarm_notice" "example" { + name = "test_alarm_notice" + notice_language = "zh-CN" + notice_type = "ALL" + + url_notices { + end_time = 86399 + is_valid = 0 + start_time = 0 + url = "https://www.mytest.com/validate" + weekday = [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + ] + } + + user_notices { + end_time = 86399 + group_ids = [] + need_phone_arrive_notice = 1 + notice_way = [ + "EMAIL", + "SMS", + ] + phone_call_type = "CIRCLE" + phone_circle_interval = 180 + phone_circle_times = 2 + phone_inner_interval = 180 + phone_order = [] + receiver_type = "USER" + start_time = 0 + user_ids = [ + 11082189, + 11082190, + ] + weekday = [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + ] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Notification template name within 60. +* `notice_language` - (Required, String) Notification language zh-CN=Chinese en-US=English. +* `notice_type` - (Required, String) Alarm notification type ALARM=Notification not restored OK=Notification restored ALL. +* `cls_notices` - (Optional, List) A maximum of one alarm notification can be pushed to the CLS service. +* `url_notices` - (Optional, List) The maximum number of callback notifications is 3. +* `user_notices` - (Optional, List) Alarm notification template list.(At most five). + +The `cls_notices` object supports the following: + +* `log_set_id` - (Required, String) Log collection Id. +* `region` - (Required, String) Regional. +* `topic_id` - (Required, String) Theme Id. +* `enable` - (Optional, Int) Start-stop status, can not be transmitted, default enabled. 0= Disabled, 1= enabled. + +The `url_notices` object supports the following: + +* `url` - (Required, String) Callback URL (limited to 256 characters). +* `end_time` - (Optional, Int) Notification End Time Seconds at the start of a day. +* `is_valid` - (Optional, Int) If passed verification `0` is no, `1` is yes. Default `0`. +* `start_time` - (Optional, Int) Notification Start Time Number of seconds at the start of a day. +* `validation_code` - (Optional, String) Verification code. +* `weekday` - (Optional, Set) Notification period 1-7 indicates Monday to Sunday. + +The `user_notices` object supports the following: + +* `end_time` - (Required, Int) The number of seconds since the notification end time 00:00:00 (value range 0-86399). +* `notice_way` - (Required, Set) Notification Channel List EMAIL=Mail SMS=SMS CALL=Telephone WECHAT=WeChat RTX=Enterprise WeChat. +* `receiver_type` - (Required, String) Recipient Type USER=User GROUP=User Group. +* `start_time` - (Required, Int) The number of seconds since the notification start time 00:00:00 (value range 0-86399). +* `group_ids` - (Optional, Set) User group ID list. +* `need_phone_arrive_notice` - (Optional, Int) Contact notification required 0= No 1= Yes. +* `phone_call_type` - (Optional, String) Call type SYNC= Simultaneous call CIRCLE= Round call If this parameter is not specified, the default value is round call. +* `phone_circle_interval` - (Optional, Int) Number of seconds between polls (value range: 60-900). +* `phone_circle_times` - (Optional, Int) Number of telephone polls (value range: 1-5). +* `phone_inner_interval` - (Optional, Int) Number of seconds between calls in a polling session (value range: 60-900). +* `phone_order` - (Optional, Set) Telephone polling list. +* `user_ids` - (Optional, Set) User UID List. +* `weekday` - (Optional, Set) Notification period 1-7 indicates Monday to Sunday. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `amp_consumer_id` - Amp consumer ID. +* `is_preset` - Whether it is the system default notification template 0=No 1=Yes. +* `policy_ids` - List of alarm policy IDs bound to the alarm notification template. +* `updated_at` - Last modified time. +* `updated_by` - Last Modified By. + + +## Import + +Monitor Alarm Notice can be imported, e.g. + +``` +$ terraform import tencentcloud_monitor_alarm_notice.import-test noticeId +``` + diff --git a/config/docs/r/monitor_alarm_policy.html.markdown b/config/docs/r/monitor_alarm_policy.html.markdown new file mode 100644 index 0000000..1577e49 --- /dev/null +++ b/config/docs/r/monitor_alarm_policy.html.markdown @@ -0,0 +1,337 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_policy" +sidebar_current: "docs-tencentcloud-resource-monitor_alarm_policy" +description: |- + Provides a alarm policy resource for monitor. +--- + +# tencentcloud_monitor_alarm_policy + +Provides a alarm policy resource for monitor. + +## Example Usage + +### cvm_device alarm policy + +```hcl +resource "tencentcloud_monitor_alarm_notice" "foo" { + name = "tf-alarm_notice" + notice_type = "ALL" + notice_language = "zh-CN" + + user_notices { + receiver_type = "USER" + start_time = 0 + end_time = 1 + notice_way = ["SMS", "EMAIL"] + user_ids = [10001] + group_ids = [] + phone_order = [10001] + phone_circle_times = 2 + phone_circle_interval = 50 + phone_inner_interval = 60 + need_phone_arrive_notice = 1 + phone_call_type = "CIRCLE" + weekday = [1, 2, 3, 4, 5, 6, 7] + } + + url_notices { + url = "https://www.mytest.com/validate" + end_time = 0 + start_time = 1 + weekday = [1, 2, 3, 4, 5, 6, 7] + } + +} + +resource "tencentcloud_monitor_alarm_policy" "foo" { + policy_name = "tf-policy" + monitor_type = "MT_QCE" + enable = 1 + project_id = 0 + namespace = "cvm_device" + conditions { + is_union_rule = 1 + rules { + metric_name = "CpuUsage" + period = 60 + operator = "ge" + value = "89.9" + continue_period = 1 + notice_frequency = 3600 + is_power_notice = 0 + } + } + event_conditions { + metric_name = "ping_unreachable" + } + event_conditions { + metric_name = "guest_reboot" + } + notice_ids = [tencentcloud_monitor_alarm_notice.foo.id] + + trigger_tasks { + type = "AS" + task_config = "{\"Region\":\"ap-guangzhou\",\"Group\":\"asg-0z312312x\",\"Policy\":\"asp-ganig28\"}" + } +} +``` + +### k8s_cluster alarm policy + +```hcl +resource "tencentcloud_monitor_alarm_policy" "policy" { + enable = 1 + monitor_type = "MT_QCE" + namespace = "k8s_cluster" + notice_ids = [ + "notice-l9ziyxw6", + ] + policy_name = "TkeClusterNew" + project_id = 1244035 + + conditions { + is_union_rule = 0 + + rules { + continue_period = 3 + description = "Allocatable Pods" + is_power_notice = 0 + metric_name = "K8sClusterAllocatablePodsTotal" + notice_frequency = 3600 + operator = "gt" + period = 60 + rule_type = "STATIC" + unit = "Count" + value = "10" + + filter { + dimensions = jsonencode( + [ + [ + { + Key = "region" + Operator = "eq" + Value = [ + "ap-guangzhou", + ] + }, + { + Key = "tke_cluster_instance_id" + Operator = "in" + Value = [ + "cls-czhtobea", + ] + }, + ], + ] + ) + type = "DIMENSION" + } + } + rules { + continue_period = 3 + description = "Total CPU Cores" + is_power_notice = 0 + metric_name = "K8sClusterCpuCoreTotal" + notice_frequency = 3600 + operator = "gt" + period = 60 + rule_type = "STATIC" + unit = "Core" + value = "2" + + filter { + dimensions = jsonencode( + [ + [ + { + Key = "region" + Operator = "eq" + Value = [ + "ap-guangzhou", + ] + }, + { + Key = "tke_cluster_instance_id" + Operator = "in" + Value = [ + "cls-czhtobea", + ] + }, + ], + ] + ) + type = "DIMENSION" + } + } + } +} +``` + +### cvm_device alarm policy binding cvm by tag + +```hcl +resource "tencentcloud_monitor_alarm_policy" "policy" { + enable = 1 + monitor_type = "MT_QCE" + namespace = "cvm_device" + notice_ids = [ + "notice-l9ziyxw6", + ] + policy_name = "policy" + project_id = 0 + + conditions { + is_union_rule = 0 + + rules { + continue_period = 5 + description = "CPUUtilization" + is_power_notice = 0 + metric_name = "CpuUsage" + notice_frequency = 7200 + operator = "gt" + period = 60 + rule_type = "STATIC" + unit = "%" + value = "95" + } + rules { + continue_period = 5 + description = "PublicBandwidthUtilization" + is_power_notice = 0 + metric_name = "Outratio" + notice_frequency = 7200 + operator = "gt" + period = 60 + rule_type = "STATIC" + unit = "%" + value = "95" + } + rules { + continue_period = 5 + description = "MemoryUtilization" + is_power_notice = 0 + metric_name = "MemUsage" + notice_frequency = 7200 + operator = "gt" + period = 60 + rule_type = "STATIC" + unit = "%" + value = "95" + } + rules { + continue_period = 5 + description = "DiskUtilization" + is_power_notice = 0 + metric_name = "CvmDiskUsage" + notice_frequency = 7200 + operator = "gt" + period = 60 + rule_type = "STATIC" + unit = "%" + value = "95" + } + } + + event_conditions { + continue_period = 0 + description = "DiskReadonly" + is_power_notice = 0 + metric_name = "disk_readonly" + notice_frequency = 0 + period = 0 + } + + policy_tag { + key = "test-tag" + value = "unit-test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `monitor_type` - (Required, String, ForceNew) The type of monitor. +* `namespace` - (Required, String, ForceNew) The type of alarm. +* `policy_name` - (Required, String) The name of policy. +* `conditions` - (Optional, List) A list of metric trigger condition. +* `conditon_template_id` - (Optional, Int, ForceNew) ID of trigger condition template. +* `enable` - (Optional, Int) Whether to enable, default is `1`. +* `event_conditions` - (Optional, List) A list of event trigger condition. +* `notice_ids` - (Optional, List: [`String`]) List of notification rule IDs. +* `policy_tag` - (Optional, List, ForceNew) Policy tag to bind object. +* `project_id` - (Optional, Int, ForceNew) Project ID. For products with different projects, a value other than -1 must be passed in. +* `remark` - (Optional, String) The remark of policy group. +* `trigger_tasks` - (Optional, List) Triggered task list. + +The `conditions` object supports the following: + +* `is_union_rule` - (Optional, Int) The and or relation of indicator alarm rule. +* `rules` - (Optional, List) A list of metric trigger condition. + +The `event_conditions` object supports the following: + +* `continue_period` - (Optional, Int) Number of periods. +* `description` - (Optional, String) Metric display name, which is used in the output parameter. +* `filter` - (Optional, List) Filter condition for one single trigger rule. Must set it when create tke-xxx rules. +* `is_power_notice` - (Optional, Int) Whether the alarm frequency increases exponentially. +* `metric_name` - (Optional, String) Metric name or event name. +* `notice_frequency` - (Optional, Int) Alarm interval in seconds. +* `operator` - (Optional, String) Operator. +* `period` - (Optional, Int) Statistical period in seconds. +* `rule_type` - (Optional, String) Trigger condition type. +* `unit` - (Optional, String) Unit, which is used in the output parameter. +* `value` - (Optional, String) Threshold. + +The `filter` object supports the following: + +* `dimensions` - (Optional, String) JSON string generated by serializing the AlarmPolicyDimension two-dimensional array. +* `type` - (Optional, String) Filter condition type. Valid values: DIMENSION (uses dimensions for filtering). + +The `policy_tag` object supports the following: + +* `key` - (Required, String) Tag key. +* `value` - (Required, String) Tag value. + +The `rules` object supports the following: + +* `continue_period` - (Optional, Int) Number of periods. +* `description` - (Optional, String) Metric display name, which is used in the output parameter. +* `filter` - (Optional, List) Filter condition for one single trigger rule. Must set it when create tke-xxx rules. +* `is_power_notice` - (Optional, Int) Whether the alarm frequency increases exponentially. +* `metric_name` - (Optional, String) Metric name or event name. +* `notice_frequency` - (Optional, Int) Alarm interval in seconds. +* `operator` - (Optional, String) Operator. +* `period` - (Optional, Int) Statistical period in seconds. +* `rule_type` - (Optional, String) Trigger condition type. +* `unit` - (Optional, String) Unit, which is used in the output parameter. +* `value` - (Optional, String) Threshold. + +The `trigger_tasks` object supports the following: + +* `task_config` - (Required, String) Configuration information in JSON format. +* `type` - (Required, String) Triggered task type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - The alarm policy create time. +* `update_time` - The alarm policy update time. + + +## Import + +Alarm policy instance can be imported, e.g. + +``` +$ terraform import tencentcloud_monitor_alarm_policy.policy policy-id +``` + diff --git a/config/docs/r/monitor_alarm_policy_set_default.html.markdown b/config/docs/r/monitor_alarm_policy_set_default.html.markdown new file mode 100644 index 0000000..ab8370b --- /dev/null +++ b/config/docs/r/monitor_alarm_policy_set_default.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_alarm_policy_set_default" +sidebar_current: "docs-tencentcloud-resource-monitor_alarm_policy_set_default" +description: |- + Provides a resource to create a monitor policy_set_default +--- + +# tencentcloud_monitor_alarm_policy_set_default + +Provides a resource to create a monitor policy_set_default + +## Example Usage + +```hcl +resource "tencentcloud_monitor_alarm_policy_set_default" "policy_set_default" { + module = "monitor" + policy_id = "policy-u4iykjkt" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `module` - (Required, String, ForceNew) Fixed value, as `monitor`. +* `policy_id` - (Required, String, ForceNew) Policy id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/monitor_binding_object.html.markdown b/config/docs/r/monitor_binding_object.html.markdown new file mode 100644 index 0000000..4b6ead6 --- /dev/null +++ b/config/docs/r/monitor_binding_object.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_binding_object" +sidebar_current: "docs-tencentcloud-resource-monitor_binding_object" +description: |- + Provides a resource for bind objects to a policy group resource. +--- + +# tencentcloud_monitor_binding_object + +Provides a resource for bind objects to a policy group resource. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_monitor_policy_binding_object. + +## Example Usage + +```hcl +data "tencentcloud_instances" "instances" { +} +resource "tencentcloud_monitor_policy_group" "group" { + group_name = "terraform_test" + policy_view_name = "cvm_device" + remark = "this is a test policy group" + is_union_rule = 1 + conditions { + metric_id = 33 + alarm_notify_type = 1 + alarm_notify_period = 600 + calc_type = 1 + calc_value = 3 + calc_period = 300 + continue_period = 2 + } +} + +#for cvm +resource "tencentcloud_monitor_binding_object" "binding" { + group_id = tencentcloud_monitor_policy_group.group.id + dimensions { + dimensions_json = "{\"unInstanceId\":\"${data.tencentcloud_instances.instances.instance_list[0].instance_id}\"}" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dimensions` - (Required, Set, ForceNew) A list objects. Each element contains the following attributes: +* `group_id` - (Required, Int, ForceNew) Policy group ID for binding objects. + +The `dimensions` object supports the following: + +* `dimensions_json` - (Required, String, ForceNew) Represents a collection of dimensions of an object instance, json format.eg:'{"unInstanceId":"ins-ot3cq4bi"}'. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/monitor_binding_receiver.html.markdown b/config/docs/r/monitor_binding_receiver.html.markdown new file mode 100644 index 0000000..b83dad6 --- /dev/null +++ b/config/docs/r/monitor_binding_receiver.html.markdown @@ -0,0 +1,73 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_binding_receiver" +sidebar_current: "docs-tencentcloud-resource-monitor_binding_receiver" +description: |- + Provides a resource for bind receivers to a policy group resource. +--- + +# tencentcloud_monitor_binding_receiver + +Provides a resource for bind receivers to a policy group resource. + +## Example Usage + +```hcl +data "tencentcloud_cam_groups" "groups" { + //You should first create a user group with CAM +} + +resource "tencentcloud_monitor_policy_group" "group" { + group_name = "nice_group" + policy_view_name = "cvm_device" + remark = "this is a test policy group" + conditions { + metric_id = 33 + alarm_notify_type = 1 + alarm_notify_period = 600 + calc_type = 1 + calc_value = 3 + calc_period = 300 + continue_period = 2 + } +} + +resource "tencentcloud_monitor_binding_receiver" "receiver" { + group_id = tencentcloud_monitor_policy_group.group.id + receivers { + start_time = 0 + end_time = 86399 + notify_way = ["SMS"] + receiver_type = "group" + receiver_group_list = [data.tencentcloud_cam_groups.groups.group_list[0].group_id] + receive_language = "en-US" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, Int, ForceNew) Policy group ID for binding receivers. +* `receivers` - (Optional, List) A list of receivers(will overwrite the configuration of the server or other resources). Each element contains the following attributes: + +The `receivers` object supports the following: + +* `notify_way` - (Required, List) Method of warning notification.Optional `CALL`,`EMAIL`,`SITE`,`SMS`,`WECHAT`. +* `receiver_type` - (Required, String) Receive type. Optional `group`,`user`. +* `end_time` - (Optional, Int) End of alarm period. Meaning with `start_time`. +* `receive_language` - (Optional, String) Alert sending language. Optional `en-US`,`zh-CN`. +* `receiver_group_list` - (Optional, List) Alarm receive group ID list. +* `receiver_user_list` - (Optional, List) Alarm receiver ID list. +* `start_time` - (Optional, Int) Alarm period start time. Valid value ranges: (0~86399). which removes the date after it is converted to Beijing time as a Unix timestamp, for example 7200 means '10:0:0'. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/monitor_grafana_dns_config.html.markdown b/config/docs/r/monitor_grafana_dns_config.html.markdown new file mode 100644 index 0000000..a44b5a8 --- /dev/null +++ b/config/docs/r/monitor_grafana_dns_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_dns_config" +sidebar_current: "docs-tencentcloud-resource-monitor_grafana_dns_config" +description: |- + Provides a resource to create a monitor grafana_dns_config +--- + +# tencentcloud_monitor_grafana_dns_config + +Provides a resource to create a monitor grafana_dns_config + +## Example Usage + +```hcl +resource "tencentcloud_monitor_grafana_dns_config" "grafana_dns_config" { + instance_id = "grafana-dp2hnnfa" + name_servers = ["10.1.2.1", "10.1.2.2", "10.1.2.3"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Grafana instance ID. +* `name_servers` - (Optional, Set: [`String`]) DNS nameserver list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +monitor grafana_dns_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_monitor_grafana_dns_config.grafana_dns_config instance_id +``` + diff --git a/config/docs/r/monitor_grafana_env_config.html.markdown b/config/docs/r/monitor_grafana_env_config.html.markdown new file mode 100644 index 0000000..fa196a6 --- /dev/null +++ b/config/docs/r/monitor_grafana_env_config.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_env_config" +sidebar_current: "docs-tencentcloud-resource-monitor_grafana_env_config" +description: |- + Provides a resource to create a monitor grafana_env_config +--- + +# tencentcloud_monitor_grafana_env_config + +Provides a resource to create a monitor grafana_env_config + +## Example Usage + +```hcl +resource "tencentcloud_monitor_grafana_env_config" "grafana_env_config" { + instance_id = "grafana-dp2hnnfa" + envs = { + "aaa" = "ccc" + "bbb" = "ccc" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Grafana instance ID. +* `envs` - (Optional, Map) Environment variables. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +monitor grafana_env_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_monitor_grafana_env_config.grafana_env_config instance_id +``` + diff --git a/config/docs/r/monitor_grafana_instance.html.markdown b/config/docs/r/monitor_grafana_instance.html.markdown new file mode 100644 index 0000000..1e9e689 --- /dev/null +++ b/config/docs/r/monitor_grafana_instance.html.markdown @@ -0,0 +1,78 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_instance" +sidebar_current: "docs-tencentcloud-resource-monitor_grafana_instance" +description: |- + Provides a resource to create a monitor grafanaInstance +--- + +# tencentcloud_monitor_grafana_instance + +Provides a resource to create a monitor grafanaInstance + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-6" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_monitor_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_monitor_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_monitor_grafana_instance" "foo" { + instance_name = "test-grafana" + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] + grafana_init_password = "1234567890" + enable_internet = false + is_destroy = true + + tags = { + "createdBy" = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_name` - (Required, String) Instance name. +* `enable_internet` - (Optional, Bool) Control whether grafana could be accessed by internet. +* `grafana_init_password` - (Optional, String) Grafana server admin password. +* `is_destroy` - (Optional, Bool) Whether to clean up completely, the default is false. +* `is_distroy` - (Optional, Bool, **Deprecated**) It has been deprecated from version 1.81.16. Whether to clean up completely, the default is false. +* `subnet_ids` - (Optional, Set: [`String`]) Subnet Id array. +* `tags` - (Optional, Map) Tag description list. +* `vpc_id` - (Optional, String) Vpc Id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `instance_id` - Grafana instance id. +* `instance_status` - Grafana instance status, 1: Creating, 2: Running, 6: Stopped. +* `internal_url` - Grafana public address. +* `internet_url` - Grafana intranet address. +* `root_url` - Grafana external url which could be accessed by user. + + +## Import + +monitor grafanaInstance can be imported using the id, e.g. +``` +$ terraform import tencentcloud_monitor_grafana_instance.foo grafanaInstance_id +``` + diff --git a/config/docs/r/monitor_grafana_integration.html.markdown b/config/docs/r/monitor_grafana_integration.html.markdown new file mode 100644 index 0000000..d5dbd8a --- /dev/null +++ b/config/docs/r/monitor_grafana_integration.html.markdown @@ -0,0 +1,70 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_integration" +sidebar_current: "docs-tencentcloud-resource-monitor_grafana_integration" +description: |- + Provides a resource to create a monitor grafanaIntegration +--- + +# tencentcloud_monitor_grafana_integration + +Provides a resource to create a monitor grafanaIntegration + +## Example Usage + +### Create a grafan instance and integrate the configuration + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-6" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_monitor_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_monitor_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_monitor_grafana_instance" "foo" { + instance_name = "test-grafana" + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] + grafana_init_password = "1234567890" + enable_internet = false + + tags = { + "createdBy" = "test" + } +} + +resource "tencentcloud_monitor_grafana_integration" "grafanaIntegration" { + instance_id = tencentcloud_monitor_grafana_instance.foo.id + kind = "tencentcloud-monitor-app" + content = "{\"kind\":\"tencentcloud-monitor-app\",\"spec\":{\"dataSourceSpec\":{\"authProvider\":{\"__anyOf\":\"使用密钥\",\"useRole\":true,\"secretId\":\"arunma@tencent.com\",\"secretKey\":\"12345678\"},\"name\":\"uint-test\"},\"grafanaSpec\":{\"organizationIds\":[]}}}" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) grafana instance id. +* `content` - (Optional, String) generated json string of given integration json schema. +* `description` - (Optional, String) integration desc. +* `kind` - (Optional, String) integration json schema kind. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `integration_id` - integration id. + + diff --git a/config/docs/r/monitor_grafana_notification_channel.html.markdown b/config/docs/r/monitor_grafana_notification_channel.html.markdown new file mode 100644 index 0000000..33b4d9a --- /dev/null +++ b/config/docs/r/monitor_grafana_notification_channel.html.markdown @@ -0,0 +1,100 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_notification_channel" +sidebar_current: "docs-tencentcloud-resource-monitor_grafana_notification_channel" +description: |- + Provides a resource to create a monitor grafanaNotificationChannel +--- + +# tencentcloud_monitor_grafana_notification_channel + +Provides a resource to create a monitor grafanaNotificationChannel + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-6" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_monitor_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_monitor_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_monitor_grafana_instance" "foo" { + instance_name = "test-grafana" + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] + grafana_init_password = "1234567890" + enable_internet = false + + tags = { + "createdBy" = "test" + } +} + +resource "tencentcloud_monitor_alarm_notice" "foo" { + name = "tf_alarm_notice" + notice_type = "ALL" + notice_language = "zh-CN" + + user_notices { + receiver_type = "USER" + start_time = 0 + end_time = 1 + notice_way = ["SMS", "EMAIL"] + user_ids = [10001] + group_ids = [] + phone_order = [10001] + phone_circle_times = 2 + phone_circle_interval = 50 + phone_inner_interval = 60 + need_phone_arrive_notice = 1 + phone_call_type = "CIRCLE" + weekday = [1, 2, 3, 4, 5, 6, 7] + } + + url_notices { + url = "https://www.mytest.com/validate" + end_time = 0 + start_time = 1 + weekday = [1, 2, 3, 4, 5, 6, 7] + } +} + +resource "tencentcloud_monitor_grafana_notification_channel" "grafanaNotificationChannel" { + instance_id = tencentcloud_monitor_grafana_instance.foo.id + channel_name = "tf-channel" + org_id = 1 + receivers = [tencentcloud_monitor_alarm_notice.foo.amp_consumer_id] + extra_org_ids = ["1"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) grafana instance id. +* `channel_name` - (Optional, String) channel name. +* `extra_org_ids` - (Optional, Set: [`String`]) extra grafana organization id list, default to 1 representing Main Org. +* `org_id` - (Optional, Int) Grafana organization which channel will be installed, default to 1 representing Main Org. +* `receivers` - (Optional, Set: [`String`]) cloud monitor notification template notice-id list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `channel_id` - plugin id. + + diff --git a/config/docs/r/monitor_grafana_plugin.html.markdown b/config/docs/r/monitor_grafana_plugin.html.markdown new file mode 100644 index 0000000..a192b6c --- /dev/null +++ b/config/docs/r/monitor_grafana_plugin.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_plugin" +sidebar_current: "docs-tencentcloud-resource-monitor_grafana_plugin" +description: |- + Provides a resource to create a monitor grafanaPlugin +--- + +# tencentcloud_monitor_grafana_plugin + +Provides a resource to create a monitor grafanaPlugin + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-6" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_monitor_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_monitor_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_monitor_grafana_instance" "foo" { + instance_name = "test-grafana" + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] + grafana_init_password = "1234567890" + enable_internet = false + + tags = { + "createdBy" = "test" + } +} + +resource "tencentcloud_monitor_grafana_plugin" "grafanaPlugin" { + instance_id = tencentcloud_monitor_grafana_instance.foo.id + plugin_id = "grafana-piechart-panel" + version = "1.6.2" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Grafana instance id. +* `plugin_id` - (Required, String) Plugin id. +* `version` - (Optional, String) Plugin version. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +monitor grafanaPlugin can be imported using the instance_id#plugin_id, e.g. +``` +$ terraform import tencentcloud_monitor_grafana_plugin.grafanaPlugin grafana-50nj6v00#grafana-piechart-panel +``` + diff --git a/config/docs/r/monitor_grafana_sso_account.html.markdown b/config/docs/r/monitor_grafana_sso_account.html.markdown new file mode 100644 index 0000000..52fcdf9 --- /dev/null +++ b/config/docs/r/monitor_grafana_sso_account.html.markdown @@ -0,0 +1,84 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_sso_account" +sidebar_current: "docs-tencentcloud-resource-monitor_grafana_sso_account" +description: |- + Provides a resource to create a monitor grafana ssoAccount +--- + +# tencentcloud_monitor_grafana_sso_account + +Provides a resource to create a monitor grafana ssoAccount + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-6" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_monitor_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_monitor_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_monitor_grafana_instance" "foo" { + instance_name = "test-grafana" + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] + grafana_init_password = "1234567890" + enable_internet = false + + tags = { + "createdBy" = "test" + } +} + +resource "tencentcloud_monitor_grafana_sso_account" "ssoAccount" { + instance_id = tencentcloud_monitor_grafana_instance.foo.id + user_id = "111" + notes = "desc12222" + role { + organization = "Main Org." + role = "Admin" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) grafana instance id. +* `user_id` - (Required, String) sub account uin of specific user. +* `notes` - (Optional, String) account related description. +* `role` - (Optional, List) grafana role. + +The `role` object supports the following: + +* `organization` - (Required, String) Grafana organization id string. +* `role` - (Required, String) Grafana role, one of {Admin,Editor,Viewer}. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +monitor grafana ssoAccount can be imported using the instance_id#user_id, e.g. +``` +$ terraform import tencentcloud_monitor_grafana_sso_account.ssoAccount grafana-50nj6v00#111 +``` + diff --git a/config/docs/r/monitor_grafana_sso_cam_config.html.markdown b/config/docs/r/monitor_grafana_sso_cam_config.html.markdown new file mode 100644 index 0000000..ab42df8 --- /dev/null +++ b/config/docs/r/monitor_grafana_sso_cam_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_sso_cam_config" +sidebar_current: "docs-tencentcloud-resource-monitor_grafana_sso_cam_config" +description: |- + Provides a resource to create a monitor grafana_sso_cam_config +--- + +# tencentcloud_monitor_grafana_sso_cam_config + +Provides a resource to create a monitor grafana_sso_cam_config + +## Example Usage + +```hcl +resource "tencentcloud_monitor_grafana_sso_cam_config" "grafana_sso_cam_config" { + instance_id = "grafana-dp2hnnfa" + enable_sso_cam_check = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `enable_sso_cam_check` - (Required, Bool) Whether to enable the CAM authorization: `true` for enabling; `false` for disabling. +* `instance_id` - (Required, String, ForceNew) Grafana instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +monitor grafana_sso_cam_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_monitor_grafana_sso_cam_config.grafana_sso_cam_config instance_id +``` + diff --git a/config/docs/r/monitor_grafana_sso_config.html.markdown b/config/docs/r/monitor_grafana_sso_config.html.markdown new file mode 100644 index 0000000..270934d --- /dev/null +++ b/config/docs/r/monitor_grafana_sso_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_sso_config" +sidebar_current: "docs-tencentcloud-resource-monitor_grafana_sso_config" +description: |- + Provides a resource to create a monitor grafana_sso_config +--- + +# tencentcloud_monitor_grafana_sso_config + +Provides a resource to create a monitor grafana_sso_config + +## Example Usage + +```hcl +resource "tencentcloud_monitor_grafana_sso_config" "grafana_sso_config" { + instance_id = "grafana-dp2hnnfa" + enable_sso = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `enable_sso` - (Required, Bool) Whether to enable SSO: `true` for enabling; `false` for disabling. +* `instance_id` - (Required, String, ForceNew) Grafana instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +monitor grafana_sso_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_monitor_grafana_sso_config.grafana_sso_config instance_id +``` + diff --git a/config/docs/r/monitor_grafana_version_upgrade.html.markdown b/config/docs/r/monitor_grafana_version_upgrade.html.markdown new file mode 100644 index 0000000..13d4eb9 --- /dev/null +++ b/config/docs/r/monitor_grafana_version_upgrade.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_version_upgrade" +sidebar_current: "docs-tencentcloud-resource-monitor_grafana_version_upgrade" +description: |- + Provides a resource to create a monitor grafana_version_upgrade +--- + +# tencentcloud_monitor_grafana_version_upgrade + +Provides a resource to create a monitor grafana_version_upgrade + +## Example Usage + +```hcl +resource "tencentcloud_monitor_grafana_version_upgrade" "grafana_version_upgrade" { + instance_id = "grafana-dp2hnnfa" + alias = "v8.2.7" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `alias` - (Required, String) Version alias. +* `instance_id` - (Required, String, ForceNew) Grafana instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +monitor grafana_version_upgrade can be imported using the id, e.g. + +``` +terraform import tencentcloud_monitor_grafana_version_upgrade.grafana_version_upgrade instance_id +``` + diff --git a/config/docs/r/monitor_grafana_whitelist_config.html.markdown b/config/docs/r/monitor_grafana_whitelist_config.html.markdown new file mode 100644 index 0000000..2f744a8 --- /dev/null +++ b/config/docs/r/monitor_grafana_whitelist_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_grafana_whitelist_config" +sidebar_current: "docs-tencentcloud-resource-monitor_grafana_whitelist_config" +description: |- + Provides a resource to create a monitor grafana_whitelist_config +--- + +# tencentcloud_monitor_grafana_whitelist_config + +Provides a resource to create a monitor grafana_whitelist_config + +## Example Usage + +```hcl +resource "tencentcloud_monitor_grafana_whitelist_config" "grafana_whitelist_config" { + instance_id = "grafana-dp2hnnfa" + whitelist = ["10.1.1.1", "10.1.1.2", "10.1.1.3"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Grafana instance ID. +* `whitelist` - (Optional, Set: [`String`]) The addresses in the whitelist. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +monitor grafana_whitelist_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_monitor_grafana_whitelist_config.grafana_whitelist_config instance_id +``` + diff --git a/config/docs/r/monitor_policy_binding_object.html.markdown b/config/docs/r/monitor_policy_binding_object.html.markdown new file mode 100644 index 0000000..311ce92 --- /dev/null +++ b/config/docs/r/monitor_policy_binding_object.html.markdown @@ -0,0 +1,92 @@ +--- +subcategory: "Cloud Monitor(Monitor)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_policy_binding_object" +sidebar_current: "docs-tencentcloud-resource-monitor_policy_binding_object" +description: |- + Provides a resource for bind objects to a alarm policy resource. +--- + +# tencentcloud_monitor_policy_binding_object + +Provides a resource for bind objects to a alarm policy resource. + +## Example Usage + +```hcl +data "tencentcloud_instances" "instances" { +} +resource "tencentcloud_monitor_alarm_policy" "policy" { + policy_name = "hello" + monitor_type = "MT_QCE" + enable = 1 + project_id = 1244035 + namespace = "cvm_device" + + conditions { + is_union_rule = 1 + rules { + metric_name = "CpuUsage" + period = 60 + operator = "ge" + value = "89.9" + continue_period = 1 + notice_frequency = 3600 + is_power_notice = 0 + } + } + + event_conditions { + metric_name = "ping_unreachable" + } + + event_conditions { + metric_name = "guest_reboot" + } + + notice_ids = ["notice-l9ziyxw6"] + + trigger_tasks { + type = "AS" + task_config = "{\"Region\":\"ap-guangzhou\",\"Group\":\"asg-0z312312x\",\"Policy\":\"asp-ganig28\"}" + } + +} + +#for cvm +resource "tencentcloud_monitor_policy_binding_object" "binding" { + policy_id = tencentcloud_monitor_alarm_policy.policy.id + + dimensions { + dimensions_json = "{\"unInstanceId\":\"${data.tencentcloud_instances.instances.instance_list[0].instance_id}\"}" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dimensions` - (Required, Set, ForceNew) A list objects. Each element contains the following attributes: +* `policy_id` - (Required, String, ForceNew) Alarm policy ID for binding objects. + +The `dimensions` object supports the following: + +* `dimensions_json` - (Required, String, ForceNew) Represents a collection of dimensions of an object instance, json format.eg:'{"unInstanceId":"ins-ot3cq4bi"}'. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Monitor Policy Binding Object can be imported, e.g. + +``` +$ terraform import tencentcloud_monitor_policy_binding_object.binding policyId +``` + diff --git a/config/docs/r/monitor_tmp_alert_rule.html.markdown b/config/docs/r/monitor_tmp_alert_rule.html.markdown new file mode 100644 index 0000000..206bcab --- /dev/null +++ b/config/docs/r/monitor_tmp_alert_rule.html.markdown @@ -0,0 +1,112 @@ +--- +subcategory: "Managed Service for Prometheus(TMP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_tmp_alert_rule" +sidebar_current: "docs-tencentcloud-resource-monitor_tmp_alert_rule" +description: |- + Provides a resource to create a monitor tmpAlertRule +--- + +# tencentcloud_monitor_tmp_alert_rule + +Provides a resource to create a monitor tmpAlertRule + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_monitor_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_monitor_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_monitor_tmp_instance" "foo" { + instance_name = "tf-tmp-instance" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + data_retention_time = 30 + zone = var.availability_zone + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_monitor_tmp_cvm_agent" "foo" { + instance_id = tencentcloud_monitor_tmp_instance.foo.id + name = "tf-agent" +} + +resource "tencentcloud_monitor_tmp_alert_rule" "foo" { + duration = "2m" + expr = "avg by (instance) (mysql_global_status_threads_connected) / avg by (instance) (mysql_global_variables_max_connections) > 0.8" + instance_id = tencentcloud_monitor_tmp_instance.foo.id + receivers = ["notice-f2svbu3w"] + rule_name = "MySQL 连接数过多" + rule_state = 2 + type = "MySQL/MySQL 连接数过多" + + annotations { + key = "description" + value = "MySQL 连接数过多, 实例: {{$labels.instance}}，当前值: {{ $value | humanizePercentage }}。" + } + annotations { + key = "summary" + value = "MySQL 连接数过多(>80%)" + } + + labels { + key = "severity" + value = "warning" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `expr` - (Required, String) Rule expression, reference documentation: `https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/`. +* `instance_id` - (Required, String) Instance id. +* `receivers` - (Required, Set: [`String`]) Alarm notification template id list. +* `rule_name` - (Required, String) Rule name. +* `annotations` - (Optional, List) Rule alarm duration. +* `duration` - (Optional, String) Rule alarm duration. +* `labels` - (Optional, List) Rule alarm duration. +* `rule_state` - (Optional, Int) Rule state code. +* `type` - (Optional, String) Alarm Policy Template Classification. + +The `annotations` object supports the following: + +* `key` - (Required, String) key. +* `value` - (Required, String) value. + +The `labels` object supports the following: + +* `key` - (Required, String) key. +* `value` - (Required, String) value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +monitor tmpAlertRule can be imported using the id, e.g. +``` +$ terraform import tencentcloud_monitor_tmp_alert_rule.tmpAlertRule instanceId#Rule_id +``` + diff --git a/config/docs/r/monitor_tmp_cvm_agent.html.markdown b/config/docs/r/monitor_tmp_cvm_agent.html.markdown new file mode 100644 index 0000000..0450010 --- /dev/null +++ b/config/docs/r/monitor_tmp_cvm_agent.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Managed Service for Prometheus(TMP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_tmp_cvm_agent" +sidebar_current: "docs-tencentcloud-resource-monitor_tmp_cvm_agent" +description: |- + Provides a resource to create a monitor tmpCvmAgent +--- + +# tencentcloud_monitor_tmp_cvm_agent + +Provides a resource to create a monitor tmpCvmAgent + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_monitor_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_monitor_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_monitor_tmp_instance" "foo" { + instance_name = "tf-tmp-instance" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + data_retention_time = 30 + zone = var.availability_zone + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_monitor_tmp_cvm_agent" "foo" { + instance_id = tencentcloud_monitor_tmp_instance.foo.id + name = "tf-agent" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance id. +* `name` - (Required, String, ForceNew) Agent name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `agent_id` - Agent id. + + +## Import + +monitor tmpCvmAgent can be imported using the id, e.g. +``` +$ terraform import tencentcloud_monitor_tmp_cvm_agent.tmpCvmAgent instance_id#agent_id +``` + diff --git a/config/docs/r/monitor_tmp_exporter_integration.html.markdown b/config/docs/r/monitor_tmp_exporter_integration.html.markdown new file mode 100644 index 0000000..d362960 --- /dev/null +++ b/config/docs/r/monitor_tmp_exporter_integration.html.markdown @@ -0,0 +1,80 @@ +--- +subcategory: "Managed Service for Prometheus(TMP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_tmp_exporter_integration" +sidebar_current: "docs-tencentcloud-resource-monitor_tmp_exporter_integration" +description: |- + Provides a resource to create a monitor tmpExporterIntegration +--- + +# tencentcloud_monitor_tmp_exporter_integration + +Provides a resource to create a monitor tmpExporterIntegration + +~> **NOTE:** If you only want to upgrade the exporter version with same config, you can set `version` under `instanceSpec` with any value to trigger the change. + +## Example Usage + +### Use blackbox-exporter + +```hcl +resource "tencentcloud_monitor_tmp_exporter_integration" "tmpExporterIntegration" { + instance_id = "prom-dko9d0nu" + kind = "blackbox-exporter" + content = "{\"name\":\"test\",\"kind\":\"blackbox-exporter\",\"spec\":{\"instanceSpec\":{\"module\":\"http_get\",\"urls\":[\"xx\"]}}}" + kube_type = 1 + cluster_id = "cls-bmuaukfu" +} +``` + +### Use es-exporter + +```hcl +resource "tencentcloud_monitor_tmp_exporter_integration" "tmpExporterIntegrationEs" { + instance_id = tencentcloud_monitor_tmp_instance.tmpInstance.id + kind = "es-exporter" + content = jsonencode({ + "name" : "ex-exporter-example", + "kind" : "es-exporter", + "spec" : { + "instanceSpec" : { + "url" : "http://127.0.0.1:9123", + "labels" : { + "instance" : "es-abcd" + }, + "version" : "1.70.1", + "user" : "fugiat Duis minim", + "password" : "exercitation cillum velit" + }, + "exporterSpec" : { + "all" : true, + "indicesSettings" : false, + "snapshots" : false, + "indices" : true, + "shards" : false + } + } + }) + cluster_id = "" + kube_type = 3 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `content` - (Required, String) Integration config. +* `instance_id` - (Required, String) Instance id. +* `kind` - (Required, String) Type. +* `kube_type` - (Required, Int) Integration config. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/monitor_tmp_grafana_config.html.markdown b/config/docs/r/monitor_tmp_grafana_config.html.markdown new file mode 100644 index 0000000..6308b77 --- /dev/null +++ b/config/docs/r/monitor_tmp_grafana_config.html.markdown @@ -0,0 +1,82 @@ +--- +subcategory: "TencentCloud Managed Service for Grafana(TCMG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_tmp_grafana_config" +sidebar_current: "docs-tencentcloud-resource-monitor_tmp_grafana_config" +description: |- + Provides a resource to create a monitor tmp_grafana_config +--- + +# tencentcloud_monitor_tmp_grafana_config + +Provides a resource to create a monitor tmp_grafana_config + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_monitor_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_monitor_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_monitor_grafana_instance" "foo" { + instance_name = "tf-grafana" + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] + grafana_init_password = "1234567890" + enable_internet = false + is_destroy = true + + tags = { + "createdBy" = "test" + } +} + +resource "tencentcloud_monitor_tmp_grafana_config" "foo" { + config = jsonencode( + { + server = { + http_port = 8080 + root_url = "https://cloud-grafana.woa.com/grafana-ffrdnrfa/" + serve_from_sub_path = true + } + } + ) + instance_id = tencentcloud_monitor_grafana_instance.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config` - (Required, String) JSON encoded string. +* `instance_id` - (Required, String) Instance id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +monitor tmp_grafana_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_monitor_tmp_grafana_config.tmp_grafana_config tmp_grafana_config_id +``` + diff --git a/config/docs/r/monitor_tmp_instance.html.markdown b/config/docs/r/monitor_tmp_instance.html.markdown new file mode 100644 index 0000000..24f32a4 --- /dev/null +++ b/config/docs/r/monitor_tmp_instance.html.markdown @@ -0,0 +1,73 @@ +--- +subcategory: "Managed Service for Prometheus(TMP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_tmp_instance" +sidebar_current: "docs-tencentcloud-resource-monitor_tmp_instance" +description: |- + Provides a resource to create a monitor tmpInstance +--- + +# tencentcloud_monitor_tmp_instance + +Provides a resource to create a monitor tmpInstance + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_monitor_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_monitor_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_monitor_tmp_instance" "foo" { + instance_name = "tf-tmp-instance" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + data_retention_time = 30 + zone = var.availability_zone + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_retention_time` - (Required, Int) Data retention time. +* `instance_name` - (Required, String) Instance name. +* `subnet_id` - (Required, String) Subnet Id. +* `vpc_id` - (Required, String) Vpc Id. +* `zone` - (Required, String) Available zone. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `api_root_path` - Prometheus HTTP API root address. +* `ipv4_address` - Instance IPv4 address. +* `proxy_address` - Proxy address. +* `remote_write` - Prometheus remote write address. + + +## Import + +monitor tmpInstance can be imported using the id, e.g. +``` +$ terraform import tencentcloud_monitor_tmp_instance.tmpInstance tmpInstance_id +``` + diff --git a/config/docs/r/monitor_tmp_manage_grafana_attachment.html.markdown b/config/docs/r/monitor_tmp_manage_grafana_attachment.html.markdown new file mode 100644 index 0000000..4feb89c --- /dev/null +++ b/config/docs/r/monitor_tmp_manage_grafana_attachment.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "Managed Service for Prometheus(TMP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_tmp_manage_grafana_attachment" +sidebar_current: "docs-tencentcloud-resource-monitor_tmp_manage_grafana_attachment" +description: |- + Provides a resource to create a monitor tmp_manage_grafana_attachment +--- + +# tencentcloud_monitor_tmp_manage_grafana_attachment + +Provides a resource to create a monitor tmp_manage_grafana_attachment + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_monitor_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_monitor_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_monitor_tmp_instance" "foo" { + instance_name = "tf-tmp-instance" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + data_retention_time = 30 + zone = var.availability_zone + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_monitor_grafana_instance" "foo" { + instance_name = "tf-grafana" + vpc_id = tencentcloud_vpc.vpc.id + subnet_ids = [tencentcloud_subnet.subnet.id] + grafana_init_password = "1234567890" + enable_internet = false + is_destroy = true + + tags = { + "createdBy" = "test" + } +} + +resource "tencentcloud_monitor_tmp_manage_grafana_attachment" "foo" { + grafana_id = tencentcloud_monitor_grafana_instance.foo.id + instance_id = tencentcloud_monitor_tmp_instance.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `grafana_id` - (Required, String, ForceNew) Grafana instance ID. +* `instance_id` - (Required, String, ForceNew) Prometheus instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +monitor tmp_manage_grafana_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_monitor_tmp_manage_grafana_attachment.manage_grafana_attachment prom-xxxxxxxx +``` + diff --git a/config/docs/r/monitor_tmp_recording_rule.html.markdown b/config/docs/r/monitor_tmp_recording_rule.html.markdown new file mode 100644 index 0000000..c40f9ce --- /dev/null +++ b/config/docs/r/monitor_tmp_recording_rule.html.markdown @@ -0,0 +1,82 @@ +--- +subcategory: "Managed Service for Prometheus(TMP)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_monitor_tmp_recording_rule" +sidebar_current: "docs-tencentcloud-resource-monitor_tmp_recording_rule" +description: |- + Provides a resource to create a monitor tmp recordingRule +--- + +# tencentcloud_monitor_tmp_recording_rule + +Provides a resource to create a monitor tmp recordingRule + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_monitor_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_monitor_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_monitor_tmp_instance" "foo" { + instance_name = "tf-tmp-instance" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + data_retention_time = 30 + zone = var.availability_zone + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_monitor_tmp_recording_rule" "recordingRule" { + instance_id = tencentcloud_monitor_tmp_instance.foo.id + rule_state = 2 + name = "tf-recording-rule" + group = < **NOTE:** It has been deprecated and replaced by tencentcloud_mysql_privilege. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_account" "example" { + mysql_id = tencentcloud_mysql_instance.example.id + name = "tf_example" + password = "Qwer@234" + description = "desc." + max_user_connections = 10 +} + +resource "tencentcloud_mysql_account_privilege" "default" { + mysql_id = tencentcloud_mysql_instance.example.id + account_name = tencentcloud_mysql_account.example.name + privileges = ["SELECT", "INSERT", "UPDATE", "DELETE"] + database_names = ["dbname1", "dbname2"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account_name` - (Required, String, ForceNew) Account name. +* `database_names` - (Required, Set: [`String`]) List of specified database name. +* `mysql_id` - (Required, String, ForceNew) Instance ID. +* `account_host` - (Optional, String, ForceNew) Account host, default is `%`. +* `privileges` - (Optional, Set: [`String`]) Database permissions. Valid values: `SELECT`, `INSERT`, `UPDATE`, `DELETE`, `CREATE`, `DROP`, `REFERENCES`, `INDEX`, `ALTER`, `CREATE TEMPORARY TABLES`, `LOCK TABLES`, `EXECUTE`, `CREATE VIEW`, `SHOW VIEW`, `CREATE ROUTINE`, `ALTER ROUTINE`, `EVENT` and `TRIGGER``. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_audit_log_file.html.markdown b/config/docs/r/mysql_audit_log_file.html.markdown new file mode 100644 index 0000000..87e0b26 --- /dev/null +++ b/config/docs/r/mysql_audit_log_file.html.markdown @@ -0,0 +1,124 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_audit_log_file" +sidebar_current: "docs-tencentcloud-resource-mysql_audit_log_file" +description: |- + Provides a resource to create a mysql audit_log_file +--- + +# tencentcloud_mysql_audit_log_file + +Provides a resource to create a mysql audit_log_file + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_audit_log_file" "example" { + instance_id = tencentcloud_mysql_instance.example.id + start_time = "2023-07-01 00:00:00" + end_time = "2023-10-01 00:00:00" + order = "ASC" + order_by = "timestamp" +} +``` + +### Add filter + +```hcl +resource "tencentcloud_mysql_audit_log_file" "example" { + instance_id = tencentcloud_mysql_instance.example.id + start_time = "2023-07-01 00:00:00" + end_time = "2023-10-01 00:00:00" + order = "ASC" + order_by = "timestamp" + + filter { + host = ["30.50.207.46"] + user = ["keep_dbbrain"] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String, ForceNew) end time. +* `instance_id` - (Required, String, ForceNew) The ID of instance. +* `start_time` - (Required, String, ForceNew) start time. +* `filter` - (Optional, List, ForceNew) Filter condition. Logs can be filtered according to the filter conditions set. +* `order_by` - (Optional, String, ForceNew) Sort field. supported values include:`timestamp` - timestamp; `affectRows` - affected rows; `execTime` - execution time. +* `order` - (Optional, String, ForceNew) Sort by. supported values are: `ASC`- ascending order, `DESC`- descending order. + +The `filter` object supports the following: + +* `affect_rows` - (Optional, Int) Affects the number of rows. Indicates to filter audit logs whose number of affected rows is greater than this value. +* `db_name` - (Optional, Set) Database name. +* `exec_time` - (Optional, Int) Execution time. The unit is: ms. Indicates to filter audit logs whose execution time is greater than this value. +* `host` - (Optional, Set) Client address. +* `policy_name` - (Optional, Set) The name of policy. +* `sql_type` - (Optional, String) SQL type. Currently supported: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, SET, REPLACE, EXECUTE. +* `sql_types` - (Optional, Set) SQL type. Supports simultaneous query of multiple types. Currently supported: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, SET, REPLACE, EXECUTE. +* `sql` - (Optional, String) SQL statement. support fuzzy matching. +* `sqls` - (Optional, Set) SQL statement. Support passing multiple sql statements. +* `table_name` - (Optional, Set) Table name. +* `user` - (Optional, Set) User name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `download_url` - download url. +* `file_size` - size of file(KB). + + diff --git a/config/docs/r/mysql_backup_download_restriction.html.markdown b/config/docs/r/mysql_backup_download_restriction.html.markdown new file mode 100644 index 0000000..2d39125 --- /dev/null +++ b/config/docs/r/mysql_backup_download_restriction.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_backup_download_restriction" +sidebar_current: "docs-tencentcloud-resource-mysql_backup_download_restriction" +description: |- + Provides a resource to create a mysql backup_download_restriction +--- + +# tencentcloud_mysql_backup_download_restriction + +Provides a resource to create a mysql backup_download_restriction + +## Example Usage + +```hcl +resource "tencentcloud_mysql_backup_download_restriction" "example" { + limit_type = "Customize" + vpc_comparison_symbol = "In" + ip_comparison_symbol = "In" + limit_vpc { + region = "ap-guangzhou" + vpc_list = ["vpc-4owdpnwr"] + } + limit_ip = ["127.0.0.1"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `limit_type` - (Required, String) NoLimit No limit, both internal and external networks can be downloaded; LimitOnlyIntranet Only intranet can be downloaded; Customize user-defined vpc:ip can be downloaded. LimitVpc and LimitIp can be set only when the value is Customize. +* `ip_comparison_symbol` - (Optional, String) In: The specified ip can be downloaded; NotIn: The specified ip cannot be downloaded. The default is In. +* `limit_ip` - (Optional, Set: [`String`]) ip settings to limit downloads. +* `limit_vpc` - (Optional, List) vpc settings to limit downloads. +* `vpc_comparison_symbol` - (Optional, String) This parameter only supports In, which means that the vpc specified by LimitVpc can be downloaded. The default is In. + +The `limit_vpc` object supports the following: + +* `region` - (Required, String) Restrict downloads from regions. Currently only the current region is supported. +* `vpc_list` - (Required, Set) List of vpcs to limit downloads. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mysql backup_download_restriction can be imported using the "BackupDownloadRestriction", as follows. + +``` +terraform import tencentcloud_mysql_backup_download_restriction.backup_download_restriction BackupDownloadRestriction +``` + diff --git a/config/docs/r/mysql_backup_encryption_status.html.markdown b/config/docs/r/mysql_backup_encryption_status.html.markdown new file mode 100644 index 0000000..fe7ed83 --- /dev/null +++ b/config/docs/r/mysql_backup_encryption_status.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_backup_encryption_status" +sidebar_current: "docs-tencentcloud-resource-mysql_backup_encryption_status" +description: |- + Provides a resource to create a mysql backup_encryption_status +--- + +# tencentcloud_mysql_backup_encryption_status + +Provides a resource to create a mysql backup_encryption_status + +## Example Usage + +### Enable encryption + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_backup_encryption_status" "example" { + instance_id = tencentcloud_mysql_instance.example.id + encryption_status = "on" +} +``` + +### Disable encryption + +```hcl +resource "tencentcloud_mysql_backup_encryption_status" "example" { + instance_id = tencentcloud_mysql_instance.example.id + encryption_status = "off" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `encryption_status` - (Required, String) Whether physical backup encryption is enabled for the instance. Possible values are `on`, `off`. +* `instance_id` - (Required, String) Instance ID, in the format: cdb-XXXX. Same instance ID as displayed in the ApsaraDB for Console page. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mysql backup_encryption_status can be imported using the id, e.g. + +``` +terraform import tencentcloud_mysql_backup_encryption_status.backup_encryption_status backup_encryption_status_id +``` + diff --git a/config/docs/r/mysql_backup_policy.html.markdown b/config/docs/r/mysql_backup_policy.html.markdown new file mode 100644 index 0000000..3d7a388 --- /dev/null +++ b/config/docs/r/mysql_backup_policy.html.markdown @@ -0,0 +1,97 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_backup_policy" +sidebar_current: "docs-tencentcloud-resource-mysql_backup_policy" +description: |- + Provides a mysql policy resource to create a backup policy. +--- + +# tencentcloud_mysql_backup_policy + +Provides a mysql policy resource to create a backup policy. + +~> **NOTE:** This attribute `backup_model` only support 'physical' in Terraform TencentCloud provider version 1.16.2 + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_backup_policy" "example" { + mysql_id = tencentcloud_mysql_instance.example.id + retention_period = 7 + backup_model = "physical" + backup_time = "22:00-02:00" + binlog_period = 32 + enable_binlog_standby = "off" + binlog_standby_days = 31 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `mysql_id` - (Required, String, ForceNew) Instance ID to which policies will be applied. +* `backup_model` - (Optional, String) Backup method. Supported values include: `physical` - physical backup. +* `backup_time` - (Optional, String) Instance backup time, in the format of 'HH:mm-HH:mm'. Time setting interval is four hours. Default to `02:00-06:00`. The following value can be supported: `02:00-06:00`, `06:00-10:00`, `10:00-14:00`, `14:00-18:00`, `18:00-22:00`, and `22:00-02:00`. +* `binlog_period` - (Optional, Int) Binlog retention time, in days. The minimum value is 7 days and the maximum value is 1830 days. This value cannot be set greater than the backup file retention time. +* `binlog_standby_days` - (Optional, Int) The standard starting number of days for log backup storage. The log backup will be converted when it reaches the standard starting number of days for storage. The minimum is 30 days and must not be greater than the number of days for log backup retention. +* `enable_binlog_standby` - (Optional, String) Whether to enable the log backup standard storage policy, `off` - close, `on` - open, the default is off. +* `retention_period` - (Optional, Int) The retention time of backup files, in days. The minimum value is 7 days and the maximum value is 1830 days. And default value is `7`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_database.html.markdown b/config/docs/r/mysql_database.html.markdown new file mode 100644 index 0000000..65bf7ec --- /dev/null +++ b/config/docs/r/mysql_database.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_database" +sidebar_current: "docs-tencentcloud-resource-mysql_database" +description: |- + Provides a resource to create a mysql database +--- + +# tencentcloud_mysql_database + +Provides a resource to create a mysql database + +## Example Usage + +```hcl +resource "tencentcloud_mysql_database" "database" { + instance_id = "cdb-i9xfdf7z" + db_name = "for_tf_test" + character_set_name = "utf8" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `character_set_name` - (Required, String) Character set. Valid values: `utf8`, `gbk`, `latin1`, `utf8mb4`. +* `db_name` - (Required, String, ForceNew) Name of Database. +* `instance_id` - (Required, String, ForceNew) Instance ID in the format of `cdb-c1nl9rpv`, which is the same as the one displayed in the TencentDB console. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mysql database can be imported using the id, e.g. + +``` +terraform import tencentcloud_mysql_database.database instanceId#dbName +``` + diff --git a/config/docs/r/mysql_deploy_group.html.markdown b/config/docs/r/mysql_deploy_group.html.markdown new file mode 100644 index 0000000..6420e61 --- /dev/null +++ b/config/docs/r/mysql_deploy_group.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_deploy_group" +sidebar_current: "docs-tencentcloud-resource-mysql_deploy_group" +description: |- + Provides a resource to create a mysql deploy_group +--- + +# tencentcloud_mysql_deploy_group + +Provides a resource to create a mysql deploy_group + +## Example Usage + +```hcl +resource "tencentcloud_mysql_deploy_group" "example" { + deploy_group_name = "tf-example" + description = "desc." + limit_num = 1 + dev_class = ["TS85"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `deploy_group_name` - (Required, String) The name of deploy group. the maximum length cannot exceed 60 characters. +* `description` - (Optional, String) The description of deploy group. the maximum length cannot exceed 200 characters. +* `dev_class` - (Optional, Set: [`String`]) The device class of deploy group. optional value is SH12+SH02, TS85, etc. +* `limit_num` - (Optional, Int) The limit on the number of instances on the same physical machine in deploy group affinity policy 1. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mysql deploy_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_mysql_deploy_group.deploy_group deploy_group_id +``` + diff --git a/config/docs/r/mysql_dr_instance_to_mater.html.markdown b/config/docs/r/mysql_dr_instance_to_mater.html.markdown new file mode 100644 index 0000000..0a82301 --- /dev/null +++ b/config/docs/r/mysql_dr_instance_to_mater.html.markdown @@ -0,0 +1,91 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_dr_instance_to_mater" +sidebar_current: "docs-tencentcloud-resource-mysql_dr_instance_to_mater" +description: |- + Provides a resource to create a mysql dr_instance_to_mater +--- + +# tencentcloud_mysql_dr_instance_to_mater + +Provides a resource to create a mysql dr_instance_to_mater + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_dr_instance_to_mater" "example" { + instance_id = tencentcloud_mysql_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Disaster recovery instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed in the TencentDB console. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mysql dr_instance_to_mater can be imported using the id, e.g. + +``` +terraform import tencentcloud_mysql_dr_instance_to_mater.dr_instance_to_mater dr_instance_to_mater_id +``` + diff --git a/config/docs/r/mysql_instance.html.markdown b/config/docs/r/mysql_instance.html.markdown new file mode 100644 index 0000000..a8e5e2a --- /dev/null +++ b/config/docs/r/mysql_instance.html.markdown @@ -0,0 +1,191 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_instance" +sidebar_current: "docs-tencentcloud-resource-mysql_instance" +description: |- + Provides a mysql instance resource to create master database instances. +--- + +# tencentcloud_mysql_instance + +Provides a mysql instance resource to create master database instances. + +~> **NOTE:** If this mysql has readonly instance, the terminate operation of the mysql does NOT take effect immediately, maybe takes for several hours. so during that time, VPCs associated with that mysql instance can't be terminated also. + +~> **NOTE:** The value of parameter `parameters` can be used with tencentcloud_mysql_parameter_list to obtain. + +## Example Usage + +### Create a single node instance + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} +``` + +### Create a double node instance + +```hcl +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 1 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + first_slave_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} +``` + +### Create a three node instance + +```hcl +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 1 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + first_slave_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_name` - (Required, String) The name of a mysql instance. +* `mem_size` - (Required, Int) Memory size (in MB). +* `volume_size` - (Required, Int) Disk size (in GB). +* `auto_renew_flag` - (Optional, Int) Auto renew flag. NOTES: Only supported prepaid instance. +* `availability_zone` - (Optional, String, ForceNew) Indicates which availability zone will be used. +* `charge_type` - (Optional, String, ForceNew) Pay type of instance. Valid values:`PREPAID`, `POSTPAID`. Default is `POSTPAID`. +* `cpu` - (Optional, Int) CPU cores. +* `device_type` - (Optional, String) Specify device type, available values: `UNIVERSAL` (default), `EXCLUSIVE`, `BASIC`. +* `engine_version` - (Optional, String) The version number of the database engine to use. Supported versions include 5.5/5.6/5.7/8.0, and default is 5.7. Upgrade the instance engine version to support 5.6/5.7 and switch immediately. +* `fast_upgrade` - (Optional, Int) Specify whether to enable fast upgrade when upgrade instance spec, available value: `1` - enabled, `0` - disabled. +* `first_slave_zone` - (Optional, String) Zone information about first slave instance. +* `force_delete` - (Optional, Bool) Indicate whether to delete instance directly or not. Default is `false`. If set true, the instance will be deleted instead of staying recycle bin. Note: only works for `PREPAID` instance. When the main mysql instance set true, this para of the readonly mysql instance will not take effect. +* `internet_service` - (Optional, Int) Indicates whether to enable the access to an instance from public network: 0 - No, 1 - Yes. +* `intranet_port` - (Optional, Int) Public access port. Valid value ranges: [1024~65535]. The default value is `3306`. +* `max_deay_time` - (Optional, Int) Latency threshold. Value range 1~10. Only need to fill in when upgrading kernel subversion and engine version. +* `param_template_id` - (Optional, Int) Specify parameter template id. +* `parameters` - (Optional, Map) List of parameters to use. +* `pay_type` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.36.0. Please use `charge_type` instead. Pay type of instance. Valid values: `0`, `1`. `0`: prepaid, `1`: postpaid. +* `period` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.36.0. Please use `prepaid_period` instead. Period of instance. NOTES: Only supported prepaid instance. +* `prepaid_period` - (Optional, Int) Period of instance. NOTES: Only supported prepaid instance. +* `project_id` - (Optional, Int) Project ID, default value is 0. +* `root_password` - (Optional, String) Password of root account. This parameter can be specified when you purchase master instances, but it should be ignored when you purchase read-only instances or disaster recovery instances. +* `second_slave_zone` - (Optional, String) Zone information about second slave instance. +* `security_groups` - (Optional, Set: [`String`]) Security groups to use. +* `slave_deploy_mode` - (Optional, Int) Availability zone deployment method. Available values: 0 - Single availability zone; 1 - Multiple availability zones. +* `slave_sync_mode` - (Optional, Int) Data replication mode. 0 - Async replication; 1 - Semisync replication; 2 - Strongsync replication. +* `subnet_id` - (Optional, String) Private network ID. If `vpc_id` is set, this value is required. +* `tags` - (Optional, Map) Instance tags. +* `upgrade_subversion` - (Optional, Int) Whether it is a kernel subversion upgrade, supported values: 1 - upgrade the kernel subversion; 0 - upgrade the database engine version. Only need to fill in when upgrading kernel subversion and engine version. +* `vpc_id` - (Optional, String) ID of VPC, which can be modified once every 24 hours and can't be removed. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `gtid` - Indicates whether GTID is enable. `0` - Not enabled; `1` - Enabled. +* `internet_host` - host for public access. +* `internet_port` - Access port for public access. +* `intranet_ip` - instance intranet IP. +* `locked` - Indicates whether the instance is locked. Valid values: `0`, `1`. `0` - No; `1` - Yes. +* `status` - Instance status. Valid values: `0`, `1`, `4`, `5`. `0` - Creating; `1` - Running; `4` - Isolating; `5` - Isolated. +* `task_status` - Indicates which kind of operations is being executed. + + +## Import + +MySQL instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_mysql_instance.foo cdb-12345678 +``` + diff --git a/config/docs/r/mysql_instance_encryption_operation.html.markdown b/config/docs/r/mysql_instance_encryption_operation.html.markdown new file mode 100644 index 0000000..7b9e26c --- /dev/null +++ b/config/docs/r/mysql_instance_encryption_operation.html.markdown @@ -0,0 +1,87 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_instance_encryption_operation" +sidebar_current: "docs-tencentcloud-resource-mysql_instance_encryption_operation" +description: |- + Provides a resource to create a mysql instance_encryption_operation +--- + +# tencentcloud_mysql_instance_encryption_operation + +Provides a resource to create a mysql instance_encryption_operation + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_instance_encryption_operation" "example" { + instance_id = tencentcloud_mysql_instance.example.id + key_id = "KMS-CDB" + key_region = "ap-guangzhou" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) TencentDB instance ID. +* `key_id` - (Optional, String, ForceNew) Custom key ID, which is the unique CMK ID. If this value is empty, the key KMS-CDB auto-generated by Tencent Cloud will be used. +* `key_region` - (Optional, String, ForceNew) Custom storage region, such as ap-guangzhou. When `KeyId` is not empty, this parameter is required. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_isolate_instance.html.markdown b/config/docs/r/mysql_isolate_instance.html.markdown new file mode 100644 index 0000000..da66363 --- /dev/null +++ b/config/docs/r/mysql_isolate_instance.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_isolate_instance" +sidebar_current: "docs-tencentcloud-resource-mysql_isolate_instance" +description: |- + Provides a resource to create a mysql isolate_instance +--- + +# tencentcloud_mysql_isolate_instance + +Provides a resource to create a mysql isolate_instance + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_isolate_instance" "example" { + instance_id = tencentcloud_mysql_instance.example.id + operate = "recover" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID, the format is: cdb-c1nl9rpv, which is the same as the instance ID displayed on the cloud database console page, and you can use the [query instance list] (https://cloud.tencent.com/document/api/236/15872) interface Gets the value of the field InstanceId in the output parameter. +* `operate` - (Required, String) Manipulate instance, `isolate` - isolate instance, `recover`- recover isolated instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - Instance status. + + diff --git a/config/docs/r/mysql_local_binlog_config.html.markdown b/config/docs/r/mysql_local_binlog_config.html.markdown new file mode 100644 index 0000000..a547c2c --- /dev/null +++ b/config/docs/r/mysql_local_binlog_config.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_local_binlog_config" +sidebar_current: "docs-tencentcloud-resource-mysql_local_binlog_config" +description: |- + Provides a resource to create a mysql local_binlog_config +--- + +# tencentcloud_mysql_local_binlog_config + +Provides a resource to create a mysql local_binlog_config + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_local_binlog_config" "example" { + instance_id = tencentcloud_mysql_instance.example.id + save_hours = 140 + max_usage = 50 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed in the TencentDB console. +* `max_usage` - (Required, Int) Space utilization of local binlog. Value range: [30,50]. +* `save_hours` - (Required, Int) Retention period of local binlog. Valid range: 72-168 hours. When there is disaster recovery instance, the valid range will be 120-168 hours. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mysql local_binlog_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_mysql_local_binlog_config.local_binlog_config instance_id +``` + diff --git a/config/docs/r/mysql_param_template.html.markdown b/config/docs/r/mysql_param_template.html.markdown new file mode 100644 index 0000000..a9acc29 --- /dev/null +++ b/config/docs/r/mysql_param_template.html.markdown @@ -0,0 +1,118 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_param_template" +sidebar_current: "docs-tencentcloud-resource-mysql_param_template" +description: |- + Provides a resource to create a mysql param template +--- + +# tencentcloud_mysql_param_template + +Provides a resource to create a mysql param template + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_param_template" "example" { + name = "tf-example" + description = "desc." + engine_version = "8.0" + param_list { + current_value = "1" + name = "auto_increment_increment" + } + param_list { + current_value = "1" + name = "auto_increment_offset" + } + param_list { + current_value = "ON" + name = "automatic_sp_privileges" + } + template_type = "HIGH_STABILITY" + engine_type = "InnoDB" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) The name of parameter template. +* `description` - (Optional, String) The description of parameter template. +* `engine_type` - (Optional, String) The engine type of instance, optional value is InnoDB or RocksDB, default to InnoDB. +* `engine_version` - (Optional, String) The version of MySQL. +* `param_list` - (Optional, List) parameter list. +* `template_id` - (Optional, Int) The ID of source parameter template. +* `template_type` - (Optional, String) The default type of parameter template, supported value is HIGH_STABILITY or HIGH_PERFORMANCE. + +The `param_list` object supports the following: + +* `current_value` - (Optional, String) The value of parameter. +* `name` - (Optional, String) The name of parameter. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mysql param template can be imported using the id, e.g. + +``` +terraform import tencentcloud_mysql_param_template.param_template template_id +``` + diff --git a/config/docs/r/mysql_password_complexity.html.markdown b/config/docs/r/mysql_password_complexity.html.markdown new file mode 100644 index 0000000..875034a --- /dev/null +++ b/config/docs/r/mysql_password_complexity.html.markdown @@ -0,0 +1,105 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_password_complexity" +sidebar_current: "docs-tencentcloud-resource-mysql_password_complexity" +description: |- + Provides a resource to create a mysql password_complexity +--- + +# tencentcloud_mysql_password_complexity + +Provides a resource to create a mysql password_complexity + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_password_complexity" "example" { + instance_id = tencentcloud_mysql_instance.example.id + param_list { + name = "validate_password_length" + current_value = "8" + } + param_list { + name = "validate_password_mixed_case_count" + current_value = "2" + } + param_list { + name = "validate_password_number_count" + current_value = "2" + } + param_list { + name = "validate_password_special_char_count" + current_value = "2" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `param_list` - (Optional, List) List of parameters to be modified. Every element is a combination of `Name` (parameter name) and `CurrentValue` (new value). Valid values for `Name` of version 8.0: `validate_password.policy`, `validate_password.lengt`, `validate_password.mixed_case_coun`, `validate_password.number_coun`, `validate_password.special_char_count`. Valid values for `Name` of version 5.6 and 5.7: `validate_password_polic`, `validate_password_lengt` `validate_password_mixed_case_coun`, `validate_password_number_coun`, `validate_password_special_char_coun`. + +The `param_list` object supports the following: + +* `current_value` - (Optional, String) Parameter value. +* `name` - (Optional, String) Parameter name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_privilege.html.markdown b/config/docs/r/mysql_privilege.html.markdown new file mode 100644 index 0000000..d2cd3df --- /dev/null +++ b/config/docs/r/mysql_privilege.html.markdown @@ -0,0 +1,144 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_privilege" +sidebar_current: "docs-tencentcloud-resource-mysql_privilege" +description: |- + Provides a mysql account privilege resource to grant different access privilege to different database. A database can be granted by multiple account. +--- + +# tencentcloud_mysql_privilege + +Provides a mysql account privilege resource to grant different access privilege to different database. A database can be granted by multiple account. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_account" "example" { + mysql_id = tencentcloud_mysql_instance.example.id + name = "tf_example" + password = "Qwer@234" + description = "desc." + max_user_connections = 10 +} + +resource "tencentcloud_mysql_privilege" "example" { + mysql_id = tencentcloud_mysql_instance.example.id + account_name = tencentcloud_mysql_account.example.name + global = ["TRIGGER"] + database { + privileges = ["SELECT", "INSERT", "UPDATE", "DELETE", "CREATE"] + database_name = "sys" + } + database { + privileges = ["SELECT"] + database_name = "performance_schema" + } + + table { + privileges = ["SELECT", "INSERT", "UPDATE", "DELETE", "CREATE"] + database_name = "mysql" + table_name = "slow_log" + } + + table { + privileges = ["SELECT", "INSERT", "UPDATE"] + database_name = "mysql" + table_name = "user" + } + + column { + privileges = ["SELECT", "INSERT", "UPDATE", "REFERENCES"] + database_name = "mysql" + table_name = "user" + column_name = "host" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account_name` - (Required, String, ForceNew) Account name.the forbidden value is:root,mysql.sys,tencentroot. +* `global` - (Required, Set: [`String`]) Global privileges. available values for Privileges:ALTER,ALTER ROUTINE,CREATE,CREATE ROUTINE,CREATE TEMPORARY TABLES,CREATE USER,CREATE VIEW,DELETE,DROP,EVENT,EXECUTE,INDEX,INSERT,LOCK TABLES,PROCESS,REFERENCES,RELOAD,REPLICATION CLIENT,REPLICATION SLAVE,SELECT,SHOW DATABASES,SHOW VIEW,TRIGGER,UPDATE. +* `mysql_id` - (Required, String, ForceNew) Instance ID. +* `account_host` - (Optional, String, ForceNew) Account host, default is `%`. +* `column` - (Optional, Set) Column privileges list. +* `database` - (Optional, Set) Database privileges list. +* `table` - (Optional, Set) Table privileges list. + +The `column` object supports the following: + +* `column_name` - (Required, String) Column name. +* `database_name` - (Required, String) Database name. +* `privileges` - (Required, Set) Column privilege.available values for Privileges:SELECT,INSERT,UPDATE,REFERENCES. +* `table_name` - (Required, String) Table name. + +The `database` object supports the following: + +* `database_name` - (Required, String) Database name. +* `privileges` - (Required, Set) Database privilege.available values for Privileges:SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,INDEX,ALTER,CREATE TEMPORARY TABLES,LOCK TABLES,EXECUTE,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE,EVENT,TRIGGER. + +The `table` object supports the following: + +* `database_name` - (Required, String) Database name. +* `privileges` - (Required, Set) Table privilege.available values for Privileges:SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,REFERENCES,INDEX,ALTER,CREATE VIEW,SHOW VIEW,TRIGGER. +* `table_name` - (Required, String) Table name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_proxy.html.markdown b/config/docs/r/mysql_proxy.html.markdown new file mode 100644 index 0000000..085b395 --- /dev/null +++ b/config/docs/r/mysql_proxy.html.markdown @@ -0,0 +1,117 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_proxy" +sidebar_current: "docs-tencentcloud-resource-mysql_proxy" +description: |- + Provides a resource to create a mysql proxy +--- + +# tencentcloud_mysql_proxy + +Provides a resource to create a mysql proxy + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 1 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + first_slave_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_proxy" "example" { + instance_id = tencentcloud_mysql_instance.example.id + uniq_vpc_id = tencentcloud_vpc.vpc.id + uniq_subnet_id = tencentcloud_subnet.subnet.id + proxy_node_custom { + node_count = 1 + cpu = 2 + mem = 4000 + region = "ap-guangzhou" + zone = "ap-guangzhou-3" + } + security_group = [tencentcloud_security_group.security_group.id] + desc = "desc." + connection_pool_limit = 2 + vip = "10.0.0.120" + vport = 3306 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance id. +* `proxy_node_custom` - (Required, List) Node specification configuration. +* `uniq_subnet_id` - (Required, String) Subnet id. +* `uniq_vpc_id` - (Required, String) Vpc id. +* `connection_pool_limit` - (Optional, Int) Connection Pool Threshold. +* `desc` - (Optional, String) Describe. +* `proxy_version` - (Optional, String) The current version of the database agent. No need to fill in when creating. +* `security_group` - (Optional, Set: [`String`]) Security group. +* `upgrade_time` - (Optional, String) Upgrade time: nowTime (upgrade completed) timeWindow (instance maintenance time), Required when modifying the agent version, No need to fill in when creating. +* `vip` - (Optional, String) IP address. +* `vport` - (Optional, Int) Port. + +The `proxy_node_custom` object supports the following: + +* `cpu` - (Required, Int) Number of CPU cores. +* `mem` - (Required, Int) Memory size. +* `node_count` - (Required, Int) Number of nodes. +* `region` - (Required, String) Region. +* `zone` - (Required, String) Zone. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `proxy_address_id` - Proxy address id. +* `proxy_group_id` - Proxy group id. + + diff --git a/config/docs/r/mysql_readonly_instance.html.markdown b/config/docs/r/mysql_readonly_instance.html.markdown new file mode 100644 index 0000000..964f8cf --- /dev/null +++ b/config/docs/r/mysql_readonly_instance.html.markdown @@ -0,0 +1,127 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_readonly_instance" +sidebar_current: "docs-tencentcloud-resource-mysql_readonly_instance" +description: |- + Provides a mysql instance resource to create read-only database instances. +--- + +# tencentcloud_mysql_readonly_instance + +Provides a mysql instance resource to create read-only database instances. + +~> **NOTE:** Read-only instances can be purchased only for two-node or three-node source instances on MySQL 5.6 or above with the InnoDB engine at a specification of 1 GB memory and 50 GB disk capacity or above. +~> **NOTE:** The terminate operation of read only mysql does NOT take effect immediately, maybe takes for several hours. so during that time, VPCs associated with that mysql instance can't be terminated also. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "UTF8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_readonly_instance" "example" { + master_instance_id = tencentcloud_mysql_instance.example.id + instance_name = "tf-example" + mem_size = 128000 + volume_size = 255 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + createBy = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_name` - (Required, String) The name of a mysql instance. +* `master_instance_id` - (Required, String) Indicates the master instance ID of recovery instances. +* `mem_size` - (Required, Int) Memory size (in MB). +* `volume_size` - (Required, Int) Disk size (in GB). +* `auto_renew_flag` - (Optional, Int) Auto renew flag. NOTES: Only supported prepaid instance. +* `charge_type` - (Optional, String, ForceNew) Pay type of instance. Valid values:`PREPAID`, `POSTPAID`. Default is `POSTPAID`. +* `cpu` - (Optional, Int) CPU cores. +* `device_type` - (Optional, String) Specify device type, available values: `UNIVERSAL` (default), `EXCLUSIVE`, `BASIC`. +* `fast_upgrade` - (Optional, Int) Specify whether to enable fast upgrade when upgrade instance spec, available value: `1` - enabled, `0` - disabled. +* `force_delete` - (Optional, Bool) Indicate whether to delete instance directly or not. Default is `false`. If set true, the instance will be deleted instead of staying recycle bin. Note: only works for `PREPAID` instance. When the main mysql instance set true, this para of the readonly mysql instance will not take effect. +* `intranet_port` - (Optional, Int) Public access port. Valid value ranges: [1024~65535]. The default value is `3306`. +* `master_region` - (Optional, String) The zone information of the primary instance is required when you purchase a disaster recovery instance. +* `param_template_id` - (Optional, Int) Specify parameter template id. +* `pay_type` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.36.0. Please use `charge_type` instead. Pay type of instance. Valid values: `0`, `1`. `0`: prepaid, `1`: postpaid. +* `period` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.36.0. Please use `prepaid_period` instead. Period of instance. NOTES: Only supported prepaid instance. +* `prepaid_period` - (Optional, Int) Period of instance. NOTES: Only supported prepaid instance. +* `security_groups` - (Optional, Set: [`String`]) Security groups to use. +* `subnet_id` - (Optional, String) Private network ID. If `vpc_id` is set, this value is required. +* `tags` - (Optional, Map) Instance tags. +* `vpc_id` - (Optional, String) ID of VPC, which can be modified once every 24 hours and can't be removed. +* `zone` - (Optional, String) Zone information, this parameter defaults to, the system automatically selects an Availability Zone. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `intranet_ip` - instance intranet IP. +* `locked` - Indicates whether the instance is locked. Valid values: `0`, `1`. `0` - No; `1` - Yes. +* `status` - Instance status. Valid values: `0`, `1`, `4`, `5`. `0` - Creating; `1` - Running; `4` - Isolating; `5` - Isolated. +* `task_status` - Indicates which kind of operations is being executed. + + +## Import + +mysql read-only database instances can be imported using the id, e.g. +``` +terraform import tencentcloud_mysql_readonly_instance.default cdb-dnqksd9f +``` + diff --git a/config/docs/r/mysql_reload_balance_proxy_node.html.markdown b/config/docs/r/mysql_reload_balance_proxy_node.html.markdown new file mode 100644 index 0000000..dfed805 --- /dev/null +++ b/config/docs/r/mysql_reload_balance_proxy_node.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_reload_balance_proxy_node" +sidebar_current: "docs-tencentcloud-resource-mysql_reload_balance_proxy_node" +description: |- + Provides a resource to create a mysql reload_balance_proxy_node +--- + +# tencentcloud_mysql_reload_balance_proxy_node + +Provides a resource to create a mysql reload_balance_proxy_node + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 1 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + first_slave_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_proxy" "example" { + instance_id = tencentcloud_mysql_instance.example.id + uniq_vpc_id = tencentcloud_vpc.vpc.id + uniq_subnet_id = tencentcloud_subnet.subnet.id + proxy_node_custom { + node_count = 1 + cpu = 2 + mem = 4000 + region = "ap-guangzhou" + zone = "ap-guangzhou-3" + } + security_group = [tencentcloud_security_group.security_group.id] + desc = "desc." + connection_pool_limit = 2 + vip = "10.0.0.120" + vport = 3306 +} + +resource "tencentcloud_mysql_reload_balance_proxy_node" "example" { + proxy_group_id = tencentcloud_mysql_proxy.example.proxy_group_id + proxy_address_id = tencentcloud_mysql_proxy.example.proxy_address_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `proxy_group_id` - (Required, String, ForceNew) Proxy id. +* `proxy_address_id` - (Optional, String, ForceNew) Proxy address id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_remote_backup_config.html.markdown b/config/docs/r/mysql_remote_backup_config.html.markdown new file mode 100644 index 0000000..490f540 --- /dev/null +++ b/config/docs/r/mysql_remote_backup_config.html.markdown @@ -0,0 +1,99 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_remote_backup_config" +sidebar_current: "docs-tencentcloud-resource-mysql_remote_backup_config" +description: |- + Provides a resource to create a mysql remote_backup_config +--- + +# tencentcloud_mysql_remote_backup_config + +Provides a resource to create a mysql remote_backup_config + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_remote_backup_config" "example" { + instance_id = tencentcloud_mysql_instance.example.id + remote_backup_save = "on" + remote_binlog_save = "on" + remote_region = ["ap-shanghai"] + expire_days = 7 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `expire_days` - (Required, Int) Remote backup retention time, in days. +* `instance_id` - (Required, String) Instance ID, in the format: cdb-c1nl9rpv. Same instance ID as displayed in the ApsaraDB for Console page. +* `remote_backup_save` - (Required, String) Remote data backup switch, off - disable remote backup, on - enable remote backup. +* `remote_binlog_save` - (Required, String) Off-site log backup switch, off - off off-site backup, on-on off-site backup, only when the parameter RemoteBackupSave is on, the RemoteBinlogSave parameter can be set to on. +* `remote_region` - (Required, Set: [`String`]) User settings off-site backup region list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mysql remote_backup_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_mysql_remote_backup_config.remote_backup_config remote_backup_config_id +``` + diff --git a/config/docs/r/mysql_renew_db_instance_operation.html.markdown b/config/docs/r/mysql_renew_db_instance_operation.html.markdown new file mode 100644 index 0000000..de72c4d --- /dev/null +++ b/config/docs/r/mysql_renew_db_instance_operation.html.markdown @@ -0,0 +1,93 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_renew_db_instance_operation" +sidebar_current: "docs-tencentcloud-resource-mysql_renew_db_instance_operation" +description: |- + Provides a resource to create a mysql renew_db_instance_operation +--- + +# tencentcloud_mysql_renew_db_instance_operation + +Provides a resource to create a mysql renew_db_instance_operation + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +data "tencentcloud_mysql_rollback_range_time" "example" { + instance_ids = [tencentcloud_mysql_instance.example.id] +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "PREPAID" + root_password = "PassWord123" + slave_deploy_mode = 1 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + first_slave_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_renew_db_instance_operation" "example" { + instance_id = tencentcloud_mysql_instance.example.id + time_span = 1 + modify_pay_type = "PREPAID" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) The instance ID to be renewed, the format is: cdb-c1nl9rpv, which is the same as the instance ID displayed on the cloud database console page, you can use [Query Instance List](https://cloud.tencent.com/document/api/236/ 15872). +* `time_span` - (Required, Int, ForceNew) Renewal duration, unit: month, optional values include [1,2,3,4,5,6,7,8,9,10,11,12,24,36]. +* `modify_pay_type` - (Optional, String, ForceNew) If you need to renew the Pay-As-You-Go instance to a Subscription instance, the value of this input parameter needs to be specified as `PREPAID`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `deadline_time` - Instance expiration time. +* `deal_id` - Deal id. + + diff --git a/config/docs/r/mysql_reset_root_account.html.markdown b/config/docs/r/mysql_reset_root_account.html.markdown new file mode 100644 index 0000000..6b3c726 --- /dev/null +++ b/config/docs/r/mysql_reset_root_account.html.markdown @@ -0,0 +1,84 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_reset_root_account" +sidebar_current: "docs-tencentcloud-resource-mysql_reset_root_account" +description: |- + Provides a resource to create a mysql reset_root_account +--- + +# tencentcloud_mysql_reset_root_account + +Provides a resource to create a mysql reset_root_account + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 1 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + first_slave_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_reset_root_account" "example" { + instance_id = tencentcloud_mysql_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) The instance ID, in the format: cdb-c1nl9rpv, is the same as the instance ID displayed on the cloud database console page. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_restart_db_instances_operation.html.markdown b/config/docs/r/mysql_restart_db_instances_operation.html.markdown new file mode 100644 index 0000000..47355a1 --- /dev/null +++ b/config/docs/r/mysql_restart_db_instances_operation.html.markdown @@ -0,0 +1,91 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_restart_db_instances_operation" +sidebar_current: "docs-tencentcloud-resource-mysql_restart_db_instances_operation" +description: |- + Provides a resource to create a mysql restart_db_instances_operation +--- + +# tencentcloud_mysql_restart_db_instances_operation + +Provides a resource to create a mysql restart_db_instances_operation + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_restart_db_instances_operation" "example" { + instance_id = tencentcloud_mysql_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) An array of instance ID in the format: cdb-c1nl9rpv, which is the same as the instance ID displayed on the cloud database console page. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - Instance status. + + +## Import + +mysql restart_db_instances_operation can be imported using the id, e.g. + +``` +terraform import tencentcloud_mysql_restart_db_instances_operation.restart_db_instances_operation restart_db_instances_operation_id +``` + diff --git a/config/docs/r/mysql_ro_group.html.markdown b/config/docs/r/mysql_ro_group.html.markdown new file mode 100644 index 0000000..9cad4ec --- /dev/null +++ b/config/docs/r/mysql_ro_group.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_ro_group" +sidebar_current: "docs-tencentcloud-resource-mysql_ro_group" +description: |- + Provides a resource to create a mysql ro_group +--- + +# tencentcloud_mysql_ro_group + +Provides a resource to create a mysql ro_group + +## Example Usage + +```hcl +resource "tencentcloud_mysql_ro_group" "example" { + instance_id = "cdb-e8i766hx" + ro_group_id = "cdbrg-f49t0gnj" + ro_group_info { + ro_group_name = "keep-ro" + ro_max_delay_time = 1 + ro_offline_delay = 1 + min_ro_in_group = 1 + weight_mode = "custom" + replication_delay_time = 1 + } + ro_weight_values { + instance_id = "cdbro-f49t0gnj" + weight = 10 + } + is_balance_ro_load = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, in the format: cdbro-3i70uj0k. +* `ro_group_id` - (Required, String) The ID of the RO group. +* `is_balance_ro_load` - (Optional, Int) Whether to rebalance the load of RO instances in the RO group. Supported values include: 1 - rebalance load; 0 - do not rebalance load. The default value is 0. Note that when it is set to rebalance the load, the RO instance in the RO group will have a momentary disconnection of the database connection, please ensure that the application can reconnect to the database. +* `ro_group_info` - (Optional, List) Details of the RO group. +* `ro_weight_values` - (Optional, List) The weight of the instance within the RO group. If the weight mode of the RO group is changed to user-defined mode (custom), this parameter must be set, and the weight value of each RO instance needs to be set. + +The `ro_group_info` object supports the following: + +* `min_ro_in_group` - (Optional, Int) The minimum number of reserved instances. It can be set to any value less than or equal to the number of RO instances under this RO group. Note that if the setting value is greater than the number of RO instances, it will not be removed; if it is set to 0, all instances whose latency exceeds the limit will be removed. +* `replication_delay_time` - (Optional, Int) Delayed replication time. +* `ro_group_name` - (Optional, String) RO group name. +* `ro_max_delay_time` - (Optional, Int) RO instance maximum latency threshold. The unit is seconds, the minimum value is 1. Note that the RO group must have enabled instance delay culling policy for this value to be valid. +* `ro_offline_delay` - (Optional, Int) Whether to enable delayed culling of instances. Supported values are: 1 - on; 0 - not on. Note that if you enable instance delay culling, you must set the delay threshold (RoMaxDelayTime) parameter. +* `weight_mode` - (Optional, String) weight mode. Supported values include: `system` - automatically assigned by the system; `custom` - user-defined settings. Note that if the `custom` mode is set, the RO instance weight configuration (RoWeightValues) parameter must be set. + +The `ro_weight_values` object supports the following: + +* `instance_id` - (Required, String) RO instance ID. +* `weight` - (Required, Int) Weights. The value range is [0, 100]. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_ro_group_load_operation.html.markdown b/config/docs/r/mysql_ro_group_load_operation.html.markdown new file mode 100644 index 0000000..7ad584b --- /dev/null +++ b/config/docs/r/mysql_ro_group_load_operation.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_ro_group_load_operation" +sidebar_current: "docs-tencentcloud-resource-mysql_ro_group_load_operation" +description: |- + Provides a resource to create a mysql ro_group_load_operation +--- + +# tencentcloud_mysql_ro_group_load_operation + +Provides a resource to create a mysql ro_group_load_operation + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +data "tencentcloud_mysql_instance" "example" { + mysql_id = tencentcloud_mysql_instance.example.id + + depends_on = [tencentcloud_mysql_readonly_instance.example] +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_readonly_instance" "example" { + master_instance_id = tencentcloud_mysql_instance.example.id + instance_name = "tf-mysql" + mem_size = 2000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + createBy = "terraform" + } +} + +resource "tencentcloud_mysql_ro_group_load_operation" "ro_group_load_operation" { + ro_group_id = data.tencentcloud_mysql_instance.example.instance_list.0.ro_groups.0.group_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ro_group_id` - (Required, String, ForceNew) The ID of the RO group, in the format: cdbrg-c1nl9rpv. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_ro_instance_ip.html.markdown b/config/docs/r/mysql_ro_instance_ip.html.markdown new file mode 100644 index 0000000..dd74f59 --- /dev/null +++ b/config/docs/r/mysql_ro_instance_ip.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_ro_instance_ip" +sidebar_current: "docs-tencentcloud-resource-mysql_ro_instance_ip" +description: |- + Provides a resource to create a mysql ro_instance_ip +--- + +# tencentcloud_mysql_ro_instance_ip + +Provides a resource to create a mysql ro_instance_ip + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_mysql_ro_instance_ip" "example" { + instance_id = "cdbro-bdlvcfpj" + uniq_subnet_id = tencentcloud_subnet.subnet.id + uniq_vpc_id = tencentcloud_vpc.vpc.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Read-only instance ID, in the format: cdbro-3i70uj0k, which is the same as the read-only instance ID displayed on the cloud database console page. +* `uniq_subnet_id` - (Optional, String, ForceNew) Subnet descriptor, for example: subnet-1typ0s7d. +* `uniq_vpc_id` - (Optional, String, ForceNew) vpc descriptor, for example: vpc-a23yt67j, if this field is passed, UniqSubnetId must be passed. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `ro_vip` - Intranet IP address of the read-only instance. +* `ro_vport` - Intranet port number of the read-only instance. + + diff --git a/config/docs/r/mysql_ro_start_replication.html.markdown b/config/docs/r/mysql_ro_start_replication.html.markdown new file mode 100644 index 0000000..a56f492 --- /dev/null +++ b/config/docs/r/mysql_ro_start_replication.html.markdown @@ -0,0 +1,102 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_ro_start_replication" +sidebar_current: "docs-tencentcloud-resource-mysql_ro_start_replication" +description: |- + Provides a resource to create a mysql ro_start_replication +--- + +# tencentcloud_mysql_ro_start_replication + +Provides a resource to create a mysql ro_start_replication + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 1 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + first_slave_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_proxy" "example" { + instance_id = tencentcloud_mysql_instance.example.id + uniq_vpc_id = tencentcloud_vpc.vpc.id + uniq_subnet_id = tencentcloud_subnet.subnet.id + proxy_node_custom { + node_count = 1 + cpu = 2 + mem = 4000 + region = "ap-guangzhou" + zone = "ap-guangzhou-3" + } + security_group = [tencentcloud_security_group.security_group.id] + desc = "desc." + connection_pool_limit = 2 + vip = "10.0.0.120" + vport = 3306 +} + +resource "tencentcloud_mysql_ro_start_replication" "example" { + instance_id = tencentcloud_mysql_proxy.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Read-Only instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_ro_stop_replication.html.markdown b/config/docs/r/mysql_ro_stop_replication.html.markdown new file mode 100644 index 0000000..9538e6d --- /dev/null +++ b/config/docs/r/mysql_ro_stop_replication.html.markdown @@ -0,0 +1,102 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_ro_stop_replication" +sidebar_current: "docs-tencentcloud-resource-mysql_ro_stop_replication" +description: |- + Provides a resource to create a mysql ro_stop_replication +--- + +# tencentcloud_mysql_ro_stop_replication + +Provides a resource to create a mysql ro_stop_replication + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 1 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + first_slave_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_proxy" "example" { + instance_id = tencentcloud_mysql_instance.example.id + uniq_vpc_id = tencentcloud_vpc.vpc.id + uniq_subnet_id = tencentcloud_subnet.subnet.id + proxy_node_custom { + node_count = 1 + cpu = 2 + mem = 4000 + region = "ap-guangzhou" + zone = "ap-guangzhou-3" + } + security_group = [tencentcloud_security_group.security_group.id] + desc = "desc." + connection_pool_limit = 2 + vip = "10.0.0.120" + vport = 3306 +} + +resource "tencentcloud_mysql_ro_stop_replication" "example" { + instance_id = tencentcloud_mysql_proxy.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Read-Only instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_rollback.html.markdown b/config/docs/r/mysql_rollback.html.markdown new file mode 100644 index 0000000..d098ece --- /dev/null +++ b/config/docs/r/mysql_rollback.html.markdown @@ -0,0 +1,120 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_rollback" +sidebar_current: "docs-tencentcloud-resource-mysql_rollback" +description: |- + Provides a resource to create a mysql rollback +--- + +# tencentcloud_mysql_rollback + +Provides a resource to create a mysql rollback + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +data "tencentcloud_mysql_rollback_range_time" "example" { + instance_ids = [tencentcloud_mysql_instance.example.id] +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 1 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + first_slave_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_rollback" "example" { + instance_id = tencentcloud_mysql_instance.example.id + strategy = "full" + rollback_time = data.tencentcloud_mysql_rollback_range_time.example.item.0.times.0.start + databases { + database_name = "tf_db_bak" + new_database_name = "tf_db_bak_new" + } + tables { + database = "tf_db_bak1" + table { + table_name = "tf_table" + new_table_name = "tf_table_new" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Cloud database instance ID. +* `rollback_time` - (Required, String, ForceNew) Database rollback time, the time format is: yyyy-mm-dd hh:mm:ss. +* `strategy` - (Required, String, ForceNew) Rollback strategy. Available values are: table, db, full; the default value is full. table- Extremely fast rollback mode, only import the backup and binlog of the selected table level, if there is a cross-table operation, and the associated table is not selected at the same time, the rollback will fail. In this mode, the parameter Databases must be empty; db- Quick mode, only import the backup and binlog of the selected library level, if there is a cross-database operation, and the associated library is not selected at the same time, the rollback will fail; full- normal rollback mode, the backup and binlog of the entire instance will be imported, at a slower rate. +* `databases` - (Optional, List, ForceNew) The database information to be archived, indicating that the entire database is archived. +* `tables` - (Optional, List, ForceNew) The database table information to be rolled back, indicating that the file is rolled back by table. + +The `databases` object supports the following: + +* `database_name` - (Required, String) The original database name before rollback. +* `new_database_name` - (Required, String) The new database name after rollback. + +The `table` object supports the following: + +* `new_table_name` - (Required, String) New database table name after rollback. +* `table_name` - (Required, String) The original database table name before rollback. + +The `tables` object supports the following: + +* `database` - (Required, String) Database name. +* `table` - (Required, List) Database table details. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_rollback_stop.html.markdown b/config/docs/r/mysql_rollback_stop.html.markdown new file mode 100644 index 0000000..d636692 --- /dev/null +++ b/config/docs/r/mysql_rollback_stop.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_rollback_stop" +sidebar_current: "docs-tencentcloud-resource-mysql_rollback_stop" +description: |- + Provides a resource to create a mysql rollback_stop +--- + +# tencentcloud_mysql_rollback_stop + +Provides a resource to create a mysql rollback_stop + +## Example Usage + +### Revoke the ongoing rollback task of the instance + +```hcl +resource "tencentcloud_mysql_rollback_stop" "example" { + instance_id = "cdb-fitq5t9h" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Cloud database instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_security_groups_attachment.html.markdown b/config/docs/r/mysql_security_groups_attachment.html.markdown new file mode 100644 index 0000000..f1fa05a --- /dev/null +++ b/config/docs/r/mysql_security_groups_attachment.html.markdown @@ -0,0 +1,93 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_security_groups_attachment" +sidebar_current: "docs-tencentcloud-resource-mysql_security_groups_attachment" +description: |- + Provides a resource to create a mysql security_groups_attachment +--- + +# tencentcloud_mysql_security_groups_attachment + +Provides a resource to create a mysql security_groups_attachment + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_security_groups_attachment" "example" { + security_group_id = tencentcloud_security_group.security_group.id + instance_id = tencentcloud_mysql_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) The id of instance. +* `security_group_id` - (Required, String, ForceNew) The ID of security group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mysql security_groups_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_mysql_security_groups_attachment.security_groups_attachment securityGroupId#instanceId +``` + diff --git a/config/docs/r/mysql_switch_for_upgrade.html.markdown b/config/docs/r/mysql_switch_for_upgrade.html.markdown new file mode 100644 index 0000000..054c007 --- /dev/null +++ b/config/docs/r/mysql_switch_for_upgrade.html.markdown @@ -0,0 +1,83 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_switch_for_upgrade" +sidebar_current: "docs-tencentcloud-resource-mysql_switch_for_upgrade" +description: |- + Provides a resource to create a mysql switch_for_upgrade +--- + +# tencentcloud_mysql_switch_for_upgrade + +Provides a resource to create a mysql switch_for_upgrade + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_switch_for_upgrade" "example" { + instance_id = tencentcloud_mysql_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_switch_master_slave_operation.html.markdown b/config/docs/r/mysql_switch_master_slave_operation.html.markdown new file mode 100644 index 0000000..5fb6351 --- /dev/null +++ b/config/docs/r/mysql_switch_master_slave_operation.html.markdown @@ -0,0 +1,90 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_switch_master_slave_operation" +sidebar_current: "docs-tencentcloud-resource-mysql_switch_master_slave_operation" +description: |- + Provides a resource to create a mysql switch_master_slave_operation +--- + +# tencentcloud_mysql_switch_master_slave_operation + +Provides a resource to create a mysql switch_master_slave_operation + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 1 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + first_slave_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_switch_master_slave_operation" "example" { + instance_id = tencentcloud_mysql_instance.example.id + dst_slave = "second" + force_switch = true + wait_switch = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) instance id. +* `dst_slave` - (Optional, String, ForceNew) target instance. Possible values: `first` - first standby; `second` - second standby. The default value is `first`, and only multi-AZ instances support setting it to `second`. +* `force_switch` - (Optional, Bool, ForceNew) Whether to force switch. Default is False. Note that if you set the mandatory switch to True, there is a risk of data loss on the instance, so use it with caution. +* `wait_switch` - (Optional, Bool, ForceNew) Whether to switch within the time window. The default is False, i.e. do not switch within the time window. Note that if the ForceSwitch parameter is set to True, this parameter will not take effect. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/mysql_time_window.html.markdown b/config/docs/r/mysql_time_window.html.markdown new file mode 100644 index 0000000..8304ac6 --- /dev/null +++ b/config/docs/r/mysql_time_window.html.markdown @@ -0,0 +1,106 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_time_window" +sidebar_current: "docs-tencentcloud-resource-mysql_time_window" +description: |- + Provides a resource to create a mysql time_window +--- + +# tencentcloud_mysql_time_window + +Provides a resource to create a mysql time_window + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_time_window" "example" { + instance_id = tencentcloud_mysql_instance.example.id + max_delay_time = 10 + time_ranges = [ + "01:00-02:01" + ] + weekdays = [ + "friday", + "monday", + "saturday", + "thursday", + "tuesday", + "wednesday", + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID in the format of cdb-c1nl9rpv or cdbro-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. +* `time_ranges` - (Required, Set: [`String`]) Time period available for maintenance after modification in the format of 10:00-12:00. Each period lasts from half an hour to three hours, with the start time and end time aligned by half-hour. Up to two time periods can be set. Start and end time range: [00:00, 24:00]. +* `max_delay_time` - (Optional, Int) Data delay threshold. It takes effect only for source instance and disaster recovery instance. Default value: 10. +* `weekdays` - (Optional, Set: [`String`]) Specifies for which day to modify the time period. Value range: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. If it is not specified or is left blank, the time period will be modified for every day by default. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +mysql time_window can be imported using the id, e.g. + +``` +terraform import tencentcloud_mysql_time_window.time_window instanceId +``` + diff --git a/config/docs/r/mysql_verify_root_account.html.markdown b/config/docs/r/mysql_verify_root_account.html.markdown new file mode 100644 index 0000000..c4d3d51 --- /dev/null +++ b/config/docs/r/mysql_verify_root_account.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "TencentDB for MySQL(cdb)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_mysql_verify_root_account" +sidebar_current: "docs-tencentcloud-resource-mysql_verify_root_account" +description: |- + Provides a resource to create a mysql verify_root_account +--- + +# tencentcloud_mysql_verify_root_account + +Provides a resource to create a mysql verify_root_account + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-mysql" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-mysql" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-mysql" + description = "mysql test" +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 1 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + first_slave_zone = data.tencentcloud_availability_zones_by_product.zones.zones.1.name + slave_sync_mode = 1 + instance_name = "tf-example-mysql" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + name = "test" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_mysql_verify_root_account" "example" { + instance_id = tencentcloud_mysql_instance.example.id + password = "Qwer@234" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) The instance ID, in the format: cdb-c1nl9rpv, is the same as the instance ID displayed on the cloud database console page. +* `password` - (Required, String, ForceNew) The password of the ROOT account of the instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/nat_gateway.html.markdown b/config/docs/r/nat_gateway.html.markdown new file mode 100644 index 0000000..df75fda --- /dev/null +++ b/config/docs/r/nat_gateway.html.markdown @@ -0,0 +1,113 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_nat_gateway" +sidebar_current: "docs-tencentcloud-resource-nat_gateway" +description: |- + Provides a resource to create a NAT gateway. +--- + +# tencentcloud_nat_gateway + +Provides a resource to create a NAT gateway. + +## Example Usage + +### Create a traditional NAT gateway. + +```hcl +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_nat_gateway_vpc" +} + +resource "tencentcloud_eip" "eip_example1" { + name = "tf_nat_gateway_eip1" +} + +resource "tencentcloud_eip" "eip_example2" { + name = "tf_nat_gateway_eip2" +} + +resource "tencentcloud_nat_gateway" "example" { + name = "tf_example_nat_gateway" + vpc_id = tencentcloud_vpc.vpc.id + bandwidth = 100 + max_concurrent = 1000000 + assigned_eip_set = [ + tencentcloud_eip.eip_example1.public_ip, + tencentcloud_eip.eip_example2.public_ip, + ] + tags = { + tf_tag_key = "tf_tag_value" + } +} +``` + +### Create a standard NAT gateway. + +```hcl +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_nat_gateway_vpc" +} + +resource "tencentcloud_eip" "eip_example1" { + name = "tf_nat_gateway_eip1" +} + +resource "tencentcloud_eip" "eip_example2" { + name = "tf_nat_gateway_eip2" +} + +resource "tencentcloud_nat_gateway" "example" { + name = "tf_example_nat_gateway" + vpc_id = tencentcloud_vpc.vpc.id + assigned_eip_set = [ + tencentcloud_eip.eip_example1.public_ip, + tencentcloud_eip.eip_example2.public_ip, + ] + nat_product_version = 2 + tags = { + tf_tag_key = "tf_tag_value" + } + lifecycle { + ignore_changes = [ + // standard nat will set default values for bandwidth and max_concurrent + bandwidth, + max_concurrent, + ] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `assigned_eip_set` - (Required, Set: [`String`]) EIP IP address set bound to the gateway. The value of at least 1 and at most 10. +* `name` - (Required, String) Name of the NAT gateway. +* `vpc_id` - (Required, String, ForceNew) ID of the vpc. +* `bandwidth` - (Optional, Int) The maximum public network output bandwidth of NAT gateway (unit: Mbps). Valid values: `20`, `50`, `100`, `200`, `500`, `1000`, `2000`, `5000`. Default is 100. +* `max_concurrent` - (Optional, Int) The upper limit of concurrent connection of NAT gateway. Valid values: `1000000`, `3000000`, `10000000`. Default is `1000000`. +* `nat_product_version` - (Optional, Int, ForceNew) 1: traditional NAT, 2: standard NAT, default value is 1. +* `subnet_id` - (Optional, String, ForceNew) Subnet of NAT. +* `tags` - (Optional, Map) The available tags within this NAT gateway. +* `zone` - (Optional, String) The availability zone, such as `ap-guangzhou-3`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `created_time` - Create time of the NAT gateway. + + +## Import + +NAT gateway can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_nat_gateway.foo nat-1asg3t63 +``` + diff --git a/config/docs/r/nat_gateway_snat.html.markdown b/config/docs/r/nat_gateway_snat.html.markdown new file mode 100644 index 0000000..334c095 --- /dev/null +++ b/config/docs/r/nat_gateway_snat.html.markdown @@ -0,0 +1,162 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_nat_gateway_snat" +sidebar_current: "docs-tencentcloud-resource-nat_gateway_snat" +description: |- + Provides a resource to create a NAT Gateway SNat rule. +--- + +# tencentcloud_nat_gateway_snat + +Provides a resource to create a NAT Gateway SNat rule. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "nat" +} + +data "tencentcloud_images" "image" { + os_name = "centos" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones_by_product.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + route_table_id = tencentcloud_route_table.route_table.id +} + +resource "tencentcloud_eip" "eip_example1" { + name = "eip_example1" +} + +resource "tencentcloud_eip" "eip_example2" { + name = "eip_example2" +} + +# Create NAT Gateway +resource "tencentcloud_nat_gateway" "my_nat" { + vpc_id = tencentcloud_vpc.vpc.id + name = "tf_example_nat_gateway" + max_concurrent = 3000000 + bandwidth = 500 + + assigned_eip_set = [ + tencentcloud_eip.eip_example1.public_ip, + tencentcloud_eip.eip_example2.public_ip, + ] +} + +# Create route_table and entry +resource "tencentcloud_route_table" "route_table" { + vpc_id = tencentcloud_vpc.vpc.id + name = "tf_example" +} + +resource "tencentcloud_route_table_entry" "route_entry" { + route_table_id = tencentcloud_route_table.route_table.id + destination_cidr_block = "10.0.0.0/8" + next_type = "NAT" + next_hub = tencentcloud_nat_gateway.my_nat.id +} + +# Subnet Nat gateway snat +resource "tencentcloud_nat_gateway_snat" "subnet_snat" { + nat_gateway_id = tencentcloud_nat_gateway.my_nat.id + resource_type = "SUBNET" + subnet_id = tencentcloud_subnet.subnet.id + subnet_cidr_block = tencentcloud_subnet.subnet.cidr_block + description = "terraform test" + public_ip_addr = [ + tencentcloud_eip.eip_example1.public_ip, + tencentcloud_eip.eip_example2.public_ip, + ] +} + +# Create instance +resource "tencentcloud_instance" "example" { + instance_name = "tf_example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + image_id = data.tencentcloud_images.image.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "user" + project_id = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +# NetWorkInterface Nat gateway snat +resource "tencentcloud_nat_gateway_snat" "my_instance_snat" { + nat_gateway_id = tencentcloud_nat_gateway.my_nat.id + resource_type = "NETWORKINTERFACE" + instance_id = tencentcloud_instance.example.id + instance_private_ip_addr = tencentcloud_instance.example.private_ip + description = "terraform test" + public_ip_addr = [ + tencentcloud_eip.eip_example1.public_ip, + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `description` - (Required, String) Description. +* `nat_gateway_id` - (Required, String, ForceNew) NAT gateway ID. +* `public_ip_addr` - (Required, List: [`String`]) Elastic IP address pool. +* `resource_type` - (Required, String, ForceNew) Resource type. Valid values: SUBNET, NETWORKINTERFACE. +* `instance_id` - (Optional, String, ForceNew) Instance ID, required when `resource_type` is NETWORKINTERFACE. +* `instance_private_ip_addr` - (Optional, String, ForceNew) Private IPs of the instance's primary ENI, required when `resource_type` is NETWORKINTERFACE. +* `subnet_cidr_block` - (Optional, String, ForceNew) The IPv4 CIDR of the subnet, required when `resource_type` is SUBNET. +* `subnet_id` - (Optional, String, ForceNew) Subnet instance ID, required when `resource_type` is SUBNET. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time. +* `snat_id` - SNAT rule ID. + + +## Import + +VPN gateway route can be imported using the id, the id format must be '{nat_gateway_id}#{resource_id}', resource_id range `subnet_id`, `instance_id`, e.g. + +SUBNET SNat +``` +$ terraform import tencentcloud_nat_gateway_snat.my_snat nat-r4ip1cwt#subnet-2ap74y35 +``` + +NETWORKINTERFACT SNat +``` +$ terraform import tencentcloud_nat_gateway_snat.my_snat nat-r4ip1cwt#ins-da412f5a +``` + diff --git a/config/docs/r/nat_refresh_nat_dc_route.html.markdown b/config/docs/r/nat_refresh_nat_dc_route.html.markdown new file mode 100644 index 0000000..2288ada --- /dev/null +++ b/config/docs/r/nat_refresh_nat_dc_route.html.markdown @@ -0,0 +1,79 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_nat_refresh_nat_dc_route" +sidebar_current: "docs-tencentcloud-resource-nat_refresh_nat_dc_route" +description: |- + Provides a resource to create a vpc refresh_nat_dc_route +--- + +# tencentcloud_nat_refresh_nat_dc_route + +Provides a resource to create a vpc refresh_nat_dc_route + +## Example Usage + +### is True + +```hcl +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_eip" "eip_example" { + name = "eip_example" +} + +resource "tencentcloud_nat_gateway" "nat" { + vpc_id = tencentcloud_vpc.vpc.id + name = "tf_example_nat_gateway" + max_concurrent = 3000000 + bandwidth = 500 + + assigned_eip_set = [ + tencentcloud_eip.eip_example.public_ip, + ] +} + +resource "tencentcloud_nat_refresh_nat_dc_route" "refresh_nat_dc_route" { + nat_gateway_id = tencentcloud_nat_gateway.nat.id + vpc_id = tencentcloud_vpc.vpc.id + dry_run = true +} +``` + +### is False + +```hcl +resource "tencentcloud_nat_refresh_nat_dc_route" "refresh_nat_dc_route" { + nat_gateway_id = tencentcloud_nat_gateway.nat.id + vpc_id = tencentcloud_vpc.vpc.id + dry_run = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dry_run` - (Required, Bool, ForceNew) Whether to pre-refresh, valid values: True:yes, False:no. +* `nat_gateway_id` - (Required, String, ForceNew) Unique identifier of Nat Gateway. +* `vpc_id` - (Required, String, ForceNew) Unique identifier of Vpc. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc refresh_nat_dc_route can be imported using the id, e.g. + +``` +terraform import tencentcloud_nat_refresh_nat_dc_route.refresh_nat_dc_route vpc_id#nat_gateway_id +``` + diff --git a/config/docs/r/oceanus_job.html.markdown b/config/docs/r/oceanus_job.html.markdown new file mode 100644 index 0000000..4f5e042 --- /dev/null +++ b/config/docs/r/oceanus_job.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_job" +sidebar_current: "docs-tencentcloud-resource-oceanus_job" +description: |- + Provides a resource to create a oceanus job +--- + +# tencentcloud_oceanus_job + +Provides a resource to create a oceanus job + +## Example Usage + +```hcl +resource "tencentcloud_oceanus_job" "example" { + name = "tf_example_job" + job_type = 1 + cluster_type = 2 + cluster_id = "cluster-1kcd524h" + cu_mem = 4 + remark = "remark." + folder_id = "folder-7ctl246z" + flink_version = "Flink-1.16" + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_type` - (Required, Int) The type of the cluster. 1 indicates shared cluster, and 2 indicates exclusive cluster. +* `job_type` - (Required, Int) The type of the job. 1 indicates SQL job, and 2 indicates JAR job. +* `name` - (Required, String) The name of the job. It can be composed of Chinese, English, numbers, hyphens (-), underscores (_), and periods (.), and the length cannot exceed 50 characters. Note that the job name cannot be the same as an existing job. +* `cluster_id` - (Optional, String) When ClusterType=2, it is required to specify the ID of the exclusive cluster to which the job is submitted. +* `cu_mem` - (Optional, Int) Set the memory specification of each CU, in GB. It supports 2, 4, 8, and 16 (which needs to apply for the whitelist before use). The default is 4, that is, 1 CU corresponds to 4 GB of running memory. +* `flink_version` - (Optional, String) The Flink version that the job runs. +* `folder_id` - (Optional, String) The folder ID to which the job name belongs. The root directory is root. +* `remark` - (Optional, String) The remark information of the job. It can be set arbitrarily. +* `work_space_id` - (Optional, String) The workspace SerialId. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/oceanus_job_config.html.markdown b/config/docs/r/oceanus_job_config.html.markdown new file mode 100644 index 0000000..e5f7ff6 --- /dev/null +++ b/config/docs/r/oceanus_job_config.html.markdown @@ -0,0 +1,177 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_job_config" +sidebar_current: "docs-tencentcloud-resource-oceanus_job_config" +description: |- + Provides a resource to create a oceanus job_config +--- + +# tencentcloud_oceanus_job_config + +Provides a resource to create a oceanus job_config + +## Example Usage + +### is 2 + +```hcl +resource "tencentcloud_oceanus_job_config" "example" { + job_id = "cql-4xwincyn" + entrypoint_class = "tf_example" + program_args = "--conf Key=Value" + remark = "remark." + resource_refs { + resource_id = "resource-q22ntswy" + version = 1 + type = 1 + } + default_parallelism = 1 + properties { + key = "pipeline.max-parallelism" + value = "2048" + } + log_collect = true + job_manager_spec = "1" + task_manager_spec = "1" + cls_logset_id = "cd9adbb5-6b7d-48d2-9870-77658959c7a4" + cls_topic_id = "cec4c2f1-0bf3-470e-b1a5-b1c451e88838" + log_collect_type = 2 + work_space_id = "space-2idq8wbr" + log_level = "INFO" + auto_recover = 1 + expert_mode_on = false +} +``` + +### is 3 + +```hcl +resource "tencentcloud_oceanus_job_config" "example" { + job_id = "cql-4xwincyn" + entrypoint_class = "tf_example" + program_args = "--conf Key=Value" + remark = "remark." + resource_refs { + resource_id = "resource-q22ntswy" + version = 1 + type = 1 + } + default_parallelism = 1 + properties { + key = "pipeline.max-parallelism" + value = "2048" + } + log_collect = true + job_manager_spec = "1" + task_manager_spec = "1" + cls_logset_id = "cd9adbb5-6b7d-48d2-9870-77658959c7a4" + cls_topic_id = "cec4c2f1-0bf3-470e-b1a5-b1c451e88838" + log_collect_type = 3 + work_space_id = "space-2idq8wbr" + log_level = "INFO" + auto_recover = 1 + expert_mode_on = false + cos_bucket = "autotest-gz-bucket-1257058945" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String) Job ID. +* `auto_recover` - (Optional, Int) Oceanus platform job recovery switch 1: on -1: off. +* `clazz_levels` - (Optional, List) Class log level. +* `cls_logset_id` - (Optional, String) CLS logset ID. +* `cls_topic_id` - (Optional, String) CLS log topic ID. +* `cos_bucket` - (Optional, String) COS storage bucket name used by the job. +* `default_parallelism` - (Optional, Int) Job default parallelism. +* `entrypoint_class` - (Optional, String) Main class. +* `expert_mode_configuration` - (Optional, List) Expert mode configuration. +* `expert_mode_on` - (Optional, Bool) Whether to enable expert mode. +* `job_manager_spec` - (Optional, Float64) JobManager specification. +* `log_collect_type` - (Optional, Int) Log collection type 2:CLS; 3:COS. +* `log_collect` - (Optional, Bool) Whether to collect job logs. +* `log_level` - (Optional, String) Log level. +* `program_args` - (Optional, String) Main class parameters. +* `properties` - (Optional, List) System parameters. +* `python_version` - (Optional, String) Python version used by the pyflink job at runtime. +* `remark` - (Optional, String) Remarks. +* `resource_refs` - (Optional, List) Resource reference array. +* `task_manager_spec` - (Optional, Float64) TaskManager specification. +* `work_space_id` - (Optional, String) Workspace SerialId. + +The `clazz_levels` object supports the following: + +* `clazz` - (Required, String) Java class full pathNote: This field may return null, indicating that no valid value can be obtained. +* `level` - (Required, String) Log level TRACE, DEBUG, INFO, WARN, ERRORNote: This field may return null, indicating that no valid value can be obtained. + +The `configuration` object supports the following: + +* `key` - (Required, String) System configuration key. +* `value` - (Required, String) System configuration value. + +The `edges` object supports the following: + +* `source` - (Required, Int) Starting node ID of the edgeNote: This field may return null, indicating that no valid value can be obtained. +* `target` - (Required, Int) Target node ID of the edgeNote: This field may return null, indicating that no valid value can be obtained. + +The `expert_mode_configuration` object supports the following: + +* `job_graph` - (Optional, List) Job graphNote: This field may return null, indicating that no valid value can be obtained. +* `node_config` - (Optional, List) Node configurationNote: This field may return null, indicating that no valid value can be obtained. +* `slot_sharing_groups` - (Optional, List) Slot sharing groupsNote: This field may return null, indicating that no valid value can be obtained. + +The `job_graph` object supports the following: + +* `edges` - (Optional, List) Edge set of the running graphNote: This field may return null, indicating that no valid value can be obtained. +* `nodes` - (Optional, List) Point set of the running graphNote: This field may return null, indicating that no valid value can be obtained. + +The `node_config` object supports the following: + +* `id` - (Required, Int) Node IDNote: This field may return null, indicating that no valid value can be obtained. +* `configuration` - (Optional, List) Configuration propertiesNote: This field may return null, indicating that no valid value can be obtained. +* `parallelism` - (Optional, Int) Node parallelismNote: This field may return null, indicating that no valid value can be obtained. +* `slot_sharing_group` - (Optional, String) Slot sharing groupNote: This field may return null, indicating that no valid value can be obtained. +* `state_ttl` - (Optional, String) State TTL configuration of the node, separated by semicolonsNote: This field may return null, indicating that no valid value can be obtained. + +The `nodes` object supports the following: + +* `description` - (Required, String) Node descriptionNote: This field may return null, indicating that no valid value can be obtained. +* `id` - (Required, Int) Node IDNote: This field may return null, indicating that no valid value can be obtained. +* `name` - (Required, String) Node nameNote: This field may return null, indicating that no valid value can be obtained. +* `parallelism` - (Required, Int) Node parallelismNote: This field may return null, indicating that no valid value can be obtained. + +The `properties` object supports the following: + +* `key` - (Required, String) System configuration key. +* `value` - (Required, String) System configuration value. + +The `resource_refs` object supports the following: + +* `resource_id` - (Required, String) Resource ID. +* `type` - (Required, Int) Reference resource type, for example, setting the main resource to 1 represents the jar package where the main class is located. +* `version` - (Required, Int) Resource version ID, -1 indicates the latest version. + +The `slot_sharing_groups` object supports the following: + +* `name` - (Required, String) Name of the SlotSharingGroupNote: This field may return null, indicating that no valid value can be obtained. +* `spec` - (Required, List) Specification of the SlotSharingGroupNote: This field may return null, indicating that no valid value can be obtained. +* `description` - (Optional, String) Description of the SlotSharingGroupNote: This field may return null, indicating that no valid value can be obtained. + +The `spec` object supports the following: + +* `cpu` - (Required, Float64) Applicable CPUNote: This field may return null, indicating that no valid value can be obtained. +* `heap_memory` - (Required, String) Default is b, supporting units are b, kb, mb, gbNote: This field may return null, indicating that no valid value can be obtained. +* `managed_memory` - (Optional, String) Default is b, supporting units are b, kb, mb, gbNote: This field may return null, indicating that no valid value can be obtained. +* `off_heap_memory` - (Optional, String) Default is b, supporting units are b, kb, mb, gbNote: This field may return null, indicating that no valid value can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/oceanus_job_copy.html.markdown b/config/docs/r/oceanus_job_copy.html.markdown new file mode 100644 index 0000000..d077f84 --- /dev/null +++ b/config/docs/r/oceanus_job_copy.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_job_copy" +sidebar_current: "docs-tencentcloud-resource-oceanus_job_copy" +description: |- + Provides a resource to create a oceanus job_copy +--- + +# tencentcloud_oceanus_job_copy + +Provides a resource to create a oceanus job_copy + +## Example Usage + +```hcl +resource "tencentcloud_oceanus_job_copy" "example" { + source_id = "cql-0nob2hx8" + target_cluster_id = "cluster-1kcd524h" + source_name = "keep_jar" + target_name = "tf_copy_example" + target_folder_id = "folder-7ctl246z" + job_type = 2 + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `source_id` - (Required, String, ForceNew) The serial ID of the job to be copied. +* `target_cluster_id` - (Required, String, ForceNew) The cluster serial ID of the target cluster. +* `job_type` - (Optional, Int, ForceNew) The type of the source job. +* `source_name` - (Optional, String, ForceNew) The name of the job to be copied. +* `target_folder_id` - (Optional, String, ForceNew) The directory ID of the new job. +* `target_name` - (Optional, String, ForceNew) The name of the new job. +* `work_space_id` - (Optional, String, ForceNew) Workspace SerialId. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `job_id` - Copy Job ID. + + diff --git a/config/docs/r/oceanus_resource.html.markdown b/config/docs/r/oceanus_resource.html.markdown new file mode 100644 index 0000000..15d70b7 --- /dev/null +++ b/config/docs/r/oceanus_resource.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_resource" +sidebar_current: "docs-tencentcloud-resource-oceanus_resource" +description: |- + Provides a resource to create a oceanus resource +--- + +# tencentcloud_oceanus_resource + +Provides a resource to create a oceanus resource + +## Example Usage + +```hcl +resource "tencentcloud_oceanus_resource" "example" { + resource_loc { + storage_type = 1 + param { + bucket = "keep-terraform-1257058945" + path = "OceanusResource/junit-4.13.2.jar" + region = "ap-guangzhou" + } + } + + resource_type = 1 + remark = "remark." + name = "tf_example" + resource_config_remark = "config remark." + folder_id = "folder-7ctl246z" + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_loc` - (Required, List) Resource location. +* `resource_type` - (Required, Int) Resource type, only support JAR now, value is 1. +* `folder_id` - (Optional, String) Folder id. +* `name` - (Optional, String) Resource name. +* `remark` - (Optional, String) Resource description. +* `resource_config_remark` - (Optional, String) Resource version description. +* `work_space_id` - (Optional, String) Workspace serialId. + +The `param` object supports the following: + +* `bucket` - (Required, String) Resource bucket. +* `path` - (Required, String) Resource path. +* `region` - (Optional, String) Resource region, if not set, use resource region, note: this field may return null, indicating that no valid values can be obtained. + +The `resource_loc` object supports the following: + +* `param` - (Required, List) Json to describe resource location. +* `storage_type` - (Required, Int) The available storage types for resource location are currently limited to 1:COS. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `resource_id` - Resource ID. +* `version` - Resource Version. + + diff --git a/config/docs/r/oceanus_resource_config.html.markdown b/config/docs/r/oceanus_resource_config.html.markdown new file mode 100644 index 0000000..41708b5 --- /dev/null +++ b/config/docs/r/oceanus_resource_config.html.markdown @@ -0,0 +1,78 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_resource_config" +sidebar_current: "docs-tencentcloud-resource-oceanus_resource_config" +description: |- + Provides a resource to create a oceanus resource_config +--- + +# tencentcloud_oceanus_resource_config + +Provides a resource to create a oceanus resource_config + +## Example Usage + +```hcl +resource "tencentcloud_oceanus_resource" "example" { + resource_loc { + storage_type = 1 + param { + bucket = "keep-terraform-1257058945" + path = "OceanusResource/junit-4.13.1.jar" + region = "ap-guangzhou" + } + } + + resource_type = 1 + remark = "remark." + name = "tf_example" + resource_config_remark = "config remark." + folder_id = "folder-7ctl246z" + work_space_id = "space-2idq8wbr" +} + +resource "tencentcloud_oceanus_resource_config" "example" { + resource_id = tencentcloud_oceanus_resource.example.resource_id + resource_loc { + storage_type = 1 + param { + bucket = "keep-terraform-1257058945" + path = "OceanusResource/junit-4.13.2.jar" + region = "ap-guangzhou" + } + } + + remark = "config remark." + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource_id` - (Required, String) Resource ID. +* `resource_loc` - (Required, List) Resource location. +* `remark` - (Optional, String) Resource description. +* `work_space_id` - (Optional, String) Workspace SerialId. + +The `param` object supports the following: + +* `bucket` - (Required, String) Resource bucket. +* `path` - (Required, String) Resource path. +* `region` - (Optional, String) Resource region, if not set, use resource region, note: this field may return null, indicating that no valid values can be obtained. + +The `resource_loc` object supports the following: + +* `param` - (Required, List) Json to describe resource location. +* `storage_type` - (Required, Int) The available storage types for resource location are currently limited to 1:COS. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `version` - Resource Config Version. + + diff --git a/config/docs/r/oceanus_run_job.html.markdown b/config/docs/r/oceanus_run_job.html.markdown new file mode 100644 index 0000000..7d5f229 --- /dev/null +++ b/config/docs/r/oceanus_run_job.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_run_job" +sidebar_current: "docs-tencentcloud-resource-oceanus_run_job" +description: |- + Provides a resource to create a oceanus run_job +--- + +# tencentcloud_oceanus_run_job + +Provides a resource to create a oceanus run_job + +## Example Usage + +```hcl +resource "tencentcloud_oceanus_run_job" "example" { + run_job_descriptions { + job_id = "cql-4xwincyn" + run_type = 1 + start_mode = "LATEST" + job_config_version = 10 + use_old_system_connector = false + } + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `run_job_descriptions` - (Required, List, ForceNew) The description information for batch job startup. +* `work_space_id` - (Optional, String, ForceNew) Workspace SerialId. + +The `run_job_descriptions` object supports the following: + +* `job_id` - (Required, String) Job ID. +* `run_type` - (Required, Int) The type of the run. 1 indicates start, and 2 indicates resume. +* `custom_timestamp` - (Optional, Int) Custom timestamp. +* `job_config_version` - (Optional, Int) A certain version of the current job(Not passed by default as a non-draft job version). +* `savepoint_id` - (Optional, String) Savepoint ID. +* `savepoint_path` - (Optional, String) Savepoint path. +* `start_mode` - (Optional, String) Compatible with the startup parameters of the old SQL type job: specify the start time point of data source consumption (recommended to pass the value)Ensure that the parameter is LATEST, EARLIEST, T+Timestamp (example: T1557394288000). +* `use_old_system_connector` - (Optional, Bool) Use the historical version of the system dependency. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/oceanus_stop_job.html.markdown b/config/docs/r/oceanus_stop_job.html.markdown new file mode 100644 index 0000000..a8bc2a2 --- /dev/null +++ b/config/docs/r/oceanus_stop_job.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_stop_job" +sidebar_current: "docs-tencentcloud-resource-oceanus_stop_job" +description: |- + Provides a resource to create a oceanus stop_job +--- + +# tencentcloud_oceanus_stop_job + +Provides a resource to create a oceanus stop_job + +## Example Usage + +```hcl +resource "tencentcloud_oceanus_stop_job" "example" { + stop_job_descriptions { + job_id = "cql-4xwincyn" + stop_type = 1 + } + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `stop_job_descriptions` - (Required, List, ForceNew) The description information for batch job stop. +* `work_space_id` - (Optional, String, ForceNew) Workspace SerialId. + +The `stop_job_descriptions` object supports the following: + +* `job_id` - (Required, String) Job Id. +* `stop_type` - (Required, Int) Stop type,1 stopped 2 paused. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/oceanus_trigger_job_savepoint.html.markdown b/config/docs/r/oceanus_trigger_job_savepoint.html.markdown new file mode 100644 index 0000000..20a863c --- /dev/null +++ b/config/docs/r/oceanus_trigger_job_savepoint.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_trigger_job_savepoint" +sidebar_current: "docs-tencentcloud-resource-oceanus_trigger_job_savepoint" +description: |- + Provides a resource to create a oceanus trigger_job_savepoint +--- + +# tencentcloud_oceanus_trigger_job_savepoint + +Provides a resource to create a oceanus trigger_job_savepoint + +## Example Usage + +```hcl +resource "tencentcloud_oceanus_trigger_job_savepoint" "example" { + job_id = "cql-4xwincyn" + description = "description." + work_space_id = "space-2idq8wbr" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Job SerialId. +* `description` - (Optional, String, ForceNew) Savepoint description. +* `work_space_id` - (Optional, String, ForceNew) Workspace SerialId. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/oceanus_work_space.html.markdown b/config/docs/r/oceanus_work_space.html.markdown new file mode 100644 index 0000000..cc9c72d --- /dev/null +++ b/config/docs/r/oceanus_work_space.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Oceanus" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_oceanus_work_space" +sidebar_current: "docs-tencentcloud-resource-oceanus_work_space" +description: |- + Provides a resource to create a oceanus work_space +--- + +# tencentcloud_oceanus_work_space + +Provides a resource to create a oceanus work_space + +## Example Usage + +```hcl +resource "tencentcloud_oceanus_work_space" "example" { + work_space_name = "tf_example" + description = "example description." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `work_space_name` - (Required, String) Workspace name. +* `description` - (Optional, String) Workspace description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `app_id` - User APPID. +* `create_time` - Create time. +* `creator_uin` - Creator UIN. +* `jobs_count` - Number of Jobs. +* `owner_uin` - Owner UIN. +* `role_auth_count` - Number of workspace members. +* `serial_id` - Serial ID. +* `status` - Workspace status. +* `update_time` - Update time. +* `work_space_id` - Workspace ID. + + +## Import + +oceanus work_space can be imported using the id, e.g. + +``` +terraform import tencentcloud_oceanus_work_space.example space-0dan3yux#tf_example +``` + diff --git a/config/docs/r/organization_instance.html.markdown b/config/docs/r/organization_instance.html.markdown new file mode 100644 index 0000000..787bf95 --- /dev/null +++ b/config/docs/r/organization_instance.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_instance" +sidebar_current: "docs-tencentcloud-resource-organization_instance" +description: |- + Provides a resource to create a organization organization +--- + +# tencentcloud_organization_instance + +Provides a resource to create a organization organization + +## Example Usage + +```hcl +resource "tencentcloud_organization_instance" "organization" { +} +``` + +## Argument Reference + +The following arguments are supported: + + + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Organize the creation time.Note: This field may return NULL, indicating that the valid value cannot be obtained. +* `host_uin` - Creator Uin.Note: This field may return NULL, indicating that the valid value cannot be obtained. +* `is_allow_quit` - Whether the members are allowed to withdraw.Allow: Allow, not allowed: DENIEDNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `is_assign_manager` - Whether a trusted service administrator.Yes: true, no: falseNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `is_auth_manager` - Whether the real -name subject administrator.Yes: true, no: falseNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `is_manager` - Whether to organize an administrator.Yes: true, no: falseNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `join_time` - Members join time.Note: This field may return NULL, indicating that the valid value cannot be obtained. +* `nick_name` - Creator nickname.Note: This field may return NULL, indicating that the valid value cannot be obtained. +* `org_id` - Enterprise organization ID.Note: This field may return NULL, indicating that the valid value cannot be obtained. +* `org_permission` - List of membership authority of members.Note: This field may return NULL, indicating that the valid value cannot be obtained. + * `id` - Permissions ID. + * `name` - Permission name. +* `org_policy_name` - Strategic name.Note: This field may return NULL, indicating that the valid value cannot be obtained. +* `org_policy_type` - Strategy type.Financial Management: FinancialNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `org_type` - Enterprise organization type.Note: This field may return NULL, indicating that the valid value cannot be obtained. +* `pay_name` - The name of the payment.Note: This field may return NULL, indicating that the valid value cannot be obtained. +* `pay_uin` - UIN on behalf of the payer.Note: This field may return NULL, indicating that the valid value cannot be obtained. +* `root_node_id` - Organize the root node ID.Note: This field may return NULL, indicating that the valid value cannot be obtained. + + +## Import + +organization organization can be imported using the id, e.g. + +``` +terraform import tencentcloud_organization_instance.organization organization_id +``` + diff --git a/config/docs/r/organization_org_identity.html.markdown b/config/docs/r/organization_org_identity.html.markdown new file mode 100644 index 0000000..496a2a9 --- /dev/null +++ b/config/docs/r/organization_org_identity.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_org_identity" +sidebar_current: "docs-tencentcloud-resource-organization_org_identity" +description: |- + Provides a resource to create a organization org_identity +--- + +# tencentcloud_organization_org_identity + +Provides a resource to create a organization org_identity + +## Example Usage + +```hcl +resource "tencentcloud_organization_org_identity" "org_identity" { + identity_alias_name = "example-iac-test" + identity_policy { + policy_id = 1 + policy_name = "AdministratorAccess" + policy_type = 2 + } + description = "iac-test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `identity_alias_name` - (Required, String) Identity name.Supports English letters and numbers, the length cannot exceed 40 characters. +* `identity_policy` - (Required, List) Identity policy list. +* `description` - (Optional, String) Identity description. + +The `identity_policy` object supports the following: + +* `policy_document` - (Optional, String) Customize policy content and follow CAM policy syntax. Valid and required when PolicyType is the 1-custom policy. +* `policy_id` - (Optional, Int) CAM default policy ID. Valid and required when PolicyType is the 2-preset policy. +* `policy_name` - (Optional, String) CAM default policy name. Valid and required when PolicyType is the 2-preset policy. +* `policy_type` - (Optional, Int) Policy type. Value 1-custom policy 2-preset policy; default value 2. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +organization org_identity can be imported using the id, e.g. + +``` +terraform import tencentcloud_organization_org_identity.org_identity org_identity_id +``` + diff --git a/config/docs/r/organization_org_member.html.markdown b/config/docs/r/organization_org_member.html.markdown new file mode 100644 index 0000000..4a63884 --- /dev/null +++ b/config/docs/r/organization_org_member.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_org_member" +sidebar_current: "docs-tencentcloud-resource-organization_org_member" +description: |- + Provides a resource to create a organization org_member +--- + +# tencentcloud_organization_org_member + +Provides a resource to create a organization org_member + +## Example Usage + +```hcl +resource "tencentcloud_organization_org_member" "org_member" { + name = "terraform_test" + node_id = 2003721 + permission_ids = [ + 1, + 2, + 3, + 4, + ] + policy_type = "Financial" + remark = "for terraform test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Member name. +* `node_id` - (Required, Int) Organization node ID. +* `permission_ids` - (Required, Set: [`Int`]) Financial management permission IDs.Valid values:- `1`: View bill.- `2`: Check balance.- `3`: Fund transfer.- `4`: Combine bill.- `5`: Issue an invoice.- `6`: Inherit discount.- `7`: Pay on behalf.value 1,2 is required. +* `policy_type` - (Required, String) Organization policy type.- `Financial`: Financial management policy. +* `pay_uin` - (Optional, String) The uin which is payment account on behalf.When `PermissionIds` contains 7, is required. +* `record_id` - (Optional, Int) Create member record ID.When create failed and needs to be recreated, is required. +* `remark` - (Optional, String) Notes. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Member creation time. +* `is_allow_quit` - Whether to allow member to leave the organization.Valid values:- `Allow`.- `Denied`. +* `member_type` - Member Type.Valid values:- `Invite`: The member is invited.- `Create`: The member is created. +* `node_name` - Organization node name. +* `org_permission` - Financial management permissions. + * `id` - Permissions ID. + * `name` - Permissions name. +* `org_policy_name` - Organization policy name. +* `pay_name` - The member name which is payment account on behalf. +* `update_time` - Member update time. + + +## Import + +organization org_member can be imported using the id, e.g. +``` +$ terraform import tencentcloud_organization_org_member.org_member orgMember_id +``` + diff --git a/config/docs/r/organization_org_member_auth_identity_attachment.html.markdown b/config/docs/r/organization_org_member_auth_identity_attachment.html.markdown new file mode 100644 index 0000000..e0a5ea0 --- /dev/null +++ b/config/docs/r/organization_org_member_auth_identity_attachment.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_org_member_auth_identity_attachment" +sidebar_current: "docs-tencentcloud-resource-organization_org_member_auth_identity_attachment" +description: |- + Provides a resource to create a organization org_member_auth_identity +--- + +# tencentcloud_organization_org_member_auth_identity_attachment + +Provides a resource to create a organization org_member_auth_identity + +## Example Usage + +```hcl +resource "tencentcloud_organization_org_member_auth_identity_attachment" "org_member_auth_identity" { + member_uin = 100033704327 + identity_ids = [1657] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `identity_ids` - (Required, Set: [`Int`], ForceNew) Identity Id list. Up to 5. +* `member_uin` - (Required, Int, ForceNew) Member Uin. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +organization org_member_auth_identity can be imported using the id, e.g. + +``` +terraform import tencentcloud_organization_org_member_auth_identity.org_member_auth_identity org_member_auth_identity_id +``` + diff --git a/config/docs/r/organization_org_member_email.html.markdown b/config/docs/r/organization_org_member_email.html.markdown new file mode 100644 index 0000000..69a2e92 --- /dev/null +++ b/config/docs/r/organization_org_member_email.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_org_member_email" +sidebar_current: "docs-tencentcloud-resource-organization_org_member_email" +description: |- + Provides a resource to create a organization org_member_email +--- + +# tencentcloud_organization_org_member_email + +Provides a resource to create a organization org_member_email + +## Example Usage + +```hcl +resource "tencentcloud_organization_org_member_email" "org_member_email" { + member_uin = 100033704327 + email = "iac-example@qq.com" + country_code = "86" + phone = "12345678901" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `country_code` - (Required, String) International region. +* `email` - (Required, String) Email address. +* `member_uin` - (Required, Int) Member Uin. +* `phone` - (Required, String) Phone number. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `apply_time` - Application timeNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `bind_id` - Binding IDNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `bind_status` - Binding status is not binding: unbound, to be activated: value, successful binding: success, binding failure: failedNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `bind_time` - Binding timeNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `description` - FailedNote: This field may return NULL, indicating that the valid value cannot be obtained. +* `phone_bind` - Safe mobile phone binding state is not bound: 0, has been binded: 1Note: This field may return NULL, indicating that the valid value cannot be obtained. + + +## Import + +organization org_member_email can be imported using the id, e.g. + +``` +terraform import tencentcloud_organization_org_member_email.org_member_email org_member_email_id +``` + diff --git a/config/docs/r/organization_org_member_policy_attachment.html.markdown b/config/docs/r/organization_org_member_policy_attachment.html.markdown new file mode 100644 index 0000000..ea090f3 --- /dev/null +++ b/config/docs/r/organization_org_member_policy_attachment.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_org_member_policy_attachment" +sidebar_current: "docs-tencentcloud-resource-organization_org_member_policy_attachment" +description: |- + Provides a resource to create a organization org_member_policy_attachment +--- + +# tencentcloud_organization_org_member_policy_attachment + +Provides a resource to create a organization org_member_policy_attachment + +## Example Usage + +```hcl +resource "tencentcloud_organization_org_member_policy_attachment" "org_member_policy_attachment" { + member_uins = [100033905366, 100033905356] + policy_name = "example-iac" + identity_id = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `identity_id` - (Required, Int, ForceNew) Organization identity ID. +* `member_uins` - (Required, Set: [`Int`], ForceNew) Member Uin list. Up to 10. +* `policy_name` - (Required, String, ForceNew) Policy name.The maximum length is 128 characters, supporting English letters, numbers, and symbols +=,.@_-. +* `description` - (Optional, String, ForceNew) Notes.The maximum length is 128 characters. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +organization org_member_policy_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_organization_org_member_policy_attachment.org_member_policy_attachment org_member_policy_attachment_id +``` + diff --git a/config/docs/r/organization_org_node.html.markdown b/config/docs/r/organization_org_node.html.markdown new file mode 100644 index 0000000..f0c02a7 --- /dev/null +++ b/config/docs/r/organization_org_node.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_org_node" +sidebar_current: "docs-tencentcloud-resource-organization_org_node" +description: |- + Provides a resource to create a organization org_node +--- + +# tencentcloud_organization_org_node + +Provides a resource to create a organization org_node + +## Example Usage + +```hcl +resource "tencentcloud_organization_org_node" "org_node" { + name = "terraform_test" + parent_node_id = 2003721 + remark = "for terraform test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Node name. +* `parent_node_id` - (Required, Int) Parent node ID. +* `remark` - (Optional, String) Notes. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Node creation time. +* `update_time` - Node update time. + + +## Import + +organization org_node can be imported using the id, e.g. +``` +$ terraform import tencentcloud_organization_org_node.org_node orgNode_id +``` + diff --git a/config/docs/r/organization_policy_sub_account_attachment.html.markdown b/config/docs/r/organization_policy_sub_account_attachment.html.markdown new file mode 100644 index 0000000..b2b466c --- /dev/null +++ b/config/docs/r/organization_policy_sub_account_attachment.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_policy_sub_account_attachment" +sidebar_current: "docs-tencentcloud-resource-organization_policy_sub_account_attachment" +description: |- + Provides a resource to create a organization policy_sub_account_attachment +--- + +# tencentcloud_organization_policy_sub_account_attachment + +Provides a resource to create a organization policy_sub_account_attachment + +## Example Usage + +```hcl +resource "tencentcloud_organization_policy_sub_account_attachment" "policy_sub_account_attachment" { + member_uin = 100028582828 + org_sub_account_uin = 100028223737 + policy_id = 144256499 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `member_uin` - (Required, Int, ForceNew) Organization member uin. +* `org_sub_account_uin` - (Required, Int, ForceNew) Organization administrator sub account uin list. +* `policy_id` - (Required, Int, ForceNew) Policy ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time. +* `identity_id` - Manage Identity ID. +* `identity_role_alias_name` - Identity role alias name. +* `identity_role_name` - Identity role name. +* `org_sub_account_name` - Organization administrator sub account name. +* `policy_name` - Policy name. +* `update_time` - Update time. + + +## Import + +organization policy_sub_account_attachment can be imported using the id, e.g. +``` +$ terraform import tencentcloud_organization_policy_sub_account_attachment.policy_sub_account_attachment policyId#memberUin#orgSubAccountUin +``` + diff --git a/config/docs/r/organization_quit_organization_operation.html.markdown b/config/docs/r/organization_quit_organization_operation.html.markdown new file mode 100644 index 0000000..2ad1c8a --- /dev/null +++ b/config/docs/r/organization_quit_organization_operation.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Tencent Cloud Organization (TCO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_organization_quit_organization_operation" +sidebar_current: "docs-tencentcloud-resource-organization_quit_organization_operation" +description: |- + Provides a resource to create a organization quit_organization_operation +--- + +# tencentcloud_organization_quit_organization_operation + +Provides a resource to create a organization quit_organization_operation + +## Example Usage + +```hcl +resource "tencentcloud_organization_quit_organization_operation" "quit_organization_operation" { + org_id = 45155 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `org_id` - (Required, Int, ForceNew) Organization ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +organization quit_organization_operation can be imported using the id, e.g. + +``` +terraform import tencentcloud_organization_quit_organization_operation.quit_organization_operation quit_organization_operation_id +``` + diff --git a/config/docs/r/placement_group.html.markdown b/config/docs/r/placement_group.html.markdown new file mode 100644 index 0000000..894eb55 --- /dev/null +++ b/config/docs/r/placement_group.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_placement_group" +sidebar_current: "docs-tencentcloud-resource-placement_group" +description: |- + Provide a resource to create a placement group. +--- + +# tencentcloud_placement_group + +Provide a resource to create a placement group. + +## Example Usage + +```hcl +resource "tencentcloud_placement_group" "foo" { + name = "test" + type = "HOST" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the placement group, 1-60 characters in length. +* `type` - (Required, String, ForceNew) Type of the placement group. Valid values: `HOST`, `SW` and `RACK`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of the placement group. +* `current_num` - Number of hosts in the placement group. +* `cvm_quota_total` - Maximum number of hosts in the placement group. + + +## Import + +Placement group can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_placement_group.foo ps-ilan8vjf +``` + diff --git a/config/docs/r/postgresql_backup_download_restriction_config.html.markdown b/config/docs/r/postgresql_backup_download_restriction_config.html.markdown new file mode 100644 index 0000000..efff844 --- /dev/null +++ b/config/docs/r/postgresql_backup_download_restriction_config.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_backup_download_restriction_config" +sidebar_current: "docs-tencentcloud-resource-postgresql_backup_download_restriction_config" +description: |- + Provides a resource to create a postgresql backup_download_restriction_config +--- + +# tencentcloud_postgresql_backup_download_restriction_config + +Provides a resource to create a postgresql backup_download_restriction_config + +## Example Usage + +### Unlimit the restriction of the backup file download. + +```hcl +resource "tencentcloud_postgresql_backup_download_restriction_config" "backup_download_restriction_config" { + restriction_type = "NONE" +} +``` + +### Set the download only to allow the intranet downloads. + +```hcl +resource "tencentcloud_postgresql_backup_download_restriction_config" "backup_download_restriction_config" { + restriction_type = "INTRANET" +} +``` + +### Restrict the backup file download by customizing. + +```hcl +resource "tencentcloud_vpc" "pg_vpc" { + name = var.instance_name + cidr_block = var.vpc_cidr +} + +resource "tencentcloud_postgresql_backup_download_restriction_config" "backup_download_restriction_config" { + restriction_type = "CUSTOMIZE" + vpc_restriction_effect = "DENY" + vpc_id_set = [tencentcloud_vpc.pg_vpc2.id] + ip_restriction_effect = "DENY" + ip_set = ["192.168.0.0"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `restriction_type` - (Required, String) Backup file download restriction type: NONE:Unlimited, both internal and external networks can be downloaded. INTRANET:Only intranet downloads are allowed. CUSTOMIZE:Customize the vpc or ip that limits downloads. +* `ip_restriction_effect` - (Optional, String) ip limit Strategy: ALLOW, DENY. +* `ip_set` - (Optional, Set: [`String`]) The list of ips that are allowed or denied to download backup files. +* `vpc_id_set` - (Optional, Set: [`String`]) The list of vpcIds that allow or deny downloading of backup files. +* `vpc_restriction_effect` - (Optional, String) vpc limit Strategy: ALLOW, DENY. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +postgresql backup_download_restriction_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_postgresql_backup_download_restriction_config.backup_download_restriction_config backup_download_restriction_config_id +``` + diff --git a/config/docs/r/postgresql_backup_plan_config.html.markdown b/config/docs/r/postgresql_backup_plan_config.html.markdown new file mode 100644 index 0000000..0957b91 --- /dev/null +++ b/config/docs/r/postgresql_backup_plan_config.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_backup_plan_config" +sidebar_current: "docs-tencentcloud-resource-postgresql_backup_plan_config" +description: |- + Provides a resource to create a postgres backup_plan_config +--- + +# tencentcloud_postgresql_backup_plan_config + +Provides a resource to create a postgres backup_plan_config + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_backup_plan_config" "backup_plan_config" { + db_instance_id = local.pgsql_id + min_backup_start_time = "01:00:00" + max_backup_start_time = "02:00:00" + base_backup_retention_period = 7 + backup_period = ["monday", "wednesday", "friday"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String) instance id. +* `backup_period` - (Optional, Set: [`String`]) Backup cycle, which means on which days each week the instance will be backed up. The parameter value should be the lowercase names of the days of the week. +* `base_backup_retention_period` - (Optional, Int) Backup retention period in days. Value range:3-7. +* `max_backup_start_time` - (Optional, String) The latest time to start a backup. +* `min_backup_start_time` - (Optional, String) The earliest time to start a backup. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +postgres backup_plan_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_postgresql_backup_plan_config.backup_plan_config backup_plan_config_id +``` + diff --git a/config/docs/r/postgresql_base_backup.html.markdown b/config/docs/r/postgresql_base_backup.html.markdown new file mode 100644 index 0000000..b4dfcae --- /dev/null +++ b/config/docs/r/postgresql_base_backup.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_base_backup" +sidebar_current: "docs-tencentcloud-resource-postgresql_base_backup" +description: |- + Provides a resource to create a postgresql base_backup +--- + +# tencentcloud_postgresql_base_backup + +Provides a resource to create a postgresql base_backup + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_base_backup" "base_backup" { + db_instance_id = local.pgsql_id + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String) Instance ID. +* `new_expire_time` - (Optional, String) New expiration time. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `base_backup_id` - Base backup ID. + + diff --git a/config/docs/r/postgresql_clone_db_instance_operation.html.markdown b/config/docs/r/postgresql_clone_db_instance_operation.html.markdown new file mode 100644 index 0000000..a204dce --- /dev/null +++ b/config/docs/r/postgresql_clone_db_instance_operation.html.markdown @@ -0,0 +1,87 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_clone_db_instance_operation" +sidebar_current: "docs-tencentcloud-resource-postgresql_clone_db_instance_operation" +description: |- + Provides a resource to create a postgresql clone_db_instance_operation +--- + +# tencentcloud_postgresql_clone_db_instance_operation + +Provides a resource to create a postgresql clone_db_instance_operation + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_clone_db_instance_operation" "clone_db_instance_operation" { + db_instance_id = local.pgsql_id + spec_code = data.tencentcloud_postgresql_specinfos.foo.list.0.id + storage = data.tencentcloud_postgresql_specinfos.foo.list.0.storage_min + period = 1 + auto_renew_flag = 0 + vpc_id = local.vpc_id + subnet_id = local.subnet_id + name = "tf_test_pg_ins_clone" + instance_charge_type = "POSTPAID_BY_HOUR" + security_group_ids = [local.sg_id] + project_id = 0 + db_node_set { + role = "Primary" + zone = local.pg_az + } + db_node_set { + role = "Standby" + zone = local.pg_az + } + tag_list { + tag_key = "issued_by" + tag_value = "terraform_test" + } + + auto_voucher = 0 + recovery_target_time = "%s" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_renew_flag` - (Required, Int, ForceNew) Renewal flag. Valid values: `0` (manual renewal), `1` (auto-renewal). Default value: `0`. +* `db_instance_id` - (Required, String, ForceNew) ID of the original instance to be cloned. +* `db_node_set` - (Required, List, ForceNew) This parameter is required if you purchase a multi-AZ deployed instance. +* `period` - (Required, Int, ForceNew) Valid period in months of the purchased instance. Valid values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `24`, `36`. This parameter is set to `1` when the pay-as-you-go billing mode is used. +* `spec_code` - (Required, String, ForceNew) Purchasable specification ID, which can be obtained through the `SpecCode` field in the returned value of the `DescribeProductConfig` API. +* `storage` - (Required, Int, ForceNew) Instance storage capacity in GB. +* `subnet_id` - (Required, String, ForceNew) ID of a subnet in the VPC specified by `VpcId`. +* `vpc_id` - (Required, String, ForceNew) VPC ID. +* `activity_id` - (Optional, Int, ForceNew) Campaign ID. +* `auto_voucher` - (Optional, Int, ForceNew) Whether to automatically use vouchers. Valid values: `1` (yes), `0` (no). Default value: `0`. +* `backup_set_id` - (Optional, String, ForceNew) Basic backup set ID. +* `instance_charge_type` - (Optional, String, ForceNew) Instance billing mode. Valid values: `PREPAID` (monthly subscription), `POSTPAID_BY_HOUR` (pay-as-you-go). +* `name` - (Optional, String, ForceNew) Name of the purchased instance. +* `project_id` - (Optional, Int, ForceNew) Project ID. +* `recovery_target_time` - (Optional, String, ForceNew) Restoration point in time. +* `security_group_ids` - (Optional, Set: [`String`], ForceNew) Security group ID. +* `tag_list` - (Optional, List, ForceNew) The information of tags to be bound with the purchased instance. This parameter is left empty by default. +* `voucher_ids` - (Optional, String, ForceNew) Voucher ID list. + +The `db_node_set` object supports the following: + +* `role` - (Required, String) Node type. Valid values:`Primary`;`Standby`. +* `zone` - (Required, String) AZ where the node resides, such as ap-guangzhou-1. + +The `tag_list` object supports the following: + +* `tag_key` - (Required, String) Tag key. +* `tag_value` - (Required, String) Tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/postgresql_delete_log_backup_operation.html.markdown b/config/docs/r/postgresql_delete_log_backup_operation.html.markdown new file mode 100644 index 0000000..70ab88e --- /dev/null +++ b/config/docs/r/postgresql_delete_log_backup_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_delete_log_backup_operation" +sidebar_current: "docs-tencentcloud-resource-postgresql_delete_log_backup_operation" +description: |- + Provides a resource to create a postgresql delete_log_backup_operation +--- + +# tencentcloud_postgresql_delete_log_backup_operation + +Provides a resource to create a postgresql delete_log_backup_operation + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_delete_log_backup_operation" "delete_log_backup_operation" { + db_instance_id = "local.pg_id" + log_backup_id = "local.pg_log_backup_id" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String, ForceNew) Instance ID. +* `log_backup_id` - (Required, String, ForceNew) Log backup ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/postgresql_disisolate_db_instance_operation.html.markdown b/config/docs/r/postgresql_disisolate_db_instance_operation.html.markdown new file mode 100644 index 0000000..b2f94cd --- /dev/null +++ b/config/docs/r/postgresql_disisolate_db_instance_operation.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_disisolate_db_instance_operation" +sidebar_current: "docs-tencentcloud-resource-postgresql_disisolate_db_instance_operation" +description: |- + Provides a resource to create a postgresql disisolate_db_instance_operation +--- + +# tencentcloud_postgresql_disisolate_db_instance_operation + +Provides a resource to create a postgresql disisolate_db_instance_operation + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_disisolate_db_instance_operation" "disisolate_db_instance_operation" { + db_instance_id_set = [local.pgsql_id] + period = 1 + auto_voucher = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id_set` - (Required, Set: [`String`], ForceNew) List of resource IDs. Note that currently you cannot remove multiple instances from isolation at the same time. Only one instance ID can be passed in here. +* `auto_voucher` - (Optional, Bool, ForceNew) Whether to use vouchers. Valid values:true (yes), false (no). Default value:false. +* `period` - (Optional, Int, ForceNew) The valid period (in months) of the monthly-subscribed instance when removing it from isolation. +* `voucher_ids` - (Optional, Set: [`String`], ForceNew) Voucher ID list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/postgresql_instance.html.markdown b/config/docs/r/postgresql_instance.html.markdown new file mode 100644 index 0000000..febc2eb --- /dev/null +++ b/config/docs/r/postgresql_instance.html.markdown @@ -0,0 +1,246 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_instance" +sidebar_current: "docs-tencentcloud-resource-postgresql_instance" +description: |- + Use this resource to create postgresql instance. +--- + +# tencentcloud_postgresql_instance + +Use this resource to create postgresql instance. + +-> **Note:** To update the charge type, please update the `charge_type` and specify the `period` for the charging period. It only supports updating from `POSTPAID_BY_HOUR` to `PREPAID`, and the `period` field only valid in that upgrading case. + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-1" +} + +# create vpc +resource "tencentcloud_vpc" "vpc" { + name = "guagua_vpc_instance_test" + cidr_block = "10.0.0.0/16" +} + +# create vpc subnet +resource "tencentcloud_subnet" "subnet" { + availability_zone = var.availability_zone + name = "guagua_vpc_subnet_test" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.20.0/28" + is_multicast = false +} + +# create postgresql +resource "tencentcloud_postgresql_instance" "foo" { + name = "example" + availability_zone = var.availability_zone + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + engine_version = "10.4" + root_user = "root123" + root_password = "Root123$" + charset = "UTF8" + project_id = 0 + memory = 2 + storage = 10 + + tags = { + test = "tf" + } +} +``` + +### Create a multi available zone bucket + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-6" +} + +variable "standby_availability_zone" { + default = "ap-guangzhou-7" +} + +# create vpc +resource "tencentcloud_vpc" "vpc" { + name = "guagua_vpc_instance_test" + cidr_block = "10.0.0.0/16" +} + +# create vpc subnet +resource "tencentcloud_subnet" "subnet" { + availability_zone = var.availability_zone + name = "guagua_vpc_subnet_test" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.20.0/28" + is_multicast = false +} + +# create postgresql +resource "tencentcloud_postgresql_instance" "foo" { + name = "example" + availability_zone = var.availability_zone + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + engine_version = "10.4" + root_user = "root123" + root_password = "Root123$" + charset = "UTF8" + project_id = 0 + memory = 2 + storage = 10 + + db_node_set { + role = "Primary" + zone = var.availability_zone + } + db_node_set { + zone = var.standby_availability_zone + } + + tags = { + test = "tf" + } +} +``` + +### create pgsql with kms key + +```hcl +resource "tencentcloud_postgresql_instance" "pg" { + name = "tf_postsql_instance" + availability_zone = "ap-guangzhou-6" + charge_type = "POSTPAID_BY_HOUR" + vpc_id = "vpc-86v957zb" + subnet_id = "subnet-enm92y0m" + engine_version = "11.12" + # db_major_vesion = "11" + db_kernel_version = "v11.12_r1.3" + need_support_tde = 1 + kms_key_id = "788c606a-c7b7-11ec-82d1-5254001e5c4e" + kms_region = "ap-guangzhou" + root_password = "xxxxxxxxxx" + charset = "LATIN1" + project_id = 0 + memory = 4 + storage = 100 + + backup_plan { + min_backup_start_time = "00:10:11" + max_backup_start_time = "01:10:11" + base_backup_retention_period = 7 + backup_period = ["tuesday", "wednesday"] + } + + tags = { + tf = "test" + } +} +``` + +### upgrade kernel version + +```hcl +resource "tencentcloud_postgresql_instance" "test" { + name = "tf_postsql_instance_update" + availability_zone = data.tencentcloud_availability_zones_by_product.zone.zones[5].name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = local.vpc_id + subnet_id = local.subnet_id + engine_version = "13.3" + root_password = "*" + charset = "LATIN1" + project_id = 0 + public_access_switch = false + security_groups = [local.sg_id] + memory = 4 + storage = 250 + backup_plan { + min_backup_start_time = "01:10:11" + max_backup_start_time = "02:10:11" + base_backup_retention_period = 5 + backup_period = ["monday", "thursday", "sunday"] + } + + db_kernel_version = "v13.3_r1.4" # eg:from v13.3_r1.1 to v13.3_r1.4 + + tags = { + tf = "teest" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Required, String) Availability zone. NOTE: This field could not be modified, please use `db_node_set` instead of modification. The changes on this field will be suppressed when using the `db_node_set`. +* `memory` - (Required, Int) Memory size(in GB). Allowed value must be larger than `memory` that data source `tencentcloud_postgresql_specinfos` provides. +* `name` - (Required, String) Name of the postgresql instance. +* `root_password` - (Required, String) Password of root account. This parameter can be specified when you purchase master instances, but it should be ignored when you purchase read-only instances or disaster recovery instances. +* `storage` - (Required, Int) Volume size(in GB). Allowed value must be a multiple of 10. The storage must be set with the limit of `storage_min` and `storage_max` which data source `tencentcloud_postgresql_specinfos` provides. +* `subnet_id` - (Required, String) ID of subnet. +* `vpc_id` - (Required, String) ID of VPC. +* `auto_renew_flag` - (Optional, Int) Auto renew flag, `1` for enabled. NOTES: Only support prepaid instance. +* `auto_voucher` - (Optional, Int) Whether to use voucher, `1` for enabled. +* `backup_plan` - (Optional, List) Specify DB backup plan. +* `charge_type` - (Optional, String) Pay type of the postgresql instance. Values `POSTPAID_BY_HOUR` (Default), `PREPAID`. It only support to update the type from `POSTPAID_BY_HOUR` to `PREPAID`. +* `charset` - (Optional, String, ForceNew) Charset of the root account. Valid values are `UTF8`,`LATIN1`. +* `db_kernel_version` - (Optional, String) PostgreSQL kernel version number. If it is specified, an instance running kernel DBKernelVersion will be created. It supports updating the minor kernel version immediately. +* `db_major_version` - (Optional, String) PostgreSQL major version number. Valid values: 10, 11, 12, 13. If it is specified, an instance running the latest kernel of PostgreSQL DBMajorVersion will be created. +* `db_major_vesion` - (Optional, String, **Deprecated**) `db_major_vesion` will be deprecated, use `db_major_version` instead. PostgreSQL major version number. Valid values: 10, 11, 12, 13. If it is specified, an instance running the latest kernel of PostgreSQL DBMajorVersion will be created. +* `db_node_set` - (Optional, Set) Specify instance node info for disaster migration. +* `engine_version` - (Optional, String, ForceNew) Version of the postgresql database engine. Valid values: `10.4`, `11.8`, `12.4`. +* `kms_key_id` - (Optional, String) KeyId of the custom key. +* `kms_region` - (Optional, String) Region of the custom key. +* `max_standby_archive_delay` - (Optional, Int) max_standby_archive_delay applies when WAL data is being read from WAL archive (and is therefore not current). Units are milliseconds if not specified. +* `max_standby_streaming_delay` - (Optional, Int) max_standby_streaming_delay applies when WAL data is being received via streaming replication. Units are milliseconds if not specified. +* `need_support_tde` - (Optional, Int) Whether to support data transparent encryption, 1: yes, 0: no (default). +* `period` - (Optional, Int) Specify Prepaid period in month. Default `1`. Values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `24`, `36`. This field is valid only when creating a `PREPAID` type instance, or updating the charge type from `POSTPAID_BY_HOUR` to `PREPAID`. +* `project_id` - (Optional, Int) Project id, default value is `0`. +* `public_access_switch` - (Optional, Bool) Indicates whether to enable the access to an instance from public network or not. +* `root_user` - (Optional, String, ForceNew) Instance root account name. This parameter is optional, Default value is `root`. +* `security_groups` - (Optional, Set: [`String`]) ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either. +* `tags` - (Optional, Map) The available tags within this postgresql. +* `voucher_ids` - (Optional, List: [`String`]) Specify Voucher Ids if `auto_voucher` was `1`, only support using 1 vouchers for now. + +The `backup_plan` object supports the following: + +* `backup_period` - (Optional, List) List of backup period per week, available values: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`. NOTE: At least specify two days. +* `base_backup_retention_period` - (Optional, Int) Specify days of the retention. +* `max_backup_start_time` - (Optional, String) Specify latest backup start time, format `hh:mm:ss`. +* `min_backup_start_time` - (Optional, String) Specify earliest backup start time, format `hh:mm:ss`. + +The `db_node_set` object supports the following: + +* `zone` - (Required, String) Indicates the node available zone. +* `role` - (Optional, String) Indicates node type, available values:`Primary`, `Standby`. Default: `Standby`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the postgresql instance. +* `private_access_ip` - IP for private access. +* `private_access_port` - Port for private access. +* `public_access_host` - Host for public access. +* `public_access_port` - Port for public access. +* `uid` - Uid of the postgresql instance. + + +## Import + +postgresql instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_postgresql_instance.foo postgres-cda1iex1 +``` + diff --git a/config/docs/r/postgresql_instance_network_access_attachment.html.markdown b/config/docs/r/postgresql_instance_network_access_attachment.html.markdown new file mode 100644 index 0000000..5227485 --- /dev/null +++ b/config/docs/r/postgresql_instance_network_access_attachment.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_instance_network_access_attachment" +sidebar_current: "docs-tencentcloud-resource-postgresql_instance_network_access_attachment" +description: |- + Provides a resource to create a postgresql instance_network_access_attachment +--- + +# tencentcloud_postgresql_instance_network_access_attachment + +Provides a resource to create a postgresql instance_network_access_attachment + +## Example Usage + +Vip assigned by system. + +```hcl +resource "tencentcloud_postgresql_instance_network_access_attachment" "instance_network_access_attachment" { + db_instance_id = tencentcloud_postgresql_instance.test.id + vpc_id = local.vpc_id + subnet_id = local.subnet_id + is_assign_vip = false + tags = { + "createdBy" = "terraform" + } +} +``` + +Vip specified by user. + +```hcl +resource "tencentcloud_postgresql_instance_network_access_attachment" "instance_network_access_attachment" { + db_instance_id = tencentcloud_postgresql_instance.test.id + vpc_id = local.my_vpc_id + subnet_id = local.my_subnet_id + is_assign_vip = true + vip = "172.18.111.111" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String, ForceNew) Instance ID in the format of postgres-6bwgamo3. +* `is_assign_vip` - (Required, Bool, ForceNew) Whether to manually assign the VIP. Valid values:true (manually assign), false (automatically assign). +* `subnet_id` - (Required, String, ForceNew) Subnet ID. +* `vpc_id` - (Required, String, ForceNew) Unified VPC ID. +* `tags` - (Optional, Map, ForceNew) Tag description list. +* `vip` - (Optional, String, ForceNew) Target VIP. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +postgresql instance_network_access_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_postgresql_instance_network_access_attachment.instance_network_access_attachment instance_network_access_attachment_id +``` + diff --git a/config/docs/r/postgresql_isolate_db_instance_operation.html.markdown b/config/docs/r/postgresql_isolate_db_instance_operation.html.markdown new file mode 100644 index 0000000..4478a57 --- /dev/null +++ b/config/docs/r/postgresql_isolate_db_instance_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_isolate_db_instance_operation" +sidebar_current: "docs-tencentcloud-resource-postgresql_isolate_db_instance_operation" +description: |- + Provides a resource to create a postgresql isolate_db_instance_operation +--- + +# tencentcloud_postgresql_isolate_db_instance_operation + +Provides a resource to create a postgresql isolate_db_instance_operation + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_isolate_db_instance_operation" "isolate_db_instance_operation" { + db_instance_id_set = [local.pgsql_id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id_set` - (Required, Set: [`String`], ForceNew) List of resource IDs. Note that currently you cannot isolate multiple instances at the same time. Only one instance ID can be passed in here. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/postgresql_modify_account_remark_operation.html.markdown b/config/docs/r/postgresql_modify_account_remark_operation.html.markdown new file mode 100644 index 0000000..38a6fd0 --- /dev/null +++ b/config/docs/r/postgresql_modify_account_remark_operation.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_modify_account_remark_operation" +sidebar_current: "docs-tencentcloud-resource-postgresql_modify_account_remark_operation" +description: |- + Provides a resource to create a postgresql modify_account_remark_operation +--- + +# tencentcloud_postgresql_modify_account_remark_operation + +Provides a resource to create a postgresql modify_account_remark_operation + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_modify_account_remark_operation" "modify_account_remark_operation" { + db_instance_id = local.pgsql_id + user_name = "root" + remark = "hello_world" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String, ForceNew) Instance ID in the format of postgres-4wdeb0zv. +* `remark` - (Required, String, ForceNew) New remarks corresponding to user `UserName`. +* `user_name` - (Required, String, ForceNew) Instance username. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/postgresql_modify_db_instance_charge_type_operation.html.markdown b/config/docs/r/postgresql_modify_db_instance_charge_type_operation.html.markdown new file mode 100644 index 0000000..cc771f2 --- /dev/null +++ b/config/docs/r/postgresql_modify_db_instance_charge_type_operation.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_modify_db_instance_charge_type_operation" +sidebar_current: "docs-tencentcloud-resource-postgresql_modify_db_instance_charge_type_operation" +description: |- + Provides a resource to create a postgresql modify_db_instance_charge_type_operation +--- + +# tencentcloud_postgresql_modify_db_instance_charge_type_operation + +Provides a resource to create a postgresql modify_db_instance_charge_type_operation + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_modify_db_instance_charge_type_operation" "modify_db_instance_charge_type_operation" { + db_instance_id = "postgres-6r233v55" + instance_charge_type = "PREPAID" + period = 1 + auto_renew_flag = 0 + auto_voucher = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String, ForceNew) dbInstance ID. +* `instance_charge_type` - (Required, String, ForceNew) Instance billing mode. Valid values:PREPAID (monthly subscription), POSTPAID_BY_HOUR (pay-as-you-go). +* `period` - (Required, Int, ForceNew) Valid period in months of purchased instances. Valid values:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. This parameter is set to 1 when the pay-as-you-go billing mode is used. +* `auto_renew_flag` - (Optional, Int, ForceNew) Renewal flag. Valid values:0 (manual renewal), 1 (auto-renewal). Default value:0. +* `auto_voucher` - (Optional, Int, ForceNew) Whether to automatically use vouchers.Valid values:1(yes),0(no).Default value:0. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/postgresql_modify_switch_time_period_operation.html.markdown b/config/docs/r/postgresql_modify_switch_time_period_operation.html.markdown new file mode 100644 index 0000000..9b6d078 --- /dev/null +++ b/config/docs/r/postgresql_modify_switch_time_period_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_modify_switch_time_period_operation" +sidebar_current: "docs-tencentcloud-resource-postgresql_modify_switch_time_period_operation" +description: |- + Provides a resource to create a postgresql modify_switch_time_period_operation +--- + +# tencentcloud_postgresql_modify_switch_time_period_operation + +Provides a resource to create a postgresql modify_switch_time_period_operation + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_modify_switch_time_period_operation" "modify_switch_time_period_operation" { + db_instance_id = local.pgsql_id + switch_tag = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String, ForceNew) The ID of the instance waiting for a switch. +* `switch_tag` - (Required, Int, ForceNew) Valid value: `0` (switch immediately). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/postgresql_parameter_template.html.markdown b/config/docs/r/postgresql_parameter_template.html.markdown new file mode 100644 index 0000000..3c4894d --- /dev/null +++ b/config/docs/r/postgresql_parameter_template.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_parameter_template" +sidebar_current: "docs-tencentcloud-resource-postgresql_parameter_template" +description: |- + Provides a resource to create a postgresql parameter_template +--- + +# tencentcloud_postgresql_parameter_template + +Provides a resource to create a postgresql parameter_template + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_parameter_template" "parameter_template" { + template_name = "your_temp_name" + db_major_version = "13" + db_engine = "postgresql" + template_description = "For_tf_test" + + modify_param_entry_set { + name = "timezone" + expected_value = "UTC" + } + modify_param_entry_set { + name = "lock_timeout" + expected_value = "123" + } + + delete_param_set = ["lc_time"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_engine` - (Required, String) Database engine, such as postgresql, mssql_compatible. +* `db_major_version` - (Required, String) The major database version number, such as 11, 12, 13. +* `template_name` - (Required, String) Template name, which can contain 1-60 letters, digits, and symbols (-_./()+=:@). +* `delete_param_set` - (Optional, Set: [`String`]) The set of parameters that need to be deleted. +* `modify_param_entry_set` - (Optional, Set) The set of parameters that need to be modified or added. Note: the same parameter cannot appear in the set of modifying and adding and deleting at the same time. +* `template_description` - (Optional, String) Parameter template description, which can contain 1-60 letters, digits, and symbols (-_./()+=:@). + +The `modify_param_entry_set` object supports the following: + +* `expected_value` - (Required, String) Modify the parameter value. The input parameters are passed in the form of strings, for example: decimal `0.1`, integer `1000`, enumeration `replica`. +* `name` - (Required, String) The parameter name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +postgresql parameter_template can be imported using the id, e.g. + +Notice: `modify_param_entry_set` and `delete_param_set` do not support import. + +``` +terraform import tencentcloud_postgresql_parameter_template.parameter_template parameter_template_id +``` + diff --git a/config/docs/r/postgresql_readonly_attachment.html.markdown b/config/docs/r/postgresql_readonly_attachment.html.markdown new file mode 100644 index 0000000..3cc55d5 --- /dev/null +++ b/config/docs/r/postgresql_readonly_attachment.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_readonly_attachment" +sidebar_current: "docs-tencentcloud-resource-postgresql_readonly_attachment" +description: |- + Use this resource to create postgresql readonly attachment. +--- + +# tencentcloud_postgresql_readonly_attachment + +Use this resource to create postgresql readonly attachment. + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_readonly_attachment" "attach" { + db_instance_id = tencentcloud_postgresql_readonly_instance.foo.id + read_only_group_id = tencentcloud_postgresql_readonly_group.group.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String, ForceNew) Read only instance ID. +* `read_only_group_id` - (Required, String, ForceNew) Read only group ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/postgresql_readonly_group.html.markdown b/config/docs/r/postgresql_readonly_group.html.markdown new file mode 100644 index 0000000..570cec3 --- /dev/null +++ b/config/docs/r/postgresql_readonly_group.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_readonly_group" +sidebar_current: "docs-tencentcloud-resource-postgresql_readonly_group" +description: |- + Use this resource to create postgresql readonly group. +--- + +# tencentcloud_postgresql_readonly_group + +Use this resource to create postgresql readonly group. + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_readonly_group" "group" { + master_db_instance_id = "postgres-gzg9jb2n" + name = "world" + project_id = 0 + vpc_id = "vpc-86v957zb" + subnet_id = "subnet-enm92y0m" + replay_lag_eliminate = 1 + replay_latency_eliminate = 1 + max_replay_lag = 100 + max_replay_latency = 512 + min_delay_eliminate_reserve = 1 + # security_groups_ids = [] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `master_db_instance_id` - (Required, String, ForceNew) Primary instance ID. +* `max_replay_lag` - (Required, Int) Delay threshold in ms. +* `max_replay_latency` - (Required, Int) Delayed log size threshold in MB. +* `min_delay_eliminate_reserve` - (Required, Int) The minimum number of read-only replicas that must be retained in an RO group. +* `name` - (Required, String) RO group name. +* `project_id` - (Required, Int) Project ID. +* `replay_lag_eliminate` - (Required, Int) Whether to remove a read-only replica from an RO group if the delay between the read-only replica and the primary instance exceeds the threshold. Valid values: 0 (no), 1 (yes). +* `replay_latency_eliminate` - (Required, Int) Whether to remove a read-only replica from an RO group if the sync log size difference between the read-only replica and the primary instance exceeds the threshold. Valid values: 0 (no), 1 (yes). +* `subnet_id` - (Required, String) VPC subnet ID. +* `vpc_id` - (Required, String) VPC ID. +* `security_groups_ids` - (Optional, Set: [`String`]) ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the postgresql instance. + + diff --git a/config/docs/r/postgresql_readonly_group_network_access_attachment.html.markdown b/config/docs/r/postgresql_readonly_group_network_access_attachment.html.markdown new file mode 100644 index 0000000..2e3deff --- /dev/null +++ b/config/docs/r/postgresql_readonly_group_network_access_attachment.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_readonly_group_network_access_attachment" +sidebar_current: "docs-tencentcloud-resource-postgresql_readonly_group_network_access_attachment" +description: |- + Provides a resource to create a postgresql readonly_group_network_access_attachment +--- + +# tencentcloud_postgresql_readonly_group_network_access_attachment + +Provides a resource to create a postgresql readonly_group_network_access_attachment + +## Example Usage + +Vip assigned by system. + +```hcl +resource "tencentcloud_vpc" "vpc" { + cidr_block = "172.18.111.0/24" + name = "test-pg-network-vpc" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = var.default_az + cidr_block = "172.18.111.0/24" + name = "test-pg-network-sub1" + vpc_id = tencentcloud_vpc.vpc.id +} + +locals { + my_vpc_id = tencentcloud_subnet.subnet.vpc_id + my_subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_postgresql_readonly_group" "group" { + master_db_instance_id = local.pgsql_id + name = "tf_test_postgresql_readonly_group" + project_id = 0 + vpc_id = local.my_vpc_id + subnet_id = local.my_subnet_id + replay_lag_eliminate = 1 + replay_latency_eliminate = 1 + max_replay_lag = 100 + max_replay_latency = 512 + min_delay_eliminate_reserve = 1 +} + +resource "tencentcloud_postgresql_readonly_group_network_access_attachment" "readonly_group_network_access_attachment" { + db_instance_id = local.pgsql_id + readonly_group_id = tencentcloud_postgresql_readonly_group.group.id + vpc_id = local.my_vpc_id + subnet_id = local.my_subnet_id + is_assign_vip = false + tags = { + "createdBy" = "terraform" + } +} +``` + +Vip specified by user. + +```hcl +resource "tencentcloud_postgresql_readonly_group_network_access_attachment" "readonly_group_network_access_attachment" { + db_instance_id = local.pgsql_id + readonly_group_id = tencentcloud_postgresql_readonly_group.group.id + vpc_id = local.my_vpc_id + subnet_id = local.my_subnet_id + is_assign_vip = true + vip = "172.18.111.111" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String, ForceNew) Master database instance ID. +* `is_assign_vip` - (Required, Bool, ForceNew) Whether to manually assign the VIP. Valid values:true (manually assign), false (automatically assign). +* `readonly_group_id` - (Required, String, ForceNew) RO group identifier. +* `subnet_id` - (Required, String, ForceNew) Subnet ID. +* `vpc_id` - (Required, String, ForceNew) Unified VPC ID. +* `tags` - (Optional, Map, ForceNew) Tag description list. +* `vip` - (Optional, String, ForceNew) Target VIP. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +postgresql readonly_group_network_access_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_postgresql_readonly_group_network_access_attachment.readonly_group_network_access_attachment db_instance_id#readonly_group_id#vpc_id#vip#port +``` + diff --git a/config/docs/r/postgresql_readonly_instance.html.markdown b/config/docs/r/postgresql_readonly_instance.html.markdown new file mode 100644 index 0000000..6994b5f --- /dev/null +++ b/config/docs/r/postgresql_readonly_instance.html.markdown @@ -0,0 +1,89 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_readonly_instance" +sidebar_current: "docs-tencentcloud-resource-postgresql_readonly_instance" +description: |- + Use this resource to create postgresql readonly instance. +--- + +# tencentcloud_postgresql_readonly_instance + +Use this resource to create postgresql readonly instance. + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_readonly_instance" "foo" { + auto_renew_flag = 0 + db_version = "10.4" + instance_charge_type = "POSTPAID_BY_HOUR" + master_db_instance_id = "postgres-j4pm65id" + memory = 4 + name = "hello" + need_support_ipv6 = 0 + project_id = 0 + security_groups_ids = [ + "sg-fefj5n6r", + ] + storage = 250 + subnet_id = "subnet-enm92y0m" + vpc_id = "vpc-86v957zb" + read_only_group_id = tencentcloud_postgresql_readonly_group.new_ro_group.id +} + +resource "tencentcloud_postgresql_readonly_group" "new_ro_group" { + master_db_instance_id = local.pgsql_id + name = "tf_ro_group_test_new" + project_id = 0 + vpc_id = local.vpc_id + subnet_id = local.subnet_id + replay_lag_eliminate = 1 + replay_latency_eliminate = 1 + max_replay_lag = 100 + max_replay_latency = 512 + min_delay_eliminate_reserve = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_version` - (Required, String, ForceNew) PostgreSQL kernel version, which must be the same as that of the primary instance. +* `master_db_instance_id` - (Required, String, ForceNew) ID of the primary instance to which the read-only replica belongs. +* `memory` - (Required, Int) Memory size(in GB). Allowed value must be larger than `memory` that data source `tencentcloud_postgresql_specinfos` provides. +* `name` - (Required, String) Instance name. +* `project_id` - (Required, Int) Project ID. +* `security_groups_ids` - (Required, Set: [`String`]) ID of security group. +* `storage` - (Required, Int) Instance storage capacity in GB. +* `subnet_id` - (Required, String) VPC subnet ID. +* `vpc_id` - (Required, String, ForceNew) VPC ID. +* `zone` - (Required, String, ForceNew) Availability zone ID, which can be obtained through the Zone field in the returned value of the DescribeZones API. +* `auto_renew_flag` - (Optional, Int) Auto renew flag, `1` for enabled. NOTES: Only support prepaid instance. +* `auto_voucher` - (Optional, Int) Whether to use voucher, `1` for enabled. +* `instance_charge_type` - (Optional, String, ForceNew) instance billing mode. Valid values: PREPAID (monthly subscription), POSTPAID_BY_HOUR (pay-as-you-go). +* `need_support_ipv6` - (Optional, Int, ForceNew) Whether to support IPv6 address access. Valid values: 1 (yes), 0 (no). +* `period` - (Optional, Int) Specify Prepaid period in month. Default `1`. Values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `24`, `36`. +* `read_only_group_id` - (Optional, String) RO group ID. +* `voucher_ids` - (Optional, List: [`String`]) Specify Voucher Ids if `auto_voucher` was `1`, only support using 1 vouchers for now. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the postgresql instance. +* `instance_id` - The instance ID of this readonly resource. +* `private_access_ip` - IP for private access. +* `private_access_port` - Port for private access. + + +## Import + +postgresql readonly instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_postgresql_readonly_instance.foo instance_id +``` + diff --git a/config/docs/r/postgresql_rebalance_readonly_group_operation.html.markdown b/config/docs/r/postgresql_rebalance_readonly_group_operation.html.markdown new file mode 100644 index 0000000..f1437db --- /dev/null +++ b/config/docs/r/postgresql_rebalance_readonly_group_operation.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_rebalance_readonly_group_operation" +sidebar_current: "docs-tencentcloud-resource-postgresql_rebalance_readonly_group_operation" +description: |- + Provides a resource to create a postgresql rebalance_readonly_group_operation +--- + +# tencentcloud_postgresql_rebalance_readonly_group_operation + +Provides a resource to create a postgresql rebalance_readonly_group_operation + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_readonly_group" "group_rebalance" { + master_db_instance_id = local.pgsql_id + name = "test-pg-readonly-group-rebalance" + project_id = 0 + vpc_id = "vpc-86v957zb" + subnet_id = "subnet-enm92y0m" + replay_lag_eliminate = 1 + replay_latency_eliminate = 1 + max_replay_lag = 100 + max_replay_latency = 512 + min_delay_eliminate_reserve = 1 +} + +resource "tencentcloud_postgresql_rebalance_readonly_group_operation" "rebalance_readonly_group_operation" { + read_only_group_id = tencentcloud_postgresql_readonly_group.group_rebalance.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `read_only_group_id` - (Required, String, ForceNew) readonly Group ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/postgresql_renew_db_instance_operation.html.markdown b/config/docs/r/postgresql_renew_db_instance_operation.html.markdown new file mode 100644 index 0000000..2407df2 --- /dev/null +++ b/config/docs/r/postgresql_renew_db_instance_operation.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_renew_db_instance_operation" +sidebar_current: "docs-tencentcloud-resource-postgresql_renew_db_instance_operation" +description: |- + Provides a resource to create a postgresql renew_db_instance_operation +--- + +# tencentcloud_postgresql_renew_db_instance_operation + +Provides a resource to create a postgresql renew_db_instance_operation + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_renew_db_instance_operation" "renew_db_instance_operation" { + db_instance_id = tencentcloud_postgresql_instance.oper_test_PREPAID.id + period = 1 + auto_voucher = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String, ForceNew) Instance ID in the format of postgres-6fego161. +* `period` - (Required, Int, ForceNew) Renewal duration in months. +* `auto_voucher` - (Optional, Int, ForceNew) Whether to automatically use vouchers. 1:yes, 0:no. Default value:0. +* `voucher_ids` - (Optional, Set: [`String`], ForceNew) Voucher ID list (only one voucher can be specified currently). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/postgresql_restart_db_instance_operation.html.markdown b/config/docs/r/postgresql_restart_db_instance_operation.html.markdown new file mode 100644 index 0000000..adc47a8 --- /dev/null +++ b/config/docs/r/postgresql_restart_db_instance_operation.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_restart_db_instance_operation" +sidebar_current: "docs-tencentcloud-resource-postgresql_restart_db_instance_operation" +description: |- + Provides a resource to create a postgresql restart_db_instance_operation +--- + +# tencentcloud_postgresql_restart_db_instance_operation + +Provides a resource to create a postgresql restart_db_instance_operation + +## Example Usage + +```hcl +resource "tencentcloud_postgresql_restart_db_instance_operation" "restart_db_instance_operation" { + db_instance_id = local.pgsql_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_instance_id` - (Required, String, ForceNew) dbInstance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/postgresql_security_group_config.html.markdown b/config/docs/r/postgresql_security_group_config.html.markdown new file mode 100644 index 0000000..f643b7d --- /dev/null +++ b/config/docs/r/postgresql_security_group_config.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "TencentDB for PostgreSQL(PostgreSQL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_postgresql_security_group_config" +sidebar_current: "docs-tencentcloud-resource-postgresql_security_group_config" +description: |- + Provides a resource to create a postgresql security_group_config +--- + +# tencentcloud_postgresql_security_group_config + +Provides a resource to create a postgresql security_group_config + +## Example Usage + +### Set security group for the sepcified postgres instance + +```hcl +resource "tencentcloud_postgresql_security_group_config" "security_group_config" { + security_group_id_set = [local.sg_id, local.sg_id2] + db_instance_id = local.pgsql_id +} +``` + +### Set security group for the specified readonly group + +```hcl +resource "tencentcloud_postgresql_readonly_group" "group" { + master_db_instance_id = local.pgsql_id + name = "tf_test_ro_sg" + project_id = 0 + subnet_id = local.subnet_id + vpc_id = local.vpc_id + replay_lag_eliminate = 1 + replay_latency_eliminate = 1 + max_replay_lag = 100 + max_replay_latency = 512 + min_delay_eliminate_reserve = 1 +} + +resource "tencentcloud_postgresql_security_group_config" "security_group_config" { + security_group_id_set = [local.sg_id, local.sg_id2] + read_only_group_id = tencentcloud_postgresql_readonly_group.group.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `security_group_id_set` - (Required, Set: [`String`]) Information of security groups in array. +* `db_instance_id` - (Optional, String) Instance ID. Either this parameter or ReadOnlyGroupId must be passed in. If both parameters are passed in, ReadOnlyGroupId will be ignored. +* `read_only_group_id` - (Optional, String) RO group ID. Either this parameter or DBInstanceId must be passed in. To query the security groups associated with the RO groups, only pass in ReadOnlyGroupId. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/private_dns_record.html.markdown b/config/docs/r/private_dns_record.html.markdown new file mode 100644 index 0000000..f7e5add --- /dev/null +++ b/config/docs/r/private_dns_record.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "PrivateDNS" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_private_dns_record" +sidebar_current: "docs-tencentcloud-resource-private_dns_record" +description: |- + Provide a resource to create a Private Dns Record. +--- + +# tencentcloud_private_dns_record + +Provide a resource to create a Private Dns Record. + +## Example Usage + +```hcl +resource "tencentcloud_private_dns_record" "foo" { + zone_id = "zone-rqndjnki" + record_type = "A" + record_value = "192.168.1.2" + sub_domain = "www" + ttl = 300 + weight = 1 + mx = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `record_type` - (Required, String) Record type. Valid values: "A", "AAAA", "CNAME", "MX", "TXT", "PTR". +* `record_value` - (Required, String) Record value, such as IP: 192.168.10.2, CNAME: cname.qcloud.com, and MX: mail.qcloud.com.. +* `sub_domain` - (Required, String) Subdomain, such as "www", "m", and "@". +* `zone_id` - (Required, String) Private domain ID. +* `mx` - (Optional, Int) MX priority, which is required when the record type is MX. Valid values: 5, 10, 15, 20, 30, 40, 50. +* `ttl` - (Optional, Int) Record cache time. The smaller the value, the faster the record will take effect. Value range: 1~86400s. +* `weight` - (Optional, Int) Record weight. Value range: 1~100. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Private Dns Record can be imported, e.g. + +``` +$ terraform import tencentcloud_private_dns_zone.foo zone_id#record_id +``` + diff --git a/config/docs/r/private_dns_zone.html.markdown b/config/docs/r/private_dns_zone.html.markdown new file mode 100644 index 0000000..94f06ba --- /dev/null +++ b/config/docs/r/private_dns_zone.html.markdown @@ -0,0 +1,115 @@ +--- +subcategory: "PrivateDNS" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_private_dns_zone" +sidebar_current: "docs-tencentcloud-resource-private_dns_zone" +description: |- + Provide a resource to create a Private Dns Zone. +--- + +# tencentcloud_private_dns_zone + +Provide a resource to create a Private Dns Zone. + +## Example Usage + +### Create a basic Private Dns Zone + +```hcl +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_private_dns_zone" "example" { + domain = "domain.com" + remark = "remark." + + vpc_set { + region = "ap-guangzhou" + uniq_vpc_id = tencentcloud_vpc.vpc.id + } + + dns_forward_status = "DISABLED" + cname_speedup_status = "ENABLED" + + tags = { + createdBy : "terraform" + } +} +``` + +### Create a Private Dns Zone domain and bind associated accounts'VPC + +```hcl +resource "tencentcloud_private_dns_zone" "example" { + domain = "domain.com" + remark = "remark." + + vpc_set { + region = "ap-guangzhou" + uniq_vpc_id = tencentcloud_vpc.vpc.id + } + + account_vpc_set { + uin = "123456789" + uniq_vpc_id = "vpc-adsebmya" + region = "ap-guangzhou" + vpc_name = "vpc-name" + } + + dns_forward_status = "DISABLED" + cname_speedup_status = "ENABLED" + + tags = { + createdBy : "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Domain name, which must be in the format of standard TLD. +* `account_vpc_set` - (Optional, List) List of authorized accounts' VPCs to associate with the private domain. +* `cname_speedup_status` - (Optional, String) CNAME acceleration: ENABLED, DISABLED, Default value is ENABLED. +* `dns_forward_status` - (Optional, String) Whether to enable subdomain recursive DNS. Valid values: ENABLED, DISABLED. Default value: DISABLED. +* `remark` - (Optional, String) Remarks. +* `tag_set` - (Optional, List, **Deprecated**) It has been deprecated from version 1.72.4. Use `tags` instead. Tags the private domain when it is created. +* `tags` - (Optional, Map) Tags of the private dns zone. +* `vpc_set` - (Optional, List) Associates the private domain to a VPC when it is created. + +The `account_vpc_set` object supports the following: + +* `region` - (Required, String) Region. +* `uin` - (Required, String) UIN of the VPC account. +* `uniq_vpc_id` - (Required, String) VPC ID. +* `vpc_name` - (Required, String) VPC NAME. + +The `tag_set` object supports the following: + +* `tag_key` - (Required, String) Key of Tag. +* `tag_value` - (Required, String) Value of Tag. + +The `vpc_set` object supports the following: + +* `region` - (Required, String) VPC REGION. +* `uniq_vpc_id` - (Required, String) VPC ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Private Dns Zone can be imported, e.g. + +``` +$ terraform import tencentcloud_private_dns_zone.foo zone_id +``` + diff --git a/config/docs/r/private_dns_zone_vpc_attachment.html.markdown b/config/docs/r/private_dns_zone_vpc_attachment.html.markdown new file mode 100644 index 0000000..07977f7 --- /dev/null +++ b/config/docs/r/private_dns_zone_vpc_attachment.html.markdown @@ -0,0 +1,96 @@ +--- +subcategory: "PrivateDNS" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_private_dns_zone_vpc_attachment" +sidebar_current: "docs-tencentcloud-resource-private_dns_zone_vpc_attachment" +description: |- + Provides a resource to create a PrivateDns zone_vpc_attachment +--- + +# tencentcloud_private_dns_zone_vpc_attachment + +Provides a resource to create a PrivateDns zone_vpc_attachment + +~> **NOTE:** If you need to bind account A to account B's VPC resources, you need to first grant role authorization to account A. + +## Example Usage + +### Append VPC associated with private dns zone + +```hcl +resource "tencentcloud_private_dns_zone" "example" { + domain = "domain.com" + remark = "remark." + + dns_forward_status = "DISABLED" + cname_speedup_status = "ENABLED" + + tags = { + createdBy : "terraform" + } +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_private_dns_zone_vpc_attachment" "example" { + zone_id = tencentcloud_private_dns_zone.example.id + + vpc_set { + uniq_vpc_id = tencentcloud_vpc.vpc.id + region = "ap-guangzhou" + } +} +``` + +### Add VPC information for associated accounts in the private dns zone + +```hcl +resource "tencentcloud_private_dns_zone_vpc_attachment" "example" { + zone_id = tencentcloud_private_dns_zone.example.id + + account_vpc_set { + uniq_vpc_id = "vpc-82znjzn3" + region = "ap-guangzhou" + uin = "100017155920" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `zone_id` - (Required, String, ForceNew) PrivateZone ID. +* `account_vpc_set` - (Optional, List, ForceNew) New add account vpc info. +* `vpc_set` - (Optional, List, ForceNew) New add vpc info. + +The `account_vpc_set` object supports the following: + +* `region` - (Required, String, ForceNew) Vpc region. +* `uin` - (Required, String, ForceNew) Vpc owner uin. To grant role authorization to this account. +* `uniq_vpc_id` - (Required, String, ForceNew) Uniq Vpc Id. + +The `vpc_set` object supports the following: + +* `region` - (Required, String, ForceNew) Vpc region. +* `uniq_vpc_id` - (Required, String, ForceNew) Uniq Vpc Id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +PrivateDns zone_vpc_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_private_dns_zone_vpc_attachment.example zone-6t11lof0#vpc-jdx11z0t +``` + diff --git a/config/docs/r/project.html.markdown b/config/docs/r/project.html.markdown new file mode 100644 index 0000000..1dd3e42 --- /dev/null +++ b/config/docs/r/project.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Project" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_project" +sidebar_current: "docs-tencentcloud-resource-project" +description: |- + Provides a resource to create a project +--- + +# tencentcloud_project + +Provides a resource to create a project + +~> **NOTE:** Project can not be destroyed. If run `terraform destroy`, project will be set invisible. + +## Example Usage + +```hcl +resource "tencentcloud_project" "project" { + project_name = "terraform-test" + info = "for terraform test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_name` - (Required, String) Name of project. +* `disable` - (Optional, Int) If disable project. 1 means disable, 0 means enable. Default 0. +* `info` - (Optional, String) Description of project. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time. +* `creator_uin` - Uin of creator. + + +## Import + +tag project can be imported using the id, e.g. + +``` +terraform import tencentcloud_project.project project_id +``` + diff --git a/config/docs/r/protocol_template.html.markdown b/config/docs/r/protocol_template.html.markdown new file mode 100644 index 0000000..21ecfea --- /dev/null +++ b/config/docs/r/protocol_template.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_protocol_template" +sidebar_current: "docs-tencentcloud-resource-protocol_template" +description: |- + Provides a resource to manage protocol template. +--- + +# tencentcloud_protocol_template + +Provides a resource to manage protocol template. + +## Example Usage + +```hcl +resource "tencentcloud_protocol_template" "foo" { + name = "protocol-template-test" + protocols = ["tcp:80", "udp:all", "icmp:10-30"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String, ForceNew) Name of the protocol template. +* `protocols` - (Required, Set: [`String`]) Protocol list. Valid protocols are `tcp`, `udp`, `icmp`, `gre`. Single port(tcp:80), multi-port(tcp:80,443), port range(tcp:3306-20000), all(tcp:all) format are support. Protocol `icmp` and `gre` cannot specify port. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Protocol template can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_protocol_template.foo ppm-nwrggd14 +``` + diff --git a/config/docs/r/protocol_template_group.html.markdown b/config/docs/r/protocol_template_group.html.markdown new file mode 100644 index 0000000..a0243c1 --- /dev/null +++ b/config/docs/r/protocol_template_group.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_protocol_template_group" +sidebar_current: "docs-tencentcloud-resource-protocol_template_group" +description: |- + Provides a resource to manage protocol template group. +--- + +# tencentcloud_protocol_template_group + +Provides a resource to manage protocol template group. + +## Example Usage + +```hcl +resource "tencentcloud_protocol_template_group" "foo" { + name = "group-test" + template_ids = ["ipl-axaf24151", "ipl-axaf24152"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String, ForceNew) Name of the protocol template group. +* `template_ids` - (Required, Set: [`String`]) Service template ID list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Protocol template group can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_protocol_template_group.foo ppmg-0np3u974 +``` + diff --git a/config/docs/r/pts_alert_channel.html.markdown b/config/docs/r/pts_alert_channel.html.markdown new file mode 100644 index 0000000..44d75fe --- /dev/null +++ b/config/docs/r/pts_alert_channel.html.markdown @@ -0,0 +1,92 @@ +--- +subcategory: "Performance Testing Service(PTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_pts_alert_channel" +sidebar_current: "docs-tencentcloud-resource-pts_alert_channel" +description: |- + Provides a resource to create a pts alert_channel +--- + +# tencentcloud_pts_alert_channel + +Provides a resource to create a pts alert_channel + +~> **NOTE:** Modification is not currently supported, please go to the console to modify. + +## Example Usage + +```hcl +resource "tencentcloud_monitor_alarm_notice" "example" { + name = "test_alarm_notice_1" + notice_type = "ALL" + notice_language = "zh-CN" + + user_notices { + receiver_type = "USER" + start_time = 0 + end_time = 1 + notice_way = ["EMAIL", "SMS", "WECHAT"] + user_ids = [10001] + group_ids = [] + phone_order = [10001] + phone_circle_times = 2 + phone_circle_interval = 50 + phone_inner_interval = 60 + need_phone_arrive_notice = 1 + phone_call_type = "CIRCLE" + weekday = [1, 2, 3, 4, 5, 6, 7] + } + + url_notices { + url = "https://www.mytest.com/validate" + end_time = 0 + start_time = 1 + weekday = [1, 2, 3, 4, 5, 6, 7] + } + +} + +resource "tencentcloud_pts_project" "project" { + name = "ptsObjectName" + description = "desc" + tags { + tag_key = "createdBy" + tag_value = "terraform" + } +} + +resource "tencentcloud_pts_alert_channel" "alert_channel" { + notice_id = tencentcloud_monitor_alarm_notice.example.id + project_id = tencentcloud_pts_project.project.id + amp_consumer_id = "Consumer-vvy1xxxxxx" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `notice_id` - (Required, String) Notice ID. +* `project_id` - (Required, String) Project ID. +* `amp_consumer_id` - (Optional, String) AMP Consumer ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `app_id` - App ID Note: this field may return null, indicating that a valid value cannot be obtained. +* `created_at` - Creation time Note: this field may return null, indicating that a valid value cannot be obtained. +* `status` - Status Note: this field may return null, indicating that a valid value cannot be obtained. +* `sub_account_uin` - Sub-user ID Note: this field may return null, indicating that a valid value cannot be obtained. +* `uin` - User ID Note: this field may return null, indicating that a valid value cannot be obtained. +* `updated_at` - Update time Note: this field may return null, indicating that a valid value cannot be obtained. + + +## Import + +pts alert_channel can be imported using the project_id#notice_id, e.g. +``` +$ terraform import tencentcloud_pts_alert_channel.alert_channel project-kww5v8se#notice-kl66t6y9 +``` + diff --git a/config/docs/r/pts_cron_job.html.markdown b/config/docs/r/pts_cron_job.html.markdown new file mode 100644 index 0000000..9009c5c --- /dev/null +++ b/config/docs/r/pts_cron_job.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "Performance Testing Service(PTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_pts_cron_job" +sidebar_current: "docs-tencentcloud-resource-pts_cron_job" +description: |- + Provides a resource to create a pts cron_job +--- + +# tencentcloud_pts_cron_job + +Provides a resource to create a pts cron_job + +## Example Usage + +```hcl +resource "tencentcloud_pts_cron_job" "cron_job" { + name = "iac-cron_job-update" + project_id = "project-7qkzxhea" + scenario_id = "scenario-c22lqb1w" + scenario_name = "pts-js(2022-11-10 21:53:53)" + frequency_type = 2 + cron_expression = "* 1 * * *" + job_owner = "userName" + # end_time = "" + notice_id = "notice-vp6i38jt" + note = "desc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cron_expression` - (Required, String) Cron expression, When setting cron_expression at that time, frequency_type must be greater than 1. +* `frequency_type` - (Required, Int) Execution frequency type, `1`: execute only once; `2`: daily granularity; `3`: weekly granularity; `4`: advanced. +* `job_owner` - (Required, String) Job Owner. +* `name` - (Required, String) Cron Job Name. +* `project_id` - (Required, String) Project Id. +* `scenario_id` - (Required, String) Scenario Id. +* `scenario_name` - (Required, String) Scenario Name. +* `end_time` - (Optional, String) End Time; type: Timestamp ISO8601. +* `note` - (Optional, String) Note. +* `notice_id` - (Optional, String) Notice ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `abort_reason` - Reason for suspension. +* `app_id` - App ID. +* `created_at` - Creation time; type: Timestamp ISO8601. +* `cron_job_id` - Cron job ID. +* `status` - Scheduled task status. +* `sub_account_uin` - Sub-user ID. +* `uin` - User ID. +* `updated_at` - Update time; type: Timestamp ISO8601. + + +## Import + +pts cron_job can be imported using the projectId#cronJobId, e.g. +``` +$ terraform import tencentcloud_pts_cron_job.cron_job project-7qkzxhea#scenario-c22lqb1w +``` + diff --git a/config/docs/r/pts_cron_job_abort.html.markdown b/config/docs/r/pts_cron_job_abort.html.markdown new file mode 100644 index 0000000..74977cb --- /dev/null +++ b/config/docs/r/pts_cron_job_abort.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Performance Testing Service(PTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_pts_cron_job_abort" +sidebar_current: "docs-tencentcloud-resource-pts_cron_job_abort" +description: |- + Provides a resource to create a pts cron_job_abort +--- + +# tencentcloud_pts_cron_job_abort + +Provides a resource to create a pts cron_job_abort + +## Example Usage + +```hcl +resource "tencentcloud_pts_cron_job_abort" "cron_job_abort" { + project_id = "project-abc" + cron_job_id = "job-dtm93vx0" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cron_job_id` - (Required, String, ForceNew) Cron job ID. +* `project_id` - (Required, String, ForceNew) Project ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/pts_cron_job_restart.html.markdown b/config/docs/r/pts_cron_job_restart.html.markdown new file mode 100644 index 0000000..2d4fbf6 --- /dev/null +++ b/config/docs/r/pts_cron_job_restart.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Performance Testing Service(PTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_pts_cron_job_restart" +sidebar_current: "docs-tencentcloud-resource-pts_cron_job_restart" +description: |- + Provides a resource to create a pts cron_job_restart, restart a scheduled task whose status is `JobAborting` +--- + +# tencentcloud_pts_cron_job_restart + +Provides a resource to create a pts cron_job_restart, restart a scheduled task whose status is `JobAborting` + +## Example Usage + +```hcl +resource "tencentcloud_pts_cron_job_restart" "cron_job_restart" { + project_id = "project-abc" + cron_job_id = "job-dtm93vx0" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cron_job_id` - (Required, String, ForceNew) Cron job ID. +* `project_id` - (Required, String, ForceNew) Project ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/pts_file.html.markdown b/config/docs/r/pts_file.html.markdown new file mode 100644 index 0000000..6fbe1b4 --- /dev/null +++ b/config/docs/r/pts_file.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "Performance Testing Service(PTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_pts_file" +sidebar_current: "docs-tencentcloud-resource-pts_file" +description: |- + Provides a resource to create a pts file +--- + +# tencentcloud_pts_file + +Provides a resource to create a pts file + +~> **NOTE:** Modification is not currently supported, please go to the console to modify. + +## Example Usage + +```hcl +resource "tencentcloud_pts_file" "file" { + file_id = "file-de2dbaf8" + header_in_file = false + kind = 3 + line_count = 0 + name = "iac.txt" + project_id = "project-45vw7v82" + size = 10799 + type = "text/plain" + # header_columns = "" + # file_infos { + # name = "" + # size = "" + # type = "" + # updated_at = "" + # } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `file_id` - (Required, String) File id. +* `kind` - (Required, Int) File kind, parameter file-1, protocol file-2, request file-3. +* `name` - (Required, String) File name. +* `project_id` - (Required, String) Project id. +* `size` - (Required, Int) File size. +* `type` - (Required, String) File type, folder-folder. +* `file_infos` - (Optional, List) Files in a folder. +* `head_lines` - (Optional, Set: [`String`]) The first few lines of data. +* `header_columns` - (Optional, Set: [`String`]) Meter head. +* `header_in_file` - (Optional, Bool) Whether the header is in the file. +* `line_count` - (Optional, Int) Line count. +* `tail_lines` - (Optional, Set: [`String`]) The last few lines of data. + +The `file_infos` object supports the following: + +* `file_id` - (Optional, String) File id. +* `name` - (Optional, String) File name. +* `size` - (Optional, Int) File size. +* `type` - (Optional, String) File type. +* `updated_at` - (Optional, String) Update time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +pts file can be imported using the project_id#file_id, e.g. +``` +$ terraform import tencentcloud_pts_file.file project-45vw7v82#file-de2dbaf8 +``` + diff --git a/config/docs/r/pts_job.html.markdown b/config/docs/r/pts_job.html.markdown new file mode 100644 index 0000000..79af021 --- /dev/null +++ b/config/docs/r/pts_job.html.markdown @@ -0,0 +1,76 @@ +--- +subcategory: "Performance Testing Service(PTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_pts_job" +sidebar_current: "docs-tencentcloud-resource-pts_job" +description: |- + Provides a resource to create a pts job +--- + +# tencentcloud_pts_job + +Provides a resource to create a pts job + +## Example Usage + +```hcl +resource "tencentcloud_pts_job" "job" { + scenario_id = "scenario-22q19f3k" + job_owner = "username" + project_id = "project-45vw7v82" + # debug = "" + note = "desc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_owner` - (Required, String) Job owner. +* `project_id` - (Required, String) Project ID. +* `scenario_id` - (Required, String) Pts scenario id. +* `debug` - (Optional, Bool) Whether to debug. +* `note` - (Optional, String) Note. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `abort_reason` - Cause of interruption. +* `created_at` - Creation time of the job. +* `cron_id` - Scheduled job ID. +* `datasets` - Dataset file for the job. +* `domain_name_config` - Domain name binding configuration. +* `duration` - Job duration. +* `end_time` - End time of the job. +* `error_rate` - Percentage of error rate. +* `job_id` - Job Id. +* `load` - Pressure configuration of job. +* `max_requests_per_second` - Maximum requests per second. +* `max_virtual_user_count` - Maximum number of VU for the job. +* `plugins` - Expansion package file information. +* `protocols` - Protocol script information. +* `request_files` - Request file information. +* `request_total` - Total number of requests. +* `requests_per_second` - Average number of requests per second. +* `response_time_average` - Average response time. +* `response_time_max` - Maximum response time. +* `response_time_min` - Minimum response time. +* `response_time_p90` - 90th percentile response time. +* `response_time_p95` - 95th percentile response time. +* `response_time_p99` - 99th percentile response time. +* `start_time` - Start time of the job. +* `status` - The running status of the task; `0`: JobUnknown, `1`: JobCreated, `2`: JobPending, `3`: JobPreparing, `4`: JobSelectClustering, `5`: JobCreateTasking, `6`: JobSyncTasking, `11`: JobRunning, `12`: JobFinished, `13`: JobPrepareException, `14`: JobFinishException, `15`: JobAborting, `16`: JobAborted, `17`: JobAbortException, `18`: JobDeleted, `19`: JobSelectClusterException, `20`: JobCreateTaskException, `21`: JobSyncTaskException. +* `test_scripts` - Test script information. +* `type` - Scene Type. + + +## Import + +pts job can be imported using the projectId#scenarioId#jobId, e.g. +``` +$ terraform import tencentcloud_pts_job.job project-45vw7v82#scenario-22q19f3k#job-dtm93vx0 +``` + diff --git a/config/docs/r/pts_job_abort.html.markdown b/config/docs/r/pts_job_abort.html.markdown new file mode 100644 index 0000000..ce2d5da --- /dev/null +++ b/config/docs/r/pts_job_abort.html.markdown @@ -0,0 +1,40 @@ +--- +subcategory: "Performance Testing Service(PTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_pts_job_abort" +sidebar_current: "docs-tencentcloud-resource-pts_job_abort" +description: |- + Provides a resource to create a pts job_abort +--- + +# tencentcloud_pts_job_abort + +Provides a resource to create a pts job_abort + +## Example Usage + +```hcl +resource "tencentcloud_pts_job_abort" "job_abort" { + job_id = "job-my644ozi" + project_id = "project-45vw7v82" + scenario_id = "scenario-22q19f3k" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `job_id` - (Required, String, ForceNew) Job ID. +* `project_id` - (Required, String, ForceNew) Project ID. +* `scenario_id` - (Required, String, ForceNew) Scenario ID. +* `abort_reason` - (Optional, Int, ForceNew) The reason for aborting the job. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/pts_project.html.markdown b/config/docs/r/pts_project.html.markdown new file mode 100644 index 0000000..d868e8c --- /dev/null +++ b/config/docs/r/pts_project.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Performance Testing Service(PTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_pts_project" +sidebar_current: "docs-tencentcloud-resource-pts_project" +description: |- + Provides a resource to create a pts project +--- + +# tencentcloud_pts_project + +Provides a resource to create a pts project + +## Example Usage + +```hcl +resource "tencentcloud_pts_project" "project" { + name = "ptsObjectName-1" + description = "desc" + tags { + tag_key = "createdBy" + tag_value = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) ptsObjectName, which must be required. +* `description` - (Optional, String) Pts object description. +* `tags` - (Optional, List) Tags List. + +The `tags` object supports the following: + +* `tag_key` - (Optional, String) tag key. +* `tag_value` - (Optional, String) tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `app_id` - App ID. +* `created_at` - Creation time. +* `status` - Project status. +* `sub_account_uin` - Sub-user ID. +* `uin` - User ID. +* `updated_at` - Update time. + + +## Import + +pts project can be imported using the id, e.g. +``` +$ terraform import tencentcloud_pts_project.project project-1ep27k1m +``` + diff --git a/config/docs/r/pts_scenario.html.markdown b/config/docs/r/pts_scenario.html.markdown new file mode 100644 index 0000000..97de418 --- /dev/null +++ b/config/docs/r/pts_scenario.html.markdown @@ -0,0 +1,280 @@ +--- +subcategory: "Performance Testing Service(PTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_pts_scenario" +sidebar_current: "docs-tencentcloud-resource-pts_scenario" +description: |- + Provides a resource to create a pts scenario +--- + +# tencentcloud_pts_scenario + +Provides a resource to create a pts scenario + +## Example Usage + +```hcl +resource "tencentcloud_pts_scenario" "scenario" { + name = "pts-js" + project_id = "project-45vw7v82" + type = "pts-js" + + domain_name_config { + } + + load { + geo_regions_load_distribution { + percentage = 100 + region = "ap-guangzhou" + region_id = 1 + } + + load_spec { + concurrency { + graceful_stop_seconds = 3 + iteration_count = 0 + max_requests_per_second = 0 + + stages { + duration_seconds = 120 + target_virtual_users = 2 + } + stages { + duration_seconds = 120 + target_virtual_users = 4 + } + stages { + duration_seconds = 120 + target_virtual_users = 5 + } + stages { + duration_seconds = 240 + target_virtual_users = 5 + } + } + } + } + + sla_policy { + } + + test_scripts { + encoded_content = <<-EOT + // Send a http get request + import http from 'pts/http'; + import { check, sleep } from 'pts'; + + export default function () { + // simple get request + const resp1 = http.get('http://httpbin.org/get'); + console.log(resp1.body); + // if resp1.body is a json string, resp1.json() transfer json format body to a json object + console.log(resp1.json()); + check('status is 200', () => resp1.statusCode === 200); + + // sleep 1 second + sleep(1); + + // get request with headers and parameters + const resp2 = http.get('http://httpbin.org/get', { + headers: { + Connection: 'keep-alive', + 'User-Agent': 'pts-engine', + }, + query: { + name1: 'value1', + name2: 'value2', + }, + }); + + console.log(resp2.json().args.name1); // 'value1' + check('body.args.name1 equals value1', () => resp2.json().args.name1 === 'value1'); + } + EOT + load_weight = 100 + name = "script.js" + size = 838 + type = "js" + updated_at = "2022-11-11T16:18:37+08:00" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Pts Scenario name. +* `project_id` - (Required, String) Project id. +* `type` - (Required, String) Pressure test engine type. +* `cron_id` - (Optional, String) cron job ID. +* `datasets` - (Optional, List) Test data set. +* `description` - (Optional, String) Pts Scenario Description. +* `domain_name_config` - (Optional, List) Domain name resolution configuration. +* `extensions` - (Optional, Set: [`String`]) deprecated. +* `load` - (Optional, List) Pressure allocation. +* `plugins` - (Optional, List) SLA strategy. +* `protocols` - (Optional, List) Protocol file path. +* `request_files` - (Optional, List) Request file path. +* `sla_policy` - (Optional, List) SLA strategy. +* `test_scripts` - (Optional, List) Test script file information. + +The `alert_channel` object supports the following: + +* `amp_consumer_id` - (Optional, String) AMP consumer ID. +* `notice_id` - (Optional, String) Notification template ID. + +The `concurrency` object supports the following: + +* `graceful_stop_seconds` - (Optional, Int) Wait time for graceful termination of the task. +* `iteration_count` - (Optional, Int) Number of runs. +* `max_requests_per_second` - (Optional, Int) Maximum RPS. +* `stages` - (Optional, List) Multi-phase configuration array. + +The `datasets` object supports the following: + +* `header_in_file` - (Required, Bool) Whether the first line is the parameter name. +* `name` - (Required, String) The file name where the test dataset is located. +* `split` - (Required, Bool) Test whether the dataset is fragmented. +* `file_id` - (Optional, String) File ID. +* `head_lines` - (Optional, Set) Header data row. +* `header_columns` - (Optional, Set) Parameter name array. +* `line_count` - (Optional, Int) Number of file lines. +* `size` - (Optional, Int) Number of file bytes. +* `tail_lines` - (Optional, Set) Trailing data row. +* `type` - (Optional, String) File type. +* `updated_at` - (Optional, String) Update time. + +The `dns_config` object supports the following: + +* `nameservers` - (Optional, Set) DNS IP List. + +The `domain_name_config` object supports the following: + +* `dns_config` - (Optional, List) DNS configuration. +* `host_aliases` - (Optional, List) Domain name binding configuration. + +The `geo_regions_load_distribution` object supports the following: + +* `region_id` - (Required, Int) Regional ID. +* `percentage` - (Optional, Int) Percentage. +* `region` - (Optional, String) Region. + +The `host_aliases` object supports the following: + +* `host_names` - (Optional, Set) List of domain names to be bound. +* `ip` - (Optional, String) The IP address to be bound. + +The `label_filter` object supports the following: + +* `label_name` - (Optional, String) Label name. +* `label_value` - (Optional, String) Label value. + +The `load_spec` object supports the following: + +* `concurrency` - (Optional, List) Configuration of concurrent pressure mode. +* `requests_per_second` - (Optional, List) Configuration of RPS pressure mode. +* `script_origin` - (Optional, List) Built-in stress mode in script. + +The `load` object supports the following: + +* `geo_regions_load_distribution` - (Optional, List) Pressure distribution. +* `load_spec` - (Optional, List) Pressure allocation. +* `vpc_load_distribution` - (Optional, List) Source of stress. + +The `plugins` object supports the following: + +* `file_id` - (Optional, String) File id. +* `name` - (Optional, String) File name. +* `size` - (Optional, Int) File size. +* `type` - (Optional, String) File type. +* `updated_at` - (Optional, String) Update time. + +The `protocols` object supports the following: + +* `file_id` - (Optional, String) File ID. +* `name` - (Optional, String) Protocol name. +* `size` - (Optional, Int) File name. +* `type` - (Optional, String) File type. +* `updated_at` - (Optional, String) Update time. + +The `request_files` object supports the following: + +* `file_id` - (Optional, String) File id. +* `name` - (Optional, String) File name. +* `size` - (Optional, Int) File size. +* `type` - (Optional, String) File type. +* `updated_at` - (Optional, String) Update time. + +The `requests_per_second` object supports the following: + +* `duration_seconds` - (Optional, Int) Pressure time. +* `graceful_stop_seconds` - (Optional, Int) Elegant shutdown waiting time. +* `max_requests_per_second` - (Optional, Int) Maximum RPS. +* `resources` - (Optional, Int) Number of resources. +* `start_requests_per_second` - (Optional, Int) Initial RPS. +* `target_requests_per_second` - (Optional, Int) Target RPS, invalid input parameter. + +The `script_origin` object supports the following: + +* `duration_seconds` - (Required, Int) Pressure testing time. +* `machine_number` - (Required, Int) Number of machines. +* `machine_specification` - (Required, String) Machine specification. + +The `sla_policy` object supports the following: + +* `alert_channel` - (Optional, List) Alarm notification channel. +* `sla_rules` - (Optional, List) SLA rules. + +The `sla_rules` object supports the following: + +* `abort_flag` - (Optional, Bool) Whether to stop the stress test task. +* `aggregation` - (Optional, String) Aggregation method of pressure test index. +* `condition` - (Optional, String) Pressure test index condition judgment symbol. +* `for` - (Optional, String) duraion. +* `label_filter` - (Optional, List) tag. +* `metric` - (Optional, String) Pressure test index. +* `value` - (Optional, Float64) Threshold value. + +The `stages` object supports the following: + +* `duration_seconds` - (Optional, Int) Pressure time. +* `target_virtual_users` - (Optional, Int) Number of virtual users. + +The `test_scripts` object supports the following: + +* `encoded_content` - (Optional, String) Base64 encoded file content. +* `encoded_http_archive` - (Optional, String) Base64 encoded har structure. +* `load_weight` - (Optional, Int) Script weight, range 1-100. +* `name` - (Optional, String) File name. +* `size` - (Optional, Int) File size. +* `type` - (Optional, String) File type. +* `updated_at` - (Optional, String) Update time. + +The `vpc_load_distribution` object supports the following: + +* `region_id` - (Required, Int) Regional ID. +* `region` - (Optional, String) Region. +* `subnet_ids` - (Optional, Set) Subnet ID list. +* `vpc_id` - (Optional, String) VPC ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `app_id` - App ID Note: this field may return null, indicating that a valid value cannot be obtained. +* `created_at` - Scene creation time. +* `status` - Scene statu Note: this field may return null, indicating that a valid value cannot be obtained. +* `sub_account_uin` - Sub-user ID Note: this field may return null, indicating that a valid value cannot be obtained. +* `uin` - User ID Note: this field may return null, indicating that a valid value cannot be obtained. +* `updated_at` - Scene modification time. + + +## Import + +pts scenario can be imported using the id, e.g. +``` +$ terraform import tencentcloud_pts_scenario.scenario scenario_id +``` + diff --git a/config/docs/r/pts_tmp_key_generate.html.markdown b/config/docs/r/pts_tmp_key_generate.html.markdown new file mode 100644 index 0000000..603e7d9 --- /dev/null +++ b/config/docs/r/pts_tmp_key_generate.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Performance Testing Service(PTS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_pts_tmp_key_generate" +sidebar_current: "docs-tencentcloud-resource-pts_tmp_key_generate" +description: |- + Provides a resource to create a pts tmp_key +--- + +# tencentcloud_pts_tmp_key_generate + +Provides a resource to create a pts tmp_key + +## Example Usage + +```hcl +resource "tencentcloud_pts_tmp_key_generate" "tmp_key" { + project_id = "project-1b0zqmhg" + scenario_id = "scenario-abc" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Required, String, ForceNew) Project ID. +* `scenario_id` - (Optional, String, ForceNew) Scenario ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `credentials` - Temporary access credentials. + * `tmp_secret_id` - Temporary secret ID. + * `tmp_secret_key` - Temporary secret key. + * `token` - Temporary token. +* `expired_time` - Timestamp of temporary access credential timeout (in seconds). +* `start_time` - The timestamp of the moment when the temporary access credential was obtained (in seconds). + + diff --git a/config/docs/r/redis_account.html.markdown b/config/docs/r/redis_account.html.markdown new file mode 100644 index 0000000..68c90d0 --- /dev/null +++ b/config/docs/r/redis_account.html.markdown @@ -0,0 +1,126 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_account" +sidebar_current: "docs-tencentcloud-resource-redis_account" +description: |- + Provides a resource to create a redis account +--- + +# tencentcloud_redis_account + +Provides a resource to create a redis account + +## Example Usage + +### Create an account with read and write permissions + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[1].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_redis_account" "account" { + instance_id = tencentcloud_redis_instance.foo.id + account_name = "account_test" + account_password = "test1234" + remark = "master" + readonly_policy = ["master"] + privilege = "rw" +} +``` + +### Create an account with read-only permissions + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[1].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_redis_account" "account" { + instance_id = tencentcloud_redis_instance.foo.id + account_name = "account_test" + account_password = "test1234" + remark = "master" + readonly_policy = ["master"] + privilege = "r" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account_name` - (Required, String) The account name. +* `account_password` - (Required, String) 1: Length 8-30 digits, it is recommended to use a password of more than 12 digits; 2: Cannot start with `/`; 3: Include at least two items: a.Lowercase letters `a-z`; b.Uppercase letters `A-Z` c.Numbers `0-9`; d.`()`~!@#$%^&*-+=_|{}[]:;<>,.?/`. +* `instance_id` - (Required, String) The ID of instance. +* `privilege` - (Required, String) Read and write policy: Enter R and RW to indicate read-only, read-write, cannot be empty when modifying operations. +* `readonly_policy` - (Required, Set: [`String`]) Routing policy: Enter master or replication, which indicates the master node or slave node, cannot be empty when modifying operations. +* `remark` - (Optional, String) Remark. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +redis account can be imported using the id, e.g. + +``` +terraform import tencentcloud_redis_account.account crs-xxxxxx#account_test +``` + diff --git a/config/docs/r/redis_backup_config.html.markdown b/config/docs/r/redis_backup_config.html.markdown new file mode 100644 index 0000000..be62577 --- /dev/null +++ b/config/docs/r/redis_backup_config.html.markdown @@ -0,0 +1,78 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_backup_config" +sidebar_current: "docs-tencentcloud-resource-redis_backup_config" +description: |- + Use this resource to create a backup config of redis. +--- + +# tencentcloud_redis_backup_config + +Use this resource to create a backup config of redis. + +## Example Usage + +### Set configuration for automatic backups + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[1].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_redis_backup_config" "foo" { + redis_id = tencentcloud_redis_instance.foo.id + backup_time = "04:00-05:00" + backup_period = ["Monday"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_time` - (Required, String) Specifys what time the backup action should take place. And the time interval should be one hour. +* `redis_id` - (Required, String, ForceNew) ID of a redis instance to which the policy will be applied. +* `backup_period` - (Optional, Set: [`String`], **Deprecated**) It has been deprecated from version 1.58.2. It makes no difference to online config at all Specifys which day the backup action should take place. Valid values: `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday` and `Sunday`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Redis backup config can be imported, e.g. + +``` +$ terraform import tencentcloud_redis_backup_config.foo redis-id +``` + diff --git a/config/docs/r/redis_backup_download_restriction.html.markdown b/config/docs/r/redis_backup_download_restriction.html.markdown new file mode 100644 index 0000000..7f4f826 --- /dev/null +++ b/config/docs/r/redis_backup_download_restriction.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_backup_download_restriction" +sidebar_current: "docs-tencentcloud-resource-redis_backup_download_restriction" +description: |- + Provides a resource to create a redis backup_download_restriction +--- + +# tencentcloud_redis_backup_download_restriction + +Provides a resource to create a redis backup_download_restriction + +## Example Usage + +### Modify the network information and address of the current region backup file download + +```hcl +resource "tencentcloud_redis_backup_download_restriction" "foo" { + limit_type = "Customize" + vpc_comparison_symbol = "In" + ip_comparison_symbol = "In" + limit_vpc { + region = "ap-guangzhou" + vpc_list = [var.vpc_id] + } + limit_ip = ["10.1.1.12", "10.1.1.13"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `limit_type` - (Required, String) Types of network restrictions for downloading backup files:- NoLimit: There is no limit, and backup files can be downloaded from both Tencent Cloud and internal and external networks.- LimitOnlyIntranet: Only intranet addresses automatically assigned by Tencent Cloud can download backup files.- Customize: refers to a user-defined private network downloadable backup file. +* `ip_comparison_symbol` - (Optional, String) Identifies whether the customized LimitIP address can download the backup file.- In: Custom IP addresses are available for download.- NotIn: Custom IPs are not available for download. +* `limit_ip` - (Optional, Set: [`String`]) A custom VPC IP address for downloadable backup files.If the parameter LimitType is **Customize**, you need to configure this parameter. +* `limit_vpc` - (Optional, List) A custom VPC ID for a downloadable backup file.If the parameter LimitType is **Customize**, you need to configure this parameter. +* `vpc_comparison_symbol` - (Optional, String) This parameter only supports entering In, which means that the custom LimitVpc can download the backup file. + +The `limit_vpc` object supports the following: + +* `region` - (Required, String) Customize the region of the VPC to which the backup file is downloaded. +* `vpc_list` - (Required, Set) Customize the list of VPCs to download backup files. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +redis backup_download_restriction can be imported using the region, e.g. + +``` +terraform import tencentcloud_redis_backup_download_restriction.foo ap-guangzhou +``` + diff --git a/config/docs/r/redis_backup_operation.html.markdown b/config/docs/r/redis_backup_operation.html.markdown new file mode 100644 index 0000000..7c80b26 --- /dev/null +++ b/config/docs/r/redis_backup_operation.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_backup_operation" +sidebar_current: "docs-tencentcloud-resource-redis_backup_operation" +description: |- + Provides a resource to create a redis backup_operation +--- + +# tencentcloud_redis_backup_operation + +Provides a resource to create a redis backup_operation + +## Example Usage + +### Manually back up the Redis instance, and the backup data is kept for 7 days + +```hcl +data "tencentcloud_mysql_instance" "foo" {} + +resource "tencentcloud_redis_backup_operation" "backup_operation" { + instance_id = data.tencentcloud_mysql_instance.foo.instance_list[0].mysql_id + remark = "manually back" + storage_days = 7 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) The ID of instance. +* `remark` - (Optional, String, ForceNew) Notes information for the backup. +* `storage_days` - (Optional, Int, ForceNew) Number of days to store.0 specifies the default retention time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/redis_clear_instance_operation.html.markdown b/config/docs/r/redis_clear_instance_operation.html.markdown new file mode 100644 index 0000000..b939e8f --- /dev/null +++ b/config/docs/r/redis_clear_instance_operation.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_clear_instance_operation" +sidebar_current: "docs-tencentcloud-resource-redis_clear_instance_operation" +description: |- + Provides a resource to create a redis clear_instance_operation +--- + +# tencentcloud_redis_clear_instance_operation + +Provides a resource to create a redis clear_instance_operation + +## Example Usage + +### Clear the instance data of the Redis instance + +```hcl +variable "password" { + default = "test12345789" +} + +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[1].type_id + password = var.password + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[1].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_redis_clear_instance_operation" "clear_instance_operation" { + instance_id = tencentcloud_redis_instance.foo.id + password = var.password +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) The ID of instance. +* `password` - (Optional, String, ForceNew) Redis instance password (password-free instances do not need to pass passwords, non-password-free instances must be transmitted). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/redis_connection_config.html.markdown b/config/docs/r/redis_connection_config.html.markdown new file mode 100644 index 0000000..fd97df6 --- /dev/null +++ b/config/docs/r/redis_connection_config.html.markdown @@ -0,0 +1,81 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_connection_config" +sidebar_current: "docs-tencentcloud-resource-redis_connection_config" +description: |- + Provides a resource to create a redis connection_config +--- + +# tencentcloud_redis_connection_config + +Provides a resource to create a redis connection_config + +## Example Usage + +### Modify the maximum number of connections and maximum network throughput of an instance + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[0].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_redis_connection_config" "connection_config" { + instance_id = "crs-fhm9fnv1" + client_limit = "20000" + add_bandwidth = "30" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of instance. +* `add_bandwidth` - (Optional, Int) Refers to the additional bandwidth of the instance. When the standard bandwidth does not meet the demand, the user can increase the bandwidth by himself. When the read-only copy is enabled, the total bandwidth of the instance = additional bandwidth * number of fragments + standard bandwidth * number of fragments * Max ([number of read-only replicas, 1] ), the number of shards in the standard architecture = 1, and when read-only replicas are not enabled, the total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards, and the number of shards in the standard architecture = 1. +* `client_limit` - (Optional, Int) The total number of connections per shard.If read-only replicas are not enabled, the lower limit is 10,000 and the upper limit is 40,000.When you enable read-only replicas, the minimum limit is 10,000 and the upper limit is 10,000 * (the number of read replicas +3). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `base_bandwidth` - standard bandwidth. Refers to the bandwidth allocated by the system to each node when an instance is purchased. +* `max_add_bandwidth` - Additional bandwidth is capped. +* `min_add_bandwidth` - Additional bandwidth sets the lower limit. +* `total_bandwidth` - Total bandwidth of the instance = additional bandwidth * number of shards + standard bandwidth * number of shards * (number of primary nodes + number of read-only replica nodes), the number of shards of the standard architecture = 1, in Mb/s. + + +## Import + +Redis connectionConfig can be imported, e.g. + +``` +$ terraform import tencentcloud_redis_connection_config.connection_config instance_id +``` + diff --git a/config/docs/r/redis_instance.html.markdown b/config/docs/r/redis_instance.html.markdown new file mode 100644 index 0000000..d2cface --- /dev/null +++ b/config/docs/r/redis_instance.html.markdown @@ -0,0 +1,287 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_instance" +sidebar_current: "docs-tencentcloud-resource-redis_instance" +description: |- + Provides a resource to create a Redis instance and set its attributes. +--- + +# tencentcloud_redis_instance + +Provides a resource to create a Redis instance and set its attributes. + +~> **NOTE:** The argument vpc_id and subnet_id is now required because Basic Network Instance is no longer supported. + +~> **NOTE:** Both adding and removing replications in one change is supported but not recommend. + +## Example Usage + +### Create a base version of redis + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[0].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} +``` + +### Using multi replica zone set + +```hcl +variable "redis_replicas_num" { + default = 3 +} + +variable "redis_type_id" { + default = 7 +} + +data "tencentcloud_availability_zones_by_product" "az" { + product = "redis" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_availability_zones_by_product.az.zones[0].name + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_security_group" "foo" { + name = "tf-redis-sg" +} + +resource "tencentcloud_security_group_lite_rule" "foo" { + security_group_id = tencentcloud_security_group.foo.id + + ingress = [ + "ACCEPT#192.168.1.0/24#80#TCP", + "DROP#8.8.8.8#80,90#UDP", + "DROP#0.0.0.0/0#80-90#TCP", + ] + + egress = [ + "ACCEPT#192.168.0.0/16#ALL#TCP", + "ACCEPT#10.0.0.0/8#ALL#ICMP", + "DROP#0.0.0.0/0#ALL#ALL", + ] +} + +resource "tencentcloud_redis_instance" "red1" { + availability_zone = data.tencentcloud_availability_zones_by_product.az.zones[0].name + type_id = var.redis_type_id + charge_type = "POSTPAID" + mem_size = 1024 + name = "test-redis" + port = 6379 + project_id = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + password = "a12121312334" + security_groups = [tencentcloud_security_group.foo.id] + redis_replicas_num = var.redis_replicas_num + redis_shard_num = 1 + replica_zone_ids = [ + for i in range(var.redis_replicas_num) + : data.tencentcloud_availability_zones_by_product.az.zones[i % length(data.tencentcloud_availability_zones_by_product.az.zones)].id + ] +} +``` + +### Buy a month of prepaid instances + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_security_group" "foo" { + name = "tf-redis-sg" +} + +resource "tencentcloud_security_group_lite_rule" "foo" { + security_group_id = tencentcloud_security_group.foo.id + + ingress = [ + "ACCEPT#192.168.1.0/24#80#TCP", + "DROP#8.8.8.8#80,90#UDP", + "DROP#0.0.0.0/0#80-90#TCP", + ] + + egress = [ + "ACCEPT#192.168.0.0/16#ALL#TCP", + "ACCEPT#10.0.0.0/8#ALL#ICMP", + "DROP#0.0.0.0/0#ALL#ALL", + ] +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[0].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.foo.id] + charge_type = "PREPAID" + prepaid_period = 1 +} +``` + +### Create a multi-AZ instance + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 + region = "ap-guangzhou" +} + +variable "replica_zone_ids" { + default = [100004, 100006] +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_security_group" "foo" { + name = "tf-redis-sg" +} + +resource "tencentcloud_security_group_lite_rule" "foo" { + security_group_id = tencentcloud_security_group.foo.id + + ingress = [ + "ACCEPT#192.168.1.0/24#80#TCP", + "DROP#8.8.8.8#80,90#UDP", + "DROP#0.0.0.0/0#80-90#TCP", + ] + + egress = [ + "ACCEPT#192.168.0.0/16#ALL#TCP", + "ACCEPT#10.0.0.0/8#ALL#ICMP", + "DROP#0.0.0.0/0#ALL#ALL", + ] +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[2].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_shard_nums[0] + redis_replicas_num = 2 + replica_zone_ids = var.replica_zone_ids + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.foo.id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Required, String, ForceNew) The available zone ID of an instance to be created, please refer to `tencentcloud_redis_zone_config.list`. +* `mem_size` - (Required, Int) The memory volume of an available instance(in MB), please refer to `tencentcloud_redis_zone_config.list[zone].shard_memories`. When redis is standard type, it represents total memory size of the instance; when Redis is cluster type, it represents memory size of per sharding. +* `auto_renew_flag` - (Optional, Int, ForceNew) Auto-renew flag. 0 - default state (manual renewal); 1 - automatic renewal; 2 - explicit no automatic renewal. +* `charge_type` - (Optional, String, ForceNew) The charge type of instance. Valid values: `PREPAID` and `POSTPAID`. Default value is `POSTPAID`. Note: TencentCloud International only supports `POSTPAID`. Caution that update operation on this field will delete old instances and create new with new charge type. +* `force_delete` - (Optional, Bool) Indicate whether to delete Redis instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin. Note: only works for `PREPAID` instance. +* `ip` - (Optional, String) IP address of an instance. When the `operation_network` is `changeVip`, this parameter needs to be configured. +* `name` - (Optional, String) Instance name. +* `no_auth` - (Optional, Bool) Indicates whether the redis instance support no-auth access. NOTE: Only available in private cloud environment. +* `operation_network` - (Optional, String) Refers to the category of the pre-modified network, including: `changeVip`: refers to switching the private network, including its intranet IPv4 address and port; `changeVpc`: refers to switching the subnet to which the private network belongs; `changeBaseToVpc`: refers to switching the basic network to a private network; `changeVPort`: refers to only modifying the instance network port. +* `params_template_id` - (Optional, String) Specify params template id. If not set, will use default template. +* `password` - (Optional, String) Password for a Redis user, which should be 8 to 16 characters. NOTE: Only `no_auth=true` specified can make password empty. +* `port` - (Optional, Int) The port used to access a redis instance. The default value is 6379. When the `operation_network` is `changeVPort` or `changeVip`, this parameter needs to be configured. +* `prepaid_period` - (Optional, Int) The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to `PREPAID`. Valid values are `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `24`, `36`. +* `project_id` - (Optional, Int) Specifies which project the instance should belong to. +* `recycle` - (Optional, Int) Original intranet IPv4 address retention time: unit: day, value range: `0`, `1`, `2`, `3`, `7`, `15`. +* `redis_replicas_num` - (Optional, Int) The number of instance copies. This is not required for standalone and master slave versions and must equal to count of `replica_zone_ids`, Non-multi-AZ does not require `replica_zone_ids`; Redis memory version 4.0, 5.0, 6.2 standard architecture and cluster architecture support the number of copies in the range [1, 2, 3, 4, 5]; Redis 2.8 standard version and CKV standard version only support 1 copy. +* `redis_shard_num` - (Optional, Int) The number of instance shards; this parameter does not need to be configured for standard version instances; for cluster version instances, the number of shards ranges from: [`1`, `3`, `5`, `8`, `12`, `16`, `24 `, `32`, `40`, `48`, `64`, `80`, `96`, `128`]. +* `replica_zone_ids` - (Optional, List: [`Int`]) ID of replica nodes available zone. This is not required for standalone and master slave versions. NOTE: Removing some of the same zone of replicas (e.g. removing 100001 of [100001, 100001, 100002]) will pick the first hit to remove. +* `replicas_read_only` - (Optional, Bool) Whether copy read-only is supported, Redis 2.8 Standard Edition and CKV Standard Edition do not support replica read-only, turn on replica read-only, the instance will automatically read and write separate, write requests are routed to the primary node, read requests are routed to the replica node, if you need to open replica read-only, the recommended number of replicas >=2. +* `security_groups` - (Optional, Set: [`String`]) ID of security group. If both vpc_id and subnet_id are not set, this argument should not be set either. +* `subnet_id` - (Optional, String) Specifies which subnet the instance should belong to. When the `operation_network` is `changeVpc` or `changeBaseToVpc`, this parameter needs to be configured. +* `tags` - (Optional, Map) Instance tags. +* `type_id` - (Optional, Int, ForceNew) Instance type. Available values reference data source `tencentcloud_redis_zone_config` or [document](https://intl.cloud.tencent.com/document/product/239/32069), toggle immediately when modified. +* `type` - (Optional, String, ForceNew, **Deprecated**) It has been deprecated from version 1.33.1. Please use 'type_id' instead. Instance type. Available values: `cluster_ckv`,`cluster_redis5.0`,`cluster_redis`,`master_slave_ckv`,`master_slave_redis4.0`,`master_slave_redis5.0`,`master_slave_redis`,`standalone_redis`, specific region support specific types, need to refer data `tencentcloud_redis_zone_config`. +* `vpc_id` - (Optional, String) ID of the vpc with which the instance is to be associated. When the `operation_network` is `changeVpc` or `changeBaseToVpc`, this parameter needs to be configured. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - The time when the instance was created. +* `node_info` - Readonly Primary/Replica nodes. + * `id` - ID of the master or replica node. + * `master` - Indicates whether the node is master. + * `zone_id` - ID of the availability zone of the master or replica node. +* `status` - Current status of an instance, maybe: init, processing, online, isolate and todelete. + + +## Import + +Redis instance can be imported, e.g. + +``` +$ terraform import tencentcloud_redis_instance.redislab redis-id +``` + diff --git a/config/docs/r/redis_maintenance_window.html.markdown b/config/docs/r/redis_maintenance_window.html.markdown new file mode 100644 index 0000000..528043e --- /dev/null +++ b/config/docs/r/redis_maintenance_window.html.markdown @@ -0,0 +1,76 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_maintenance_window" +sidebar_current: "docs-tencentcloud-resource-redis_maintenance_window" +description: |- + Provides a resource to create a redis maintenance_window +--- + +# tencentcloud_redis_maintenance_window + +Provides a resource to create a redis maintenance_window + +## Example Usage + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[0].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_redis_maintenance_window" "foo" { + instance_id = tencentcloud_redis_instance.foo.id + start_time = "17:00" + end_time = "19:00" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_time` - (Required, String) The end time of the maintenance window, e.g. 19:00. +* `instance_id` - (Required, String) The ID of instance. +* `start_time` - (Required, String) Maintenance window start time, e.g. 17:00. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +redis maintenance_window can be imported using the id, e.g. + +``` +terraform import tencentcloud_redis_maintenance_window.foo instance_id +``` + diff --git a/config/docs/r/redis_param.html.markdown b/config/docs/r/redis_param.html.markdown new file mode 100644 index 0000000..d6f9854 --- /dev/null +++ b/config/docs/r/redis_param.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_param" +sidebar_current: "docs-tencentcloud-resource-redis_param" +description: |- + Provides a resource to create a redis param +--- + +# tencentcloud_redis_param + +Provides a resource to create a redis param + +## Example Usage + +```hcl +resource "tencentcloud_redis_param" "param" { + instance_id = "crs-c1nl9rpv" + instance_params = { + "cluster-node-timeout" = "15000" + "disable-command-list" = "\"\"" + "hash-max-ziplist-entries" = "512" + "hash-max-ziplist-value" = "64" + "hz" = "10" + "lazyfree-lazy-eviction" = "yes" + "lazyfree-lazy-expire" = "yes" + "lazyfree-lazy-server-del" = "yes" + "maxmemory-policy" = "noeviction" + "notify-keyspace-events" = "\"\"" + "proxy-slowlog-log-slower-than" = "500" + "replica-lazy-flush" = "yes" + "sentineauth" = "no" + "set-max-intset-entries" = "512" + "slowlog-log-slower-than" = "10" + "timeout" = "31536000" + "zset-max-ziplist-entries" = "128" + "zset-max-ziplist-value" = "64" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of instance. +* `instance_params` - (Required, Map) A list of parameters modified by the instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +redis param can be imported using the instanceId, e.g. + +``` +terraform import tencentcloud_redis_param.param crs-c1nl9rpv +``` + diff --git a/config/docs/r/redis_param_template.html.markdown b/config/docs/r/redis_param_template.html.markdown new file mode 100644 index 0000000..93b37c9 --- /dev/null +++ b/config/docs/r/redis_param_template.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_param_template" +sidebar_current: "docs-tencentcloud-resource-redis_param_template" +description: |- + Provides a resource to create a redis parameter template +--- + +# tencentcloud_redis_param_template + +Provides a resource to create a redis parameter template + +## Example Usage + +```hcl +resource "tencentcloud_redis_param_template" "param_template" { + name = "example-template" + description = "This is an example redis param template." + product_type = 6 + params_override { + key = "timeout" + value = "7200" + } +} +``` + +### Copy from another template + +```hcl +resource "tencentcloud_redis_param_template" "foo" { + name = "tf-template" + description = "This is an example redis param template." + product_type = 6 + params_override { + key = "timeout" + value = "7200" + } +} + +resource "tencentcloud_redis_param_template" "param_template" { + name = "tf-template-copied" + description = "This is an copied redis param template from tf-template." + template_id = tencentcloud_redis_param_template.foo.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Parameter template name. +* `description` - (Optional, String) Parameter template description. +* `params_override` - (Optional, List) Specify override parameter list, NOTE: Do not remove override params once set, removing will not take effects to current value. +* `product_type` - (Optional, Int) Specify product type. Valid values: 1 (Redis 2.8 Memory Edition in cluster architecture), 2 (Redis 2.8 Memory Edition in standard architecture), 3 (CKV 3.2 Memory Edition in standard architecture), 4 (CKV 3.2 Memory Edition in cluster architecture), 5 (Redis 2.8 Memory Edition in standalone architecture), 6 (Redis 4.0 Memory Edition in standard architecture), 7 (Redis 4.0 Memory Edition in cluster architecture), 8 (Redis 5.0 Memory Edition in standard architecture), 9 (Redis 5.0 Memory Edition in cluster architecture). If `template_id` is specified, this parameter can be left blank; otherwise, it is required. +* `template_id` - (Optional, String) Specify which existed template import from. + +The `params_override` object supports the following: + +* `key` - (Required, String) Parameter key e.g. `timeout`, check https://www.tencentcloud.com/document/product/239/39796 for more reference. +* `value` - (Required, String) Parameter value, check https://www.tencentcloud.com/document/product/239/39796 for more reference. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `param_details` - Readonly full parameter list details. + * `current_value` - Current value. + * `default` - Default value. + * `description` - Parameter description. + * `enum_value` - Enum values. + * `max` - Maximum value. + * `min` - Minimum value. + * `name` - Parameter key name. + * `need_reboot` - Indicates whether to reboot redis instance if modified. + * `param_type` - Parameter type. + + +## Import + +redis param_template can be imported using the id, e.g. +``` +$ terraform import tencentcloud_redis_param_template.param_template param_template_id +``` + diff --git a/config/docs/r/redis_read_only.html.markdown b/config/docs/r/redis_read_only.html.markdown new file mode 100644 index 0000000..da62402 --- /dev/null +++ b/config/docs/r/redis_read_only.html.markdown @@ -0,0 +1,97 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_read_only" +sidebar_current: "docs-tencentcloud-resource-redis_read_only" +description: |- + Provides a resource to create a redis read_only +--- + +# tencentcloud_redis_read_only + +Provides a resource to create a redis read_only + +## Example Usage + +### Set instance input mode + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_security_group" "foo" { + name = "tf-redis-sg" +} + +resource "tencentcloud_security_group_lite_rule" "foo" { + security_group_id = tencentcloud_security_group.foo.id + + ingress = [ + "ACCEPT#192.168.1.0/24#80#TCP", + "DROP#8.8.8.8#80,90#UDP", + "DROP#0.0.0.0/0#80-90#TCP", + ] + + egress = [ + "ACCEPT#192.168.0.0/16#ALL#TCP", + "ACCEPT#10.0.0.0/8#ALL#ICMP", + "DROP#0.0.0.0/0#ALL#ALL", + ] +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[0].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.foo.id] +} + +resource "tencentcloud_redis_read_only" "read_only" { + instance_id = tencentcloud_redis_instance.foo.id + input_mode = "0" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `input_mode` - (Required, String) Instance input mode: `0`: read-write; `1`: read-only. +* `instance_id` - (Required, String) The ID of instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +redis read_only can be imported using the instanceId, e.g. + +``` +terraform import tencentcloud_redis_read_only.read_only crs-c1nl9rpv +``` + diff --git a/config/docs/r/redis_renew_instance_operation.html.markdown b/config/docs/r/redis_renew_instance_operation.html.markdown new file mode 100644 index 0000000..7cdaf55 --- /dev/null +++ b/config/docs/r/redis_renew_instance_operation.html.markdown @@ -0,0 +1,90 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_renew_instance_operation" +sidebar_current: "docs-tencentcloud-resource-redis_renew_instance_operation" +description: |- + Provides a resource to create a redis renew_instance_operation +--- + +# tencentcloud_redis_renew_instance_operation + +Provides a resource to create a redis renew_instance_operation + +## Example Usage + +### Renew Subscription Instances + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 +} + +data "tencentcloud_vpc" "vpc" { + name = "Default-VPC" +} + +data "tencentcloud_vpc_subnets" "subnet" { + vpc_id = data.tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone +} + +resource "tencentcloud_security_group" "foo" { + name = "tf-redis-sg" +} + +resource "tencentcloud_security_group_lite_rule" "foo" { + security_group_id = tencentcloud_security_group.foo.id + + ingress = [ + "ACCEPT#192.168.1.0/24#80#TCP", + "DROP#8.8.8.8#80,90#UDP", + "DROP#0.0.0.0/0#80-90#TCP", + ] + + egress = [ + "ACCEPT#192.168.0.0/16#ALL#TCP", + "ACCEPT#10.0.0.0/8#ALL#ICMP", + "DROP#0.0.0.0/0#ALL#ALL", + ] +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[0].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = data.tencentcloud_vpc.vpc.id + subnet_id = data.tencentcloud_vpc_subnets.subnet.instance_list[0].subnet_id + security_groups = [tencentcloud_security_group.foo.id] + charge_type = "PREPAID" + prepaid_period = 1 +} + +resource "tencentcloud_redis_renew_instance_operation" "foo" { + instance_id = tencentcloud_redis_instance.foo.id + period = 1 + modify_pay_mode = "prepaid" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) The ID of instance. +* `period` - (Required, Int, ForceNew) Purchase duration, in months. +* `modify_pay_mode` - (Optional, String, ForceNew) Identifies whether the billing model is modified:The current instance billing mode is pay-as-you-go, which is prepaid and renewed.The billing mode of the current instance is subscription and you can not set this parameter. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/redis_replica_readonly.html.markdown b/config/docs/r/redis_replica_readonly.html.markdown new file mode 100644 index 0000000..7935ea9 --- /dev/null +++ b/config/docs/r/redis_replica_readonly.html.markdown @@ -0,0 +1,89 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_replica_readonly" +sidebar_current: "docs-tencentcloud-resource-redis_replica_readonly" +description: |- + Provides a resource to create a redis replica_readonly +--- + +# tencentcloud_redis_replica_readonly + +Provides a resource to create a redis replica_readonly + +## Example Usage + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[1].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_security_group" "foo" { + name = "tf-redis-sg" +} + +resource "tencentcloud_security_group_lite_rule" "foo" { + security_group_id = tencentcloud_security_group.foo.id + + ingress = [ + "ACCEPT#192.168.1.0/24#80#TCP", + "DROP#8.8.8.8#80,90#UDP", + "DROP#0.0.0.0/0#80-90#TCP", + ] + + egress = [ + "ACCEPT#192.168.0.0/16#ALL#TCP", + "ACCEPT#10.0.0.0/8#ALL#ICMP", + "DROP#0.0.0.0/0#ALL#ALL", + ] +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[0].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[0].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[0].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.foo.id] +} + +resource "tencentcloud_redis_replica_readonly" "replica_readonly" { + instance_id = tencentcloud_redis_instance.foo.id + readonly_policy = ["master"] + operate = "enable" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of instance. +* `operate` - (Required, String) The replica is read-only, `enable` - enable read-write splitting, `disable`- disable read-write splitting. +* `readonly_policy` - (Optional, Set: [`String`]) Routing policy: Enter `master` or `replication`, which indicates the master node or slave node. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/redis_replicate_attachment.html.markdown b/config/docs/r/redis_replicate_attachment.html.markdown new file mode 100644 index 0000000..c9ee353 --- /dev/null +++ b/config/docs/r/redis_replicate_attachment.html.markdown @@ -0,0 +1,112 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_replicate_attachment" +sidebar_current: "docs-tencentcloud-resource-redis_replicate_attachment" +description: |- + Provides a resource to create a redis replicate_attachment +--- + +# tencentcloud_redis_replicate_attachment + +Provides a resource to create a redis replicate_attachment + +## Example Usage + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 + region = "ap-guangzhou" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_security_group" "foo" { + name = "tf-redis-sg" +} + +resource "tencentcloud_security_group_lite_rule" "foo" { + security_group_id = tencentcloud_security_group.foo.id + + ingress = [ + "ACCEPT#192.168.1.0/24#80#TCP", + "DROP#8.8.8.8#80,90#UDP", + "DROP#0.0.0.0/0#80-90#TCP", + ] + + egress = [ + "ACCEPT#192.168.0.0/16#ALL#TCP", + "ACCEPT#10.0.0.0/8#ALL#ICMP", + "DROP#0.0.0.0/0#ALL#ALL", + ] +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[2].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.foo.id] +} + +resource "tencentcloud_redis_instance" "instance" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[2].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_replicas_nums[0] + name = "terrform_test_instance" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.foo.id] +} + +resource "tencentcloud_redis_replicate_attachment" "replicate_attachment" { + group_id = "crs-rpl-orfiwmn5" + master_instance_id = tencentcloud_redis_instance.foo.id + instance_ids = [tencentcloud_redis_instance.instance.id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String) The ID of group. +* `instance_ids` - (Required, Set: [`String`]) All instance ids of the replication group. +* `master_instance_id` - (Required, String) The ID of master instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +redis replicate_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_redis_replicate_attachment.replicate_attachment replicate_attachment_id +``` + diff --git a/config/docs/r/redis_security_group_attachment.html.markdown b/config/docs/r/redis_security_group_attachment.html.markdown new file mode 100644 index 0000000..e42627a --- /dev/null +++ b/config/docs/r/redis_security_group_attachment.html.markdown @@ -0,0 +1,111 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_security_group_attachment" +sidebar_current: "docs-tencentcloud-resource-redis_security_group_attachment" +description: |- + Provides a resource to create a redis security_group_attachment +--- + +# tencentcloud_redis_security_group_attachment + +Provides a resource to create a redis security_group_attachment + +## Example Usage + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 + region = "ap-guangzhou" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_security_group" "foo" { + name = "tf-redis-sg" +} + +resource "tencentcloud_security_group_lite_rule" "foo" { + security_group_id = tencentcloud_security_group.foo.id + + ingress = [ + "ACCEPT#192.168.1.0/24#80#TCP", + "DROP#8.8.8.8#80,90#UDP", + "DROP#0.0.0.0/0#80-90#TCP", + ] + + egress = [ + "ACCEPT#192.168.0.0/16#ALL#TCP", + "ACCEPT#10.0.0.0/8#ALL#ICMP", + "DROP#0.0.0.0/0#ALL#ALL", + ] +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[2].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.foo.id] +} + +resource "tencentcloud_redis_instance" "instance" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[2].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_replicas_nums[0] + name = "terrform_test_instance" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.foo.id] +} + +resource "tencentcloud_redis_replicate_attachment" "replicate_attachment" { + group_id = "crs-rpl-orfiwmn5" + master_instance_id = tencentcloud_redis_instance.foo.id + instance_ids = [tencentcloud_redis_instance.instance.id] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `security_group_id` - (Required, String, ForceNew) Security group ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +redis security_group_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_redis_security_group_attachment.security_group_attachment instance_id#security_group_id +``` + diff --git a/config/docs/r/redis_ssl.html.markdown b/config/docs/r/redis_ssl.html.markdown new file mode 100644 index 0000000..bac4439 --- /dev/null +++ b/config/docs/r/redis_ssl.html.markdown @@ -0,0 +1,96 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_ssl" +sidebar_current: "docs-tencentcloud-resource-redis_ssl" +description: |- + Provides a resource to create a redis ssl +--- + +# tencentcloud_redis_ssl + +Provides a resource to create a redis ssl + +## Example Usage + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 + region = "ap-guangzhou" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_security_group" "foo" { + name = "tf-redis-sg" +} + +resource "tencentcloud_security_group_lite_rule" "foo" { + security_group_id = tencentcloud_security_group.foo.id + + ingress = [ + "ACCEPT#192.168.1.0/24#80#TCP", + "DROP#8.8.8.8#80,90#UDP", + "DROP#0.0.0.0/0#80-90#TCP", + ] + + egress = [ + "ACCEPT#192.168.0.0/16#ALL#TCP", + "ACCEPT#10.0.0.0/8#ALL#ICMP", + "DROP#0.0.0.0/0#ALL#ALL", + ] +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[2].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_replicas_nums[0] + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.foo.id] +} + +resource "tencentcloud_redis_ssl" "ssl" { + instance_id = tencentcloud_redis_instance.foo.id + ssl_config = "disabled" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of instance. +* `ssl_config` - (Required, String) The SSL configuration status of the instance: `enabled`,`disabled`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +redis ssl can be imported using the instanceId, e.g. + +``` +terraform import tencentcloud_redis_ssl.ssl crs-c1nl9rpv +``` + diff --git a/config/docs/r/redis_startup_instance_operation.html.markdown b/config/docs/r/redis_startup_instance_operation.html.markdown new file mode 100644 index 0000000..5f60ecc --- /dev/null +++ b/config/docs/r/redis_startup_instance_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_startup_instance_operation" +sidebar_current: "docs-tencentcloud-resource-redis_startup_instance_operation" +description: |- + Provides a resource to create a redis startup_instance_operation +--- + +# tencentcloud_redis_startup_instance_operation + +Provides a resource to create a redis startup_instance_operation + +## Example Usage + +### Recover the redis instance that has been isolated + +```hcl +resource "tencentcloud_redis_startup_instance_operation" "foo" { + instance_id = "crs-c1nl9rpv" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) The ID of instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/redis_switch_master.html.markdown b/config/docs/r/redis_switch_master.html.markdown new file mode 100644 index 0000000..2a5f021 --- /dev/null +++ b/config/docs/r/redis_switch_master.html.markdown @@ -0,0 +1,97 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_switch_master" +sidebar_current: "docs-tencentcloud-resource-redis_switch_master" +description: |- + Provides a resource to create a redis switch_master +--- + +# tencentcloud_redis_switch_master + +Provides a resource to create a redis switch_master + +## Example Usage + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 7 + region = "ap-guangzhou" +} + +variable "replica_zone_ids" { + default = [100004, 100006] +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_redis_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + name = "tf_redis_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_security_group" "foo" { + name = "tf-redis-sg" +} + +resource "tencentcloud_security_group_lite_rule" "foo" { + security_group_id = tencentcloud_security_group.foo.id + + ingress = [ + "ACCEPT#192.168.1.0/24#80#TCP", + "DROP#8.8.8.8#80,90#UDP", + "DROP#0.0.0.0/0#80-90#TCP", + ] + + egress = [ + "ACCEPT#192.168.0.0/16#ALL#TCP", + "ACCEPT#10.0.0.0/8#ALL#ICMP", + "DROP#0.0.0.0/0#ALL#ALL", + ] +} + +resource "tencentcloud_redis_instance" "foo" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[2].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[2].type_id + password = "test12345789" + mem_size = 8192 + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[2].redis_shard_nums[0] + redis_replicas_num = 2 + replica_zone_ids = var.replica_zone_ids + name = "terrform_test" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.foo.id] +} + +data "tencentcloud_redis_instance_zone_info" "foo" { + instance_id = tencentcloud_redis_instance.foo.id +} + +resource "tencentcloud_redis_switch_master" "switch_master" { + instance_id = tencentcloud_redis_instance.foo.id + group_id = data.tencentcloud_redis_instance_zone_info.foo.replica_groups[1].group_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of instance. +* `group_id` - (Optional, Int) Replication group ID, required for multi-AZ instances. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/redis_switck_master.html.markdown b/config/docs/r/redis_switck_master.html.markdown new file mode 100644 index 0000000..e50fd7b --- /dev/null +++ b/config/docs/r/redis_switck_master.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_switch_master" +sidebar_current: "docs-tencentcloud-resource-redis_switch_master" +description: |- + Provides a resource to create a redis switch_master +--- + +# tencentcloud_redis_switch_master + +Provides a resource to create a redis switch_master + +## Example Usage + +```hcl +resource "tencentcloud_redis_switch_master" "switch_master" { + instance_id = "crs-kfdkirid" + group_id = 29369 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) The ID of instance. +* `group_id` - (Optional, Int) Replication group ID, required for multi-AZ instances. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/redis_upgrade_cache_version_operation.html.markdown b/config/docs/r/redis_upgrade_cache_version_operation.html.markdown new file mode 100644 index 0000000..444e5ab --- /dev/null +++ b/config/docs/r/redis_upgrade_cache_version_operation.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_upgrade_cache_version_operation" +sidebar_current: "docs-tencentcloud-resource-redis_upgrade_cache_version_operation" +description: |- + Provides a resource to create a redis upgrade_cache_version_operation +--- + +# tencentcloud_redis_upgrade_cache_version_operation + +Provides a resource to create a redis upgrade_cache_version_operation + +## Example Usage + +```hcl +resource "tencentcloud_redis_upgrade_cache_version_operation" "upgrade_cache_version_operation" { + instance_id = "crs-c1nl9rpv" + current_redis_version = "5.0.0" + upgrade_redis_version = "5.0.0" + instance_type_upgrade_now = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `current_redis_version` - (Required, String, ForceNew) Current redis version. +* `instance_id` - (Required, String, ForceNew) The ID of instance. +* `instance_type_upgrade_now` - (Required, Int, ForceNew) Switch mode:1 - Upgrade now0 - Maintenance window upgrade. +* `upgrade_redis_version` - (Required, String, ForceNew) Upgradeable redis version. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/redis_upgrade_multi_zone_operation.html.markdown b/config/docs/r/redis_upgrade_multi_zone_operation.html.markdown new file mode 100644 index 0000000..aa70c16 --- /dev/null +++ b/config/docs/r/redis_upgrade_multi_zone_operation.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_upgrade_multi_zone_operation" +sidebar_current: "docs-tencentcloud-resource-redis_upgrade_multi_zone_operation" +description: |- + Provides a resource to create a redis upgrade_multi_zone_operation +--- + +# tencentcloud_redis_upgrade_multi_zone_operation + +Provides a resource to create a redis upgrade_multi_zone_operation + +## Example Usage + +```hcl +resource "tencentcloud_redis_upgrade_multi_zone_operation" "upgrade_multi_zone_operation" { + instance_id = "crs-c1nl9rpv" + upgrade_proxy_and_redis_server = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) The ID of instance. +* `upgrade_proxy_and_redis_server` - (Optional, Bool, ForceNew) After you upgrade Multi-AZ, whether the nearby access feature is supported.true: Supports nearby access.The upgrade process, which requires upgrading both the proxy version and the Redis kernel minor version, involves data migration and can take several hours.false: No need to support nearby access.Upgrading Multi-AZ only involves managing metadata migration, with no service impact, and the upgrade process typically completes within 3 minutes. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/redis_upgrade_proxy_version_operation.html.markdown b/config/docs/r/redis_upgrade_proxy_version_operation.html.markdown new file mode 100644 index 0000000..ae2666a --- /dev/null +++ b/config/docs/r/redis_upgrade_proxy_version_operation.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TencentDB for Redis(crs)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_redis_upgrade_proxy_version_operation" +sidebar_current: "docs-tencentcloud-resource-redis_upgrade_proxy_version_operation" +description: |- + Provides a resource to create a redis upgrade_proxy_version_operation +--- + +# tencentcloud_redis_upgrade_proxy_version_operation + +Provides a resource to create a redis upgrade_proxy_version_operation + +## Example Usage + +```hcl +resource "tencentcloud_redis_upgrade_proxy_version_operation" "upgrade_proxy_version_operation" { + instance_id = "crs-c1nl9rpv" + current_proxy_version = "5.0.0" + upgrade_proxy_version = "5.0.0" + instance_type_upgrade_now = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `current_proxy_version` - (Required, String, ForceNew) Current proxy version. +* `instance_id` - (Required, String, ForceNew) The ID of instance. +* `instance_type_upgrade_now` - (Required, Int, ForceNew) Switch mode:1 - Upgrade now0 - Maintenance window upgrade. +* `upgrade_proxy_version` - (Required, String, ForceNew) Upgradeable redis proxy version. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/reserved_instance.html.markdown b/config/docs/r/reserved_instance.html.markdown new file mode 100644 index 0000000..cd29634 --- /dev/null +++ b/config/docs/r/reserved_instance.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Cloud Virtual Machine(CVM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_reserved_instance" +sidebar_current: "docs-tencentcloud-resource-reserved_instance" +description: |- + Provides a reserved instance resource. +--- + +# tencentcloud_reserved_instance + +Provides a reserved instance resource. + +~> **NOTE:** Reserved instance cannot be deleted and updated. The reserved instance still exist which can be extracted by reserved_instances data source when reserved instance is destroied. + +## Example Usage + +```hcl +resource "tencentcloud_reserved_instance" "ri" { + config_id = "469043dd-28b9-4d89-b557-74f6a8326259" + instance_count = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_id` - (Required, String) Configuration ID of the reserved instance. +* `instance_count` - (Required, Int) Number of reserved instances to be purchased. +* `reserved_instance_name` - (Optional, String) Reserved Instance display name. + - If you do not specify an instance display name, 'Unnamed' is displayed by default. + - Up to 60 characters (including pattern strings) are supported. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `end_time` - Expiry time of the RI. +* `start_time` - Start time of the RI. +* `status` - Status of the RI at the time of purchase. + + +## Import + +Reserved instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_reserved_instance.foo 6cc16e7c-47d7-4fae-9b44-ce5c0f59a920 +``` + diff --git a/config/docs/r/route_entry.html.markdown b/config/docs/r/route_entry.html.markdown new file mode 100644 index 0000000..a53eabd --- /dev/null +++ b/config/docs/r/route_entry.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_route_entry" +sidebar_current: "docs-tencentcloud-resource-route_entry" +description: |- + Provides a resource to create a routing entry in a VPC routing table. +--- + +# tencentcloud_route_entry + +Provides a resource to create a routing entry in a VPC routing table. + +~> **NOTE:** It has been deprecated and replaced by tencentcloud_route_table_entry. + +## Example Usage + +```hcl +resource "tencentcloud_vpc" "main" { + name = "Used to test the routing entry" + cidr_block = "10.4.0.0/16" +} + +resource "tencentcloud_route_table" "r" { + name = "Used to test the routing entry" + vpc_id = tencentcloud_vpc.main.id +} + +resource "tencentcloud_route_entry" "rtb_entry_instance" { + vpc_id = tencentcloud_route_table.main.vpc_id + route_table_id = tencentcloud_route_table.r.id + cidr_block = "10.4.8.0/24" + next_type = "instance" + next_hub = "10.16.1.7" +} + +resource "tencentcloud_route_entry" "rtb_entry_instance" { + vpc_id = tencentcloud_route_table.main.vpc_id + route_table_id = tencentcloud_route_table.r.id + cidr_block = "10.4.5.0/24" + next_type = "vpn_gateway" + next_hub = "vpngw-db52irtl" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cidr_block` - (Required, String, ForceNew) The RouteEntry's target network segment. +* `next_hub` - (Required, String, ForceNew) The route entry's next hub. CVM instance ID or VPC router interface ID. +* `next_type` - (Required, String, ForceNew) The next hop type. Valid values: `public_gateway`,`vpn_gateway`,`sslvpn_gateway`,`dc_gateway`,`peering_connection`,`nat_gateway`,`havip`,`local_gateway` and `instance`. `instance` points to CVM Instance. +* `route_table_id` - (Required, String, ForceNew) The ID of the route table. +* `vpc_id` - (Required, String, ForceNew) The VPC ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/route_table.html.markdown b/config/docs/r/route_table.html.markdown new file mode 100644 index 0000000..3a22f20 --- /dev/null +++ b/config/docs/r/route_table.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_route_table" +sidebar_current: "docs-tencentcloud-resource-route_table" +description: |- + Provides a resource to create a VPC routing table. +--- + +# tencentcloud_route_table + +Provides a resource to create a VPC routing table. + +## Example Usage + +```hcl +resource "tencentcloud_vpc" "foo" { + name = "ci-temp-test" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_route_table" "foo" { + vpc_id = tencentcloud_vpc.foo.id + name = "ci-temp-test-rt" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) The name of routing table. +* `vpc_id` - (Required, String, ForceNew) ID of VPC to which the route table should be associated. +* `tags` - (Optional, Map) The tags of routing table. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of the routing table. +* `is_default` - Indicates whether it is the default routing table. +* `route_entry_ids` - ID list of the routing entries. +* `subnet_ids` - ID list of the subnets associated with this route table. + + +## Import + +Vpc routetable instance can be imported, e.g. + +``` +$ terraform import tencentcloud_route_table.test route_table_id +``` + diff --git a/config/docs/r/route_table_association.html.markdown b/config/docs/r/route_table_association.html.markdown new file mode 100644 index 0000000..b2fd2c2 --- /dev/null +++ b/config/docs/r/route_table_association.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_route_table_association" +sidebar_current: "docs-tencentcloud-resource-route_table_association" +description: |- + Provides a resource to create a vpc route_table +--- + +# tencentcloud_route_table_association + +Provides a resource to create a vpc route_table + +## Example Usage + +```hcl +resource "tencentcloud_route_table_association" "route_table_association" { + route_table_id = "rtb-5toos5sy" + subnet_id = "subnet-2y2omd4k" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `route_table_id` - (Required, String) The route table instance ID, such as `rtb-azd4dt1c`. +* `subnet_id` - (Required, String, ForceNew) Subnet instance ID, such as `subnet-3x5lf5q0`. This can be queried using the DescribeSubnets API. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc route_table can be imported using the id, e.g. + +``` +terraform import tencentcloud_route_table_association.route_table_association subnet_id +``` + diff --git a/config/docs/r/route_table_entry.html.markdown b/config/docs/r/route_table_entry.html.markdown new file mode 100644 index 0000000..bf1570e --- /dev/null +++ b/config/docs/r/route_table_entry.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_route_table_entry" +sidebar_current: "docs-tencentcloud-resource-route_table_entry" +description: |- + Provides a resource to create an entry of a routing table. +--- + +# tencentcloud_route_table_entry + +Provides a resource to create an entry of a routing table. + +## Example Usage + +```hcl +variable "availability_zone" { + default = "na-siliconvalley-1" +} + +resource "tencentcloud_vpc" "foo" { + name = "ci-temp-test" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "foo" { + vpc_id = tencentcloud_vpc.foo.id + name = "terraform test subnet" + cidr_block = "10.0.12.0/24" + availability_zone = var.availability_zone + route_table_id = tencentcloud_route_table.foo.id +} + +resource "tencentcloud_route_table" "foo" { + vpc_id = tencentcloud_vpc.foo.id + name = "ci-temp-test-rt" +} + +resource "tencentcloud_route_table_entry" "instance" { + route_table_id = tencentcloud_route_table.foo.id + destination_cidr_block = "10.4.4.0/24" + next_type = "EIP" + next_hub = "0" + description = "ci-test-route-table-entry" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `destination_cidr_block` - (Required, String, ForceNew) Destination address block. +* `next_hub` - (Required, String, ForceNew) ID of next-hop gateway. Note: when `next_type` is EIP, GatewayId should be `0`. +* `next_type` - (Required, String, ForceNew) Type of next-hop. Valid values: `CVM`, `VPN`, `DIRECTCONNECT`, `PEERCONNECTION`, `HAVIP`, `NAT`, `NORMAL_CVM`, `EIP` and `LOCAL_GATEWAY`. +* `route_table_id` - (Required, String, ForceNew) ID of routing table to which this entry belongs. +* `description` - (Optional, String, ForceNew) Description of the routing table entry. +* `disabled` - (Optional, Bool) Whether the entry is disabled, default is `false`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Route table entry can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_route_table_entry.foo 83517.rtb-mlhpg09u +``` + diff --git a/config/docs/r/rum_instance_status_config.html.markdown b/config/docs/r/rum_instance_status_config.html.markdown new file mode 100644 index 0000000..b47927d --- /dev/null +++ b/config/docs/r/rum_instance_status_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_instance_status_config" +sidebar_current: "docs-tencentcloud-resource-rum_instance_status_config" +description: |- + Provides a resource to create a rum instance_status_config +--- + +# tencentcloud_rum_instance_status_config + +Provides a resource to create a rum instance_status_config + +## Example Usage + +```hcl +resource "tencentcloud_rum_instance_status_config" "instance_status_config" { + instance_id = "rum-pasZKEI3RLgakj" + operate = "stop" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `operate` - (Required, String) `resume`, `stop`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `instance_status` - Instance status (`1`=creating, `2`=running, `3`=abnormal, `4`=restarting, `5`=stopping, `6`=stopped, `7`=deleted). + + +## Import + +rum instance_status_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_rum_instance_status_config.instance_status_config instance_id +``` + diff --git a/config/docs/r/rum_offline_log_config_attachment.html.markdown b/config/docs/r/rum_offline_log_config_attachment.html.markdown new file mode 100644 index 0000000..3cba976 --- /dev/null +++ b/config/docs/r/rum_offline_log_config_attachment.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_offline_log_config_attachment" +sidebar_current: "docs-tencentcloud-resource-rum_offline_log_config_attachment" +description: |- + Provides a resource to create a rum offline_log_config_attachment +--- + +# tencentcloud_rum_offline_log_config_attachment + +Provides a resource to create a rum offline_log_config_attachment + +## Example Usage + +```hcl +resource "tencentcloud_rum_offline_log_config_attachment" "offline_log_config_attachment" { + project_key = "ZEYrYfvaYQ30jRdmPx" + unique_id = "100027012454" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_key` - (Required, String, ForceNew) Unique project key for reporting. +* `unique_id` - (Required, String, ForceNew) Unique identifier of the user to be listened on(aid or uin). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `msg` - Interface call information. + + +## Import + +rum offline_log_config_attachment can be imported using the id, e.g. +``` +$ terraform import tencentcloud_rum_offline_log_config_attachment.offline_log_config_attachment ZEYrYfvaYQ30jRdmPx#100027012454 +``` + diff --git a/config/docs/r/rum_project.html.markdown b/config/docs/r/rum_project.html.markdown new file mode 100644 index 0000000..b07e26d --- /dev/null +++ b/config/docs/r/rum_project.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_project" +sidebar_current: "docs-tencentcloud-resource-rum_project" +description: |- + Provides a resource to create a rum project +--- + +# tencentcloud_rum_project + +Provides a resource to create a rum project + +## Example Usage + +```hcl +resource "tencentcloud_rum_project" "project" { + name = "projectName" + instance_id = "rum-pasZKEI3RLgakj" + rate = "100" + enable_url_group = "0" + type = "web" + repo = "" + url = "iac-tf.com" + desc = "projectDesc-1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `enable_url_group` - (Required, Int) Whether to enable aggregation. +* `instance_id` - (Required, String) Business system ID. +* `name` - (Required, String) Name of the created project (required and up to 200 characters). +* `rate` - (Required, String) Project sampling rate (greater than or equal to 0). +* `type` - (Required, String) Project type (valid values: `web`, `mp`, `android`, `ios`, `node`, `hippy`, `weex`, `viola`, `rn`). +* `desc` - (Optional, String) Description of the created project (optional and up to 1,000 characters). +* `repo` - (Optional, String) Repository address of the project (optional and up to 256 characters). +* `url` - (Optional, String) Webpage address of the project (optional and up to 256 characters). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creata Time. +* `creator` - Creator ID. +* `instance_key` - Instance key. +* `instance_name` - Instance name. +* `is_star` - Starred status. `1`: yes; `0`: no. +* `key` - Unique project key (12 characters). +* `project_status` - Project status (`1`: Creating; `2`: Running; `3`: Abnormal; `4`: Restarting; `5`: Stopping; `6`: Stopped; `7`: Terminating; `8`: Terminated). + + +## Import + +rum project can be imported using the id, e.g. +``` +$ terraform import tencentcloud_rum_project.project project_id +``` + diff --git a/config/docs/r/rum_project_status_config.html.markdown b/config/docs/r/rum_project_status_config.html.markdown new file mode 100644 index 0000000..9732273 --- /dev/null +++ b/config/docs/r/rum_project_status_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_project_status_config" +sidebar_current: "docs-tencentcloud-resource-rum_project_status_config" +description: |- + Provides a resource to create a rum project_status_config +--- + +# tencentcloud_rum_project_status_config + +Provides a resource to create a rum project_status_config + +## Example Usage + +```hcl +resource "tencentcloud_rum_project_status_config" "project_status_config" { + project_id = 131407 + operate = "stop" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `operate` - (Required, String) `resume`, `stop`. +* `project_id` - (Required, Int, ForceNew) Project ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +rum project_status_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_rum_project_status_config.project_status_config project_id +``` + diff --git a/config/docs/r/rum_taw_instance.html.markdown b/config/docs/r/rum_taw_instance.html.markdown new file mode 100644 index 0000000..95b08ad --- /dev/null +++ b/config/docs/r/rum_taw_instance.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_taw_instance" +sidebar_current: "docs-tencentcloud-resource-rum_taw_instance" +description: |- + Provides a resource to create a rum taw_instance +--- + +# tencentcloud_rum_taw_instance + +Provides a resource to create a rum taw_instance + +## Example Usage + +```hcl +resource "tencentcloud_rum_taw_instance" "taw_instance" { + area_id = "1" + charge_type = "1" + data_retention_days = "30" + instance_name = "instanceName-1" + tags = { + createdBy = "terraform" + } + instance_desc = "instanceDesc-1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `area_id` - (Required, Int) Region ID (at least greater than 0). +* `charge_type` - (Required, Int) Billing type (1: Pay-as-you-go). +* `data_retention_days` - (Required, Int) Data retention period (at least greater than 0). +* `instance_name` - (Required, String) Instance name (up to 255 bytes). +* `instance_desc` - (Optional, String) Instance description (up to 1,024 bytes). +* `tags` - (Optional, Map) Tag description list. Up to 10 tag key-value pairs are supported and must be unique. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `charge_status` - Billing status (`1` = in use, `2` = expired, `3` = destroyed, `4` = assigning, `5` = failed). +* `cluster_id` - Cluster ID. +* `created_at` - Create time. +* `instance_status` - Instance status (`1` = creating, `2` = running, `3` = exception, `4` = restarting, `5` = stopping, `6` = stopped, `7` = deleted). +* `updated_at` - Update time. + + +## Import + +rum taw_instance can be imported using the id, e.g. +``` +$ terraform import tencentcloud_rum_taw_instance.taw_instance tawInstance_id +``` + diff --git a/config/docs/r/rum_whitelist.html.markdown b/config/docs/r/rum_whitelist.html.markdown new file mode 100644 index 0000000..a4b4cae --- /dev/null +++ b/config/docs/r/rum_whitelist.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Real User Monitoring(RUM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_rum_whitelist" +sidebar_current: "docs-tencentcloud-resource-rum_whitelist" +description: |- + Provides a resource to create a rum whitelist +--- + +# tencentcloud_rum_whitelist + +Provides a resource to create a rum whitelist + +## Example Usage + +```hcl +resource "tencentcloud_rum_whitelist" "whitelist" { + instance_id = "rum-pasZKEI3RLgakj" + remark = "white list remark" + whitelist_uin = "20221122" + # aid = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID, such as taw-123. +* `remark` - (Required, String) Remarks. +* `whitelist_uin` - (Required, String) uin: business identifier. +* `aid` - (Optional, String) Business identifier. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time. +* `create_user` - Creator ID. +* `ttl` - End time. +* `wid` - Auto-Increment allowlist ID. + + +## Import + +rum whitelist can be imported using the id, e.g. +``` +$ terraform import tencentcloud_rum_whitelist.whitelist whitelist_id +``` + diff --git a/config/docs/r/scf_function.html.markdown b/config/docs/r/scf_function.html.markdown new file mode 100644 index 0000000..652976a --- /dev/null +++ b/config/docs/r/scf_function.html.markdown @@ -0,0 +1,159 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_function" +sidebar_current: "docs-tencentcloud-resource-scf_function" +description: |- + Provide a resource to create a SCF function. +--- + +# tencentcloud_scf_function + +Provide a resource to create a SCF function. + +## Example Usage + +```hcl +resource "tencentcloud_scf_function" "foo" { + name = "ci-test-function" + handler = "main.do_it" + runtime = "Python3.6" + + cos_bucket_name = "scf-code-1234567890" + cos_object_name = "code.zip" + cos_bucket_region = "ap-guangzhou" +} +``` + +### Using Zip file + +```hcl +resource "tencentcloud_scf_function" "foo" { + name = "ci-test-function" + handler = "first.do_it_first" + runtime = "Python3.6" + enable_public_net = true + dns_cache = true + intranet_config { + ip_fixed = "ENABLE" + } + vpc_id = "vpc-391sv4w3" + subnet_id = "subnet-ljyn7h30" + + zip_file = "/scf/first.zip" + + tags = { + "env" = "test" + } +} + +Using CFS config +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String, ForceNew) Name of the SCF function. Name supports 26 English letters, numbers, connectors, and underscores, it should start with a letter. The last character cannot be `-` or `_`. Available length is 2-60. +* `async_run_enable` - (Optional, String, ForceNew) Whether SCF function asynchronous attribute is enabled. `TRUE` is open, `FALSE` is close. +* `cfs_config` - (Optional, List) List of CFS configurations. +* `cls_logset_id` - (Optional, String) cls logset id of the SCF function. +* `cls_topic_id` - (Optional, String) cls topic id of the SCF function. +* `cos_bucket_name` - (Optional, String) Cos bucket name of the SCF function, such as `cos-1234567890`, conflict with `zip_file`. +* `cos_bucket_region` - (Optional, String) Cos bucket region of the SCF function, conflict with `zip_file`. +* `cos_object_name` - (Optional, String) Cos object name of the SCF function, should have suffix `.zip` or `.jar`, conflict with `zip_file`. +* `description` - (Optional, String) Description of the SCF function. Description supports English letters, numbers, spaces, commas, newlines, periods and Chinese, the maximum length is 1000. +* `dns_cache` - (Optional, Bool) Whether to enable Dns caching capability, only the EVENT function is supported. Default is false. +* `enable_eip_config` - (Optional, Bool) Indicates whether EIP config set to `ENABLE` when `enable_public_net` was true. Default `false`. +* `enable_public_net` - (Optional, Bool) Indicates whether public net config enabled. Default `false`. NOTE: only `vpc_id` specified can disable public net config. +* `environment` - (Optional, Map) Environment of the SCF function. +* `func_type` - (Optional, String) Function type. The default value is Event. Enter Event if you need to create a trigger function. Enter HTTP if you need to create an HTTP function service. +* `handler` - (Optional, String) Handler of the SCF function. The format of name is `.`, and it supports 26 English letters, numbers, connectors, and underscores, it should start with a letter. The last character cannot be `-` or `_`. Available length is 2-60. +* `image_config` - (Optional, List) Image of the SCF function, conflict with `cos_bucket_name`, `cos_object_name`, `cos_bucket_region`, `zip_file`. +* `intranet_config` - (Optional, List) Intranet access configuration. +* `l5_enable` - (Optional, Bool) Enable L5 for SCF function, default is `false`. +* `layers` - (Optional, List) The list of association layers. +* `mem_size` - (Optional, Int) Memory size of the SCF function, unit is MB. The default is `128`MB. The ladder is 128M. +* `namespace` - (Optional, String, ForceNew) Namespace of the SCF function, default is `default`. +* `role` - (Optional, String) Role of the SCF function. +* `runtime` - (Optional, String) Runtime of the SCF function, only supports `Python2.7`, `Python3.6`, `Nodejs6.10`, `Nodejs8.9`, `Nodejs10.15`, `PHP5`, `PHP7`, `Golang1`, and `Java8`. +* `subnet_id` - (Optional, String) Subnet ID of the SCF function. +* `tags` - (Optional, Map) Tags of the SCF function. +* `timeout` - (Optional, Int) Timeout of the SCF function, unit is second. Default `3`. Available value is 1-900. +* `triggers` - (Optional, Set) Trigger list of the SCF function, note that if you modify the trigger list, all existing triggers will be deleted, and then create triggers in the new list. Each element contains the following attributes: +* `vpc_id` - (Optional, String) VPC ID of the SCF function. +* `zip_file` - (Optional, String) Zip file of the SCF function, conflict with `cos_bucket_name`, `cos_object_name`, `cos_bucket_region`. + +The `cfs_config` object supports the following: + +* `cfs_id` - (Required, String) File system instance ID. +* `local_mount_dir` - (Required, String) Local mount directory. +* `mount_ins_id` - (Required, String) File system mount instance ID. +* `remote_mount_dir` - (Required, String) Remote mount directory. +* `user_group_id` - (Required, String) ID of user group. +* `user_id` - (Required, String) ID of user. + +The `image_config` object supports the following: + +* `image_type` - (Required, String) The image type. personal or enterprise. +* `image_uri` - (Required, String) The uri of image. +* `args` - (Optional, String) the parameters of command. +* `command` - (Optional, String) The command of entrypoint. +* `container_image_accelerate` - (Optional, Bool) Image accelerate switch. +* `entry_point` - (Optional, String) The entrypoint of app. +* `image_port` - (Optional, Int) Image function port setting. Default is `9000`, -1 indicates no port mirroring function. Other value ranges 0 ~ 65535. +* `registry_id` - (Optional, String) The registry id of TCR. When image type is enterprise, it must be set. + +The `intranet_config` object supports the following: + +* `ip_fixed` - (Required, String) Whether to enable fixed intranet IP, ENABLE is enabled, DISABLE is disabled. + +The `layers` object supports the following: + +* `layer_name` - (Required, String) The name of Layer. +* `layer_version` - (Required, Int) The version of layer. + +The `triggers` object supports the following: + +* `name` - (Required, String) Name of the SCF function trigger, if `type` is `ckafka`, the format of name must be `-`; if `type` is `cos`, the name is cos bucket id, other In any case, it can be combined arbitrarily. It can only contain English letters, numbers, connectors and underscores. The maximum length is 100. +* `trigger_desc` - (Required, String) TriggerDesc of the SCF function trigger, parameter format of `timer` is linux cron expression; parameter of `cos` type is json string `{"bucketUrl":".cos..myqcloud.com","event":"cos:ObjectCreated:*","filter":{"Prefix":"","Suffix":""}}`, where `bucketUrl` is cos bucket (optional), `event` is the cos event trigger, `Prefix` is the corresponding file prefix filter condition, `Suffix` is the suffix filter condition, if not need filter condition can not pass; `cmq` type does not pass this parameter; `ckafka` type parameter format is json string `{"maxMsgNum":"1","offset":"latest"}`; `apigw` type parameter format is json string `{"api":{"authRequired":"FALSE","requestConfig":{"method":"ANY"},"isIntegratedResponse":"FALSE"},"service":{"serviceId":"service-dqzh68sg"},"release":{"environmentName":"test"}}`. +* `type` - (Required, String) Type of the SCF function trigger, support `cos`, `cmq`, `timer`, `ckafka`, `apigw`. +* `cos_region` - (Optional, String) Region of cos bucket. if `type` is `cos`, `cos_region` is required. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `code_error` - SCF function code error message. +* `code_result` - SCF function code is correct. +* `code_size` - SCF function code size, unit is M. +* `eip_fixed` - Whether EIP is a fixed IP. +* `eips` - SCF function EIP list. +* `err_no` - SCF function code error code. +* `host` - SCF function domain name. +* `install_dependency` - Whether to automatically install dependencies. +* `modify_time` - SCF function last modified time. +* `status_desc` - SCF status description. +* `status` - SCF function status. +* `trigger_info` - SCF trigger details list. Each element contains the following attributes: + * `create_time` - Create time of SCF function trigger. + * `custom_argument` - User-defined parameters of SCF function trigger. + * `enable` - Whether SCF function trigger is enable. + * `modify_time` - Modify time of SCF function trigger. + * `name` - Name of SCF function trigger. + * `trigger_desc` - TriggerDesc of SCF function trigger. + * `type` - Type of SCF function trigger. +* `vip` - SCF function vip. + + +## Import + +SCF function can be imported, e.g. + +-> **NOTE:** function id is `+` + +``` +$ terraform import tencentcloud_scf_function.test default+test +``` + diff --git a/config/docs/r/scf_function_alias.html.markdown b/config/docs/r/scf_function_alias.html.markdown new file mode 100644 index 0000000..255d137 --- /dev/null +++ b/config/docs/r/scf_function_alias.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_function_alias" +sidebar_current: "docs-tencentcloud-resource-scf_function_alias" +description: |- + Provides a resource to create a scf function_alias +--- + +# tencentcloud_scf_function_alias + +Provides a resource to create a scf function_alias + +## Example Usage + +```hcl +// by weight +resource "tencentcloud_scf_function_alias" "function_alias" { + description = "weight test" + function_name = "keep-1676351130" + function_version = "$LATEST" + name = "weight" + namespace = "default" + + routing_config { + additional_version_weights { + version = "2" + weight = 0.4 + } + } +} + +// by route +resource "tencentcloud_scf_function_alias" "function_alias" { + description = "matchs for test 12312312" + function_name = "keep-1676351130" + function_version = "3" + name = "matchs" + namespace = "default" + + routing_config { + additional_version_matches { + expression = "testuser" + key = "invoke.headers.User" + method = "exact" + version = "2" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String) Function name. +* `function_version` - (Required, String) Master version pointed to by the alias. +* `name` - (Required, String) Alias name, which must be unique in the function, can contain 1 to 64 letters, digits, _, and -, and must begin with a letter. +* `description` - (Optional, String) Alias description information. +* `namespace` - (Optional, String) Function namespace. +* `routing_config` - (Optional, List) Request routing configuration of alias. + +The `additional_version_matches` object supports the following: + +* `expression` - (Required, String) Rule requirements for range match:It should be described in an open or closed range, i.e., (a,b) or [a,b], where both a and b are integersRule requirements for exact match:Exact string match. +* `key` - (Required, String) Matching rule key. When the API is called, pass in the key to route the request to the specified version based on the matching ruleHeader method:Enter invoke.headers.User for key and pass in RoutingKey:{User:value} when invoking a function through invoke for invocation based on rule matching. +* `method` - (Required, String) Match method. Valid values:range: Range matchexact: exact string match. +* `version` - (Required, String) Function version name. + +The `additional_version_weights` object supports the following: + +* `version` - (Required, String) Function version name. +* `weight` - (Required, Float64) Version weight. + +The `routing_config` object supports the following: + +* `additional_version_matches` - (Optional, List) Additional version with rule-based routing. +* `additional_version_weights` - (Optional, List) Additional version with random weight-based routing. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +scf function_alias can be imported using the id, e.g. + +``` +terraform import tencentcloud_scf_function_alias.function_alias namespace#functionName#name +``` + diff --git a/config/docs/r/scf_function_event_invoke_config.html.markdown b/config/docs/r/scf_function_event_invoke_config.html.markdown new file mode 100644 index 0000000..d781bd4 --- /dev/null +++ b/config/docs/r/scf_function_event_invoke_config.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_function_event_invoke_config" +sidebar_current: "docs-tencentcloud-resource-scf_function_event_invoke_config" +description: |- + Provides a resource to create a scf function_event_invoke_config +--- + +# tencentcloud_scf_function_event_invoke_config + +Provides a resource to create a scf function_event_invoke_config + +## Example Usage + +```hcl +resource "tencentcloud_scf_function_event_invoke_config" "function_event_invoke_config" { + function_name = "keep-1676351130" + namespace = "default" + async_trigger_config { + retry_config { + retry_num = 2 + } + msg_ttl = 24 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `async_trigger_config` - (Required, List) Async retry configuration information. +* `function_name` - (Required, String) Function name. +* `namespace` - (Optional, String) Function namespace. Default value: default. + +The `async_trigger_config` object supports the following: + +* `msg_ttl` - (Required, Int) Message retention period. +* `retry_config` - (Required, List) Async retry configuration of function upon user error. + +The `retry_config` object supports the following: + +* `retry_num` - (Required, Int) Number of retry attempts. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +scf function_event_invoke_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_scf_function_event_invoke_config.function_event_invoke_config function_name#namespace +``` + diff --git a/config/docs/r/scf_function_version.html.markdown b/config/docs/r/scf_function_version.html.markdown new file mode 100644 index 0000000..d5ac796 --- /dev/null +++ b/config/docs/r/scf_function_version.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_function_version" +sidebar_current: "docs-tencentcloud-resource-scf_function_version" +description: |- + Provides a resource to create a scf function_version +--- + +# tencentcloud_scf_function_version + +Provides a resource to create a scf function_version + +## Example Usage + +```hcl +resource "tencentcloud_scf_function_version" "function_version" { + function_name = "keep-1676351130" + namespace = "default" + description = "for-terraform-test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String, ForceNew) Name of the released function. +* `description` - (Optional, String, ForceNew) Function description. +* `namespace` - (Optional, String, ForceNew) Function namespace. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `function_version` - Version of the released function. + + +## Import + +scf function_version can be imported using the id, e.g. + +``` +terraform import tencentcloud_scf_function_version.function_version functionName#namespace#functionVersion +``` + diff --git a/config/docs/r/scf_invoke_function.html.markdown b/config/docs/r/scf_invoke_function.html.markdown new file mode 100644 index 0000000..d56c720 --- /dev/null +++ b/config/docs/r/scf_invoke_function.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_invoke_function" +sidebar_current: "docs-tencentcloud-resource-scf_invoke_function" +description: |- + Provides a resource to create a scf invoke_function +--- + +# tencentcloud_scf_invoke_function + +Provides a resource to create a scf invoke_function + +## Example Usage + +```hcl +resource "tencentcloud_scf_invoke_function" "invoke_function" { + function_name = "keep-1676351130" + qualifier = "2" + namespace = "default" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String, ForceNew) Function name. +* `client_context` - (Optional, String, ForceNew) Function running parameter, which is in the JSON format. The maximum parameter size is 6 MB for synchronized invocations and 128KB for asynchronized invocations. This field corresponds to event input parameter. +* `invocation_type` - (Optional, String, ForceNew) Fill in RequestResponse for synchronized invocations (default and recommended) and Event for asychronized invocations. Note that for synchronized invocations, the max timeout period is 300s. Choose asychronized invocations if the required timeout period is longer than 300 seconds. You can also use InvokeFunction for synchronized invocations. +* `log_type` - (Optional, String, ForceNew) Null for async invocations. +* `namespace` - (Optional, String, ForceNew) Namespace. +* `qualifier` - (Optional, String, ForceNew) The version or alias of the triggered function. It defaults to $LATEST. +* `routing_key` - (Optional, String, ForceNew) Traffic routing config in json format, e.g., {k:v}. Please note that both k and v must be strings. Up to 1024 bytes allowed. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/scf_layer.html.markdown b/config/docs/r/scf_layer.html.markdown new file mode 100644 index 0000000..c52b8be --- /dev/null +++ b/config/docs/r/scf_layer.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_layer" +sidebar_current: "docs-tencentcloud-resource-scf_layer" +description: |- + Provide a resource to create a SCF layer. +--- + +# tencentcloud_scf_layer + +Provide a resource to create a SCF layer. + +## Example Usage + +```hcl +resource "tencentcloud_scf_layer" "foo" { + layer_name = "foo" + compatible_runtimes = ["Python3.6"] + content { + cos_bucket_name = "test-bucket" + cos_object_name = "/foo.zip" + cos_bucket_region = "ap-guangzhou" + } + description = "foo" + license_info = "foo" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `compatible_runtimes` - (Required, List: [`String`]) The compatible runtimes of layer. +* `content` - (Required, List) The source code of layer. +* `layer_name` - (Required, String) The name of layer. +* `description` - (Optional, String) The description of layer. +* `license_info` - (Optional, String) The license info of layer. + +The `content` object supports the following: + +* `cos_bucket_name` - (Optional, String) Cos bucket name of the SCF layer, such as `cos-1234567890`, conflict with `zip_file`. +* `cos_bucket_region` - (Optional, String) Cos bucket region of the SCF layer, conflict with `zip_file`. +* `cos_object_name` - (Optional, String) Cos object name of the SCF layer, should have suffix `.zip` or `.jar`, conflict with `zip_file`. +* `zip_file` - (Optional, String) Zip file of the SCF layer, conflict with `cos_bucket_name`, `cos_object_name`, `cos_bucket_region`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `code_sha_256` - The code type of layer. +* `create_time` - The create time of layer. +* `layer_version` - The version of layer. +* `location` - The download location url of layer. +* `status` - The current status of layer. + + +## Import + +Scf layer can be imported, e.g. + +``` +$ terraform import tencentcloud_scf_layer.layer layerId#layerVersion +``` + diff --git a/config/docs/r/scf_namespace.html.markdown b/config/docs/r/scf_namespace.html.markdown new file mode 100644 index 0000000..d623c6b --- /dev/null +++ b/config/docs/r/scf_namespace.html.markdown @@ -0,0 +1,46 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_namespace" +sidebar_current: "docs-tencentcloud-resource-scf_namespace" +description: |- + Provide a resource to create a SCF namespace. +--- + +# tencentcloud_scf_namespace + +Provide a resource to create a SCF namespace. + +## Example Usage + +```hcl +resource "tencentcloud_scf_namespace" "foo" { + namespace = "ci-test-scf" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `namespace` - (Required, String, ForceNew) Name of the SCF namespace. +* `description` - (Optional, String) Description of the SCF namespace. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - SCF namespace creation time. +* `modify_time` - SCF namespace last modified time. +* `type` - SCF namespace type. + + +## Import + +SCF namespace can be imported, e.g. + +``` +$ terraform import tencentcloud_scf_function.test default +``` + diff --git a/config/docs/r/scf_provisioned_concurrency_config.html.markdown b/config/docs/r/scf_provisioned_concurrency_config.html.markdown new file mode 100644 index 0000000..9dde71e --- /dev/null +++ b/config/docs/r/scf_provisioned_concurrency_config.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_provisioned_concurrency_config" +sidebar_current: "docs-tencentcloud-resource-scf_provisioned_concurrency_config" +description: |- + Provides a resource to create a scf provisioned_concurrency_config +--- + +# tencentcloud_scf_provisioned_concurrency_config + +Provides a resource to create a scf provisioned_concurrency_config + +## Example Usage + +```hcl +resource "tencentcloud_scf_provisioned_concurrency_config" "provisioned_concurrency_config" { + function_name = "keep-1676351130" + qualifier = "2" + version_provisioned_concurrency_num = 2 + namespace = "default" + trigger_actions { + trigger_name = "test" + trigger_provisioned_concurrency_num = 2 + trigger_cron_config = "29 45 12 29 05 * 2023" + provisioned_type = "Default" + } + provisioned_type = "Default" + tracking_target = 0.5 + min_capacity = 1 + max_capacity = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String, ForceNew) Name of the function for which to set the provisioned concurrency. +* `qualifier` - (Required, String, ForceNew) Function version number. Note: the $LATEST version does not support provisioned concurrency. +* `version_provisioned_concurrency_num` - (Required, Int, ForceNew) Provisioned concurrency amount. Note: there is an upper limit for the sum of provisioned concurrency amounts of all versions, which currently is the function&#39;s maximum concurrency quota minus 100. +* `max_capacity` - (Optional, Int, ForceNew) The maximum number of instances. +* `min_capacity` - (Optional, Int, ForceNew) The minimum number of instances. It can not be smaller than 1. +* `namespace` - (Optional, String, ForceNew) Function namespace. Default value: default. +* `provisioned_type` - (Optional, String, ForceNew) Specifies the provisioned concurrency type. Default: Static provisioned concurrency. ConcurrencyUtilizationTracking: Scales the concurrency automatically according to the concurrency utilization. If ConcurrencyUtilizationTracking is passed in, TrackingTarget, MinCapacity and MaxCapacity are required, and VersionProvisionedConcurrencyNum must be 0. +* `tracking_target` - (Optional, Float64, ForceNew) The target concurrency utilization. Range: (0,1) (two decimal places). +* `trigger_actions` - (Optional, List, ForceNew) Scheduled provisioned concurrency scaling action. + +The `trigger_actions` object supports the following: + +* `trigger_cron_config` - (Required, String) Trigger time of the scheduled action in Cron expression. Seven fields are required and should be separated with a space. Note: this field may return null, indicating that no valid values can be obtained. +* `trigger_name` - (Required, String) Scheduled action name Note: this field may return null, indicating that no valid values can be obtained. +* `trigger_provisioned_concurrency_num` - (Required, Int) Target provisioned concurrency of the scheduled scaling action Note: this field may return null, indicating that no valid values can be obtained. +* `provisioned_type` - (Optional, String) The provision type. Value: Default Note: This field may return null, indicating that no valid value can be found. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/scf_reserved_concurrency_config.html.markdown b/config/docs/r/scf_reserved_concurrency_config.html.markdown new file mode 100644 index 0000000..1ac2c09 --- /dev/null +++ b/config/docs/r/scf_reserved_concurrency_config.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_reserved_concurrency_config" +sidebar_current: "docs-tencentcloud-resource-scf_reserved_concurrency_config" +description: |- + Provides a resource to create a scf reserved_concurrency_config +--- + +# tencentcloud_scf_reserved_concurrency_config + +Provides a resource to create a scf reserved_concurrency_config + +## Example Usage + +```hcl +resource "tencentcloud_scf_reserved_concurrency_config" "reserved_concurrency_config" { + function_name = "keep-1676351130" + reserved_concurrency_mem = 128000 + namespace = "default" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String, ForceNew) Specifies the function of which you want to configure the reserved quota. +* `reserved_concurrency_mem` - (Required, Int, ForceNew) Reserved memory quota of the function. Note: the upper limit for the total reserved quota of the function is the user's total concurrency memory minus 12800. +* `namespace` - (Optional, String, ForceNew) Function namespace. Default value: default. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +scf reserved_concurrency_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_scf_reserved_concurrency_config.reserved_concurrency_config reserved_concurrency_config_id +``` + diff --git a/config/docs/r/scf_sync_invoke_function.html.markdown b/config/docs/r/scf_sync_invoke_function.html.markdown new file mode 100644 index 0000000..c76024f --- /dev/null +++ b/config/docs/r/scf_sync_invoke_function.html.markdown @@ -0,0 +1,42 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_sync_invoke_function" +sidebar_current: "docs-tencentcloud-resource-scf_sync_invoke_function" +description: |- + Provides a resource to create a scf sync_invoke_function +--- + +# tencentcloud_scf_sync_invoke_function + +Provides a resource to create a scf sync_invoke_function + +## Example Usage + +```hcl +resource "tencentcloud_scf_sync_invoke_function" "invoke_function" { + function_name = "keep-1676351130" + qualifier = "2" + namespace = "default" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String, ForceNew) Function name. +* `event` - (Optional, String, ForceNew) Function running parameter, which is in the JSON format. Maximum parameter size is 6 MB. This field corresponds to event input parameter. +* `log_type` - (Optional, String, ForceNew) Valid value: None (default) or Tail. If the value is Tail, log in the response will contain the corresponding function execution log (up to 4KB). +* `namespace` - (Optional, String, ForceNew) Namespace. default is used if it's left empty. +* `qualifier` - (Optional, String, ForceNew) Version or alias of the function. It defaults to $DEFAULT. +* `routing_key` - (Optional, String, ForceNew) Traffic routing config in json format, e.g., {k:v}. Please note that both k and v must be strings. Up to 1024 bytes allowed. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/scf_terminate_async_event.html.markdown b/config/docs/r/scf_terminate_async_event.html.markdown new file mode 100644 index 0000000..560863f --- /dev/null +++ b/config/docs/r/scf_terminate_async_event.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_terminate_async_event" +sidebar_current: "docs-tencentcloud-resource-scf_terminate_async_event" +description: |- + Provides a resource to create a scf terminate_async_event +--- + +# tencentcloud_scf_terminate_async_event + +Provides a resource to create a scf terminate_async_event + +## Example Usage + +```hcl +resource "tencentcloud_scf_terminate_async_event" "terminate_async_event" { + function_name = "keep-1676351130" + invoke_request_id = "9de9405a-e33a-498d-bb59-e80b7bed1191" + namespace = "default" + grace_shutdown = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String, ForceNew) Function name. +* `invoke_request_id` - (Required, String, ForceNew) Terminated invocation request ID. +* `grace_shutdown` - (Optional, Bool, ForceNew) Whether to enable grace shutdown. If it's true, a SIGTERM signal is sent to the specified request. See [Sending termination signal](https://www.tencentcloud.com/document/product/583/63969?from_cn_redirect=1#.E5.8F.91.E9.80.81.E7.BB.88.E6.AD.A2.E4.BF.A1.E5.8F.B7]. It's set to false by default. +* `namespace` - (Optional, String, ForceNew) Namespace. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/scf_trigger_config.html.markdown b/config/docs/r/scf_trigger_config.html.markdown new file mode 100644 index 0000000..4d164a8 --- /dev/null +++ b/config/docs/r/scf_trigger_config.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Serverless Cloud Function(SCF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_scf_trigger_config" +sidebar_current: "docs-tencentcloud-resource-scf_trigger_config" +description: |- + Provides a resource to create a scf trigger_config +--- + +# tencentcloud_scf_trigger_config + +Provides a resource to create a scf trigger_config + +## Example Usage + +```hcl +resource "tencentcloud_scf_trigger_config" "trigger_config" { + enable = "OPEN" + function_name = "keep-1676351130" + trigger_name = "SCF-timer-1685540160" + type = "timer" + qualifier = "$DEFAULT" + namespace = "default" + trigger_desc = "* 1 2 * * * *" + description = "func" + custom_argument = "Information" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `function_name` - (Required, String, ForceNew) Function name. +* `trigger_name` - (Required, String, ForceNew) Trigger Name. +* `type` - (Required, String) Trigger type. +* `custom_argument` - (Optional, String) User Additional Information. +* `description` - (Optional, String) Trigger description. +* `enable` - (Optional, String) Status of trigger. Values: OPEN (enabled); CLOSE disabled). +* `namespace` - (Optional, String, ForceNew) Function namespace. +* `qualifier` - (Optional, String) Function version. It defaults to `$LATEST`. It's recommended to use `[$DEFAULT](https://intl.cloud.tencent.com/document/product/583/36149?from_cn_redirect=1#.E9.BB.98.E8.AE.A4.E5.88.AB.E5.90.8D)` for canary release. +* `trigger_desc` - (Optional, String) TriggerDesc parameter. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +scf trigger_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_scf_trigger_config.trigger_config functionName#namespace#triggerName +``` + diff --git a/config/docs/r/security_group.html.markdown b/config/docs/r/security_group.html.markdown new file mode 100644 index 0000000..9921c45 --- /dev/null +++ b/config/docs/r/security_group.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_security_group" +sidebar_current: "docs-tencentcloud-resource-security_group" +description: |- + Provides a resource to create security group. +--- + +# tencentcloud_security_group + +Provides a resource to create security group. + +## Example Usage + +### Create a basic security group + +```hcl +resource "tencentcloud_security_group" "example" { + name = "tf-example-sg" + description = "sg test" +} +``` + +### Create a complete security group + +```hcl +resource "tencentcloud_security_group" "example" { + name = "tf-example-sg" + description = "sg test" + project_id = 0 + + tags = { + "example" = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the security group to be queried. +* `description` - (Optional, String) Description of the security group. +* `project_id` - (Optional, Int, ForceNew) Project ID of the security group. +* `tags` - (Optional, Map) Tags of the security group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Security group can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_security_group.sglab sg-ey3wmiz1 +``` + diff --git a/config/docs/r/security_group_lite_rule.html.markdown b/config/docs/r/security_group_lite_rule.html.markdown new file mode 100644 index 0000000..aabb414 --- /dev/null +++ b/config/docs/r/security_group_lite_rule.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_security_group_lite_rule" +sidebar_current: "docs-tencentcloud-resource-security_group_lite_rule" +description: |- + Provide a resource to create security group some lite rules quickly. +--- + +# tencentcloud_security_group_lite_rule + +Provide a resource to create security group some lite rules quickly. + +-> **NOTE:** It can't be used with tencentcloud_security_group_rule, and don't create multiple tencentcloud_security_group_rule resources, otherwise it may cause problems. + +## Example Usage + +```hcl +resource "tencentcloud_security_group" "foo" { + name = "ci-temp-test-sg" +} + +resource "tencentcloud_security_group_lite_rule" "foo" { + security_group_id = tencentcloud_security_group.foo.id + + ingress = [ + "ACCEPT#192.168.1.0/24#80#TCP", + "DROP#8.8.8.8#80,90#UDP", + "ACCEPT#0.0.0.0/0#80-90#TCP", + "ACCEPT#sg-7ixn3foj#80-90#TCP", + "ACCEPT#ipm-epjq5kn0#80-90#TCP", + "ACCEPT#ipmg-3loavam6#80-90#TCP", + "ACCEPT#0.0.0.0/0##ppm-xxxxxxxx" + "ACCEPT#0.0.0.0/0##ppmg-xxxxxxxx" + ] + + egress = [ + "ACCEPT#192.168.0.0/16#ALL#TCP", + "ACCEPT#10.0.0.0/8#ALL#ICMP", + "DROP#0.0.0.0/0#ALL#ALL", + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `security_group_id` - (Required, String, ForceNew) ID of the security group. +* `egress` - (Optional, List: [`String`]) Egress rules set. A rule must match the following format: [action]#[source]#[port]#[protocol]. The available value of 'action' is `ACCEPT` and `DROP`. The 'source' can be an IP address network, segment, security group ID and Address Template ID. The 'port' valid format is `80`, `80,443`, `80-90` or `ALL`. The available value of 'protocol' is `TCP`, `UDP`, `ICMP`, `ALL` and `ppm(g?)-xxxxxxxx`. When 'protocol' is `ICMP` or `ALL`, the 'port' must be `ALL`. +* `ingress` - (Optional, List: [`String`]) Ingress rules set. A rule must match the following format: [action]#[source]#[port]#[protocol]. The available value of 'action' is `ACCEPT` and `DROP`. The 'source' can be an IP address network, segment, security group ID and Address Template ID. The 'port' valid format is `80`, `80,443`, `80-90` or `ALL`. The available value of 'protocol' is `TCP`, `UDP`, `ICMP`, `ALL` and `ppm(g?)-xxxxxxxx`. When 'protocol' is `ICMP` or `ALL`, the 'port' must be `ALL`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Security group lite rule can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_security_group_lite_rule.foo sg-ey3wmiz1 +``` + diff --git a/config/docs/r/security_group_rule.html.markdown b/config/docs/r/security_group_rule.html.markdown new file mode 100644 index 0000000..1bf461b --- /dev/null +++ b/config/docs/r/security_group_rule.html.markdown @@ -0,0 +1,97 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_security_group_rule" +sidebar_current: "docs-tencentcloud-resource-security_group_rule" +description: |- + Provides a resource to create security group rule. +--- + +# tencentcloud_security_group_rule + +Provides a resource to create security group rule. + +~> **NOTE:** This resource will be offline and no longer supported, beacause single security rule is hardly ordered. Please use 'tencentcloud_security_group_lite_rule' instead. + +## Example Usage + +### Source is CIDR ip + +```hcl +resource "tencentcloud_security_group" "sglab_1" { + name = "mysg_1" + description = "favourite sg_1" + project_id = 0 +} + +resource "tencentcloud_security_group_rule" "sglab_1" { + security_group_id = tencentcloud_security_group.sglab_1.id + type = "ingress" + cidr_ip = "10.0.0.0/16" + ip_protocol = "TCP" + port_range = "80" + policy = "ACCEPT" + description = "favourite sg rule_1" +} +``` + +### Source is a security group id + +```hcl +resource "tencentcloud_security_group" "sglab_2" { + name = "mysg_2" + description = "favourite sg_2" + project_id = 0 +} + +resource "tencentcloud_security_group" "sglab_3" { + name = "mysg_3" + description = "favourite sg_3" + project_id = 0 +} + +resource "tencentcloud_security_group_rule" "sglab_2" { + security_group_id = tencentcloud_security_group.sglab_2.id + type = "ingress" + ip_protocol = "TCP" + port_range = "80" + policy = "ACCEPT" + source_sgid = tencentcloud_security_group.sglab_3.id + description = "favourite sg rule_2" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `policy` - (Required, String, ForceNew) Rule policy of security group. Valid values: `ACCEPT` and `DROP`. +* `security_group_id` - (Required, String, ForceNew) ID of the security group to be queried. +* `type` - (Required, String, ForceNew) Type of the security group rule. Valid values: `ingress` and `egress`. +* `address_template` - (Optional, List, ForceNew) ID of the address template, and confilicts with `source_sgid` and `cidr_ip`. +* `cidr_ip` - (Optional, String, ForceNew) An IP address network or segment, and conflict with `source_sgid` and `address_template`. +* `description` - (Optional, String, ForceNew) Description of the security group rule. +* `ip_protocol` - (Optional, String, ForceNew) Type of IP protocol. Valid values: `TCP`, `UDP` and `ICMP`. Default to all types protocol, and conflicts with `protocol_template`. +* `policy_index` - (Optional, Int, ForceNew) The security group rule index number, the value of which dynamically changes as the security group rule changes. +* `port_range` - (Optional, String, ForceNew) Range of the port. The available value can be one, multiple or one segment. E.g. `80`, `80,90` and `80-90`. Default to all ports, and confilicts with `protocol_template`. +* `protocol_template` - (Optional, List, ForceNew) ID of the address template, and conflict with `ip_protocol`, `port_range`. +* `source_sgid` - (Optional, String, ForceNew) ID of the nested security group, and conflicts with `cidr_ip` and `address_template`. + +The `address_template` object supports the following: + +* `group_id` - (Optional, String, ForceNew) Address template group ID, conflicts with `template_id`. +* `template_id` - (Optional, String, ForceNew) Address template ID, conflicts with `group_id`. + +The `protocol_template` object supports the following: + +* `group_id` - (Optional, String, ForceNew) Address template group ID, conflicts with `template_id`. +* `template_id` - (Optional, String, ForceNew) Address template ID, conflicts with `group_id`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/security_group_rule_set.html.markdown b/config/docs/r/security_group_rule_set.html.markdown new file mode 100644 index 0000000..19e0c3c --- /dev/null +++ b/config/docs/r/security_group_rule_set.html.markdown @@ -0,0 +1,154 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_security_group_rule_set" +sidebar_current: "docs-tencentcloud-resource-security_group_rule_set" +description: |- + Provides a resource to create security group rule. This resource is similar with tencentcloud_security_group_lite_rule, rules can be ordered and configure descriptions. +--- + +# tencentcloud_security_group_rule_set + +Provides a resource to create security group rule. This resource is similar with tencentcloud_security_group_lite_rule, rules can be ordered and configure descriptions. + +~> **NOTE:** This resource must exclusive in one security group, do not declare additional rule resources of this security group elsewhere. + +## Example Usage + +```hcl +resource "tencentcloud_security_group" "base" { + name = "test-set-sg" + description = "Testing Rule Set Security" +} + +resource "tencentcloud_security_group" "relative" { + name = "for-relative" + description = "Used for attach security policy" +} + +resource "tencentcloud_address_template" "foo" { + name = "test-set-aTemp" + addresses = ["10.0.0.1", "10.0.1.0/24", "10.0.0.1-10.0.0.100"] +} + +resource "tencentcloud_address_template_group" "foo" { + name = "test-set-atg" + template_ids = [tencentcloud_address_template.foo.id] +} + +resource "tencentcloud_security_group_rule_set" "base" { + security_group_id = tencentcloud_security_group.base.id + + ingress { + action = "ACCEPT" + cidr_block = "10.0.0.0/22" + protocol = "TCP" + port = "80-90" + description = "A:Allow Ips and 80-90" + } + + ingress { + action = "ACCEPT" + cidr_block = "10.0.2.1" + protocol = "UDP" + port = "8080" + description = "B:Allow UDP 8080" + } + + ingress { + action = "ACCEPT" + cidr_block = "10.0.2.1" + protocol = "UDP" + port = "8080" + description = "C:Allow UDP 8080" + } + + ingress { + action = "ACCEPT" + cidr_block = "172.18.1.2" + protocol = "ALL" + port = "ALL" + description = "D:Allow ALL" + } + + ingress { + action = "DROP" + protocol = "TCP" + port = "80" + source_security_id = tencentcloud_security_group.relative.id + description = "E:Block relative" + } + + egress { + action = "DROP" + cidr_block = "10.0.0.0/16" + protocol = "ICMP" + description = "A:Block ping3" + } + + egress { + action = "DROP" + address_template_id = tencentcloud_address_template.foo.id + description = "B:Allow template" + } + + egress { + action = "DROP" + address_template_group = tencentcloud_address_template_group.foo.id + description = "C:DROP template group" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `security_group_id` - (Required, String, ForceNew) ID of the security group to be queried. +* `egress` - (Optional, List) List of egress rule. NOTE: this block is ordered, the first rule has the highest priority. +* `ingress` - (Optional, List) List of ingress rule. NOTE: this block is ordered, the first rule has the highest priority. + +The `egress` object supports the following: + +* `action` - (Required, String) Rule policy of security group. Valid values: `ACCEPT` and `DROP`. +* `address_template_group` - (Optional, String) Specify Group ID of Address template like `ipmg-xxxxxxxx`, conflict with `source_security_id` and `cidr_block`. +* `address_template_id` - (Optional, String) Specify Address template ID like `ipm-xxxxxxxx`, conflict with `source_security_id` and `cidr_block`. +* `cidr_block` - (Optional, String) An IP address network or CIDR segment. NOTE: `cidr_block`, `ipv6_cidr_block`, `source_security_id` and `address_template_*` are exclusive and cannot be set in the same time. +* `description` - (Optional, String) Description of the security group rule. +* `ipv6_cidr_block` - (Optional, String) An IPV6 address network or CIDR segment, and conflict with `source_security_id` and `address_template_*`. +* `port` - (Optional, String) Range of the port. The available value can be one, multiple or one segment. E.g. `80`, `80,90` and `80-90`. Default to all ports, and conflicts with `service_template_*`. +* `protocol` - (Optional, String) Type of IP protocol. Valid values: `TCP`, `UDP` and `ICMP`. Default to all types protocol, and conflicts with `service_template_*`. +* `service_template_group` - (Optional, String) Specify Group ID of Protocol template ID like `ppmg-xxxxxxxx`, conflict with `cidr_block` and `port`. +* `service_template_id` - (Optional, String) Specify Protocol template ID like `ppm-xxxxxxxx`, conflict with `cidr_block` and `port`. +* `source_security_id` - (Optional, String) ID of the nested security group, and conflicts with `cidr_block` and `address_template_*`. + +The `ingress` object supports the following: + +* `action` - (Required, String) Rule policy of security group. Valid values: `ACCEPT` and `DROP`. +* `address_template_group` - (Optional, String) Specify Group ID of Address template like `ipmg-xxxxxxxx`, conflict with `source_security_id` and `cidr_block`. +* `address_template_id` - (Optional, String) Specify Address template ID like `ipm-xxxxxxxx`, conflict with `source_security_id` and `cidr_block`. +* `cidr_block` - (Optional, String) An IP address network or CIDR segment. NOTE: `cidr_block`, `ipv6_cidr_block`, `source_security_id` and `address_template_*` are exclusive and cannot be set in the same time. +* `description` - (Optional, String) Description of the security group rule. +* `ipv6_cidr_block` - (Optional, String) An IPV6 address network or CIDR segment, and conflict with `source_security_id` and `address_template_*`. +* `port` - (Optional, String) Range of the port. The available value can be one, multiple or one segment. E.g. `80`, `80,90` and `80-90`. Default to all ports, and conflicts with `service_template_*`. +* `protocol` - (Optional, String) Type of IP protocol. Valid values: `TCP`, `UDP` and `ICMP`. Default to all types protocol, and conflicts with `service_template_*`. +* `service_template_group` - (Optional, String) Specify Group ID of Protocol template ID like `ppmg-xxxxxxxx`, conflict with `cidr_block` and `port`. +* `service_template_id` - (Optional, String) Specify Protocol template ID like `ppm-xxxxxxxx`, conflict with `cidr_block` and `port`. +* `source_security_id` - (Optional, String) ID of the nested security group, and conflicts with `cidr_block` and `address_template_*`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `version` - Security policies version, auto increment for every update. + + +## Import + +Resource tencentcloud_security_group_rule_set can be imported by passing security grou id: + +``` +terraform import tencentcloud_security_group_rule_set.sglab_1 sg-xxxxxxxx +``` + diff --git a/config/docs/r/ses_batch_send_email.html.markdown b/config/docs/r/ses_batch_send_email.html.markdown new file mode 100644 index 0000000..9cd71e6 --- /dev/null +++ b/config/docs/r/ses_batch_send_email.html.markdown @@ -0,0 +1,84 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_batch_send_email" +sidebar_current: "docs-tencentcloud-resource-ses_batch_send_email" +description: |- + Provides a resource to create a ses batch_send_email +--- + +# tencentcloud_ses_batch_send_email + +Provides a resource to create a ses batch_send_email + +## Example Usage + +```hcl +resource "tencentcloud_ses_batch_send_email" "batch_send_email" { + from_email_address = "aaa@iac-tf.cloud" + receiver_id = 1063742 + subject = "terraform test" + task_type = 1 + reply_to_addresses = "reply@mail.qcloud.com" + template { + template_id = 99629 + template_data = "{\"name\":\"xxx\",\"age\":\"xx\"}" + + } + + cycle_param { + begin_time = "2023-09-07 15:10:00" + interval_time = 1 + } + timed_param { + begin_time = "2023-09-07 15:20:00" + } + unsubscribe = "0" + ad_location = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `from_email_address` - (Required, String, ForceNew) Sender address. Enter a sender address such as noreply@mail.qcloud.com. To display the sender name, enter the address in the following format:sender &amp;lt;email address&amp;gt;. For example:Tencent Cloud team &amp;lt;noreply@mail.qcloud.com&amp;gt;. +* `receiver_id` - (Required, Int, ForceNew) Recipient group ID. +* `subject` - (Required, String, ForceNew) Email subject. +* `task_type` - (Required, Int, ForceNew) Task type. 1: immediate; 2: scheduled; 3: recurring. +* `ad_location` - (Optional, Int, ForceNew) Whether to add an ad tag. 0: Add no tag; 1: Add before the subject; 2: Add after the subject. +* `attachments` - (Optional, List, ForceNew) Attachment parameters to set when you need to send attachments. This parameter is currently unavailable. +* `cycle_param` - (Optional, List, ForceNew) Parameter required for a recurring sending task. +* `reply_to_addresses` - (Optional, String, ForceNew) Reply-to address. You can enter a valid personal email address that can receive emails. If this parameter is left empty, reply emails will fail to be sent. +* `template` - (Optional, List, ForceNew) Template when emails are sent using a template. +* `timed_param` - (Optional, List, ForceNew) Parameter required for a scheduled sending task. +* `unsubscribe` - (Optional, String, ForceNew) Unsubscribe link option. 0: Do not add unsubscribe link; 1: English 2: Simplified Chinese; 3: Traditional Chinese; 4: Spanish; 5: French; 6: German; 7: Japanese; 8: Korean; 9: Arabic; 10: Thai. + +The `attachments` object supports the following: + +* `content` - (Required, String) Base64-encoded attachment content. You can send attachments of up to 4 MB in the total size.Note: The TencentCloud API supports a request packet of up to 8 MB in size, and the size of the attachmentcontent will increase by 1.5 times after Base64 encoding. Therefore, you need to keep the total size of allattachments below 4 MB. If the entire request exceeds 8 MB, the API will return an error. +* `file_name` - (Required, String) Attachment name, which cannot exceed 255 characters. Some attachment types are not supported. For details, see [Attachment Types.](https://www.tencentcloud.com/document/product/1084/42373?has_map=1). + +The `cycle_param` object supports the following: + +* `begin_time` - (Required, String) Start time of the task. +* `interval_time` - (Required, Int) Task recurrence in hours. +* `term_cycle` - (Optional, Int) Specifies whether to end the cycle. This parameter is used to update the task. Valid values: 0: No; 1: Yes. + +The `template` object supports the following: + +* `template_data` - (Required, String) Variable parameters in the template. Please use json.dump to format the JSON object into a string type.The object is a set of key-value pairs. Each key denotes a variable, which is represented by {{key}}. The key will be replaced with the correspondingvalue (represented by {{value}}) when sending the email.Note: The parameter value cannot be data of a complex type such as HTML.Example: {name:xxx,age:xx}. +* `template_id` - (Required, Int) Template ID. If you do not have any template, please create one. + +The `timed_param` object supports the following: + +* `begin_time` - (Required, String) Start time of a scheduled sending task. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ses_black_list.html.markdown b/config/docs/r/ses_black_list.html.markdown new file mode 100644 index 0000000..7037ffd --- /dev/null +++ b/config/docs/r/ses_black_list.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_black_list" +sidebar_current: "docs-tencentcloud-resource-ses_black_list" +description: |- + Provides a resource to create a ses black_list +--- + +# tencentcloud_ses_black_list + +Provides a resource to create a ses black_list + +~> **NOTE:** Used to remove email addresses from blacklists. + +## Example Usage + +```hcl +resource "tencentcloud_ses_black_list" "black_list" { + email_address = "terraform-tf@gmail.com" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `email_address` - (Required, String, ForceNew) Email addresses to be unblocklisted. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ses_black_list_delete.html.markdown b/config/docs/r/ses_black_list_delete.html.markdown new file mode 100644 index 0000000..f9008be --- /dev/null +++ b/config/docs/r/ses_black_list_delete.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_black_list_delete" +sidebar_current: "docs-tencentcloud-resource-ses_black_list_delete" +description: |- + Provides a resource to create a ses black_list +--- + +# tencentcloud_ses_black_list_delete + +Provides a resource to create a ses black_list + +~> **NOTE:** Used to remove email addresses from blacklists. + +## Example Usage + +```hcl +resource "tencentcloud_ses_black_list_delete" "black_list" { + email_address = "terraform-tf@gmail.com" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `email_address` - (Required, String, ForceNew) Email addresses to be unblocklisted. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ses_domain.html.markdown b/config/docs/r/ses_domain.html.markdown new file mode 100644 index 0000000..4084a1f --- /dev/null +++ b/config/docs/r/ses_domain.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_domain" +sidebar_current: "docs-tencentcloud-resource-ses_domain" +description: |- + Provides a resource to create a ses domain +--- + +# tencentcloud_ses_domain + +Provides a resource to create a ses domain + +## Example Usage + +```hcl +resource "tencentcloud_ses_domain" "domain" { + email_identity = "iac.cloud" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `email_identity` - (Required, String, ForceNew) Your sender domain. You are advised to use a third-level domain, for example, mail.qcloud.com. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `attributes` - DNS configuration details. + * `expected_value` - Values that need to be configured. + * `send_domain` - Domain name. + * `type` - Record Type CNAME | A | TXT | MX. + + +## Import + +ses domain can be imported using the id, e.g. +``` +$ terraform import tencentcloud_ses_domain.domain iac.cloud +``` + diff --git a/config/docs/r/ses_email_address.html.markdown b/config/docs/r/ses_email_address.html.markdown new file mode 100644 index 0000000..e07ece2 --- /dev/null +++ b/config/docs/r/ses_email_address.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_email_address" +sidebar_current: "docs-tencentcloud-resource-ses_email_address" +description: |- + Provides a resource to create a ses email_address +--- + +# tencentcloud_ses_email_address + +Provides a resource to create a ses email_address + +## Example Usage + +```hcl +resource "tencentcloud_ses_email_address" "email_address" { + email_address = "aaa@iac-tf.cloud" + email_sender_name = "aaa" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `email_address` - (Required, String, ForceNew) Your sender address. (You can create up to 10 sender addresses for each domain.). +* `email_sender_name` - (Optional, String, ForceNew) Sender name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ses email_address can be imported using the id, e.g. +``` +$ terraform import tencentcloud_ses_email_address.email_address aaa@iac-tf.cloud +``` + diff --git a/config/docs/r/ses_receiver.html.markdown b/config/docs/r/ses_receiver.html.markdown new file mode 100644 index 0000000..2f27d7d --- /dev/null +++ b/config/docs/r/ses_receiver.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_receiver" +sidebar_current: "docs-tencentcloud-resource-ses_receiver" +description: |- + Provides a resource to create a ses receiver +--- + +# tencentcloud_ses_receiver + +Provides a resource to create a ses receiver + +## Example Usage + +```hcl +resource "tencentcloud_ses_receiver" "receiver" { + receivers_name = "terraform_test" + desc = "description" + + data { + email = "abc@abc.com" + } + + data { + email = "abcd@abcd.com" + } +} +``` + + + +```hcl +resource "tencentcloud_ses_receiver" "receiver" { + receivers_name = "terraform_test" + desc = "description" + + data { + email = "abc@abc.com" + template_data = "{\"name\":\"xxx\",\"age\":\"xx\"}" + } + + data { + email = "abcd@abcd.com" + template_data = "{\"name\":\"xxx\",\"age\":\"xx\"}" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data` - (Required, Set, ForceNew) Recipient email and template parameters in array format. The number of recipients is limited to within 20,000. If there is an object in the `data` list that inputs `template_data`, then other objects are also required. +* `receivers_name` - (Required, String, ForceNew) Recipient group name. +* `desc` - (Optional, String, ForceNew) Recipient group description. + +The `data` object supports the following: + +* `email` - (Required, String, ForceNew) Recipient email addresses. +* `template_data` - (Optional, String, ForceNew) Variable parameters in the template, please use json.dump to format the JSON object as a string type. The object is a set of key-value pairs, where each key represents a variable in the template, and the variables in the template are represented by {{key}}, and the corresponding values will be replaced with {{value}} when sent.Note: Parameter values cannot be complex data such as HTML. The total length of TemplateData (the entire JSON structure) should be less than 800 bytes. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ses email_address can be imported using the id, e.g. +``` +$ terraform import tencentcloud_ses_receiver.receiver receiverId +``` + diff --git a/config/docs/r/ses_send_email.html.markdown b/config/docs/r/ses_send_email.html.markdown new file mode 100644 index 0000000..0ca836a --- /dev/null +++ b/config/docs/r/ses_send_email.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_send_email" +sidebar_current: "docs-tencentcloud-resource-ses_send_email" +description: |- + Provides a resource to create a ses send_email +--- + +# tencentcloud_ses_send_email + +Provides a resource to create a ses send_email + +## Example Usage + +```hcl +resource "tencentcloud_ses_send_email" "send_email" { + from_email_address = "aaa@iac-tf.cloud" + destination = ["1055482519@qq.com"] + subject = "test subject" + reply_to_addresses = "aaa@iac-tf.cloud" + + template { + template_id = 99629 + template_data = "{\"name\":\"xxx\",\"age\":\"xx\"}" + } + + unsubscribe = "1" + trigger_type = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `destination` - (Required, Set: [`String`], ForceNew) Recipient email addresses. You can send an email to up to 50 recipients at a time. Note: the email content will display all recipient addresses. To send one-to-one emails to several recipients, please call the API multiple times to send the emails. +* `from_email_address` - (Required, String, ForceNew) Sender address. Enter a sender address, for example, noreply@mail.qcloud.com.To display the sender name, enter the address in the following format:Sender. +* `subject` - (Required, String, ForceNew) Email subject. +* `attachments` - (Optional, List, ForceNew) Parameters for the attachments to be sent. The TencentCloud API supports a request packet of up to 8 MB in size,and the size of the attachment content will increase by 1.5 times after Base64 encoding. Therefore,you need to keep the total size of all attachments below 4 MB. If the entire request exceeds 8 MB,the API will return an error. +* `bcc` - (Optional, Set: [`String`], ForceNew) The email address of the cc recipient can support up to 20 cc recipients. +* `cc` - (Optional, Set: [`String`], ForceNew) Cc recipient email address, up to 20 people can be copied. +* `reply_to_addresses` - (Optional, String, ForceNew) Reply-to address. You can enter a valid personal email address that can receive emails. If this parameter is left empty, reply emails will fail to be sent. +* `template` - (Optional, List, ForceNew) Template parameters for template-based sending. As Simple has been disused, Template is required. +* `trigger_type` - (Optional, Int, ForceNew) Email triggering type. 0 (default): non-trigger-based, suitable for marketing emails and non-immediate emails;1: trigger-based, suitable for immediate emails such as emails containing verification codes.If the size of an email exceeds a specified value,the system will automatically choose the non-trigger-based type. +* `unsubscribe` - (Optional, String, ForceNew) Unsubscribe link option. 0: Do not add unsubscribe link; 1: English 2: Simplified Chinese; 3: Traditional Chinese; 4: Spanish; 5: French; 6: German; 7: Japanese; 8: Korean; 9: Arabic; 10: Thai. + +The `attachments` object supports the following: + +* `content` - (Required, String) Base64-encoded attachment content. You can send attachments of up to 4 MB in the total size.Note: The TencentCloud API supports a request packet of up to 8 MB in size, and the size of the attachmentcontent will increase by 1.5 times after Base64 encoding. Therefore, you need to keep the total size of allattachments below 4 MB. If the entire request exceeds 8 MB, the API will return an error. +* `file_name` - (Required, String) Attachment name, which cannot exceed 255 characters. Some attachment types are not supported. For details, see [Attachment Types.](https://www.tencentcloud.com/document/product/1084/42373?has_map=1). + +The `template` object supports the following: + +* `template_data` - (Required, String) Variable parameters in the template. Please use json.dump to format the JSON object into a string type.The object is a set of key-value pairs. Each key denotes a variable, which is represented by {{key}}. The key will be replaced with the correspondingvalue (represented by {{value}}) when sending the email.Note: The parameter value cannot be data of a complex type such as HTML.Example: {name:xxx,age:xx}. +* `template_id` - (Required, Int) Template ID. If you do not have any template, please create one. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ses_template.html.markdown b/config/docs/r/ses_template.html.markdown new file mode 100644 index 0000000..f742310 --- /dev/null +++ b/config/docs/r/ses_template.html.markdown @@ -0,0 +1,83 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_template" +sidebar_current: "docs-tencentcloud-resource-ses_template" +description: |- + Provides a resource to create a ses template. +--- + +# tencentcloud_ses_template + +Provides a resource to create a ses template. + +## Example Usage + +### Create a ses text template + +```hcl +resource "tencentcloud_ses_template" "example" { + template_name = "tf_example_ses_temp" " + template_content { + text = " example for the ses template " + } +} +``` + +### Create a ses html template + +```hcl +resource "tencentcloud_ses_template" "example" { + template_name = "tf_example_ses_temp" + template_content { + html = <<-EOT + + + + + + mail title + + +
+

Welcome to our service!

+

Dear user,

+

Thank you for using Tencent Cloud:

+

https://cloud.tencent.com/document/product/1653

+

If you did not request this email, please ignore it.

+

from the iac team

+
+ + + EOT + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `template_content` - (Required, List) Sms Template Content. +* `template_name` - (Required, String) smsTemplateName, which must be required. + +The `template_content` object supports the following: + +* `html` - (Optional, String) Html code after base64. +* `text` - (Optional, String) Text content after base64. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ses template can be imported using the id, e.g. +``` +$ terraform import tencentcloud_ses_template.example template_id +``` + diff --git a/config/docs/r/ses_verify_domain.html.markdown b/config/docs/r/ses_verify_domain.html.markdown new file mode 100644 index 0000000..c1357c2 --- /dev/null +++ b/config/docs/r/ses_verify_domain.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Simple Email Service(SES)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ses_verify_domain" +sidebar_current: "docs-tencentcloud-resource-ses_verify_domain" +description: |- + Provides a resource to create a ses verify_domain +--- + +# tencentcloud_ses_verify_domain + +Provides a resource to create a ses verify_domain + +~> **NOTE:** Please add the `attributes` information returned by `tencentcloud_ses_domain` to the domain name resolution record through `tencentcloud_dnspod_record`, and then verify it. + +## Example Usage + +```hcl +resource "tencentcloud_ses_verify_domain" "verify_domain" { + email_identity = "example.com" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `email_identity` - (Required, String, ForceNew) Domain name requested for verification. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/sms_sign.html.markdown b/config/docs/r/sms_sign.html.markdown new file mode 100644 index 0000000..ef0c838 --- /dev/null +++ b/config/docs/r/sms_sign.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Short Message Service(SMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sms_sign" +sidebar_current: "docs-tencentcloud-resource-sms_sign" +description: |- + Provides a resource to create a sms sign +--- + +# tencentcloud_sms_sign + +Provides a resource to create a sms sign + +## Example Usage + +### Create a sms sign instance + +```hcl +resource "tencentcloud_sms_sign" "example" { + sign_name = "tf_example_sms_sign" + sign_type = 1 # 1：APP, DocumentType can be chosen（0，1，2，3，4） + document_type = 4 # Screenshot of application background management (personally developed APP) + international = 0 # Mainland China SMS + sign_purpose = 0 # personal use + proof_image = "your_proof_image" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `document_type` - (Required, Int) DocumentType is used for enterprise authentication, or website, app authentication, etc. DocumentType: 0, 1, 2, 3, 4, 5, 6, 7, 8. +* `international` - (Required, Int) Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS. +* `proof_image` - (Required, String) You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. +* `sign_name` - (Required, String) Sms sign name, unique. +* `sign_purpose` - (Required, Int) Signature purpose: 0: for personal use; 1: for others. +* `sign_type` - (Required, Int) Sms sign type: 0, 1, 2, 3, 4, 5, 6. +* `commission_image` - (Optional, String) Power of attorney, which should be submitted if SignPurpose is for use by others. You should Base64-encode the image first, remove the prefix data:image/jpeg;base64, from the resulted string, and then use it as the value of this parameter. Note: this field will take effect only when SignPurpose is 1 (for user by others). +* `remark` - (Optional, String) Signature application remarks. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/sms_template.html.markdown b/config/docs/r/sms_template.html.markdown new file mode 100644 index 0000000..8bfdbc8 --- /dev/null +++ b/config/docs/r/sms_template.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Short Message Service(SMS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sms_template" +sidebar_current: "docs-tencentcloud-resource-sms_template" +description: |- + Provides a resource to create a sms template +--- + +# tencentcloud_sms_template + +Provides a resource to create a sms template + +## Example Usage + +### Create a sms template + +```hcl +resource "tencentcloud_sms_template" "template" { + template_name = "tf_example_sms_template" + template_content = "example for sms template" + international = 0 # Mainland China SMS + sms_type = 0 # regular SMS + remark = "terraform example" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `international` - (Required, Int) Whether it is Global SMS: 0: Mainland China SMS; 1: Global SMS. +* `remark` - (Required, String) Template remarks, such as reason for application and use case. +* `sms_type` - (Required, Int) SMS type. 0: regular SMS, 1: marketing SMS. +* `template_content` - (Required, String) Message Template Content. +* `template_name` - (Required, String) Message Template name, which must be unique. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/sqlserver_account.html.markdown b/config/docs/r/sqlserver_account.html.markdown new file mode 100644 index 0000000..2b97dd7 --- /dev/null +++ b/config/docs/r/sqlserver_account.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_account" +sidebar_current: "docs-tencentcloud-resource-sqlserver_account" +description: |- + Use this resource to create SQL Server account +--- + +# tencentcloud_sqlserver_account + +Use this resource to create SQL Server account + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_account" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_account" + password = "Qwer@234" + remark = "test-remark" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID that the account belongs to. +* `name` - (Required, String) Name of the SQL Server account. +* `password` - (Required, String) Password of the SQL Server account. +* `is_admin` - (Optional, Bool) Indicate that the account is root account or not. +* `remark` - (Optional, String) Remark of the SQL Server account. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the SQL Server account. +* `status` - Status of the SQL Server account. Valid values: 1, 2, 3, 4. 1 for creating, 2 for running, 3 for modifying, 4 for resetting password, -1 for deleting. +* `update_time` - Last updated time of the SQL Server account. + + +## Import + +SQL Server account can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_sqlserver_account.example mssql-3cdq7kx5#tf_example_account +``` + diff --git a/config/docs/r/sqlserver_account_db_attachment.html.markdown b/config/docs/r/sqlserver_account_db_attachment.html.markdown new file mode 100644 index 0000000..1e7bbba --- /dev/null +++ b/config/docs/r/sqlserver_account_db_attachment.html.markdown @@ -0,0 +1,106 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_account_db_attachment" +sidebar_current: "docs-tencentcloud-resource-sqlserver_account_db_attachment" +description: |- + Use this resource to create SQL Server account DB attachment +--- + +# tencentcloud_sqlserver_account_db_attachment + +Use this resource to create SQL Server account DB attachment + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_db" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_account" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_account" + password = "Qwer@234" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_account_db_attachment" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + account_name = tencentcloud_sqlserver_account.example.name + db_name = tencentcloud_sqlserver_db.example.name + privilege = "ReadWrite" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `account_name` - (Required, String, ForceNew) SQL Server account name. +* `db_name` - (Required, String, ForceNew) SQL Server DB name. +* `instance_id` - (Required, String, ForceNew) SQL Server instance ID that the account belongs to. +* `privilege` - (Required, String) Privilege of the account on DB. Valid values: `ReadOnly`, `ReadWrite`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +SQL Server account DB attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_sqlserver_account_db_attachment.example mssql-3cdq7kx5#tf_example_account#tf_example_db +``` + diff --git a/config/docs/r/sqlserver_basic_instance.html.markdown b/config/docs/r/sqlserver_basic_instance.html.markdown new file mode 100644 index 0000000..1b35079 --- /dev/null +++ b/config/docs/r/sqlserver_basic_instance.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_basic_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_basic_instance" +description: |- + Provides a SQL Server instance resource to create basic database instances. +--- + +# tencentcloud_sqlserver_basic_instance + +Provides a SQL Server instance resource to create basic database instances. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cpu` - (Required, Int) The CPU number of the SQL Server basic instance. +* `machine_type` - (Required, String) The host type of the purchased instance, `CLOUD_PREMIUM` for virtual machine high-performance cloud disk, `CLOUD_SSD` for virtual machine SSD cloud disk, `CLOUD_HSSD` for virtual machine enhanced cloud disk, `CLOUD_BSSD` for virtual machine general purpose SSD cloud disk. +* `memory` - (Required, Int) Memory size (in GB). Allowed value must be larger than `memory` that data source `tencentcloud_sqlserver_specinfos` provides. +* `name` - (Required, String) Name of the SQL Server basic instance. +* `storage` - (Required, Int) Disk size (in GB). Allowed value must be a multiple of 10. The storage must be set with the limit of `storage_min` and `storage_max` which data source `tencentcloud_sqlserver_specinfos` provides. +* `auto_renew` - (Optional, Int) Automatic renewal sign. 0 for normal renewal, 1 for automatic renewal, the default is 1 automatic renewal. Only valid when purchasing a prepaid instance. +* `auto_voucher` - (Optional, Int) Whether to use the voucher automatically; 1 for yes, 0 for no, the default is 0. +* `availability_zone` - (Optional, String, ForceNew) Availability zone. +* `charge_type` - (Optional, String, ForceNew) Pay type of the SQL Server basic instance. For now, only `POSTPAID_BY_HOUR` is valid. +* `engine_version` - (Optional, String, ForceNew) Version of the SQL Server basic database engine. Allowed values are `2008R2`(SQL Server 2008 Enterprise), `2012SP3`(SQL Server 2012 Enterprise), `2016SP1` (SQL Server 2016 Enterprise), `201602`(SQL Server 2016 Standard) and `2017`(SQL Server 2017 Enterprise). Default is `2008R2`. +* `maintenance_start_time` - (Optional, String) Start time of the maintenance in one day, format like `HH:mm`. +* `maintenance_time_span` - (Optional, Int) The timespan of maintenance in one day, unit is hour. +* `maintenance_week_set` - (Optional, Set: [`Int`]) A list of integer indicates weekly maintenance. For example, [1,7] presents do weekly maintenance on every Monday and Sunday. +* `period` - (Optional, Int) Purchase instance period, the default value is 1, which means one month. The value does not exceed 48. +* `project_id` - (Optional, Int) Project ID, default value is 0. +* `security_groups` - (Optional, Set: [`String`]) Security group bound to the instance. +* `subnet_id` - (Optional, String, ForceNew) ID of subnet. +* `tags` - (Optional, Map) The tags of the SQL Server basic instance. +* `voucher_ids` - (Optional, Set: [`String`]) An array of voucher IDs, currently only one can be used for a single order. +* `vpc_id` - (Optional, String, ForceNew) ID of VPC. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the SQL Server basic instance. +* `status` - Status of the SQL Server basic instance. 1 for applying, 2 for running, 3 for running with limit, 4 for isolated, 5 for recycling, 6 for recycled, 7 for running with task, 8 for off-line, 9 for expanding, 10 for migrating, 11 for readonly, 12 for rebooting. +* `vip` - IP for private access. +* `vport` - Port for private access. + + +## Import + +SQL Server basic instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_sqlserver_basic_instance.example mssql-3cdq7kx5 +``` + diff --git a/config/docs/r/sqlserver_business_intelligence_file.html.markdown b/config/docs/r/sqlserver_business_intelligence_file.html.markdown new file mode 100644 index 0000000..554094f --- /dev/null +++ b/config/docs/r/sqlserver_business_intelligence_file.html.markdown @@ -0,0 +1,88 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_business_intelligence_file" +sidebar_current: "docs-tencentcloud-resource-sqlserver_business_intelligence_file" +description: |- + Provides a resource to create a sqlserver business_intelligence_file +--- + +# tencentcloud_sqlserver_business_intelligence_file + +Provides a resource to create a sqlserver business_intelligence_file + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_business_intelligence_instance" "example" { + zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + project_id = 0 + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + db_version = "201603" + security_group_list = [tencentcloud_security_group.security_group.id] + weekly = [1, 2, 3, 4, 5, 6, 7] + start_time = "00:00" + span = 6 + instance_name = "tf_example" +} + +resource "tencentcloud_sqlserver_business_intelligence_file" "example" { + instance_id = tencentcloud_sqlserver_business_intelligence_instance.example.id + file_url = "https://tf-example-1208515315.cos.ap-guangzhou.myqcloud.com/sqlserver_business_intelligence_file.txt" + file_type = "FLAT" + remark = "desc." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `file_type` - (Required, String, ForceNew) File Type FLAT - Flat File as Data Source, SSIS - ssis project package. +* `file_url` - (Required, String, ForceNew) Cos Url. +* `instance_id` - (Required, String, ForceNew) instance id. +* `remark` - (Optional, String, ForceNew) remark. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver business_intelligence_file can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_business_intelligence_file.example mssqlbi-fo2dwujt#test.xlsx +``` + diff --git a/config/docs/r/sqlserver_business_intelligence_instance.html.markdown b/config/docs/r/sqlserver_business_intelligence_instance.html.markdown new file mode 100644 index 0000000..8b76990 --- /dev/null +++ b/config/docs/r/sqlserver_business_intelligence_instance.html.markdown @@ -0,0 +1,97 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_business_intelligence_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_business_intelligence_instance" +description: |- + Provides a resource to create a sqlserver business_intelligence_instance +--- + +# tencentcloud_sqlserver_business_intelligence_instance + +Provides a resource to create a sqlserver business_intelligence_instance + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_business_intelligence_instance" "example" { + zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + project_id = 0 + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + db_version = "201603" + security_group_list = [tencentcloud_security_group.security_group.id] + weekly = [1, 2, 3, 4, 5, 6, 7] + start_time = "00:00" + span = 6 + instance_name = "tf_example" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cpu` - (Required, Int) The number of CPU cores of the instance you want to purchase. +* `instance_name` - (Required, String) Instance Name. +* `machine_type` - (Required, String) The host type of purchased instance. Valid values: CLOUD_PREMIUM (virtual machine with premium cloud disk), CLOUD_SSD (virtual machine with SSD). +* `memory` - (Required, Int) Instance memory size in GB. +* `storage` - (Required, Int) Instance disk size in GB. +* `zone` - (Required, String) Instance AZ, such as ap-guangzhou-1 (Guangzhou Zone 1). Purchasable AZs for an instance can be obtained through theDescribeZones API. +* `db_version` - (Optional, String) Supported versions of business intelligence server. Valid values: 201603 (SQL Server 2016 Integration Services), 201703 (SQL Server 2017 Integration Services), 201903 (SQL Server 2019 Integration Services). Default value: 201903. As the purchasable versions are region-specific, you can use the DescribeProductConfig API to query the information of purchasable versions in each region. +* `project_id` - (Optional, Int) Project ID. +* `resource_tags` - (Optional, List) Tags associated with the instances to be created. +* `security_group_list` - (Optional, List: [`String`]) Security group list, which contains security group IDs in the format of sg-xxx. +* `span` - (Optional, Int) Configuration of the maintenance window, which specifies the maintenance duration in hours. +* `start_time` - (Optional, String) Configuration of the maintenance window, which specifies the start time of daily maintenance. +* `subnet_id` - (Optional, String) VPC subnet ID in the format of subnet-bdoe83fa. Both SubnetId and VpcId need to be set or unset at the same time. +* `vpc_id` - (Optional, String) VPC ID in the format of vpc-dsp338hz. Both SubnetId and VpcId need to be set or unset at the same time. +* `weekly` - (Optional, List: [`Int`]) Configuration of the maintenance window, which specifies the day of the week when maintenance can be performed. Valid values: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday). + +The `resource_tags` object supports the following: + +* `tag_key` - (Optional, String) Tag key. +* `tag_value` - (Optional, String) Tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver business_intelligence_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_business_intelligence_instance.example mssqlbi-fo2dwujt +``` + diff --git a/config/docs/r/sqlserver_complete_expansion.html.markdown b/config/docs/r/sqlserver_complete_expansion.html.markdown new file mode 100644 index 0000000..ca32b32 --- /dev/null +++ b/config/docs/r/sqlserver_complete_expansion.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_complete_expansion" +sidebar_current: "docs-tencentcloud-resource-sqlserver_complete_expansion" +description: |- + Provides a resource to create a sqlserver complete_expansion +--- + +# tencentcloud_sqlserver_complete_expansion + +Provides a resource to create a sqlserver complete_expansion + +## Example Usage + +### First, Create a basic SQL instance + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "example-vpc" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "example-vpc" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "example-sg" + description = "desc." +} + +resource "tencentcloud_sqlserver_instance" "example" { + name = "tf_example_sql" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.security_group.id] + project_id = 0 + memory = 2 + storage = 20 + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "01:00" + maintenance_time_span = 3 + tags = { + "createBy" = "tfExample" + } +} +``` + +### Expand the current instance, storage: 20->40, wait_switch = 1 + +```hcl +resource "tencentcloud_sqlserver_instance" "example" { + name = "tf_example_sql" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + security_groups = [tencentcloud_security_group.security_group.id] + project_id = 0 + memory = 2 + storage = 40 + wait_switch = 1 + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "01:00" + maintenance_time_span = 3 + tags = { + "createBy" = "tfExample" + } +} +``` + +### Complete the expansion task immediately + +```hcl +resource "tencentcloud_sqlserver_complete_expansion" "example" { + instance_id = tencentcloud_sqlserver_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of imported target instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/sqlserver_config_backup_strategy.html.markdown b/config/docs/r/sqlserver_config_backup_strategy.html.markdown new file mode 100644 index 0000000..d7cd10e --- /dev/null +++ b/config/docs/r/sqlserver_config_backup_strategy.html.markdown @@ -0,0 +1,143 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_config_backup_strategy" +sidebar_current: "docs-tencentcloud-resource-sqlserver_config_backup_strategy" +description: |- + Provides a resource to create a sqlserver config_backup_strategy +--- + +# tencentcloud_sqlserver_config_backup_strategy + +Provides a resource to create a sqlserver config_backup_strategy + +## Example Usage + +### Daily backup + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_config_backup_strategy" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + backup_type = "daily" + backup_time = 0 + backup_day = 1 + backup_model = "master_no_pkg" + backup_cycle = [1] + backup_save_days = 7 + regular_backup_enable = "disable" + regular_backup_save_days = 90 + regular_backup_strategy = "months" + regular_backup_counts = 1 +} +``` + +### Weekly backup + +```hcl +resource "tencentcloud_sqlserver_config_backup_strategy" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + backup_type = "weekly" + backup_time = 0 + backup_model = "master_no_pkg" + backup_cycle = [1, 3, 5] + backup_save_days = 7 + regular_backup_enable = "disable" + regular_backup_save_days = 90 + regular_backup_strategy = "months" + regular_backup_counts = 1 +} +``` + +### Regular backup + +```hcl +resource "tencentcloud_sqlserver_config_backup_strategy" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + backup_time = 0 + backup_model = "master_no_pkg" + backup_cycle = [1, 3] + backup_save_days = 7 + regular_backup_enable = "enable" + regular_backup_save_days = 120 + regular_backup_strategy = "months" + regular_backup_counts = 1 + regular_backup_start_time = "%s" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `backup_cycle` - (Optional, Set: [`Int`]) The days of the week on which backup will be performed when `BackupType` is weekly. If data backup retention period is less than 7 days, the values will be 1-7, indicating that backup will be performed everyday by default; if data backup retention period is greater than or equal to 7 days, the values will be at least any two days, indicating that backup will be performed at least twice in a week by default. +* `backup_day` - (Optional, Int) Backup interval in days when the BackupType is daily. The current value can only be 1. +* `backup_model` - (Optional, String) Backup mode. Valid values: master_pkg (archive the backup files of the primary node), master_no_pkg (do not archive the backup files of the primary node), slave_pkg (archive the backup files of the replica node), slave_no_pkg (do not archive the backup files of the replica node). Backup files of the replica node are supported only when Always On disaster recovery is enabled. +* `backup_save_days` - (Optional, Int) Data (log) backup retention period. Value range: 3-1830 days, default value: 7 days. +* `backup_time` - (Optional, Int) Backup time. Value range: an integer from 0 to 23. +* `backup_type` - (Optional, String) Backup type. Valid values: weekly (when length(BackupDay) <=7 && length(BackupDay) >=2), daily (when length(BackupDay)=1). Default value: daily. +* `regular_backup_counts` - (Optional, Int) The number of retained archive backups. Default value: 1. +* `regular_backup_enable` - (Optional, String) Archive backup status. Valid values: enable (enabled); disable (disabled). Default value: disable. +* `regular_backup_save_days` - (Optional, Int) Archive backup retention days. Value range: 90-3650 days. Default value: 365 days. +* `regular_backup_start_time` - (Optional, String) Archive backup start date in YYYY-MM-DD format, which is the current time by default. +* `regular_backup_strategy` - (Optional, String) Archive backup policy. Valid values: years (yearly); quarters (quarterly); months(monthly); Default value: `months`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver config_backup_strategy can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_config_backup_strategy.example mssql-si2823jyl +``` + diff --git a/config/docs/r/sqlserver_config_database_cdc.html.markdown b/config/docs/r/sqlserver_config_database_cdc.html.markdown new file mode 100644 index 0000000..db7f88c --- /dev/null +++ b/config/docs/r/sqlserver_config_database_cdc.html.markdown @@ -0,0 +1,109 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_config_database_cdc" +sidebar_current: "docs-tencentcloud-resource-sqlserver_config_database_cdc" +description: |- + Provides a resource to create a sqlserver config_database_cdc +--- + +# tencentcloud_sqlserver_config_database_cdc + +Provides a resource to create a sqlserver config_database_cdc + +## Example Usage + +### Turn off database data change capture (CDC) + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_db" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_config_database_cdc" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + db_name = tencentcloud_sqlserver_db.example.name + modify_type = "disable" +} +``` + +### Enable Database Data Change Capture (CDC) + +```hcl +resource "tencentcloud_sqlserver_config_database_cdc" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + db_name = tencentcloud_sqlserver_db.example.name + modify_type = "enable" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_name` - (Required, String) database name. +* `instance_id` - (Required, String) Instance ID. +* `modify_type` - (Required, String) Enable or disable CDC. Valid values: enable, disable. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver config_database_cdc can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_config_database_cdc.example mssql-i9ma6oy7#tf_example_db +``` + diff --git a/config/docs/r/sqlserver_config_database_ct.html.markdown b/config/docs/r/sqlserver_config_database_ct.html.markdown new file mode 100644 index 0000000..0642b6a --- /dev/null +++ b/config/docs/r/sqlserver_config_database_ct.html.markdown @@ -0,0 +1,99 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_config_database_ct" +sidebar_current: "docs-tencentcloud-resource-sqlserver_config_database_ct" +description: |- + Provides a resource to create a sqlserver config_database_ct +--- + +# tencentcloud_sqlserver_config_database_ct + +Provides a resource to create a sqlserver config_database_ct + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_db" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_config_database_ct" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + db_name = tencentcloud_sqlserver_db.example.name + modify_type = "disable" + change_retention_day = 7 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_name` - (Required, String) database name. +* `instance_id` - (Required, String) Instance ID. +* `modify_type` - (Required, String) Enable or disable CT. Valid values: enable, disable. +* `change_retention_day` - (Optional, Int) Retention period (in days) of change tracking information when CT is enabled. Value range: 3-30. Default value: 3. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver tencentcloud_sqlserver_config_database_ct can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_config_database_ct.example mssql-i9ma6oy7#tf_example_db +``` + diff --git a/config/docs/r/sqlserver_config_database_mdf.html.markdown b/config/docs/r/sqlserver_config_database_mdf.html.markdown new file mode 100644 index 0000000..73fb729 --- /dev/null +++ b/config/docs/r/sqlserver_config_database_mdf.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_config_database_mdf" +sidebar_current: "docs-tencentcloud-resource-sqlserver_config_database_mdf" +description: |- + Provides a resource to create a sqlserver config_database_mdf +--- + +# tencentcloud_sqlserver_config_database_mdf + +Provides a resource to create a sqlserver config_database_mdf + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_db" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_config_database_mdf" "example" { + db_name = tencentcloud_sqlserver_db.example.name + instance_id = tencentcloud_sqlserver_basic_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_name` - (Required, String) Array of database names. +* `instance_id` - (Required, String) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver config_database_mdf can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_config_database_mdf.example mssql-i9ma6oy7#tf_example_db +``` + diff --git a/config/docs/r/sqlserver_config_delete_db.html.markdown b/config/docs/r/sqlserver_config_delete_db.html.markdown new file mode 100644 index 0000000..359583d --- /dev/null +++ b/config/docs/r/sqlserver_config_delete_db.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_config_delete_db" +sidebar_current: "docs-tencentcloud-resource-sqlserver_config_delete_db" +description: |- + Provides a resource to create a sqlserver config_delete_db +--- + +# tencentcloud_sqlserver_config_delete_db + +Provides a resource to create a sqlserver config_delete_db + +## Example Usage + +```hcl +resource "tencentcloud_sqlserver_config_delete_db" "config_delete_db" { + instance_id = "mssql-i1z41iwd" + name = +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `name` - (Required, String) collection of database name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/sqlserver_config_instance_network.html.markdown b/config/docs/r/sqlserver_config_instance_network.html.markdown new file mode 100644 index 0000000..d9b6470 --- /dev/null +++ b/config/docs/r/sqlserver_config_instance_network.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_config_instance_network" +sidebar_current: "docs-tencentcloud-resource-sqlserver_config_instance_network" +description: |- + Provides a resource to create a sqlserver config_instance_network +--- + +# tencentcloud_sqlserver_config_instance_network + +Provides a resource to create a sqlserver config_instance_network + +## Example Usage + +```hcl +resource "tencentcloud_sqlserver_config_instance_network" "config_instance_network" { + instance_id = "mssql-qelbzgwf" + new_vpc_id = "vpc-4owdpnwr" + new_subnet_id = "sub-ahv6swf2" + vip = "172.16.16.48" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `new_subnet_id` - (Required, String) ID of the new subnet. +* `new_vpc_id` - (Required, String) ID of the new VPC. +* `vip` - (Optional, String) New VIP. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver config_instance_network can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_config_instance_network.config_instance_network config_instance_network_id +``` + diff --git a/config/docs/r/sqlserver_config_instance_param.html.markdown b/config/docs/r/sqlserver_config_instance_param.html.markdown new file mode 100644 index 0000000..a4e0b43 --- /dev/null +++ b/config/docs/r/sqlserver_config_instance_param.html.markdown @@ -0,0 +1,96 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_config_instance_param" +sidebar_current: "docs-tencentcloud-resource-sqlserver_config_instance_param" +description: |- + Provides a resource to create a sqlserver config_instance_param +--- + +# tencentcloud_sqlserver_config_instance_param + +Provides a resource to create a sqlserver config_instance_param + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_config_instance_param" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + param_list { + name = "fill factor(%)" + current_value = "90" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `param_list` - (Required, List) List of modified parameters. Each list element has two fields: Name and CurrentValue. Set Name to the parameter name and CurrentValue to the new value after modification. Note: if the instance needs to be restarted for the modified parameter to take effect, it will be restarted immediately or during the maintenance time. Before you modify a parameter, you can use the DescribeInstanceParams API to query whether the instance needs to be restarted. + +The `param_list` object supports the following: + +* `current_value` - (Optional, String) Parameter value. +* `name` - (Optional, String) Parameter name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver config_instance_param can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_config_instance_param.example config_instance_param +``` + diff --git a/config/docs/r/sqlserver_config_instance_ro_group.html.markdown b/config/docs/r/sqlserver_config_instance_ro_group.html.markdown new file mode 100644 index 0000000..5451b1f --- /dev/null +++ b/config/docs/r/sqlserver_config_instance_ro_group.html.markdown @@ -0,0 +1,121 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_config_instance_ro_group" +sidebar_current: "docs-tencentcloud-resource-sqlserver_config_instance_ro_group" +description: |- + Provides a resource to create a sqlserver config_instance_ro_group +--- + +# tencentcloud_sqlserver_config_instance_ro_group + +Provides a resource to create a sqlserver config_instance_ro_group + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_readonly_instance" "example" { + name = "tf_example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + memory = 4 + storage = 20 + master_instance_id = tencentcloud_sqlserver_basic_instance.example.id + readonly_group_type = 2 + read_only_group_name = "tf_example_ro" + is_offline_delay = 1 + read_only_max_delay_time = 10 + min_read_only_in_group = 0 + force_upgrade = true +} + +resource "tencentcloud_sqlserver_config_instance_ro_group" "example" { + instance_id = tencentcloud_sqlserver_readonly_instance.example.master_instance_id + read_only_group_id = tencentcloud_sqlserver_readonly_instance.example.readonly_group_id + read_only_group_name = "tf_example_ro_update" + is_offline_delay = 1 + read_only_max_delay_time = 5 + min_read_only_in_group = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `read_only_group_id` - (Required, String) Read-only group ID. +* `auto_weight` - (Optional, Int) 0-user-defined weight (adjusted according to WeightPairs), 1-system automatically assigns weight (WeightPairs is invalid), the default is 0. +* `balance_weight` - (Optional, Int) 0-do not rebalance the load, 1-rebalance the load, the default is 0. +* `is_offline_delay` - (Optional, Int) Whether to enable timeout culling function. 0- Disable the culling function. 1- Enable the culling function. +* `min_read_only_in_group` - (Optional, Int) After the timeout removal function is enabled, the number of read-only copies retained by the read-only group at least, if this parameter is not filled, it will not be modified. +* `read_only_group_name` - (Optional, String) Read-only group name. If this parameter is not specified, it is not modified. +* `read_only_max_delay_time` - (Optional, Int) After the timeout elimination function is enabled, the timeout threshold used, if this parameter is not filled, it will not be modified. +* `weight_pairs` - (Optional, List) Read-only group instance weight modification set, if this parameter is not filled, it will not be modified. + +The `weight_pairs` object supports the following: + +* `read_only_instance_id` - (Required, String) Read-only instance ID, in the format: mssqlro-3l3fgqn7. +* `read_only_weight` - (Required, Int) Read-only instance weight, the range is 0-100. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver config_instance_ro_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_config_instance_ro_group.example mssql-ds1xhnt9#mssqlro-o6dv2ugx#0#0 +``` + diff --git a/config/docs/r/sqlserver_config_instance_security_groups.html.markdown b/config/docs/r/sqlserver_config_instance_security_groups.html.markdown new file mode 100644 index 0000000..96df45a --- /dev/null +++ b/config/docs/r/sqlserver_config_instance_security_groups.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_config_instance_security_groups" +sidebar_current: "docs-tencentcloud-resource-sqlserver_config_instance_security_groups" +description: |- + Provides a resource to create a sqlserver config_instance_security_groups +--- + +# tencentcloud_sqlserver_config_instance_security_groups + +Provides a resource to create a sqlserver config_instance_security_groups + +## Example Usage + +```hcl +resource "tencentcloud_sqlserver_config_instance_security_groups" "config_instance_security_groups" { + instance_id = "mssql-qelbzgwf" + security_group_id_set = ["sg-mayqdlt1", "sg-5aubsf8n"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `security_group_id_set` - (Required, Set: [`String`]) A list of security group IDs to modify, an array of one or more security group IDs. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver config_instance_security_groups can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_config_instance_security_groups.config_instance_security_groups config_instance_security_groups_id +``` + diff --git a/config/docs/r/sqlserver_config_terminate_db_instance.html.markdown b/config/docs/r/sqlserver_config_terminate_db_instance.html.markdown new file mode 100644 index 0000000..6283836 --- /dev/null +++ b/config/docs/r/sqlserver_config_terminate_db_instance.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_config_terminate_db_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_config_terminate_db_instance" +description: |- + Provides a resource to create a sqlserver config_terminate_db_instance +--- + +# tencentcloud_sqlserver_config_terminate_db_instance + +Provides a resource to create a sqlserver config_terminate_db_instance + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_config_terminate_db_instance" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver config_terminate_db_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_config_terminate_db_instance.example mssql-i9ma6oy7 +``` + diff --git a/config/docs/r/sqlserver_database_tde.html.markdown b/config/docs/r/sqlserver_database_tde.html.markdown new file mode 100644 index 0000000..c668820 --- /dev/null +++ b/config/docs/r/sqlserver_database_tde.html.markdown @@ -0,0 +1,109 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_database_tde" +sidebar_current: "docs-tencentcloud-resource-sqlserver_database_tde" +description: |- + Provides a resource to create a sqlserver database_tde +--- + +# tencentcloud_sqlserver_database_tde + +Provides a resource to create a sqlserver database_tde + +## Example Usage + +### Open database tde encryption + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_db" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_database_tde" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + db_names = [tencentcloud_sqlserver_db.example.name] + encryption = "enable" +} +``` + +### Close database tde encryption + +```hcl +resource "tencentcloud_sqlserver_database_tde" "example" { + instance_id = tencentcloud_sqlserver_instance.example.id + db_names = [tencentcloud_sqlserver_db.example.name] + encryption = "disable" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `db_names` - (Required, Set: [`String`]) Database name list. +* `encryption` - (Required, String) `enable` - enable encryption, `disable` - disable encryption. +* `instance_id` - (Required, String) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver database_tde can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_database_tde.example mssql-farjz9tz#tf_example_db +``` + diff --git a/config/docs/r/sqlserver_db.html.markdown b/config/docs/r/sqlserver_db.html.markdown new file mode 100644 index 0000000..a39dc7c --- /dev/null +++ b/config/docs/r/sqlserver_db.html.markdown @@ -0,0 +1,93 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_db" +sidebar_current: "docs-tencentcloud-resource-sqlserver_db" +description: |- + Provides a SQL Server DB resource belongs to SQL Server instance. +--- + +# tencentcloud_sqlserver_db + +Provides a SQL Server DB resource belongs to SQL Server instance. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_db" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) SQL Server instance ID which DB belongs to. +* `name` - (Required, String, ForceNew) Name of SQL Server DB. The database name must be unique and must be composed of numbers, letters and underlines, and the first one can not be underline. +* `charset` - (Optional, String, ForceNew) Character set DB uses. Valid values: `Chinese_PRC_CI_AS`, `Chinese_PRC_CS_AS`, `Chinese_PRC_BIN`, `Chinese_Taiwan_Stroke_CI_AS`, `SQL_Latin1_General_CP1_CI_AS`, and `SQL_Latin1_General_CP1_CS_AS`. Default value is `Chinese_PRC_CI_AS`. +* `remark` - (Optional, String) Remark of the DB. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Database creation time. +* `status` - Database status, could be `creating`, `running`, `modifying` which means changing the remark, and `deleting`. + + +## Import + +SQL Server DB can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_sqlserver_db.example mssql-3cdq7kx5#tf_example_db +``` + diff --git a/config/docs/r/sqlserver_full_backup_migration.html.markdown b/config/docs/r/sqlserver_full_backup_migration.html.markdown new file mode 100644 index 0000000..291f187 --- /dev/null +++ b/config/docs/r/sqlserver_full_backup_migration.html.markdown @@ -0,0 +1,114 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_full_backup_migration" +sidebar_current: "docs-tencentcloud-resource-sqlserver_full_backup_migration" +description: |- + Provides a resource to create a sqlserver full_backup_migration +--- + +# tencentcloud_sqlserver_full_backup_migration + +Provides a resource to create a sqlserver full_backup_migration + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +data "tencentcloud_sqlserver_backups" "example" { + instance_id = tencentcloud_sqlserver_db.example.instance_id + backup_name = tencentcloud_sqlserver_general_backup.example.backup_name + start_time = "2023-07-25 00:00:00" + end_time = "2023-08-04 00:00:00" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_db" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_general_backup" "example" { + instance_id = tencentcloud_sqlserver_db.example.instance_id + backup_name = "tf_example_backup" + strategy = 0 +} + +resource "tencentcloud_sqlserver_full_backup_migration" "example" { + instance_id = tencentcloud_sqlserver_general_backup.example.instance_id + recovery_type = "FULL" + upload_type = "COS_URL" + migration_name = "migration_test" + backup_files = [data.tencentcloud_sqlserver_backups.example.list.0.internet_url] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) ID of imported target instance. +* `migration_name` - (Required, String) Task name. +* `recovery_type` - (Required, String) Migration task restoration type. FULL: full backup restoration, FULL_LOG: full backup and transaction log restoration, FULL_DIFF: full backup and differential backup restoration. +* `upload_type` - (Required, String) Backup upload type. COS_URL: the backup is stored in users Cloud Object Storage, with URL provided. COS_UPLOAD: the backup is stored in the applications Cloud Object Storage and needs to be uploaded by the user. +* `backup_files` - (Optional, List: [`String`]) If the UploadType is COS_URL, fill in the URL here. If the UploadType is COS_UPLOAD, fill in the name of the backup file here. Only 1 backup file is supported, but a backup file can involve multiple databases. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `backup_migration_id` - Backup import task ID. + + +## Import + +sqlserver full_backup_migration can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_full_backup_migration.example mssql-si2823jyl#mssql-backup-migration-cg0ffgqt +``` + diff --git a/config/docs/r/sqlserver_general_backup.html.markdown b/config/docs/r/sqlserver_general_backup.html.markdown new file mode 100644 index 0000000..50bcb36 --- /dev/null +++ b/config/docs/r/sqlserver_general_backup.html.markdown @@ -0,0 +1,98 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_general_backup" +sidebar_current: "docs-tencentcloud-resource-sqlserver_general_backup" +description: |- + Provides a resource to create a sqlserver general_backup +--- + +# tencentcloud_sqlserver_general_backup + +Provides a resource to create a sqlserver general_backup + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_db" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_general_backup" "example" { + instance_id = tencentcloud_sqlserver_db.example.instance_id + backup_name = "tf_example_backup" + strategy = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID in the format of mssql-i1z41iwd. +* `backup_name` - (Optional, String) Backup name. If this parameter is left empty, a backup name in the format of [Instance ID]_[Backup start timestamp] will be automatically generated. +* `db_names` - (Optional, Set: [`String`]) List of names of databases to be backed up (required only for multi-database backup). +* `strategy` - (Optional, Int) Backup policy (0: instance backup, 1: multi-database backup). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `flow_id` - flow id. + + +## Import + +sqlserver general_backups can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_general_backups.example mssql-qelbzgwf#3512621#5293#2020-07-31 14:28:51#2020-07-31 15:10:27#autoed_instance_58037_20200728011545.bak.tar +``` + diff --git a/config/docs/r/sqlserver_general_clone.html.markdown b/config/docs/r/sqlserver_general_clone.html.markdown new file mode 100644 index 0000000..c51851d --- /dev/null +++ b/config/docs/r/sqlserver_general_clone.html.markdown @@ -0,0 +1,97 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_general_clone" +sidebar_current: "docs-tencentcloud-resource-sqlserver_general_clone" +description: |- + Provides a resource to create a sqlserver general_communication +--- + +# tencentcloud_sqlserver_general_clone + +Provides a resource to create a sqlserver general_communication + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + name = "tf_example_db" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_general_clone" "example" { + instance_id = tencentcloud_sqlserver_db.example.instance_id + old_name = tencentcloud_sqlserver_db.example.name + new_name = "tf_example_db_clone" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `new_name` - (Required, String) New database name. In offline migration, OldName will be used if NewName is left empty (OldName and NewName cannot be both empty). In database cloning, OldName and NewName must be both specified and cannot have the same value. +* `old_name` - (Required, String) Database name. If the OldName database does not exist, a failure will be returned. It can be left empty in offline migration tasks. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver general_communication can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_general_clone.example mssql-si2823jyl#tf_example_db#tf_example_db_clone +``` + diff --git a/config/docs/r/sqlserver_general_cloud_instance.html.markdown b/config/docs/r/sqlserver_general_cloud_instance.html.markdown new file mode 100644 index 0000000..f97fc52 --- /dev/null +++ b/config/docs/r/sqlserver_general_cloud_instance.html.markdown @@ -0,0 +1,110 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_general_cloud_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_general_cloud_instance" +description: |- + Provides a resource to create a sqlserver general_cloud_instance +--- + +# tencentcloud_sqlserver_general_cloud_instance + +Provides a resource to create a sqlserver general_cloud_instance + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_general_cloud_instance" "example" { + name = "tf_example" + zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_HSSD" + instance_charge_type = "POSTPAID" + project_id = 0 + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + db_version = "2008R2" + security_group_list = [tencentcloud_security_group.security_group.id] + weekly = [1, 2, 3, 5, 6, 7] + start_time = "00:00" + span = 6 + resource_tags { + tag_key = "test" + tag_value = "test" + } + collation = "Chinese_PRC_CI_AS" + time_zone = "China Standard Time" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cpu` - (Required, Int) Cpu, unit: CORE. +* `machine_type` - (Required, String) The host disk type of the purchased instance, CLOUD_HSSD-enhanced SSD cloud disk for virtual machines, CLOUD_TSSD-extremely fast SSD cloud disk for virtual machines, CLOUD_BSSD-universal SSD cloud disk for virtual machines. +* `memory` - (Required, Int) Memory, unit: GB. +* `name` - (Required, String) Name of the SQL Server instance. +* `storage` - (Required, Int) instance disk storage, unit: GB. +* `zone` - (Required, String) Instance AZ, such as ap-guangzhou-1 (Guangzhou Zone 1). Purchasable AZs for an instance can be obtained through the DescribeZones API. +* `auto_renew_flag` - (Optional, Int) Automatic renewal flag: 0-normal renewal 1-automatic renewal, the default is 1 automatic renewal. Valid only when purchasing a prepaid instance. Valid only when the 'instance_charge_type' parameter value is 'PREPAID'. +* `collation` - (Optional, String) System character set collation, default: Chinese_PRC_CI_AS. +* `db_version` - (Optional, String) sqlserver version, currently all supported versions are: 2008R2 (SQL Server 2008 R2 Enterprise), 2012SP3 (SQL Server 2012 Enterprise), 201202 (SQL Server 2012 Standard), 2014SP2 (SQL Server 2014 Enterprise), 201402 (SQL Server 2014 Standard), 2016SP1 (SQL Server 2016 Enterprise), 201602 (SQL Server 2016 Standard), 2017 (SQL Server 2017 Enterprise), 201702 (SQL Server 2017 Standard), 2019 (SQL Server 2019 Enterprise), 201902 (SQL Server 2019 Standard). Each region supports different versions for sale, and the version information that can be sold in each region can be pulled through the DescribeProductConfig interface. If left blank, the default version is 2008R2. +* `ha_type` - (Optional, String, **Deprecated**) It has been deprecated from version 1.81.2. Upgrade the high-availability architecture of sqlserver, upgrade from mirror disaster recovery to always on cluster disaster recovery, only support 2017 and above and support always on high-availability instances, do not support downgrading to mirror disaster recovery, CLUSTER-upgrade to always on capacity Disaster, if not filled, the high-availability architecture will not be modified. +* `instance_charge_type` - (Optional, String) Payment mode, the value supports PREPAID (prepaid), POSTPAID (postpaid). +* `period` - (Optional, Int) Purchase instance period, the default value is 1, which means one month. The value cannot exceed 48. Valid only when the 'instance_charge_type' parameter value is 'PREPAID'. +* `project_id` - (Optional, Int) project ID. +* `resource_tags` - (Optional, List) A collection of tags bound to the new instance. +* `security_group_list` - (Optional, Set: [`String`]) Security group list, fill in the security group ID in the form of sg-xxx. +* `span` - (Optional, Int) Maintainable time window configuration, duration, unit: hour. +* `start_time` - (Optional, String) Maintainable time window configuration, daily maintainable start time. +* `subnet_id` - (Optional, String) VPC subnet ID, in the form of subnet-bdoe83fa; SubnetId and VpcId need to be set at the same time or not set at the same time. +* `time_zone` - (Optional, String) System time zone, default: China Standard Time. +* `vpc_id` - (Optional, String) VPC network ID, in the form of vpc-dsp338hz; SubnetId and VpcId need to be set at the same time or not set at the same time. +* `weekly` - (Optional, Set: [`Int`]) Maintainable time window configuration, in weeks, indicates the days of the week that allow maintenance, 1-7 represent Monday to weekend respectively. + +The `resource_tags` object supports the following: + +* `tag_key` - (Optional, String) tag key. +* `tag_value` - (Optional, String) tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver general_cloud_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_general_cloud_instance.example mssql-i9ma6oy7 +``` + diff --git a/config/docs/r/sqlserver_general_cloud_ro_instance.html.markdown b/config/docs/r/sqlserver_general_cloud_ro_instance.html.markdown new file mode 100644 index 0000000..a504c60 --- /dev/null +++ b/config/docs/r/sqlserver_general_cloud_ro_instance.html.markdown @@ -0,0 +1,171 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_general_cloud_ro_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_general_cloud_ro_instance" +description: |- + Provides a resource to create a sqlserver general_cloud_ro_instance +--- + +# tencentcloud_sqlserver_general_cloud_ro_instance + +Provides a resource to create a sqlserver general_cloud_ro_instance + +## Example Usage + +### If read_only_group_type value is 1 - Ship according to one instance and one read-only group: + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_general_cloud_instance" "example" { + name = "tf_example" + zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_HSSD" + instance_charge_type = "POSTPAID" + project_id = 0 + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + db_version = "2008R2" + security_group_list = [tencentcloud_security_group.security_group.id] + weekly = [1, 2, 3, 5, 6, 7] + start_time = "00:00" + span = 6 + resource_tags { + tag_key = "test" + tag_value = "test" + } + collation = "Chinese_PRC_CI_AS" + time_zone = "China Standard Time" +} + +resource "tencentcloud_sqlserver_general_cloud_ro_instance" "example" { + instance_id = tencentcloud_sqlserver_general_cloud_instance.example.id + zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + read_only_group_type = 1 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_BSSD" + instance_charge_type = "POSTPAID" + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + security_group_list = [tencentcloud_security_group.security_group.id] + collation = "Chinese_PRC_CI_AS" + time_zone = "China Standard Time" + resource_tags = { + test-key1 = "test-value1" + test-key2 = "test-value2" + } +} +``` + +### If read_only_group_type value is 2 - Ship after creating a read-only group, all instances are under this read-only group: + +```hcl +resource "tencentcloud_sqlserver_general_cloud_ro_instance" "example" { + instance_id = tencentcloud_sqlserver_general_cloud_instance.example.id + zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + read_only_group_type = 2 + read_only_group_name = "test-ro-group" + read_only_group_is_offline_delay = 1 + read_only_group_max_delay_time = 10 + read_only_group_min_in_group = 1 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_BSSD" + instance_charge_type = "POSTPAID" + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + security_group_list = [tencentcloud_security_group.security_group.id] + collation = "Chinese_PRC_CI_AS" + time_zone = "China Standard Time" + resource_tags = { + test-key1 = "test-value1" + test-key2 = "test-value2" + } +} +``` + +### If read_only_group_type value is 3 - All instances shipped are in the existing Some read-only groups below: + +```hcl +resource "tencentcloud_sqlserver_general_cloud_ro_instance" "example" { + instance_id = tencentcloud_sqlserver_general_cloud_instance.example.id + zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + read_only_group_type = 3 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_BSSD" + read_only_group_id = "mssqlrg-clboghrj" + instance_charge_type = "POSTPAID" + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + security_group_list = [tencentcloud_security_group.security_group.id] + collation = "Chinese_PRC_CI_AS" + time_zone = "China Standard Time" + resource_tags = { + test-key1 = "test-value1" + test-key2 = "test-value2" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cpu` - (Required, Int) Number of instance cores. +* `instance_id` - (Required, String) Primary instance ID, in the format: mssql-3l3fgqn7. +* `machine_type` - (Required, String) The host disk type of the purchased instance, CLOUD_HSSD-enhanced SSD cloud disk for virtual machines, CLOUD_TSSD-extremely fast SSD cloud disk for virtual machines, CLOUD_BSSD-universal SSD cloud disk for virtual machines. +* `memory` - (Required, Int) Instance memory size, in GB. +* `read_only_group_type` - (Required, Int) Read-only group type option, 1- Ship according to one instance and one read-only group, 2 - Ship after creating a read-only group, all instances are under this read-only group, 3 - All instances shipped are in the existing Some read-only groups below. +* `storage` - (Required, Int) Instance disk size, in GB. +* `zone` - (Required, String) Instance Availability Zone, similar to ap-guangzhou-1 (Guangzhou District 1); the instance sales area can be obtained through the interface DescribeZones. +* `collation` - (Optional, String) System character set collation, default: Chinese_PRC_CI_AS. +* `instance_charge_type` - (Optional, String) Payment mode, the value supports PREPAID (prepaid), POSTPAID (postpaid). +* `period` - (Optional, Int) Purchase instance period, the default value is 1, which means one month. The value cannot exceed 48. +* `read_only_group_id` - (Optional, String) Required when ReadOnlyGroupType=3, existing read-only group ID. +* `read_only_group_is_offline_delay` - (Optional, Int) Required when ReadOnlyGroupType=2, whether to enable the delayed elimination function for the newly created read-only group, 1-on, 0-off. When the delay between the read-only replica and the primary instance is greater than the threshold, it will be automatically removed. +* `read_only_group_max_delay_time` - (Optional, Int) Mandatory when ReadOnlyGroupType=2 and ReadOnlyGroupIsOfflineDelay=1, the threshold for delay culling of newly created read-only groups. +* `read_only_group_min_in_group` - (Optional, Int) Required when ReadOnlyGroupType=2 and ReadOnlyGroupIsOfflineDelay=1, the newly created read-only group retains at least the number of read-only replicas after delay elimination. +* `read_only_group_name` - (Optional, String) Required when ReadOnlyGroupType=2, the name of the newly created read-only group. +* `resource_tags` - (Optional, Map) Tag description list. +* `security_group_list` - (Optional, Set: [`String`]) Security group list, fill in the security group ID in the form of sg-xxx. +* `subnet_id` - (Optional, String) VPC subnet ID, in the form of subnet-bdoe83fa; SubnetId and VpcId need to be set at the same time or not set at the same time. +* `time_zone` - (Optional, String) System time zone, default: China Standard Time. +* `vpc_id` - (Optional, String) VPC network ID, in the form of vpc-dsp338hz; SubnetId and VpcId need to be set at the same time or not set at the same time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `ro_instance_id` - Primary read only instance ID, in the format: mssqlro-lbljc5qd. + + diff --git a/config/docs/r/sqlserver_general_communication.html.markdown b/config/docs/r/sqlserver_general_communication.html.markdown new file mode 100644 index 0000000..3be7f4b --- /dev/null +++ b/config/docs/r/sqlserver_general_communication.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_general_communication" +sidebar_current: "docs-tencentcloud-resource-sqlserver_general_communication" +description: |- + Provides a resource to create a sqlserver general_communication +--- + +# tencentcloud_sqlserver_general_communication + +Provides a resource to create a sqlserver general_communication + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_general_communication" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of instances. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver general_communication can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_general_communication.example mssql-hlh6yka1 +``` + diff --git a/config/docs/r/sqlserver_incre_backup_migration.html.markdown b/config/docs/r/sqlserver_incre_backup_migration.html.markdown new file mode 100644 index 0000000..8987674 --- /dev/null +++ b/config/docs/r/sqlserver_incre_backup_migration.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_incre_backup_migration" +sidebar_current: "docs-tencentcloud-resource-sqlserver_incre_backup_migration" +description: |- + Provides a resource to create a sqlserver incre_backup_migration +--- + +# tencentcloud_sqlserver_incre_backup_migration + +Provides a resource to create a sqlserver incre_backup_migration + +## Example Usage + +```hcl +resource "tencentcloud_sqlserver_incre_backup_migration" "example" { + instance_id = "mssql-4gmc5805" + backup_migration_id = "mssql-backup-migration-9tj0sxnz" + backup_files = [] + is_recovery = "YES" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_migration_id` - (Required, String) Backup import task ID, which is returned through the API CreateBackupMigration. +* `instance_id` - (Required, String) ID of imported target instance. +* `backup_files` - (Optional, List: [`String`]) Incremental backup file. If the UploadType of a full backup file is COS_URL, fill in URL here. If the UploadType is COS_UPLOAD, fill in the name of the backup file here. Only 1 backup file is supported, but a backup file can involve multiple databases. +* `is_recovery` - (Optional, String) Whether restoration is required. No: not required. Yes: required. Not required by default. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `incremental_migration_id` - Incremental import task ID. + + +## Import + +sqlserver incre_backup_migration can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_incre_backup_migration.incre_backup_migration incre_backup_migration_id +``` + diff --git a/config/docs/r/sqlserver_instance.html.markdown b/config/docs/r/sqlserver_instance.html.markdown new file mode 100644 index 0000000..e7aef63 --- /dev/null +++ b/config/docs/r/sqlserver_instance.html.markdown @@ -0,0 +1,91 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_instance" +description: |- + Use this resource to create SQL Server instance +--- + +# tencentcloud_sqlserver_instance + +Use this resource to create SQL Server instance + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_sqlserver_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 16 + storage = 100 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `memory` - (Required, Int) Memory size (in GB). Allowed value must be larger than `memory` that data source `tencentcloud_sqlserver_specinfos` provides. +* `name` - (Required, String) Name of the SQL Server instance. +* `storage` - (Required, Int) Disk size (in GB). Allowed value must be a multiple of 10. The storage must be set with the limit of `storage_min` and `storage_max` which data source `tencentcloud_sqlserver_specinfos` provides. +* `auto_renew` - (Optional, Int) Automatic renewal sign. 0 for normal renewal, 1 for automatic renewal (Default). Only valid when purchasing a prepaid instance. +* `auto_voucher` - (Optional, Int) Whether to use the voucher automatically; 1 for yes, 0 for no, the default is 0. +* `availability_zone` - (Optional, String, ForceNew) Availability zone. +* `charge_type` - (Optional, String, ForceNew) Pay type of the SQL Server instance. Available values `PREPAID`, `POSTPAID_BY_HOUR`. +* `engine_version` - (Optional, String, ForceNew) Version of the SQL Server database engine. Allowed values are `2008R2`(SQL Server 2008 Enterprise), `2012SP3`(SQL Server 2012 Enterprise), `2016SP1` (SQL Server 2016 Enterprise), `201602`(SQL Server 2016 Standard) and `2017`(SQL Server 2017 Enterprise). Default is `2008R2`. +* `ha_type` - (Optional, String, ForceNew) Instance type. `DUAL` (dual-server high availability), `CLUSTER` (cluster). Default is `DUAL`. +* `maintenance_start_time` - (Optional, String) Start time of the maintenance in one day, format like `HH:mm`. +* `maintenance_time_span` - (Optional, Int) The timespan of maintenance in one day, unit is hour. +* `maintenance_week_set` - (Optional, Set: [`Int`]) A list of integer indicates weekly maintenance. For example, [2,7] presents do weekly maintenance on every Tuesday and Sunday. +* `multi_zones` - (Optional, Bool, ForceNew) Indicate whether to deploy across availability zones. +* `period` - (Optional, Int) Purchase instance period in month. The value does not exceed 48. +* `project_id` - (Optional, Int) Project ID, default value is 0. +* `security_groups` - (Optional, Set: [`String`]) Security group bound to the instance. +* `subnet_id` - (Optional, String) ID of subnet. +* `tags` - (Optional, Map) The tags of the SQL Server. +* `voucher_ids` - (Optional, Set: [`String`]) An array of voucher IDs, currently only one can be used for a single order. +* `vpc_id` - (Optional, String) ID of VPC. +* `wait_switch` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.81.2. The way to execute the allocation. Supported values include: 0 - execute immediately, 1 - execute in maintenance window. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the SQL Server instance. +* `ro_flag` - Readonly flag. `RO` (read-only instance), `MASTER` (primary instance with read-only instances). If it is left empty, it refers to an instance which is not read-only and has no RO group. +* `status` - Status of the SQL Server instance. 1 for applying, 2 for running, 3 for running with limit, 4 for isolated, 5 for recycling, 6 for recycled, 7 for running with task, 8 for off-line, 9 for expanding, 10 for migrating, 11 for readonly, 12 for rebooting. +* `vip` - IP for private access. +* `vport` - Port for private access. + + +## Import + +SQL Server instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_sqlserver_instance.example mssql-3cdq7kx5 +``` + diff --git a/config/docs/r/sqlserver_instance_tde.html.markdown b/config/docs/r/sqlserver_instance_tde.html.markdown new file mode 100644 index 0000000..fc5204a --- /dev/null +++ b/config/docs/r/sqlserver_instance_tde.html.markdown @@ -0,0 +1,89 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_instance_tde" +sidebar_current: "docs-tencentcloud-resource-sqlserver_instance_tde" +description: |- + Provides a resource to create a sqlserver instance_tde +--- + +# tencentcloud_sqlserver_instance_tde + +Provides a resource to create a sqlserver instance_tde + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_instance_tde" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + certificate_attribution = "self" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_attribution` - (Required, String) Certificate attribution. self- means to use the account's own certificate, others- means to refer to the certificate of other accounts, and the default is self. +* `instance_id` - (Required, String) Instance ID. +* `quote_uin` - (Optional, String) Other referenced main account IDs, required when CertificateAttribute is others. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver instance_tde can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_instance_tde.example mssql-farjz9tz +``` + diff --git a/config/docs/r/sqlserver_migration.html.markdown b/config/docs/r/sqlserver_migration.html.markdown new file mode 100644 index 0000000..02e48d2 --- /dev/null +++ b/config/docs/r/sqlserver_migration.html.markdown @@ -0,0 +1,199 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_migration" +sidebar_current: "docs-tencentcloud-resource-sqlserver_migration" +description: |- + Provides a resource to create a sqlserver migration +--- + +# tencentcloud_sqlserver_migration + +Provides a resource to create a sqlserver migration + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "src_example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_basic_instance" "dst_example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_db" "src" { + instance_id = tencentcloud_sqlserver_basic_instance.src_example.id + name = "tf_example_db_src" + charset = "Chinese_PRC_BIN" + remark = "testACC-remark" +} + +resource "tencentcloud_sqlserver_db" "dst" { + instance_id = tencentcloud_sqlserver_basic_instance.dst_example.id + name = "tf_example_db_dst" + charset = "Chinese_PRC_BIN" + remark = "testACC-remark" +} + +resource "tencentcloud_sqlserver_account" "src" { + instance_id = tencentcloud_sqlserver_basic_instance.src_example.id + name = "tf_example_src_account" + password = "Qwer@234" + is_admin = true +} + +resource "tencentcloud_sqlserver_account" "dst" { + instance_id = tencentcloud_sqlserver_basic_instance.dst_example.id + name = "tf_example_dst_account" + password = "Qwer@234" + is_admin = true +} + +resource "tencentcloud_sqlserver_account_db_attachment" "src" { + instance_id = tencentcloud_sqlserver_basic_instance.src_example.id + account_name = tencentcloud_sqlserver_account.src.name + db_name = tencentcloud_sqlserver_db.src.name + privilege = "ReadWrite" +} + +resource "tencentcloud_sqlserver_account_db_attachment" "dst" { + instance_id = tencentcloud_sqlserver_basic_instance.dst_example.id + account_name = tencentcloud_sqlserver_account.dst.name + db_name = tencentcloud_sqlserver_db.dst.name + privilege = "ReadWrite" +} + +resource "tencentcloud_sqlserver_migration" "migration" { + migrate_name = "tf_test_migration" + migrate_type = 1 + source_type = 1 + source { + instance_id = tencentcloud_sqlserver_basic_instance.src_example.id + user_name = tencentcloud_sqlserver_account.src.name + password = tencentcloud_sqlserver_account.src.password + } + target { + instance_id = tencentcloud_sqlserver_basic_instance.dst_example.id + user_name = tencentcloud_sqlserver_account.dst.name + password = tencentcloud_sqlserver_account.dst.password + } + + migrate_db_set { + db_name = tencentcloud_sqlserver_db.src.name + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `migrate_name` - (Required, String) Name of the migration task. +* `migrate_type` - (Required, Int) Migration type (1 structure migration 2 data migration 3 incremental synchronization). +* `source_type` - (Required, Int) Type of migration source 1 TencentDB for SQLServer 2 Cloud server self-built SQLServer database 4 SQLServer backup and restore 5 SQLServer backup and restore (COS mode). +* `source` - (Required, List) Migration source. +* `target` - (Required, List) Migration target. +* `migrate_db_set` - (Optional, List) Migrate DB objects. Offline migration is not used (SourceType=4 or SourceType=5). +* `rename_restore` - (Optional, List) Restore and rename the database in ReNameRestoreDatabase. If it is not filled in, the restored database will be named by default and all databases will be restored. Valid if SourceType=5. + +The `migrate_db_set` object supports the following: + +* `db_name` - (Optional, String) Name of the migration database. + +The `rename_restore` object supports the following: + +* `new_name` - (Optional, String) When the new name of the library is used for offline migration, if it is not filled in, it will be named according to OldName. OldName and NewName cannot be filled in at the same time. OldName and NewName must be filled in and cannot be duplicate when used for cloning database. +* `old_name` - (Optional, String) The name of the library. If oldName does not exist, a failure is returned.It can be left blank when used for offline migration tasks. + +The `source` object supports the following: + +* `cvm_id` - (Optional, String) ID of the migration source Cvm, used when MigrateType=2 (cloud server self-built SQL Server database). +* `instance_id` - (Optional, String) The ID of the migration source instance, which is used when MigrateType=1 (TencentDB for SQLServers). The format is mssql-si2823jyl. +* `ip` - (Optional, String) Migrate the intranet IP of the self-built database of the source Cvm, and use it when MigrateType=2 (self-built SQL Server database of the cloud server). +* `password` - (Optional, String) Password, MigrateType=1 or MigrateType=2. +* `port` - (Optional, Int) The port number of the self-built database of the migration source Cvm, which is used when MigrateType=2 (self-built SQL Server database of the cloud server). +* `subnet_id` - (Optional, String) The subnet ID under the Vpc of the source Cvm is used when MigrateType=2 (ECS self-built SQL Server database). The format is as follows subnet-h9extioi. +* `url_password` - (Optional, String) The source backup password for offline migration, MigrateType=4 or MigrateType=5. +* `url` - (Optional, Set) The source backup address for offline migration. MigrateType=4 or MigrateType=5. +* `user_name` - (Optional, String) User name, MigrateType=1 or MigrateType=2. +* `vpc_id` - (Optional, String) The Vpc network ID of the migration source Cvm is used when MigrateType=2 (cloud server self-built SQL Server database). The format is as follows vpc-6ys9ont9. + +The `target` object supports the following: + +* `instance_id` - (Optional, String) The ID of the migration target instance, in the format mssql-si2823jyl. +* `password` - (Optional, String) Password of the migration target instance. +* `user_name` - (Optional, String) User name of the migration target instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver migration can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_migration.migration migration_id +``` + diff --git a/config/docs/r/sqlserver_publish_subscribe.html.markdown b/config/docs/r/sqlserver_publish_subscribe.html.markdown new file mode 100644 index 0000000..4443a3d --- /dev/null +++ b/config/docs/r/sqlserver_publish_subscribe.html.markdown @@ -0,0 +1,143 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_publish_subscribe" +sidebar_current: "docs-tencentcloud-resource-sqlserver_publish_subscribe" +description: |- + Provides a SQL Server PublishSubscribe resource belongs to SQL Server instance. +--- + +# tencentcloud_sqlserver_publish_subscribe + +Provides a SQL Server PublishSubscribe resource belongs to SQL Server instance. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_general_cloud_instance" "example_pub" { + name = "tf-example-pub" + zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_HSSD" + instance_charge_type = "POSTPAID" + project_id = 0 + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + db_version = "2008R2" + security_group_list = [tencentcloud_security_group.security_group.id] + weekly = [1, 2, 3, 5, 6, 7] + start_time = "00:00" + span = 6 + resource_tags { + tag_key = "test" + tag_value = "test" + } + collation = "Chinese_PRC_CI_AS" + time_zone = "China Standard Time" +} + +resource "tencentcloud_sqlserver_general_cloud_instance" "example_sub" { + name = "tf-example-sub" + zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_HSSD" + instance_charge_type = "POSTPAID" + project_id = 0 + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + db_version = "2008R2" + security_group_list = [tencentcloud_security_group.security_group.id] + weekly = [1, 2, 3, 5, 6, 7] + start_time = "00:00" + span = 6 + resource_tags { + tag_key = "test" + tag_value = "test" + } + collation = "Chinese_PRC_CI_AS" + time_zone = "China Standard Time" +} + +resource "tencentcloud_sqlserver_db" "example_pub" { + instance_id = tencentcloud_sqlserver_general_cloud_instance.example_pub.id + name = "tf_example_db_pub" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_db" "example_sub" { + instance_id = tencentcloud_sqlserver_general_cloud_instance.example_sub.id + name = "tf_example_db_sub" + charset = "Chinese_PRC_BIN" + remark = "test-remark" +} + +resource "tencentcloud_sqlserver_publish_subscribe" "example" { + publish_instance_id = tencentcloud_sqlserver_general_cloud_instance.example_pub.id + subscribe_instance_id = tencentcloud_sqlserver_general_cloud_instance.example_sub.id + publish_subscribe_name = "example" + delete_subscribe_db = false + database_tuples { + publish_database = tencentcloud_sqlserver_db.example_pub.name + subscribe_database = tencentcloud_sqlserver_db.example_sub.name + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `database_tuples` - (Required, Set) Database Publish and Publish relationship list. The elements inside can be deleted and added individually, but modification is not allowed. +* `publish_instance_id` - (Required, String, ForceNew) ID of the SQL Server instance which publish. +* `subscribe_instance_id` - (Required, String, ForceNew) ID of the SQL Server instance which subscribe. +* `delete_subscribe_db` - (Optional, Bool) Whether to delete the subscriber database when deleting the Publish and Subscribe. `true` for deletes the subscribe database, `false` for does not delete the subscribe database. default is `false`. +* `publish_subscribe_name` - (Optional, String) The name of the Publish and Subscribe. Default is `default_name`. + +The `database_tuples` object supports the following: + +* `publish_database` - (Required, String) Publish the database. +* `subscribe_database` - (Required, String) Subscribe the database. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +SQL Server PublishSubscribe can be imported using the publish_sqlserver_id#subscribe_sqlserver_id, e.g. + +``` +$ terraform import tencentcloud_sqlserver_publish_subscribe.example publish_sqlserver_id#subscribe_sqlserver_id +``` + diff --git a/config/docs/r/sqlserver_readonly_instance.html.markdown b/config/docs/r/sqlserver_readonly_instance.html.markdown new file mode 100644 index 0000000..111dd5e --- /dev/null +++ b/config/docs/r/sqlserver_readonly_instance.html.markdown @@ -0,0 +1,122 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_readonly_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_readonly_instance" +description: |- + Provides a SQL Server instance resource to create read-only database instances. +--- + +# tencentcloud_sqlserver_readonly_instance + +Provides a SQL Server instance resource to create read-only database instances. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_readonly_instance" "example" { + name = "tf_example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + memory = 4 + storage = 20 + master_instance_id = tencentcloud_sqlserver_basic_instance.example.id + readonly_group_type = 1 + force_upgrade = true + tags = { + "test" = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `master_instance_id` - (Required, String, ForceNew) Indicates the master instance ID of recovery instances. +* `memory` - (Required, Int) Memory size (in GB). Allowed value must be larger than `memory` that data source `tencentcloud_sqlserver_specinfos` provides. +* `name` - (Required, String) Name of the SQL Server instance. +* `readonly_group_type` - (Required, Int, ForceNew) Type of readonly group. Valid values: `1`, `3`. `1` for one auto-assigned readonly instance per one readonly group, `2` for creating new readonly group, `3` for all exist readonly instances stay in the exist readonly group. For now, only `1` and `3` are supported. +* `storage` - (Required, Int) Disk size (in GB). Allowed value must be a multiple of 10. The storage must be set with the limit of `storage_min` and `storage_max` which data source `tencentcloud_sqlserver_specinfos` provides. +* `auto_voucher` - (Optional, Int) Whether to use the voucher automatically; 1 for yes, 0 for no, the default is 0. +* `availability_zone` - (Optional, String, ForceNew) Availability zone. +* `charge_type` - (Optional, String, ForceNew) Pay type of the SQL Server instance. Available values `PREPAID`, `POSTPAID_BY_HOUR`. +* `force_upgrade` - (Optional, Bool, ForceNew) Indicate that the master instance upgrade or not. `true` for upgrading the master SQL Server instance to cluster type by force. Default is false. Note: this is not supported with `DUAL`(ha_type), `2017`(engine_version) master SQL Server instance, for it will cause ha_type of the master SQL Server instance change. +* `period` - (Optional, Int) Purchase instance period in month. The value does not exceed 48. +* `readonly_group_id` - (Optional, String) ID of the readonly group that this instance belongs to. When `readonly_group_type` set value `3`, it must be set with valid value. +* `readonly_group_name` - (Optional, String) Required when `readonly_group_type`=2, the name of the newly created read-only group. +* `readonly_groups_is_offline_delay` - (Optional, Int) Required when `readonly_group_type`=2, whether the newly created read-only group has delay elimination enabled, 1-enabled, 0-disabled. When the delay between the read-only copy and the primary instance exceeds the threshold, it is automatically removed. +* `readonly_groups_max_delay_time` - (Optional, Int) Required when `readonly_group_type`=2 and `readonly_groups_is_offline_delay`=1, the threshold for delayed elimination of newly created read-only groups. +* `readonly_groups_min_in_group` - (Optional, Int) When `readonly_group_type`=2 and `readonly_groups_is_offline_delay`=1, it is required. After the newly created read-only group is delayed and removed, at least the number of read-only copies should be retained. +* `security_groups` - (Optional, Set: [`String`]) Security group bound to the instance. +* `subnet_id` - (Optional, String) ID of subnet. +* `tags` - (Optional, Map) The tags of the SQL Server. +* `voucher_ids` - (Optional, Set: [`String`]) An array of voucher IDs, currently only one can be used for a single order. +* `vpc_id` - (Optional, String) ID of VPC. +* `wait_switch` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.81.2. The way to execute the allocation. Supported values include: 0 - execute immediately, 1 - execute in maintenance window. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the SQL Server instance. +* `ro_flag` - Readonly flag. `RO` (read-only instance), `MASTER` (primary instance with read-only instances). If it is left empty, it refers to an instance which is not read-only and has no RO group. +* `status` - Status of the SQL Server instance. 1 for applying, 2 for running, 3 for running with limit, 4 for isolated, 5 for recycling, 6 for recycled, 7 for running with task, 8 for off-line, 9 for expanding, 10 for migrating, 11 for readonly, 12 for rebooting. +* `vip` - IP for private access. +* `vport` - Port for private access. + + +## Import + +SQL Server readonly instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_sqlserver_readonly_instance.example mssqlro-3cdq7kx5 +``` + diff --git a/config/docs/r/sqlserver_recycle_ro_group.html.markdown b/config/docs/r/sqlserver_recycle_ro_group.html.markdown new file mode 100644 index 0000000..1366029 --- /dev/null +++ b/config/docs/r/sqlserver_recycle_ro_group.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_recycle_ro_group" +sidebar_current: "docs-tencentcloud-resource-sqlserver_recycle_ro_group" +description: |- + Provides a resource to create a sqlserver recycle_ro_group +--- + +# tencentcloud_sqlserver_recycle_ro_group + +Provides a resource to create a sqlserver recycle_ro_group + +## Example Usage + +```hcl +resource "tencentcloud_sqlserver_recycle_ro_group" "recycle_ro_group" { + instance_id = "mssql-qelbzgwf" + read_only_group_id = "mssqlrg-c9ld954d" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of the master instance. +* `read_only_group_id` - (Required, String, ForceNew) ID of the read-only group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/sqlserver_renew_db_instance.html.markdown b/config/docs/r/sqlserver_renew_db_instance.html.markdown new file mode 100644 index 0000000..df49822 --- /dev/null +++ b/config/docs/r/sqlserver_renew_db_instance.html.markdown @@ -0,0 +1,88 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_renew_db_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_renew_db_instance" +description: |- + Provides a resource to create a sqlserver renew_db_instance +--- + +# tencentcloud_sqlserver_renew_db_instance + +Provides a resource to create a sqlserver renew_db_instance + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "PREPAID" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_renew_db_instance" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + period = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `period` - (Optional, Int) How many months to renew, the value range is 1-48, the default is 1. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver renew_db_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_renew_db_instance.example mssql-i9ma6oy7#1 +``` + diff --git a/config/docs/r/sqlserver_renew_postpaid_db_instance.html.markdown b/config/docs/r/sqlserver_renew_postpaid_db_instance.html.markdown new file mode 100644 index 0000000..737dccf --- /dev/null +++ b/config/docs/r/sqlserver_renew_postpaid_db_instance.html.markdown @@ -0,0 +1,90 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_renew_postpaid_db_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_renew_postpaid_db_instance" +description: |- + Provides a resource to create a sqlserver renew_postpaid_db_instance +--- + +# tencentcloud_sqlserver_renew_postpaid_db_instance + +Provides a resource to create a sqlserver renew_postpaid_db_instance + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_config_terminate_db_instance" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id +} + +resource "tencentcloud_sqlserver_renew_postpaid_db_instance" "example" { + instance_id = tencentcloud_sqlserver_config_terminate_db_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver renew_postpaid_db_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_renew_postpaid_db_instance.example mssql-i9ma6oy7 +``` + diff --git a/config/docs/r/sqlserver_restart_db_instance.html.markdown b/config/docs/r/sqlserver_restart_db_instance.html.markdown new file mode 100644 index 0000000..a81f692 --- /dev/null +++ b/config/docs/r/sqlserver_restart_db_instance.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_restart_db_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_restart_db_instance" +description: |- + Provides a resource to create a sqlserver restart_db_instance +--- + +# tencentcloud_sqlserver_restart_db_instance + +Provides a resource to create a sqlserver restart_db_instance + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_restart_db_instance" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +sqlserver restart_db_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_restart_db_instance.example mssql-i9ma6oy7 +``` + diff --git a/config/docs/r/sqlserver_restore_instance.html.markdown b/config/docs/r/sqlserver_restore_instance.html.markdown new file mode 100644 index 0000000..83a373a --- /dev/null +++ b/config/docs/r/sqlserver_restore_instance.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_restore_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_restore_instance" +description: |- + Provides a resource to create a sqlserver restore_instance +--- + +# tencentcloud_sqlserver_restore_instance + +Provides a resource to create a sqlserver restore_instance + +## Example Usage + +```hcl +resource "tencentcloud_sqlserver_restore_instance" "restore_instance" { + instance_id = "mssql-qelbzgwf" + backup_id = 3482091273 + rename_restore { + old_name = "keep_pubsub_db2" + new_name = "restore_keep_pubsub_db2" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_id` - (Required, Int) Backup file ID, which can be obtained through the Id field in the returned value of the DescribeBackups API. +* `instance_id` - (Required, String) Instance ID. +* `rename_restore` - (Required, List) Restore the databases listed in ReNameRestoreDatabase and rename them after restoration. If this parameter is left empty, all databases will be restored and renamed in the default format. + +The `rename_restore` object supports the following: + +* `new_name` - (Required, String) New database name. In offline migration, OldName will be used if NewName is left empty (OldName and NewName cannot be both empty). In database cloning, OldName and NewName must be both specified and cannot have the same value. +* `old_name` - (Required, String) Database name. If the OldName database does not exist, a failure will be returned.It can be left empty in offline migration tasks. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `encryption` - TDE encryption, `enable` encrypted, `disable` unencrypted. + * `db_name` - Database name. + * `status` - encryption, `enable` encrypted, `disable` unencrypted. + + +## Import + +sqlserver restore_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_restore_instance.restore_instance mssql-qelbzgwf#3482091273#keep_pubsub_db2#restore_keep_pubsub_db2 +``` + diff --git a/config/docs/r/sqlserver_rollback_instance.html.markdown b/config/docs/r/sqlserver_rollback_instance.html.markdown new file mode 100644 index 0000000..2167b6e --- /dev/null +++ b/config/docs/r/sqlserver_rollback_instance.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_rollback_instance" +sidebar_current: "docs-tencentcloud-resource-sqlserver_rollback_instance" +description: |- + Provides a resource to create a sqlserver rollback_instance +--- + +# tencentcloud_sqlserver_rollback_instance + +Provides a resource to create a sqlserver rollback_instance + +## Example Usage + +```hcl +resource "tencentcloud_sqlserver_rollback_instance" "rollback_instance" { + instance_id = "mssql-qelbzgwf" + time = "2023-05-23 01:00:00" + rename_restore { + old_name = "keep_pubsub_db2" + new_name = "rollback_pubsub_db3" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Instance ID. +* `rename_restore` - (Required, List) Rename the databases listed in ReNameRestoreDatabase. +* `time` - (Required, String) Target time point for rollback. + +The `rename_restore` object supports the following: + +* `new_name` - (Required, String) New database name. +* `old_name` - (Required, String) Database name. If the OldName database does not exist, a failure will be returned. It can be left empty in offline migration tasks. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `encryption` - TDE encryption, `enable` encrypted, `disable` unencrypted. + * `db_name` - Database name. + * `status` - encryption, `enable` encrypted, `disable` unencrypted. + + +## Import + +sqlserver rollback_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_sqlserver_rollback_instance.rollback_instance mssql-qelbzgwf#2023-05-23 01:00:00#keep_pubsub_db2#rollback_pubsub_db3 +``` + diff --git a/config/docs/r/sqlserver_start_backup_full_migration.html.markdown b/config/docs/r/sqlserver_start_backup_full_migration.html.markdown new file mode 100644 index 0000000..9c9f81d --- /dev/null +++ b/config/docs/r/sqlserver_start_backup_full_migration.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_start_backup_full_migration" +sidebar_current: "docs-tencentcloud-resource-sqlserver_start_backup_full_migration" +description: |- + Provides a resource to create a sqlserver start_backup_full_migration +--- + +# tencentcloud_sqlserver_start_backup_full_migration + +Provides a resource to create a sqlserver start_backup_full_migration + +## Example Usage + +```hcl +resource "tencentcloud_sqlserver_start_backup_full_migration" "start_backup_full_migration" { + instance_id = "mssql-i1z41iwd" + backup_migration_id = "mssql-backup-migration-kpl74n9l" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_migration_id` - (Required, String, ForceNew) Backup import task ID, returned by the CreateBackupMigration interface. +* `instance_id` - (Required, String, ForceNew) ID of imported target instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/sqlserver_start_backup_incremental_migration.html.markdown b/config/docs/r/sqlserver_start_backup_incremental_migration.html.markdown new file mode 100644 index 0000000..fa9db6f --- /dev/null +++ b/config/docs/r/sqlserver_start_backup_incremental_migration.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_start_backup_incremental_migration" +sidebar_current: "docs-tencentcloud-resource-sqlserver_start_backup_incremental_migration" +description: |- + Provides a resource to create a sqlserver start_backup_incremental_migration +--- + +# tencentcloud_sqlserver_start_backup_incremental_migration + +Provides a resource to create a sqlserver start_backup_incremental_migration + +## Example Usage + +```hcl +resource "tencentcloud_sqlserver_start_backup_incremental_migration" "start_backup_incremental_migration" { + instance_id = "mssql-i1z41iwd" + backup_migration_id = "mssql-backup-migration-cg0ffgqt" + incremental_migration_id = "mssql-incremental-migration-kp7bgv8p" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_migration_id` - (Required, String, ForceNew) Backup import task ID, returned by the CreateBackupMigration interface. +* `incremental_migration_id` - (Required, String, ForceNew) Incremental backup import task ID. +* `instance_id` - (Required, String, ForceNew) ID of imported target instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/sqlserver_start_xevent.html.markdown b/config/docs/r/sqlserver_start_xevent.html.markdown new file mode 100644 index 0000000..02f3c79 --- /dev/null +++ b/config/docs/r/sqlserver_start_xevent.html.markdown @@ -0,0 +1,88 @@ +--- +subcategory: "SQLServer" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_sqlserver_start_xevent" +sidebar_current: "docs-tencentcloud-resource-sqlserver_start_xevent" +description: |- + Provides a resource to create a sqlserver start_xevent +--- + +# tencentcloud_sqlserver_start_xevent + +Provides a resource to create a sqlserver start_xevent + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "sqlserver" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_sqlserver_basic_instance" "example" { + name = "tf-example" + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.4.name + charge_type = "POSTPAID_BY_HOUR" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + project_id = 0 + memory = 4 + storage = 100 + cpu = 2 + machine_type = "CLOUD_PREMIUM" + maintenance_week_set = [1, 2, 3] + maintenance_start_time = "09:00" + maintenance_time_span = 3 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + "test" = "test" + } +} + +resource "tencentcloud_sqlserver_start_xevent" "example" { + instance_id = tencentcloud_sqlserver_basic_instance.example.id + event_config { + event_type = "slow" + threshold = 0 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `event_config` - (Required, List, ForceNew) Whether to start or stop an extended event. +* `instance_id` - (Required, String, ForceNew) Instance ID. + +The `event_config` object supports the following: + +* `event_type` - (Required, String) Event type. Valid values: slow (set threshold for slow SQL ), blocked (set threshold for the blocking and deadlock). +* `threshold` - (Required, Int) Threshold in milliseconds. Valid values: 0(disable), non-zero (enable). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ssl_certificate.html.markdown b/config/docs/r/ssl_certificate.html.markdown new file mode 100644 index 0000000..450dfb2 --- /dev/null +++ b/config/docs/r/ssl_certificate.html.markdown @@ -0,0 +1,89 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_certificate" +sidebar_current: "docs-tencentcloud-resource-ssl_certificate" +description: |- + Provides a resource to create a SSL certificate. +--- + +# tencentcloud_ssl_certificate + +Provides a resource to create a SSL certificate. + +Upload the existing SSL certificate to Tencent Cloud. + +## Example Usage + +```hcl +variable "ca" { + default = "-----BEGIN CERTIFICATE-----\nMIIEDjCCAnagAwIBAgIBATANBgkqhkiG9w0BAQsFADAoMQ0wCwYDVQQDEwR0ZXN0\nMRcwFQYDVQQKEw50ZXJyYWZvcm0gdGVzdDAeFw0xOTA4MTMwMzA4MjBaFw0yOTA4\nMTAwMzA4MjBaMCgxDTALBgNVBAMTBHRlc3QxFzAVBgNVBAoTDnRlcnJhZm9ybSB0\nZXN0MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA0k2vqg/GHtFP5P7r\ndbzswfx1jSHeK9r4StV4mGOAoKyzvAJA5BvYbAHpSrL2ZAd6ShjHgRVU1qEroeFn\n8fwTrAVQttMltBFABx7G4iN4Zf6EUXzhhFN6vVVbWaqhYhrdMoPvZxgGSA/4hG4W\nGIr8MXZzXbKLoRoz4Bvq1Ymg5eO14KLJFSTahvIkG60egGN5pmi4czxWy2U7ycA5\nQ5TuQBnF0rKQJW5XKIV3kr5YrzDdJK7up9E6Od4T5jz+qY97KAjIpWD/pTAsc7+6\nfPBpY7NHT9Bw0fDmvsWO/PtswY4hW02n86b5eWA9sfKJGphhsBxgpuuhmxYHS6pA\nB+C7IkyxcADNT5u9tEo2JGOj+/veXKrEhZin7inKsQLD0WOobcg1Rh/3NSWD7geF\nTJBRnzgplaN7cK6c/utEAAnngS38q4DGBR/jHmkWjAeQPZj1eLLBk686HEEbKeU+\n9yAVcPRhA9tuL7wMeSX32VunWZunoA/f8iuGZYJlZsNBqyJbAgMBAAGjQzBBMA8G\nA1UdEwEB/wQFMAMBAf8wDwYDVR0PAQH/BAUDAweGADAdBgNVHQ4EFgQUKwfrmq79\n1mY831S6UHARHtgYnlgwDQYJKoZIhvcNAQELBQADggGBAInM+aeaHoZdw9B9nAH2\nHscEoOulF+RxnysSXTTRLd2VQph4+ynlfRZT4evLBBj/ppmqjp8F7/OcRiiZwSXl\nnamyP/UUINtHfgDM0kll/5Za0aYzMhrORNw+3ythIv2yPJX8t4LmsG1L4PMO8ZU8\nN0K9XyKRaL/tq6rw1gQM152OmNgTzfAQoKYxrvbftOZz4J0ZACctuBmwtp5upKvJ\n36aQ4wJLUzOt69mnW+AaL5EPA37mwtzdnzTTxd3SBfOYXjsflc3l2raljJznnqU2\nySynjb6L3D3L/pObL1Uu7nQBy8CazJBsBsVFK/pr61vcllm8lG7vOhHOUSFUeezq\nFWukAolm9/cagmD6IhNishM3Uzng+UYyCC8uQq3Z7FGqJpXSI79wZYjudnCLPVCg\nOIfJHQeJFLryn6GxiSYmYs6dgUJiiTV+I/2Y5X7ZFdb5FC1J/WmvoCv6yO7NiirY\nBSgfV0lp5CuV8SfiSClpYfrM28NbNgxveUqET642BJOPLQ==\n-----END CERTIFICATE-----" +} + +data "tencentcloud_ssl_certificates" "ca" { + name = tencentcloud_ssl_certificate.ca.name +} + +resource "tencentcloud_ssl_certificate" "ca" { + name = "ssl-ca" + type = "CA" + cert = var.ca +} +``` + + + +```hcl +variable "cert" { + default = "-----BEGIN CERTIFICATE-----\nMIIERzCCAq+gAwIBAgIBAjANBgkqhkiG9w0BAQsFADAoMQ0wCwYDVQQDEwR0ZXN0\nMRcwFQYDVQQKEw50ZXJyYWZvcm0gdGVzdDAeFw0xOTA4MTMwMzE5MzlaFw0yOTA4\nMTAwMzE5MzlaMC4xEzARBgNVBAMTCnNlcnZlciBzc2wxFzAVBgNVBAoTDnRlcnJh\nZm9ybS10ZXN0MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA1Ryp+DKK\nSNFKZsPtwfR+jzOnQ8YFieIKYgakV688d8YgpolenbmeEPrzT87tunFD7G9f6ALG\nND8rj7npj0AowxhOL/h/v1D9u0UsIaj5i2GWJrqNAhGLaxWiEB/hy5WOiwxDrGei\ngQqJkFM52Ep7G1Yx7PHJmKFGwN9FhIsFi1cNZfVRopZuCe/RMPNusNVZaIi+qcEf\nfsE1cmfmuSlG3Ap0RKOIyR0ajDEzqZn9/0R7VwWCF97qy8TNYk94K/1tq3zyhVzR\nZ83xOSfrTqEfb3so3AU2jyKgYdwr/FZS72VCHS8IslgnqJW4izIXZqgIKmHaRZtM\nN4jUloi6l/6lktt6Lsgh9xECecxziSJtPMaog88aC8HnMqJJ3kScGCL36GYG+Kaw\n5PnDlWXBaeiDe8z/eWK9+Rr2M+rhTNxosAVGfDJyxAXyiX49LQ0v7f9qzwc/0JiD\nbvsUv1cm6OgpoEMP9SXqqBdwGqeKbD2/2jlP48xlYP6l1SoJG3GgZ8dbAgMBAAGj\ndjB0MAwGA1UdEwEB/wQCMAAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDwYDVR0PAQH/\nBAUDAweAADAdBgNVHQ4EFgQULwWKBQNLL9s3cb3tTnyPVg+mpCMwHwYDVR0jBBgw\nFoAUKwfrmq791mY831S6UHARHtgYnlgwDQYJKoZIhvcNAQELBQADggGBAMo5RglS\nAHdPgaicWJvmvjjexjF/42b7Rz4pPfMjYw6uYO8He/f4UZWv5CZLrbEe7MywaK3y\n0OsfH8AhyN29pv2x8g9wbmq7omZIOZ0oCAGduEXs/A/qY/hFaCohdkz/IN8qi6JW\nVXreGli3SrpcHFchSwHTyJEXgkutcGAsOvdsOuVSmplOyrkLHc8uUe8SG4j8kGyg\nEzaszFjHkR7g1dVyDVUedc588mjkQxYeAamJgfkgIhljWKMa2XzkVMcVfQHfNpM1\nn+bu8SmqRt9Wma2bMijKRG/Blm756LoI+skY+WRZmlDnq8zj95TT0vceGP0FUWh5\nhKyiocABmpQs9OK9HMi8vgSWISP+fYgkm/bKtKup2NbZBoO5/VL2vCEPInYzUhBO\njCbLMjNjtM5KriCaR7wDARgHiG0gBEPOEW1PIjZ9UOH+LtIxbNZ4eEIIINLHnBHf\nL+doVeZtS/gJc4G4Adr5HYuaS9ZxJ0W2uy0eQlOHzjyxR6Mf/rpnilJlcQ==\n-----END CERTIFICATE-----" +} + +variable "key" { + default = "Public Key Info:\n Public Key Algorithm: RSA\n Key Security Level: High (3072 bits)\n\nmodulus:\n 00:d5:1c:a9:f8:32:8a:48:d1:4a:66:c3:ed:c1:f4:7e\n 8f:33:a7:43:c6:05:89:e2:0a:62:06:a4:57:af:3c:77\n c6:20:a6:89:5e:9d:b9:9e:10:fa:f3:4f:ce:ed:ba:71\n 43:ec:6f:5f:e8:02:c6:34:3f:2b:8f:b9:e9:8f:40:28\n c3:18:4e:2f:f8:7f:bf:50:fd:bb:45:2c:21:a8:f9:8b\n 61:96:26:ba:8d:02:11:8b:6b:15:a2:10:1f:e1:cb:95\n 8e:8b:0c:43:ac:67:a2:81:0a:89:90:53:39:d8:4a:7b\n 1b:56:31:ec:f1:c9:98:a1:46:c0:df:45:84:8b:05:8b\n 57:0d:65:f5:51:a2:96:6e:09:ef:d1:30:f3:6e:b0:d5\n 59:68:88:be:a9:c1:1f:7e:c1:35:72:67:e6:b9:29:46\n dc:0a:74:44:a3:88:c9:1d:1a:8c:31:33:a9:99:fd:ff\n 44:7b:57:05:82:17:de:ea:cb:c4:cd:62:4f:78:2b:fd\n 6d:ab:7c:f2:85:5c:d1:67:cd:f1:39:27:eb:4e:a1:1f\n 6f:7b:28:dc:05:36:8f:22:a0:61:dc:2b:fc:56:52:ef\n 65:42:1d:2f:08:b2:58:27:a8:95:b8:8b:32:17:66:a8\n 08:2a:61:da:45:9b:4c:37:88:d4:96:88:ba:97:fe:a5\n 92:db:7a:2e:c8:21:f7:11:02:79:cc:73:89:22:6d:3c\n c6:a8:83:cf:1a:0b:c1:e7:32:a2:49:de:44:9c:18:22\n f7:e8:66:06:f8:a6:b0:e4:f9:c3:95:65:c1:69:e8:83\n 7b:cc:ff:79:62:bd:f9:1a:f6:33:ea:e1:4c:dc:68:b0\n 05:46:7c:32:72:c4:05:f2:89:7e:3d:2d:0d:2f:ed:ff\n 6a:cf:07:3f:d0:98:83:6e:fb:14:bf:57:26:e8:e8:29\n a0:43:0f:f5:25:ea:a8:17:70:1a:a7:8a:6c:3d:bf:da\n 39:4f:e3:cc:65:60:fe:a5:d5:2a:09:1b:71:a0:67:c7\n 5b:\n\npublic exponent:\n 01:00:01:\n\nprivate exponent:\n 00:b1:56:d0:fa:00:d4:a2:13:c7:5e:0c:dc:e4:f1:97\n ff:82:74:46:29:9a:a2:4a:bf:69:23:2d:ce:e9:bb:df\n cf:b7:8b:dd:f4:26:3c:38:14:d9:3f:6f:c2:3a:81:53\n 8f:ba:48:53:fe:b5:90:4a:19:e7:1e:0b:0f:18:6d:c3\n 7d:d5:d3:fa:87:47:86:e4:d6:bf:e7:a7:f9:ba:ab:2e\n 19:5e:e1:8b:8b:9b:95:0d:f7:66:61:1e:19:e9:c3:88\n 08:be:1c:ce:93:c1:09:b1:68:1b:61:46:60:74:64:46\n 5d:51:34:ea:7f:a9:ca:a1:2a:47:85:84:4b:ef:84:05\n 97:c3:46:7d:06:19:ce:24:73:90:64:fb:df:16:d5:80\n 34:8e:90:7c:58:b6:a4:86:ce:30:b3:ab:52:8b:f2:95\n 4c:b6:46:5a:77:db:73:c0:0c:3f:6d:12:18:a8:54:7c\n ff:77:c3:ca:89:9f:63:98:ef:48:2d:c1:09:70:6e:ea\n cb:bb:78:91:42:8a:22:3e:21:ef:a5:bf:16:ee:66:45\n e5:f0:26:6a:85:8e:e1:69:62:ac:05:00:a6:44:ba:c8\n ac:10:00:97:f5:51:65:7f:9a:1f:7b:99:9d:02:d4:87\n 50:ce:74:06:51:67:fa:fb:90:e4:33:79:f2:a8:61:ee\n 45:1d:87:ca:22:5b:ac:e7:32:38:f8:2c:fd:55:92:1e\n 3d:60:1e:7c:4b:fd:28:ff:e5:b1:02:6a:aa:22:f7:ae\n a8:36:90:7b:a6:f7:29:05:14:3a:21:da:36:05:f9:b0\n 9d:f7:fb:10:75:d7:2c:21:32:95:e7:f7:17:be:09:cb\n 66:fe:f1:69:71:df:a4:5e:3f:fc:67:6c:37:65:b8:51\n c6:22:38:fb:07:ce:89:54:50:43:71:44:3d:c3:51:5a\n bd:e5:c7:87:b2:ea:7b:64:0f:5d:34:9c:a1:52:b3:ce\n 06:86:ba:7a:05:80:48:b3:6c:1b:79:74:9b:49:f2:30\n c1:\n\nprime1:\n 00:e4:31:46:59:3d:24:f7:31:d9:22:26:af:c0:3e:f5\n c1:6d:be:ba:d3:9e:3f:b9:2c:43:a0:d0:47:09:e4:35\n 63:19:a4:33:82:af:f9:76:3c:11:c2:cb:34:f9:a6:ab\n dd:ab:64:5a:6b:9c:c1:2a:52:89:64:7e:b5:a7:f0:4d\n 29:13:a4:cf:17:f4:f2:0d:a0:6e:b9:5d:95:41:10:df\n ae:f3:7a:13:49:21:66:73:2a:b7:e2:8d:7c:c2:34:e5\n 3f:bd:78:ca:fc:64:c5:1c:3a:66:7a:12:53:96:bd:b0\n c3:7a:0c:ec:5e:55:c0:c3:3f:7f:25:72:f4:e2:19:94\n 9d:65:15:be:c8:82:20:57:12:97:b2:a8:4d:3d:e0:8f\n e2:1f:d0:c8:49:aa:f4:34:fa:91:d1:d1:cc:98:bc:3d\n 8b:b1:9b:8f:fd:ef:03:dd:92:fb:ca:99:45:af:cc:83\n 58:4c:bb:ba:73:9e:23:84:f9:7e:4f:40:fe:00:b5:bf\n 6f:\n\nprime2:\n 00:ef:14:ef:73:fc:0c:fc:e3:87:d9:7f:a6:f8:55:86\n 57:63:8a:86:87:f5:ef:63:20:1f:b2:ae:28:dc:ab:59\n 80:8f:15:64:44:e2:bc:a5:7b:d7:69:ef:30:b1:83:b3\n bd:09:fd:4a:0c:c6:31:5b:a4:79:d0:e5:d3:a8:31:fd\n 59:ea:52:63:cf:17:a7:c1:54:bf:a8:11:9b:b1:85:47\n 5a:08:a6:9c:2f:47:9d:ac:5d:e8:7c:e4:31:6c:99:71\n 04:7d:20:98:be:8b:60:07:66:2d:b9:41:10:ea:dd:5b\n 87:20:65:62:ea:75:a7:a6:04:a2:18:66:6b:db:5b:a4\n 9f:12:97:cb:7c:8c:d2:e0:ce:02:ef:1e:df:a1:9d:6a\n bc:00:38:18:36:a1:c5:97:16:be:7a:df:5f:4f:4f:de\n a3:cb:25:fe:f6:67:0d:31:aa:0a:d4:1b:be:df:91:2c\n 05:14:20:37:cc:4f:50:33:a6:50:1b:90:f9:b2:08:80\n d5:\n\ncoefficient:\n 47:d1:7f:ca:93:6a:14:9b:fe:85:8d:c2:15:11:52:a2\n a5:bc:f5:6b:a2:69:76:49:1e:09:79:f1:15:bf:39:48\n 41:ff:92:78:af:bc:7d:6f:76:3b:32:9e:08:d2:42:06\n 04:5f:36:e0:be:a8:1d:21:5c:ec:39:09:e0:77:c5:86\n 06:e6:ce:98:16:fc:0f:30:de:a7:69:7a:8f:dd:01:42\n 2a:22:f5:b7:c2:fc:c8:90:5a:78:dc:b3:e0:4d:e7:2d\n 98:6c:e3:34:1b:d7:e8:f8:90:57:7e:4d:41:d6:4a:29\n 81:92:eb:89:5b:45:85:dd:b9:16:20:63:cb:59:f6:06\n 59:c1:dd:3b:6b:92:0a:5e:5e:63:4a:f1:a7:d5:16:b9\n 8b:6c:d8:ad:76:0e:2d:3c:e0:b3:73:e0:6d:af:d4:a2\n bc:4b:fd:6c:2d:d7:5d:4d:cd:28:03:64:b2:ef:9a:1d\n 82:8d:53:40:c5:f8:fb:f3:63:de:8e:1a:21:b6:35:14\n \n\nexp1:\n 00:9c:a5:8a:d2:65:dc:03:69:8f:d2:16:d6:9d:55:5b\n 25:4e:ae:18:d8:7e:90:e6:10:11:d8:ca:41:89:f3:c4\n 06:64:aa:c8:c5:95:01:dd:fd:7c:7f:c9:39:73:8b:cb\n fd:9e:d3:84:12:cd:87:f9:02:b1:d8:6f:f7:49:f2:f7\n 35:14:8c:15:b2:2f:6f:1e:95:9c:8c:d9:46:45:65:4c\n f8:6f:a1:c4:ad:76:25:3b:37:ff:05:a1:f5:1b:e8:6d\n db:64:b9:10:37:55:01:ce:cf:f4:5b:26:4b:85:76:70\n 6a:b0:55:40:c9:bd:7a:57:4e:36:7d:41:be:03:9c:65\n dd:ea:6f:94:09:56:f2:d6:73:27:f9:f7:f9:16:5a:1a\n cb:b2:e5:83:28:b7:17:6f:6a:f7:41:1f:11:a1:63:cf\n a8:1e:e3:58:64:8c:78:8d:d9:81:c9:e1:8f:ea:0f:ad\n b6:a6:ee:54:1f:5c:56:ab:c9:0d:c1:60:2f:3d:d3:86\n 37:\n\nexp2:\n 64:12:b7:48:2d:30:a2:89:fa:cb:27:8b:94:56:f8:2c\n 8c:15:e7:c9:f1:3f:8a:96:5f:ae:43:08:07:96:11:98\n a6:4b:a5:f4:cf:93:77:11:27:51:c8:34:f1:98:d7:1b\n 41:9b:2b:eb:bc:e9:dc:1a:34:83:24:30:3c:2e:f0:85\n 3a:77:d2:1f:55:1f:7a:e5:26:74:0b:2a:c8:5b:a9:4a\n 1e:64:de:eb:4b:66:cc:47:62:91:24:53:2b:c9:ee:6c\n 9a:93:92:5b:ef:aa:fa:6d:e2:a5:b0:7e:8c:50:ab:87\n 1c:20:54:0f:1f:c0:54:d5:8b:a3:fa:fb:1a:8e:79:91\n bc:0e:9d:b6:3c:9b:e8:4d:53:1d:14:27:37:56:d4:de\n 6c:99:0e:49:8f:dd:4d:28:d0:02:4e:8d:6e:7d:58:0b\n e7:74:b8:0c:1b:86:82:4b:52:cd:05:f0:17:54:84:c0\n 7b:74:20:e6:fc:2b:ed:f2:a7:85:62:61:a2:0b:bd:21\n \n\n\nPublic Key PIN:\n pin-sha256:t5OXXC5gYqMNtUMsTqRs3A3vhfK2BiXVOgYzIEYv7Y8=\nPublic Key ID:\n sha256:b793975c2e6062a30db5432c4ea46cdc0def85f2b60625d53a063320462fed8f\n sha1:2f058a05034b2fdb3771bded4e7c8f560fa6a423\n\n-----BEGIN RSA PRIVATE KEY-----\nMIIG5AIBAAKCAYEA1Ryp+DKKSNFKZsPtwfR+jzOnQ8YFieIKYgakV688d8Ygpole\nnbmeEPrzT87tunFD7G9f6ALGND8rj7npj0AowxhOL/h/v1D9u0UsIaj5i2GWJrqN\nAhGLaxWiEB/hy5WOiwxDrGeigQqJkFM52Ep7G1Yx7PHJmKFGwN9FhIsFi1cNZfVR\nopZuCe/RMPNusNVZaIi+qcEffsE1cmfmuSlG3Ap0RKOIyR0ajDEzqZn9/0R7VwWC\nF97qy8TNYk94K/1tq3zyhVzRZ83xOSfrTqEfb3so3AU2jyKgYdwr/FZS72VCHS8I\nslgnqJW4izIXZqgIKmHaRZtMN4jUloi6l/6lktt6Lsgh9xECecxziSJtPMaog88a\nC8HnMqJJ3kScGCL36GYG+Kaw5PnDlWXBaeiDe8z/eWK9+Rr2M+rhTNxosAVGfDJy\nxAXyiX49LQ0v7f9qzwc/0JiDbvsUv1cm6OgpoEMP9SXqqBdwGqeKbD2/2jlP48xl\nYP6l1SoJG3GgZ8dbAgMBAAECggGBALFW0PoA1KITx14M3OTxl/+CdEYpmqJKv2kj\nLc7pu9/Pt4vd9CY8OBTZP2/COoFTj7pIU/61kEoZ5x4LDxhtw33V0/qHR4bk1r/n\np/m6qy4ZXuGLi5uVDfdmYR4Z6cOICL4czpPBCbFoG2FGYHRkRl1RNOp/qcqhKkeF\nhEvvhAWXw0Z9BhnOJHOQZPvfFtWANI6QfFi2pIbOMLOrUovylUy2Rlp323PADD9t\nEhioVHz/d8PKiZ9jmO9ILcEJcG7qy7t4kUKKIj4h76W/Fu5mReXwJmqFjuFpYqwF\nAKZEusisEACX9VFlf5ofe5mdAtSHUM50BlFn+vuQ5DN58qhh7kUdh8oiW6znMjj4\nLP1Vkh49YB58S/0o/+WxAmqqIveuqDaQe6b3KQUUOiHaNgX5sJ33+xB11ywhMpXn\n9xe+Cctm/vFpcd+kXj/8Z2w3ZbhRxiI4+wfOiVRQQ3FEPcNRWr3lx4ey6ntkD100\nnKFSs84Ghrp6BYBIs2wbeXSbSfIwwQKBwQDkMUZZPST3MdkiJq/APvXBbb66054/\nuSxDoNBHCeQ1YxmkM4Kv+XY8EcLLNPmmq92rZFprnMEqUolkfrWn8E0pE6TPF/Ty\nDaBuuV2VQRDfrvN6E0khZnMqt+KNfMI05T+9eMr8ZMUcOmZ6ElOWvbDDegzsXlXA\nwz9/JXL04hmUnWUVvsiCIFcSl7KoTT3gj+If0MhJqvQ0+pHR0cyYvD2LsZuP/e8D\n3ZL7yplFr8yDWEy7unOeI4T5fk9A/gC1v28CgcEA7xTvc/wM/OOH2X+m+FWGV2OK\nhof172MgH7KuKNyrWYCPFWRE4ryle9dp7zCxg7O9Cf1KDMYxW6R50OXTqDH9WepS\nY88Xp8FUv6gRm7GFR1oIppwvR52sXeh85DFsmXEEfSCYvotgB2YtuUEQ6t1bhyBl\nYup1p6YEohhma9tbpJ8Sl8t8jNLgzgLvHt+hnWq8ADgYNqHFlxa+et9fT0/eo8sl\n/vZnDTGqCtQbvt+RLAUUIDfMT1AzplAbkPmyCIDVAoHBAJylitJl3ANpj9IW1p1V\nWyVOrhjYfpDmEBHYykGJ88QGZKrIxZUB3f18f8k5c4vL/Z7ThBLNh/kCsdhv90ny\n9zUUjBWyL28elZyM2UZFZUz4b6HErXYlOzf/BaH1G+ht22S5EDdVAc7P9FsmS4V2\ncGqwVUDJvXpXTjZ9Qb4DnGXd6m+UCVby1nMn+ff5Floay7Llgyi3F29q90EfEaFj\nz6ge41hkjHiN2YHJ4Y/qD622pu5UH1xWq8kNwWAvPdOGNwKBwGQSt0gtMKKJ+ssn\ni5RW+CyMFefJ8T+Kll+uQwgHlhGYpkul9M+TdxEnUcg08ZjXG0GbK+u86dwaNIMk\nMDwu8IU6d9IfVR965SZ0CyrIW6lKHmTe60tmzEdikSRTK8nubJqTklvvqvpt4qWw\nfoxQq4ccIFQPH8BU1Yuj+vsajnmRvA6dtjyb6E1THRQnN1bU3myZDkmP3U0o0AJO\njW59WAvndLgMG4aCS1LNBfAXVITAe3Qg5vwr7fKnhWJhogu9IQKBwEfRf8qTahSb\n/oWNwhURUqKlvPVroml2SR4JefEVvzlIQf+SeK+8fW92OzKeCNJCBgRfNuC+qB0h\nXOw5CeB3xYYG5s6YFvwPMN6naXqP3QFCKiL1t8L8yJBaeNyz4E3nLZhs4zQb1+j4\nkFd+TUHWSimBkuuJW0WF3bkWIGPLWfYGWcHdO2uSCl5eY0rxp9UWuYts2K12Di08\n4LNz4G2v1KK8S/1sLdddTc0oA2Sy75odgo1TQMX4+/Nj3o4aIbY1FA==\n-----END RSA PRIVATE KEY-----" +} + +data "tencentcloud_ssl_certificates" "svr" { + name = tencentcloud_ssl_certificate.svr.name +} + +resource "tencentcloud_ssl_certificate" "svr" { + name = "ssl-svr" + type = "SVR" + cert = var.cert + key = var.key +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cert` - (Required, String, ForceNew) Content of the SSL certificate. Not allowed newline at the start and end. +* `type` - (Required, String, ForceNew) Type of the SSL certificate. Valid values: `CA` and `SVR`. +* `key` - (Optional, String, ForceNew) Key of the SSL certificate and required when certificate type is `SVR`. Not allowed newline at the start and end. +* `name` - (Optional, String) Name of the SSL certificate. +* `project_id` - (Optional, Int) Project ID of the SSL certificate. Default is `0`. +* `tags` - (Optional, Map) Tags of the SSL certificate. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `begin_time` - Beginning time of the SSL certificate. +* `create_time` - Creation time of the SSL certificate. +* `domain` - Primary domain of the SSL certificate. +* `end_time` - Ending time of the SSL certificate. +* `product_zh_name` - Certificate authority. +* `status` - Status of the SSL certificate. +* `subject_names` - ALL domains included in the SSL certificate. Including the primary domain name. + + +## Import + +ssl certificate can be imported using the id, e.g. + +``` + $ terraform import tencentcloud_ssl_certificate.cert GjTNRoK7 +``` + diff --git a/config/docs/r/ssl_check_certificate_chain_operation.html.markdown b/config/docs/r/ssl_check_certificate_chain_operation.html.markdown new file mode 100644 index 0000000..e755cee --- /dev/null +++ b/config/docs/r/ssl_check_certificate_chain_operation.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_check_certificate_chain_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_check_certificate_chain_operation" +description: |- + Provides a resource to create a ssl check_certificate_chain +--- + +# tencentcloud_ssl_check_certificate_chain_operation + +Provides a resource to create a ssl check_certificate_chain + +## Example Usage + +```hcl +resource "tencentcloud_ssl_check_certificate_chain_operation" "check_certificate_chain" { + certificate_chain = "-----BEGIN CERTIFICATE--·····---END CERTIFICATE-----" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_chain` - (Required, String, ForceNew) The certificate chain to check. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl check_certificate_chain can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_check_certificate_chain_operation.check_certificate_chain check_certificate_chain_id +``` + diff --git a/config/docs/r/ssl_complete_certificate_operation.html.markdown b/config/docs/r/ssl_complete_certificate_operation.html.markdown new file mode 100644 index 0000000..4fc7c44 --- /dev/null +++ b/config/docs/r/ssl_complete_certificate_operation.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_complete_certificate_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_complete_certificate_operation" +description: |- + Provides a resource to create a ssl complete_certificate +--- + +# tencentcloud_ssl_complete_certificate_operation + +Provides a resource to create a ssl complete_certificate + +## Example Usage + +```hcl +resource "tencentcloud_ssl_complete_certificate_operation" "complete_certificate" { + certificate_id = "9Bfe1IBR" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String, ForceNew) Certificate ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl complete_certificate can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_complete_certificate_operation.complete_certificate complete_certificate_id +``` + diff --git a/config/docs/r/ssl_deploy_certificate_instance_operation.html.markdown b/config/docs/r/ssl_deploy_certificate_instance_operation.html.markdown new file mode 100644 index 0000000..06a6d16 --- /dev/null +++ b/config/docs/r/ssl_deploy_certificate_instance_operation.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_deploy_certificate_instance_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_deploy_certificate_instance_operation" +description: |- + Provides a resource to create a ssl deploy_certificate_instance +--- + +# tencentcloud_ssl_deploy_certificate_instance_operation + +Provides a resource to create a ssl deploy_certificate_instance + +## Example Usage + +```hcl +resource "tencentcloud_ssl_deploy_certificate_instance_operation" "deploy_certificate_instance" { + certificate_id = "8x1eUSSl" + instance_id_list = ["cdndomain1.example.com|on", "cdndomain1.example.com|off"] + resource_type = "cdn" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String, ForceNew) ID of the certificate to be deployed. +* `instance_id_list` - (Required, Set: [`String`], ForceNew) Need to deploy instance list. +* `resource_type` - (Optional, String, ForceNew) Deployed cloud resource type. +* `status` - (Optional, Int, ForceNew) Deployment cloud resource status: Live: -1: The domain name is not associated with a certificate.1: Domain name https is enabled.0: Domain name https is closed. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl deploy_certificate_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_deploy_certificate_instance_operation.deploy_certificate_instance deploy_certificate_instance_id +``` + diff --git a/config/docs/r/ssl_deploy_certificate_record_retry_operation.html.markdown b/config/docs/r/ssl_deploy_certificate_record_retry_operation.html.markdown new file mode 100644 index 0000000..a2fc2c8 --- /dev/null +++ b/config/docs/r/ssl_deploy_certificate_record_retry_operation.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_deploy_certificate_record_retry_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_deploy_certificate_record_retry_operation" +description: |- + Provides a resource to create a ssl deploy_certificate_record_retry +--- + +# tencentcloud_ssl_deploy_certificate_record_retry_operation + +Provides a resource to create a ssl deploy_certificate_record_retry + +## Example Usage + +```hcl +resource "tencentcloud_ssl_deploy_certificate_record_retry_operation" "deploy_certificate_record_retry" { + deploy_record_id = 35474 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `deploy_record_detail_id` - (Optional, Int, ForceNew) Deployment record details ID to be retried. +* `deploy_record_id` - (Optional, Int, ForceNew) Deployment record ID to be retried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl deploy_certificate_record_retry can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_deploy_certificate_record_retry_operation.deploy_certificate_record_retry deploy_certificate_record_retry_id +``` + diff --git a/config/docs/r/ssl_deploy_certificate_record_rollback_operation.html.markdown b/config/docs/r/ssl_deploy_certificate_record_rollback_operation.html.markdown new file mode 100644 index 0000000..8f549e2 --- /dev/null +++ b/config/docs/r/ssl_deploy_certificate_record_rollback_operation.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_deploy_certificate_record_rollback_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_deploy_certificate_record_rollback_operation" +description: |- + Provides a resource to create a ssl deploy_certificate_record_rollback +--- + +# tencentcloud_ssl_deploy_certificate_record_rollback_operation + +Provides a resource to create a ssl deploy_certificate_record_rollback + +## Example Usage + +```hcl +resource "tencentcloud_ssl_deploy_certificate_record_rollback_operation" "deploy_certificate_record_rollback" { + deploy_record_id = 35471 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `deploy_record_id` - (Optional, Int, ForceNew) Deployment record ID to be rollback. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl deploy_certificate_record_rollback can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_deploy_certificate_record_rollback_operation.deploy_certificate_record_rollback deploy_certificate_record_rollback_id +``` + diff --git a/config/docs/r/ssl_download_certificate_operation.html.markdown b/config/docs/r/ssl_download_certificate_operation.html.markdown new file mode 100644 index 0000000..45a2b97 --- /dev/null +++ b/config/docs/r/ssl_download_certificate_operation.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_download_certificate_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_download_certificate_operation" +description: |- + Provides a resource to create a ssl download_certificate +--- + +# tencentcloud_ssl_download_certificate_operation + +Provides a resource to create a ssl download_certificate + +## Example Usage + +```hcl +resource "tencentcloud_ssl_download_certificate_operation" "download_certificate" { + certificate_id = "8x1eUSSl" + output_path = "./" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String, ForceNew) Certificate ID. +* `output_path` - (Required, String, ForceNew) Certificate ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl download_certificate can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_download_certificate_operation.download_certificate download_certificate_id +``` + diff --git a/config/docs/r/ssl_free_certificate.html.markdown b/config/docs/r/ssl_free_certificate.html.markdown new file mode 100644 index 0000000..91261d7 --- /dev/null +++ b/config/docs/r/ssl_free_certificate.html.markdown @@ -0,0 +1,81 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_free_certificate" +sidebar_current: "docs-tencentcloud-resource-ssl_free_certificate" +description: |- + Provide a resource to create a Free Certificate. +--- + +# tencentcloud_ssl_free_certificate + +Provide a resource to create a Free Certificate. + +~> **NOTE:** Once certificat created, it cannot be removed within 1 hours. + +## Example Usage + +### only support type 2. 2=TrustAsia TLS RSA CA. + +```hcl +resource "tencentcloud_ssl_free_certificate" "example" { + dv_auth_method = "DNS_AUTO" + domain = "example.com" + package_type = "2" + contact_email = "test@example.com" + contact_phone = "18352458901" + validity_period = 12 + csr_encrypt_algo = "RSA" + csr_key_parameter = "2048" + csr_key_password = "csr_pwd" + alias = "example_free_cert" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Specify domain name. +* `dv_auth_method` - (Required, String) Specify DV authorize method. Available values: `DNS_AUTO` - automatic DNS auth, `DNS` - manual DNS auth, `FILE` - auth by file. +* `alias` - (Optional, String) Specify alias for remark. +* `contact_email` - (Optional, String) Email address. +* `contact_phone` - (Optional, String) Phone number. +* `csr_encrypt_algo` - (Optional, String) Specify CSR encrypt algorithm, only support `RSA` for now. +* `csr_key_parameter` - (Optional, String) Specify CSR key parameter, only support `"2048"` for now. +* `csr_key_password` - (Optional, String) Specify CSR key password. +* `old_certificate_id` - (Optional, String, ForceNew) Specify old certificate ID, used for re-apply. +* `package_type` - (Optional, String) Type of package. Only support `"2"` (TrustAsia TLS RSA CA). +* `project_id` - (Optional, Int) ID of projects which this certification belong to. +* `validity_period` - (Optional, String) Specify validity period in month, only support `"12"` months for now. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `cert_begin_time` - Certificate begin time. +* `cert_end_time` - Certificate end time. +* `certificate_private_key` - Certificate private key. +* `certificate_public_key` - Certificate public key. +* `deployable` - Indicates whether the certificate deployable. +* `dv_auths` - DV certification information. + * `dv_auth_key` - DV authentication key. + * `dv_auth_value` - DV authentication value. + * `dv_auth_verify_type` - DV authentication type. +* `insert_time` - Certificate insert time. +* `product_zh_name` - Product zh name. +* `renewable` - Indicates whether the certificate renewable. +* `status_msg` - Certificate status message. +* `status_name` - Certificate status name. +* `status` - Certificate status. 0 = Approving, 1 = Approved, 2 = Approve failed, 3 = expired, 4 = DNS record added, 5 = OV/EV Certificate and confirm letter needed, 6 = Order canceling, 7 = Order canceled, 8 = Submitted and confirm letter needed, 9 = Revoking, 10 = Revoked, 11 = re-applying, 12 = Revoke and confirm letter needed, 13 = Free SSL and confirm letter needed. +* `vulnerability_status` - Vulnerability status. + + +## Import + +FreeCertificate instance can be imported, e.g. +``` +$ terraform import tencentcloud_ssl_free_certificate.test free_certificate-id +``` + diff --git a/config/docs/r/ssl_pay_certificate.html.markdown b/config/docs/r/ssl_pay_certificate.html.markdown new file mode 100644 index 0000000..26c6adc --- /dev/null +++ b/config/docs/r/ssl_pay_certificate.html.markdown @@ -0,0 +1,119 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_pay_certificate" +sidebar_current: "docs-tencentcloud-resource-ssl_pay_certificate" +description: |- + Provide a resource to create a payment SSL. +--- + +# tencentcloud_ssl_pay_certificate + +Provide a resource to create a payment SSL. + +~> **NOTE:** Provides the creation of a paid certificate, including the submission of certificate information and order functions; +currently, it does not support re-issuing certificates, revoking certificates, and deleting certificates; the certificate remarks +and belonging items can be updated. The Destroy operation will only cancel the certificate order, and will not delete the +certificate and refund the fee. If you need a refund, you need to check the current certificate status in the console +as `Review Cancel`, and then you can click `Request a refund` to refund the fee. To update the information of a certificate, +we will automatically roll back your certificate if this certificate is already in the validation stage. This process may take +some time because the CA callback is time-consuming. Please be patient and follow the prompt message. Or, feel free to contact +Tencent Cloud Support. + +## Example Usage + +```hcl +resource "tencentcloud_ssl_pay_certificate" "example" { + product_id = 33 + domain_num = 1 + alias = "ssl desc." + project_id = 0 + information { + csr_type = "online" + certificate_domain = "www.example.com" + organization_name = "Tencent" + organization_division = "Qcloud" + organization_address = "广东省深圳市南山区腾讯大厦1000号" + organization_country = "CN" + organization_city = "深圳市" + organization_region = "广东省" + postal_code = "0755" + phone_area_code = "0755" + phone_number = "86013388" + verify_type = "DNS" + admin_first_name = "test" + admin_last_name = "test" + admin_phone_num = "12345678901" + admin_email = "test@tencent.com" + admin_position = "developer" + contact_first_name = "test" + contact_last_name = "test" + contact_email = "test@tencent.com" + contact_number = "12345678901" + contact_position = "developer" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_num` - (Required, Int, ForceNew) Number of domain names included in the certificate. +* `information` - (Required, List) Certificate information. +* `product_id` - (Required, Int, ForceNew) Certificate commodity ID. Valid value ranges: (3~42). `3` means SecureSite enhanced Enterprise Edition (EV Pro), `4` means SecureSite enhanced (EV), `5` means SecureSite Enterprise Professional Edition (OV Pro), `6` means SecureSite Enterprise (OV), `7` means SecureSite Enterprise Type (OV) wildcard, `8` means Geotrust enhanced (EV), `9` means Geotrust enterprise (OV), `10` means Geotrust enterprise (OV) wildcard, `11` means TrustAsia domain type multi-domain SSL certificate, `12` means TrustAsia domain type ( DV) wildcard, `13` means TrustAsia enterprise wildcard (OV) SSL certificate (D3), `14` means TrustAsia enterprise (OV) SSL certificate (D3), `15` means TrustAsia enterprise multi-domain (OV) SSL certificate (D3), `16` means TrustAsia Enhanced (EV) SSL Certificate (D3), `17` means TrustAsia Enhanced Multiple Domain (EV) SSL Certificate (D3), `18` means GlobalSign Enterprise (OV) SSL Certificate, `19` means GlobalSign Enterprise Wildcard (OV) SSL Certificate, `20` means GlobalSign Enhanced (EV) SSL Certificate, `21` means TrustAsia Enterprise Wildcard Multiple Domain (OV) SSL Certificate (D3), `22` means GlobalSign Enterprise Multiple Domain (OV) SSL Certificate, `23` means GlobalSign Enterprise Multiple Wildcard Domain name (OV) SSL certificate, `24` means GlobalSign enhanced multi-domain (EV) SSL certificate, `25` means Wotrus domain type certificate, `26` means Wotrus domain type multi-domain certificate, `27` means Wotrus domain type wildcard certificate, `28` means Wotrus enterprise type certificate, `29` means Wotrus enterprise multi-domain certificate, `30` means Wotrus enterprise wildcard certificate, `31` means Wotrus enhanced certificate, `32` means Wotrus enhanced multi-domain certificate, `33` means WoTrus National Secret Domain name Certificate, `34` means WoTrus National Secret Domain name Certificate (multiple domain names), `35` WoTrus National Secret Domain name Certificate (wildcard), `37` means WoTrus State Secret Enterprise Certificate, `38` means WoTrus State Secret Enterprise Certificate (multiple domain names), `39` means WoTrus State Secret Enterprise Certificate (wildcard), `40` means WoTrus National secret enhanced certificate, `41` means WoTrus National Secret enhanced Certificate (multiple domain names), `42` means TrustAsia- Domain name Certificate (wildcard multiple domain names), `43` means DNSPod Enterprise (OV) SSL Certificate, `44` means DNSPod- Enterprise (OV) wildcard SSL certificate, `45` means DNSPod Enterprise (OV) Multi-domain name SSL Certificate, `46` means DNSPod enhanced (EV) SSL certificate, `47` means DNSPod enhanced (EV) multi-domain name SSL certificate, `48` means DNSPod Domain name Type (DV) SSL Certificate, `49` means DNSPod Domain name Type (DV) wildcard SSL certificate, `50` means DNSPod domain name type (DV) multi-domain name SSL certificate, `51` means DNSPod (State Secret) Enterprise (OV) SSL certificate, `52` DNSPod (National Secret) Enterprise (OV) wildcard SSL certificate, `53` means DNSPod (National Secret) Enterprise (OV) multi-domain SSL certificate, `54` means DNSPod (National Secret) Domain Name (DV) SSL certificate, `55` means DNSPod (National Secret) Domain Name Type (DV) wildcard SSL certificate, `56` means DNSPod (National Secret) Domain Name Type (DV) multi-domain SSL certificate. +* `alias` - (Optional, String) Remark name. +* `confirm_letter` - (Optional, String) The base64-encoded certificate confirmation file should be in jpg, jpeg, png, pdf, and the size should be between 1kb and 1.4M. Note: it only works when product_id is set to 8, 9 or 10. +* `dv_auths` - (Optional, List) DV certification information. +* `project_id` - (Optional, Int) The ID of project. +* `time_span` - (Optional, Int) Certificate period, currently only supports 1 year certificate purchase. + +The `dv_auths` object supports the following: + + +The `information` object supports the following: + +* `admin_email` - (Required, String) The administrator's email address. +* `admin_first_name` - (Required, String) The first name of the administrator. +* `admin_last_name` - (Required, String) The last name of the administrator. +* `admin_phone_num` - (Required, String) Manager mobile phone number. +* `admin_position` - (Required, String) Manager position. +* `certificate_domain` - (Required, String) Domain name for binding certificate. +* `contact_email` - (Required, String) Contact email address. +* `contact_first_name` - (Required, String) Contact first name. +* `contact_last_name` - (Required, String) Contact last name. +* `contact_number` - (Required, String) Contact phone number. +* `contact_position` - (Required, String) Contact position. +* `organization_address` - (Required, String) Company address. +* `organization_city` - (Required, String) Company city. +* `organization_country` - (Required, String) Country name, such as China: CN. +* `organization_division` - (Required, String) Department name. +* `organization_name` - (Required, String) Company name. +* `organization_region` - (Required, String) The province where the company is located. +* `phone_area_code` - (Required, String) Company landline area code. +* `phone_number` - (Required, String) Company landline number. +* `postal_code` - (Required, String) Company postal code. +* `verify_type` - (Required, String) Certificate verification method. Valid values: `DNS_AUTO`, `DNS`, `FILE`. `DNS_AUTO` means automatic DNS verification, this verification type is only supported for domain names resolved by Tencent Cloud and the resolution status is normal, `DNS` means manual DNS verification, `FILE` means file verification. +* `csr_content` - (Optional, String) CSR content uploaded. +* `csr_type` - (Optional, String) CSR generation method. Valid values: `online`, `parse`. `online` means online generation, `parse` means manual upload. +* `domain_list` - (Optional, Set) Array of uploaded domain names, multi-domain certificates can be uploaded. +* `key_password` - (Optional, String) Private key password. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `certificate_id` - Returned certificate ID. +* `order_id` - Order ID returned. +* `status` - SSL certificate status. + + +## Import + +payment SSL instance can be imported, e.g. + +``` +$ terraform import tencentcloud_ssl_pay_certificate.ssl iPQNn61x#33#1#1 +``` + diff --git a/config/docs/r/ssl_replace_certificate_operation.html.markdown b/config/docs/r/ssl_replace_certificate_operation.html.markdown new file mode 100644 index 0000000..aa7e540 --- /dev/null +++ b/config/docs/r/ssl_replace_certificate_operation.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_replace_certificate_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_replace_certificate_operation" +description: |- + Provides a resource to create a ssl replace_certificate +--- + +# tencentcloud_ssl_replace_certificate_operation + +Provides a resource to create a ssl replace_certificate + +## Example Usage + +```hcl +resource "tencentcloud_ssl_replace_certificate_operation" "replace_certificate" { + certificate_id = "8L6JsWq2" + valid_type = "DNS_AUTO" + csr_type = "online" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String, ForceNew) Certificate ID. +* `valid_type` - (Required, String, ForceNew) Verification type: DNS_AUTO = automatic DNS verification (this verification type is only supported for domain names that are resolved by Tencent Cloud and have normal resolution status), DNS = manual DNS verification, FILE = file verification. +* `cert_csr_encrypt_algo` - (Optional, String, ForceNew) CSR encryption method, optional: RSA, ECC, SM2. (Selectable only if CsrType is Online), default is RSA. +* `cert_csr_key_parameter` - (Optional, String, ForceNew) CSR encryption parameter, when CsrEncryptAlgo is RSA, you can choose 2048, 4096, etc., and the default is 2048; when CsrEncryptAlgo is ECC, you can choose prime256v1, secp384r1, etc., and the default is prime256v1;. +* `csr_content` - (Optional, String, ForceNew) CSR Content. +* `csr_key_password` - (Optional, String, ForceNew) KEY Password. +* `csr_type` - (Optional, String, ForceNew) Type, default Original. Available options: Original = original certificate CSR, Upload = manual upload, Online = online generation. +* `reason` - (Optional, String, ForceNew) Reason for reissue. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl replace_certificate can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_replace_certificate_operation.replace_certificate replace_certificate_id +``` + diff --git a/config/docs/r/ssl_revoke_certificate_operation.html.markdown b/config/docs/r/ssl_revoke_certificate_operation.html.markdown new file mode 100644 index 0000000..7cd9dfb --- /dev/null +++ b/config/docs/r/ssl_revoke_certificate_operation.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_revoke_certificate_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_revoke_certificate_operation" +description: |- + Provides a resource to create a ssl revoke_certificate +--- + +# tencentcloud_ssl_revoke_certificate_operation + +Provides a resource to create a ssl revoke_certificate + +## Example Usage + +```hcl +resource "tencentcloud_ssl_revoke_certificate_operation" "revoke_certificate" { + certificate_id = "7zUGkVab" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String, ForceNew) Certificate ID. +* `reason` - (Optional, String, ForceNew) Reasons for revoking certificate. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl revoke_certificate can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_revoke_certificate_operation.revoke_certificate revoke_certificate_id +``` + diff --git a/config/docs/r/ssl_update_certificate_instance_operation.html.markdown b/config/docs/r/ssl_update_certificate_instance_operation.html.markdown new file mode 100644 index 0000000..fe8639c --- /dev/null +++ b/config/docs/r/ssl_update_certificate_instance_operation.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_update_certificate_instance_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_update_certificate_instance_operation" +description: |- + Provides a resource to create a ssl update_certificate_instance +--- + +# tencentcloud_ssl_update_certificate_instance_operation + +Provides a resource to create a ssl update_certificate_instance + +## Example Usage + +```hcl +resource "tencentcloud_ssl_update_certificate_instance_operation" "update_certificate_instance" { + certificate_id = "8x1eUSSl" + old_certificate_id = "8xNdi2ig" + resource_types = ["cdn"] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String, ForceNew) Update new certificate ID. +* `old_certificate_id` - (Required, String, ForceNew) Update the original certificate ID. +* `resource_types` - (Required, Set: [`String`], ForceNew) The resource type that needs to be deployed. The parameter value is optional: clb,cdn,waf,live,ddos,teo,apigateway,vod,tke,tcb. +* `resource_types_regions` - (Optional, List, ForceNew) List of regions where cloud resources need to be deployed. + +The `resource_types_regions` object supports the following: + +* `regions` - (Optional, Set) Region list. +* `resource_type` - (Optional, String) Cloud resource type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl update_certificate_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_update_certificate_instance_operation.update_certificate_instance update_certificate_instance_id +``` + diff --git a/config/docs/r/ssl_update_certificate_record_retry_operation.html.markdown b/config/docs/r/ssl_update_certificate_record_retry_operation.html.markdown new file mode 100644 index 0000000..6b766b1 --- /dev/null +++ b/config/docs/r/ssl_update_certificate_record_retry_operation.html.markdown @@ -0,0 +1,44 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_update_certificate_record_retry_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_update_certificate_record_retry_operation" +description: |- + Provides a resource to create a ssl update_certificate_record_retry +--- + +# tencentcloud_ssl_update_certificate_record_retry_operation + +Provides a resource to create a ssl update_certificate_record_retry + +## Example Usage + +```hcl +resource "tencentcloud_ssl_update_certificate_record_retry_operation" "update_certificate_record_retry" { + deploy_record_id = "1603" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `deploy_record_detail_id` - (Optional, Int, ForceNew) Deployment record details ID to be retried. +* `deploy_record_id` - (Optional, Int, ForceNew) Deployment record ID to be retried. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl update_certificate_record_retry can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_update_certificate_record_retry_operation.update_certificate_record_retry update_certificate_record_retry_id +``` + diff --git a/config/docs/r/ssl_update_certificate_record_rollback_operation.html.markdown b/config/docs/r/ssl_update_certificate_record_rollback_operation.html.markdown new file mode 100644 index 0000000..9f1eed5 --- /dev/null +++ b/config/docs/r/ssl_update_certificate_record_rollback_operation.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_update_certificate_record_rollback_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_update_certificate_record_rollback_operation" +description: |- + Provides a resource to create a ssl update_certificate_record_rollback +--- + +# tencentcloud_ssl_update_certificate_record_rollback_operation + +Provides a resource to create a ssl update_certificate_record_rollback + +## Example Usage + +```hcl +resource "tencentcloud_ssl_update_certificate_record_rollback_operation" "update_certificate_record_rollback" { + deploy_record_id = "1603" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `deploy_record_id` - (Optional, String, ForceNew) Deployment record ID to be rolled back. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl update_certificate_record_rollback can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_update_certificate_record_rollback_operation.update_certificate_record_rollback update_certificate_record_rollback_id +``` + diff --git a/config/docs/r/ssl_upload_revoke_letter_operation.html.markdown b/config/docs/r/ssl_upload_revoke_letter_operation.html.markdown new file mode 100644 index 0000000..4d7cd29 --- /dev/null +++ b/config/docs/r/ssl_upload_revoke_letter_operation.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "SSL Certificates" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssl_upload_revoke_letter_operation" +sidebar_current: "docs-tencentcloud-resource-ssl_upload_revoke_letter_operation" +description: |- + Provides a resource to create a ssl upload_revoke_letter +--- + +# tencentcloud_ssl_upload_revoke_letter_operation + +Provides a resource to create a ssl upload_revoke_letter + +## Example Usage + +```hcl +resource "tencentcloud_ssl_upload_revoke_letter_operation" "upload_revoke_letter" { + certificate_id = "8xRYdDlc" + revoke_letter = filebase64("./c.pdf") +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String, ForceNew) Certificate ID. +* `revoke_letter` - (Required, String, ForceNew) The format of the base64-encoded certificate confirmation letter file should be jpg, jpeg, png, or pdf, and the size should be between 1kb and 1.4M. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +ssl upload_revoke_letter can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssl_upload_revoke_letter_operation.upload_revoke_letter upload_revoke_letter_id +``` + diff --git a/config/docs/r/ssm_product_secret.html.markdown b/config/docs/r/ssm_product_secret.html.markdown new file mode 100644 index 0000000..70e1010 --- /dev/null +++ b/config/docs/r/ssm_product_secret.html.markdown @@ -0,0 +1,133 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_product_secret" +sidebar_current: "docs-tencentcloud-resource-ssm_product_secret" +description: |- + Provides a resource to create a ssm product_secret +--- + +# tencentcloud_ssm_product_secret + +Provides a resource to create a ssm product_secret + +## Example Usage + +```hcl +data "tencentcloud_availability_zones_by_product" "zones" { + product = "cdb" +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_security_group" "security_group" { + name = "sg-example" + description = "desc." +} + +resource "tencentcloud_mysql_instance" "example" { + internet_service = 1 + engine_version = "5.7" + charge_type = "POSTPAID" + root_password = "PassWord123" + slave_deploy_mode = 0 + availability_zone = data.tencentcloud_availability_zones_by_product.zones.zones.0.name + slave_sync_mode = 1 + instance_name = "tf-example" + mem_size = 4000 + volume_size = 200 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + intranet_port = 3306 + security_groups = [tencentcloud_security_group.security_group.id] + + tags = { + createBy = "terraform" + } + + parameters = { + character_set_server = "utf8" + max_connections = "1000" + } +} + +resource "tencentcloud_kms_key" "example" { + alias = "tf-example-kms-key" + description = "example of kms key" + key_rotation_enabled = false + is_enabled = true + + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_ssm_product_secret" "example" { + secret_name = "tf-example" + user_name_prefix = "prefix" + product_name = "Mysql" + instance_id = tencentcloud_mysql_instance.example.id + domains = ["10.0.0.0"] + privileges_list { + privilege_name = "GlobalPrivileges" + privileges = ["ALTER ROUTINE"] + } + description = "for ssm product test" + kms_key_id = tencentcloud_kms_key.example.id + status = "Enabled" + enable_rotation = true + rotation_begin_time = "2023-08-05 20:54:33" + rotation_frequency = 30 + + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domains` - (Required, Set: [`String`]) Domain name of the account in the form of IP. You can enter `%`. +* `instance_id` - (Required, String) Tencent Cloud service instance ID. +* `privileges_list` - (Required, List) List of permissions that need to be granted when the credential is bound to a Tencent Cloud service. +* `product_name` - (Required, String) Name of the Tencent Cloud service bound to the credential, such as `Mysql`, `Tdsql-mysql`. you can use dataSource `tencentcloud_ssm_products` to query supported products. +* `secret_name` - (Required, String, ForceNew) Credential name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens, and underscores and must begin with a letter or digit. +* `user_name_prefix` - (Required, String) Prefix of the user account name, which is specified by you and can contain up to 8 characters.Supported character sets include:Digits: [0, 9].Lowercase letters: [a, z].Uppercase letters: [A, Z].Special symbols: underscore.The prefix must begin with a letter. +* `description` - (Optional, String) Description, which is used to describe the purpose in detail and can contain up to 2,048 bytes. +* `enable_rotation` - (Optional, Bool) Specifies whether to enable rotation, when secret status is `Disabled`, rotation will be disabled. `True` - enable, `False` - do not enable. If this parameter is not specified, `False` will be used by default. +* `kms_key_id` - (Optional, String) Specifies the KMS CMK that encrypts the credential. If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption. +* `rotation_begin_time` - (Optional, String) User-Defined rotation start time in the format of 2006-01-02 15:04:05.When `EnableRotation` is `True`, this parameter is required. +* `rotation_frequency` - (Optional, Int) Rotation frequency in days. Default value: 1 day. +* `status` - (Optional, String) Enable or Disable Secret. Valid values is `Enabled` or `Disabled`. Default is `Enabled`. +* `tags` - (Optional, Map) Tags of secret. + +The `privileges_list` object supports the following: + +* `privilege_name` - (Required, String) Permission name. Valid values: `GlobalPrivileges`, `DatabasePrivileges`, `TablePrivileges`, `ColumnPrivileges`. When the permission is `DatabasePrivileges`, the database name must be specified by the `Database` parameter; When the permission is `TablePrivileges`, the database name and the table name in the database must be specified by the `Database` and `TableName` parameters; When the permission is `ColumnPrivileges`, the database name, table name in the database, and column name in the table must be specified by the `Database`, `TableName`, and `ColumnName` parameters. +* `privileges` - (Required, Set) Permission list. For the `Mysql` service, optional permission values are: 1. Valid values of `GlobalPrivileges`: SELECT,INSERT,UPDATE,DELETE,CREATE, PROCESS, DROP,REFERENCES,INDEX,ALTER,SHOW DATABASES,CREATE TEMPORARY TABLES,LOCK TABLES,EXECUTE,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE,EVENT,TRIGGER. Note: if this parameter is not passed in, it means to clear the permission. 2. Valid values of `DatabasePrivileges`: SELECT,INSERT,UPDATE,DELETE,CREATE, DROP,REFERENCES,INDEX,ALTER,CREATE TEMPORARY TABLES,LOCK TABLES,EXECUTE,CREATE VIEW,SHOW VIEW,CREATE ROUTINE,ALTER ROUTINE,EVENT,TRIGGER. Note: if this parameter is not passed in, it means to clear the permission. 3. Valid values of `TablePrivileges`: SELECT,INSERT,UPDATE,DELETE,CREATE, DROP,REFERENCES,INDEX,ALTER,CREATE VIEW,SHOW VIEW, TRIGGER. Note: if this parameter is not passed in, it means to clear the permission. 4. Valid values of `ColumnPrivileges`: SELECT,INSERT,UPDATE,REFERENCES.Note: if this parameter is not passed in, it means to clear the permission. +* `column_name` - (Optional, String) This value takes effect only when `PrivilegeName` is `ColumnPrivileges`, and the following parameters are required in this case:Database: explicitly indicate the database instance.TableName: explicitly indicate the table. +* `database` - (Optional, String) This value takes effect only when `PrivilegeName` is `DatabasePrivileges`. +* `table_name` - (Optional, String) This value takes effect only when `PrivilegeName` is `TablePrivileges`, and the `Database` parameter is required in this case to explicitly indicate the database instance. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Credential creation time in UNIX timestamp format. +* `secret_type` - `0`: user-defined secret. `1`: Tencent Cloud services secret. `2`: SSH key secret. `3`: Tencent Cloud API key secret. Note: this field may return `null`, indicating that no valid values can be obtained. + + diff --git a/config/docs/r/ssm_rotate_product_secret.html.markdown b/config/docs/r/ssm_rotate_product_secret.html.markdown new file mode 100644 index 0000000..115b207 --- /dev/null +++ b/config/docs/r/ssm_rotate_product_secret.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_rotate_product_secret" +sidebar_current: "docs-tencentcloud-resource-ssm_rotate_product_secret" +description: |- + Provides a resource to create a ssm rotate_product_secret +--- + +# tencentcloud_ssm_rotate_product_secret + +Provides a resource to create a ssm rotate_product_secret + +## Example Usage + +```hcl +resource "tencentcloud_ssm_rotate_product_secret" "example" { + secret_name = "tf_example" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `secret_name` - (Required, String, ForceNew) Secret name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/ssm_secret.html.markdown b/config/docs/r/ssm_secret.html.markdown new file mode 100644 index 0000000..040a3fa --- /dev/null +++ b/config/docs/r/ssm_secret.html.markdown @@ -0,0 +1,111 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_secret" +sidebar_current: "docs-tencentcloud-resource-ssm_secret" +description: |- + Provide a resource to create a SSM secret. +--- + +# tencentcloud_ssm_secret + +Provide a resource to create a SSM secret. + +## Example Usage + +### Create user defined secret + +```hcl +resource "tencentcloud_ssm_secret" "example" { + secret_name = "tf-example" + description = "desc." + is_enabled = true + recovery_window_in_days = 0 + + tags = { + createBy = "terraform" + } +} +``` + +### Create redis secret + +```hcl +data "tencentcloud_redis_zone_config" "zone" { + type_id = 8 +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = data.tencentcloud_redis_zone_config.zone.list[3].zone + name = "subnet-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_redis_instance" "example" { + availability_zone = data.tencentcloud_redis_zone_config.zone.list[3].zone + type_id = data.tencentcloud_redis_zone_config.zone.list[3].type_id + password = "Qwer@234" + mem_size = data.tencentcloud_redis_zone_config.zone.list[3].mem_sizes[0] + redis_shard_num = data.tencentcloud_redis_zone_config.zone.list[3].redis_shard_nums[0] + redis_replicas_num = data.tencentcloud_redis_zone_config.zone.list[3].redis_replicas_nums[0] + name = "tf_example" + port = 6379 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_ssm_secret" "example" { + secret_name = "tf-example" + description = "redis desc." + is_enabled = true + secret_type = 4 + additional_config = jsonencode( + { + "Region" : "ap-guangzhou" + "Privilege" : "r", + "InstanceId" : tencentcloud_redis_instance.example.id + "ReadonlyPolicy" : ["master"], + "Remark" : "for tf test" + } + ) + tags = { + createdBy = "terraform" + } + recovery_window_in_days = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `secret_name` - (Required, String, ForceNew) Name of secret which cannot be repeated in the same region. The maximum length is 128 bytes. The name can only contain English letters, numbers, underscore and hyphen '-'. The first character must be a letter or number. +* `additional_config` - (Optional, String) Additional config for specific secret types in JSON string format. +* `description` - (Optional, String) Description of secret. The maximum is 2048 bytes. +* `is_enabled` - (Optional, Bool) Specify whether to enable secret. Default value is `true`. +* `kms_key_id` - (Optional, String, ForceNew) KMS keyId used to encrypt secret. If it is empty, it means that the CMK created by SSM for you by default is used for encryption. You can also specify the KMS CMK created by yourself in the same region for encryption. +* `recovery_window_in_days` - (Optional, Int) Specify the scheduled deletion date. Default value is `0` that means to delete immediately. 1-30 means the number of days reserved, completely deleted after this date. +* `secret_type` - (Optional, Int) Type of secret. `0`: user-defined secret. `4`: redis secret. Default is `0`. +* `tags` - (Optional, Map) Tags of secret. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - Status of secret. + + +## Import + +SSM secret can be imported using the secretName, e.g. +``` +$ terraform import tencentcloud_ssm_secret.foo test +``` + diff --git a/config/docs/r/ssm_secret_version.html.markdown b/config/docs/r/ssm_secret_version.html.markdown new file mode 100644 index 0000000..fd16cae --- /dev/null +++ b/config/docs/r/ssm_secret_version.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_secret_version" +sidebar_current: "docs-tencentcloud-resource-ssm_secret_version" +description: |- + Provide a resource to create a SSM secret version. +--- + +# tencentcloud_ssm_secret_version + +Provide a resource to create a SSM secret version. + +-> **Note:** A maximum of 10 versions can be supported under one credential. Only new versions can be added to credentials in the enabled and disabled states. + +## Example Usage + +### Text type credential information plaintext + +```hcl +resource "tencentcloud_ssm_secret" "example" { + secret_name = "tf-example" + description = "desc." + recovery_window_in_days = 0 + is_enabled = true + + tags = { + createdBy = "terraform" + } +} + +resource "tencentcloud_ssm_secret_version" "v1" { + secret_name = tencentcloud_ssm_secret.example.secret_name + version_id = "v1" + secret_string = "this is secret string" +} +``` + +### Binary credential information, encoded using base64 + +```hcl +resource "tencentcloud_ssm_secret_version" "v2" { + secret_name = tencentcloud_ssm_secret.example.secret_name + version_id = "v2" + secret_binary = "MTIzMTIzMTIzMTIzMTIzQQ==" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `secret_name` - (Required, String, ForceNew) Name of secret which cannot be repeated in the same region. The maximum length is 128 bytes. The name can only contain English letters, numbers, underscore and hyphen '-'. The first character must be a letter or number. +* `version_id` - (Required, String, ForceNew) Version of secret. The maximum length is 64 bytes. The version_id can only contain English letters, numbers, underscore and hyphen '-'. The first character must be a letter or number. +* `secret_binary` - (Optional, String) The base64-encoded binary secret. secret_binary and secret_string must be set only one, and the maximum support is 4096 bytes. When secret status is `Disabled`, this field will not update anymore. +* `secret_string` - (Optional, String) The string text of secret. secret_binary and secret_string must be set only one, and the maximum support is 4096 bytes. When secret status is `Disabled`, this field will not update anymore. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +SSM secret version can be imported using the secretName#versionId, e.g. +``` +$ terraform import tencentcloud_ssm_secret_version.v1 test#v1 +``` + diff --git a/config/docs/r/ssm_ssh_key_pair_secret.html.markdown b/config/docs/r/ssm_ssh_key_pair_secret.html.markdown new file mode 100644 index 0000000..a534179 --- /dev/null +++ b/config/docs/r/ssm_ssh_key_pair_secret.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Secrets Manager(SSM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_ssm_ssh_key_pair_secret" +sidebar_current: "docs-tencentcloud-resource-ssm_ssh_key_pair_secret" +description: |- + Provides a resource to create a ssm ssh key pair secret +--- + +# tencentcloud_ssm_ssh_key_pair_secret + +Provides a resource to create a ssm ssh key pair secret + +## Example Usage + +```hcl +resource "tencentcloud_kms_key" "example" { + alias = "tf-example-kms-key" + description = "example of kms key" + key_rotation_enabled = false + is_enabled = true + + tags = { + createdBy = "terraform" + } +} + +resource "tencentcloud_ssm_ssh_key_pair_secret" "example" { + secret_name = "tf-example" + project_id = 0 + description = "desc." + kms_key_id = tencentcloud_kms_key.example.id + ssh_key_name = "tf_example_ssh" + status = "Enabled" + clean_ssh_key = true + + tags = { + createdBy = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Required, Int) ID of the project to which the created SSH key belongs. +* `secret_name` - (Required, String, ForceNew) Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit. +* `clean_ssh_key` - (Optional, Bool) Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only take effect when delete SSH key secrets. Valid values: `True`: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.`False`: only deletes the SSH key information in the secret. +* `description` - (Optional, String) Description, such as what it is used for. It contains up to 2,048 bytes. +* `kms_key_id` - (Optional, String) Specifies a KMS CMK to encrypt the secret.If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.You can also specify a custom KMS CMK created in the same region for encryption. +* `ssh_key_name` - (Optional, String) Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters. +* `status` - (Optional, String) Enable or Disable Secret. Valid values is `Enabled` or `Disabled`. Default is `Enabled`. +* `tags` - (Optional, Map) Tags of secret. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Credential creation time in UNIX timestamp format. +* `secret_type` - `0`: user-defined secret. `1`: Tencent Cloud services secret. `2`: SSH key secret. `3`: Tencent Cloud API key secret. Note: this field may return `null`, indicating that no valid values can be obtained. + + +## Import + +ssm ssh_key_pair_secret can be imported using the id, e.g. + +``` +terraform import tencentcloud_ssm_ssh_key_pair_secret.ssh_key_pair_secret ssh_key_pair_secret_name +``` + diff --git a/config/docs/r/subnet.html.markdown b/config/docs/r/subnet.html.markdown new file mode 100644 index 0000000..178ca35 --- /dev/null +++ b/config/docs/r/subnet.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_subnet" +sidebar_current: "docs-tencentcloud-resource-subnet" +description: |- + Provide a resource to create a VPC subnet. +--- + +# tencentcloud_subnet + +Provide a resource to create a VPC subnet. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + is_multicast = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `availability_zone` - (Required, String, ForceNew) The availability zone within which the subnet should be created. +* `cidr_block` - (Required, String, ForceNew) A network address block of the subnet. +* `name` - (Required, String) The name of subnet to be created. +* `vpc_id` - (Required, String, ForceNew) ID of the VPC to be associated. +* `is_multicast` - (Optional, Bool) Indicates whether multicast is enabled. The default value is 'true'. +* `route_table_id` - (Optional, String) ID of a routing table to which the subnet should be associated. +* `tags` - (Optional, Map) Tags of the subnet. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `available_ip_count` - The number of available IPs. +* `create_time` - Creation time of subnet resource. +* `is_default` - Indicates whether it is the default VPC for this region. + + +## Import + +Vpc subnet instance can be imported, e.g. + +``` +$ terraform import tencentcloud_subnet.test subnet_id +``` + diff --git a/config/docs/r/tag.html.markdown b/config/docs/r/tag.html.markdown new file mode 100644 index 0000000..00a677a --- /dev/null +++ b/config/docs/r/tag.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Tag" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tag" +sidebar_current: "docs-tencentcloud-resource-tag" +description: |- + Provides a resource to create a tag +--- + +# tencentcloud_tag + +Provides a resource to create a tag + +## Example Usage + +```hcl +resource "tencentcloud_tag" "tag" { + tag_key = "test" + tag_value = "Terraform" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `tag_key` - (Required, String, ForceNew) tag key. +* `tag_value` - (Required, String, ForceNew) tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tag tag can be imported using the id, e.g. + +``` +terraform import tencentcloud_tag.tag tag_id +``` + diff --git a/config/docs/r/tag_attachment.html.markdown b/config/docs/r/tag_attachment.html.markdown new file mode 100644 index 0000000..c99bab4 --- /dev/null +++ b/config/docs/r/tag_attachment.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Tag" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tag_attachment" +sidebar_current: "docs-tencentcloud-resource-tag_attachment" +description: |- + Provides a resource to create a tag attachment +--- + +# tencentcloud_tag_attachment + +Provides a resource to create a tag attachment + +## Example Usage + +```hcl +resource "tencentcloud_tag_attachment" "attachment" { + tag_key = "test3" + tag_value = "Terraform3" + resource = "qcs::cvm:ap-guangzhou:uin/100020512675:instance/ins-kfrlvcp4" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `resource` - (Required, String, ForceNew) [Six-segment description of resources](https://cloud.tencent.com/document/product/598/10606). +* `tag_key` - (Required, String, ForceNew) tag key. +* `tag_value` - (Required, String, ForceNew) tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tag attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_tag_attachment.attachment attachment_id +``` + diff --git a/config/docs/r/tat_command.html.markdown b/config/docs/r/tat_command.html.markdown new file mode 100644 index 0000000..f64e378 --- /dev/null +++ b/config/docs/r/tat_command.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "TencentCloud Automation Tools(TAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tat_command" +sidebar_current: "docs-tencentcloud-resource-tat_command" +description: |- + Provides a resource to create a tat command +--- + +# tencentcloud_tat_command + +Provides a resource to create a tat command + +## Example Usage + +```hcl +resource "tencentcloud_tat_command" "command" { + username = "root" + command_name = "ls" + content = "bHM=" + description = "xxx" + command_type = "SHELL" + working_directory = "/root" + timeout = 50 + tags { + key = "" + value = "" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `command_name` - (Required, String) Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.]. +* `content` - (Required, String) Command. The maximum length of Base64 encoding is 64KB. +* `command_type` - (Optional, String) Command type. `SHELL` and `POWERSHELL` are supported. The default value is `SHELL`. +* `default_parameters` - (Optional, String) The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {&#39;varA&#39;: &#39;222&#39;}.`key` is the name of the custom parameter and value is the default value. Both `key` and `value` are strings.If no parameter value is provided in the `InvokeCommand` API, the default value is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_]. +* `description` - (Optional, String) Command description. The maximum length is 120 characters. +* `enable_parameter` - (Optional, Bool) Whether to enable the custom parameter feature.This cannot be modified once created.Default value: `false`. +* `output_cos_bucket_url` - (Optional, String) The COS bucket URL for uploading logs. The URL must start with `https`, such as `https://BucketName-123454321.cos.ap-beijing.myqcloud.com`. +* `output_cos_key_prefix` - (Optional, String) The COS bucket directory where the logs are saved. Check below for the rules of the directory name.1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.2. Use a slash (/) to create a subdirectory.3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/). +* `tags` - (Optional, List) Tags bound to the command. At most 10 tags are allowed. +* `timeout` - (Optional, Int) Command timeout period. Default value: 60 seconds. Value range: [1, 86400]. +* `username` - (Optional, String) The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows. +* `working_directory` - (Optional, String) Command execution path. The default value is /root for `SHELL` commands and C:/Program Files/qcloudtat_agent/workdir for `POWERSHELL` commands. + +The `tags` object supports the following: + +* `key` - (Required, String) Tag key. +* `value` - (Required, String) Tag value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `created_by` - Command creator. `TAT` indicates a public command and `USER` indicates a personal command. +* `created_time` - Command creation time. +* `formatted_description` - Formatted description of the command. This parameter is an empty string for user commands and contains values for public commands. +* `updated_time` - Command update time. + + +## Import + +tat command can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tat_command.command cmd-6fydo27j +``` + diff --git a/config/docs/r/tat_invocation_command_attachment.html.markdown b/config/docs/r/tat_invocation_command_attachment.html.markdown new file mode 100644 index 0000000..01c83a1 --- /dev/null +++ b/config/docs/r/tat_invocation_command_attachment.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "TencentCloud Automation Tools(TAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tat_invocation_command_attachment" +sidebar_current: "docs-tencentcloud-resource-tat_invocation_command_attachment" +description: |- + Provides a resource to create a tat invocation_command_attachment +--- + +# tencentcloud_tat_invocation_command_attachment + +Provides a resource to create a tat invocation_command_attachment + +## Example Usage + +```hcl +resource "tencentcloud_tat_invocation_command_attachment" "invocation_command_attachment" { + content = base64encode("pwd") + instance_id = "ins-881b1c8w" + command_name = "terraform-test" + description = "shell test" + command_type = "SHELL" + working_directory = "/root" + timeout = 100 + save_command = false + enable_parameter = false + # default_parameters = "{\"varA\": \"222\"}" + # parameters = "{\"varA\": \"222\"}" + username = "root" + output_cos_bucket_url = "https://BucketName-123454321.cos.ap-beijing.myqcloud.com" + output_cos_key_prefix = "log" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `content` - (Required, String, ForceNew) Base64-encoded command. The maximum length is 64 KB. +* `instance_id` - (Required, String, ForceNew) ID of instances about to execute commands. Supported instance types: CVM LIGHTHOUSE. +* `command_name` - (Optional, String, ForceNew) Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.]. +* `command_type` - (Optional, String, ForceNew) Command type. SHELL and POWERSHELL are supported. The default value is SHELL. +* `default_parameters` - (Optional, String, ForceNew) The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {varA: 222}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If Parameters is not provided, the default values specified here are used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_]. +* `description` - (Optional, String, ForceNew) Command description. The maximum length is 120 characters. +* `enable_parameter` - (Optional, Bool, ForceNew) Whether to enable the custom parameter feature.This cannot be modified once created.Default value: false. +* `output_cos_bucket_url` - (Optional, String, ForceNew) The COS bucket URL for uploading logs; The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com. +* `output_cos_key_prefix` - (Optional, String, ForceNew) The COS bucket directory where the logs are saved; Check below for the rules of the directory name: 1 It must be a combination of number, letters, and visible characters, Up to 60 characters are allowed; 2 Use a slash (/) to create a subdirectory; 3 can not be used as the folder name; It cannot start with a slash (/), and cannot contain consecutive slashes. +* `parameters` - (Optional, String, ForceNew) Custom parameters of Command. The field type is JSON encoded string. For example, {varA: 222}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided, the DefaultParameters is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_]. +* `save_command` - (Optional, Bool, ForceNew) Whether to save the command. Valid values:rue: SaveFalse:Do not saveThe default value is False. +* `timeout` - (Optional, Int, ForceNew) Command timeout period. Default value: 60 seconds. Value range: [1, 86400]. +* `username` - (Optional, String, ForceNew) The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the user root is used to execute commands on Linux and the user System is used on Windows. +* `working_directory` - (Optional, String, ForceNew) Command execution path. The default value is /root for SHELL commands and C:Program Filesqcloudtat_agentworkdir for POWERSHELL commands. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `command_id` - Command ID. + + diff --git a/config/docs/r/tat_invocation_invoke_attachment.html.markdown b/config/docs/r/tat_invocation_invoke_attachment.html.markdown new file mode 100644 index 0000000..3dad46b --- /dev/null +++ b/config/docs/r/tat_invocation_invoke_attachment.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "TencentCloud Automation Tools(TAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tat_invocation_invoke_attachment" +sidebar_current: "docs-tencentcloud-resource-tat_invocation_invoke_attachment" +description: |- + Provides a resource to create a tat invocation_invoke_attachment +--- + +# tencentcloud_tat_invocation_invoke_attachment + +Provides a resource to create a tat invocation_invoke_attachment + +## Example Usage + +```hcl +resource "tencentcloud_tat_invocation_invoke_attachment" "invocation_invoke_attachment" { + instance_id = "ins-881b1c8w" + working_directory = "/root" + timeout = 100 + # parameters = "{\"varA\": \"222\"}" + username = "root" + output_cos_bucket_url = "https://BucketName-123454321.cos.ap-beijing.myqcloud.com" + output_cos_key_prefix = "log" + command_id = "cmd-rxbs7f5z" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `command_id` - (Required, String, ForceNew) Command ID. +* `instance_id` - (Required, String, ForceNew) ID of instances about to execute commands. Supported instance types: CVM LIGHTHOUSE. +* `output_cos_bucket_url` - (Optional, String, ForceNew) The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com. +* `output_cos_key_prefix` - (Optional, String, ForceNew) The COS bucket directory where the logs are saved; Check below for the rules of the directory name: 1 It must be a combination of number, letters, and visible characters, Up to 60 characters are allowed; 2 Use a slash (/) to create a subdirectory; 3 can not be used as the folder name; It cannot start with a slash (/), and cannot contain consecutive slashes. +* `parameters` - (Optional, String, ForceNew) Custom parameters of Command. The field type is JSON encoded string. For example, {varA: 222}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If no parameter value is provided, the DefaultParameters is used.Up to 20 custom parameters are supported.The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_]. +* `timeout` - (Optional, Int, ForceNew) Command timeout period. Default value: 60 seconds. Value range: [1, 86400]. +* `username` - (Optional, String, ForceNew) The username used to execute the command on the CVM or Lighthouse instance.The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the user root is used to execute commands on Linux and the user System is used on Windows. +* `working_directory` - (Optional, String, ForceNew) Command execution path. The default value is /root for SHELL commands and C:Program Filesqcloudtat_agentworkdir for POWERSHELL commands. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tat invocation can be imported using the invocation_id#instance_id, e.g. + +``` +terraform import tencentcloud_tat_invocation_invoke_attachment.invocation_invoke_attachment inv-mhs6ca8z#ins-881b1c8w +``` + diff --git a/config/docs/r/tat_invoker.html.markdown b/config/docs/r/tat_invoker.html.markdown new file mode 100644 index 0000000..5acd5a8 --- /dev/null +++ b/config/docs/r/tat_invoker.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "TencentCloud Automation Tools(TAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tat_invoker" +sidebar_current: "docs-tencentcloud-resource-tat_invoker" +description: |- + Provides a resource to create a tat invoker +--- + +# tencentcloud_tat_invoker + +Provides a resource to create a tat invoker + +## Example Usage + +```hcl +resource "tencentcloud_tat_invoker" "invoker" { + name = "pwd-1" + type = "SCHEDULE" + command_id = "cmd-6fydo27j" + instance_ids = ["ins-3c7q2ebs", ] + username = "root" + # parameters = "" + schedule_settings { + policy = "ONCE" + # recurrence = "" + invoke_time = "2099-11-17T16:00:00Z" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `command_id` - (Required, String) Remote command ID. +* `instance_ids` - (Required, Set: [`String`]) ID of the instance bound to the trigger. Up to 100 IDs are allowed. +* `name` - (Required, String) Invoker name. +* `type` - (Required, String) Invoker type. It can only be `SCHEDULE` (recurring invokers). +* `parameters` - (Optional, String) Custom parameters of the command. +* `schedule_settings` - (Optional, List) Settings required for a recurring invoker. +* `username` - (Optional, String) The user who executes the command. + +The `schedule_settings` object supports the following: + +* `policy` - (Required, String) Execution policy: `ONCE`: Execute once; `RECURRENCE`: Execute repeatedly. +* `invoke_time` - (Optional, String) The next execution time of the invoker. This field is required if Policy is ONCE. +* `recurrence` - (Optional, String) Trigger the crontab expression. This field is required if `Policy` is `RECURRENCE`. The crontab expression is parsed in UTC+8. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `created_time` - Creation time. +* `enable` - Whether to enable the invoker. +* `invoker_id` - Invoker ID. +* `updated_time` - Modification time. + + +## Import + +tat invoker can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tat_invoker.invoker ivk-gwb4ztk5 +``` + diff --git a/config/docs/r/tat_invoker_config.html.markdown b/config/docs/r/tat_invoker_config.html.markdown new file mode 100644 index 0000000..05871bc --- /dev/null +++ b/config/docs/r/tat_invoker_config.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TencentCloud Automation Tools(TAT)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tat_invoker_config" +sidebar_current: "docs-tencentcloud-resource-tat_invoker_config" +description: |- + Provides a resource to create a tat invoker_config +--- + +# tencentcloud_tat_invoker_config + +Provides a resource to create a tat invoker_config + +## Example Usage + +```hcl +resource "tencentcloud_tat_invoker_config" "invoker_config" { + invoker_id = "ivk-cas4upyf" + invoker_status = "on" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `invoker_id` - (Required, String) ID of the invoker to be enabled. +* `invoker_status` - (Required, String) Invoker on and off state, Values: `on`, `off`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tat invoker_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_tat_invoker_config.invoker_config invoker_config_id +``` + diff --git a/config/docs/r/tcaplus_cluster.html.markdown b/config/docs/r/tcaplus_cluster.html.markdown new file mode 100644 index 0000000..52960ce --- /dev/null +++ b/config/docs/r/tcaplus_cluster.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "TcaplusDB" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcaplus_cluster" +sidebar_current: "docs-tencentcloud-resource-tcaplus_cluster" +description: |- + Use this resource to create TcaplusDB cluster. +--- + +# tencentcloud_tcaplus_cluster + +Use this resource to create TcaplusDB cluster. + +~> **NOTE:** TcaplusDB now only supports the following regions: `ap-shanghai,ap-hongkong,na-siliconvalley,ap-singapore,ap-seoul,ap-tokyo,eu-frankfurt, and na-ashburn`. + +## Example Usage + +### Create a new tcaplus cluster instance + +```hcl +locals { + vpc_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.vpc_id + subnet_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.subnet_id +} + +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +data "tencentcloud_vpc_subnets" "vpc" { + is_default = true + availability_zone = var.availability_zone +} + +resource "tencentcloud_tcaplus_cluster" "example" { + idl_type = "PROTO" + cluster_name = "tf_example_tcaplus_cluster" + vpc_id = local.vpc_id + subnet_id = local.subnet_id + password = "your_pw_123111" + old_password_expire_last = 3600 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_name` - (Required, String) Name of the TcaplusDB cluster. Name length should be between 1 and 30. +* `idl_type` - (Required, String, ForceNew) IDL type of the TcaplusDB cluster. Valid values: `PROTO` and `TDR`. +* `password` - (Required, String) Password of the TcaplusDB cluster. Password length should be between 12 and 16. The password must be a *mix* of uppercase letters (A-Z), lowercase *letters* (a-z) and *numbers* (0-9). +* `subnet_id` - (Required, String, ForceNew) Subnet id of the TcaplusDB cluster. +* `vpc_id` - (Required, String, ForceNew) VPC id of the TcaplusDB cluster. +* `old_password_expire_last` - (Optional, Int) Expiration time of old password after password update, unit: second. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `api_access_id` - Access ID of the TcaplusDB cluster.For TcaplusDB SDK connect. +* `api_access_ip` - Access IP of the TcaplusDB cluster.For TcaplusDB SDK connect. +* `api_access_port` - Access port of the TcaplusDB cluster.For TcaplusDB SDK connect. +* `create_time` - Create time of the TcaplusDB cluster. +* `network_type` - Network type of the TcaplusDB cluster. +* `old_password_expire_time` - Expiration time of the old password. If `password_status` is `unmodifiable`, it means the old password has not yet expired. +* `password_status` - Password status of the TcaplusDB cluster. Valid values: `unmodifiable`, `modifiable`. `unmodifiable`. which means the password can not be changed in this moment; `modifiable`, which means the password can be changed in this moment. + + +## Import + +tcaplus cluster can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_tcaplus_cluster.example cluster_id +``` + diff --git a/config/docs/r/tcaplus_idl.html.markdown b/config/docs/r/tcaplus_idl.html.markdown new file mode 100644 index 0000000..3f5f28d --- /dev/null +++ b/config/docs/r/tcaplus_idl.html.markdown @@ -0,0 +1,110 @@ +--- +subcategory: "TcaplusDB" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcaplus_idl" +sidebar_current: "docs-tencentcloud-resource-tcaplus_idl" +description: |- + Use this resource to create TcaplusDB IDL file. +--- + +# tencentcloud_tcaplus_idl + +Use this resource to create TcaplusDB IDL file. + +## Example Usage + +### Create a tcaplus database idl file + +The file will be with a specified cluster and tablegroup. + +```hcl +locals { + vpc_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.vpc_id + subnet_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.subnet_id +} + +variable "availability_zone" { + default = "ap-guangzhou-3" +} + +data "tencentcloud_vpc_subnets" "vpc" { + is_default = true + availability_zone = var.availability_zone +} + +resource "tencentcloud_tcaplus_cluster" "example" { + idl_type = "PROTO" + cluster_name = "tf_example_tcaplus_cluster" + vpc_id = local.vpc_id + subnet_id = local.subnet_id + password = "your_pw_123111" + old_password_expire_last = 3600 +} + +resource "tencentcloud_tcaplus_tablegroup" "example" { + cluster_id = tencentcloud_tcaplus_cluster.example.id + tablegroup_name = "tf_example_group_name" +} + +resource "tencentcloud_tcaplus_idl" "main" { + cluster_id = tencentcloud_tcaplus_cluster.example.id + tablegroup_id = tencentcloud_tcaplus_tablegroup.example.id + file_name = "tf_example_tcaplus_idl" + file_type = "PROTO" + file_ext_type = "proto" + file_content = < **NOTE:** Instructions for use: 1. Use Tencent Cloud Prometheus to monitor TMP, please enter `vpc_id`, `subnet_id`, `region` or `instance_id`, it is recommended to use an existing tmp instance; 2. To use the third-party Prometheus service, please enter `custom_prom`; 3. `tencentcloud_tcm_prometheus_attachment` does not support modification; 4. If you use Tencent Cloud Prometheus to monitor TMP, enter `vpc_id`, `subnet_id`, `region` to create a new Prometheus monitoring instance, destroy will not destroy the Prometheus monitoring instance +~> **NOTE:** If you use the config attribute prometheus in tencentcloud_tcm_mesh, do not use tencentcloud_tcm_prometheus_attachment + +## Example Usage + +```hcl +resource "tencentcloud_tcm_prometheus_attachment" "prometheus_attachment" { + mesh_id = "mesh-rofjmxxx" + prometheus { + vpc_id = "vpc-pewdpxxx" + subnet_id = "subnet-driddxxx" + region = "ap-guangzhou" + instance_id = "" + # custom_prom { + # is_public_addr = false + # vpc_id = "vpc-pewdpxxx" + # url = "http://10.0.0.1:9090" + # auth_type = "basic" + # username = "test" + # password = "test" + # } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `mesh_id` - (Required, String, ForceNew) Mesh ID. +* `prometheus` - (Required, List, ForceNew) Prometheus configuration. + +The `custom_prom` object supports the following: + +* `auth_type` - (Required, String) Authentication type of the prometheus. +* `url` - (Required, String) Url of the prometheus. +* `is_public_addr` - (Optional, Bool) Whether it is public address, default false. +* `password` - (Optional, String) Password of the prometheus, used in basic authentication type. +* `username` - (Optional, String) Username of the prometheus, used in basic authentication type. +* `vpc_id` - (Optional, String) Vpc id. + +The `prometheus` object supports the following: + +* `custom_prom` - (Optional, List) Third party prometheus. +* `instance_id` - (Optional, String) Existed TMP id, auto create TMP if empty. +* `region` - (Optional, String) Region for TMP. +* `subnet_id` - (Optional, String) Subnet id for TMP. +* `vpc_id` - (Optional, String) Vpc id for TMP. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tcm prometheus_attachment can be imported using the mesh_id, e.g. +``` +$ terraform import tencentcloud_tcm_prometheus_attachment.prometheus_attachment mesh-rofjmxxx +``` + diff --git a/config/docs/r/tcm_tracing_config.html.markdown b/config/docs/r/tcm_tracing_config.html.markdown new file mode 100644 index 0000000..003602d --- /dev/null +++ b/config/docs/r/tcm_tracing_config.html.markdown @@ -0,0 +1,82 @@ +--- +subcategory: "TencentCloud ServiceMesh(TCM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcm_tracing_config" +sidebar_current: "docs-tencentcloud-resource-tcm_tracing_config" +description: |- + Provides a resource to create a tcm tracing_config +--- + +# tencentcloud_tcm_tracing_config + +Provides a resource to create a tcm tracing_config + +~> **NOTE:** If you use the config attribute tracing in tencentcloud_tcm_mesh, do not use tencentcloud_tcm_tracing_config + +## Example Usage + +```hcl +resource "tencentcloud_tcm_tracing_config" "tracing_config" { + mesh_id = "mesh-xxxxxxxx" + enable = true + apm { + enable = true + region = "ap-guangzhou" + instance_id = "apm-xxx" + } + sampling = + zipkin { + address = "10.10.10.10:9411" + } +} + +resource "tencentcloud_tcm_tracing_config" "delete_config" { + mesh_id = "mesh-rofjmxxx" + enable = true + apm { + enable = false + # region = "ap-guangzhou" + # instance_id = "apm-xxx" + } + sampling = 0 + zipkin { + address = "" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `mesh_id` - (Required, String) Mesh ID. +* `apm` - (Optional, List) APM config. +* `enable` - (Optional, Bool) Whether enable tracing. +* `sampling` - (Optional, Float64) Tracing sampling, 0.0-1.0. +* `zipkin` - (Optional, List) Third party zipkin config. + +The `apm` object supports the following: + +* `enable` - (Optional, Bool) Whether enable APM. +* `instance_id` - (Optional, String) Instance id of the APM. +* `region` - (Optional, String) Region. + +The `zipkin` object supports the following: + +* `address` - (Required, String) Zipkin address. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tcm tracing_config can be imported using the mesh_id, e.g. +``` +$ terraform import tencentcloud_tcm_tracing_config.tracing_config mesh-rofjmxxx +``` + diff --git a/config/docs/r/tcmq_queue.html.markdown b/config/docs/r/tcmq_queue.html.markdown new file mode 100644 index 0000000..e043a7c --- /dev/null +++ b/config/docs/r/tcmq_queue.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "TDMQ for CMQ" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcmq_queue" +sidebar_current: "docs-tencentcloud-resource-tcmq_queue" +description: |- + Provides a resource to create a tcmq queue +--- + +# tencentcloud_tcmq_queue + +Provides a resource to create a tcmq queue + +## Example Usage + +```hcl +resource "tencentcloud_tcmq_queue" "queue" { + queue_name = "queue_name" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `queue_name` - (Required, String) Queue name, which must be unique under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter. +* `dead_letter_queue_name` - (Optional, String) Dead letter queue name. +* `first_query_interval` - (Optional, Int) First lookback interval. +* `max_msg_heap_num` - (Optional, Int) Maximum number of heaped messages. The value range is 1,000,000-10,000,000 during the beta test and can be 1,000,000-1,000,000,000 after the product is officially released. The default value is 10,000,000 during the beta test and will be 100,000,000 after the product is officially released. +* `max_msg_size` - (Optional, Int) Maximum message length. Value range: 1024-65536 bytes (i.e., 1-64 KB). Default value: 65536. +* `max_query_count` - (Optional, Int) Maximum number of lookbacks. +* `max_receive_count` - (Optional, Int) Maximum receipt times. Value range: 1-1000. +* `max_time_to_live` - (Optional, Int) Maximum period in seconds before an unconsumed message expires, which is required if `policy` is 1. Value range: 300-43200. This value should be smaller than `msgRetentionSeconds` (maximum message retention period). +* `msg_retention_seconds` - (Optional, Int) The max period during which a message is retained before it is automatically acknowledged. Value range: 30-43,200 seconds (30 seconds to 12 hours). Default value: 3600 seconds (1 hour). +* `policy` - (Optional, Int) Dead letter policy. 0: message has been consumed multiple times but not deleted; 1: `Time-To-Live` has elapsed. +* `polling_wait_seconds` - (Optional, Int) Long polling wait time for message reception. Value range: 0-30 seconds. Default value: 0. +* `retention_size_in_mb` - (Optional, Int) Queue storage space configured for message rewind. Value range: 10,240-512,000 MB (if message rewind is enabled). The value `0` indicates that message rewind is not enabled. +* `rewind_seconds` - (Optional, Int) Rewindable time of messages in the queue. Value range: 0-1,296,000s (if message rewind is enabled). The value `0` indicates that message rewind is not enabled. +* `trace` - (Optional, Bool) Whether to enable message trace. true: yes; false: no. If this field is not configured, the feature will not be enabled. +* `transaction` - (Optional, Int) 1: transaction queue; 0: general queue. +* `visibility_timeout` - (Optional, Int) Message visibility timeout period. Value range: 1-43200 seconds (i.e., 12 hours). Default value: 30. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tcmq queue can be imported using the id, e.g. + +``` +terraform import tencentcloud_tcmq_queue.queue queue_id +``` + diff --git a/config/docs/r/tcmq_subscribe.html.markdown b/config/docs/r/tcmq_subscribe.html.markdown new file mode 100644 index 0000000..2bc48e9 --- /dev/null +++ b/config/docs/r/tcmq_subscribe.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "TDMQ for CMQ" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcmq_subscribe" +sidebar_current: "docs-tencentcloud-resource-tcmq_subscribe" +description: |- + Provides a resource to create a tcmq subscribe +--- + +# tencentcloud_tcmq_subscribe + +Provides a resource to create a tcmq subscribe + +## Example Usage + +```hcl +resource "tencentcloud_tcmq_subscribe" "subscribe" { + topic_name = "topic_name" + subscription_name = "subscription_name" + protocol = "http" + endpoint = "http://xxxxxx" ; +} +``` + +## Argument Reference + +The following arguments are supported: + +* `endpoint` - (Required, String) `Endpoint` for notification receipt, which is distinguished by `Protocol`. For `http`, `Endpoint` must begin with `http://` and `host` can be a domain name or IP. For `Queue`, enter `QueueName`. Note that currently the push service cannot push messages to a VPC; therefore, if a VPC domain name or address is entered for `Endpoint`, pushed messages will not be received. Currently, messages can be pushed only to the public network and classic network. +* `protocol` - (Required, String) ubscription protocol. Currently, two protocols are supported: `http` and `queue`. To use the `http` protocol, you need to build your own web server to receive messages. With the `queue` protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently. +* `subscription_name` - (Required, String) Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter. +* `topic_name` - (Required, String) Topic name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter. +* `binding_key` - (Optional, Set: [`String`]) The number of `BindingKey` cannot exceed 5, and the length of each `BindingKey` cannot exceed 64 bytes. This field indicates the filtering policy for subscribing to and receiving messages. Each `BindingKey` includes up to 15 dots (namely up to 16 segments). +* `filter_tags` - (Optional, Set: [`String`]) Message body tag (used for message filtering). The number of tags cannot exceed 5, and each tag can contain up to 16 characters. It is used in conjunction with the `MsgTag` parameter of `(Batch)PublishMessage`. Rules: 1. If `FilterTag` is not configured, no matter whether `MsgTag` is configured, the subscription will receive all messages published to the topic; 2. If the array of `FilterTag` values has a value, only when at least one of the values in the array also exists in the array of `MsgTag` values (i.e., `FilterTag` and `MsgTag` have an intersection) can the subscription receive messages published to the topic; 3. If the array of `FilterTag` values has a value, but `MsgTag` is not configured, then no message published to the topic will be received, which can be considered as a special case of rule 2 as `FilterTag` and `MsgTag` do not intersect in this case. The overall design idea of rules is based on the intention of the subscriber. +* `notify_content_format` - (Optional, String) Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If `Protocol` is `queue`, this value must be `SIMPLIFIED`. If `Protocol` is `http`, both options are acceptable, and the default value is `JSON`. +* `notify_strategy` - (Optional, String) CMQ push server retry policy in case an error occurs while pushing a message to `Endpoint`. Valid values: 1. `BACKOFF_RETRY`: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message; 2. `EXPONENTIAL_DECAY_RETRY`: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: `EXPONENTIAL_DECAY_RETRY`. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tcmq subscribe can be imported using the id, e.g. + +``` +terraform import tencentcloud_tcmq_subscribe.subscribe subscribe_id +``` + diff --git a/config/docs/r/tcmq_topic.html.markdown b/config/docs/r/tcmq_topic.html.markdown new file mode 100644 index 0000000..5794157 --- /dev/null +++ b/config/docs/r/tcmq_topic.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TDMQ for CMQ" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcmq_topic" +sidebar_current: "docs-tencentcloud-resource-tcmq_topic" +description: |- + Provides a resource to create a tcmq topic +--- + +# tencentcloud_tcmq_topic + +Provides a resource to create a tcmq topic + +## Example Usage + +```hcl +resource "tencentcloud_tcmq_topic" "topic" { + topic_name = "topic_name" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `topic_name` - (Required, String) Topic name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter. +* `filter_type` - (Optional, Int) Used to specify the message match policy for the topic. `1`: tag match policy (default value); `2`: routing match policy. +* `max_msg_size` - (Optional, Int) Maximum message length. Value range: 1024-65536 bytes (i.e., 1-64 KB). Default value: 65536. +* `msg_retention_seconds` - (Optional, Int) Message retention period. Value range: 60-86400 seconds (i.e., 1 minute-1 day). Default value: 86400. +* `trace` - (Optional, Bool) Whether to enable message trace. true: yes; false: no. If this field is left empty, the feature will not be enabled. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tcmq topic can be imported using the id, e.g. + +``` +terraform import tencentcloud_tcmq_topic.topic topic_id +``` + diff --git a/config/docs/r/tcr_create_image_signature_operation.html.markdown b/config/docs/r/tcr_create_image_signature_operation.html.markdown new file mode 100644 index 0000000..9e8fe86 --- /dev/null +++ b/config/docs/r/tcr_create_image_signature_operation.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_create_image_signature_operation" +sidebar_current: "docs-tencentcloud-resource-tcr_create_image_signature_operation" +description: |- + Provides a resource to operate a tcr image signature. +--- + +# tencentcloud_tcr_create_image_signature_operation + +Provides a resource to operate a tcr image signature. + +## Example Usage + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "premium" + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tcr_namespace" "example" { + instance_id = tencentcloud_tcr_instance.example.id + name = "tf_example_ns" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "cve-xxxxx" + } +} + +resource "tencentcloud_tcr_repository" "example" { + instance_id = tencentcloud_tcr_instance.example.id + namespace_name = tencentcloud_tcr_namespace.example.name + name = "test" + brief_desc = "111" + description = "111111111111111111111111111111111111" +} + +resource "tencentcloud_tcr_create_image_signature_operation" "example" { + registry_id = tencentcloud_tcr_instance.example.id + namespace_name = tencentcloud_tcr_namespace.example.name + repository_name = tencentcloud_tcr_repository.example.name + image_version = "v1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `image_version` - (Required, String, ForceNew) image version name. +* `namespace_name` - (Required, String, ForceNew) namespace name. +* `registry_id` - (Required, String, ForceNew) instance id. +* `repository_name` - (Required, String, ForceNew) repository name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tcr image_signature_operation can be imported using the id, e.g. + +``` +terraform import tencentcloud_tcr_create_image_signature_operation.image_signature_operation image_signature_operation_id +``` + diff --git a/config/docs/r/tcr_customized_domain.html.markdown b/config/docs/r/tcr_customized_domain.html.markdown new file mode 100644 index 0000000..31b037e --- /dev/null +++ b/config/docs/r/tcr_customized_domain.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_customized_domain" +sidebar_current: "docs-tencentcloud-resource-tcr_customized_domain" +description: |- + Provides a resource to create a tcr customized domain +--- + +# tencentcloud_tcr_customized_domain + +Provides a resource to create a tcr customized domain + +## Example Usage + +### Create a tcr customized domain + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "premium" + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tcr_customized_domain" "example" { + registry_id = tencentcloud_tcr_instance.example.id + domain_name = "www.test.com" + certificate_id = "your_cert_id" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `certificate_id` - (Required, String, ForceNew) certificate id. +* `domain_name` - (Required, String, ForceNew) custom domain name. +* `registry_id` - (Required, String, ForceNew) instance id. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tcr customized_domain can be imported using the id, e.g. + +``` +terraform import tencentcloud_tcr_customized_domain.customized_domain customized_domain_id +``` + diff --git a/config/docs/r/tcr_delete_image_operation.html.markdown b/config/docs/r/tcr_delete_image_operation.html.markdown new file mode 100644 index 0000000..0cf02cf --- /dev/null +++ b/config/docs/r/tcr_delete_image_operation.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_delete_image_operation" +sidebar_current: "docs-tencentcloud-resource-tcr_delete_image_operation" +description: |- + Provides a resource to delete the specified tcr image. +--- + +# tencentcloud_tcr_delete_image_operation + +Provides a resource to delete the specified tcr image. + +## Example Usage + +### To delete the specified image + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "premium" + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tcr_namespace" "example" { + instance_id = tencentcloud_tcr_instance.example.id + name = "tf_example_ns" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "cve-xxxxx" + } +} + +resource "tencentcloud_tcr_delete_image_operation" "example" { + registry_id = tencentcloud_tcr_instance.example.id + repository_name = "repo" + image_version = "v1" # the image want to delete + namespace_name = tencentcloud_tcr_namespace.example.name +} +``` + +## Argument Reference + +The following arguments are supported: + +* `image_version` - (Required, String, ForceNew) image version name. +* `namespace_name` - (Required, String, ForceNew) namespace name. +* `registry_id` - (Required, String, ForceNew) instance id. +* `repository_name` - (Required, String, ForceNew) repository name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tcr_immutable_tag_rule.html.markdown b/config/docs/r/tcr_immutable_tag_rule.html.markdown new file mode 100644 index 0000000..d428f58 --- /dev/null +++ b/config/docs/r/tcr_immutable_tag_rule.html.markdown @@ -0,0 +1,138 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_immutable_tag_rule" +sidebar_current: "docs-tencentcloud-resource-tcr_immutable_tag_rule" +description: |- + Provides a resource to create a tcr immutable tag rule. +--- + +# tencentcloud_tcr_immutable_tag_rule + +Provides a resource to create a tcr immutable tag rule. + +## Example Usage + +### Create a immutable tag rule with specified tags and exclude specified repositories + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "premium" + delete_bucket = true +} + +resource "tencentcloud_tcr_namespace" "example" { + instance_id = tencentcloud_tcr_instance.example.id + name = "tf_example_ns" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "cve-xxxxx" + } +} + +resource "tencentcloud_tcr_immutable_tag_rule" "example" { + registry_id = tencentcloud_tcr_instance.example.id + namespace_name = tencentcloud_tcr_namespace.example.name + rule { + repository_pattern = "deprecated_repo" # specify exclude repo + tag_pattern = "**" # all tags + repository_decoration = "repoExcludes" + tag_decoration = "matches" + disabled = false + } + tags = { + "createdBy" = "terraform" + } +} +``` + +### With specified repositories and exclude specified version tag + +```hcl +resource "tencentcloud_tcr_immutable_tag_rule" "example" { + registry_id = tencentcloud_tcr_instance.example.id + namespace_name = tencentcloud_tcr_namespace.example.name + rule { + repository_pattern = "**" # all repo + tag_pattern = "v1" # exlude v1 tags + repository_decoration = "repoMatches" + tag_decoration = "excludes" + disabled = false + } + tags = { + "createdBy" = "terraform" + } +} +``` + +### Disabled the specified rule + +```hcl +resource "tencentcloud_tcr_immutable_tag_rule" "example_rule_A" { + registry_id = tencentcloud_tcr_instance.example.id + namespace_name = tencentcloud_tcr_namespace.example.name + rule { + repository_pattern = "deprecated_repo" # specify exclude repo + tag_pattern = "**" # all tags + repository_decoration = "repoExcludes" + tag_decoration = "matches" + disabled = false + } + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tcr_immutable_tag_rule" "example_rule_B" { + registry_id = tencentcloud_tcr_instance.example.id + namespace_name = tencentcloud_tcr_namespace.example.name + rule { + repository_pattern = "**" # all repo + tag_pattern = "v1" # exlude v1 tags + repository_decoration = "repoMatches" + tag_decoration = "excludes" + disabled = true # disable it + } + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `namespace_name` - (Required, String) namespace name. +* `registry_id` - (Required, String) instance id. +* `rule` - (Required, List) rule. +* `tags` - (Optional, Map) Tag description list. + +The `rule` object supports the following: + +* `repository_decoration` - (Required, String) repository decoration type:repoMatches or repoExcludes. +* `repository_pattern` - (Required, String) repository matching rules. +* `tag_decoration` - (Required, String) tag decoration type: matches or excludes. +* `tag_pattern` - (Required, String) tag matching rules. +* `disabled` - (Optional, Bool) disable rule. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tcr immutable_tag_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_tcr_immutable_tag_rule.immutable_tag_rule immutable_tag_rule_id +``` + diff --git a/config/docs/r/tcr_instance.html.markdown b/config/docs/r/tcr_instance.html.markdown new file mode 100644 index 0000000..9a2f3bf --- /dev/null +++ b/config/docs/r/tcr_instance.html.markdown @@ -0,0 +1,127 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_instance" +sidebar_current: "docs-tencentcloud-resource-tcr_instance" +description: |- + Use this resource to create tcr instance. +--- + +# tencentcloud_tcr_instance + +Use this resource to create tcr instance. + +## Example Usage + +### Create a basic tcr instance. + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "basic" + + tags = { + "createdBy" = "terraform" + } +} +``` + +### Create instance with the public network access whitelist. + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "basic" + open_public_operation = true + security_policy { + cidr_block = "10.0.0.1/24" + } + security_policy { + cidr_block = "192.168.1.1" + } +} +``` + +### Create instance with Replications. + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "premium" + replications { + region_id = var.tcr_region_map["ap-guangzhou"] # 1 + } + replications { + region_id = var.tcr_region_map["ap-singapore"] # 9 + } +} + +variable "tcr_region_map" { + default = { + "ap-guangzhou" = 1 + "ap-shanghai" = 4 + "ap-hongkong" = 5 + "ap-beijing" = 8 + "ap-singapore" = 9 + "na-siliconvalley" = 15 + "ap-chengdu" = 16 + "eu-frankfurt" = 17 + "ap-seoul" = 18 + "ap-chongqing" = 19 + "ap-mumbai" = 21 + "na-ashburn" = 22 + "ap-bangkok" = 23 + "eu-moscow" = 24 + "ap-tokyo" = 25 + "ap-nanjing" = 33 + "ap-taipei" = 39 + "ap-jakarta" = 72 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_type` - (Required, String) TCR types. Valid values are: `standard`, `basic`, `premium`. +* `name` - (Required, String, ForceNew) Name of the TCR instance. +* `delete_bucket` - (Optional, Bool) Indicate to delete the COS bucket which is auto-created with the instance or not. +* `instance_charge_type_prepaid_period` - (Optional, Int) Length of time to purchase an instance (in month). Must set when registry_charge_type is prepaid. +* `instance_charge_type_prepaid_renew_flag` - (Optional, Int) Auto renewal flag. 1: manual renewal, 2: automatic renewal, 3: no renewal and no notification. Must set when registry_charge_type is prepaid. +* `open_public_operation` - (Optional, Bool) Control public network access. +* `registry_charge_type` - (Optional, Int) Charge type of instance. 1: postpaid; 2: prepaid. Default is postpaid. +* `replications` - (Optional, List) Specify List of instance Replications, premium only. The available [source region list](https://www.tencentcloud.com/document/api/1051/41101) is here. +* `security_policy` - (Optional, Set) Public network access allowlist policies of the TCR instance. Only available when `open_public_operation` is `true`. +* `tags` - (Optional, Map) The available tags within this TCR instance. + +The `replications` object supports the following: + +* `region_id` - (Optional, Int) Replication region ID, check the example at the top of page to find out id of region. +* `syn_tag` - (Optional, Bool) Specify whether to sync TCR cloud tags to COS Bucket. NOTE: You have to specify when adding, modifying will be ignored for now. + +The `security_policy` object supports the following: + +* `cidr_block` - (Optional, String) The public network IP address of the access source. +* `description` - (Optional, String) Remarks of policy. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `expired_at` - Instance expiration time (prepaid). +* `internal_end_point` - Internal address for access of the TCR instance. +* `public_domain` - Public address for access of the TCR instance. +* `public_status` - Status of the TCR instance public network access. +* `status` - Status of the TCR instance. + + +## Import + +tcr instance can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_tcr_instance.foo instance_id +``` + diff --git a/config/docs/r/tcr_manage_replication_operation.html.markdown b/config/docs/r/tcr_manage_replication_operation.html.markdown new file mode 100644 index 0000000..a99a9d2 --- /dev/null +++ b/config/docs/r/tcr_manage_replication_operation.html.markdown @@ -0,0 +1,163 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_manage_replication_operation" +sidebar_current: "docs-tencentcloud-resource-tcr_manage_replication_operation" +description: |- + Provides a resource to start a tcr instance replication operation +--- + +# tencentcloud_tcr_manage_replication_operation + +Provides a resource to start a tcr instance replication operation + +## Example Usage + +### Sync source tcr instance to target instance + +Synchronize an existing tcr instance to the destination instance. This operation is often used in the cross-multiple region scenario. +Assume you have had two TCR instances before this operation. This example shows how to sync a tcr instance from ap-guangzhou(gz) to ap-shanghai(sh). + +```hcl +# tcr instance on ap-guangzhou +resource "tencentcloud_tcr_instance" "example_gz" { + name = "tf-example-tcr-gz" + instance_type = "premium" + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tcr_namespace" "example_gz" { + instance_id = tencentcloud_tcr_instance.example_gz.id + name = "tf_example_ns_gz" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "cve-xxxxx" + } +} + +# tcr instance on ap-shanghai +resource "tencentcloud_tcr_instance" "example_sh" { + name = "tf-example-tcr-sh" + instance_type = "premium" + delete_bucket = true +} + +resource "tencentcloud_tcr_namespace" "example_sh" { + instance_id = tencentcloud_tcr_instance.example_sh.id + name = "tf_example_ns_sh" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "cve-xxxxx" + } +} +``` + + + +```hcl +# Run this on region ap-guangzhou +locals { + src_id = tencentcloud_tcr_instance.example_gz.id + dest_id = tencentcloud_tcr_instance.example_sh.id + src_ns = tencentcloud_tcr_namespace.example_gz.name + dest_ns = tencentcloud_tcr_instance.example_sh.id +} + +variable "tcr_region_map" { + default = { + "ap-guangzhou" = 1 + "ap-shanghai" = 4 + "ap-hongkong" = 5 + "ap-beijing" = 8 + "ap-singapore" = 9 + "na-siliconvalley" = 15 + "ap-chengdu" = 16 + "eu-frankfurt" = 17 + "ap-seoul" = 18 + "ap-chongqing" = 19 + "ap-mumbai" = 21 + "na-ashburn" = 22 + "ap-bangkok" = 23 + "eu-moscow" = 24 + "ap-tokyo" = 25 + "ap-nanjing" = 33 + "ap-taipei" = 39 + "ap-jakarta" = 72 + } +} + +resource "tencentcloud_tcr_manage_replication_operation" "example_sync" { + source_registry_id = local.src_id + destination_registry_id = local.dest_id + rule { + name = "tf_example_sync_gz_to_sh" + dest_namespace = local.dest_ns + override = true + filters { + type = "name" + value = join("/", [local.src_ns, "**"]) + } + filters { + type = "tag" + value = "" + } + filters { + type = "resource" + value = "" + } + } + description = "example for tcr sync operation" + destination_region_id = var.tcr_region_map["ap-shanghai"] # 4 + peer_replication_option { + peer_registry_uin = "" + peer_registry_token = "" + enable_peer_replication = false + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `destination_registry_id` - (Required, String, ForceNew) copy destination instance Id. +* `rule` - (Required, List, ForceNew) synchronization rules. +* `source_registry_id` - (Required, String, ForceNew) copy source instance Id. +* `description` - (Optional, String, ForceNew) rule description. +* `destination_region_id` - (Optional, Int, ForceNew) the region ID of the target instance, such as Guangzhou is 1. +* `peer_replication_option` - (Optional, List, ForceNew) enable synchronization of configuration items across master account instances. + +The `filters` object supports the following: + +* `type` - (Required, String) type (name, tag, and resource). +* `value` - (Optional, String) empty by default. + +The `peer_replication_option` object supports the following: + +* `enable_peer_replication` - (Required, Bool) whether to enable cross-master account instance synchronization. +* `peer_registry_token` - (Required, String) access permanent token of the instance to be synchronized. +* `peer_registry_uin` - (Required, String) uin of the instance to be synchronized. + +The `rule` object supports the following: + +* `dest_namespace` - (Required, String) target namespace. +* `filters` - (Required, List) sync filters. +* `name` - (Required, String) synchronization rule names. +* `override` - (Required, Bool) whether to cover. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tcr_namespace.html.markdown b/config/docs/r/tcr_namespace.html.markdown new file mode 100644 index 0000000..23cfc43 --- /dev/null +++ b/config/docs/r/tcr_namespace.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_namespace" +sidebar_current: "docs-tencentcloud-resource-tcr_namespace" +description: |- + Use this resource to create tcr namespace. +--- + +# tencentcloud_tcr_namespace + +Use this resource to create tcr namespace. + +## Example Usage + +### Create a tcr namespace instance + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "premium" + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tcr_namespace" "example" { + instance_id = tencentcloud_tcr_instance.example.id + name = "example" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "cve-xxxxx" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of the TCR instance. +* `name` - (Required, String, ForceNew) Name of the TCR namespace. Valid length is [2~30]. It can only contain lowercase letters, numbers and separators (`.`, `_`, `-`), and cannot start, end or continue with separators. +* `cve_whitelist_items` - (Optional, List) Vulnerability Whitelist. +* `is_auto_scan` - (Optional, Bool) Scanning level, `True` is automatic, `False` is manual. Default is `false`. +* `is_prevent_vul` - (Optional, Bool) Blocking switch, `True` is open, `False` is closed. Default is `false`. +* `is_public` - (Optional, Bool) Indicate that the namespace is public or not. Default is `false`. +* `severity` - (Optional, String) Block vulnerability level, currently only supports `low`, `medium`, `high`. + +The `cve_whitelist_items` object supports the following: + +* `cve_id` - (Optional, String) Vulnerability Whitelist ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tcr namespace can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_tcr_namespace.example tcr_instance_id#namespace_name +``` + diff --git a/config/docs/r/tcr_repository.html.markdown b/config/docs/r/tcr_repository.html.markdown new file mode 100644 index 0000000..979f293 --- /dev/null +++ b/config/docs/r/tcr_repository.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_repository" +sidebar_current: "docs-tencentcloud-resource-tcr_repository" +description: |- + Use this resource to create tcr repository. +--- + +# tencentcloud_tcr_repository + +Use this resource to create tcr repository. + +## Example Usage + +### Create a tcr repository instance + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "premium" + delete_bucket = true +} + +resource "tencentcloud_tcr_namespace" "example" { + instance_id = tencentcloud_tcr_instance.example.id + name = "tf_example_ns" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "cve-xxxxx" + } +} + +resource "tencentcloud_tcr_repository" "example" { + instance_id = tencentcloud_tcr_instance.example.id + namespace_name = tencentcloud_tcr_namespace.example.name + name = "test" + brief_desc = "111" + description = "111111111111111111111111111111111111" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of the TCR instance. +* `name` - (Required, String, ForceNew) Name of the TCR repository. Valid length is [2~200]. It can only contain lowercase letters, numbers and separators (`.`, `_`, `-`, `/`), and cannot start, end or continue with separators. Support the use of multi-level address formats, such as `sub1/sub2/repo`. +* `namespace_name` - (Required, String, ForceNew) Name of the TCR namespace. +* `brief_desc` - (Optional, String) Brief description of the repository. Valid length is [1~100]. +* `description` - (Optional, String) Description of the repository. Valid length is [1~1000]. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time. +* `is_public` - Indicate the repository is public or not. +* `update_time` - Last updated time. +* `url` - URL of the repository. + + +## Import + +tcr repository can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_tcr_repository.foo instance_id#namespace_name#repository_name +``` + diff --git a/config/docs/r/tcr_service_account.html.markdown b/config/docs/r/tcr_service_account.html.markdown new file mode 100644 index 0000000..31fdca4 --- /dev/null +++ b/config/docs/r/tcr_service_account.html.markdown @@ -0,0 +1,108 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_service_account" +sidebar_current: "docs-tencentcloud-resource-tcr_service_account" +description: |- + Provides a resource to create a tcr service account. +--- + +# tencentcloud_tcr_service_account + +Provides a resource to create a tcr service account. + +## Example Usage + +### Create custom account with specified duration days + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr-instance" + instance_type = "basic" + delete_bucket = true + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tcr_namespace" "example" { + instance_id = tencentcloud_tcr_instance.example.id + name = "tf_test_tcr_namespace" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "tf_example_cve_id" + } +} + +resource "tencentcloud_tcr_service_account" "example" { + registry_id = tencentcloud_tcr_instance.example.id + name = "tf_example_account" + permissions { + resource = tencentcloud_tcr_namespace.example.name + actions = ["tcr:PushRepository", "tcr:PullRepository"] + } + description = "tf example for tcr custom account" + duration = 10 + disable = false + tags = { + "createdBy" = "terraform" + } +} +``` + +### With specified expiration time + +```hcl +resource "tencentcloud_tcr_service_account" "example" { + registry_id = tencentcloud_tcr_instance.example.id + name = "tf_example_account" + permissions { + resource = tencentcloud_tcr_namespace.example.name + actions = ["tcr:PushRepository", "tcr:PullRepository"] + } + description = "tf example for tcr custom account" + expires_at = 1676897989000 //time stamp + disable = false + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Service account name. +* `permissions` - (Required, List) strategy list. +* `registry_id` - (Required, String) instance id. +* `description` - (Optional, String) Service account description. +* `disable` - (Optional, Bool) whether to disable Service accounts. +* `duration` - (Optional, Int) expiration date (unit: day), calculated from the current time, priority is higher than ExpiresAt Service account description. +* `expires_at` - (Optional, Int) Service account expiration time (time stamp, unit: milliseconds). +* `tags` - (Optional, Map) Tag description list. + +The `permissions` object supports the following: + +* `actions` - (Required, Set) Actions, currently support: `tcr:PushRepository`, `tcr:PullRepository`, `tcr:CreateRepository`, `tcr:CreateHelmChart`, `tcr:DescribeHelmCharts`. Note: This field may return null, indicating that no valid value can be obtained. +* `resource` - (Required, String) resource path, currently only supports Namespace. Note: This field may return null, indicating that no valid value can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `password` - Password of the service account. + + +## Import + +tcr service_account can be imported using the id, e.g. + +``` +terraform import tencentcloud_tcr_service_account.service_account registry_id#account_name +``` + diff --git a/config/docs/r/tcr_tag_retention_execution_config.html.markdown b/config/docs/r/tcr_tag_retention_execution_config.html.markdown new file mode 100644 index 0000000..8f6c316 --- /dev/null +++ b/config/docs/r/tcr_tag_retention_execution_config.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_tag_retention_execution_config" +sidebar_current: "docs-tencentcloud-resource-tcr_tag_retention_execution_config" +description: |- + Provides a resource to configure a tcr tag retention execution. +--- + +# tencentcloud_tcr_tag_retention_execution_config + +Provides a resource to configure a tcr tag retention execution. + +## Example Usage + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "basic" + delete_bucket = true + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tcr_namespace" "example" { + instance_id = tencentcloud_tcr_instance.example.id + name = "tf_example_ns_retention" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "cve-xxxxx" + } +} + +resource "tencentcloud_tcr_tag_retention_rule" "example" { + registry_id = tencentcloud_tcr_instance.example.id + namespace_name = tencentcloud_tcr_namespace.example.name + retention_rule { + key = "nDaysSinceLastPush" + value = 2 + } + cron_setting = "manual" + disabled = true +} + +resource "tencentcloud_tcr_tag_retention_execution_config" "example" { + registry_id = tencentcloud_tcr_tag_retention_rule.example.registry_id + retention_id = tencentcloud_tcr_tag_retention_rule.example.retention_id + dry_run = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `registry_id` - (Required, String) instance id. +* `retention_id` - (Required, Int) retention id. +* `dry_run` - (Optional, Bool) Whether to simulate execution, the default value is false, that is, non-simulation execution. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `execution_id` - execution id. + + diff --git a/config/docs/r/tcr_tag_retention_rule.html.markdown b/config/docs/r/tcr_tag_retention_rule.html.markdown new file mode 100644 index 0000000..0306e0b --- /dev/null +++ b/config/docs/r/tcr_tag_retention_rule.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_tag_retention_rule" +sidebar_current: "docs-tencentcloud-resource-tcr_tag_retention_rule" +description: |- + Provides a resource to create a tcr tag retention rule. +--- + +# tencentcloud_tcr_tag_retention_rule + +Provides a resource to create a tcr tag retention rule. + +## Example Usage + +### Create a tcr tag retention rule instance + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "basic" + delete_bucket = true + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tcr_namespace" "example" { + instance_id = tencentcloud_tcr_instance.example.id + name = "tf_example_ns_retention" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "cve-xxxxx" + } +} + +resource "tencentcloud_tcr_tag_retention_rule" "my_rule" { + registry_id = tencentcloud_tcr_instance.example.id + namespace_name = tencentcloud_tcr_namespace.example.name + retention_rule { + key = "nDaysSinceLastPush" + value = 2 + } + cron_setting = "daily" + disabled = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cron_setting` - (Required, String) Execution cycle, currently only available selections are: manual; daily; weekly; monthly. +* `namespace_name` - (Required, String) The Name of the namespace. +* `registry_id` - (Required, String) The main instance ID. +* `retention_rule` - (Required, List) Retention Policy. +* `disabled` - (Optional, Bool) Whether to disable the rule, with the default value of false. + +The `retention_rule` object supports the following: + +* `key` - (Required, String) The supported policies are latestPushedK (retain the latest `k` pushed versions) and nDaysSinceLastPush (retain pushed versions within the last `n` days). +* `value` - (Required, Int) corresponding values for rule settings. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `retention_id` - The ID of the retention task. + + diff --git a/config/docs/r/tcr_token.html.markdown b/config/docs/r/tcr_token.html.markdown new file mode 100644 index 0000000..742850e --- /dev/null +++ b/config/docs/r/tcr_token.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_token" +sidebar_current: "docs-tencentcloud-resource-tcr_token" +description: |- + Use this resource to create tcr long term token. +--- + +# tencentcloud_tcr_token + +Use this resource to create tcr long term token. + +## Example Usage + +### Create a token for tcr instance + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "basic" + delete_bucket = true + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tcr_token" "example" { + instance_id = tencentcloud_tcr_instance.example.id + description = "example for the tcr token" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of the TCR instance. +* `description` - (Optional, String, ForceNew) Description of the token. Valid length is [0~255]. +* `enable` - (Optional, Bool) Indicate to enable this token or not. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time. +* `token_id` - Sub ID of the TCR token. The full ID of token format like `instance_id#token_id`. +* `token` - The content of the token. +* `user_name` - User name of the token. + + +## Import + +tcr token can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_tcr_token.example instance_id#token_id +``` + diff --git a/config/docs/r/tcr_vpc_attachment.html.markdown b/config/docs/r/tcr_vpc_attachment.html.markdown new file mode 100644 index 0000000..826c999 --- /dev/null +++ b/config/docs/r/tcr_vpc_attachment.html.markdown @@ -0,0 +1,78 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_vpc_attachment" +sidebar_current: "docs-tencentcloud-resource-tcr_vpc_attachment" +description: |- + Use this resource to attach tcr instance with the vpc and subnet network. +--- + +# tencentcloud_tcr_vpc_attachment + +Use this resource to attach tcr instance with the vpc and subnet network. + +## Example Usage + +### Attach a tcr instance with vpc resource + +```hcl +locals { + vpc_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.vpc_id + subnet_id = data.tencentcloud_vpc_subnets.vpc.instance_list.0.subnet_id + tcr_id = tencentcloud_tcr_instance.example.id +} + +data "tencentcloud_vpc_subnets" "vpc" { + is_default = true + availability_zone = var.availability_zone +} + +data "tencentcloud_security_groups" "sg" { + name = "default" +} + +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "basic" + delete_bucket = true + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tcr_vpc_attachment" "foo" { + instance_id = local.tcr_id + vpc_id = local.vpc_id + subnet_id = local.subnet_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of the TCR instance. +* `subnet_id` - (Required, String, ForceNew) ID of subnet. +* `vpc_id` - (Required, String, ForceNew) ID of VPC. +* `enable_public_domain_dns` - (Optional, Bool) Whether to enable public domain dns. Default value is `false`. +* `enable_vpc_domain_dns` - (Optional, Bool) Whether to enable vpc domain dns. Default value is `false`. +* `region_id` - (Optional, Int, **Deprecated**) this argument was deprecated, use `region_name` instead. ID of region. Conflict with region_name, can not be set at the same time. +* `region_name` - (Optional, String) Name of region. Conflict with region_id, can not be set at the same time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `access_ip` - IP address of the internal access. +* `status` - Status of the internal access. + + +## Import + +tcr vpc attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_tcr_vpc_attachment.foo instance_id#vpc_id#subnet_id +``` + diff --git a/config/docs/r/tcr_webhook_trigger.html.markdown b/config/docs/r/tcr_webhook_trigger.html.markdown new file mode 100644 index 0000000..d5193ef --- /dev/null +++ b/config/docs/r/tcr_webhook_trigger.html.markdown @@ -0,0 +1,118 @@ +--- +subcategory: "Tencent Container Registry(TCR)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tcr_webhook_trigger" +sidebar_current: "docs-tencentcloud-resource-tcr_webhook_trigger" +description: |- + Provides a resource to create a tcr webhook trigger +--- + +# tencentcloud_tcr_webhook_trigger + +Provides a resource to create a tcr webhook trigger + +## Example Usage + +### Create a tcr webhook trigger instance + +```hcl +resource "tencentcloud_tcr_instance" "example" { + name = "tf-example-tcr" + instance_type = "basic" + delete_bucket = true + + tags = { + test = "test" + } +} + +resource "tencentcloud_tcr_namespace" "example" { + instance_id = tencentcloud_tcr_instance.example.id + name = "tf_example_ns_retention" + is_public = true + is_auto_scan = true + is_prevent_vul = true + severity = "medium" + cve_whitelist_items { + cve_id = "cve-xxxxx" + } +} + +data "tencentcloud_tcr_namespaces" "example" { + instance_id = tencentcloud_tcr_namespace.example.instance_id +} + +locals { + ns_id = data.tencentcloud_tcr_namespaces.example.namespace_list.0.id +} + +resource "tencentcloud_tcr_webhook_trigger" "example" { + registry_id = tencentcloud_tcr_instance.example.id + namespace = tencentcloud_tcr_namespace.example.name + trigger { + name = "trigger-example" + targets { + address = "http://example.org/post" + headers { + key = "X-Custom-Header" + values = ["a"] + } + } + event_types = ["pushImage"] + condition = ".*" + enabled = true + description = "example for trigger description" + namespace_id = local.ns_id + + } + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `namespace` - (Required, String) namespace name. +* `registry_id` - (Required, String) instance Id. +* `trigger` - (Required, List) trigger parameters. +* `tags` - (Optional, Map) Tag description list. + +The `headers` object supports the following: + +* `key` - (Required, String) Header Key. +* `values` - (Required, Set) Header Values. + +The `targets` object supports the following: + +* `address` - (Required, String) target address. +* `headers` - (Optional, List) custom Headers. + +The `trigger` object supports the following: + +* `condition` - (Required, String) trigger rule. +* `enabled` - (Required, Bool) enable trigger. +* `event_types` - (Required, Set) trigger action. +* `name` - (Required, String) trigger name. +* `targets` - (Required, List) trigger target. +* `description` - (Optional, String) trigger description. +* `namespace_id` - (Optional, Int) the namespace Id to which the trigger belongs. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tcr webhook_trigger can be imported using the id, e.g. + +``` +terraform import tencentcloud_tcr_webhook_trigger.example webhook_trigger_id +``` + diff --git a/config/docs/r/tdcpg_cluster.html.markdown b/config/docs/r/tdcpg_cluster.html.markdown new file mode 100644 index 0000000..a60e4f0 --- /dev/null +++ b/config/docs/r/tdcpg_cluster.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "TDSQL-C for PostgreSQL(TDCPG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdcpg_cluster" +sidebar_current: "docs-tencentcloud-resource-tdcpg_cluster" +description: |- + Provides a resource to create a tdcpg cluster. +--- + +# tencentcloud_tdcpg_cluster + +Provides a resource to create a tdcpg cluster. + +~> **NOTE:** This resource is still in internal testing. To experience its functions, you need to apply for a whitelist from Tencent Cloud. + +## Example Usage + +```hcl +resource "tencentcloud_tdcpg_cluster" "cluster" { + zone = "ap-guangzhou-3" + master_user_password = "" + cpu = 1 + memory = 1 + vpc_id = "vpc_id" + subnet_id = "subnet_id" + pay_mode = "POSTPAID_BY_HOUR" + cluster_name = "cluster_name" + db_version = "10.17" + instance_count = 1 + period = 1 + project_id = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cpu` - (Required, Int) cpu cores. +* `master_user_password` - (Required, String) user password. +* `memory` - (Required, Int) memory size. +* `pay_mode` - (Required, String) pay mode, the value is either PREPAID or POSTPAID_BY_HOUR. +* `subnet_id` - (Required, String) subnet id. +* `vpc_id` - (Required, String) vpc id. +* `zone` - (Required, String) available zone. +* `cluster_name` - (Optional, String) cluster name. +* `db_version` - (Optional, String) community version number, default to 10.17. +* `instance_count` - (Optional, Int) instance count. +* `period` - (Optional, Int) purchase time, required when PayMode is PREPAID, the value range is 1~60, default to 1. +* `project_id` - (Optional, Int) project id, default to 0, means default project. +* `storage` - (Optional, Int) max storage, the unit is GB. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tdcpg cluster can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tdcpg_cluster.cluster cluster_id +``` + diff --git a/config/docs/r/tdcpg_instance.html.markdown b/config/docs/r/tdcpg_instance.html.markdown new file mode 100644 index 0000000..f0835bf --- /dev/null +++ b/config/docs/r/tdcpg_instance.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "TDSQL-C for PostgreSQL(TDCPG)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdcpg_instance" +sidebar_current: "docs-tencentcloud-resource-tdcpg_instance" +description: |- + Provides a resource to create a tdcpg instance. +--- + +# tencentcloud_tdcpg_instance + +Provides a resource to create a tdcpg instance. + +~> **NOTE:** This resource is still in internal testing. To experience its functions, you need to apply for a whitelist from Tencent Cloud. + +## Example Usage + +```hcl +resource "tencentcloud_tdcpg_instance" "instance1" { + cluster_id = "cluster_id" + cpu = 1 + memory = 1 + instance_name = "instance_name" +} + +resource "tencentcloud_tdcpg_instance" "instance2" { + cluster_id = "cluster_id" + cpu = 1 + memory = 2 + instance_name = "instance_name" + operation_timing = "IMMEDIATE" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) cluster id. +* `cpu` - (Required, Int) cpu cores. +* `memory` - (Required, Int) memory size. +* `instance_name` - (Optional, String) instance name. +* `operation_timing` - (Optional, String) operation timing, optional value is IMMEDIATE or MAINTAIN_PERIOD. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tdcpg instance can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tdcpg_instance.instance cluster_id#instance_id +``` + diff --git a/config/docs/r/tdmq_instance.html.markdown b/config/docs/r/tdmq_instance.html.markdown new file mode 100644 index 0000000..46a9456 --- /dev/null +++ b/config/docs/r/tdmq_instance.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "TDMQ for Pulsar(tpulsar)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_instance" +sidebar_current: "docs-tencentcloud-resource-tdmq_instance" +description: |- + Provide a resource to create a TDMQ instance. +--- + +# tencentcloud_tdmq_instance + +Provide a resource to create a TDMQ instance. + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_instance" "foo" { + cluster_name = "example" + remark = "this is description." + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_name` - (Required, String) The name of tdmq cluster to be created. +* `bind_cluster_id` - (Optional, Int) The Dedicated Cluster Id. +* `remark` - (Optional, String) Description of the tdmq cluster. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Tdmq instance can be imported, e.g. + +``` +$ terraform import tencentcloud_tdmq_instance.test tdmq_id +``` + diff --git a/config/docs/r/tdmq_namespace.html.markdown b/config/docs/r/tdmq_namespace.html.markdown new file mode 100644 index 0000000..d73444f --- /dev/null +++ b/config/docs/r/tdmq_namespace.html.markdown @@ -0,0 +1,67 @@ +--- +subcategory: "TDMQ for Pulsar(tpulsar)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_namespace" +sidebar_current: "docs-tencentcloud-resource-tdmq_namespace" +description: |- + Provide a resource to create a tdmq namespace. +--- + +# tencentcloud_tdmq_namespace + +Provide a resource to create a tdmq namespace. + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_instance" "example" { + cluster_name = "tf_example" + remark = "remark." + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tdmq_namespace" "example" { + environ_name = "tf_example" + msg_ttl = 300 + cluster_id = tencentcloud_tdmq_instance.example.id + retention_policy { + time_in_minutes = 60 + size_in_mb = 10 + } + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) The Dedicated Cluster Id. +* `environ_name` - (Required, String) The name of namespace to be created. +* `msg_ttl` - (Required, Int) The expiration time of unconsumed message. +* `remark` - (Optional, String) Description of the namespace. +* `retention_policy` - (Optional, List) The Policy of message to retain. Format like: `{time_in_minutes: Int, size_in_mb: Int}`. `time_in_minutes`: the time of message to retain; `size_in_mb`: the size of message to retain. + +The `retention_policy` object supports the following: + +* `size_in_mb` - (Optional, Int) the size of message to retain. +* `time_in_minutes` - (Optional, Int) the time of message to retain. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Tdmq namespace can be imported, e.g. + +``` +$ terraform import tencentcloud_tdmq_instance.test namespace_id +``` + diff --git a/config/docs/r/tdmq_namespace_role_attachment.html.markdown b/config/docs/r/tdmq_namespace_role_attachment.html.markdown new file mode 100644 index 0000000..e8e4cc3 --- /dev/null +++ b/config/docs/r/tdmq_namespace_role_attachment.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "TDMQ for Pulsar(tpulsar)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_namespace_role_attachment" +sidebar_current: "docs-tencentcloud-resource-tdmq_namespace_role_attachment" +description: |- + Provide a resource to create a TDMQ role. +--- + +# tencentcloud_tdmq_namespace_role_attachment + +Provide a resource to create a TDMQ role. + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_instance" "example" { + cluster_name = "tf_example" + remark = "remark." + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tdmq_namespace" "example" { + environ_name = "tf_example" + msg_ttl = 300 + cluster_id = tencentcloud_tdmq_instance.example.id + retention_policy { + time_in_minutes = 60 + size_in_mb = 10 + } + remark = "remark." +} + +resource "tencentcloud_tdmq_role" "example" { + role_name = "tf_example" + cluster_id = tencentcloud_tdmq_instance.example.id + remark = "remark." +} + +resource "tencentcloud_tdmq_namespace_role_attachment" "example" { + environ_id = tencentcloud_tdmq_namespace.example.environ_name + role_name = tencentcloud_tdmq_role.example.role_name + permissions = ["produce", "consume"] + cluster_id = tencentcloud_tdmq_instance.example.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) The id of tdmq cluster. +* `environ_id` - (Required, String) The name of tdmq namespace. +* `permissions` - (Required, List: [`String`]) The permissions of tdmq role. +* `role_name` - (Required, String) The name of tdmq role. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of resource. + + diff --git a/config/docs/r/tdmq_rabbitmq_user.html.markdown b/config/docs/r/tdmq_rabbitmq_user.html.markdown new file mode 100644 index 0000000..a53384d --- /dev/null +++ b/config/docs/r/tdmq_rabbitmq_user.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "TDMQ for RabbitMQ(trabbit)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rabbitmq_user" +sidebar_current: "docs-tencentcloud-resource-tdmq_rabbitmq_user" +description: |- + Provides a resource to create a tdmq rabbitmq_user +--- + +# tencentcloud_tdmq_rabbitmq_user + +Provides a resource to create a tdmq rabbitmq_user + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_rabbitmq_user" "rabbitmq_user" { + instance_id = "amqp-kzbe8p3n" + user = "keep-user" + password = "asdf1234" + description = "test user" + tags = ["management", "monitoring"] + max_connections = 3 + max_channels = 3 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Cluster instance ID. +* `password` - (Required, String) Password, used when logging in. +* `user` - (Required, String) Username, used when logging in. +* `description` - (Optional, String) Describe. +* `max_channels` - (Optional, Int) The maximum number of channels for this user, if not filled in, there is no limit. +* `max_connections` - (Optional, Int) The maximum number of connections for this user, if not filled in, there is no limit. +* `tags` - (Optional, List: [`String`]) User tag, used to determine the permission range for changing user access to RabbitMQ Management. Management: regular console user, monitoring: management console user, other values: non console user. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tdmq_rabbitmq_vip_instance.html.markdown b/config/docs/r/tdmq_rabbitmq_vip_instance.html.markdown new file mode 100644 index 0000000..01595da --- /dev/null +++ b/config/docs/r/tdmq_rabbitmq_vip_instance.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "TDMQ for RabbitMQ(trabbit)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rabbitmq_vip_instance" +sidebar_current: "docs-tencentcloud-resource-tdmq_rabbitmq_vip_instance" +description: |- + Provides a resource to create a tdmq rabbitmq_vip_instance +--- + +# tencentcloud_tdmq_rabbitmq_vip_instance + +Provides a resource to create a tdmq rabbitmq_vip_instance + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +resource "tencentcloud_vpc" "vpc" { + name = "rabbitmq-vpc" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + name = "rabbitmq-subnet" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_tdmq_rabbitmq_vip_instance" "example" { + zone_ids = [data.tencentcloud_availability_zones.zones.zones.0.id] + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + cluster_name = "tf-example-rabbitmq-vip-instance" + node_spec = "rabbit-vip-basic-1" + node_num = 1 + storage_size = 200 + enable_create_default_ha_mirror_queue = false + auto_renew_flag = true + time_span = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_name` - (Required, String) cluster name. +* `subnet_id` - (Required, String) Private network SubnetId. +* `vpc_id` - (Required, String) Private network VpcId. +* `zone_ids` - (Required, Set: [`Int`]) availability zone. +* `auto_renew_flag` - (Optional, Bool) Automatic renewal, the default is true. +* `enable_create_default_ha_mirror_queue` - (Optional, Bool) Mirrored queue, the default is false. +* `node_num` - (Optional, Int) The number of nodes, a minimum of 3 nodes for a multi-availability zone. If not passed, the default single availability zone is 1, and the multi-availability zone is 3. +* `node_spec` - (Optional, String) Node specifications, basic type rabbit-vip-basic-1, standard type rabbit-vip-basic-2, high-level type 1 rabbit-vip-basic-3, high-level type 2 rabbit-vip-basic-4. If not passed, the default is the basic type. +* `storage_size` - (Optional, Int) Single node storage specification, the default is 200G. +* `time_span` - (Optional, Int) Purchase duration, the default is 1 (month). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tdmq_rabbitmq_virtual_host.html.markdown b/config/docs/r/tdmq_rabbitmq_virtual_host.html.markdown new file mode 100644 index 0000000..1a09c19 --- /dev/null +++ b/config/docs/r/tdmq_rabbitmq_virtual_host.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "TDMQ for RabbitMQ(trabbit)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rabbitmq_virtual_host" +sidebar_current: "docs-tencentcloud-resource-tdmq_rabbitmq_virtual_host" +description: |- + Provides a resource to create a tdmq rabbitmq_virtual_host +--- + +# tencentcloud_tdmq_rabbitmq_virtual_host + +Provides a resource to create a tdmq rabbitmq_virtual_host + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_rabbitmq_virtual_host" "rabbitmq_virtual_host" { + instance_id = "amqp-kzbe8p3n" + virtual_host = "vh-test-1" + description = "desc" + trace_flag = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String) Cluster instance ID. +* `virtual_host` - (Required, String) vhost name. +* `description` - (Optional, String) describe. +* `trace_flag` - (Optional, Bool) Message track switch, true is on, false is off, default is off. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tdmq_rocketmq_cluster.html.markdown b/config/docs/r/tdmq_rocketmq_cluster.html.markdown new file mode 100644 index 0000000..8ccc0ed --- /dev/null +++ b/config/docs/r/tdmq_rocketmq_cluster.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_cluster" +sidebar_current: "docs-tencentcloud-resource-tdmq_rocketmq_cluster" +description: |- + Provides a resource to create a tdmqRocketmq cluster +--- + +# tencentcloud_tdmq_rocketmq_cluster + +Provides a resource to create a tdmqRocketmq cluster + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_rocketmq_cluster" "example" { + cluster_name = "tf_example" + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_name` - (Required, String) Cluster name, which can contain 3-64 letters, digits, hyphens, and underscores. +* `remark` - (Optional, String) Cluster description (up to 128 characters). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `cluster_id` - Cluster ID. +* `create_time` - Creation time in milliseconds. +* `is_vip` - Whether it is an exclusive instance. +* `public_end_point` - Public network access address. +* `region` - Region information. +* `rocket_m_q_flag` - Rocketmq cluster identification. +* `support_namespace_endpoint` - Whether the namespace access point is supported. +* `vpc_end_point` - VPC access address. +* `vpcs` - Vpc list. + * `subnet_id` - Subnet ID. + * `vpc_id` - Vpc ID. + + +## Import + +tdmqRocketmq cluster can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tdmq_rocketmq_cluster.cluster cluster_id +``` + diff --git a/config/docs/r/tdmq_rocketmq_environment_role.html.markdown b/config/docs/r/tdmq_rocketmq_environment_role.html.markdown new file mode 100644 index 0000000..497eb21 --- /dev/null +++ b/config/docs/r/tdmq_rocketmq_environment_role.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_environment_role" +sidebar_current: "docs-tencentcloud-resource-tdmq_rocketmq_environment_role" +description: |- + Provides a resource to create a tdmqRocketmq environment_role +--- + +# tencentcloud_tdmq_rocketmq_environment_role + +Provides a resource to create a tdmqRocketmq environment_role + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_rocketmq_cluster" "example" { + cluster_name = "tf_example" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_role" "example" { + role_name = "tf_example_role" + remark = "remark." + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id +} + +resource "tencentcloud_tdmq_rocketmq_namespace" "example" { + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + namespace_name = "tf_example_namespace" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_environment_role" "example" { + environment_name = tencentcloud_tdmq_rocketmq_namespace.example.namespace_name + role_name = tencentcloud_tdmq_rocketmq_role.example.role_name + permissions = ["produce", "consume"] + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) Cluster ID (required). +* `environment_name` - (Required, String, ForceNew) Environment (namespace) name. +* `permissions` - (Required, Set: [`String`]) Permissions, which is a non-empty string array of `produce` and `consume` at the most. +* `role_name` - (Required, String, ForceNew) Role Name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tdmqRocketmq environment_role can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tdmq_rocketmq_environment_role.environment_role environmentRole_id +``` + diff --git a/config/docs/r/tdmq_rocketmq_group.html.markdown b/config/docs/r/tdmq_rocketmq_group.html.markdown new file mode 100644 index 0000000..f4372d2 --- /dev/null +++ b/config/docs/r/tdmq_rocketmq_group.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_group" +sidebar_current: "docs-tencentcloud-resource-tdmq_rocketmq_group" +description: |- + Provides a resource to create a tdmqRocketmq group +--- + +# tencentcloud_tdmq_rocketmq_group + +Provides a resource to create a tdmqRocketmq group + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_rocketmq_cluster" "example" { + cluster_name = "tf_example" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_namespace" "example" { + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + namespace_name = "tf_example" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_group" "example" { + group_name = "tf_example" + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + namespace = tencentcloud_tdmq_rocketmq_namespace.example.namespace_name + read_enable = true + broadcast_enable = true + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `broadcast_enable` - (Required, Bool) Whether to enable broadcast consumption. +* `cluster_id` - (Required, String, ForceNew) Cluster ID. +* `group_name` - (Required, String, ForceNew) Group name (8-64 characters). +* `namespace` - (Required, String, ForceNew) Namespace. Currently, only one namespace is supported. +* `read_enable` - (Required, Bool) Whether to enable consumption. +* `remark` - (Optional, String) Remarks (up to 128 characters). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `client_protocol` - Client protocol. +* `consumer_num` - The number of online consumers. +* `consumer_type` - Consumer type. Enumerated values: ACTIVELY or PASSIVELY. +* `consumption_mode` - `0`: Cluster consumption mode; `1`: Broadcast consumption mode; `-1`: Unknown. +* `create_time` - Creation time in milliseconds. +* `retry_partition_num` - The number of partitions in a retry topic. +* `total_accumulative` - The total number of heaped messages. +* `tps` - Consumption TPS. +* `update_time` - Modification time in milliseconds. + + +## Import + +tdmqRocketmq group can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tdmq_rocketmq_group.group group_id +``` + diff --git a/config/docs/r/tdmq_rocketmq_namespace.html.markdown b/config/docs/r/tdmq_rocketmq_namespace.html.markdown new file mode 100644 index 0000000..986f703 --- /dev/null +++ b/config/docs/r/tdmq_rocketmq_namespace.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_namespace" +sidebar_current: "docs-tencentcloud-resource-tdmq_rocketmq_namespace" +description: |- + Provides a resource to create a tdmqRocketmq namespace +--- + +# tencentcloud_tdmq_rocketmq_namespace + +Provides a resource to create a tdmqRocketmq namespace + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_rocketmq_cluster" "example" { + cluster_name = "tf_example" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_namespace" "example" { + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + namespace_name = "tf_example_namespace" + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `namespace_name` - (Required, String) Namespace name, which can contain 3-64 letters, digits, hyphens, and underscores. +* `remark` - (Optional, String) Remarks (up to 128 characters). +* `retention_time` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.81.20. Due to the adjustment of RocketMQ, the creation or modification of this parameter will be ignored. Retention time of persisted messages in milliseconds. +* `ttl` - (Optional, Int, **Deprecated**) It has been deprecated from version 1.81.20. Due to the adjustment of RocketMQ, the creation or modification of this parameter will be ignored. Retention time of unconsumed messages in milliseconds. Value range: 60 seconds-15 days. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `public_endpoint` - Public network access point address. +* `vpc_endpoint` - VPC access point address. + + +## Import + +tdmqRocketmq namespace can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tdmq_rocketmq_namespace.namespace namespace_id +``` + diff --git a/config/docs/r/tdmq_rocketmq_role.html.markdown b/config/docs/r/tdmq_rocketmq_role.html.markdown new file mode 100644 index 0000000..51edad2 --- /dev/null +++ b/config/docs/r/tdmq_rocketmq_role.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_role" +sidebar_current: "docs-tencentcloud-resource-tdmq_rocketmq_role" +description: |- + Provides a resource to create a tdmqRocketmq role +--- + +# tencentcloud_tdmq_rocketmq_role + +Provides a resource to create a tdmqRocketmq role + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_rocketmq_cluster" "example" { + cluster_name = "tf_example" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_role" "example" { + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + role_name = "tf_example" + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID (required). +* `role_name` - (Required, String) Role name, which can contain up to 32 letters, digits, hyphens, and underscores. +* `remark` - (Optional, String) Remarks (up to 128 characters). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time. +* `token` - Value of the role token. +* `update_time` - Update time. + + +## Import + +tdmqRocketmq role can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tdmq_rocketmq_role.role role_id +``` + diff --git a/config/docs/r/tdmq_rocketmq_topic.html.markdown b/config/docs/r/tdmq_rocketmq_topic.html.markdown new file mode 100644 index 0000000..eabc5e8 --- /dev/null +++ b/config/docs/r/tdmq_rocketmq_topic.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_topic" +sidebar_current: "docs-tencentcloud-resource-tdmq_rocketmq_topic" +description: |- + Provides a resource to create a tdmqRocketmq topic +--- + +# tencentcloud_tdmq_rocketmq_topic + +Provides a resource to create a tdmqRocketmq topic + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_rocketmq_cluster" "example" { + cluster_name = "tf_example" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_namespace" "example" { + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + namespace_name = "tf_example_namespace" + remark = "remark." +} + +resource "tencentcloud_tdmq_rocketmq_topic" "example" { + topic_name = "tf_example" + namespace_name = tencentcloud_tdmq_rocketmq_namespace.example.namespace_name + cluster_id = tencentcloud_tdmq_rocketmq_cluster.example.cluster_id + type = "Normal" + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) Cluster ID. +* `namespace_name` - (Required, String) Topic namespace. Currently, you can create topics only in one single namespace. +* `topic_name` - (Required, String) Topic name, which can contain 3-64 letters, digits, hyphens, and underscores. +* `type` - (Required, String) Topic type. Valid values: Normal, GlobalOrder, PartitionedOrder. +* `partition_num` - (Optional, Int) Number of partitions. +* `remark` - (Optional, String) Topic remarks (up to 128 characters). + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time in milliseconds. +* `update_time` - Update time in milliseconds. + + +## Import + +tdmqRocketmq topic can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tdmq_rocketmq_topic.topic topic_id +``` + diff --git a/config/docs/r/tdmq_rocketmq_vip_instance.html.markdown b/config/docs/r/tdmq_rocketmq_vip_instance.html.markdown new file mode 100644 index 0000000..be36356 --- /dev/null +++ b/config/docs/r/tdmq_rocketmq_vip_instance.html.markdown @@ -0,0 +1,78 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_rocketmq_vip_instance" +sidebar_current: "docs-tencentcloud-resource-tdmq_rocketmq_vip_instance" +description: |- + Provides a resource to create a tdmq rocketmq_vip_instance +--- + +# tencentcloud_tdmq_rocketmq_vip_instance + +Provides a resource to create a tdmq rocketmq_vip_instance + +~> **NOTE:** The instance cannot be downgraded, Include parameters `node_count`, `spec`, `storage_size`. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones.zones.zones.1.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_tdmq_rocketmq_vip_instance" "example" { + name = "tx-example" + spec = "rocket-vip-basic-2" + node_count = 2 + storage_size = 200 + zone_ids = [ + data.tencentcloud_availability_zones.zones.zones.0.id, + data.tencentcloud_availability_zones.zones.zones.1.id + ] + + vpc_info { + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + + } + + time_span = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Instance name. +* `node_count` - (Required, Int) Number of nodes, minimum 2, maximum 20. +* `spec` - (Required, String) Instance specification: Basic type: `rocket-vip-basic-1`, Standard type: `rocket-vip-basic-2`, Advanced Type I: `rocket-vip-basic-3`, Advanced Type II: `rocket-vip-basic-4`. +* `storage_size` - (Required, Int) Single node storage space, in GB, minimum 200GB. +* `time_span` - (Required, Int) Purchase period, in months. +* `vpc_info` - (Required, List) VPC information. +* `zone_ids` - (Required, Set: [`String`]) The Zone ID list for node deployment, such as Guangzhou Zone 1, is 100001. For details, please refer to the official website of Tencent Cloud. + +The `vpc_info` object supports the following: + +* `subnet_id` - (Required, String) Subnet ID. +* `vpc_id` - (Required, String) VPC ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tdmq_role.html.markdown b/config/docs/r/tdmq_role.html.markdown new file mode 100644 index 0000000..a828faf --- /dev/null +++ b/config/docs/r/tdmq_role.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "TDMQ for Pulsar(tpulsar)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_role" +sidebar_current: "docs-tencentcloud-resource-tdmq_role" +description: |- + Provide a resource to create a TDMQ role. +--- + +# tencentcloud_tdmq_role + +Provide a resource to create a TDMQ role. + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_instance" "example" { + cluster_name = "tf_example" + remark = "remark." + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tdmq_role" "example" { + role_name = "tf_example" + cluster_id = tencentcloud_tdmq_instance.example.id + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) The id of tdmq cluster. +* `remark` - (Required, String) The description of tdmq role. +* `role_name` - (Required, String) The name of tdmq role. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Tdmq instance can be imported, e.g. + +``` +$ terraform import tencentcloud_tdmq_instance.test tdmq_id +``` + diff --git a/config/docs/r/tdmq_send_rocketmq_message.html.markdown b/config/docs/r/tdmq_send_rocketmq_message.html.markdown new file mode 100644 index 0000000..dd1e0e7 --- /dev/null +++ b/config/docs/r/tdmq_send_rocketmq_message.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_send_rocketmq_message" +sidebar_current: "docs-tencentcloud-resource-tdmq_send_rocketmq_message" +description: |- + Provides a resource to create a tdmq send_rocketmq_message +--- + +# tencentcloud_tdmq_send_rocketmq_message + +Provides a resource to create a tdmq send_rocketmq_message + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_send_rocketmq_message" "send_rocketmq_message" { + cluster_id = "rocketmq-7k45z9dkpnne" + namespace_id = "test_ns" + topic_name = "test_topic" + msg_body = "msg key" + msg_key = "msg tag" + msg_tag = "msg value" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) Cluster id. +* `msg_body` - (Required, String, ForceNew) Information. +* `namespace_id` - (Required, String, ForceNew) Namespaces. +* `topic_name` - (Required, String, ForceNew) topic name. +* `msg_key` - (Optional, String, ForceNew) Message key information. +* `msg_tag` - (Optional, String, ForceNew) Message tag information. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tdmq_topic.html.markdown b/config/docs/r/tdmq_topic.html.markdown new file mode 100644 index 0000000..5e4148f --- /dev/null +++ b/config/docs/r/tdmq_topic.html.markdown @@ -0,0 +1,73 @@ +--- +subcategory: "TDMQ for Pulsar(tpulsar)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tdmq_topic" +sidebar_current: "docs-tencentcloud-resource-tdmq_topic" +description: |- + Provide a resource to create a TDMQ topic. +--- + +# tencentcloud_tdmq_topic + +Provide a resource to create a TDMQ topic. + +## Example Usage + +```hcl +resource "tencentcloud_tdmq_instance" "example" { + cluster_name = "tf_example" + remark = "remark." + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tdmq_namespace" "example" { + environ_name = "tf_example" + msg_ttl = 300 + cluster_id = tencentcloud_tdmq_instance.example.id + retention_policy { + time_in_minutes = 60 + size_in_mb = 10 + } + remark = "remark." +} + +resource "tencentcloud_tdmq_topic" "example" { + environ_id = tencentcloud_tdmq_namespace.example.environ_name + cluster_id = tencentcloud_tdmq_instance.example.id + topic_name = "tf-example-topic" + partitions = 6 + pulsar_topic_type = 3 + remark = "remark." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String) The Dedicated Cluster Id. +* `environ_id` - (Required, String, ForceNew) The name of tdmq namespace. +* `partitions` - (Required, Int) The partitions of topic. +* `topic_name` - (Required, String, ForceNew) The name of topic to be created. +* `pulsar_topic_type` - (Optional, Int) Pulsar Topic Type 0: Non-persistent non-partitioned 1: Non-persistent partitioned 2: Persistent non-partitioned 3: Persistent partitioned. +* `remark` - (Optional, String) Description of the namespace. +* `topic_type` - (Optional, Int, **Deprecated**) This input will be gradually discarded and can be switched to PulsarTopicType parameter 0: Normal message; 1: Global sequential messages; 2: Local sequential messages; 3: Retrying queue; 4: Dead letter queue. The type of topic. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of resource. + + +## Import + +Tdmq Topic can be imported, e.g. + +``` +$ terraform import tencentcloud_tdmq_topic.test topic_id +``` + diff --git a/config/docs/r/tem_app_config.html.markdown b/config/docs/r/tem_app_config.html.markdown new file mode 100644 index 0000000..782374d --- /dev/null +++ b/config/docs/r/tem_app_config.html.markdown @@ -0,0 +1,58 @@ +--- +subcategory: "TencentCloud Elastic Microservice(TEM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tem_app_config" +sidebar_current: "docs-tencentcloud-resource-tem_app_config" +description: |- + Provides a resource to create a tem appConfig +--- + +# tencentcloud_tem_app_config + +Provides a resource to create a tem appConfig + +## Example Usage + +```hcl +resource "tencentcloud_tem_app_config" "appConfig" { + environment_id = "en-o5edaepv" + name = "demo" + config_data { + key = "key" + value = "value" + } + config_data { + key = "key1" + value = "value1" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_data` - (Required, List) payload. +* `environment_id` - (Required, String, ForceNew) environment ID. +* `name` - (Required, String, ForceNew) appConfig name. + +The `config_data` object supports the following: + +* `key` - (Required, String) key. +* `value` - (Required, String) value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tem appConfig can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tem_app_config.appConfig environmentId#name +``` + diff --git a/config/docs/r/tem_application.html.markdown b/config/docs/r/tem_application.html.markdown new file mode 100644 index 0000000..171f50d --- /dev/null +++ b/config/docs/r/tem_application.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TencentCloud Elastic Microservice(TEM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tem_application" +sidebar_current: "docs-tencentcloud-resource-tem_application" +description: |- + Provides a resource to create a tem application +--- + +# tencentcloud_tem_application + +Provides a resource to create a tem application + +## Example Usage + +```hcl +resource "tencentcloud_tem_application" "application" { + application_name = "demo" + description = "demo for test" + coding_language = "JAVA" + use_default_image_service = 0 + repo_type = 2 + repo_name = "qcloud/nginx" + repo_server = "ccr.ccs.tencentyun.com" + tags = { + "created" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_name` - (Required, String) application name. +* `coding_language` - (Required, String) program language, like JAVA. +* `description` - (Required, String) application description. +* `instance_id` - (Optional, String) tcr instance id. +* `repo_name` - (Optional, String) repository name. +* `repo_server` - (Optional, String) registry address. +* `repo_type` - (Optional, Int) repo type, 0: tcr personal, 1: tcr enterprise, 2: public repository, 3: tcr hosted by tem, 4: demo image. +* `tags` - (Optional, Map) application tag list. +* `use_default_image_service` - (Optional, Int) create image repo or not. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tem_application_service.html.markdown b/config/docs/r/tem_application_service.html.markdown new file mode 100644 index 0000000..ee53c86 --- /dev/null +++ b/config/docs/r/tem_application_service.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "TencentCloud Elastic Microservice(TEM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tem_application_service" +sidebar_current: "docs-tencentcloud-resource-tem_application_service" +description: |- + Provides a resource to create a tem application_service +--- + +# tencentcloud_tem_application_service + +Provides a resource to create a tem application_service + +## Example Usage + +```hcl +resource "tencentcloud_tem_application_service" "application_service" { + environment_id = "en-dpxyydl5" + application_id = "app-jrl3346j" + service { + type = "CLUSTER" + service_name = "test0-1" + port_mapping_item_list { + port = 80 + target_port = 80 + protocol = "TCP" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Required, String) application ID. +* `environment_id` - (Required, String) environment ID. +* `service` - (Optional, List) service detail list. + +The `port_mapping_item_list` object supports the following: + +* `port` - (Optional, Int) container port. +* `protocol` - (Optional, String) UDP or TCP. +* `target_port` - (Optional, Int) application listen port. + +The `service` object supports the following: + +* `port_mapping_item_list` - (Optional, List) port mapping item list. +* `service_name` - (Optional, String) application service name. +* `subnet_id` - (Optional, String) ID of subnet instance, required when type is `VPC`. +* `type` - (Optional, String) application service type: EXTERNAL | VPC | CLUSTER. +* `vpc_id` - (Optional, String) ID of vpc instance, required when type is `VPC`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tem application_service can be imported using the environmentId#applicationId#serviceName, e.g. + +``` +terraform import tencentcloud_tem_application_service.application_service en-dpxyydl5#app-jrl3346j#test0-1 +``` + diff --git a/config/docs/r/tem_environment.html.markdown b/config/docs/r/tem_environment.html.markdown new file mode 100644 index 0000000..572736a --- /dev/null +++ b/config/docs/r/tem_environment.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "TencentCloud Elastic Microservice(TEM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tem_environment" +sidebar_current: "docs-tencentcloud-resource-tem_environment" +description: |- + Provides a resource to create a tem environment +--- + +# tencentcloud_tem_environment + +Provides a resource to create a tem environment + +## Example Usage + +```hcl +resource "tencentcloud_tem_environment" "environment" { + environment_name = "demo" + description = "demo for test" + vpc = "vpc-2hfyray3" + subnet_ids = ["subnet-rdkj0agk", "subnet-r1c4pn5m", "subnet-02hcj95c"] + tags = { + "created" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `environment_name` - (Required, String) environment name. +* `subnet_ids` - (Required, Set: [`String`]) subnet IDs. +* `vpc` - (Required, String) vpc ID. +* `description` - (Optional, String) environment description. +* `tags` - (Optional, Map) environment tag list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tem environment can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tem_environment.environment environment_id +``` + diff --git a/config/docs/r/tem_gateway.html.markdown b/config/docs/r/tem_gateway.html.markdown new file mode 100644 index 0000000..dfe33ce --- /dev/null +++ b/config/docs/r/tem_gateway.html.markdown @@ -0,0 +1,111 @@ +--- +subcategory: "TencentCloud Elastic Microservice(TEM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tem_gateway" +sidebar_current: "docs-tencentcloud-resource-tem_gateway" +description: |- + Provides a resource to create a tem gateway +--- + +# tencentcloud_tem_gateway + +Provides a resource to create a tem gateway + +## Example Usage + +```hcl +resource "tencentcloud_tem_gateway" "gateway" { + ingress { + ingress_name = "demo" + environment_id = "en-853mggjm" + address_ip_version = "IPV4" + rewrite_type = "NONE" + mixed = false + rules { + host = "test.com" + protocol = "http" + http { + paths { + path = "/" + backend { + service_name = "demo" + service_port = 80 + } + } + } + } + rules { + host = "hello.com" + protocol = "http" + http { + paths { + path = "/" + backend { + service_name = "hello" + service_port = 36000 + } + } + } + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ingress` - (Optional, List) gateway properties. + +The `backend` object supports the following: + +* `service_name` - (Required, String) backend name. +* `service_port` - (Required, Int) backend port. + +The `http` object supports the following: + +* `paths` - (Required, List) path payload. + +The `ingress` object supports the following: + +* `address_ip_version` - (Required, String) ip version, support IPV4. +* `environment_id` - (Required, String, ForceNew) environment ID. +* `ingress_name` - (Required, String, ForceNew) gateway name. +* `mixed` - (Required, Bool) mixing HTTP and HTTPS. +* `rules` - (Required, List) proxy rules. +* `clb_id` - (Optional, String) related CLB ID, support binding existing clb, does not support modification. +* `rewrite_type` - (Optional, String) redirect mode, support AUTO and NONE. +* `tls` - (Optional, List) ingress TLS configurations. + +The `paths` object supports the following: + +* `backend` - (Required, List) backend payload. +* `path` - (Required, String) path. + +The `rules` object supports the following: + +* `http` - (Required, List) rule payload. +* `host` - (Optional, String) host name. +* `protocol` - (Optional, String) protocol. + +The `tls` object supports the following: + +* `certificate_id` - (Required, String) certificate ID. +* `hosts` - (Required, Set) host names. +* `secret_name` - (Optional, String) secret name, if you use a certificate, you don't need to fill in this field. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tem gateway can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tem_gateway.gateway environmentId#gatewayName +``` + diff --git a/config/docs/r/tem_log_config.html.markdown b/config/docs/r/tem_log_config.html.markdown new file mode 100644 index 0000000..8f4afd0 --- /dev/null +++ b/config/docs/r/tem_log_config.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "TencentCloud Elastic Microservice(TEM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tem_log_config" +sidebar_current: "docs-tencentcloud-resource-tem_log_config" +description: |- + Provides a resource to create a tem logConfig +--- + +# tencentcloud_tem_log_config + +Provides a resource to create a tem logConfig + +## Example Usage + +```hcl +resource "tencentcloud_tem_log_config" "logConfig" { + environment_id = "en-o5edaepv" + application_id = "app-3j29aa2p" + workload_id = resource.tencentcloud_tem_workload.workload.id + name = "terraform" + logset_id = "b5824781-8d5b-4029-a2f7-d03c37f72bdf" + topic_id = "5a85bb6d-8e41-4e04-b7bd-c05e04782f94" + input_type = "container_stdout" + log_type = "minimalist_log" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Required, String, ForceNew) application ID. +* `environment_id` - (Required, String, ForceNew) environment ID. +* `input_type` - (Required, String) container_stdout or container_file. +* `log_type` - (Required, String) minimalist_log or multiline_log. +* `logset_id` - (Required, String) logset. +* `name` - (Required, String, ForceNew) appConfig name. +* `topic_id` - (Required, String) topic. +* `workload_id` - (Required, String, ForceNew) application ID, which is combined by environment ID and application ID, like `en-o5edaepv#app-3j29aa2p`. +* `beginning_regex` - (Optional, String) regex pattern. +* `file_pattern` - (Optional, String) file name pattern if container_file. +* `log_path` - (Optional, String) directory if container_file. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tem logConfig can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tem_log_config.logConfig environmentId#applicationId#name +``` + diff --git a/config/docs/r/tem_scale_rule.html.markdown b/config/docs/r/tem_scale_rule.html.markdown new file mode 100644 index 0000000..bbf700b --- /dev/null +++ b/config/docs/r/tem_scale_rule.html.markdown @@ -0,0 +1,113 @@ +--- +subcategory: "TencentCloud Elastic Microservice(TEM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tem_scale_rule" +sidebar_current: "docs-tencentcloud-resource-tem_scale_rule" +description: |- + Provides a resource to create a tem scaleRule +--- + +# tencentcloud_tem_scale_rule + +Provides a resource to create a tem scaleRule + +## Example Usage + +```hcl +resource "tencentcloud_tem_scale_rule" "scaleRule" { + environment_id = "en-o5edaepv" + application_id = "app-3j29aa2p" + workload_id = resource.tencentcloud_tem_workload.workload.id + autoscaler { + autoscaler_name = "test3123" + description = "test" + enabled = true + min_replicas = 1 + max_replicas = 4 + cron_horizontal_autoscaler { + name = "test" + period = "* * *" + priority = 1 + enabled = true + schedules { + start_at = "03:00" + target_replicas = 1 + } + } + cron_horizontal_autoscaler { + name = "test123123" + period = "* * *" + priority = 0 + enabled = true + schedules { + start_at = "04:13" + target_replicas = 1 + } + } + horizontal_autoscaler { + metrics = "CPU" + enabled = true + max_replicas = 4 + min_replicas = 1 + threshold = 60 + } + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Required, String, ForceNew) application ID. +* `autoscaler` - (Required, List) . +* `environment_id` - (Required, String, ForceNew) environment ID. +* `workload_id` - (Required, String, ForceNew) application ID, which is combined by environment ID and application ID, like `en-o5edaepv#app-3j29aa2p`. + +The `autoscaler` object supports the following: + +* `autoscaler_name` - (Required, String) name. +* `enabled` - (Required, Bool) enable AutoScaler. +* `max_replicas` - (Required, Int) maximal replica number. +* `min_replicas` - (Required, Int) minimal replica number. +* `cron_horizontal_autoscaler` - (Optional, List) scaler based on cron configuration. +* `description` - (Optional, String) description. +* `horizontal_autoscaler` - (Optional, List) scaler based on metrics. + +The `cron_horizontal_autoscaler` object supports the following: + +* `enabled` - (Required, Bool) enable scaler. +* `name` - (Required, String) name. +* `period` - (Required, String) period. +* `priority` - (Required, Int) priority. +* `schedules` - (Required, List) schedule payload. + +The `horizontal_autoscaler` object supports the following: + +* `enabled` - (Required, Bool) enable scaler. +* `max_replicas` - (Required, Int) maximal replica number. +* `metrics` - (Required, String) metric name. +* `min_replicas` - (Required, Int) minimal replica number. +* `threshold` - (Required, Int) metric threshold. + +The `schedules` object supports the following: + +* `start_at` - (Required, String) start time. +* `target_replicas` - (Required, Int) target replica number. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tem scaleRule can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tem_scale_rule.scaleRule environmentId#applicationId#scaleRuleId +``` + diff --git a/config/docs/r/tem_workload.html.markdown b/config/docs/r/tem_workload.html.markdown new file mode 100644 index 0000000..ff60a81 --- /dev/null +++ b/config/docs/r/tem_workload.html.markdown @@ -0,0 +1,161 @@ +--- +subcategory: "TencentCloud Elastic Microservice(TEM)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tem_workload" +sidebar_current: "docs-tencentcloud-resource-tem_workload" +description: |- + Provides a resource to create a tem workload +--- + +# tencentcloud_tem_workload + +Provides a resource to create a tem workload + +## Example Usage + +```hcl +resource "tencentcloud_tem_workload" "workload" { + application_id = "app-j4d3x6kj" + environment_id = "en-85377m6j" + deploy_version = "hello-world" + deploy_mode = "IMAGE" + img_repo = "tem_demo/tem_demo" + repo_server = "ccr.ccs.tencentyun.com" + init_pod_num = 1 + cpu_spec = 1 + memory_spec = 1 + # liveness { + # type = "HttpGet" + # protocol = "HTTP" + # path = "/" + # port = 8080 + # initial_delay_seconds = 0 + # timeout_seconds = 1 + # period_seconds = 10 + + # } + # readiness { + # type = "HttpGet" + # protocol = "HTTP" + # path = "/" + # port = 8000 + # initial_delay_seconds = 0 + # timeout_seconds = 1 + # period_seconds = 10 + + # } + # startup_probe { + # type = "HttpGet" + # protocol = "HTTP" + # path = "/" + # port = 36000 + # initial_delay_seconds = 0 + # timeout_seconds = 1 + # period_seconds = 10 + + # } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Required, String, ForceNew) application ID. +* `cpu_spec` - (Required, Float64) cpu. +* `deploy_mode` - (Required, String) deploy mode, support IMAGE. +* `deploy_version` - (Required, String) deploy version. +* `environment_id` - (Required, String, ForceNew) environment ID. +* `img_repo` - (Required, String) repository name. +* `init_pod_num` - (Required, Int) initial pod number. +* `memory_spec` - (Required, Float64) mem. +* `deploy_strategy_conf` - (Optional, List) deploy strategy. +* `env_conf` - (Optional, List) . +* `liveness` - (Optional, List) liveness config. +* `post_start` - (Optional, String) mem. +* `pre_stop` - (Optional, String) mem. +* `readiness` - (Optional, List) . +* `repo_server` - (Optional, String) repo server addr when deploy by image. +* `repo_type` - (Optional, Int) repo type when deploy: 0: tcr personal; 1: tcr enterprise; 2: public repository; 3: tem host tcr; 4: demo repo. +* `security_group_ids` - (Optional, Set: [`String`]) security groups. +* `startup_probe` - (Optional, List) . +* `storage_confs` - (Optional, List) storage configuration. +* `storage_mount_confs` - (Optional, List) storage mount configuration. +* `tcr_instance_id` - (Optional, String) tcr instance id when deploy by image. + +The `deploy_strategy_conf` object supports the following: + +* `deploy_strategy_type` - (Required, Int) strategy type, 0 means auto, 1 means manual, 2 means manual with beta batch. +* `total_batch_count` - (Required, Int) total batch number. +* `batch_interval` - (Optional, Int) interval between batches. +* `beta_batch_num` - (Optional, Int) beta batch number. +* `force` - (Optional, Bool) force update. +* `min_available` - (Optional, Int) minimal available instances duration deployment. + +The `env_conf` object supports the following: + +* `key` - (Required, String) env key. +* `value` - (Required, String) env value. +* `config` - (Optional, String) referenced config name when type=referenced. +* `secret` - (Optional, String) referenced secret name when type=referenced. +* `type` - (Optional, String) env type, support default, referenced. + +The `liveness` object supports the following: + +* `type` - (Required, String) check type, support HttpGet, TcpSocket and Exec. +* `exec` - (Optional, String) script. +* `initial_delay_seconds` - (Optional, Int) initial delay seconds for liveness check. +* `path` - (Optional, String) path. +* `period_seconds` - (Optional, Int) period seconds for liveness check. +* `port` - (Optional, Int) liveness check port. +* `protocol` - (Optional, String) protocol. +* `timeout_seconds` - (Optional, Int) timeout seconds for liveness check. + +The `readiness` object supports the following: + +* `type` - (Required, String) check type, support HttpGet, TcpSocket and Exec. +* `exec` - (Optional, String) script. +* `initial_delay_seconds` - (Optional, Int) initial delay seconds for readiness check. +* `path` - (Optional, String) path. +* `period_seconds` - (Optional, Int) period seconds for readiness check. +* `port` - (Optional, Int) readiness check port. +* `protocol` - (Optional, String) protocol. +* `timeout_seconds` - (Optional, Int) timeout seconds for readiness check. + +The `startup_probe` object supports the following: + +* `type` - (Required, String) check type, support HttpGet, TcpSocket and Exec. +* `exec` - (Optional, String) script. +* `initial_delay_seconds` - (Optional, Int) initial delay seconds for startup check. +* `path` - (Optional, String) path. +* `period_seconds` - (Optional, Int) period seconds for startup check. +* `port` - (Optional, Int) startup check port. +* `protocol` - (Optional, String) protocol. +* `timeout_seconds` - (Optional, Int) timeout seconds for startup check. + +The `storage_confs` object supports the following: + +* `storage_vol_ip` - (Required, String) volume ip. +* `storage_vol_name` - (Required, String) volume name. +* `storage_vol_path` - (Required, String) volume path. + +The `storage_mount_confs` object supports the following: + +* `mount_path` - (Required, String) mount path. +* `volume_name` - (Required, String) volume name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tem workload can be imported using the id, e.g. +``` +$ terraform import tencentcloud_tem_workload.workload envirnomentId#applicationId +``` + diff --git a/config/docs/r/teo_acceleration_domain.html.markdown b/config/docs/r/teo_acceleration_domain.html.markdown new file mode 100644 index 0000000..efa1613 --- /dev/null +++ b/config/docs/r/teo_acceleration_domain.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "TencentCloud EdgeOne(TEO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_teo_acceleration_domain" +sidebar_current: "docs-tencentcloud-resource-teo_acceleration_domain" +description: |- + Provides a resource to create a teo acceleration_domain +--- + +# tencentcloud_teo_acceleration_domain + +Provides a resource to create a teo acceleration_domain + +## Example Usage + +```hcl +resource "tencentcloud_teo_acceleration_domain" "acceleration_domain" { + zone_id = "zone-2o0i41pv2h8c" + domain_name = "aaa.makn.cn" + + origin_info { + origin = "150.109.8.1" + origin_type = "IP_DOMAIN" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain_name` - (Required, String, ForceNew) Accelerated domain name. +* `origin_info` - (Required, List) Details of the origin. +* `zone_id` - (Required, String, ForceNew) ID of the site related with the accelerated domain name. +* `status` - (Optional, String) Accelerated domain name status, the values are: `online`: enabled; `offline`: disabled. + +The `origin_info` object supports the following: + +* `origin_type` - (Required, String) The origin type. Values: `IP_DOMAIN`: IPv4/IPv6 address or domain name; `COS`: COS bucket address; `ORIGIN_GROUP`: Origin group; `AWS_S3`: AWS S3 bucket address; `SPACE`: EdgeOne Shield Space. +* `origin` - (Required, String) The origin address. Enter the origin group ID if `OriginType=ORIGIN_GROUP`. +* `backup_origin` - (Optional, String) ID of the secondary origin group (valid when `OriginType=ORIGIN_GROUP`). If it is not specified, it indicates that secondary origins are not used. +* `private_access` - (Optional, String) Whether to authenticate access to the private object storage origin (valid when `OriginType=COS/AWS_S3`). Values: `on`: Enable private authentication; `off`: Disable private authentication. If this field is not specified, the default value `off` is used. +* `private_parameters` - (Optional, List) The private authentication parameters. This field is valid when `PrivateAccess=on`. + +The `private_parameters` object supports the following: + +* `name` - (Required, String) The parameter name. Valid values: `AccessKeyId`: Access Key ID; `SecretAccessKey`: Secret Access Key. +* `value` - (Required, String) The parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `cname` - CNAME address. + + +## Import + +teo acceleration_domain can be imported using the id, e.g. + +``` +terraform import tencentcloud_teo_acceleration_domain.acceleration_domain acceleration_domain_id +``` + diff --git a/config/docs/r/teo_application_proxy_rule.html.markdown b/config/docs/r/teo_application_proxy_rule.html.markdown new file mode 100644 index 0000000..9c6923a --- /dev/null +++ b/config/docs/r/teo_application_proxy_rule.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "TencentCloud EdgeOne(TEO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_teo_application_proxy_rule" +sidebar_current: "docs-tencentcloud-resource-teo_application_proxy_rule" +description: |- + Provides a resource to create a teo application_proxy_rule +--- + +# tencentcloud_teo_application_proxy_rule + +Provides a resource to create a teo application_proxy_rule + +## Example Usage + +```hcl +resource "tencentcloud_teo_application_proxy_rule" "application_proxy_rule" { + forward_client_ip = "TOA" + origin_type = "custom" + origin_port = "8083" + origin_value = [ + "127.0.0.1", + ] + port = [ + "8083", + ] + proto = "TCP" + proxy_id = "proxy-6972528a-373a-11ed-afca-52540044a456" + session_persist = false + status = "online" + zone_id = "zone-2983wizgxqvm" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `origin_port` - (Required, String) Origin port, supported formats: single port: 80; Port segment: 81-90, 81 to 90 ports. +* `origin_type` - (Required, String) Origin server type. Valid values: `custom`: Specified origins; `origins`: An origin group. +* `origin_value` - (Required, Set: [`String`]) Origin site information: When `OriginType` is `custom`, it indicates one or more origin sites, such as `['8.8.8.8', '9.9.9.9']` or `OriginValue=['test.com']`; When `OriginType` is `origins`, there is required to be one and only one element, representing the origin site group ID, such as `['origin-537f5b41-162a-11ed-abaa-525400c5da15']`. +* `port` - (Required, Set: [`String`]) Valid values: `80` means port 80; `81-90` means port range 81-90. +* `proto` - (Required, String) Protocol. Valid values: `TCP`, `UDP`. +* `proxy_id` - (Required, String) Proxy ID. +* `zone_id` - (Required, String) Site ID. +* `forward_client_ip` - (Optional, String) Passes the client IP. Default value is `OFF`. When Proto is TCP, valid values: `TOA`: Pass the client IP via TOA; `PPV1`: Pass the client IP via Proxy Protocol V1; `PPV2`: Pass the client IP via Proxy Protocol V2; `OFF`: Do not pass the client IP. When Proto=UDP, valid values: `PPV2`: Pass the client IP via Proxy Protocol V2; `OFF`: Do not pass the client IP. +* `session_persist` - (Optional, Bool) Specifies whether to enable session persistence. Default value is false. +* `status` - (Optional, String) Status, the values are: `online`: enabled; `offline`: deactivated; `progress`: being deployed; `stopping`: being deactivated; `fail`: deployment failure/deactivation failure. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `rule_id` - Rule ID. + + +## Import + +teo application_proxy_rule can be imported using the zoneId#proxyId#ruleId, e.g. +``` +terraform import tencentcloud_teo_application_proxy_rule.application_proxy_rule zone-2983wizgxqvm#proxy-6972528a-373a-11ed-afca-52540044a456#rule-90b13bb4-373a-11ed-8794-525400eddfed +``` + diff --git a/config/docs/r/teo_certificate_config.html.markdown b/config/docs/r/teo_certificate_config.html.markdown new file mode 100644 index 0000000..e556c0d --- /dev/null +++ b/config/docs/r/teo_certificate_config.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "TencentCloud EdgeOne(TEO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_teo_certificate_config" +sidebar_current: "docs-tencentcloud-resource-teo_certificate_config" +description: |- + Provides a resource to create a teo certificate +--- + +# tencentcloud_teo_certificate_config + +Provides a resource to create a teo certificate + +## Example Usage + +```hcl +resource "tencentcloud_teo_certificate_config" "certificate" { + host = "test.tencentcloud-terraform-provider.cn" + mode = "eofreecert" + zone_id = "zone-2o1t24kgy362" +} +``` + +### Configure SSL certificate + +```hcl +resource "tencentcloud_teo_certificate_config" "certificate" { + host = "test.tencentcloud-terraform-provider.cn" + mode = "sslcert" + zone_id = "zone-2o1t24kgy362" + + server_cert_info { + cert_id = "8xiUJIJd" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `host` - (Required, String, ForceNew) Acceleration domain name that needs to modify the certificate configuration. +* `zone_id` - (Required, String, ForceNew) Site ID. +* `mode` - (Optional, String) Mode of configuring the certificate, the values are: `disable`: Do not configure the certificate; `eofreecert`: Configure EdgeOne free certificate; `sslcert`: Configure SSL certificate. If not filled in, the default value is `disable`. +* `server_cert_info` - (Optional, List) SSL certificate configuration, this parameter takes effect only when mode = sslcert, just enter the corresponding CertId. You can go to the SSL certificate list to view the CertId. + +The `server_cert_info` object supports the following: + +* `cert_id` - (Required, String) ID of the server certificate.Note: This field may return null, indicating that no valid values can be obtained. +* `alias` - (Optional, String) Alias of the certificate.Note: This field may return null, indicating that no valid values can be obtained. +* `common_name` - (Optional, String) Domain name of the certificate. Note: This field may return `null`, indicating that no valid value can be obtained. +* `deploy_time` - (Optional, String) Time when the certificate is deployed. Note: This field may return null, indicating that no valid values can be obtained. +* `expire_time` - (Optional, String) Time when the certificate expires. Note: This field may return null, indicating that no valid values can be obtained. +* `sign_algo` - (Optional, String) Signature algorithm. Note: This field may return null, indicating that no valid values can be obtained. +* `type` - (Optional, String) Type of the certificate. Values: `default`: Default certificate; `upload`: Specified certificate; `managed`: Tencent Cloud-managed certificate. Note: This field may return `null`, indicating that no valid value can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +teo certificate can be imported using the id, e.g. + +``` +terraform import tencentcloud_teo_certificate_config.certificate zone_id#host#cert_id +``` + diff --git a/config/docs/r/teo_origin_group.html.markdown b/config/docs/r/teo_origin_group.html.markdown new file mode 100644 index 0000000..65a498f --- /dev/null +++ b/config/docs/r/teo_origin_group.html.markdown @@ -0,0 +1,92 @@ +--- +subcategory: "TencentCloud EdgeOne(TEO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_teo_origin_group" +sidebar_current: "docs-tencentcloud-resource-teo_origin_group" +description: |- + Provides a resource to create a teo origin_group +--- + +# tencentcloud_teo_origin_group + +Provides a resource to create a teo origin_group + +## Example Usage + +### Self origin group + +```hcl +resource "tencentcloud_teo_origin_group" "origin_group" { + zone_id = "zone-297z8rf93cfw" + configuration_type = "weight" + origin_group_name = "test-group" + origin_type = "self" + origin_records { + area = [] + port = 8080 + private = false + record = "150.109.8.1" + weight = 100 + } +} +``` + +### Cos origin group + +```hcl +resource "tencentcloud_teo_origin_group" "origin_group" { + configuration_type = "weight" + origin_group_name = "test" + origin_type = "cos" + zone_id = "zone-2o3h21ed8bpu" + + origin_records { + area = [] + port = 0 + private = true + record = "test-ruichaolin-1310708577.cos.ap-nanjing.myqcloud.com" + weight = 100 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `configuration_type` - (Required, String) Type of the origin group, this field should be set when `OriginType` is self, otherwise leave it empty. Valid values: `area`: select an origin by using Geo info of the client IP and `Area` field in Records; `weight`: weighted select an origin by using `Weight` field in Records; `proto`: config by HTTP protocol. +* `origin_group_name` - (Required, String) OriginGroup Name. +* `origin_records` - (Required, List) Origin site records. +* `origin_type` - (Required, String) Type of the origin site. Valid values: `self`: self-build website; `cos`: tencent cos; `third_party`: third party cos. +* `zone_id` - (Required, String, ForceNew) Site ID. + +The `origin_records` object supports the following: + +* `port` - (Required, Int) Port of the origin site. Valid value range: 1-65535. +* `record` - (Required, String) Record value, which could be an IPv4/IPv6 address or a domain. +* `area` - (Optional, Set) Indicating origin sites area when `Type` field is `area`. An empty List indicate the default area. Valid value:- Asia, Americas, Europe, Africa or Oceania. +* `private_parameter` - (Optional, List) Parameters for private authentication. Only valid when `Private` is `true`. +* `private` - (Optional, Bool) Whether origin site is using private authentication. Only valid when `OriginType` is `third_party`. +* `weight` - (Optional, Int) Indicating origin sites weight when `Type` field is `weight`. Valid value range: 1-100. Sum of all weights should be 100. + +The `private_parameter` object supports the following: + +* `name` - (Required, String) Parameter Name. Valid values: `AccessKeyId`: Access Key ID; `SecretAccessKey`: Secret Access Key. +* `value` - (Required, String) Parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `origin_group_id` - OriginGroup ID. +* `update_time` - Last modification date. + + +## Import + +teo origin_group can be imported using the zone_id#originGroup_id, e.g. +```` +terraform import tencentcloud_teo_origin_group.origin_group zone-297z8rf93cfw#origin-4f8a30b2-3720-11ed-b66b-525400dceb86 +```` + diff --git a/config/docs/r/teo_ownership_verify.html.markdown b/config/docs/r/teo_ownership_verify.html.markdown new file mode 100644 index 0000000..66bc841 --- /dev/null +++ b/config/docs/r/teo_ownership_verify.html.markdown @@ -0,0 +1,36 @@ +--- +subcategory: "TencentCloud EdgeOne(TEO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_teo_ownership_verify" +sidebar_current: "docs-tencentcloud-resource-teo_ownership_verify" +description: |- + Provides a resource to create a teo ownership_verify +--- + +# tencentcloud_teo_ownership_verify + +Provides a resource to create a teo ownership_verify + +## Example Usage + +```hcl +resource "tencentcloud_teo_ownership_verify" "ownership_verify" { + domain = "qq.com" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Verify domain name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `result` - When the verification result is failed, this field will return the reason. +* `status` - Ownership verification results. `success`: verification successful; `fail`: verification failed. + + diff --git a/config/docs/r/teo_rule_engine.html.markdown b/config/docs/r/teo_rule_engine.html.markdown new file mode 100644 index 0000000..a24cc72 --- /dev/null +++ b/config/docs/r/teo_rule_engine.html.markdown @@ -0,0 +1,234 @@ +--- +subcategory: "TencentCloud EdgeOne(TEO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_teo_rule_engine" +sidebar_current: "docs-tencentcloud-resource-teo_rule_engine" +description: |- + Provides a resource to create a teo rule_engine +--- + +# tencentcloud_teo_rule_engine + +Provides a resource to create a teo rule_engine + +## Example Usage + +```hcl +resource "tencentcloud_teo_rule_engine" "rule1" { + zone_id = tencentcloud_teo_zone.example.id + rule_name = "test-rule" + status = "disable" + + rules { + actions { + normal_action { + action = "UpstreamUrlRedirect" + parameters { + name = "Type" + values = [ + "Path", + ] + } + parameters { + name = "Action" + values = [ + "addPrefix", + ] + } + parameters { + name = "Value" + values = [ + "/sss", + ] + } + } + } + + or { + and { + operator = "equal" + target = "host" + ignore_case = false + values = [ + "a.tf-teo-t.xyz", + ] + } + and { + operator = "equal" + target = "extension" + ignore_case = false + values = [ + "jpg", + ] + } + } + or { + and { + operator = "equal" + target = "filename" + ignore_case = false + values = [ + "test.txt", + ] + } + } + + sub_rules { + tags = ["png"] + rules { + or { + and { + operator = "notequal" + target = "host" + ignore_case = false + values = [ + "a.tf-teo-t.xyz", + ] + } + and { + operator = "equal" + target = "extension" + ignore_case = false + values = [ + "png", + ] + } + } + or { + and { + operator = "notequal" + target = "filename" + ignore_case = false + values = [ + "test.txt", + ] + } + } + actions { + normal_action { + action = "UpstreamUrlRedirect" + parameters { + name = "Type" + values = [ + "Path", + ] + } + parameters { + name = "Action" + values = [ + "addPrefix", + ] + } + parameters { + name = "Value" + values = [ + "/www", + ] + } + } + } + } + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `rule_name` - (Required, String) The rule name (1 to 255 characters). +* `rules` - (Required, List) Rule items list. +* `status` - (Required, String) Rule status. Values: `enable`: Enabled; `disable`: Disabled. +* `zone_id` - (Required, String, ForceNew) ID of the site. +* `tags` - (Optional, Set: [`String`]) rule tag list. + +The `actions` object supports the following: + +* `code_action` - (Optional, List) Define a code action. +* `normal_action` - (Optional, List) Define a normal action. +* `rewrite_action` - (Optional, List) Define a rewrite action. + +The `and` object supports the following: + +* `operator` - (Required, String) Condition operator. Valid values are `equal`, `notequal`. +* `target` - (Required, String) Condition target. Valid values:- `host`: Host of the URL.- `filename`: filename of the URL.- `extension`: file extension of the URL.- `full_url`: full url.- `url`: path of the URL. +* `values` - (Required, Set) Condition Value. +* `ignore_case` - (Optional, Bool) Whether to ignore the case of the parameter value, the default value is false. +* `name` - (Optional, String) The parameter name corresponding to the matching type is valid when the Target value is the following, and the valid value cannot be empty: `query_string` (query string): The parameter name of the query string in the URL request under the current site, such as lang and version in lang=cn&version=1; `request_header` (HTTP request header): HTTP request header field name, such as Accept-Language in Accept-Language:zh-CN,zh;q=0.9. + +The `and` object supports the following: + +* `operator` - (Required, String) Condition operator. Valid values are `equal`, `notequal`. +* `target` - (Required, String) Condition target. Valid values:- `host`: Host of the URL.- `filename`: filename of the URL.- `extension`: file extension of the URL.- `full_url`: full url.- `url`: path of the URL. +* `values` - (Required, Set) Condition Value. +* `ignore_case` - (Optional, Bool) Whether to ignore the case of the parameter value, the default value is false. +* `name` - (Optional, String) The parameter name corresponding to the matching type is valid when the Target value is the following, and the valid value cannot be empty:- `query_string` (query string): The parameter name of the query string in the URL request under the current site, such as lang and version in lang=cn&version=1; `request_header` (HTTP request header): HTTP request header field name, such as Accept-Language in Accept-Language:zh-CN,zh;q=0.9. + +The `code_action` object supports the following: + +* `action` - (Required, String) Action name. +* `parameters` - (Required, List) Action parameters. + +The `normal_action` object supports the following: + +* `action` - (Required, String) Action name. +* `parameters` - (Required, List) Action parameters. + +The `or` object supports the following: + +* `and` - (Required, List) AND Conditions list of the rule. Rule would be triggered if all conditions are true. + +The `parameters` object supports the following: + +* `action` - (Required, String) Action to take on the HEADER. Valid values: `add`, `del`, `set`. +* `name` - (Required, String) Target HEADER name. +* `values` - (Required, Set) Parameter Value. + +The `parameters` object supports the following: + +* `name` - (Required, String) Parameter Name. +* `status_code` - (Required, Int) HTTP status code to use. +* `values` - (Required, Set) Parameter Values. + +The `parameters` object supports the following: + +* `name` - (Required, String) Parameter Name. +* `values` - (Required, Set) Parameter Values. + +The `rewrite_action` object supports the following: + +* `action` - (Required, String) Action name. +* `parameters` - (Required, List) Action parameters. + +The `rules` object supports the following: + +* `actions` - (Required, List) Actions list of the rule. See details in data source `rule_engine_setting`. +* `or` - (Required, List) OR Conditions list of the rule. Rule would be triggered if any of the condition is true. + +The `rules` object supports the following: + +* `actions` - (Required, List) Actions list of the rule. See details in data source `rule_engine_setting`. +* `or` - (Required, List) OR Conditions list of the rule. Rule would be triggered if any of the condition is true. +* `sub_rules` - (Optional, List) Actions list of the rule. See details in data source `rule_engine_setting`. + +The `sub_rules` object supports the following: + +* `rules` - (Required, List) Rule items list. +* `tags` - (Optional, Set) rule tag list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `rule_id` - Rule ID. + + +## Import + +teo rule_engine can be imported using the id#rule_id, e.g. +``` +terraform import tencentcloud_teo_rule_engine.rule_engine zone-297z8rf93cfw#rule-ajol584a +``` + diff --git a/config/docs/r/teo_zone.html.markdown b/config/docs/r/teo_zone.html.markdown new file mode 100644 index 0000000..54aceff --- /dev/null +++ b/config/docs/r/teo_zone.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "TencentCloud EdgeOne(TEO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_teo_zone" +sidebar_current: "docs-tencentcloud-resource-teo_zone" +description: |- + Provides a resource to create a teo zone +--- + +# tencentcloud_teo_zone + +Provides a resource to create a teo zone + +## Example Usage + +```hcl +resource "tencentcloud_teo_zone" "zone" { + zone_name = "tf-teo.com" + type = "partial" + area = "overseas" + alias_zone_name = "teo-test" + paused = false + plan_id = "edgeone-2kfv1h391n6w" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `area` - (Required, String) When the `type` value is `partial` or `full`, the acceleration region of the L7 domain name. The following are the values of this parameter, and the default value is `overseas` if not filled in. When the `type` value is `noDomainAccess`, please leave this value empty. Valid values: `global`: Global availability zone; `mainland`: Chinese mainland availability zone; `overseas`: Global availability zone (excluding Chinese mainland). +* `plan_id` - (Required, String, ForceNew) The target Plan ID to be bound. When you have an existing Plan in your account, you can fill in this parameter to directly bind the site to the Plan. If you do not have a Plan that can be bound at the moment, please go to the console to purchase a Plan to complete the site creation. +* `type` - (Required, String) Site access type. The value of this parameter is as follows, and the default is `partial` if not filled in. Valid values: `partial`: CNAME access; `full`: NS access; `noDomainAccess`: No domain access. +* `zone_name` - (Required, String, ForceNew) Site name. When accessing CNAME/NS, please pass the second-level domain (example.com) as the site name; when accessing without a domain name, please leave this value empty. +* `alias_zone_name` - (Optional, String) Alias site identifier. Limit the input to a combination of numbers, English, - and _, within 20 characters. For details, refer to the alias site identifier. If there is no such usage scenario, leave this field empty. +* `paused` - (Optional, Bool) Indicates whether the site is disabled. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `name_servers` - NS list allocated by Tencent Cloud. +* `ownership_verification` - Ownership verification information. Note: This field may return null, indicating that no valid value can be obtained. + * `dns_verification` - CNAME access, using DNS to resolve the information required for authentication. For details, please refer to [Site/Domain Name Ownership Verification ](https://cloud.tencent.com/document/product/1552/70789#7af6ecf8-afca-4e35-8811-b5797ed1bde5). Note: This field may return null, indicating that no valid value can be obtained. + * `record_type` - Record type. + * `record_value` - Record the value. + * `subdomain` - Host record. +* `status` - Site status. Valid values: `active`: NS is switched; `pending`: NS is not switched; `moved`: NS is moved; `deactivated`: this site is blocked. + + +## Import + +teo zone can be imported using the id, e.g. +``` +terraform import tencentcloud_teo_zone.zone zone_id +``` + diff --git a/config/docs/r/teo_zone_setting.html.markdown b/config/docs/r/teo_zone_setting.html.markdown new file mode 100644 index 0000000..49585f0 --- /dev/null +++ b/config/docs/r/teo_zone_setting.html.markdown @@ -0,0 +1,269 @@ +--- +subcategory: "TencentCloud EdgeOne(TEO)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_teo_zone_setting" +sidebar_current: "docs-tencentcloud-resource-teo_zone_setting" +description: |- + Provides a resource to create a teo zone_setting +--- + +# tencentcloud_teo_zone_setting + +Provides a resource to create a teo zone_setting + +## Example Usage + +```hcl +resource "tencentcloud_teo_zone_setting" "zone_setting" { + zone_id = "zone-297z8rf93cfw" + + cache { + + follow_origin { + switch = "on" + } + + no_cache { + switch = "off" + } + } + + cache_key { + full_url_cache = "on" + ignore_case = "off" + + query_string { + action = "includeCustom" + switch = "off" + value = [] + } + } + + cache_prefresh { + percent = 90 + switch = "off" + } + + client_ip_header { + switch = "off" + } + + compression { + algorithms = [ + "brotli", + "gzip", + ] + switch = "on" + } + + force_redirect { + redirect_status_code = 302 + switch = "off" + } + + https { + http2 = "on" + ocsp_stapling = "off" + tls_version = [ + "TLSv1", + "TLSv1.1", + "TLSv1.2", + "TLSv1.3", + ] + + hsts { + include_sub_domains = "off" + max_age = 0 + preload = "off" + switch = "off" + } + } + + ipv6 { + switch = "off" + } + + max_age { + follow_origin = "on" + max_age_time = 0 + } + + offline_cache { + switch = "on" + } + + origin { + backup_origins = [] + origin_pull_protocol = "follow" + origins = [] + } + + post_max_size { + max_size = 524288000 + switch = "on" + } + + quic { + switch = "off" + } + + smart_routing { + switch = "off" + } + + upstream_http2 { + switch = "off" + } + + web_socket { + switch = "off" + timeout = 30 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `zone_id` - (Required, String, ForceNew) Site ID. +* `cache_key` - (Optional, List) Node cache key configuration. +* `cache_prefresh` - (Optional, List) Cache pre-refresh configuration. +* `cache` - (Optional, List) Cache expiration time configuration. +* `client_ip_header` - (Optional, List) Origin-pull client IP header configuration. +* `compression` - (Optional, List) Smart compression configuration. +* `force_redirect` - (Optional, List) Force HTTPS redirect configuration. +* `https` - (Optional, List) HTTPS acceleration configuration. +* `ipv6` - (Optional, List) IPv6 access configuration. +* `max_age` - (Optional, List) Browser cache configuration. +* `offline_cache` - (Optional, List) Offline cache configuration. +* `origin` - (Optional, List) Origin server configuration. +* `post_max_size` - (Optional, List) Maximum size of files transferred over POST request. +* `quic` - (Optional, List) QUIC access configuration. +* `smart_routing` - (Optional, List) Smart acceleration configuration. +* `upstream_http2` - (Optional, List) HTTP2 origin-pull configuration. +* `web_socket` - (Optional, List) WebSocket configuration. + +The `cache_key` object supports the following: + +* `full_url_cache` - (Optional, String) Specifies whether to enable full-path cache.- `on`: Enable full-path cache (i.e., disable Ignore Query String).- `off`: Disable full-path cache (i.e., enable Ignore Query String). Note: This field may return null, indicating that no valid value can be obtained. +* `ignore_case` - (Optional, String) Specifies whether the cache key is case-sensitive. Note: This field may return null, indicating that no valid value can be obtained. +* `query_string` - (Optional, List) Request parameter contained in CacheKey. Note: This field may return null, indicating that no valid value can be obtained. + +The `cache_prefresh` object supports the following: + +* `switch` - (Required, String) Specifies whether to enable cache prefresh.- `on`: Enable.- `off`: Disable. +* `percent` - (Optional, Int) Percentage of cache time before try to prefresh. Valid value range: 1-99. + +The `cache` object supports the following: + +* `cache_time` - (Optional, Int) Cache expiration time settings, Unit: second. The maximum value is 365 days. Note: This field may return null, indicating that no valid value can be obtained. +* `ignore_cache_control` - (Optional, String) Specifies whether to enable force cache. Valid values: `on`: Enable; `off`: Disable. Note: This field may return null, indicating that no valid value can be obtained. +* `switch` - (Optional, String) Cache configuration switch. Valid values: `on`: Enable; `off`: Disable. Note: This field may return null, indicating that no valid value can be obtained. + +The `cache` object supports the following: + +* `cache` - (Optional, List) Cache configuration. Note: This field may return null, indicating that no valid value can be obtained. +* `follow_origin` - (Optional, List) Follows the origin server configuration. Note: This field may return null, indicating that no valid value can be obtained. +* `no_cache` - (Optional, List) No-cache configuration. Note: This field may return null, indicating that no valid value can be obtained. + +The `client_ip_header` object supports the following: + +* `switch` - (Required, String) Specifies whether to enable client IP header.- `on`: Enable.- `off`: Disable. Note: This field may return null, indicating that no valid value can be obtained. +* `header_name` - (Optional, String) Name of the origin-pull client IP request header. Note: This field may return null, indicating that no valid value can be obtained. + +The `compression` object supports the following: + +* `switch` - (Required, String) Whether to enable Smart compression.- `on`: Enable.- `off`: Disable. +* `algorithms` - (Optional, Set) Compression algorithms to select. Valid values: `brotli`, `gzip`. + +The `follow_origin` object supports the following: + +* `switch` - (Optional, String) Specifies whether to follow the origin server configuration.- `on`: Enable.- `off`: Disable. Note: This field may return null, indicating that no valid value can be obtained. + +The `force_redirect` object supports the following: + +* `switch` - (Required, String) Whether to enable force redirect.- `on`: Enable.- `off`: Disable. +* `redirect_status_code` - (Optional, Int) Redirection status code.- 301- 302 Note: This field may return null, indicating that no valid value can be obtained. + +The `hsts` object supports the following: + +* `switch` - (Required, String) - `on`: Enable.- `off`: Disable. +* `include_sub_domains` - (Optional, String) Specifies whether to include subdomain names. Valid values: `on` and `off`. Note: This field may return null, indicating that no valid value can be obtained. +* `max_age` - (Optional, Int) MaxAge value in seconds, should be no more than 1 day. Note: This field may return null, indicating that no valid value can be obtained. +* `preload` - (Optional, String) Specifies whether to preload. Valid values: `on` and `off`. Note: This field may return null, indicating that no valid value can be obtained. + +The `https` object supports the following: + +* `hsts` - (Optional, List) HSTS Configuration. Note: This field may return null, indicating that no valid value can be obtained. +* `http2` - (Optional, String) HTTP2 configuration switch.- `on`: Enable.- `off`: Disable. Note: This field may return null, indicating that no valid value can be obtained. +* `ocsp_stapling` - (Optional, String) OCSP configuration switch.- `on`: Enable.- `off`: Disable.It is disabled by default. Note: This field may return null, indicating that no valid value can be obtained. +* `tls_version` - (Optional, Set) TLS version settings. Valid values: `TLSv1`, `TLSV1.1`, `TLSV1.2`, and `TLSv1.3`.Only consecutive versions can be enabled at the same time. Note: This field may return null, indicating that no valid value can be obtained. + +The `ipv6` object supports the following: + +* `switch` - (Required, String) - `on`: Enable.- `off`: Disable. + +The `max_age` object supports the following: + +* `follow_origin` - (Optional, String) Specifies whether to follow the max cache age of the origin server.- `on`: Enable.- `off`: Disable.If is on, MaxAgeTime is ignored. Note: This field may return null, indicating that no valid value can be obtained. +* `max_age_time` - (Optional, Int) Specifies the max age of the cache (in seconds). The maximum value is 365 days. Note: the value 0 means not to cache. Note: This field may return null, indicating that no valid value can be obtained. + +The `no_cache` object supports the following: + +* `switch` - (Optional, String) Whether to cache the configuration. Valid values: `on`: Do not cache; `off`: Cache. Note: This field may return null, indicating that no valid value can be obtained. + +The `offline_cache` object supports the following: + +* `switch` - (Required, String) Whether to enable offline cache.- `on`: Enable.- `off`: Disable. Note: This field may return null, indicating that no valid value can be obtained. + +The `origin` object supports the following: + +* `backup_origins` - (Optional, Set) Backup origin sites list. Note: This field may return null, indicating that no valid value can be obtained. +* `cos_private_access` - (Optional, String) Whether access private cos bucket is allowed when `OriginType` is cos. Note: This field may return null, indicating that no valid value can be obtained. +* `origin_pull_protocol` - (Optional, String) Origin-pull protocol.- `http`: Switch HTTPS requests to HTTP.- `follow`: Follow the protocol of the request.- `https`: Switch HTTP requests to HTTPS. This only supports port 443 on the origin server. Note: This field may return null, indicating that no valid value can be obtained. +* `origins` - (Optional, Set) Origin sites list. Note: This field may return null, indicating that no valid value can be obtained. + +The `post_max_size` object supports the following: + +* `switch` - (Required, String) Specifies whether to enable custom setting of the maximum file size.- `on`: Enable. You can set a custom max size.- `off`: Disable. In this case, the max size defaults to 32 MB. +* `max_size` - (Optional, Int) Maximum size. Value range: 1-500 MB. Note: This field may return null, indicating that no valid value can be obtained. + +The `query_string` object supports the following: + +* `switch` - (Required, String) Whether to use QueryString as part of CacheKey.- `on`: Enable.- `off`: Disable. Note: This field may return null, indicating that no valid value can be obtained. +* `action` - (Optional, String) - `includeCustom`: Include the specified query strings.- `excludeCustom`: Exclude the specified query strings. Note: This field may return null, indicating that no valid value can be obtained. +* `value` - (Optional, Set) Array of query strings used/excluded. Note: This field may return null, indicating that no valid value can be obtained. + +The `quic` object supports the following: + +* `switch` - (Required, String) Whether to enable QUIC.- `on`: Enable.- `off`: Disable. + +The `smart_routing` object supports the following: + +* `switch` - (Required, String) Whether to enable smart acceleration.- `on`: Enable.- `off`: Disable. + +The `upstream_http2` object supports the following: + +* `switch` - (Required, String) Whether to enable HTTP2 origin-pull.- `on`: Enable.- `off`: Disable. + +The `web_socket` object supports the following: + +* `switch` - (Required, String) Whether to enable custom WebSocket timeout setting. When is off: it means to keep the default WebSocket connection timeout period, which is 15 seconds. To change the timeout period, please set it to on. +* `timeout` - (Optional, Int) Sets timeout period in seconds. Maximum value: 120. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `area` - Acceleration area of the zone. Valid values: `mainland`, `overseas`. + + +## Import + +teo zone_setting can be imported using the zone_id, e.g. +``` +terraform import tencentcloud_teo_zone_setting.zone_setting zone-297z8rf93cfw# +``` + diff --git a/config/docs/r/trocket_rocketmq_consumer_group.html.markdown b/config/docs/r/trocket_rocketmq_consumer_group.html.markdown new file mode 100644 index 0000000..f7a98f4 --- /dev/null +++ b/config/docs/r/trocket_rocketmq_consumer_group.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_trocket_rocketmq_consumer_group" +sidebar_current: "docs-tencentcloud-resource-trocket_rocketmq_consumer_group" +description: |- + Provides a resource to create a trocket rocketmq_consumer_group +--- + +# tencentcloud_trocket_rocketmq_consumer_group + +Provides a resource to create a trocket rocketmq_consumer_group + +## Example Usage + +```hcl +resource "tencentcloud_trocket_rocketmq_instance" "rocketmq_instance" { + instance_type = "EXPERIMENT" + name = "test" + sku_code = "experiment_500" + remark = "test" + vpc_id = "vpc-xxxxxx" + subnet_id = "subnet-xxxxx" + tags = { + tag_key = "rocketmq" + tag_value = "5.x" + } +} + +resource "tencentcloud_trocket_rocketmq_consumer_group" "rocketmq_consumer_group" { + instance_id = tencentcloud_trocket_rocketmq_instance.rocketmq_instance.id + consumer_group = "test_consumer_group" + max_retry_times = 20 + consume_enable = false + consume_message_orderly = true + remark = "test for terraform" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `consume_enable` - (Required, Bool) Whether to enable consumption. +* `consume_message_orderly` - (Required, Bool) `true`: Sequential delivery, `false`: Concurrent delivery. +* `consumer_group` - (Required, String, ForceNew) Name of consumer group. +* `instance_id` - (Required, String, ForceNew) Instance ID. +* `max_retry_times` - (Required, Int) Max retry times. +* `remark` - (Optional, String) remark. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +trocket rocketmq_consumer_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_trocket_rocketmq_consumer_group.rocketmq_consumer_group instanceId#consumerGroup +``` + diff --git a/config/docs/r/trocket_rocketmq_instance.html.markdown b/config/docs/r/trocket_rocketmq_instance.html.markdown new file mode 100644 index 0000000..1ed0723 --- /dev/null +++ b/config/docs/r/trocket_rocketmq_instance.html.markdown @@ -0,0 +1,92 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_trocket_rocketmq_instance" +sidebar_current: "docs-tencentcloud-resource-trocket_rocketmq_instance" +description: |- + Provides a resource to create a rocketmq 5.x instance +--- + +# tencentcloud_trocket_rocketmq_instance + +Provides a resource to create a rocketmq 5.x instance + +~> **NOTE:** It only support create postpaid rocketmq 5.x instance. + +## Example Usage + +### Basic Instance + +```hcl +resource "tencentcloud_trocket_rocketmq_instance" "rocketmq_instance" { + instance_type = "EXPERIMENT" + name = "rocketmq-instance" + sku_code = "experiment_500" + remark = "remark" + vpc_id = "vpc-xxxxxx" + subnet_id = "subnet-xxxxxx" + tags = { + tag_key = "rocketmq" + tag_value = "5.x" + } +} +``` + +### Enable Public Instance + +```hcl +resource "tencentcloud_trocket_rocketmq_instance" "rocketmq_instance_public" { + instance_type = "EXPERIMENT" + name = "rocketmq-enable-public-instance" + sku_code = "experiment_500" + remark = "remark" + vpc_id = "vpc-xxxxxx" + subnet_id = "subnet-xxxxxx" + tags = { + tag_key = "rocketmq" + tag_value = "5.x" + } + enable_public = true + bandwidth = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_type` - (Required, String) Instance type. Valid values: `EXPERIMENT`, `BASIC`, `PRO`, `PLATINUM`. +* `name` - (Required, String) Instance name. +* `sku_code` - (Required, String) SKU code. Available specifications are as follows: experiment_500, basic_1k, basic_2k, basic_4k, basic_6k. +* `subnet_id` - (Required, String) Subnet id. +* `vpc_id` - (Required, String) VPC id. +* `bandwidth` - (Optional, Int) Public network bandwidth. `bandwidth` must be greater than zero when `enable_public` equal true. +* `enable_public` - (Optional, Bool) Whether to enable the public network. Must set `bandwidth` when `enable_public` equal true. +* `ip_rules` - (Optional, List) Public network access whitelist. +* `message_retention` - (Optional, Int) Message retention time in hours. +* `remark` - (Optional, String) Remark. +* `tags` - (Optional, Map) Tag description list. + +The `ip_rules` object supports the following: + +* `allow` - (Required, Bool) Whether to allow release or not. +* `ip` - (Required, String) IP. +* `remark` - (Required, String) Remark. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `public_end_point` - Public network access address. +* `vpc_end_point` - VPC access address. + + +## Import + +trocket rocketmq_instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_trocket_rocketmq_instance.rocketmq_instance rocketmq_instance_id +``` + diff --git a/config/docs/r/trocket_rocketmq_role.html.markdown b/config/docs/r/trocket_rocketmq_role.html.markdown new file mode 100644 index 0000000..68de0f9 --- /dev/null +++ b/config/docs/r/trocket_rocketmq_role.html.markdown @@ -0,0 +1,75 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_trocket_rocketmq_role" +sidebar_current: "docs-tencentcloud-resource-trocket_rocketmq_role" +description: |- + Provides a resource to create a trocket rocketmq_role +--- + +# tencentcloud_trocket_rocketmq_role + +Provides a resource to create a trocket rocketmq_role + +## Example Usage + +```hcl +resource "tencentcloud_trocket_rocketmq_instance" "rocketmq_instance" { + instance_type = "EXPERIMENT" + name = "test_role" + sku_code = "experiment_500" + remark = "test" + vpc_id = "vpc-xxxxx" + subnet_id = "subnet-xxxxx" + tags = { + tag_key = "rocketmq" + tag_value = "5.x" + } +} + +resource "tencentcloud_trocket_rocketmq_role" "rocketmq_role" { + instance_id = tencentcloud_trocket_rocketmq_instance.rocketmq_instance.id + role = "test_role" + remark = "test for terraform" + perm_write = false + perm_read = true +} + +output "access_key" { + value = tencentcloud_trocket_rocketmq_role.rocketmq_role.access_key +} + +output "secret_key" { + value = tencentcloud_trocket_rocketmq_role.rocketmq_role.secret_key +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) ID of instance. +* `perm_read` - (Required, Bool) Whether to enable consumption permission. +* `perm_write` - (Required, Bool) Whether to enable production permission. +* `remark` - (Required, String) remark. +* `role` - (Required, String, ForceNew) Name of role. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `access_key` - Access key. +* `created_time` - Created time. +* `modified_time` - Modified time. +* `secret_key` - Secret key. + + +## Import + +trocket rocketmq_role can be imported using the id, e.g. + +``` +terraform import tencentcloud_trocket_rocketmq_role.rocketmq_role instanceId#role +``` + diff --git a/config/docs/r/trocket_rocketmq_topic.html.markdown b/config/docs/r/trocket_rocketmq_topic.html.markdown new file mode 100644 index 0000000..c974bc5 --- /dev/null +++ b/config/docs/r/trocket_rocketmq_topic.html.markdown @@ -0,0 +1,64 @@ +--- +subcategory: "TDMQ for RocketMQ(trocket)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_trocket_rocketmq_topic" +sidebar_current: "docs-tencentcloud-resource-trocket_rocketmq_topic" +description: |- + Provides a resource to create a trocket rocketmq_topic +--- + +# tencentcloud_trocket_rocketmq_topic + +Provides a resource to create a trocket rocketmq_topic + +## Example Usage + +```hcl +resource "tencentcloud_trocket_rocketmq_instance" "rocketmq_instance" { + instance_type = "EXPERIMENT" + name = "test" + sku_code = "experiment_500" + remark = "test" + vpc_id = "vpc-xxxxx" + subnet_id = "subnet-xxxxx" + tags = { + tag_key = "rocketmq" + tag_value = "5.x" + } +} + +resource "tencentcloud_trocket_rocketmq_topic" "rocketmq_topic" { + instance_id = tencentcloud_trocket_rocketmq_instance.rocketmq_instance.id + topic = "test_topic" + topic_type = "NORMAL" + queue_num = 4 + remark = "test for terraform" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) Instance Id. +* `queue_num` - (Required, Int) Number of queue. Must be greater than or equal to 3. +* `topic_type` - (Required, String, ForceNew) Topic type. `UNSPECIFIED`: not specified, `NORMAL`: normal message, `FIFO`: sequential message, `DELAY`: delayed message. +* `topic` - (Required, String, ForceNew) topic. +* `remark` - (Optional, String) remark. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +trocket rocketmq_topic can be imported using the id, e.g. + +``` +terraform import tencentcloud_trocket_rocketmq_topic.rocketmq_topic instanceId#topic +``` + diff --git a/config/docs/r/tse_cngw_canary_rule.html.markdown b/config/docs/r/tse_cngw_canary_rule.html.markdown new file mode 100644 index 0000000..11870b4 --- /dev/null +++ b/config/docs/r/tse_cngw_canary_rule.html.markdown @@ -0,0 +1,123 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_cngw_canary_rule" +sidebar_current: "docs-tencentcloud-resource-tse_cngw_canary_rule" +description: |- + Provides a resource to create a tse cngw_canary_rule +--- + +# tencentcloud_tse_cngw_canary_rule + +Provides a resource to create a tse cngw_canary_rule + +## Example Usage + +```hcl +resource "tencentcloud_tse_cngw_service" "cngw_service" { + gateway_id = "gateway-ddbb709b" + name = "terraform-test" + path = "/test" + protocol = "http" + retries = 5 + tags = { + "created" = "terraform" + } + timeout = 6000 + upstream_type = "IPList" + + upstream_info { + algorithm = "round-robin" + auto_scaling_cvm_port = 80 + auto_scaling_group_id = "asg-519acdug" + auto_scaling_hook_status = "Normal" + auto_scaling_tat_cmd_status = "Normal" + port = 0 + slow_start = 20 + + targets { + health = "HEALTHCHECKS_OFF" + host = "192.168.0.1" + port = 80 + weight = 100 + } + } +} + +resource "tencentcloud_tse_cngw_canary_rule" "cngw_canary_rule" { + gateway_id = tencentcloud_tse_cngw_service.cngw_service.gateway_id + service_id = tencentcloud_tse_cngw_service.cngw_service.service_id + tags = { + "created" = "terraform" + } + + canary_rule { + enabled = true + priority = 100 + + balanced_service_list { + percent = 100 + service_id = tencentcloud_tse_cngw_service.cngw_service.service_id + service_name = tencentcloud_tse_cngw_service.cngw_service.name + } + + condition_list { + key = "test" + operator = "eq" + type = "query" + value = "1" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `canary_rule` - (Required, List) canary rule configuration. +* `gateway_id` - (Required, String) gateway ID. +* `service_id` - (Required, String) service ID. +* `tags` - (Optional, Map) Tag description list. + +The `balanced_service_list` object supports the following: + +* `percent` - (Optional, Float64) percent, 10 is 10%, valid values:0 to 100. +* `service_id` - (Optional, String) service ID, required when used as an input parameter. +* `service_name` - (Optional, String) service name, meaningless when used as an input parameter. + +The `canary_rule` object supports the following: + +* `enabled` - (Required, Bool) the status of canary rule. +* `priority` - (Required, Int, ForceNew) priority. The value ranges from 0 to 100; the larger the value, the higher the priority; the priority cannot be repeated between different rules. +* `balanced_service_list` - (Optional, List) service weight configuration. +* `condition_list` - (Optional, List) parameter matching condition list. +* `service_id` - (Optional, String) service ID. +* `service_name` - (Optional, String) service name. + +The `condition_list` object supports the following: + +* `type` - (Required, String) type.Reference value:`path`,`method`,`query`,`header`,`cookie`,`body`,`system`. +* `delimiter` - (Optional, String) delimiter. valid when operator is in or not in, reference value:`,`, `;`,`\n`. +* `global_config_id` - (Optional, String) global configuration ID. +* `global_config_name` - (Optional, String) global configuration name. +* `key` - (Optional, String) parameter name. +* `operator` - (Optional, String) operator.Reference value:`le`,`eq`,`lt`,`ne`,`ge`,`gt`,`regex`,`exists`,`in`,`not in`,`prefix`,`exact`,`regex`. +* `value` - (Optional, String) parameter value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tse cngw_canary_rule can be imported using the gatewayId#serviceId#priority, e.g. + +``` +terraform import tencentcloud_tse_cngw_canary_rule.cngw_canary_rule gateway-ddbb709b#b6017eaf-2363-481e-9e93-8d65aaf498cd#100 +``` + diff --git a/config/docs/r/tse_cngw_certificate.html.markdown b/config/docs/r/tse_cngw_certificate.html.markdown new file mode 100644 index 0000000..28b210e --- /dev/null +++ b/config/docs/r/tse_cngw_certificate.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_cngw_certificate" +sidebar_current: "docs-tencentcloud-resource-tse_cngw_certificate" +description: |- + Provides a resource to create a tse cngw_certificate +--- + +# tencentcloud_tse_cngw_certificate + +Provides a resource to create a tse cngw_certificate + +## Example Usage + +```hcl +resource "tencentcloud_tse_cngw_certificate" "cngw_certificate" { + gateway_id = "gateway-ddbb709b" + bind_domains = ["example1.com"] + cert_id = "vYSQkJ3K" + name = "xxx1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bind_domains` - (Required, Set: [`String`]) Domains of the binding. +* `cert_id` - (Required, String, ForceNew) Certificate ID of ssl platform. +* `gateway_id` - (Required, String, ForceNew) Gateway ID. +* `name` - (Optional, String) Certificate name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `crt` - Pem format of certificate. +* `key` - Private key of certificate. + + +## Import + +tse cngw_certificate can be imported using the id, e.g. + +``` +terraform import tencentcloud_tse_cngw_certificate.cngw_certificate gatewayId#Id +``` + diff --git a/config/docs/r/tse_cngw_gateway.html.markdown b/config/docs/r/tse_cngw_gateway.html.markdown new file mode 100644 index 0000000..e314c2d --- /dev/null +++ b/config/docs/r/tse_cngw_gateway.html.markdown @@ -0,0 +1,113 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_cngw_gateway" +sidebar_current: "docs-tencentcloud-resource-tse_cngw_gateway" +description: |- + Provides a resource to create a tse cngw_gateway +--- + +# tencentcloud_tse_cngw_gateway + +Provides a resource to create a tse cngw_gateway + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_tse_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_tse_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_tse_cngw_gateway" "cngw_gateway" { + description = "terraform test1" + enable_cls = true + engine_region = "ap-guangzhou" + feature_version = "STANDARD" + gateway_version = "2.5.1" + ingress_class_name = "tse-nginx-ingress" + internet_max_bandwidth_out = 0 + name = "terraform-gateway1" + trade_type = 0 + type = "kong" + + node_config { + number = 2 + specification = "1c2g" + } + + vpc_config { + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + } + + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_version` - (Required, String) gateway vwersion. Reference value: `2.4.1`, `2.5.1`. +* `name` - (Required, String) gateway name, supports up to 60 characters. +* `node_config` - (Required, List) gateway node configration. +* `type` - (Required, String) gateway type,currently only supports kong. +* `vpc_config` - (Required, List) vpc information. +* `description` - (Optional, String) description information, up to 120 characters. +* `enable_cls` - (Optional, Bool) whether to enable CLS log. Default value: fasle. +* `engine_region` - (Optional, String) engine region of gateway. +* `feature_version` - (Optional, String) product version. Reference value: `TRIAL`, `STANDARD`(default value), `PROFESSIONAL`. +* `ingress_class_name` - (Optional, String) ingress class name. +* `internet_config` - (Optional, List) internet configration. +* `internet_max_bandwidth_out` - (Optional, Int) public network outbound traffic bandwidth,[1,2048]Mbps. +* `tags` - (Optional, Map) Tag description list. +* `trade_type` - (Optional, Int) trade type. Reference value: `0`: postpaid, `1`:Prepaid (Interface does not support the creation of prepaid instances yet). + +The `internet_config` object supports the following: + +* `description` - (Optional, String) description of clb. +* `internet_address_version` - (Optional, String) internet type. Reference value: `IPV4`(default value), `IPV6`. +* `internet_max_bandwidth_out` - (Optional, Int) public network bandwidth. +* `internet_pay_mode` - (Optional, String) trade type of internet. Reference value: `BANDWIDTH`, `TRAFFIC`(default value). +* `master_zone_id` - (Optional, String) primary availability zone. +* `multi_zone_flag` - (Optional, Bool) Whether load balancing has multiple availability zones. +* `sla_type` - (Optional, String) specification type of clb. Default shared type when this parameter is empty. Reference value:- SLA LCU-supported. +* `slave_zone_id` - (Optional, String) alternate availability zone. + +The `node_config` object supports the following: + +* `number` - (Required, Int) node number, 2-50. +* `specification` - (Required, String) specification, 1c2g|2c4g|4c8g|8c16g. + +The `vpc_config` object supports the following: + +* `subnet_id` - (Optional, String) subnet ID. Assign an IP address to the engine in the VPC subnet. Reference value: subnet-ahde9me9. +* `vpc_id` - (Optional, String) VPC ID. Assign an IP address to the engine in the VPC subnet. Reference value: vpc-conz6aix. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `instance_port` - Port information that the instance listens to. + * `http_port` - Http port range. + * `https_port` - Https port range. + * `tcp_port` - Tcp port range. + * `udp_port` - Udp port range. +* `public_ip_addresses` - Public IP address list. + + diff --git a/config/docs/r/tse_cngw_group.html.markdown b/config/docs/r/tse_cngw_group.html.markdown new file mode 100644 index 0000000..855498e --- /dev/null +++ b/config/docs/r/tse_cngw_group.html.markdown @@ -0,0 +1,108 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_cngw_group" +sidebar_current: "docs-tencentcloud-resource-tse_cngw_group" +description: |- + Provides a resource to create a tse cngw_group +--- + +# tencentcloud_tse_cngw_group + +Provides a resource to create a tse cngw_group + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_tse_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_tse_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_tse_cngw_gateway" "cngw_gateway" { + description = "terraform test1" + enable_cls = true + engine_region = "ap-guangzhou" + feature_version = "STANDARD" + gateway_version = "2.5.1" + ingress_class_name = "tse-nginx-ingress" + internet_max_bandwidth_out = 0 + name = "terraform-gateway1" + trade_type = 0 + type = "kong" + + node_config { + number = 2 + specification = "1c2g" + } + + vpc_config { + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + } + + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tse_cngw_group" "cngw_group" { + description = "terraform desc" + gateway_id = tencentcloud_tse_cngw_gateway.cngw_gateway.id + name = "terraform-group" + subnet_id = tencentcloud_subnet.subnet.id + + node_config { + number = 2 + specification = "1c2g" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) gateway IDonly postpaid gateway supported. +* `name` - (Required, String) gateway group name. +* `node_config` - (Required, List) group node configration. +* `subnet_id` - (Required, String) subnet ID. Assign an IP address to the engine in the VPC subnet. Reference value:- subnet-ahde9me9. +* `description` - (Optional, String) description information of group. +* `internet_config` - (Optional, List) internet configration. +* `internet_max_bandwidth_out` - (Optional, Int) public network outbound traffic bandwidth,[1,2048]Mbps. + +The `internet_config` object supports the following: + +* `description` - (Optional, String) description of clb. +* `internet_address_version` - (Optional, String) internet type. Reference value:- IPV4 (default value)- IPV6. +* `internet_max_bandwidth_out` - (Optional, Int) public network bandwidth. +* `internet_pay_mode` - (Optional, String) trade type of internet. Reference value:- BANDWIDTH- TRAFFIC (default value). +* `master_zone_id` - (Optional, String) primary availability zone. +* `multi_zone_flag` - (Optional, Bool) Whether load balancing has multiple availability zones. +* `sla_type` - (Optional, String) specification type of clb. Default shared type when this parameter is empty. Reference value:- SLA LCU-supported. +* `slave_zone_id` - (Optional, String) alternate availability zone. + +The `node_config` object supports the following: + +* `number` - (Required, Int) group node number, 2-50. +* `specification` - (Required, String) group specification, 1c2g|2c4g|4c8g|8c16g. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tse_cngw_route.html.markdown b/config/docs/r/tse_cngw_route.html.markdown new file mode 100644 index 0000000..fd01524 --- /dev/null +++ b/config/docs/r/tse_cngw_route.html.markdown @@ -0,0 +1,133 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_cngw_route" +sidebar_current: "docs-tencentcloud-resource-tse_cngw_route" +description: |- + Provides a resource to create a tse cngw_route +--- + +# tencentcloud_tse_cngw_route + +Provides a resource to create a tse cngw_route + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_tse_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_tse_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_tse_cngw_gateway" "cngw_gateway" { + description = "terraform test1" + enable_cls = true + engine_region = "ap-guangzhou" + feature_version = "STANDARD" + gateway_version = "2.5.1" + ingress_class_name = "tse-nginx-ingress" + internet_max_bandwidth_out = 0 + name = "terraform-gateway1" + trade_type = 0 + type = "kong" + + node_config { + number = 2 + specification = "1c2g" + } + + vpc_config { + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + } + + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tse_cngw_service" "cngw_service" { + gateway_id = tencentcloud_tse_cngw_gateway.cngw_gateway.id + name = "terraform-test" + path = "/test" + protocol = "http" + retries = 5 + timeout = 60000 + upstream_type = "HostIP" + + upstream_info { + algorithm = "round-robin" + auto_scaling_cvm_port = 0 + host = "arunma.cn" + port = 8012 + slow_start = 0 + } +} + +resource "tencentcloud_tse_cngw_route" "cngw_route" { + destination_ports = [] + gateway_id = tencentcloud_tse_cngw_gateway.cngw_gateway.id + hosts = [ + "192.168.0.1:9090", + ] + https_redirect_status_code = 426 + paths = [ + "/user", + ] + headers { + key = "req" + value = "terraform" + } + preserve_host = false + protocols = [ + "http", + "https", + ] + route_name = "terraform-route" + service_id = tencentcloud_tse_cngw_service.cngw_service.service_id + strip_path = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) gateway ID. +* `service_id` - (Required, String) ID of the service which the route belongs to. +* `destination_ports` - (Optional, Set: [`Int`]) destination port for Layer 4 matching. +* `force_https` - (Optional, Bool, **Deprecated**) This field has been deprecated and will be deleted in subsequent versions. whether to enable forced HTTPS, no longer use. +* `headers` - (Optional, List) the headers of route. +* `hosts` - (Optional, Set: [`String`]) host list. +* `https_redirect_status_code` - (Optional, Int) https redirection status code. +* `methods` - (Optional, Set: [`String`]) route methods. Reference value:`GET`,`POST`,`DELETE`,`PUT`,`OPTIONS`,`PATCH`,`HEAD`,`ANY`,`TRACE`,`COPY`,`MOVE`,`PROPFIND`,`PROPPATCH`,`MKCOL`,`LOCK`,`UNLOCK`. +* `paths` - (Optional, Set: [`String`]) path list. +* `preserve_host` - (Optional, Bool) whether to keep the host when forwarding to the backend. +* `protocols` - (Optional, Set: [`String`]) the protocol list of route.Reference value:`https`,`http`. +* `route_name` - (Optional, String) the name of the route, unique in the instance. +* `strip_path` - (Optional, Bool) whether to strip path when forwarding to the backend. + +The `headers` object supports the following: + +* `key` - (Optional, String) key of header. +* `value` - (Optional, String) value of header. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `route_id` - the id of the route, unique in the instance. + + diff --git a/config/docs/r/tse_cngw_route_rate_limit.html.markdown b/config/docs/r/tse_cngw_route_rate_limit.html.markdown new file mode 100644 index 0000000..c559cfe --- /dev/null +++ b/config/docs/r/tse_cngw_route_rate_limit.html.markdown @@ -0,0 +1,187 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_cngw_route_rate_limit" +sidebar_current: "docs-tencentcloud-resource-tse_cngw_route_rate_limit" +description: |- + Provides a resource to create a tse cngw_route_rate_limit +--- + +# tencentcloud_tse_cngw_route_rate_limit + +Provides a resource to create a tse cngw_route_rate_limit + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_tse_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_tse_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_tse_cngw_gateway" "cngw_gateway" { + description = "terraform test1" + enable_cls = true + engine_region = "ap-guangzhou" + feature_version = "STANDARD" + gateway_version = "2.5.1" + ingress_class_name = "tse-nginx-ingress" + internet_max_bandwidth_out = 0 + name = "terraform-gateway1" + trade_type = 0 + type = "kong" + + node_config { + number = 2 + specification = "1c2g" + } + + vpc_config { + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + } + + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tse_cngw_service" "cngw_service" { + gateway_id = tencentcloud_tse_cngw_gateway.cngw_gateway.id + name = "terraform-test" + path = "/test" + protocol = "http" + retries = 5 + timeout = 60000 + upstream_type = "HostIP" + + upstream_info { + algorithm = "round-robin" + auto_scaling_cvm_port = 0 + host = "arunma.cn" + port = 8012 + slow_start = 0 + } +} + +resource "tencentcloud_tse_cngw_route" "cngw_route" { + destination_ports = [] + force_https = false + gateway_id = tencentcloud_tse_cngw_gateway.cngw_gateway.id + hosts = [ + "192.168.0.1:9090", + ] + https_redirect_status_code = 426 + paths = [ + "/user", + ] + headers { + key = "req" + value = "terraform" + } + preserve_host = false + protocols = [ + "http", + "https", + ] + route_name = "terraform-route" + service_id = tencentcloud_tse_cngw_service.cngw_service.service_id + strip_path = true +} + +resource "tencentcloud_tse_cngw_route_rate_limit" "cngw_route_rate_limit" { + gateway_id = tencentcloud_tse_cngw_gateway.cngw_gateway.id + route_id = tencentcloud_tse_cngw_route.cngw_route.route_id + + limit_detail { + enabled = true + header = "req" + hide_client_headers = true + is_delay = true + limit_by = "header" + line_up_time = 10 + policy = "redis" + response_type = "default" + + qps_thresholds { + max = 10 + unit = "minute" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) gateway ID. +* `limit_detail` - (Required, List) rate limit configuration. +* `route_id` - (Required, String) Route id, or route name. + +The `external_redis` object supports the following: + +* `redis_host` - (Required, String) redis ip, maybe null. +* `redis_password` - (Required, String) redis password, maybe null. +* `redis_port` - (Required, Int) redis port, maybe null. +* `redis_timeout` - (Required, Int) redis timeout, unit: `ms`, maybe null. + +The `headers` object supports the following: + +* `key` - (Optional, String) key of header. +* `value` - (Optional, String) value of header. + +The `limit_detail` object supports the following: + +* `enabled` - (Required, Bool) status of service rate limit. +* `hide_client_headers` - (Required, Bool) whether to hide the headers of client. +* `is_delay` - (Required, Bool) whether to enable request queuing. +* `limit_by` - (Required, String) basis for service rate limit.Reference value:`ip`,`service`,`consumer`,`credential`,`path`,`header`. +* `qps_thresholds` - (Required, List) qps threshold. +* `response_type` - (Required, String) response strategy.Reference value:`url`: forward request according to url,`text`: response configuration,`default`: return directly. +* `external_redis` - (Optional, List) external redis information, maybe null. +* `header` - (Optional, String) request headers that require rate limit. +* `line_up_time` - (Optional, Int) queue time. +* `path` - (Optional, String) request paths that require rate limit. +* `policy` - (Optional, String) counter policy.Reference value:`local`,`redis`,`external_redis`. +* `rate_limit_response_url` - (Optional, String) request forwarding address, maybe null. +* `rate_limit_response` - (Optional, List) response configuration, the response strategy is text, maybe null. + +The `qps_thresholds` object supports the following: + +* `max` - (Required, Int) the max threshold. +* `unit` - (Required, String) qps threshold unit.Reference value:`second`,`minute`,`hour`,`day`,`month`,`year`. + +The `rate_limit_response` object supports the following: + +* `body` - (Optional, String) custom response body, maybe bull. +* `headers` - (Optional, List) headrs. +* `http_status` - (Optional, Int) http status code. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tse cngw_route_rate_limit can be imported using the id, e.g. + +``` +terraform import tencentcloud_tse_cngw_route_rate_limit.cngw_route_rate_limit gatewayId#routeId +``` + diff --git a/config/docs/r/tse_cngw_service.html.markdown b/config/docs/r/tse_cngw_service.html.markdown new file mode 100644 index 0000000..d2c9f0e --- /dev/null +++ b/config/docs/r/tse_cngw_service.html.markdown @@ -0,0 +1,137 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_cngw_service" +sidebar_current: "docs-tencentcloud-resource-tse_cngw_service" +description: |- + Provides a resource to create a tse cngw_service +--- + +# tencentcloud_tse_cngw_service + +Provides a resource to create a tse cngw_service + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_tse_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_tse_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_tse_cngw_gateway" "cngw_gateway" { + description = "terraform test1" + enable_cls = true + engine_region = "ap-guangzhou" + feature_version = "STANDARD" + gateway_version = "2.5.1" + ingress_class_name = "tse-nginx-ingress" + internet_max_bandwidth_out = 0 + name = "terraform-gateway1" + trade_type = 0 + type = "kong" + + node_config { + number = 2 + specification = "1c2g" + } + + vpc_config { + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + } + + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tse_cngw_service" "cngw_service" { + gateway_id = tencentcloud_tse_cngw_gateway.cngw_gateway.id + name = "terraform-test" + path = "/test" + protocol = "http" + retries = 5 + timeout = 60000 + upstream_type = "HostIP" + + upstream_info { + algorithm = "round-robin" + auto_scaling_cvm_port = 0 + host = "arunma.cn" + port = 8012 + slow_start = 0 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) gateway ID. +* `name` - (Required, String) service name. +* `path` - (Required, String) path. +* `protocol` - (Required, String) protocol. Reference value:`https`, `http`, `tcp`, `udp`. +* `retries` - (Required, Int) retry times. +* `timeout` - (Required, Int) time out, unit:ms. +* `upstream_info` - (Required, List) service config information. +* `upstream_type` - (Required, String) service type. Reference value:`Kubernetes`, `Registry`, `IPList`, `HostIP`, `Scf`. +* `tags` - (Optional, Map, **Deprecated**) Deprecate ineffective tags Tag description list. + +The `targets` object supports the following: + +* `host` - (Required, String) host. +* `port` - (Required, Int) port. +* `weight` - (Required, Int) weight. +* `source` - (Optional, String) source of target. + +The `upstream_info` object supports the following: + +* `algorithm` - (Optional, String) load balance algorithm,default: `round-robin`, `least-connections` and `consisten_hashing` also support. +* `auto_scaling_cvm_port` - (Optional, Int) auto scaling group port of cvm. +* `auto_scaling_group_id` - (Optional, String) auto scaling group ID of cvm. +* `auto_scaling_hook_status` - (Optional, String) hook status in auto scaling group of cvm. +* `auto_scaling_tat_cmd_status` - (Optional, String) tat cmd status in auto scaling group of cvm. +* `host` - (Optional, String) an IP address or domain name. +* `namespace` - (Optional, String) namespace. +* `port` - (Optional, Int) backend service port.valid values: `1` to `65535`. +* `real_source_type` - (Optional, String) exact source service type. +* `scf_lambda_name` - (Optional, String) scf lambda name. +* `scf_lambda_qualifier` - (Optional, String) scf lambda version. +* `scf_namespace` - (Optional, String) scf lambda namespace. +* `scf_type` - (Optional, String) scf lambda type. +* `service_name` - (Optional, String) the name of the service in registry or kubernetes. +* `slow_start` - (Optional, Int) slow start time, unit: `second`, when it is enabled, weight of the node is increased from 1 to the target value gradually. +* `source_id` - (Optional, String) service source ID. +* `source_name` - (Optional, String) the name of source service. +* `source_type` - (Optional, String) source service type. +* `targets` - (Optional, List) provided when service type is IPList. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `service_id` - service id. + + +## Import + +tse cngw_service can be imported using the id, e.g. + +``` +terraform import tencentcloud_tse_cngw_service.cngw_service gatewayId#name +``` + diff --git a/config/docs/r/tse_cngw_service_rate_limit.html.markdown b/config/docs/r/tse_cngw_service_rate_limit.html.markdown new file mode 100644 index 0000000..96c168f --- /dev/null +++ b/config/docs/r/tse_cngw_service_rate_limit.html.markdown @@ -0,0 +1,162 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_cngw_service_rate_limit" +sidebar_current: "docs-tencentcloud-resource-tse_cngw_service_rate_limit" +description: |- + Provides a resource to create a tse cngw_service_rate_limit +--- + +# tencentcloud_tse_cngw_service_rate_limit + +Provides a resource to create a tse cngw_service_rate_limit + +## Example Usage + +```hcl +variable "availability_zone" { + default = "ap-guangzhou-4" +} + +resource "tencentcloud_vpc" "vpc" { + cidr_block = "10.0.0.0/16" + name = "tf_tse_vpc" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + availability_zone = var.availability_zone + name = "tf_tse_subnet" + cidr_block = "10.0.1.0/24" +} + +resource "tencentcloud_tse_cngw_gateway" "cngw_gateway" { + description = "terraform test1" + enable_cls = true + engine_region = "ap-guangzhou" + feature_version = "STANDARD" + gateway_version = "2.5.1" + ingress_class_name = "tse-nginx-ingress" + internet_max_bandwidth_out = 0 + name = "terraform-gateway1" + trade_type = 0 + type = "kong" + + node_config { + number = 2 + specification = "1c2g" + } + + vpc_config { + subnet_id = tencentcloud_subnet.subnet.id + vpc_id = tencentcloud_vpc.vpc.id + } + + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_tse_cngw_service" "cngw_service" { + gateway_id = tencentcloud_tse_cngw_gateway.cngw_gateway.id + name = "terraform-test" + path = "/test" + protocol = "http" + retries = 5 + timeout = 60000 + upstream_type = "HostIP" + + upstream_info { + algorithm = "round-robin" + auto_scaling_cvm_port = 0 + host = "arunma.cn" + port = 8012 + slow_start = 0 + } +} + +resource "tencentcloud_tse_cngw_service_rate_limit" "cngw_service_rate_limit" { + gateway_id = tencentcloud_tse_cngw_gateway.cngw_gateway.id + name = tencentcloud_tse_cngw_service.cngw_service.name + + limit_detail { + enabled = true + header = "req" + hide_client_headers = true + is_delay = true + limit_by = "header" + line_up_time = 15 + policy = "redis" + response_type = "default" + + qps_thresholds { + max = 100 + unit = "hour" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String) gateway ID. +* `limit_detail` - (Required, List) rate limit configuration. +* `name` - (Required, String) service name or service ID. + +The `external_redis` object supports the following: + +* `redis_host` - (Required, String) redis ip, maybe null. +* `redis_password` - (Required, String) redis password, maybe null. +* `redis_port` - (Required, Int) redis port, maybe null. +* `redis_timeout` - (Required, Int) redis timeout, unit: `ms`, maybe null. + +The `headers` object supports the following: + +* `key` - (Optional, String) key of header. +* `value` - (Optional, String) value of header. + +The `limit_detail` object supports the following: + +* `enabled` - (Required, Bool) status of service rate limit. +* `hide_client_headers` - (Required, Bool) whether to hide the headers of client. +* `is_delay` - (Required, Bool) whether to enable request queuing. +* `limit_by` - (Required, String) basis for service rate limit.Reference value: `ip`, `service`, `consumer`, `credential`, `path`, `header`. +* `qps_thresholds` - (Required, List) qps threshold. +* `response_type` - (Required, String) response strategy.Reference value: `url`: forward request according to url, `text`: response configuration, `default`: return directly. +* `external_redis` - (Optional, List) external redis information, maybe null. +* `header` - (Optional, String) request headers that require rate limit. +* `line_up_time` - (Optional, Int) queue time. +* `path` - (Optional, String) request paths that require rate limit. +* `policy` - (Optional, String) counter policy.Reference value: `local`, `redis`, `external_redis`. +* `rate_limit_response_url` - (Optional, String) request forwarding address, maybe null. +* `rate_limit_response` - (Optional, List) response configuration, the response strategy is text, maybe null. + +The `qps_thresholds` object supports the following: + +* `max` - (Required, Int) the max threshold. +* `unit` - (Required, String) qps threshold unit.Reference value:`second`, `minute`, `hour`, `day`, `month`, `year`. + +The `rate_limit_response` object supports the following: + +* `body` - (Optional, String) custom response body, maybe bull. +* `headers` - (Optional, List) headrs. +* `http_status` - (Optional, Int) http status code. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tse cngw_service_rate_limit can be imported using the id, e.g. + +``` +terraform import tencentcloud_tse_cngw_service_rate_limit.cngw_service_rate_limit gatewayId#name +``` + diff --git a/config/docs/r/tse_instance.html.markdown b/config/docs/r/tse_instance.html.markdown new file mode 100644 index 0000000..b4aa760 --- /dev/null +++ b/config/docs/r/tse_instance.html.markdown @@ -0,0 +1,161 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_instance" +sidebar_current: "docs-tencentcloud-resource-tse_instance" +description: |- + Provides a resource to create a tse instance +--- + +# tencentcloud_tse_instance + +Provides a resource to create a tse instance + +## Example Usage + +### Create zookeeper standard version + +```hcl +resource "tencentcloud_tse_instance" "zookeeper_standard" { + engine_type = "zookeeper" + engine_version = "3.5.9.4" + engine_product_version = "STANDARD" + engine_region = "ap-guangzhou" + engine_name = "zookeeper-test" + trade_type = 0 + engine_resource_spec = "spec-qvj6k7t4q" + engine_node_num = 3 + vpc_id = "vpc-4owdpnwr" + subnet_id = "subnet-dwj7ipnc" + + tags = { + "createdBy" = "terraform" + } +} +``` + +### Create zookeeper professional version + +```hcl +resource "tencentcloud_tse_instance" "zookeeper_professional" { + engine_type = "zookeeper" + engine_version = "3.5.9.4" + engine_product_version = "PROFESSIONAL" + engine_region = "ap-guangzhou" + engine_name = "zookeeper-test" + trade_type = 0 + engine_resource_spec = "spec-qvj6k7t4q" + engine_node_num = 3 + vpc_id = "vpc-4owdpnwr" + subnet_id = "subnet-dwj7ipnc" + + engine_region_infos { + engine_region = "ap-guangzhou" + replica = 3 + + vpc_infos { + subnet_id = "subnet-dwj7ipnc" + vpc_id = "vpc-4owdpnwr" + } + vpc_infos { + subnet_id = "subnet-403mgks4" + vpc_id = "vpc-b1puef4z" + } + } + tags = { + "createdBy" = "terraform" + } +} +``` + +### Create nacos standard version + +```hcl +resource "tencentcloud_tse_instance" "nacos" { + enable_client_internet_access = false + engine_name = "test" + engine_node_num = 3 + engine_product_version = "STANDARD" + engine_region = "ap-guangzhou" + engine_resource_spec = "spec-1160a35a" + engine_type = "nacos" + engine_version = "2.0.3.4" + subnet_id = "subnet-5vpegquy" + trade_type = 0 + vpc_id = "vpc-99xmasf9" + + tags = { + "createdBy" = "terraform" + } +} +``` + +### Create polaris base version + +```hcl +resource "tencentcloud_tse_instance" "polaris" { + enable_client_internet_access = false + engine_name = "test" + engine_node_num = 2 + engine_product_version = "BASE" + engine_region = "ap-guangzhou" + engine_resource_spec = "spec-c160bas1" + engine_type = "polaris" + engine_version = "1.16.0.1" + subnet_id = "subnet-5vpegquy" + trade_type = 0 + vpc_id = "vpc-99xmasf9" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `engine_name` - (Required, String) engien name. Reference value: nacos-test. +* `engine_product_version` - (Required, String) Engine product version. Reference value: `Nacos`: `TRIAL`: Development version, optional node num: `1`, optional spec list: `1C1G`; `STANDARD`: Standard versions, optional node num: `3`, `5`, `7`, optional spec list: `1C2G`, `2C4G`, `4C8G`, `8C16G`, `16C32G`. `Zookeeper`: `TRIAL`: Development version, optional node num: `1`, optional spec list: `1C1G`; `STANDARD`: Standard versions, optional node num: `3`, `5`, `7`, optional spec list: `1C2G`, `2C4G`, `4C8G`, `8C16G`, `16C32G`; `PROFESSIONAL`: professional versions, optional node num: `3`, `5`, `7`, optional spec list: `1C2G`, `2C4G`, `4C8G`, `8C16G`, `16C32G`. `Polarismesh`: `BASE`: Base version, optional node num: `1`, optional spec list: `NUM50`; `PROFESSIONAL`: Enterprise versions, optional node num: `2`, `3`, optional spec list: `NUM50`, `NUM100`, `NUM200`, `NUM500`, `NUM1000`, `NUM5000`, `NUM10000`, `NUM50000`. +* `engine_region` - (Required, String) engine deploy region. Reference value: `China area` Reference value: `ap-guangzhou`, `ap-beijing`, `ap-chengdu`, `ap-chongqing`, `ap-nanjing`, `ap-shanghai` `ap-beijing-fsi`, `ap-shanghai-fsi`, `ap-shenzhen-fsi`. `Asia Pacific` area Reference value: `ap-hongkong`, `ap-taipei`, `ap-jakarta`, `ap-singapore`, `ap-bangkok`, `ap-seoul`, `ap-tokyo`. `North America area` Reference value: `na-toronto`, `sa-saopaulo`, `na-siliconvalley`, `na-ashburn`. +* `engine_type` - (Required, String) engine type. Reference value: `zookeeper`, `nacos`, `polaris`. +* `engine_version` - (Required, String) An open source version of the engine. Each engine supports different open source versions, refer to the product documentation or console purchase page. +* `trade_type` - (Required, Int) trade type. Reference value:- 0:postpaid- 1:Prepaid (Interface does not support the creation of prepaid instances yet). +* `enable_client_internet_access` - (Optional, Bool) Client public network access, `true`: on, `false`: off, default: false. +* `engine_node_num` - (Optional, Int) engine node num. see EngineProductVersion. +* `engine_region_infos` - (Optional, List) Details about the regional configuration of the engine in cross-region deployment, only zookeeper professional requires the use of the EngineRegionInfos parameter. +* `engine_resource_spec` - (Optional, String) engine spec ID. see EngineProductVersion. +* `prepaid_period` - (Optional, Int) Prepaid time, in monthly units. +* `prepaid_renew_flag` - (Optional, Int) Automatic renewal mark, prepaid only. Reference value: `0`: No automatic renewal, `1`: Automatic renewal. +* `subnet_id` - (Optional, String) subnet ID. Assign an IP address to the engine in the VPC subnet. Reference value: subnet-ahde9me9. +* `tags` - (Optional, Map) Tag description list. +* `vpc_id` - (Optional, String) VPC ID. Assign an IP address to the engine in the VPC subnet. Reference value: vpc-conz6aix. + +The `engine_region_infos` object supports the following: + +* `engine_region` - (Required, String) Engine node region. +* `replica` - (Required, Int) The number of nodes allocated in this region. +* `vpc_infos` - (Required, List) Cluster network information. + +The `vpc_infos` object supports the following: + +* `subnet_id` - (Required, String) Subnet ID. +* `vpc_id` - (Required, String) Vpc Id. +* `intranet_address` - (Optional, String) Intranet access addressNote: This field may return null, indicating that a valid value is not available.. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tse instance can be imported using the id, e.g. + +``` +terraform import tencentcloud_tse_instance.instance instance_id +``` + diff --git a/config/docs/r/tse_waf_domains.html.markdown b/config/docs/r/tse_waf_domains.html.markdown new file mode 100644 index 0000000..9f65663 --- /dev/null +++ b/config/docs/r/tse_waf_domains.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_waf_domains" +sidebar_current: "docs-tencentcloud-resource-tse_waf_domains" +description: |- + Provides a resource to create a tse waf_domains +--- + +# tencentcloud_tse_waf_domains + +Provides a resource to create a tse waf_domains + +## Example Usage + +```hcl +resource "tencentcloud_tse_waf_domains" "waf_domains" { + domain = "tse.exmaple.com" + gateway_id = "gateway-ed63e957" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) The waf protected domain name. +* `gateway_id` - (Required, String, ForceNew) Gateway ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tse waf_domains can be imported using the id, e.g. + +``` +terraform import tencentcloud_tse_waf_domains.waf_domains waf_domains_id +``` + diff --git a/config/docs/r/tse_waf_protection.html.markdown b/config/docs/r/tse_waf_protection.html.markdown new file mode 100644 index 0000000..aec7688 --- /dev/null +++ b/config/docs/r/tse_waf_protection.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Tencent Cloud Service Engine(TSE)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tse_waf_protection" +sidebar_current: "docs-tencentcloud-resource-tse_waf_protection" +description: |- + Provides a resource to create a tse waf_protection +--- + +# tencentcloud_tse_waf_protection + +Provides a resource to create a tse waf_protection + +## Example Usage + +```hcl +resource "tencentcloud_tse_waf_protection" "waf_protection" { + gateway_id = "gateway-ed63e957" + type = "Route" + list = ["7324a769-9d87-48ce-a904-48c3defc4abd"] + operate = "open" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_id` - (Required, String, ForceNew) Gateway ID. +* `operate` - (Required, String) `open`: open the protection, `close`: close the protection. +* `type` - (Required, String) The type of protection resource. Reference value: `Global`: instance, `Service`: service, `Route`: route, `Object`: obejct (This interface does not currently support this type). +* `list` - (Optional, Set: [`String`]) Means the list of services or routes when the resource type `Type` is `Service` or `Route`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `global_status` - Global protection status. + + diff --git a/config/docs/r/tsf_api_group.html.markdown b/config/docs/r/tsf_api_group.html.markdown new file mode 100644 index 0000000..eb754bc --- /dev/null +++ b/config/docs/r/tsf_api_group.html.markdown @@ -0,0 +1,75 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_api_group" +sidebar_current: "docs-tencentcloud-resource-tsf_api_group" +description: |- + Provides a resource to create a tsf api_group +--- + +# tencentcloud_tsf_api_group + +Provides a resource to create a tsf api_group + +## Example Usage + +```hcl +resource "tencentcloud_tsf_api_group" "api_group" { + group_name = "terraform_test_group" + group_context = "/terraform-test" + auth_type = "none" + description = "terraform-test" + group_type = "ms" + gateway_instance_id = "gw-ins-i6mjpgm8" + # namespace_name_key = "path" + # service_name_key = "path" + namespace_name_key_position = "path" + service_name_key_position = "path" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_context` - (Required, String) grouping context. +* `group_name` - (Required, String) group name, cannot contain Chinese. +* `auth_type` - (Optional, String) authentication type. secret: key authentication; none: no authentication. +* `description` - (Optional, String) remarks. +* `gateway_instance_id` - (Optional, String) gateway entity ID. +* `group_type` - (Optional, String) grouping type, default ms. ms: microservice grouping; external: external Api grouping. +* `namespace_name_key_position` - (Optional, String) namespace parameter position, path, header or query, the default is path. +* `namespace_name_key` - (Optional, String) namespace parameter key value. +* `service_name_key_position` - (Optional, String) microservice name parameter position, path, header or query, the default is path. +* `service_name_key` - (Optional, String) microservice name parameter key value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `acl_mode` - Access group ACL type. +* `api_count` - number of APIs. +* `binded_gateway_deploy_groups` - api group bound gateway deployment group. + * `application_id` - application ID. + * `application_name` - Application Name. + * `application_type` - Application classification: V: virtual machine application, C: container application. + * `cluster_type` - Cluster type, C: container, V: virtual machine. + * `deploy_group_id` - Gateway deployment group ID. + * `deploy_group_name` - Gateway deployment group name. + * `group_status` - Deployment group application status, values: Running, Waiting, Paused, Updating, RollingBack, Abnormal, Unknown. +* `created_time` - Group creation time such as: 2019-06-20 15:51:28. +* `gateway_instance_type` - Type of gateway instance. +* `group_id` - Api Group Id. +* `status` - Release status, drafted: Not published. released: released. +* `updated_time` - Group update time such as: 2019-06-20 15:51:28. + + +## Import + +tsf api_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_api_group.api_group api_group_id +``` + diff --git a/config/docs/r/tsf_api_rate_limit_rule.html.markdown b/config/docs/r/tsf_api_rate_limit_rule.html.markdown new file mode 100644 index 0000000..d9b9251 --- /dev/null +++ b/config/docs/r/tsf_api_rate_limit_rule.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_api_rate_limit_rule" +sidebar_current: "docs-tencentcloud-resource-tsf_api_rate_limit_rule" +description: |- + Provides a resource to create a tsf api_rate_limit_rule +--- + +# tencentcloud_tsf_api_rate_limit_rule + +Provides a resource to create a tsf api_rate_limit_rule + +## Example Usage + +```hcl +resource "tencentcloud_tsf_api_rate_limit_rule" "api_rate_limit_rule" { + api_id = "api-xxxxxx" + max_qps = 10 + usable_status = "enable" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `api_id` - (Required, String) Api Id. +* `max_qps` - (Required, Int) qps value. +* `usable_status` - (Optional, String) Enabled/disabled, enabled/disabled, if not passed, it is enabled by default. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `created_time` - creation time. +* `description` - describe. +* `rule_content` - Rule content. +* `rule_id` - rule Id. +* `rule_name` - Current limit name. +* `tsf_rule_id` - Tsf Rule ID. +* `updated_time` - update time. + + +## Import + +tsf api_rate_limit_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_api_rate_limit_rule.api_rate_limit_rule api_rate_limit_rule_id +``` + diff --git a/config/docs/r/tsf_application.html.markdown b/config/docs/r/tsf_application.html.markdown new file mode 100644 index 0000000..34c9e73 --- /dev/null +++ b/config/docs/r/tsf_application.html.markdown @@ -0,0 +1,75 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application" +sidebar_current: "docs-tencentcloud-resource-tsf_application" +description: |- + Provides a resource to create a tsf application +--- + +# tencentcloud_tsf_application + +Provides a resource to create a tsf application + +## Example Usage + +```hcl +resource "tencentcloud_tsf_application" "application" { + application_name = "my-app" + application_type = "C" + microservice_type = "M" + application_desc = "This is my application" + application_runtime_type = "Java" + service_config_list { + name = "my-service" + ports { + target_port = 8080 + protocol = "HTTP" + } + health_check { + path = "/health" + } + } + ignore_create_image_repository = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_name` - (Required, String) Application name. +* `application_type` - (Required, String) Application type: V for virtual machine, C for container, S for serverless. +* `microservice_type` - (Required, String) Application microservice type: M for service mesh, N for normal application, G for gateway application. +* `application_desc` - (Optional, String) Application description. +* `application_log_config` - (Optional, String) Application log configuration, deprecated parameter. +* `application_resource_type` - (Optional, String) Application resource type, deprecated parameter. +* `application_runtime_type` - (Optional, String) Application runtime type. +* `ignore_create_image_repository` - (Optional, Bool) Ignore creating image repository. +* `program_id_list` - (Optional, Set: [`String`]) N/A. +* `program_id` - (Optional, String) ID of the dataset to be bound. +* `service_config_list` - (Optional, List) List of service configuration information. + +The `health_check` object supports the following: + +* `path` - (Optional, String) Health check path. + +The `ports` object supports the following: + +* `protocol` - (Required, String) Port protocol. +* `target_port` - (Required, Int) Service port. + +The `service_config_list` object supports the following: + +* `name` - (Required, String) Service name. +* `ports` - (Required, List) List of port information. +* `health_check` - (Optional, List) Health check configuration. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tsf_application_config.html.markdown b/config/docs/r/tsf_application_config.html.markdown new file mode 100644 index 0000000..e5fcbd1 --- /dev/null +++ b/config/docs/r/tsf_application_config.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application_config" +sidebar_current: "docs-tencentcloud-resource-tsf_application_config" +description: |- + Provides a resource to create a tsf application_config +--- + +# tencentcloud_tsf_application_config + +Provides a resource to create a tsf application_config + +## Example Usage + +```hcl +resource "tencentcloud_tsf_application_config" "application_config" { + config_name = "test-2" + config_version = "1.0" + config_value = "name: \"name\"" + application_id = "application-ym9mxmza" + config_version_desc = "test2" + # config_type = "" + encode_with_base64 = false + # program_id_list = +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Required, String) Application ID. +* `config_name` - (Required, String) configuration item name. +* `config_value` - (Required, String) configuration item value. +* `config_version` - (Required, String) configuration item version. +* `config_type` - (Optional, String) configuration item value type. +* `config_version_desc` - (Optional, String) configuration item version description. +* `encode_with_base64` - (Optional, Bool) Base64 encoded configuration items. +* `program_id_list` - (Optional, Set: [`String`]) Program id list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tsf_application_file_config.html.markdown b/config/docs/r/tsf_application_file_config.html.markdown new file mode 100644 index 0000000..3685a50 --- /dev/null +++ b/config/docs/r/tsf_application_file_config.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application_file_config" +sidebar_current: "docs-tencentcloud-resource-tsf_application_file_config" +description: |- + Provides a resource to create a tsf application_file_config +--- + +# tencentcloud_tsf_application_file_config + +Provides a resource to create a tsf application_file_config + +## Example Usage + +```hcl +resource "tencentcloud_tsf_application_file_config" "application_file_config" { + config_name = "terraform-test" + config_version = "1.0" + config_file_name = "application.yaml" + config_file_value = "test: 1" + application_id = "application-a24x29xv" + config_file_path = "/etc/nginx" + config_version_desc = "1.0" + config_file_code = "UTF-8" + config_post_cmd = "source .bashrc" + encode_with_base64 = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Required, String, ForceNew) Config file associated application ID. +* `config_file_name` - (Required, String, ForceNew) Config file name. +* `config_file_path` - (Required, String, ForceNew) config release path. +* `config_file_value` - (Required, String, ForceNew) Configuration file content (the original content encoding needs to be in utf-8 format, if the ConfigFileCode is gbk, it will be converted in the background). +* `config_name` - (Required, String, ForceNew) Config Name. +* `config_version` - (Required, String, ForceNew) Config version. +* `config_file_code` - (Optional, String, ForceNew) Configuration file encoding, utf-8 or gbk. Note: If you choose gbk, you need the support of a new version of tsf-consul-template (public cloud virtual machines need to use 1.32 tsf-agent, and containers need to obtain the latest tsf-consul-template-docker.tar.gz from the documentation). +* `config_post_cmd` - (Optional, String, ForceNew) post command. +* `config_version_desc` - (Optional, String, ForceNew) config version description. +* `encode_with_base64` - (Optional, Bool, ForceNew) the config value is encoded with base64 or not. +* `program_id_list` - (Optional, Set: [`String`], ForceNew) datasource for auth. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tsf_application_file_config_release.html.markdown b/config/docs/r/tsf_application_file_config_release.html.markdown new file mode 100644 index 0000000..88c0f92 --- /dev/null +++ b/config/docs/r/tsf_application_file_config_release.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application_file_config_release" +sidebar_current: "docs-tencentcloud-resource-tsf_application_file_config_release" +description: |- + Provides a resource to create a tsf application_file_config_release +--- + +# tencentcloud_tsf_application_file_config_release + +Provides a resource to create a tsf application_file_config_release + +## Example Usage + +```hcl +resource "tencentcloud_tsf_application_file_config_release" "application_file_config_release" { + config_id = "dcfg-f-123456" + group_id = "group-123456" + release_desc = "product release" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_id` - (Required, String, ForceNew) File config id. +* `group_id` - (Required, String, ForceNew) Group Id. +* `release_desc` - (Optional, String, ForceNew) release Description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tsf applicationfile_config_release can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_application_file_config_release.application_file_config_release application_file_config_release_id +``` + diff --git a/config/docs/r/tsf_application_public_config.html.markdown b/config/docs/r/tsf_application_public_config.html.markdown new file mode 100644 index 0000000..ef89e53 --- /dev/null +++ b/config/docs/r/tsf_application_public_config.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application_public_config" +sidebar_current: "docs-tencentcloud-resource-tsf_application_public_config" +description: |- + Provides a resource to create a tsf application_public_config +--- + +# tencentcloud_tsf_application_public_config + +Provides a resource to create a tsf application_public_config + +## Example Usage + +```hcl +resource "tencentcloud_tsf_application_public_config" "application_public_config" { + config_name = "my_config" + config_version = "1.0" + config_value = "test: 1" + config_version_desc = "product version" + config_type = "P" + encode_with_base64 = true + # program_id_list = +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_name` - (Required, String, ForceNew) Config Name. +* `config_value` - (Required, String, ForceNew) config value, only yaml file allowed. +* `config_version` - (Required, String, ForceNew) config version. +* `config_type` - (Optional, String, ForceNew) Config type. +* `config_version_desc` - (Optional, String, ForceNew) Config version description. +* `encode_with_base64` - (Optional, Bool, ForceNew) the config value is encoded with base64 or not. +* `program_id_list` - (Optional, Set: [`String`], ForceNew) datasource for auth. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tsf_application_public_config_release.html.markdown b/config/docs/r/tsf_application_public_config_release.html.markdown new file mode 100644 index 0000000..8434ff0 --- /dev/null +++ b/config/docs/r/tsf_application_public_config_release.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application_public_config_release" +sidebar_current: "docs-tencentcloud-resource-tsf_application_public_config_release" +description: |- + Provides a resource to create a tsf application_public_config_release +--- + +# tencentcloud_tsf_application_public_config_release + +Provides a resource to create a tsf application_public_config_release + +## Example Usage + +```hcl +resource "tencentcloud_tsf_application_public_config_release" "application_public_config_release" { + config_id = "dcfg-p-123456" + namespace_id = "namespace-123456" + release_desc = "product version" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_id` - (Required, String, ForceNew) ConfigId. +* `namespace_id` - (Required, String, ForceNew) namespace-id. +* `release_desc` - (Optional, String, ForceNew) Release description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tsf application_public_config_release can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_application_public_config_release.application_public_config_release application_public_config_attachment_id +``` + diff --git a/config/docs/r/tsf_application_release_config.html.markdown b/config/docs/r/tsf_application_release_config.html.markdown new file mode 100644 index 0000000..7dc926c --- /dev/null +++ b/config/docs/r/tsf_application_release_config.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_application_release_config" +sidebar_current: "docs-tencentcloud-resource-tsf_application_release_config" +description: |- + Provides a resource to create a tsf application_release_config +--- + +# tencentcloud_tsf_application_release_config + +Provides a resource to create a tsf application_release_config + +## Example Usage + +```hcl +resource "tencentcloud_tsf_application_release_config" "application_release_config" { + config_id = "dcfg-nalqbqwv" + group_id = "group-yxmz72gv" + release_desc = "terraform-test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_id` - (Required, String, ForceNew) Configuration ID. +* `group_id` - (Required, String, ForceNew) deployment group ID. +* `release_desc` - (Optional, String, ForceNew) release description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `application_id` - Application ID. +* `cluster_id` - cluster ID. +* `cluster_name` - cluster name. +* `config_name` - configuration item name. +* `config_release_id` - configuration item release ID. +* `config_version` - configuration item version. +* `group_name` - deployment group name. +* `namespace_id` - Namespace ID. +* `namespace_name` - namespace name. +* `release_time` - release time. + + +## Import + +tsf application_release_config can be imported using the configId#groupId#configReleaseId, e.g. + +``` +terraform import tencentcloud_tsf_application_release_config.application_release_config dcfg-nalqbqwv#group-yxmz72gv#dcfgr-maeeq2ea +``` + diff --git a/config/docs/r/tsf_bind_api_group.html.markdown b/config/docs/r/tsf_bind_api_group.html.markdown new file mode 100644 index 0000000..beb6c68 --- /dev/null +++ b/config/docs/r/tsf_bind_api_group.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_bind_api_group" +sidebar_current: "docs-tencentcloud-resource-tsf_bind_api_group" +description: |- + Provides a resource to create a tsf bind_api_group +--- + +# tencentcloud_tsf_bind_api_group + +Provides a resource to create a tsf bind_api_group + +## Example Usage + +```hcl +resource "tencentcloud_tsf_bind_api_group" "bind_api_group" { + gateway_deploy_group_id = "group-vzd97zpy" + group_id = "grp-qp0rj3zi" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_deploy_group_id` - (Required, String, ForceNew) gateway group id. +* `group_id` - (Required, String, ForceNew) group id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tsf bind_api_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_bind_api_group.bind_api_group bind_api_group_id +``` + diff --git a/config/docs/r/tsf_cluster.html.markdown b/config/docs/r/tsf_cluster.html.markdown new file mode 100644 index 0000000..a300c70 --- /dev/null +++ b/config/docs/r/tsf_cluster.html.markdown @@ -0,0 +1,97 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_cluster" +sidebar_current: "docs-tencentcloud-resource-tsf_cluster" +description: |- + Provides a resource to create a tsf cluster +--- + +# tencentcloud_tsf_cluster + +Provides a resource to create a tsf cluster + +## Example Usage + +```hcl +resource "tencentcloud_tsf_cluster" "cluster" { + cluster_name = "terraform-test" + cluster_type = "C" + vpc_id = "vpc-xxxxxx" + cluster_cidr = "9.165.120.0/24" + cluster_desc = "test" + tsf_region_id = "ap-guangzhou" + cluster_version = "1.18.4" + max_node_pod_num = 32 + max_cluster_service_num = 128 + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_name` - (Required, String) Cluster name. +* `cluster_type` - (Required, String) Cluster type. +* `vpc_id` - (Required, String) Vpc id. +* `cluster_cidr` - (Optional, String) CIDR assigned to cluster containers and service IP. +* `cluster_desc` - (Optional, String) cluster notes. +* `cluster_remark_name` - (Optional, String) cluster remark name. +* `cluster_version` - (Optional, String) cluster version. +* `kubernete_api_server` - (Optional, String) api address. +* `kubernete_native_secret` - (Optional, String) native secret. +* `kubernete_native_type` - (Optional, String) `K`:kubeconfig, `S`:service account. +* `max_cluster_service_num` - (Optional, Int) The maximum number of services in the cluster. The value ranges from 32 to 32768. If it is not a power of 2, the nearest power of 2 will be taken up. +* `max_node_pod_num` - (Optional, Int) The maximum number of Pods on each Node in the cluster. The value ranges from 4 to 256. When the value is not a power of 2, the nearest power of 2 will be taken up. +* `program_id_list` - (Optional, Set: [`String`]) Program id list. +* `program_id` - (Optional, String) The dataset ID to be bound. +* `subnet_id` - (Optional, String) Subnet id. +* `tags` - (Optional, Map) Tag description list. +* `tsf_region_id` - (Optional, String) The TSF region to which the cluster belongs. +* `tsf_zone_id` - (Optional, String) The TSF availability zone to which the cluster belongs. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `abnormal_group_count` - Abnormal number of deployment groups. +* `cluster_id` - Cluster ID. +* `cluster_limit_cpu` - Cluster remaining cpu limit. +* `cluster_limit_mem` - Cluster remaining memory limit. +* `cluster_status` - cluster status. +* `cluster_total_cpu` - The total CPU of the cluster, unit: core. +* `cluster_total_mem` - The total memory of the cluster, unit: G. +* `cluster_used_cpu` - CPU used by the cluster, unit: core. +* `cluster_used_mem` - The memory used by the cluster, unit: G. +* `create_time` - Create time. +* `delete_flag_reason` - Reasons why clusters cannot be deleted. +* `delete_flag` - Delete flag: `true`: can be deleted; `false`: can not be deleted. +* `group_count` - Total number of deployment groups. +* `instance_count` - Number of cluster machine instances. +* `normal_instance_count` - The number of machine instances in the normal state of the cluster. +* `operation_info` - Control information for buttons on the front end. + * `add_instance` - Add the control information of the instance button. + * `disabled_reason` - Reason for not showing. + * `enabled` - Is the button clickable. + * `supported` - whether to show the button. + * `destroy` - Destroy the control information of the machine. + * `disabled_reason` - Reason for not showing. + * `enabled` - Is the button clickable. + * `supported` - whether to show the button. + * `init` - Initialize the control information of the button. + * `disabled_reason` - Reason for not showing. + * `enabled` - Is the button clickable. + * `supported` - whether to show the button. +* `run_group_count` - Number of Deployment Groups in progress. +* `run_instance_count` - Number of machine instances running in the cluster. +* `run_service_instance_count` - Number of running service instances. +* `stop_group_count` - Number of deployment groups in stop. +* `tsf_region_name` - Name of the TSF region to which the cluster belongs. +* `tsf_zone_name` - The name of the TSF availability zone to which the cluster belongs. +* `update_time` - Update time. + + diff --git a/config/docs/r/tsf_config_template.html.markdown b/config/docs/r/tsf_config_template.html.markdown new file mode 100644 index 0000000..6303b6c --- /dev/null +++ b/config/docs/r/tsf_config_template.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_config_template" +sidebar_current: "docs-tencentcloud-resource-tsf_config_template" +description: |- + Provides a resource to create a tsf config_template +--- + +# tencentcloud_tsf_config_template + +Provides a resource to create a tsf config_template + +## Example Usage + +```hcl +resource "tencentcloud_tsf_config_template" "config_template" { + config_template_name = "terraform-template-name" + config_template_type = "Ribbon" + config_template_value = <<-EOT + ribbon.ReadTimeout: 5000 + ribbon.ConnectTimeout: 2000 + ribbon.MaxAutoRetries: 0 + ribbon.MaxAutoRetriesNextServer: 1 + ribbon.OkToRetryOnAllOperations: true + EOT + config_template_desc = "terraform-test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `config_template_name` - (Required, String) Configuration template name. +* `config_template_type` - (Required, String) Configure the microservice framework corresponding to the template. +* `config_template_value` - (Required, String) Configure template data. +* `config_template_desc` - (Optional, String) Configuration template description. +* `program_id_list` - (Optional, Set: [`String`]) Program id list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `config_template_id` - Template Id. +* `create_time` - creation time. +* `update_time` - update time. + + diff --git a/config/docs/r/tsf_contain_group.html.markdown b/config/docs/r/tsf_contain_group.html.markdown new file mode 100644 index 0000000..7eb699e --- /dev/null +++ b/config/docs/r/tsf_contain_group.html.markdown @@ -0,0 +1,143 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_contain_group" +sidebar_current: "docs-tencentcloud-resource-tsf_contain_group" +description: |- + Provides a resource to create a tsf contain_group +--- + +# tencentcloud_tsf_contain_group + +Provides a resource to create a tsf contain_group + +## Example Usage + +```hcl +resource "tencentcloud_tsf_contain_group" "contain_group" { + access_type = 0 + application_id = "application-y5r4nejv" + cluster_id = "cls-2yu5kxr8" + cpu_limit = "0.5" + cpu_request = "0.25" + group_name = "terraform-test" + group_resource_type = "DEF" + instance_num = 1 + mem_limit = "1280" + mem_request = "640" + namespace_id = "namespace-ydlezgxa" + update_ivl = 10 + update_type = 1 + + protocol_ports { + node_port = 0 + port = 333 + protocol = "TCP" + target_port = 333 + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_type` - (Required, Int) 0: public network 1: access within the cluster 2: NodePort. +* `application_id` - (Required, String) The application ID to which the group belongs. +* `cluster_id` - (Required, String) Cluster ID. +* `group_name` - (Required, String) Group name field, length 1~60, beginning with a letter or underscore, can contain alphanumeric underscore. +* `instance_num` - (Required, Int) number of instances. +* `namespace_id` - (Required, String) ID of the namespace to which the group belongs. +* `protocol_ports` - (Required, List) Protocol Ports array. +* `agent_cpu_limit` - (Optional, String) The maximum number of CPU cores for the agent container, corresponding to the limit of K8S. +* `agent_cpu_request` - (Optional, String) The number of CPU cores allocated by the agent container, corresponding to the K8S request. +* `agent_mem_limit` - (Optional, String) The maximum memory MiB of the agent container, corresponding to the limit of K8S. +* `agent_mem_request` - (Optional, String) The number of memory MiB allocated by the agent container, corresponding to the K8S request. +* `cpu_limit` - (Optional, String) The maximum number of allocated CPU cores, corresponding to the K8S limit. +* `cpu_request` - (Optional, String) Initially allocated CPU cores, corresponding to K8S request. +* `group_comment` - (Optional, String) Group remarks field, the length should not exceed 200 characters. +* `group_resource_type` - (Optional, String) Deployment Group Resource Type. +* `istio_cpu_limit` - (Optional, String) The maximum number of CPU cores for the istioproxy container corresponds to the limit of K8S. +* `istio_cpu_request` - (Optional, String) The number of CPU cores allocated by the istioproxy container, corresponding to the K8S request. +* `istio_mem_limit` - (Optional, String) The maximum memory MiB of the istioproxy container corresponds to the limit of K8S. +* `istio_mem_request` - (Optional, String) The number of memory MiB allocated by the istioproxy container, corresponding to the K8S request. +* `mem_limit` - (Optional, String) Maximum allocated memory MiB, corresponding to K8S limit. +* `mem_request` - (Optional, String) Initially allocated memory MiB, corresponding to K8S request. +* `subnet_id` - (Optional, String) subnet ID. +* `update_ivl` - (Optional, Int) Rolling update is required, update interval. +* `update_type` - (Optional, Int) Update method: 0: fast update 1: rolling update. + +The `protocol_ports` object supports the following: + +* `port` - (Required, Int) service port. +* `protocol` - (Required, String) TCP UDP. +* `target_port` - (Required, Int) container port. +* `node_port` - (Optional, Int) host port. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `application_name` - Application Name. +* `application_type` - App types. +* `cluster_ip` - Service ip. +* `cluster_name` - cluster name. +* `create_time` - creation time. +* `current_num` - Total number of instances launched. +* `envs` - environment variable array object. + * `name` - environment variable name. + * `value_from` - k8s ValueFrom. + * `field_ref` - FieldRef for k8s env. + * `field_path` - FieldPath of k8s. + * `resource_field_ref` - ResourceFieldRef of k8s env. + * `resource` - Resource of k8s. + * `value` - environment variable value. +* `group_id` - Deployment group ID. +* `health_check_settings` - Deployment group health check settings. + * `liveness_probe` - live health check. + * `action_type` - health check method. HTTP: check by HTTP interface; CMD: check by executing command; TCP: check by establishing TCP connection. + * `command` - Execute command check mode, the command to execute. + * `failure_threshold` - Indicates the number of consecutive health check successes of the backend container from success to failure. + * `initial_delay_seconds` - The time for the container to delay starting the health check. + * `path` - The request path of the HTTP health check interface. + * `period_seconds` - Interval between health checks. + * `port` - Health check port, range 1~65535. + * `scheme` - The inspection protocol used by the HTTP health check method. HTTP and HTTPS are supported. + * `success_threshold` - Indicates the number of consecutive health check successes for the backend container from failure to success. + * `timeout_seconds` - Maximum timeout for each health check response. + * `type` - TSF_DEFAULT: tsf default readiness probe. K8S_NATIVE: k8s native probe. If not filled, it defaults to k8s native probe. + * `readiness_probe` - readiness health check. + * `action_type` - health check method. HTTP: check by HTTP interface; CMD: check by executing command; TCP: check by establishing TCP connection. + * `command` - Execute command check mode, the command to execute. + * `failure_threshold` - Indicates the number of consecutive health check successes for the backend container from success to failure. + * `initial_delay_seconds` - The time for the container to delay starting the health check. + * `path` - The request path of the HTTP health check interface. + * `period_seconds` - The interval at which health checks are performed. + * `port` - Health check port, range 1~65535. + * `scheme` - The inspection protocol used by the HTTP health check method. HTTP and HTTPS are supported. + * `success_threshold` - Indicates the number of consecutive health check successes for the backend container from failure to success. + * `timeout_seconds` - The maximum timeout for each health check response. + * `type` - TSF_DEFAULT: tsf default readiness probe. K8S_NATIVE: k8s native probe. If not filled, it defaults to k8s native probe. +* `instance_count` - Number of deployment group instances. +* `lb_ip` - load balancing ip. +* `max_surge` - The MaxSurge parameter of the kubernetes rolling update policy. +* `max_unavailable` - The MaxUnavailable parameter of the kubernetes rolling update policy. +* `message` - pod error message description. +* `microservice_type` - Service type. +* `namespace_name` - namespace name. +* `reponame` - Mirror name, such as /tsf/nginx. +* `server` - mirror server. +* `status` - Deployment group status. +* `tag_name` - Image version name. +* `updated_time` - Deployment group update timestamp. + + +## Import + +tsf contain_group can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_contain_group.contain_group contain_group_id +``` + diff --git a/config/docs/r/tsf_deploy_container_group.html.markdown b/config/docs/r/tsf_deploy_container_group.html.markdown new file mode 100644 index 0000000..4017f75 --- /dev/null +++ b/config/docs/r/tsf_deploy_container_group.html.markdown @@ -0,0 +1,226 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_deploy_container_group" +sidebar_current: "docs-tencentcloud-resource-tsf_deploy_container_group" +description: |- + Provides a resource to create a tsf deploy_container_group +--- + +# tencentcloud_tsf_deploy_container_group + +Provides a resource to create a tsf deploy_container_group + +## Example Usage + +```hcl +resource "tencentcloud_tsf_deploy_container_group" "deploy_container_group" { + group_id = "group-yqml6w3a" + cpu_request = "0.25" + mem_request = "640" + server = "ccr.ccs.tencentyun.com" + reponame = "tsf_100011913960/terraform" + tag_name = "terraform-only-1" + do_not_start = false + instance_num = 1 + update_type = 1 + update_ivl = 10 + mem_limit = "1280" + cpu_limit = "0.5" + agent_cpu_request = "0.1" + agent_cpu_limit = "0.2" + agent_mem_request = "125" + agent_mem_limit = "400" + max_surge = "25%" + max_unavailable = "0" + service_setting { + access_type = 1 + protocol_ports { + protocol = "TCP" + port = 18081 + target_port = 18081 + node_port = 30001 + } + subnet_id = "" + disable_service = false + headless_service = false + allow_delete_service = true + open_session_affinity = false + session_affinity_timeout_seconds = 10800 + + } + health_check_settings { + readiness_probe { + action_type = "TCP" + initial_delay_seconds = 0 + timeout_seconds = 3 + period_seconds = 30 + success_threshold = 1 + failure_threshold = 3 + scheme = "HTTP" + port = 80 + path = "/" + type = "TSF_DEFAULT" + } + } + scheduling_strategy { + type = "NONE" + } + deploy_agent = true + repo_type = "personal" + volume_clean = false + jvm_opts = "-Xms128m -Xmx512m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=512m" + warmup_setting { + enabled = false + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String, ForceNew) group Id. +* `instance_num` - (Required, Int) instance number. +* `tag_name` - (Required, String, ForceNew) image version name, v1. +* `agent_cpu_limit` - (Optional, String, ForceNew) The maximum number of CPU cores allocated to the agent container corresponds to the limit field in Kubernetes. +* `agent_cpu_request` - (Optional, String, ForceNew) The number of CPU cores allocated to the agent container corresponds to the request field in Kubernetes. +* `agent_mem_limit` - (Optional, String, ForceNew) The maximum amount of memory in MiB allocated to the agent container corresponds to the &#39;limit&#39; field in Kubernetes. +* `agent_mem_request` - (Optional, String, ForceNew) The amount of memory in MiB allocated to the agent container corresponds to the request field in Kubernetes. +* `agent_profile_list` - (Optional, List, ForceNew) javaagent info: SERVICE_AGENT/OT_AGENT. +* `cpu_limit` - (Optional, String, ForceNew) The maximum number of CPU cores for the business container, corresponding to the limit in K8S. If not specified, it defaults to twice the request. +* `cpu_request` - (Optional, String, ForceNew) The number of CPU cores allocated to the business container, corresponding to the request in K8S. The default value is 0.25. +* `deploy_agent` - (Optional, Bool, ForceNew) Whether to deploy the agent container. If this parameter is not specified, the agent container will not be deployed by default. +* `do_not_start` - (Optional, Bool, ForceNew) Not start right away. +* `envs` - (Optional, List, ForceNew) The environment variables that the application runs in the deployment group. If this parameter is not specified, no additional environment variables are set by default. +* `health_check_settings` - (Optional, List, ForceNew) The configuration information for health checks. If this parameter is not specified, the health check is not set by default. +* `incremental_deployment` - (Optional, Bool, ForceNew) Whether to perform incremental deployment. The default value is false, which means full update. +* `istio_cpu_limit` - (Optional, String, ForceNew) The maximum amount of CPU cores allocated to the istio proxy container corresponds to the &#39;limit&#39; field in Kubernetes. +* `istio_cpu_request` - (Optional, String, ForceNew) The number of CPU cores allocated to the istio proxy container corresponds to the &#39;request&#39; field in Kubernetes. +* `istio_mem_limit` - (Optional, String, ForceNew) The maximum amount of memory in MiB allocated to the agent container corresponds to the request field in Kubernetes. +* `istio_mem_request` - (Optional, String, ForceNew) The amount of memory in MiB allocated to the agent container corresponds to the request field in Kubernetes. +* `jvm_opts` - (Optional, String, ForceNew) jvm options. +* `max_surge` - (Optional, String, ForceNew) MaxSurge parameter in Kubernetes rolling update strategy. +* `max_unavailable` - (Optional, String, ForceNew) MaxUnavailable parameter in Kubernetes rolling update strategy. +* `mem_limit` - (Optional, String, ForceNew) The maximum memory size in MiB for the business container, corresponding to the limit in K8S. If not specified, it defaults to twice the request. +* `mem_request` - (Optional, String, ForceNew) The amount of memory in MiB allocated to the business container, corresponding to the request in K8S. The default value is 640 MiB. +* `repo_name` - (Optional, String, ForceNew) (Priority use) New image name, such as /tsf/nginx. +* `repo_type` - (Optional, String, ForceNew) repo type, tcr or leave it blank. +* `reponame` - (Optional, String, ForceNew) old image name, eg: /tsf/server. +* `scheduling_strategy` - (Optional, List, ForceNew) Node scheduling strategy. If this parameter is not specified, the node scheduling strategy will not be used by default. +* `server` - (Optional, String, ForceNew) image server. +* `service_setting` - (Optional, List, ForceNew) Network settings for container deployment groups. +* `update_ivl` - (Optional, Int, ForceNew) update Interval, is required when rolling update. +* `update_type` - (Optional, Int, ForceNew) Update method: 0 for fast update, 1 for rolling update. +* `volume_clean` - (Optional, Bool, ForceNew) Whether to clear the volume information. Default is false. +* `volume_info_list` - (Optional, List, ForceNew) Volume information, as a list. +* `volume_mount_info_list` - (Optional, List, ForceNew) Volume mount point information, list type. +* `warmup_setting` - (Optional, List, ForceNew) warmup setting. + +The `agent_profile_list` object supports the following: + +* `agent_type` - (Optional, String) Agent type. +* `agent_version` - (Optional, String) Agent version. + +The `envs` object supports the following: + +* `name` - (Required, String) env param name. +* `value_from` - (Optional, List) Kubernetes ValueFrom configuration. Note: This field may return null, indicating that no valid values can be obtained. +* `value` - (Optional, String) value of env. + +The `field_ref` object supports the following: + +* `field_path` - (Optional, String) The FieldPath configuration of Kubernetes. Note: This field may return null, indicating that no valid values can be obtained. + +The `health_check_settings` object supports the following: + +* `liveness_probe` - (Optional, List) Liveness probe. Note: This field may return null, indicating that no valid values can be obtained. +* `readiness_probe` - (Optional, List) Readiness health check. Note: This field may return null, indicating that no valid values can be obtained. + +The `liveness_probe` object supports the following: + +* `action_type` - (Required, String) The health check method. HTTP: checks through an HTTP interface; CMD: checks by executing a command; TCP: checks by establishing a TCP connection. Note: This field may return null, indicating that no valid values can be obtained. +* `command` - (Optional, Set) The command to be executed for command health checks. Note: This field may return null, indicating that no valid values can be obtained. +* `failure_threshold` - (Optional, Int) The number of consecutive successful health checks required for the backend container to transition from success to failure. Note: This field may return null, indicating that no valid values can be obtained. +* `initial_delay_seconds` - (Optional, Int) The time delay for the container to start the health check. Note: This field may return null, indicating that no valid values can be obtained. +* `path` - (Optional, String) The request path for HTTP health checks. Note: This field may return null, indicating that no valid values can be obtained. +* `period_seconds` - (Optional, Int) The time interval for performing health checks. Note: This field may return null, indicating that no valid values can be obtained. +* `port` - (Optional, Int) The port used for health checks, ranging from 1 to 65535. Note: This field may return null, indicating that no valid values can be obtained. +* `scheme` - (Optional, String) The protocol used for HTTP health checks. HTTP and HTTPS are supported. Note: This field may return null, indicating that no valid values can be obtained. +* `success_threshold` - (Optional, Int) The number of consecutive successful health checks required for the backend container to transition from failure to success. Note: This field may return null, indicating that no valid values can be obtained. +* `timeout_seconds` - (Optional, Int) The maximum timeout period for each health check response. Note: This field may return null, indicating that no valid values can be obtained. +* `type` - (Optional, String) The type of readiness probe. TSF_DEFAULT represents the default readiness probe of TSF, while K8S_NATIVE represents the native readiness probe of Kubernetes. If this field is not specified, the native readiness probe of Kubernetes is used by default. Note: This field may return null, indicating that no valid values can be obtained. + +The `protocol_ports` object supports the following: + +* `port` - (Required, Int) port. +* `protocol` - (Required, String) TCP or UDP. +* `target_port` - (Required, Int) container port. +* `node_port` - (Optional, Int) node port. + +The `readiness_probe` object supports the following: + +* `action_type` - (Required, String) The health check method. HTTP indicates checking through an HTTP interface, CMD indicates checking through executing a command, and TCP indicates checking through establishing a TCP connection. Note: This field may return null, indicating that no valid values can be obtained. +* `command` - (Optional, Set) The command to be executed for command check. Note: This field may return null, indicating that no valid values can be obtained. +* `failure_threshold` - (Optional, Int) The number of consecutive successful health checks required for the backend container to transition from success to failure. Note: This field may return null, indicating that no valid values can be obtained. +* `initial_delay_seconds` - (Optional, Int) The time to delay the start of the container health check. Note: This field may return null, indicating that no valid values can be obtained. +* `path` - (Optional, String) The request path for HTTP health checks. Note: This field may return null, indicating that no valid values can be obtained. +* `period_seconds` - (Optional, Int) The time interval for performing health checks. Note: This field may return null, indicating that no valid values can be obtained. +* `port` - (Optional, Int) The port used for health checks, ranging from 1 to 65535. Note: This field may return null, indicating that no valid values can be obtained. +* `scheme` - (Optional, String) The protocol used for HTTP health checks. HTTP and HTTPS are supported. Note: This field may return null, indicating that no valid values can be obtained. +* `success_threshold` - (Optional, Int) The number of consecutive successful health checks required for the backend container to transition from failure to success. Note: This field may return null, indicating that no valid values can be obtained. +* `timeout_seconds` - (Optional, Int) The maximum timeout period for each health check response. Note: This field may return null, indicating that no valid values can be obtained. +* `type` - (Optional, String) The type of readiness probe. TSF_DEFAULT represents the default readiness probe of TSF, while K8S_NATIVE represents the native readiness probe of Kubernetes. If this field is not specified, the native readiness probe of Kubernetes is used by default. Note: This field may return null, indicating that no valid values can be obtained. + +The `resource_field_ref` object supports the following: + +* `resource` - (Optional, String) The Resource configuration of Kubernetes. Note: This field may return null, indicating that no valid values can be obtained. + +The `scheduling_strategy` object supports the following: + +* `type` - (Required, String) NONE: Do not use scheduling strategy; CROSS_AZ: Deploy across availability zones. Note: This field may return null, indicating that no valid values can be obtained. + +The `service_setting` object supports the following: + +* `access_type` - (Required, Int) 0: Public network, 1: Access within the cluster, 2: NodePort, 3: Access within VPC. Note: This field may return null, indicating that no valid values can be obtained. +* `protocol_ports` - (Required, List) Container port mapping. Note: This field may return null, indicating that no valid values can be obtained. +* `subnet_id` - (Required, String) subnet Id. +* `allow_delete_service` - (Optional, Bool) When set to true and DisableService is also true, the previously created service will be deleted. Please use with caution. Note: This field may return null, indicating that no valid values can be obtained. +* `disable_service` - (Optional, Bool) Whether to create a Kubernetes service. The default value is false. Note: This field may return null, indicating that no valid values can be obtained. +* `headless_service` - (Optional, Bool) Whether the service is of headless type. Note: This field may return null, indicating that no valid values can be obtained. +* `open_session_affinity` - (Optional, Bool) Enable session affinity. true means enabled, false means disabled. The default value is false. Note: This field may return null, indicating that no valid values can be obtained. +* `session_affinity_timeout_seconds` - (Optional, Int) Session affinity session time. The default value is 10800. Note: This field may return null, indicating that no valid values can be obtained. + +The `value_from` object supports the following: + +* `field_ref` - (Optional, List) The FieldRef configuration of Kubernetes env. Note: This field may return null, indicating that no valid values can be obtained. +* `resource_field_ref` - (Optional, List) The ResourceFieldRef configuration of Kubernetes env. Note: This field may return null, indicating that no valid values can be obtained. + +The `volume_info_list` object supports the following: + +* `volume_name` - (Required, String) volume name. +* `volume_type` - (Required, String) volume type. +* `volume_config` - (Optional, String) volume config. + +The `volume_mount_info_list` object supports the following: + +* `volume_mount_name` - (Required, String) mount volume name. +* `volume_mount_path` - (Required, String) mount path. +* `read_or_write` - (Optional, String) Read and write access mode. 1: Read-only. 2: Read-write. +* `volume_mount_sub_path` - (Optional, String) mount subPath. + +The `warmup_setting` object supports the following: + +* `curvature` - (Optional, Int) Preheating curvature, with a value between 1 and 5. +* `enabled_protection` - (Optional, Bool) Whether to enable preheating protection. If protection is enabled and more than 50% of nodes are in preheating state, preheating will be aborted. +* `enabled` - (Optional, Bool) Whether to enable preheating. +* `warmup_time` - (Optional, Int) warmup time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tsf_deploy_vm_group.html.markdown b/config/docs/r/tsf_deploy_vm_group.html.markdown new file mode 100644 index 0000000..49c8b47 --- /dev/null +++ b/config/docs/r/tsf_deploy_vm_group.html.markdown @@ -0,0 +1,120 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_deploy_vm_group" +sidebar_current: "docs-tencentcloud-resource-tsf_deploy_vm_group" +description: |- + Provides a resource to create a tsf deploy_vm_group +--- + +# tencentcloud_tsf_deploy_vm_group + +Provides a resource to create a tsf deploy_vm_group + +## Example Usage + +```hcl +resource "tencentcloud_tsf_deploy_vm_group" "deploy_vm_group" { + group_id = "group-vzd97zpy" + pkg_id = "pkg-131bc1d3" + startup_parameters = "-Xms128m -Xmx512m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=512m" + deploy_desc = "deploy test" + force_start = false + enable_health_check = true + health_check_settings { + readiness_probe { + action_type = "HTTP" + initial_delay_seconds = 10 + timeout_seconds = 2 + period_seconds = 10 + success_threshold = 1 + failure_threshold = 3 + scheme = "HTTP" + port = "80" + path = "/" + } + } + update_type = 0 + jdk_name = "konaJDK" + jdk_version = "8" + +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String, ForceNew) group id. +* `pkg_id` - (Required, String, ForceNew) program package ID. +* `agent_profile_list` - (Optional, List, ForceNew) javaagent info: SERVICE_AGENT/OT_AGENT. +* `deploy_batch` - (Optional, Set: [`Float64`], ForceNew) The ratio of instances participating in each batch during rolling release. +* `deploy_beta_enable` - (Optional, Bool, ForceNew) Whether to enable beta batch. +* `deploy_desc` - (Optional, String, ForceNew) group description. +* `deploy_exe_mode` - (Optional, String, ForceNew) The execution method of rolling release. +* `deploy_wait_time` - (Optional, Int, ForceNew) The time interval for each batch during rolling release. +* `enable_health_check` - (Optional, Bool, ForceNew) Whether to enable health check. +* `force_start` - (Optional, Bool, ForceNew) Whether to allow forced start. +* `health_check_settings` - (Optional, List, ForceNew) When enabling health check, configure the health check settings. +* `incremental_deployment` - (Optional, Bool, ForceNew) Whether to perform incremental deployment. The default value is false, which means full update. +* `jdk_name` - (Optional, String, ForceNew) JDK name: konaJDK or openJDK. +* `jdk_version` - (Optional, String, ForceNew) JDK version: 8 or 11(openJDK only support 8). +* `start_script` - (Optional, String, ForceNew) The base64-encoded startup script. +* `startup_parameters` - (Optional, String, ForceNew) start args of group. +* `stop_script` - (Optional, String, ForceNew) The base64-encoded stop script. +* `update_type` - (Optional, Int, ForceNew) Update method: 0 for fast update, 1 for rolling update. +* `warmup_setting` - (Optional, List, ForceNew) warmup setting. + +The `agent_profile_list` object supports the following: + +* `agent_type` - (Optional, String) Agent type. +* `agent_version` - (Optional, String) Agent version. + +The `health_check_settings` object supports the following: + +* `liveness_probe` - (Optional, List) Survival health check. Note: This field may return null, indicating that no valid value was found. +* `readiness_probe` - (Optional, List) Readiness health check. Note: This field may return null, indicating that no valid values can be obtained. + +The `liveness_probe` object supports the following: + +* `action_type` - (Required, String) Health check method. HTTP: check through HTTP interface; CMD: check through executing command; TCP: check through establishing TCP connection. Note: This field may return null, indicating that no valid value was found. +* `command` - (Optional, Set) The command to be executed for command health checks. Note: This field may return null, indicating that no valid values can be obtained. +* `failure_threshold` - (Optional, Int) The number of consecutive successful health checks required for the backend container to transition from success to failure. Note: This field may return null, indicating that no valid values can be obtained. +* `initial_delay_seconds` - (Optional, Int) The time delay for the container to start the health check. Note: This field may return null, indicating that no valid values can be obtained. +* `path` - (Optional, String) The request path for HTTP health checks. Note: This field may return null, indicating that no valid values can be obtained. +* `period_seconds` - (Optional, Int) The time interval for performing health checks. Note: This field may return null, indicating that no valid values can be obtained. +* `port` - (Optional, Int) The port used for health checks, ranging from 1 to 65535. Note: This field may return null, indicating that no valid values can be obtained. +* `scheme` - (Optional, String) The protocol used for HTTP health checks. HTTP and HTTPS are supported. Note: This field may return null, indicating that no valid values can be obtained. +* `success_threshold` - (Optional, Int) The number of consecutive successful health checks required for the backend container to transition from failure to success. Note: This field may return null, indicating that no valid values can be obtained. +* `timeout_seconds` - (Optional, Int) The maximum timeout period for each health check response. Note: This field may return null, indicating that no valid values can be obtained. +* `type` - (Optional, String) The type of readiness probe. TSF_DEFAULT represents the default readiness probe of TSF, while K8S_NATIVE represents the native readiness probe of Kubernetes. If this field is not specified, the native readiness probe of Kubernetes is used by default. Note: This field may return null, indicating that no valid values can be obtained. + +The `readiness_probe` object supports the following: + +* `action_type` - (Required, String) The health check method. HTTP indicates checking through an HTTP interface, CMD indicates checking through executing a command, and TCP indicates checking through establishing a TCP connection. Note: This field may return null, indicating that no valid values can be obtained. +* `command` - (Optional, Set) The command to be executed for command check. Note: This field may return null, indicating that no valid values can be obtained. +* `failure_threshold` - (Optional, Int) The number of consecutive successful health checks required for the backend container to transition from success to failure. Note: This field may return null, indicating that no valid values can be obtained. +* `initial_delay_seconds` - (Optional, Int) The time to delay the start of the container health check. Note: This field may return null, indicating that no valid values can be obtained. +* `path` - (Optional, String) The request path for HTTP health checks. Note: This field may return null, indicating that no valid values can be obtained. +* `period_seconds` - (Optional, Int) The time interval for performing health checks. Note: This field may return null, indicating that no valid values can be obtained. +* `port` - (Optional, Int) The port used for health checks, ranging from 1 to 65535. Note: This field may return null, indicating that no valid values can be obtained. +* `scheme` - (Optional, String) The protocol used for HTTP health checks. HTTP and HTTPS are supported. Note: This field may return null, indicating that no valid values can be obtained. +* `success_threshold` - (Optional, Int) The number of consecutive successful health checks required for the backend container to transition from failure to success. Note: This field may return null, indicating that no valid values can be obtained. +* `timeout_seconds` - (Optional, Int) The maximum timeout period for each health check response. Note: This field may return null, indicating that no valid values can be obtained. +* `type` - (Optional, String) The type of readiness probe. TSF_DEFAULT represents the default readiness probe of TSF, while K8S_NATIVE represents the native readiness probe of Kubernetes. If this field is not specified, the native readiness probe of Kubernetes is used by default. Note: This field may return null, indicating that no valid values can be obtained. + +The `warmup_setting` object supports the following: + +* `curvature` - (Optional, Int) Preheating curvature, with a value between 1 and 5. +* `enabled_protection` - (Optional, Bool) Whether to enable preheating protection. If protection is enabled and more than 50% of nodes are in preheating state, preheating will be aborted. +* `enabled` - (Optional, Bool) Whether to enable preheating. +* `warmup_time` - (Optional, Int) warmup time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tsf_enable_unit_rule.html.markdown b/config/docs/r/tsf_enable_unit_rule.html.markdown new file mode 100644 index 0000000..3a9b809 --- /dev/null +++ b/config/docs/r/tsf_enable_unit_rule.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_enable_unit_rule" +sidebar_current: "docs-tencentcloud-resource-tsf_enable_unit_rule" +description: |- + Provides a resource to create a tsf enable_unit_rule +--- + +# tencentcloud_tsf_enable_unit_rule + +Provides a resource to create a tsf enable_unit_rule + +## Example Usage + +```hcl +resource "tencentcloud_tsf_enable_unit_rule" "enable_unit_rule" { + rule_id = "unit-rl-is9m4nxz" + switch = "enabled" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `rule_id` - (Required, String) api ID. +* `switch` - (Required, String) switch, on: `enabled`, off: `disabled`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tsf enable_unit_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_enable_unit_rule.enable_unit_rule enable_unit_rule_id +``` + diff --git a/config/docs/r/tsf_group.html.markdown b/config/docs/r/tsf_group.html.markdown new file mode 100644 index 0000000..96373d9 --- /dev/null +++ b/config/docs/r/tsf_group.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_group" +sidebar_current: "docs-tencentcloud-resource-tsf_group" +description: |- + Provides a resource to create a tsf group +--- + +# tencentcloud_tsf_group + +Provides a resource to create a tsf group + +## Example Usage + +```hcl +resource "tencentcloud_tsf_group" "group" { + application_id = "application-xxx" + namespace_id = "namespace-aemrxxx" + group_name = "terraform-test" + cluster_id = "cluster-vwgjxxxx" + group_desc = "terraform desc" + alias = "terraform test" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `application_id` - (Required, String) The application ID to which the group belongs. +* `cluster_id` - (Required, String) Cluster ID. +* `group_name` - (Required, String) Group name field, length 1~60, beginning with a letter or underscore, can contain alphanumeric underscore. +* `namespace_id` - (Required, String) ID of the namespace to which the group belongs. +* `alias` - (Optional, String) Deployment Group Notes. +* `group_desc` - (Optional, String) Group description. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `group_resource_type` - Deployment Group Resource Type. + + +## Import + +tsf group can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_group.group group-axxx +``` + diff --git a/config/docs/r/tsf_instances_attachment.html.markdown b/config/docs/r/tsf_instances_attachment.html.markdown new file mode 100644 index 0000000..553e81d --- /dev/null +++ b/config/docs/r/tsf_instances_attachment.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_instances_attachment" +sidebar_current: "docs-tencentcloud-resource-tsf_instances_attachment" +description: |- + Provides a resource to create a tsf instances_attachment +--- + +# tencentcloud_tsf_instances_attachment + +Provides a resource to create a tsf instances_attachment + +## Example Usage + +```hcl +resource "tencentcloud_tsf_instances_attachment" "instances_attachment" { + cluster_id = "cluster-123456" + instance_id_list = [""] + os_name = "Ubuntu 20.04" + image_id = "img-123456" + password = "MyP@ssw0rd" + key_id = "key-123456" + sg_id = "sg-123456" + instance_import_mode = "R" + os_customize_type = "my_customize" + feature_id_list = + instance_advanced_settings { + mount_target = "/mnt/data" + docker_graph_path = "/var/lib/docker" + } + security_group_ids = [""] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cluster_id` - (Required, String, ForceNew) Cluster ID. +* `instance_id` - (Required, String, ForceNew) Cloud server ID. +* `feature_id_list` - (Optional, Set: [`String`], ForceNew) Image feature ID list. +* `image_id` - (Optional, String, ForceNew) Operating system image ID. +* `instance_advanced_settings` - (Optional, List, ForceNew) Additional instance parameter information. +* `instance_import_mode` - (Optional, String, ForceNew) Cloud server import mode, required for virtual machine clusters, not required for container clusters. R: Reinstall TSF system image, M: Manual installation of agent. +* `key_id` - (Optional, String, ForceNew) Associated key for system reinstallation. +* `os_customize_type` - (Optional, String, ForceNew) Image customization type. +* `os_name` - (Optional, String, ForceNew) Operating system name. +* `password` - (Optional, String, ForceNew) Reset system password. +* `security_group_ids` - (Optional, Set: [`String`], ForceNew) Security group. +* `sg_id` - (Optional, String, ForceNew) Security group setting. + +The `instance_advanced_settings` object supports the following: + +* `docker_graph_path` - (Required, String) Dockerd --graph specifies the value, default is /var/lib/docker Note: This field may return null, indicating that no valid values can be obtained. +* `mount_target` - (Required, String) Data disk mount point, data disks are not mounted by default. Data disks with formatted ext3, ext4, xfs file systems will be mounted directly, other file systems or unformatted data disks will be automatically formatted as ext4 and mounted. Please back up your data! This setting does not take effect for cloud servers with no data disks or multiple data disks. Note: This field may return null, indicating that no valid values can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tsf_lane.html.markdown b/config/docs/r/tsf_lane.html.markdown new file mode 100644 index 0000000..32be443 --- /dev/null +++ b/config/docs/r/tsf_lane.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_lane" +sidebar_current: "docs-tencentcloud-resource-tsf_lane" +description: |- + Provides a resource to create a tsf lane +--- + +# tencentcloud_tsf_lane + +Provides a resource to create a tsf lane + +## Example Usage + +```hcl +resource "tencentcloud_tsf_lane" "lane" { + lane_name = "lane-name-1" + remark = "lane desc1" + lane_group_list { + group_id = "group-yn7j5l8a" + entrance = true + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `lane_group_list` - (Required, List) Swimlane Deployment Group Information. +* `lane_name` - (Required, String) Lane name. +* `remark` - (Required, String) Lane Remarks. +* `program_id_list` - (Optional, Set: [`String`]) Program id list. + +The `lane_group_list` object supports the following: + +* `entrance` - (Required, Bool) Whether to enter the application. +* `group_id` - (Required, String) Deployment group ID. +* `application_id` - (Optional, String) application ID. +* `application_name` - (Optional, String) application name. +* `cluster_type` - (Optional, String) cluster type. +* `create_time` - (Optional, Int) creation time. +* `group_name` - (Optional, String) deployment group name. +* `lane_group_id` - (Optional, String) Swimlane deployment group ID. +* `lane_id` - (Optional, String) Lane ID. +* `namespace_id` - (Optional, String) Namespace ID. +* `namespace_name` - (Optional, String) namespace name. +* `update_time` - (Optional, Int) update time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - creation time. +* `entrance` - Whether to enter the application. +* `lane_id` - Lane id. +* `namespace_id_list` - A list of namespaces to which the swimlane has associated deployment groups. +* `update_time` - update time. + + diff --git a/config/docs/r/tsf_lane_rule.html.markdown b/config/docs/r/tsf_lane_rule.html.markdown new file mode 100644 index 0000000..a93d230 --- /dev/null +++ b/config/docs/r/tsf_lane_rule.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_lane_rule" +sidebar_current: "docs-tencentcloud-resource-tsf_lane_rule" +description: |- + Provides a resource to create a tsf lane_rule +--- + +# tencentcloud_tsf_lane_rule + +Provides a resource to create a tsf lane_rule + +## Example Usage + +```hcl +resource "tencentcloud_tsf_lane_rule" "lane_rule" { + rule_name = "terraform-rule-name" + remark = "terraform-test" + rule_tag_list { + tag_name = "xxx" + tag_operator = "EQUAL" + tag_value = "222" + } + rule_tag_relationship = "RELEATION_AND" + lane_id = "lane-abw5oo5a" + enable = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `enable` - (Required, Bool) open state, true/false, default: false. +* `lane_id` - (Required, String) lane ID. +* `remark` - (Required, String) Lane rule notes. +* `rule_name` - (Required, String) lane rule name. +* `rule_tag_list` - (Required, List) list of swimlane rule labels. +* `rule_tag_relationship` - (Required, String) lane rule label relationship. +* `program_id_list` - (Optional, Set: [`String`]) Program id list. + +The `rule_tag_list` object supports the following: + +* `tag_name` - (Required, String) label name. +* `tag_operator` - (Required, String) label operator. +* `tag_value` - (Required, String) tag value. +* `create_time` - (Optional, Int) creation time. +* `lane_rule_id` - (Optional, String) lane rule ID. +* `tag_id` - (Optional, String) label ID. +* `update_time` - (Optional, Int) update time. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - creation time. +* `priority` - Priority. +* `rule_id` - Rule id. +* `update_time` - update time. + + diff --git a/config/docs/r/tsf_microservice.html.markdown b/config/docs/r/tsf_microservice.html.markdown new file mode 100644 index 0000000..45a0345 --- /dev/null +++ b/config/docs/r/tsf_microservice.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_microservice" +sidebar_current: "docs-tencentcloud-resource-tsf_microservice" +description: |- + Provides a resource to create a tsf microservice +--- + +# tencentcloud_tsf_microservice + +Provides a resource to create a tsf microservice + +## Example Usage + +```hcl +resource "tencentcloud_tsf_microservice" "microservice" { + namespace_id = "namespace-vjlkzkgy" + microservice_name = "test-microservice" + microservice_desc = "desc-microservice" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `microservice_name` - (Required, String) Microservice name. +* `namespace_id` - (Required, String) Namespace ID. +* `microservice_desc` - (Optional, String) Microservice description information. +* `tags` - (Optional, Map) Tag description list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +tsf microservice can be imported using the namespaceId#microserviceId, e.g. + +``` +terraform import tencentcloud_tsf_microservice.microservice namespace-vjlkzkgy#ms-vjeb43lw +``` + diff --git a/config/docs/r/tsf_namespace.html.markdown b/config/docs/r/tsf_namespace.html.markdown new file mode 100644 index 0000000..2283790 --- /dev/null +++ b/config/docs/r/tsf_namespace.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_namespace" +sidebar_current: "docs-tencentcloud-resource-tsf_namespace" +description: |- + Provides a resource to create a tsf namespace +--- + +# tencentcloud_tsf_namespace + +Provides a resource to create a tsf namespace + +## Example Usage + +```hcl +resource "tencentcloud_tsf_namespace" "namespace" { + namespace_name = "namespace-name" + # cluster_id = "cls-xxxx" + namespace_desc = "namespace desc" + # namespace_resource_type = "" + namespace_type = "DEF" + # namespace_id = "" + is_ha_enable = "0" + # program_id = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `namespace_name` - (Required, String) namespace name. +* `cluster_id` - (Optional, String) cluster ID. +* `is_ha_enable` - (Optional, String) whether to enable high availability. +* `namespace_desc` - (Optional, String) namespace description. +* `namespace_id` - (Optional, String) Namespace ID. +* `namespace_resource_type` - (Optional, String) namespace resource type (default is DEF). +* `namespace_type` - (Optional, String) Whether it is a global namespace (the default is DEF, which means a common namespace; GLOBAL means a global namespace). +* `program_id_list` - (Optional, Set: [`String`]) Program id list. +* `program_id` - (Optional, String) ID of the dataset to be bound. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - creation time. +* `delete_flag` - Delete ID. +* `is_default` - default namespace. +* `kube_inject_enable` - KubeInjectEnable value. +* `namespace_code` - Namespace encoding. +* `namespace_status` - namespace status. +* `update_time` - update time. + + diff --git a/config/docs/r/tsf_operate_container_group.html.markdown b/config/docs/r/tsf_operate_container_group.html.markdown new file mode 100644 index 0000000..d2f1c3c --- /dev/null +++ b/config/docs/r/tsf_operate_container_group.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_operate_container_group" +sidebar_current: "docs-tencentcloud-resource-tsf_operate_container_group" +description: |- + Provides a resource to create a tsf operate_container_group +--- + +# tencentcloud_tsf_operate_container_group + +Provides a resource to create a tsf operate_container_group + +## Example Usage + +```hcl +resource "tencentcloud_tsf_operate_container_group" "operate_container_group" { + group_id = "group-ynd95rea" + operate = "stop" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String) group Id. +* `operate` - (Required, String) Operation, `start`- start the container, `stop`- stop the container. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tsf_operate_group.html.markdown b/config/docs/r/tsf_operate_group.html.markdown new file mode 100644 index 0000000..a200f0a --- /dev/null +++ b/config/docs/r/tsf_operate_group.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_operate_group" +sidebar_current: "docs-tencentcloud-resource-tsf_operate_group" +description: |- + Provides a resource to create a tsf operate_group +--- + +# tencentcloud_tsf_operate_group + +Provides a resource to create a tsf operate_group + +## Example Usage + +```hcl +resource "tencentcloud_tsf_operate_group" "operate_group" { + group_id = "group-ynd95rea" + operate = "start" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String) group id. +* `operate` - (Required, String) Operation, `start`- start the group, `stop`- stop the group. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tsf_path_rewrite.html.markdown b/config/docs/r/tsf_path_rewrite.html.markdown new file mode 100644 index 0000000..792a0b8 --- /dev/null +++ b/config/docs/r/tsf_path_rewrite.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_path_rewrite" +sidebar_current: "docs-tencentcloud-resource-tsf_path_rewrite" +description: |- + Provides a resource to create a tsf path_rewrite +--- + +# tencentcloud_tsf_path_rewrite + +Provides a resource to create a tsf path_rewrite + +## Example Usage + +```hcl +resource "tencentcloud_tsf_path_rewrite" "path_rewrite" { + gateway_group_id = "group-a2j9zxpv" + regex = "/test" + replacement = "/tt" + blocked = "N" + order = 2 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `blocked` - (Required, String) Whether to shield the mapped path, Y: Yes N: No. +* `gateway_group_id` - (Required, String) gateway deployment group ID. +* `order` - (Required, Int) rule order, the smaller the higher the priority. +* `regex` - (Required, String) regular expression. +* `replacement` - (Required, String) content to replace. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `path_rewrite_id` - path rewrite rule ID. + + +## Import + +tsf path_rewrite can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_path_rewrite.path_rewrite rewrite-nygq33v2 +``` + diff --git a/config/docs/r/tsf_release_api_group.html.markdown b/config/docs/r/tsf_release_api_group.html.markdown new file mode 100644 index 0000000..a4084dc --- /dev/null +++ b/config/docs/r/tsf_release_api_group.html.markdown @@ -0,0 +1,35 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_release_api_group" +sidebar_current: "docs-tencentcloud-resource-tsf_release_api_group" +description: |- + Provides a resource to create a tsf release_api_group +--- + +# tencentcloud_tsf_release_api_group + +Provides a resource to create a tsf release_api_group + +## Example Usage + +```hcl +resource "tencentcloud_tsf_release_api_group" "release_api_group" { + group_id = "grp-qp0rj3zi" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `group_id` - (Required, String, ForceNew) api group Id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/tsf_repository.html.markdown b/config/docs/r/tsf_repository.html.markdown new file mode 100644 index 0000000..f4e221f --- /dev/null +++ b/config/docs/r/tsf_repository.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_repository" +sidebar_current: "docs-tencentcloud-resource-tsf_repository" +description: |- + Provides a resource to create a tsf repository +--- + +# tencentcloud_tsf_repository + +Provides a resource to create a tsf repository + +## Example Usage + +```hcl +resource "tencentcloud_tsf_repository" "repository" { + repository_name = "" + repository_type = "" + bucket_name = "" + bucket_region = "" + directory = "" + repository_desc = "" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket_name` - (Required, String) the name of the bucket where the warehouse is located. +* `bucket_region` - (Required, String) Bucket region where the warehouse is located. +* `repository_name` - (Required, String) warehouse name. +* `repository_type` - (Required, String) warehouse type (default warehouse: default, private warehouse: private). +* `directory` - (Optional, String) directory. +* `repository_desc` - (Optional, String) warehouse description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - warehouse creation time. +* `is_used` - whether the repository is in use. +* `repository_id` - Warehouse ID. + + +## Import + +tsf repository can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_repository.repository repository_id +``` + diff --git a/config/docs/r/tsf_task.html.markdown b/config/docs/r/tsf_task.html.markdown new file mode 100644 index 0000000..3bf76ec --- /dev/null +++ b/config/docs/r/tsf_task.html.markdown @@ -0,0 +1,94 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_task" +sidebar_current: "docs-tencentcloud-resource-tsf_task" +description: |- + Provides a resource to create a tsf task +--- + +# tencentcloud_tsf_task + +Provides a resource to create a tsf task + +## Example Usage + +```hcl +resource "tencentcloud_tsf_task" "task" { + task_name = "terraform-test" + task_content = "/test" + execute_type = "unicast" + task_type = "java" + time_out = 60000 + group_id = "group-y8pnmoga" + task_rule { + rule_type = "Cron" + expression = "0 * 1 * * ? " + } + retry_count = 0 + retry_interval = 0 + success_operator = "GTE" + success_ratio = "100" + advance_settings { + sub_task_concurrency = 2 + } + task_argument = "a=c" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `execute_type` - (Required, String) execution type, unicast/broadcast. +* `group_id` - (Required, String) deployment group ID. +* `task_content` - (Required, String) task content, length limit 65536 bytes. +* `task_name` - (Required, String) task name, task length 64 characters. +* `task_type` - (Required, String) task type, java. +* `time_out` - (Required, Int) task timeout, time unit ms. +* `advance_settings` - (Optional, List) advanced settings. +* `program_id_list` - (Optional, Set: [`String`]) Program id list. +* `retry_count` - (Optional, Int) number of retries, 0 &lt;= RetryCount&lt;= 10. +* `retry_interval` - (Optional, Int) retry interval, 0 &lt;= RetryInterval &lt;= 600000, time unit ms. +* `shard_arguments` - (Optional, List) Fragmentation parameters. +* `shard_count` - (Optional, Int) number of shards. +* `success_operator` - (Optional, String) the operator to judge the success of the task. +* `success_ratio` - (Optional, String) The threshold for judging the success rate of the task, such as 100. +* `task_argument` - (Optional, String) task parameters, the length limit is 10000 characters. +* `task_rule` - (Optional, List) trigger rule. + +The `advance_settings` object supports the following: + +* `sub_task_concurrency` - (Optional, Int) Subtask single-machine concurrency limit, the default value is 2. + +The `shard_arguments` object supports the following: + +* `shard_key` - (Required, Int) Sharding parameter KEY, integer, range [1,1000]. +* `shard_value` - (Required, String) Shard parameter VALUE. + +The `task_rule` object supports the following: + +* `rule_type` - (Required, String) trigger rule type, Cron/Repeat. +* `expression` - (Optional, String) Cron type rule, cron expression. +* `repeat_interval` - (Optional, Int) time interval, in milliseconds. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `belong_flow_ids` - ID of the workflow to which it belongs. +* `task_id` - task ID. +* `task_log_id` - task history ID. +* `task_state` - Whether to enable the task, ENABLED/DISABLED. +* `trigger_type` - trigger type. + + +## Import + +tsf task can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_task.task task-y37eqq95 +``` + diff --git a/config/docs/r/tsf_unit_namespace.html.markdown b/config/docs/r/tsf_unit_namespace.html.markdown new file mode 100644 index 0000000..7245c9c --- /dev/null +++ b/config/docs/r/tsf_unit_namespace.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_unit_namespace" +sidebar_current: "docs-tencentcloud-resource-tsf_unit_namespace" +description: |- + Provides a resource to create a tsf unit_namespace +--- + +# tencentcloud_tsf_unit_namespace + +Provides a resource to create a tsf unit_namespace + +## Example Usage + +```hcl +resource "tencentcloud_tsf_unit_namespace" "unit_namespace" { + gateway_instance_id = "gw-ins-lvdypq5k" + namespace_id = "namespace-vwgo38wy" + namespace_name = "keep-terraform-cls" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_instance_id` - (Required, String, ForceNew) gateway instance Id. +* `namespace_id` - (Required, String, ForceNew) namespace id. +* `namespace_name` - (Required, String, ForceNew) namespace name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `created_time` - Create time. Note: This field may return null, indicating that no valid value was found. +* `updated_time` - Update time. Note: This field may return null, indicating that no valid value was found. + + +## Import + +tsf unit_namespace can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_unit_namespace.unit_namespace gw-ins-lvdypq5k#namespace-vwgo38wy +``` + diff --git a/config/docs/r/tsf_unit_rule.html.markdown b/config/docs/r/tsf_unit_rule.html.markdown new file mode 100644 index 0000000..37d011b --- /dev/null +++ b/config/docs/r/tsf_unit_rule.html.markdown @@ -0,0 +1,84 @@ +--- +subcategory: "Tencent Service Framework(TSF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_tsf_unit_rule" +sidebar_current: "docs-tencentcloud-resource-tsf_unit_rule" +description: |- + Provides a resource to create a tsf unit_rule +--- + +# tencentcloud_tsf_unit_rule + +Provides a resource to create a tsf unit_rule + +## Example Usage + +```hcl +resource "tencentcloud_tsf_unit_rule" "unit_rule" { + gateway_instance_id = "gw-ins-rug79a70" + name = "terraform-test" + description = "terraform-desc" + unit_rule_item_list { + relationship = "AND" + dest_namespace_id = "namespace-y8p88eka" + dest_namespace_name = "garden-test_default" + name = "Rule1" + description = "rule1-desc" + unit_rule_tag_list { + tag_type = "U" + tag_field = "aaa" + tag_operator = "IN" + tag_value = "1" + } + + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `gateway_instance_id` - (Required, String) gateway entity ID. +* `name` - (Required, String) rule name. +* `description` - (Optional, String) rule description. +* `unit_rule_item_list` - (Optional, List) list of rule items. + +The `unit_rule_item_list` object supports the following: + +* `dest_namespace_id` - (Required, String) destination namespace ID. +* `dest_namespace_name` - (Required, String) destination namespace name. +* `name` - (Required, String) rule item name. +* `relationship` - (Required, String) logical relationship: AND/OR. +* `description` - (Optional, String) rule description. +* `priority` - (Optional, Int) rule order, the smaller the higher the priority: the default is 0. +* `rule_id` - (Optional, String) rule item ID. +* `unit_rule_id` - (Optional, String) Unitization rule ID. +* `unit_rule_tag_list` - (Optional, List) list of rule labels. + +The `unit_rule_tag_list` object supports the following: + +* `tag_field` - (Required, String) label name. +* `tag_operator` - (Required, String) Operator: IN/NOT_IN/EQUAL/NOT_EQUAL/REGEX. +* `tag_type` - (Required, String) Tag Type: U(User Tag). +* `tag_value` - (Required, String) tag value. +* `rule_id` - (Optional, String) rule ID. +* `unit_rule_item_id` - (Optional, String) Unitization rule item ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `rule_id` - rule ID. +* `status` - usage status: enabled/disabled. + + +## Import + +tsf unit_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_tsf_unit_rule.unit_rule unit-rl-zbywqeca +``` + diff --git a/config/docs/r/vod_adaptive_dynamic_streaming_template.html.markdown b/config/docs/r/vod_adaptive_dynamic_streaming_template.html.markdown new file mode 100644 index 0000000..812241b --- /dev/null +++ b/config/docs/r/vod_adaptive_dynamic_streaming_template.html.markdown @@ -0,0 +1,111 @@ +--- +subcategory: "Video on Demand(VOD)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vod_adaptive_dynamic_streaming_template" +sidebar_current: "docs-tencentcloud-resource-vod_adaptive_dynamic_streaming_template" +description: |- + Provide a resource to create a VOD adaptive dynamic streaming template. +--- + +# tencentcloud_vod_adaptive_dynamic_streaming_template + +Provide a resource to create a VOD adaptive dynamic streaming template. + +## Example Usage + +```hcl +resource "tencentcloud_vod_adaptive_dynamic_streaming_template" "foo" { + format = "HLS" + name = "tf-adaptive" + drm_type = "SimpleAES" + disable_higher_video_bitrate = false + disable_higher_video_resolution = false + comment = "test" + + stream_info { + video { + codec = "libx265" + fps = 4 + bitrate = 129 + resolution_adaptive = false + width = 128 + height = 128 + fill_type = "stretch" + } + audio { + codec = "libmp3lame" + bitrate = 129 + sample_rate = 44100 + audio_channel = "dual" + } + remove_audio = false + } + stream_info { + video { + codec = "libx264" + fps = 4 + bitrate = 256 + } + audio { + codec = "libfdk_aac" + bitrate = 256 + sample_rate = 44100 + } + remove_audio = true + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `format` - (Required, String) Adaptive bitstream format. Valid values: `HLS`. +* `name` - (Required, String) Template name. Length limit: 64 characters. +* `stream_info` - (Required, List) List of AdaptiveStreamTemplate parameter information of output substream for adaptive bitrate streaming. Up to 10 substreams can be output. Note: the frame rate of all substreams must be the same; otherwise, the frame rate of the first substream will be used as the output frame rate. +* `comment` - (Optional, String) Template description. Length limit: 256 characters. +* `disable_higher_video_bitrate` - (Optional, Bool) Whether to prohibit transcoding video from low bitrate to high bitrate. Valid values: `false`,`true`. `false`: no, `true`: yes. Default value: `false`. +* `disable_higher_video_resolution` - (Optional, Bool) Whether to prohibit transcoding from low resolution to high resolution. Valid values: `false`,`true`. `false`: no, `true`: yes. Default value: `false`. +* `drm_type` - (Optional, String, ForceNew) DRM scheme type. Valid values: `SimpleAES`. If this field is an empty string, DRM will not be performed on the video. +* `sub_app_id` - (Optional, Int) Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. + +The `audio` object supports the following: + +* `bitrate` - (Required, Int) Audio stream bitrate in Kbps. Value range: `0` and `[26, 256]`. If the value is `0`, the bitrate of the audio stream will be the same as that of the original audio. +* `codec` - (Required, String) Audio stream encoder. Valid value are: `libfdk_aac` and `libmp3lame`. while `libfdk_aac` is recommended. +* `sample_rate` - (Required, Int) Audio stream sample rate. Valid values: `32000`, `44100`, `48000`Hz. +* `audio_channel` - (Optional, String) Audio channel system. Valid values: mono, dual, stereo. Default value: dual. + +The `stream_info` object supports the following: + +* `audio` - (Required, List) Audio parameter information. +* `video` - (Required, List) Video parameter information. +* `remove_audio` - (Optional, Bool) Whether to remove audio stream. Valid values: `false`: no, `true`: yes. `false` by default. + +The `video` object supports the following: + +* `bitrate` - (Required, Int) Bitrate of video stream in Kbps. Value range: `0` and `[128, 35000]`. If the value is `0`, the bitrate of the video will be the same as that of the source video. +* `codec` - (Required, String) Video stream encoder. Valid values: `libx264`,`libx265`,`av1`. `libx264`: H.264, `libx265`: H.265, `av1`: AOMedia Video 1. Currently, a resolution within 640x480 must be specified for `H.265`. and the `av1` container only supports mp4. +* `fps` - (Required, Int) Video frame rate in Hz. Value range: `[0, 60]`. If the value is `0`, the frame rate will be the same as that of the source video. +* `fill_type` - (Optional, String) Fill type. Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: `stretch`: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; `black`: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: black. Note: this field may return null, indicating that no valid values can be obtained. +* `height` - (Optional, Int) Maximum value of the height (or short side) of a video stream in px. Value range: `0` and `[128, 4096]`. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, `width` will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. Default value: `0`. Note: this field may return null, indicating that no valid values can be obtained. +* `resolution_adaptive` - (Optional, Bool) Resolution adaption. Valid values: `true`,`false`. `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height. Default value: `true`. Note: this field may return null, indicating that no valid values can be obtained. +* `width` - (Optional, Int) Maximum value of the width (or long side) of a video stream in px. Value range: `0` and `[128, 4096]`. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, `width` will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. Default value: `0`. Note: this field may return null, indicating that no valid values can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of template in ISO date format. +* `update_time` - Last modified time of template in ISO date format. + + +## Import + +VOD adaptive dynamic streaming template can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_vod_adaptive_dynamic_streaming_template.foo 169141 +``` + diff --git a/config/docs/r/vod_image_sprite_template.html.markdown b/config/docs/r/vod_image_sprite_template.html.markdown new file mode 100644 index 0000000..9c42441 --- /dev/null +++ b/config/docs/r/vod_image_sprite_template.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Video on Demand(VOD)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vod_image_sprite_template" +sidebar_current: "docs-tencentcloud-resource-vod_image_sprite_template" +description: |- + Provide a resource to create a VOD image sprite template. +--- + +# tencentcloud_vod_image_sprite_template + +Provide a resource to create a VOD image sprite template. + +## Example Usage + +```hcl +resource "tencentcloud_vod_image_sprite_template" "foo" { + sample_type = "Percent" + sample_interval = 10 + row_count = 3 + column_count = 3 + name = "tf-sprite" + comment = "test" + fill_type = "stretch" + width = 128 + height = 128 + resolution_adaptive = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `column_count` - (Required, Int) Subimage column count of an image sprite. +* `name` - (Required, String) Name of a time point screen capturing template. Length limit: 64 characters. +* `row_count` - (Required, Int) Subimage row count of an image sprite. +* `sample_interval` - (Required, Int) Sampling interval. If `sample_type` is `Percent`, sampling will be performed at an interval of the specified percentage. If `sample_type` is `Time`, sampling will be performed at the specified time interval in seconds. +* `sample_type` - (Required, String) Sampling type. Valid values: `Percent`, `Time`. `Percent`: by percent. `Time`: by time interval. +* `comment` - (Optional, String) Template description. Length limit: 256 characters. +* `fill_type` - (Optional, String) Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: `stretch`: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot shorter or longer; `black`: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. Default value: `black`. +* `height` - (Optional, Int) Maximum value of the `height` (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, `width` will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. Default value: `0`. +* `resolution_adaptive` - (Optional, Bool) Resolution adaption. Valid values: `true`,`false`. `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height. Default value: `true`. +* `sub_app_id` - (Optional, Int) Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. +* `width` - (Optional, Int) Maximum value of the `width` (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, width will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. Default value: `0`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of template in ISO date format. +* `update_time` - Last modified time of template in ISO date format. + + +## Import + +VOD image sprite template can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_vod_image_sprite_template.foo 51156 +``` + diff --git a/config/docs/r/vod_procedure_template.html.markdown b/config/docs/r/vod_procedure_template.html.markdown new file mode 100644 index 0000000..a9d2fa7 --- /dev/null +++ b/config/docs/r/vod_procedure_template.html.markdown @@ -0,0 +1,193 @@ +--- +subcategory: "Video on Demand(VOD)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vod_procedure_template" +sidebar_current: "docs-tencentcloud-resource-vod_procedure_template" +description: |- + Provide a resource to create a VOD procedure template. +--- + +# tencentcloud_vod_procedure_template + +Provide a resource to create a VOD procedure template. + +## Example Usage + +```hcl +resource "tencentcloud_vod_adaptive_dynamic_streaming_template" "foo" { + format = "HLS" + name = "tf-adaptive" + drm_type = "SimpleAES" + disable_higher_video_bitrate = false + disable_higher_video_resolution = false + comment = "test" + + stream_info { + video { + codec = "libx265" + fps = 4 + bitrate = 129 + resolution_adaptive = false + width = 128 + height = 128 + fill_type = "stretch" + } + audio { + codec = "libmp3lame" + bitrate = 129 + sample_rate = 44100 + audio_channel = "dual" + } + remove_audio = false + } + stream_info { + video { + codec = "libx264" + fps = 4 + bitrate = 256 + } + audio { + codec = "libfdk_aac" + bitrate = 256 + sample_rate = 44100 + } + remove_audio = true + } +} + +resource "tencentcloud_vod_snapshot_by_time_offset_template" "foo" { + name = "tf-snapshot" + width = 130 + height = 128 + resolution_adaptive = false + format = "png" + comment = "test" + fill_type = "white" +} + +resource "tencentcloud_vod_image_sprite_template" "foo" { + sample_type = "Percent" + sample_interval = 10 + row_count = 3 + column_count = 3 + name = "tf-sprite" + comment = "test" + fill_type = "stretch" + width = 128 + height = 128 + resolution_adaptive = false +} + +resource "tencentcloud_vod_procedure_template" "foo" { + name = "tf-procedure" + comment = "test" + media_process_task { + adaptive_dynamic_streaming_task_list { + definition = tencentcloud_vod_adaptive_dynamic_streaming_template.foo.id + } + snapshot_by_time_offset_task_list { + definition = tencentcloud_vod_snapshot_by_time_offset_template.foo.id + ext_time_offset_list = [ + "3.5s" + ] + } + image_sprite_task_list { + definition = tencentcloud_vod_image_sprite_template.foo.id + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String, ForceNew) Task flow name (up to 20 characters). +* `comment` - (Optional, String) Template description. Length limit: 256 characters. +* `media_process_task` - (Optional, List) Parameter of video processing task. +* `sub_app_id` - (Optional, Int) Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. + +The `adaptive_dynamic_streaming_task_list` object supports the following: + +* `definition` - (Required, String) Adaptive bitrate streaming template ID. +* `watermark_list` - (Optional, List) List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained. + +The `animated_graphic_task_list` object supports the following: + +* `definition` - (Required, String) Animated image generating template ID. +* `end_time_offset` - (Required, Float64) End time of animated image in video in seconds. +* `start_time_offset` - (Required, Float64) Start time of animated image in video in seconds. + +The `cover_by_snapshot_task_list` object supports the following: + +* `definition` - (Required, String) Time point screen capturing template ID. +* `position_type` - (Required, String) Screen capturing mode. Valid values: `Time`, `Percent`. `Time`: screen captures by time point, `Percent`: screen captures by percentage. +* `position_value` - (Required, Float64) Screenshot position: For time point screen capturing, this means to take a screenshot at a specified time point (in seconds) and use it as the cover. For percentage screen capturing, this value means to take a screenshot at a specified percentage of the video duration and use it as the cover. +* `watermark_list` - (Optional, List) List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained. + +The `image_sprite_task_list` object supports the following: + +* `definition` - (Required, String) Image sprite generating template ID. + +The `media_process_task` object supports the following: + +* `adaptive_dynamic_streaming_task_list` - (Optional, List) List of adaptive bitrate streaming tasks. Note: this field may return null, indicating that no valid values can be obtained. +* `animated_graphic_task_list` - (Optional, List) List of animated image generating tasks. Note: this field may return null, indicating that no valid values can be obtained. +* `cover_by_snapshot_task_list` - (Optional, List) List of cover generating tasks. Note: this field may return null, indicating that no valid values can be obtained. +* `image_sprite_task_list` - (Optional, List) List of image sprite generating tasks. Note: this field may return null, indicating that no valid values can be obtained. +* `sample_snapshot_task_list` - (Optional, List) List of sampled screen capturing tasks. Note: this field may return null, indicating that no valid values can be obtained. +* `snapshot_by_time_offset_task_list` - (Optional, List) List of time point screen capturing tasks. Note: this field may return null, indicating that no valid values can be obtained. +* `transcode_task_list` - (Optional, List) List of transcoding tasks. Note: this field may return null, indicating that no valid values can be obtained. + +The `mosaic_list` object supports the following: + +* `coordinate_origin` - (Optional, String) Origin position, which currently can only be: `TopLeft`: the origin of coordinates is in the top-left corner of the video, and the origin of the blur is in the top-left corner of the image or text. Default value: TopLeft. +* `end_time_offset` - (Optional, Float64) End time offset of blur in seconds. If this parameter is left empty or `0` is entered, the blur will exist till the last video frame; If this value is greater than `0` (e.g., n), the blur will exist till second n; If this value is smaller than `0` (e.g., -n), the blur will exist till second n before the last video frame. +* `height` - (Optional, String) Blur height. `%` and `px` formats are supported: If the string ends in `%`, the `height` of the blur will be the specified percentage of the video height; for example, 10% means that Height is 10% of the video height; If the string ends in `px`, the `height` of the blur will be in px; for example, 100px means that Height is 100 px. Default value: `10%`. +* `start_time_offset` - (Optional, Float64) Start time offset of blur in seconds. If this parameter is left empty or `0` is entered, the blur will appear upon the first video frame. If this parameter is left empty or `0` is entered, the blur will appear upon the first video frame; If this value is greater than `0` (e.g., n), the blur will appear at second n after the first video frame; If this value is smaller than `0` (e.g., -n), the blur will appear at second n before the last video frame. +* `width` - (Optional, String) Blur width. `%` and `px` formats are supported: If the string ends in `%`, the `width` of the blur will be the specified percentage of the video width; for example, 10% means that `width` is 10% of the video width; If the string ends in `px`, the `width` of the blur will be in px; for example, 100px means that Width is 100 px. Default value: `10%`. +* `x_pos` - (Optional, String) The horizontal position of the origin of the blur relative to the origin of coordinates of the video. `%` and `px` formats are supported: If the string ends in `%`, the XPos of the blur will be the specified percentage of the video width; for example, 10% means that XPos is 10% of the video width; If the string ends in `px`, the XPos of the blur will be the specified px; for example, 100px means that XPos is 100 px. Default value: `0px`. +* `y_pos` - (Optional, String) Vertical position of the origin of blur relative to the origin of coordinates of video. `%` and `px` formats are supported: If the string ends in `%`, the YPos of the blur will be the specified percentage of the video height; for example, 10% means that YPos is 10% of the video height; If the string ends in `px`, the YPos of the blur will be the specified px; for example, 100px means that YPos is 100 px. Default value: `0px`. + +The `sample_snapshot_task_list` object supports the following: + +* `definition` - (Required, String) Sampled screen capturing template ID. +* `watermark_list` - (Optional, List) List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained. + +The `snapshot_by_time_offset_task_list` object supports the following: + +* `definition` - (Required, String) Time point screen capturing template ID. +* `ext_time_offset_list` - (Optional, List) The list of screenshot time points. `s` and `%` formats are supported: When a time point string ends with `s`, its unit is second. For example, `3.5s` means the 3.5th second of the video; When a time point string ends with `%`, it is marked with corresponding percentage of the video duration. For example, `10%` means that the time point is at the 10% of the video entire duration. +* `watermark_list` - (Optional, List) List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained. + +The `transcode_task_list` object supports the following: + +* `definition` - (Required, String) Video transcoding template ID. +* `mosaic_list` - (Optional, List) List of blurs. Up to 10 ones can be supported. +* `watermark_list` - (Optional, List) List of up to `10` image or text watermarks. Note: this field may return null, indicating that no valid values can be obtained. + +The `watermark_list` object supports the following: + +* `definition` - (Required, String) Watermarking template ID. +* `end_time_offset` - (Optional, Float64) End time offset of a watermark in seconds. If this parameter is left blank or `0` is entered, the watermark will exist till the last video frame; If this value is greater than `0` (e.g., n), the watermark will exist till second n; If this value is smaller than `0` (e.g., -n), the watermark will exist till second n before the last video frame. +* `start_time_offset` - (Optional, Float64) Start time offset of a watermark in seconds. If this parameter is left blank or `0` is entered, the watermark will appear upon the first video frame. If this parameter is left blank or `0` is entered, the watermark will appear upon the first video frame; If this value is greater than `0` (e.g., n), the watermark will appear at second n after the first video frame; If this value is smaller than `0` (e.g., -n), the watermark will appear at second n before the last video frame. +* `svg_content` - (Optional, String) SVG content of up to `2000000` characters. This needs to be entered only when the watermark type is `SVG`. Note: this field may return null, indicating that no valid values can be obtained. +* `text_content` - (Optional, String) Text content of up to `100` characters. This needs to be entered only when the watermark type is text. Note: this field may return null, indicating that no valid values can be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of template in ISO date format. +* `update_time` - Last modified time of template in ISO date format. + + +## Import + +VOD procedure template can be imported using the name, e.g. + +``` +$ terraform import tencentcloud_vod_procedure_template.foo tf-procedure +``` + diff --git a/config/docs/r/vod_snapshot_by_time_offset_template.html.markdown b/config/docs/r/vod_snapshot_by_time_offset_template.html.markdown new file mode 100644 index 0000000..2613d65 --- /dev/null +++ b/config/docs/r/vod_snapshot_by_time_offset_template.html.markdown @@ -0,0 +1,57 @@ +--- +subcategory: "Video on Demand(VOD)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vod_snapshot_by_time_offset_template" +sidebar_current: "docs-tencentcloud-resource-vod_snapshot_by_time_offset_template" +description: |- + Provide a resource to create a VOD snapshot by time offset template. +--- + +# tencentcloud_vod_snapshot_by_time_offset_template + +Provide a resource to create a VOD snapshot by time offset template. + +## Example Usage + +```hcl +resource "tencentcloud_vod_snapshot_by_time_offset_template" "foo" { + name = "tf-snapshot" + width = 130 + height = 128 + resolution_adaptive = false + format = "png" + comment = "test" + fill_type = "white" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of a time point screen capturing template. Length limit: 64 characters. +* `comment` - (Optional, String) Template description. Length limit: 256 characters. +* `fill_type` - (Optional, String) Fill refers to the way of processing a screenshot when its aspect ratio is different from that of the source video. The following fill types are supported: `stretch`: stretch. The screenshot will be stretched frame by frame to match the aspect ratio of the source video, which may make the screenshot `shorter` or `longer`; `black`: fill with black. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with black color blocks. `white`: fill with white. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with white color blocks. `gauss`: fill with Gaussian blur. This option retains the aspect ratio of the source video for the screenshot and fills the unmatched area with Gaussian blur. Default value: `black`. +* `format` - (Optional, String) Image format. Valid values: `jpg`, `png`. Default value: `jpg`. +* `height` - (Optional, Int) Maximum value of the `height` (or short side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, `width` will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. Default value: `0`. +* `resolution_adaptive` - (Optional, Bool) Resolution adaption. Valid values: `true`,`false`. `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height. Default value: `true`. +* `sub_app_id` - (Optional, Int) Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. +* `width` - (Optional, Int) Maximum value of the `width` (or long side) of a screenshot in px. Value range: 0 and [128, 4,096]. If both `width` and `height` are `0`, the resolution will be the same as that of the source video; If `width` is `0`, but `height` is not `0`, width will be proportionally scaled; If `width` is not `0`, but `height` is `0`, `height` will be proportionally scaled; If both `width` and `height` are not `0`, the custom resolution will be used. Default value: `0`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of template in ISO date format. +* `update_time` - Last modified time of template in ISO date format. + + +## Import + +VOD snapshot by time offset template can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_vod_snapshot_by_time_offset_template.foo 46906 +``` + diff --git a/config/docs/r/vod_sub_application.html.markdown b/config/docs/r/vod_sub_application.html.markdown new file mode 100644 index 0000000..86d8358 --- /dev/null +++ b/config/docs/r/vod_sub_application.html.markdown @@ -0,0 +1,47 @@ +--- +subcategory: "Video on Demand(VOD)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vod_sub_application" +sidebar_current: "docs-tencentcloud-resource-vod_sub_application" +description: |- + Provide a resource to create a VOD sub application. +--- + +# tencentcloud_vod_sub_application + +Provide a resource to create a VOD sub application. + +## Example Usage + +```hcl +resource "tencentcloud_vod_sub_application" "foo" { + name = "foo" + status = "On" + description = "this is sub application" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Sub application name, which can contain up to 64 letters, digits, underscores, and hyphens (such as test_ABC-123) and must be unique under a user. +* `status` - (Required, String) Sub appliaction status. +* `description` - (Optional, String) Sub application description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - The time when the sub application was created. + + +## Import + +VOD super player config can be imported using the name+, e.g. + +``` +$ terraform import tencentcloud_vod_sub_application.foo name+"#"+id +``` + diff --git a/config/docs/r/vod_super_player_config.html.markdown b/config/docs/r/vod_super_player_config.html.markdown new file mode 100644 index 0000000..06712ef --- /dev/null +++ b/config/docs/r/vod_super_player_config.html.markdown @@ -0,0 +1,132 @@ +--- +subcategory: "Video on Demand(VOD)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vod_super_player_config" +sidebar_current: "docs-tencentcloud-resource-vod_super_player_config" +description: |- + Provide a resource to create a VOD super player config. +--- + +# tencentcloud_vod_super_player_config + +Provide a resource to create a VOD super player config. + +## Example Usage + +```hcl +resource "tencentcloud_vod_adaptive_dynamic_streaming_template" "foo" { + format = "HLS" + name = "tf-adaptive" + drm_type = "SimpleAES" + disable_higher_video_bitrate = false + disable_higher_video_resolution = false + comment = "test" + + stream_info { + video { + codec = "libx265" + fps = 4 + bitrate = 129 + resolution_adaptive = false + width = 128 + height = 128 + fill_type = "stretch" + } + audio { + codec = "libmp3lame" + bitrate = 129 + sample_rate = 44100 + audio_channel = "dual" + } + remove_audio = false + } + stream_info { + video { + codec = "libx264" + fps = 4 + bitrate = 256 + } + audio { + codec = "libfdk_aac" + bitrate = 256 + sample_rate = 44100 + } + remove_audio = true + } +} + +resource "tencentcloud_vod_image_sprite_template" "foo" { + sample_type = "Percent" + sample_interval = 10 + row_count = 3 + column_count = 3 + name = "tf-sprite" + comment = "test" + fill_type = "stretch" + width = 128 + height = 128 + resolution_adaptive = false +} + +resource "tencentcloud_vod_super_player_config" "foo" { + name = "tf-super-player" + drm_switch = true + drm_streaming_info { + simple_aes_definition = tencentcloud_vod_adaptive_dynamic_streaming_template.foo.id + } + image_sprite_definition = tencentcloud_vod_image_sprite_template.foo.id + resolution_names { + min_edge_length = 889 + name = "test1" + } + resolution_names { + min_edge_length = 890 + name = "test2" + } + domain = "Default" + scheme = "Default" + comment = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String, ForceNew) Player configuration name, which can contain up to 64 letters, digits, underscores, and hyphens (such as test_ABC-123) and must be unique under a user. +* `adaptive_dynamic_streaming_definition` - (Optional, String) ID of the unencrypted adaptive bitrate streaming template that allows output, which is required if `drm_switch` is `false`. +* `comment` - (Optional, String) Template description. Length limit: 256 characters. +* `domain` - (Optional, String) Domain name used for playback. If it is left empty or set to `Default`, the domain name configured in [Default Distribution Configuration](https://cloud.tencent.com/document/product/266/33373) will be used. `Default` by default. +* `drm_streaming_info` - (Optional, List) Content of the DRM-protected adaptive bitrate streaming template that allows output, which is required if `drm_switch` is `true`. +* `drm_switch` - (Optional, Bool) Switch of DRM-protected adaptive bitstream playback: `true`: enabled, indicating to play back only output adaptive bitstreams protected by DRM; `false`: disabled, indicating to play back unencrypted output adaptive bitstreams. Default value: `false`. +* `image_sprite_definition` - (Optional, String) ID of the image sprite template that allows output. +* `resolution_names` - (Optional, List) Display name of player for substreams with different resolutions. If this parameter is left empty or an empty array, the default configuration will be used: `min_edge_length: 240, name: LD`; `min_edge_length: 480, name: SD`; `min_edge_length: 720, name: HD`; `min_edge_length: 1080, name: FHD`; `min_edge_length: 1440, name: 2K`; `min_edge_length: 2160, name: 4K`; `min_edge_length: 4320, name: 8K`. +* `scheme` - (Optional, String) Scheme used for playback. If it is left empty or set to `Default`, the scheme configured in [Default Distribution Configuration](https://cloud.tencent.com/document/product/266/33373) will be used. Other valid values: `HTTP`; `HTTPS`. +* `sub_app_id` - (Optional, Int) Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. + +The `drm_streaming_info` object supports the following: + +* `simple_aes_definition` - (Optional, String) ID of the adaptive dynamic streaming template whose protection type is `SimpleAES`. + +The `resolution_names` object supports the following: + +* `min_edge_length` - (Required, Int) Length of video short side in px. +* `name` - (Required, String) Display name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of template in ISO date format. +* `update_time` - Last modified time of template in ISO date format. + + +## Import + +VOD super player config can be imported using the name, e.g. + +``` +$ terraform import tencentcloud_vod_super_player_config.foo tf-super-player +``` + diff --git a/config/docs/r/vpc.html.markdown b/config/docs/r/vpc.html.markdown new file mode 100644 index 0000000..754bbc9 --- /dev/null +++ b/config/docs/r/vpc.html.markdown @@ -0,0 +1,75 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc" +sidebar_current: "docs-tencentcloud-resource-vpc" +description: |- + Provide a resource to create a VPC. +--- + +# tencentcloud_vpc + +Provide a resource to create a VPC. + +## Example Usage + +### Create a basic VPC + +```hcl +resource "tencentcloud_vpc" "vpc" { + name = "tf-example" + cidr_block = "10.0.0.0/16" + dns_servers = ["119.29.29.29", "8.8.8.8"] + is_multicast = false + + tags = { + "test" = "test" + } +} +``` + +### Using Assistant CIDR + +```hcl +resource "tencentcloud_vpc" "vpc" { + name = "tf-example" + cidr_block = "10.0.0.0/16" + is_multicast = false + assistant_cidrs = ["172.16.0.0/24"] + + tags = { + "test" = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cidr_block` - (Required, String, ForceNew) A network address block which should be a subnet of the three internal network segments (10.0.0.0/16, 172.16.0.0/12 and 192.168.0.0/16). +* `name` - (Required, String) The name of the VPC. +* `assistant_cidrs` - (Optional, List: [`String`]) List of Assistant CIDR, NOTE: Only `NORMAL` typed CIDRs included, check the Docker CIDR by readonly `assistant_docker_cidrs`. +* `dns_servers` - (Optional, Set: [`String`]) The DNS server list of the VPC. And you can specify 0 to 5 servers to this list. +* `is_multicast` - (Optional, Bool) Indicates whether VPC multicast is enabled. The default value is 'true'. +* `tags` - (Optional, Map) Tags of the VPC. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of VPC. +* `default_route_table_id` - Default route table id, which created automatically after VPC create. +* `docker_assistant_cidrs` - List of Docker Assistant CIDR. +* `is_default` - Indicates whether it is the default VPC for this region. + + +## Import + +Vpc instance can be imported, e.g. + +``` +$ terraform import tencentcloud_vpc.test vpc-id +``` + diff --git a/config/docs/r/vpc_acl.html.markdown b/config/docs/r/vpc_acl.html.markdown new file mode 100644 index 0000000..456c4b5 --- /dev/null +++ b/config/docs/r/vpc_acl.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_acl" +sidebar_current: "docs-tencentcloud-resource-vpc_acl" +description: |- + Provide a resource to create a VPC ACL instance. +--- + +# tencentcloud_vpc_acl + +Provide a resource to create a VPC ACL instance. + +## Example Usage + +```hcl +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_vpc_acl" "example" { + vpc_id = tencentcloud_vpc.vpc.id + name = "tf-example" + ingress = [ + "ACCEPT#192.168.1.0/24#800#TCP", + "ACCEPT#192.168.1.0/24#800-900#TCP", + ] + egress = [ + "ACCEPT#192.168.1.0/24#800#TCP", + "ACCEPT#192.168.1.0/24#800-900#TCP", + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the network ACL. +* `vpc_id` - (Required, String) ID of the VPC instance. +* `egress` - (Optional, List: [`String`]) Egress rules. A rule must match the following format: [action]#[cidr_ip]#[port]#[protocol]. The available value of 'action' is `ACCEPT` and `DROP`. The 'cidr_ip' must be an IP address network or segment. The 'port' valid format is `80`, `80,443`, `80-90` or `ALL`. The available value of 'protocol' is `TCP`, `UDP`, `ICMP` and `ALL`. When 'protocol' is `ICMP` or `ALL`, the 'port' must be `ALL`. +* `ingress` - (Optional, List: [`String`]) Ingress rules. A rule must match the following format: [action]#[cidr_ip]#[port]#[protocol]. The available value of 'action' is `ACCEPT` and `DROP`. The 'cidr_ip' must be an IP address network or segment. The 'port' valid format is `80`, `80,443`, `80-90` or `ALL`. The available value of 'protocol' is `TCP`, `UDP`, `ICMP` and `ALL`. When 'protocol' is `ICMP` or `ALL`, the 'port' must be `ALL`. +* `tags` - (Optional, Map) Tags of the vpc acl. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time of ACL. + + +## Import + +Vpc ACL can be imported, e.g. + +``` +$ terraform import tencentcloud_vpc_acl.default acl-id +``` + diff --git a/config/docs/r/vpc_acl_attachment.html.markdown b/config/docs/r/vpc_acl_attachment.html.markdown new file mode 100644 index 0000000..7a16903 --- /dev/null +++ b/config/docs/r/vpc_acl_attachment.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_acl_attachment" +sidebar_current: "docs-tencentcloud-resource-vpc_acl_attachment" +description: |- + Provide a resource to attach an existing subnet to Network ACL. +--- + +# tencentcloud_vpc_acl_attachment + +Provide a resource to attach an existing subnet to Network ACL. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name +} + +resource "tencentcloud_vpc_acl" "example" { + vpc_id = tencentcloud_vpc.vpc.id + name = "tf-example" + ingress = [ + "ACCEPT#192.168.1.0/24#800#TCP", + "ACCEPT#192.168.1.0/24#800-900#TCP", + ] + egress = [ + "ACCEPT#192.168.1.0/24#800#TCP", + "ACCEPT#192.168.1.0/24#800-900#TCP", + ] +} + +resource "tencentcloud_vpc_acl_attachment" "attachment" { + acl_id = tencentcloud_vpc_acl.example.id + subnet_id = tencentcloud_subnet.subnet.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `acl_id` - (Required, String, ForceNew) ID of the attached ACL. +* `subnet_id` - (Required, String, ForceNew) The Subnet instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +Acl attachment can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_vpc_acl_attachment.attachment acl-eotx5qsg#subnet-91x0geu6 +``` + diff --git a/config/docs/r/vpc_bandwidth_package.html.markdown b/config/docs/r/vpc_bandwidth_package.html.markdown new file mode 100644 index 0000000..9dc2e5f --- /dev/null +++ b/config/docs/r/vpc_bandwidth_package.html.markdown @@ -0,0 +1,83 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_bandwidth_package" +sidebar_current: "docs-tencentcloud-resource-vpc_bandwidth_package" +description: |- + Provides a resource to create a vpc bandwidth_package +--- + +# tencentcloud_vpc_bandwidth_package + +Provides a resource to create a vpc bandwidth_package + +## Example Usage + +```hcl +resource "tencentcloud_vpc_bandwidth_package" "example" { + network_type = "BGP" + charge_type = "TOP5_POSTPAID_BY_MONTH" + bandwidth_package_name = "tf-example" + tags = { + "createdBy" = "terraform" + } +} +``` + +### PrePaid Bandwidth Package + +```hcl +resource "tencentcloud_vpc_bandwidth_package" "bandwidth_package" { + network_type = "BGP" + charge_type = "FIXED_PREPAID_BY_MONTH" + bandwidth_package_name = "test-001" + time_span = 3 + internet_max_bandwidth = 100 + tags = { + "createdBy" = "terraform" + } +} +``` + +### Bandwidth Package With Egress + +```hcl +resource "tencentcloud_vpc_bandwidth_package" "example" { + network_type = "SINGLEISP_CMCC" + charge_type = "ENHANCED95_POSTPAID_BY_MONTH" + bandwidth_package_name = "tf-example" + internet_max_bandwidth = 400 + egress = "center_egress2" + tags = { + "createdBy" = "terraform" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bandwidth_package_name` - (Optional, String) Bandwidth package name. +* `charge_type` - (Optional, String) Bandwidth package billing type, default: `TOP5_POSTPAID_BY_MONTH`. Optional value: `TOP5_POSTPAID_BY_MONTH`: TOP5 billed by monthly postpaid; `PERCENT95_POSTPAID_BY_MONTH`: 95 billed monthly postpaid; `FIXED_PREPAID_BY_MONTH`: Monthly prepaid billing (Type FIXED_PREPAID_BY_MONTH product API capability is under construction); `BANDWIDTH_POSTPAID_BY_DAY`: bandwidth billed by daily postpaid; `ENHANCED95_POSTPAID_BY_MONTH`: enhanced 95 billed monthly postpaid. +* `egress` - (Optional, String) Network egress. It defaults to `center_egress1`. If you want to try the egress feature, please [submit a ticket](https://console.cloud.tencent.com/workorder/category). +* `internet_max_bandwidth` - (Optional, Int) Bandwidth packet speed limit size. Unit: Mbps, -1 means no speed limit. +* `network_type` - (Optional, String) Bandwidth packet type, default: `BGP`. Optional value: `BGP`: common BGP shared bandwidth package; `HIGH_QUALITY_BGP`: High Quality BGP Shared Bandwidth Package; `SINGLEISP_CMCC`: CMCC shared bandwidth package; `SINGLEISP_CTCC:`: CTCC shared bandwidth package; `SINGLEISP_CUCC`: CUCC shared bandwidth package. +* `tags` - (Optional, Map) Tag description list. +* `time_span` - (Optional, Int, ForceNew) The purchase duration of the prepaid monthly bandwidth package, unit: month, value range: 1~60. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc bandwidth_package can be imported using the id, e.g. +``` +$ terraform import tencentcloud_vpc_bandwidth_package.bandwidth_package bandwidthPackage_id +``` + diff --git a/config/docs/r/vpc_bandwidth_package_attachment.html.markdown b/config/docs/r/vpc_bandwidth_package_attachment.html.markdown new file mode 100644 index 0000000..6273137 --- /dev/null +++ b/config/docs/r/vpc_bandwidth_package_attachment.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_bandwidth_package_attachment" +sidebar_current: "docs-tencentcloud-resource-vpc_bandwidth_package_attachment" +description: |- + Provides a resource to create a vpc bandwidth_package_attachment +--- + +# tencentcloud_vpc_bandwidth_package_attachment + +Provides a resource to create a vpc bandwidth_package_attachment + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name +} + +resource "tencentcloud_vpc_bandwidth_package" "example" { + network_type = "BGP" + charge_type = "TOP5_POSTPAID_BY_MONTH" + bandwidth_package_name = "tf-example" + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_clb_instance" "example" { + network_type = "INTERNAL" + clb_name = "tf-example" + project_id = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + + tags = { + "createdBy" = "terraform" + } +} + +resource "tencentcloud_vpc_bandwidth_package_attachment" "attachment" { + resource_id = tencentcloud_clb_instance.example.id + bandwidth_package_id = tencentcloud_vpc_bandwidth_package.example.id + network_type = "BGP" + resource_type = "LoadBalance" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bandwidth_package_id` - (Required, String, ForceNew) Bandwidth package unique ID, in the form of `bwp-xxxx`. +* `resource_id` - (Required, String, ForceNew) The unique ID of the resource, currently supports EIP resources and LB resources, such as `eip-xxxx`, `lb-xxxx`. +* `network_type` - (Optional, String, ForceNew) Bandwidth packet type, currently supports `BGP` type, indicating that the internal resource is BGP IP. +* `protocol` - (Optional, String, ForceNew) Bandwidth packet protocol type. Currently `ipv4` and `ipv6` protocol types are supported. +* `resource_type` - (Optional, String, ForceNew) Resource types, including `Address`, `LoadBalance`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/vpc_dhcp_ip.html.markdown b/config/docs/r/vpc_dhcp_ip.html.markdown new file mode 100644 index 0000000..dd31648 --- /dev/null +++ b/config/docs/r/vpc_dhcp_ip.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_dhcp_ip" +sidebar_current: "docs-tencentcloud-resource-vpc_dhcp_ip" +description: |- + Provides a resource to create a vpc dhcp_ip +--- + +# tencentcloud_vpc_dhcp_ip + +Provides a resource to create a vpc dhcp_ip + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_vpc_dhcp_ip" "example" { + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + dhcp_ip_name = "tf-example" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `dhcp_ip_name` - (Required, String) `DhcpIp` name. +* `subnet_id` - (Required, String) Subnet `ID`. +* `vpc_id` - (Required, String) The private network `ID`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc dhcp_ip can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_dhcp_ip.dhcp_ip dhcp_ip_id +``` + diff --git a/config/docs/r/vpc_enable_end_point_connect.html.markdown b/config/docs/r/vpc_enable_end_point_connect.html.markdown new file mode 100644 index 0000000..e88e88a --- /dev/null +++ b/config/docs/r/vpc_enable_end_point_connect.html.markdown @@ -0,0 +1,39 @@ +--- +subcategory: "Private Link(PLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_enable_end_point_connect" +sidebar_current: "docs-tencentcloud-resource-vpc_enable_end_point_connect" +description: |- + Provides a resource to create a vpc enable_end_point_connect +--- + +# tencentcloud_vpc_enable_end_point_connect + +Provides a resource to create a vpc enable_end_point_connect + +## Example Usage + +```hcl +resource "tencentcloud_vpc_enable_end_point_connect" "enable_end_point_connect" { + end_point_service_id = "vpcsvc-98jddhcz" + end_point_id = ["vpce-6q0ftmke"] + accept_flag = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `accept_flag` - (Required, Bool, ForceNew) Whether to accept endpoint connection requests. `true`: Accept automatically. `false`: Do not automatically accept. +* `end_point_id` - (Required, Set: [`String`], ForceNew) Endpoint ID. +* `end_point_service_id` - (Required, String, ForceNew) Endpoint service ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/vpc_end_point.html.markdown b/config/docs/r/vpc_end_point.html.markdown new file mode 100644 index 0000000..7fd3bc2 --- /dev/null +++ b/config/docs/r/vpc_end_point.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Private Link(PLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_end_point" +sidebar_current: "docs-tencentcloud-resource-vpc_end_point" +description: |- + Provides a resource to create a vpc end_point +--- + +# tencentcloud_vpc_end_point + +Provides a resource to create a vpc end_point + +## Example Usage + +```hcl +resource "tencentcloud_vpc_end_point" "end_point" { + vpc_id = "vpc-391sv4w3" + subnet_id = "subnet-ljyn7h30" + end_point_name = "terraform-test" + end_point_service_id = "vpcsvc-69y13tdb" + end_point_vip = "10.0.2.1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_point_name` - (Required, String) Name of endpoint. +* `end_point_service_id` - (Required, String) ID of endpoint service. +* `subnet_id` - (Required, String) ID of subnet instance. +* `vpc_id` - (Required, String) ID of vpc instance. +* `end_point_vip` - (Optional, String) VIP of endpoint ip. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create Time. +* `end_point_owner` - APPID. +* `state` - state of end point. + + +## Import + +vpc end_point can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_end_point.end_point end_point_id +``` + diff --git a/config/docs/r/vpc_end_point_service.html.markdown b/config/docs/r/vpc_end_point_service.html.markdown new file mode 100644 index 0000000..2fa3369 --- /dev/null +++ b/config/docs/r/vpc_end_point_service.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "Private Link(PLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_end_point_service" +sidebar_current: "docs-tencentcloud-resource-vpc_end_point_service" +description: |- + Provides a resource to create a vpc end_point_service +--- + +# tencentcloud_vpc_end_point_service + +Provides a resource to create a vpc end_point_service + +## Example Usage + +```hcl +resource "tencentcloud_vpc_end_point_service" "end_point_service" { + vpc_id = "vpc-391sv4w3" + end_point_service_name = "terraform-endpoint-service" + auto_accept_flag = false + service_instance_id = "lb-o5f6x7ke" + service_type = "CLB" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `auto_accept_flag` - (Required, Bool) Whether to automatically accept. +* `end_point_service_name` - (Required, String) Name of end point service. +* `service_instance_id` - (Required, String) Id of service instance, like lb-xxx. +* `vpc_id` - (Required, String) ID of vpc instance. +* `service_type` - (Optional, String) Type of service instance, like `CLB`, `CDB`, `CRS`, default is `CLB`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create Time. +* `end_point_count` - Count of end point. +* `service_owner` - APPID. +* `service_vip` - VIP of backend service. + + +## Import + +vpc end_point_service can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_end_point_service.end_point_service end_point_service_id +``` + diff --git a/config/docs/r/vpc_end_point_service_white_list.html.markdown b/config/docs/r/vpc_end_point_service_white_list.html.markdown new file mode 100644 index 0000000..d16ab15 --- /dev/null +++ b/config/docs/r/vpc_end_point_service_white_list.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Private Link(PLS)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_end_point_service_white_list" +sidebar_current: "docs-tencentcloud-resource-vpc_end_point_service_white_list" +description: |- + Provides a resource to create a vpc end_point_service_white_list +--- + +# tencentcloud_vpc_end_point_service_white_list + +Provides a resource to create a vpc end_point_service_white_list + +## Example Usage + +```hcl +resource "tencentcloud_vpc_end_point_service_white_list" "end_point_service_white_list" { + user_uin = "100020512675" + end_point_service_id = "vpcsvc-69y13tdb" + description = "terraform for test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `end_point_service_id` - (Required, String) ID of endpoint service. +* `user_uin` - (Required, String) UIN. +* `description` - (Optional, String) Description of white list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create Time. +* `owner` - APPID. + + +## Import + +vpc end_point_service_white_list can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_end_point_service_white_list.end_point_service_white_list end_point_service_white_list_id +``` + diff --git a/config/docs/r/vpc_flow_log.html.markdown b/config/docs/r/vpc_flow_log.html.markdown new file mode 100644 index 0000000..bc3bb45 --- /dev/null +++ b/config/docs/r/vpc_flow_log.html.markdown @@ -0,0 +1,152 @@ +--- +subcategory: "Flow Logs(FL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_flow_log" +sidebar_current: "docs-tencentcloud-resource-vpc_flow_log" +description: |- + Provides a resource to create a vpc flow_log +--- + +# tencentcloud_vpc_flow_log + +Provides a resource to create a vpc flow_log + +~> **NOTE:** The cloud server instance specifications that support stream log collection include: M6ce, M6p, SA3se, S4m, DA3, ITA3, I6t, I6, S5se, SA2, SK1, S4, S5, SN3ne, S3ne, S2ne, SA2a, S3ne, SW3a, SW3b, SW3ne, ITA3, IT5c, IT5, IT5c, IT3, I3, D3, DA2, D2, M6, MA2, M4, C6, IT3a, IT3b, IT3c, C4ne, CN3ne, C3ne, GI1, PNV4, GNV4v, GNV4, GT4, GI3X, GN7, GN7vw. + +~> **NOTE:** The following models no longer support the collection of new stream logs, and the stock stream logs will no longer be reported for data from July 25, 2022: Standard models: S3, SA1, S2, S1;Memory type: M3, M2, M1;Calculation type: C4, CN3, C3, C2;Batch calculation type: BC1, BS1;HPCC: HCCIC5, HCCG5v. + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + image_name_regex = "Final" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_cls_logset" "logset" { + logset_name = "delogsetmo" + tags = { + "test" = "test" + } +} + +resource "tencentcloud_cls_topic" "topic" { + topic_name = "topic" + logset_id = tencentcloud_cls_logset.logset.id + auto_split = false + max_split_partitions = 20 + partition_count = 1 + period = 10 + storage_type = "hot" + tags = { + "test" = "test", + } +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-flow-log-vpc" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + name = "vpc-flow-log-subnet" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_eni" "example" { + name = "vpc-flow-log-eni" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + description = "eni desc" + ipv4_count = 1 +} + +resource "tencentcloud_instance" "example" { + instance_name = "ci-test-eni-attach" + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + image_id = data.tencentcloud_images.image.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + disable_security_service = true + disable_monitor_service = true + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_eni_attachment" "example" { + eni_id = tencentcloud_eni.example.id + instance_id = tencentcloud_instance.example.id +} + +resource "tencentcloud_vpc_flow_log" "example" { + flow_log_name = "tf-example-vpc-flow-log" + resource_type = "NETWORKINTERFACE" + resource_id = tencentcloud_eni_attachment.example.eni_id + traffic_type = "ACCEPT" + vpc_id = tencentcloud_vpc.vpc.id + flow_log_description = "this is a testing flow log" + cloud_log_id = tencentcloud_cls_topic.topic.id + storage_type = "cls" + tags = { + "testKey" = "testValue" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `flow_log_name` - (Required, String) Specify flow log name. +* `resource_id` - (Required, String) Specify resource unique Id of `resource_type` configured. +* `resource_type` - (Required, String) Specify resource type. NOTE: Only support `NETWORKINTERFACE` for now. Values: `VPC`, `SUBNET`, `NETWORKINTERFACE`, `CCN`, `NAT`, `DCG`. +* `traffic_type` - (Required, String) Specify log traffic type, values: `ACCEPT`, `REJECT`, `ALL`. +* `cloud_log_id` - (Optional, String) Specify flow log storage id, just set cls topic id. +* `cloud_log_region` - (Optional, String) Specify flow log storage region, default using current. +* `flow_log_description` - (Optional, String) Specify flow Log description. +* `flow_log_storage` - (Optional, List) Specify consumer detail, required while `storage_type` is `ckafka`. +* `storage_type` - (Optional, String) Specify consumer type, values: `cls`, `ckafka`. +* `tags` - (Optional, Map) Tag description list. +* `vpc_id` - (Optional, String) Specify vpc Id, ignore while `resource_type` is `CCN` (unsupported) but required while other types. + +The `flow_log_storage` object supports the following: + +* `storage_id` - (Optional, String) Specify storage instance id, required while `storage_type` is `ckafka`. +* `storage_topic` - (Optional, String) Specify storage topic id, required while `storage_type` is `ckafka`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc flow_log can be imported using the flow log Id combine vpc Id, e.g. + +``` +$ terraform import tencentcloud_vpc_flow_log.flow_log flow_log_id fl-xxxx1234#vpc-yyyy5678 +``` + diff --git a/config/docs/r/vpc_flow_log_config.html.markdown b/config/docs/r/vpc_flow_log_config.html.markdown new file mode 100644 index 0000000..90c4b31 --- /dev/null +++ b/config/docs/r/vpc_flow_log_config.html.markdown @@ -0,0 +1,150 @@ +--- +subcategory: "Flow Logs(FL)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_flow_log_config" +sidebar_current: "docs-tencentcloud-resource-vpc_flow_log_config" +description: |- + Provides a resource to create a vpc flow_log_config +--- + +# tencentcloud_vpc_flow_log_config + +Provides a resource to create a vpc flow_log_config + +## Example Usage + +### If disable FlowLogs + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + image_name_regex = "Final" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_cls_logset" "logset" { + logset_name = "delogsetmo" + tags = { + "test" = "test" + } +} + +resource "tencentcloud_cls_topic" "topic" { + topic_name = "topic" + logset_id = tencentcloud_cls_logset.logset.id + auto_split = false + max_split_partitions = 20 + partition_count = 1 + period = 10 + storage_type = "hot" + tags = { + "test" = "test", + } +} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-flow-log-vpc" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + name = "vpc-flow-log-subnet" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_eni" "example" { + name = "vpc-flow-log-eni" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + description = "eni desc" + ipv4_count = 1 +} + +resource "tencentcloud_instance" "example" { + instance_name = "ci-test-eni-attach" + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + image_id = data.tencentcloud_images.image.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + disable_security_service = true + disable_monitor_service = true + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_eni_attachment" "example" { + eni_id = tencentcloud_eni.example.id + instance_id = tencentcloud_instance.example.id +} + +resource "tencentcloud_vpc_flow_log" "example" { + flow_log_name = "tf-example-vpc-flow-log" + resource_type = "NETWORKINTERFACE" + resource_id = tencentcloud_eni_attachment.example.eni_id + traffic_type = "ACCEPT" + vpc_id = tencentcloud_vpc.vpc.id + flow_log_description = "this is a testing flow log" + cloud_log_id = tencentcloud_cls_topic.topic.id + storage_type = "cls" + tags = { + "testKey" = "testValue" + } +} + +resource "tencentcloud_vpc_flow_log_config" "config" { + flow_log_id = tencentcloud_vpc_flow_log.example.id + enable = false +} +``` + +### If enable FlowLogs + +```hcl +resource "tencentcloud_vpc_flow_log_config" "config" { + flow_log_id = tencentcloud_vpc_flow_log.example.id + enable = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `enable` - (Required, Bool) If enable snapshot policy. +* `flow_log_id` - (Required, String) Flow log ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc flow_log_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_flow_log_config.flow_log_config flow_log_id +``` + diff --git a/config/docs/r/vpc_ipv6_cidr_block.html.markdown b/config/docs/r/vpc_ipv6_cidr_block.html.markdown new file mode 100644 index 0000000..0f5d500 --- /dev/null +++ b/config/docs/r/vpc_ipv6_cidr_block.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_ipv6_cidr_block" +sidebar_current: "docs-tencentcloud-resource-vpc_ipv6_cidr_block" +description: |- + Provides a resource to create a vpc ipv6_cidr_block +--- + +# tencentcloud_vpc_ipv6_cidr_block + +Provides a resource to create a vpc ipv6_cidr_block + +## Example Usage + +```hcl +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_vpc_ipv6_cidr_block" "example" { + vpc_id = tencentcloud_vpc.vpc.id +} +``` + +## Argument Reference + +The following arguments are supported: + +* `vpc_id` - (Required, String, ForceNew) `VPC` instance `ID`, in the form of `vpc-f49l6u0z`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `ipv6_cidr_block` - ipv6 cidr block. + + +## Import + +vpc ipv6_cidr_block can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_ipv6_cidr_block.ipv6_cidr_block vpc_id +``` + diff --git a/config/docs/r/vpc_ipv6_eni_address.html.markdown b/config/docs/r/vpc_ipv6_eni_address.html.markdown new file mode 100644 index 0000000..7c0584f --- /dev/null +++ b/config/docs/r/vpc_ipv6_eni_address.html.markdown @@ -0,0 +1,78 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_ipv6_eni_address" +sidebar_current: "docs-tencentcloud-resource-vpc_ipv6_eni_address" +description: |- + Provides a resource to create a vpc ipv6_eni_address +--- + +# tencentcloud_vpc_ipv6_eni_address + +Provides a resource to create a vpc ipv6_eni_address + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_eni" "eni" { + name = "eni-example" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + description = "eni desc." + ipv4_count = 1 +} + +resource "tencentcloud_vpc_ipv6_cidr_block" "example" { + vpc_id = tencentcloud_vpc.vpc.id +} + +resource "tencentcloud_vpc_ipv6_eni_address" "ipv6_eni_address" { + vpc_id = tencentcloud_vpc.vpc.id + network_interface_id = tencentcloud_eni.eni.id + ipv6_addresses { + address = tencentcloud_vpc_ipv6_cidr_block.example.ipv6_cidr_block + description = "desc." + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `network_interface_id` - (Required, String) ENI instance `ID`, in the form of `eni-m6dyj72l`. +* `vpc_id` - (Required, String) VPC `ID`, in the form of `vpc-m6dyj72l`. +* `ipv6_addresses` - (Optional, List) The specified `IPv6` address list, up to 10 can be specified at a time. Combined with the input parameter `Ipv6AddressCount` to calculate the quota. Mandatory one with Ipv6AddressCount. + +The `ipv6_addresses` object supports the following: + +* `address` - (Required, String) `IPv6` address, in the form of: `3402:4e00:20:100:0:8cd9:2a67:71f3`. +* `address_id` - (Optional, String) `EIP` instance `ID`, such as:`eip-hxlqja90`. +* `description` - (Optional, String) Description. +* `is_wan_ip_blocked` - (Optional, Bool) Whether the public network IP is blocked. +* `primary` - (Optional, Bool) Whether to master `IP`. +* `state` - (Optional, String) `IPv6` address status: `PENDING`: pending, `MIGRATING`: migrating, `DELETING`: deleting, `AVAILABLE`: available. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/vpc_ipv6_subnet_cidr_block.html.markdown b/config/docs/r/vpc_ipv6_subnet_cidr_block.html.markdown new file mode 100644 index 0000000..5421fde --- /dev/null +++ b/config/docs/r/vpc_ipv6_subnet_cidr_block.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_ipv6_subnet_cidr_block" +sidebar_current: "docs-tencentcloud-resource-vpc_ipv6_subnet_cidr_block" +description: |- + Provides a resource to create a vpc ipv6_subnet_cidr_block +--- + +# tencentcloud_vpc_ipv6_subnet_cidr_block + +Provides a resource to create a vpc ipv6_subnet_cidr_block + +## Example Usage + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + name = "subnet-example" + vpc_id = tencentcloud_vpc.vpc.id + cidr_block = "10.0.0.0/16" + is_multicast = false +} + +resource "tencentcloud_vpc_ipv6_cidr_block" "example" { + vpc_id = tencentcloud_vpc.vpc.id +} + +resource "tencentcloud_vpc_ipv6_subnet_cidr_block" "example" { + vpc_id = tencentcloud_vpc.vpc.id + ipv6_subnet_cidr_blocks { + subnet_id = tencentcloud_subnet.subnet.id + ipv6_cidr_block = tencentcloud_vpc_ipv6_cidr_block.example.ipv6_cidr_block + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ipv6_subnet_cidr_blocks` - (Required, List, ForceNew) Allocate a list of `IPv6` subnets. +* `vpc_id` - (Required, String, ForceNew) The private network `ID` where the subnet is located. Such as:`vpc-f49l6u0z`. + +The `ipv6_subnet_cidr_blocks` object supports the following: + +* `ipv6_cidr_block` - (Required, String) `IPv6` subnet segment. Such as: `3402:4e00:20:1001::/64`. +* `subnet_id` - (Required, String) Subnet instance `ID`. Such as:`subnet-pxir56ns`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc ipv6_subnet_cidr_block can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_ipv6_subnet_cidr_block.ipv6_subnet_cidr_block ipv6_subnet_cidr_block_id +``` + diff --git a/config/docs/r/vpc_local_gateway.html.markdown b/config/docs/r/vpc_local_gateway.html.markdown new file mode 100644 index 0000000..e89972a --- /dev/null +++ b/config/docs/r/vpc_local_gateway.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_local_gateway" +sidebar_current: "docs-tencentcloud-resource-vpc_local_gateway" +description: |- + Provides a resource to create a vpc local_gateway +--- + +# tencentcloud_vpc_local_gateway + +Provides a resource to create a vpc local_gateway + +## Example Usage + +```hcl +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_vpc_local_gateway" "example" { + local_gateway_name = "tf-example" + vpc_id = tencentcloud_vpc.vpc.id + cdc_id = "cluster-j9gyu1iy" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cdc_id` - (Required, String) CDC instance ID. +* `local_gateway_name` - (Required, String) Local gateway name. +* `vpc_id` - (Required, String) VPC instance ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc local_gateway can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_local_gateway.local_gateway local_gateway_id +``` + diff --git a/config/docs/r/vpc_net_detect.html.markdown b/config/docs/r/vpc_net_detect.html.markdown new file mode 100644 index 0000000..14e2419 --- /dev/null +++ b/config/docs/r/vpc_net_detect.html.markdown @@ -0,0 +1,248 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_net_detect" +sidebar_current: "docs-tencentcloud-resource-vpc_net_detect" +description: |- + Provides a resource to create a vpc net_detect +--- + +# tencentcloud_vpc_net_detect + +Provides a resource to create a vpc net_detect + +## Example Usage + +### Create a basic Net Detect + +```hcl +data "tencentcloud_availability_zones" "zones" {} + +resource "tencentcloud_vpc" "vpc" { + name = "vpc-example" + cidr_block = "10.0.0.0/16" +} + +resource "tencentcloud_subnet" "subnet" { + vpc_id = tencentcloud_vpc.vpc.id + name = "subnet-example" + cidr_block = "10.0.0.0/16" + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name +} + +resource "tencentcloud_vpc_net_detect" "example" { + net_detect_name = "tf-example" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + detect_destination_ip = [ + "10.0.0.1", + "10.0.0.2", + ] +} +``` + + + +```hcl +resource "tencentcloud_vpn_gateway" "vpn" { + name = "tf-example" + bandwidth = 100 + zone = data.tencentcloud_availability_zones.zones.zones.0.name + type = "SSL" + vpc_id = tencentcloud_vpc.vpc.id + + tags = { + test = "test" + } +} + +resource "tencentcloud_vpc_net_detect" "example" { + net_detect_name = "tf-example" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + next_hop_type = "VPN" + next_hop_destination = tencentcloud_vpn_gateway.vpn.id + detect_destination_ip = [ + "192.16.10.10", + "172.16.10.22", + ] +} +``` + + + +```hcl +resource "tencentcloud_dc_gateway" "example" { + name = "ci-cdg-vpc-test" + network_instance_id = tencentcloud_vpc.vpc.id + network_type = "VPC" + gateway_type = "NAT" +} + +resource "tencentcloud_vpc_net_detect" "example" { + net_detect_name = "tf-example" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + next_hop_type = "DIRECTCONNECT" + next_hop_destination = tencentcloud_dc_gateway.example.id + detect_destination_ip = [ + "192.16.10.10", + "172.16.10.22", + ] +} +``` + + + +```hcl +resource "tencentcloud_eip" "eip_example1" { + name = "tf_nat_gateway_eip1" +} + +resource "tencentcloud_eip" "eip_example2" { + name = "tf_nat_gateway_eip2" +} + +resource "tencentcloud_nat_gateway" "example" { + name = "tf_example_nat_gateway" + vpc_id = tencentcloud_vpc.vpc.id + bandwidth = 100 + max_concurrent = 1000000 + assigned_eip_set = [ + tencentcloud_eip.eip_example1.public_ip, + tencentcloud_eip.eip_example2.public_ip, + ] + tags = { + tf_tag_key = "tf_tag_value" + } +} + +resource "tencentcloud_vpc_net_detect" "example" { + net_detect_name = "tf-example" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + next_hop_type = "NAT" + next_hop_destination = tencentcloud_nat_gateway.example.id + detect_destination_ip = [ + "192.16.10.10", + "172.16.10.22", + ] +} +``` + + + +```hcl +data "tencentcloud_images" "image" { + image_type = ["PUBLIC_IMAGE"] + os_name = "TencentOS Server 3.2 (Final)" +} + +data "tencentcloud_instance_types" "instance_types" { + filter { + name = "zone" + values = [data.tencentcloud_availability_zones.zones.zones.0.name] + } + + filter { + name = "instance-family" + values = ["S5"] + } + + cpu_core_count = 2 + exclude_sold_out = true +} + +resource "tencentcloud_instance" "example" { + instance_name = "tf_example" + availability_zone = data.tencentcloud_availability_zones.zones.zones.0.name + image_id = data.tencentcloud_images.image.images.0.image_id + instance_type = data.tencentcloud_instance_types.instance_types.instance_types.0.instance_type + system_disk_type = "CLOUD_PREMIUM" + system_disk_size = 50 + hostname = "user" + project_id = 0 + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id +} + +resource "tencentcloud_vpc_net_detect" "example" { + net_detect_name = "tf-example" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + next_hop_type = "NORMAL_CVM" + next_hop_destination = tencentcloud_instance.example.private_ip + detect_destination_ip = [ + "192.16.10.10", + "172.16.10.22", + ] +} +``` + + + +```hcl +resource "tencentcloud_ccn" "example" { + name = "tf-example" + description = "desc." + qos = "AU" + charge_type = "POSTPAID" + bandwidth_limit_type = "OUTER_REGION_LIMIT" +} + +resource "tencentcloud_vpc_net_detect" "example" { + net_detect_name = "tf-example" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + next_hop_type = "CCN" + next_hop_destination = tencentcloud_ccn.example.id + detect_destination_ip = [ + "172.10.0.1", + "172.10.0.2", + ] +} +``` + + + +```hcl +resource "tencentcloud_vpc_net_detect" "example" { + net_detect_name = "tf-example" + vpc_id = tencentcloud_vpc.vpc.id + subnet_id = tencentcloud_subnet.subnet.id + next_hop_type = "NONEXTHOP" + detect_destination_ip = [ + "10.0.0.1", + "10.0.0.2", + ] +} +``` + +## Argument Reference + +The following arguments are supported: + +* `detect_destination_ip` - (Required, Set: [`String`]) An array of probe destination IPv4 addresses. Up to two. +* `net_detect_name` - (Required, String) Network probe name, the maximum length cannot exceed 60 bytes. +* `subnet_id` - (Required, String, ForceNew) Subnet instance ID. Such as:subnet-12345678. +* `vpc_id` - (Required, String, ForceNew) `VPC` instance `ID`. Such as:`vpc-12345678`. +* `net_detect_description` - (Optional, String) Network probe description. +* `next_hop_destination` - (Optional, String) The destination gateway of the next hop, the value is related to the next hop type. If the next hop type is VPN, and the value is the VPN gateway ID, such as: vpngw-12345678; If the next hop type is DIRECTCONNECT, and the value is the private line gateway ID, such as: dcg-12345678; If the next hop type is PEERCONNECTION, which takes the value of the peer connection ID, such as: pcx-12345678; If the next hop type is NAT, and the value is Nat gateway, such as: nat-12345678; If the next hop type is NORMAL_CVM, which takes the IPv4 address of the cloud server, such as: 10.0.0.12; If the next hop type is CCN, and the value is the cloud network ID, such as: ccn-12345678; If the next hop type is NONEXTHOP, and the specified network probe is a network probe without a next hop. +* `next_hop_type` - (Optional, String) The next hop type, currently we support the following types: `VPN`: VPN gateway; `DIRECTCONNECT`: private line gateway; `PEERCONNECTION`: peer connection; `NAT`: NAT gateway; `NORMAL_CVM`: normal cloud server; `CCN`: cloud networking gateway; `NONEXTHOP`: no next hop. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc net_detect can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_net_detect.net_detect net_detect_id +``` + diff --git a/config/docs/r/vpc_resume_snapshot_instance.html.markdown b/config/docs/r/vpc_resume_snapshot_instance.html.markdown new file mode 100644 index 0000000..260df10 --- /dev/null +++ b/config/docs/r/vpc_resume_snapshot_instance.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_resume_snapshot_instance" +sidebar_current: "docs-tencentcloud-resource-vpc_resume_snapshot_instance" +description: |- + Provides a resource to create a vpc resume_snapshot_instance +--- + +# tencentcloud_vpc_resume_snapshot_instance + +Provides a resource to create a vpc resume_snapshot_instance + +## Example Usage + +### Basic example + +```hcl +resource "tencentcloud_vpc_resume_snapshot_instance" "resume_snapshot_instance" { + snapshot_policy_id = "sspolicy-1t6cobbv" + snapshot_file_id = "ssfile-emtabuwu2z" + instance_id = "ntrgm89v" +} +``` + +### Complete example + +```hcl +data "tencentcloud_vpc_snapshot_files" "example" { + business_type = "securitygroup" + instance_id = "sg-902tl7t7" + start_date = "2022-10-10 00:00:00" + end_date = "2023-10-30 00:00:00" +} + +resource "tencentcloud_cos_bucket" "example" { + bucket = "tf-example-1308919341" + acl = "private" +} + +resource "tencentcloud_vpc_snapshot_policy" "example" { + snapshot_policy_name = "tf-example" + backup_type = "time" + cos_bucket = tencentcloud_cos_bucket.example.bucket + cos_region = "ap-guangzhou" + create_new_cos = false + keep_time = 2 + + backup_policies { + backup_day = "monday" + backup_time = "00:00:00" + } + backup_policies { + backup_day = "tuesday" + backup_time = "01:00:00" + } + backup_policies { + backup_day = "wednesday" + backup_time = "02:00:00" + } +} + +resource "tencentcloud_vpc_resume_snapshot_instance" "example" { + snapshot_policy_id = tencentcloud_vpc_snapshot_policy.example.id + snapshot_file_id = data.tencentcloud_vpc_snapshot_files.example.snapshot_file_set.0.snapshot_file_id + instance_id = "policy-1t6cob" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instance_id` - (Required, String, ForceNew) InstanceId. +* `snapshot_file_id` - (Required, String, ForceNew) Snapshot file Id. +* `snapshot_policy_id` - (Required, String, ForceNew) Snapshot policy Id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/vpc_snapshot_policy.html.markdown b/config/docs/r/vpc_snapshot_policy.html.markdown new file mode 100644 index 0000000..1a91f36 --- /dev/null +++ b/config/docs/r/vpc_snapshot_policy.html.markdown @@ -0,0 +1,79 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_snapshot_policy" +sidebar_current: "docs-tencentcloud-resource-vpc_snapshot_policy" +description: |- + Provides a resource to create a vpc snapshot_policy +--- + +# tencentcloud_vpc_snapshot_policy + +Provides a resource to create a vpc snapshot_policy + +## Example Usage + +```hcl +resource "tencentcloud_cos_bucket" "example" { + bucket = "tf-example-1308919341" + acl = "private" +} + +resource "tencentcloud_vpc_snapshot_policy" "example" { + snapshot_policy_name = "tf-example" + backup_type = "time" + cos_bucket = tencentcloud_cos_bucket.example.bucket + cos_region = "ap-guangzhou" + create_new_cos = false + keep_time = 2 + + backup_policies { + backup_day = "monday" + backup_time = "00:00:00" + } + backup_policies { + backup_day = "tuesday" + backup_time = "01:00:00" + } + backup_policies { + backup_day = "wednesday" + backup_time = "02:00:00" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backup_type` - (Required, String) Backup strategy type, `operate`: operate backup, `time`: schedule backup. +* `cos_bucket` - (Required, String) cos bucket. +* `cos_region` - (Required, String) The region where the cos bucket is located. +* `create_new_cos` - (Required, Bool) Whether to create a new cos bucket, the default is False.Note: This field may return null, indicating that no valid value can be obtained. +* `keep_time` - (Required, Int) The retention time supports 1 to 365 days. +* `snapshot_policy_name` - (Required, String) Snapshot policy name. +* `backup_policies` - (Optional, List) Time backup strategy. Note: This field may return null, indicating that no valid value can be obtained. + +The `backup_policies` object supports the following: + +* `backup_day` - (Required, String) Backup cycle time, the value can be monday, tuesday, wednesday, thursday, friday, saturday, sunday. +* `backup_time` - (Required, String) Backup time point, format:HH:mm:ss. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Creation time.Note: This field may return null, indicating that no valid value can be obtained. +* `enable` - Enabled state, True-enabled, False-disabled, the default is True. +* `snapshot_policy_id` - Snapshot policy Id. + + +## Import + +vpc snapshot_policy can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_snapshot_policy.snapshot_policy snapshot_policy_id +``` + diff --git a/config/docs/r/vpc_snapshot_policy_attachment.html.markdown b/config/docs/r/vpc_snapshot_policy_attachment.html.markdown new file mode 100644 index 0000000..8f3fd86 --- /dev/null +++ b/config/docs/r/vpc_snapshot_policy_attachment.html.markdown @@ -0,0 +1,90 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_snapshot_policy_attachment" +sidebar_current: "docs-tencentcloud-resource-vpc_snapshot_policy_attachment" +description: |- + Provides a resource to create a vpc snapshot_policy_attachment +--- + +# tencentcloud_vpc_snapshot_policy_attachment + +Provides a resource to create a vpc snapshot_policy_attachment + +## Example Usage + +```hcl +resource "tencentcloud_cos_bucket" "example" { + bucket = "tf-example-1308919341" + acl = "private" +} + +resource "tencentcloud_vpc_snapshot_policy" "example" { + snapshot_policy_name = "tf-example" + backup_type = "time" + cos_bucket = tencentcloud_cos_bucket.example.bucket + cos_region = "ap-guangzhou" + create_new_cos = false + keep_time = 2 + + backup_policies { + backup_day = "monday" + backup_time = "00:00:00" + } + backup_policies { + backup_day = "tuesday" + backup_time = "01:00:00" + } + backup_policies { + backup_day = "wednesday" + backup_time = "02:00:00" + } +} + +resource "tencentcloud_security_group" "example" { + name = "tf-example" + description = "desc." +} + +resource "tencentcloud_vpc_snapshot_policy_attachment" "attachment" { + snapshot_policy_id = tencentcloud_vpc_snapshot_policy.example.id + + instances { + instance_type = "securitygroup" + instance_id = tencentcloud_security_group.example.id + instance_name = "tf-example" + instance_region = "ap-guangzhou" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `instances` - (Required, Set, ForceNew) Associated instance information. +* `snapshot_policy_id` - (Required, String, ForceNew) Snapshot policy Id. + +The `instances` object supports the following: + +* `instance_id` - (Required, String, ForceNew) InstanceId. +* `instance_region` - (Required, String, ForceNew) The region where the instance is located. +* `instance_type` - (Required, String, ForceNew) Instance type, currently supports set: `securitygroup`. +* `instance_name` - (Optional, String, ForceNew) Instance name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc snapshot_policy_attachment can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_snapshot_policy_attachment.snapshot_policy_attachment snapshot_policy_attachment_id +``` + diff --git a/config/docs/r/vpc_snapshot_policy_config.html.markdown b/config/docs/r/vpc_snapshot_policy_config.html.markdown new file mode 100644 index 0000000..cb8be09 --- /dev/null +++ b/config/docs/r/vpc_snapshot_policy_config.html.markdown @@ -0,0 +1,72 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_snapshot_policy_config" +sidebar_current: "docs-tencentcloud-resource-vpc_snapshot_policy_config" +description: |- + Provides a resource to create a vpc snapshot_policy_config +--- + +# tencentcloud_vpc_snapshot_policy_config + +Provides a resource to create a vpc snapshot_policy_config + +## Example Usage + +```hcl +resource "tencentcloud_cos_bucket" "example" { + bucket = "tf-example-1308919341" + acl = "private" +} + +resource "tencentcloud_vpc_snapshot_policy" "example" { + snapshot_policy_name = "tf-example" + backup_type = "time" + cos_bucket = tencentcloud_cos_bucket.example.bucket + cos_region = "ap-guangzhou" + create_new_cos = false + keep_time = 2 + + backup_policies { + backup_day = "monday" + backup_time = "00:00:00" + } + backup_policies { + backup_day = "tuesday" + backup_time = "01:00:00" + } + backup_policies { + backup_day = "wednesday" + backup_time = "02:00:00" + } +} + +resource "tencentcloud_vpc_snapshot_policy_config" "config" { + snapshot_policy_id = tencentcloud_vpc_snapshot_policy.example.id + enable = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `enable` - (Required, Bool) If enable snapshot policy. +* `snapshot_policy_id` - (Required, String) Snapshot policy Id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc snapshot_policy_config can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_snapshot_policy_config.snapshot_policy_config snapshot_policy_id +``` + diff --git a/config/docs/r/vpc_traffic_package.html.markdown b/config/docs/r/vpc_traffic_package.html.markdown new file mode 100644 index 0000000..f003b78 --- /dev/null +++ b/config/docs/r/vpc_traffic_package.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Virtual Private Cloud(VPC)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpc_traffic_package" +sidebar_current: "docs-tencentcloud-resource-vpc_traffic_package" +description: |- + Provides a resource to create a vpc traffic_package +--- + +# tencentcloud_vpc_traffic_package + +Provides a resource to create a vpc traffic_package + +## Example Usage + +```hcl +resource "tencentcloud_vpc_traffic_package" "example" { + traffic_amount = 10 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `traffic_amount` - (Required, Int, ForceNew) Traffic Package Amount, eg: 10,20,50,512,1024,5120,51200,60,300,600,3072,6144,30720,61440,307200. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `created_time` - Created time. +* `remaining_amount` - Remaining amount. +* `used_amount` - Used amount. + + +## Import + +vpc traffic_package can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpc_traffic_package.traffic_package traffic_package_id +``` + diff --git a/config/docs/r/vpn_connection.html.markdown b/config/docs/r/vpn_connection.html.markdown new file mode 100644 index 0000000..11e17dd --- /dev/null +++ b/config/docs/r/vpn_connection.html.markdown @@ -0,0 +1,109 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_connection" +sidebar_current: "docs-tencentcloud-resource-vpn_connection" +description: |- + Provides a resource to create a VPN connection. +--- + +# tencentcloud_vpn_connection + +Provides a resource to create a VPN connection. + +## Example Usage + +```hcl +resource "tencentcloud_vpn_connection" "foo" { + name = "vpn_connection_test" + vpc_id = "vpc-dk8zmwuf" + vpn_gateway_id = "vpngw-8ccsnclt" + customer_gateway_id = "cgw-xfqag" + pre_share_key = "testt" + ike_proto_encry_algorithm = "3DES-CBC" + ike_proto_authen_algorithm = "SHA" + ike_local_identity = "ADDRESS" + ike_exchange_mode = "AGGRESSIVE" + ike_local_address = "1.1.1.1" + ike_remote_identity = "ADDRESS" + ike_remote_address = "2.2.2.2" + ike_dh_group_name = "GROUP2" + ike_sa_lifetime_seconds = 86401 + ipsec_encrypt_algorithm = "3DES-CBC" + ipsec_integrity_algorithm = "SHA1" + ipsec_sa_lifetime_seconds = 7200 + ipsec_pfs_dh_group = "NULL" + ipsec_sa_lifetime_traffic = 2570 + + security_group_policy { + local_cidr_block = "172.16.0.0/16" + remote_cidr_block = ["2.2.2.0/26", ] + } + tags = { + test = "testt" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `customer_gateway_id` - (Required, String, ForceNew) ID of the customer gateway. +* `name` - (Required, String) Name of the VPN connection. The length of character is limited to 1-60. +* `pre_share_key` - (Required, String) Pre-shared key of the VPN connection. +* `security_group_policy` - (Required, Set) Security group policy of the VPN connection. +* `vpn_gateway_id` - (Required, String, ForceNew) ID of the VPN gateway. +* `dpd_action` - (Optional, String) The action after DPD timeout. Valid values: clear (disconnect) and restart (try again). It is valid when DpdEnable is 1. +* `dpd_enable` - (Optional, Int) Specifies whether to enable DPD. Valid values: 0 (disable) and 1 (enable). +* `dpd_timeout` - (Optional, Int) DPD timeout period.Valid value ranges: [30~60], Default: 30; unit: second. If the request is not responded within this period, the peer end is considered not exists. This parameter is valid when the value of DpdEnable is 1. +* `enable_health_check` - (Optional, Bool) Whether intra-tunnel health checks are supported. +* `health_check_local_ip` - (Optional, String) Health check the address of this terminal. +* `health_check_remote_ip` - (Optional, String) Health check peer address. +* `ike_dh_group_name` - (Optional, String) DH group name of the IKE operation specification. Valid values: `GROUP1`, `GROUP2`, `GROUP5`, `GROUP14`, `GROUP24`. Default value is `GROUP1`. +* `ike_exchange_mode` - (Optional, String) Exchange mode of the IKE operation specification. Valid values: `AGGRESSIVE`, `MAIN`. Default value is `MAIN`. +* `ike_local_address` - (Optional, String) Local address of IKE operation specification, valid when ike_local_identity is `ADDRESS`, generally the value is `public_ip_address` of the related VPN gateway. +* `ike_local_fqdn_name` - (Optional, String) Local FQDN name of the IKE operation specification. +* `ike_local_identity` - (Optional, String) Local identity way of IKE operation specification. Valid values: `ADDRESS`, `FQDN`. Default value is `ADDRESS`. +* `ike_proto_authen_algorithm` - (Optional, String) Proto authenticate algorithm of the IKE operation specification. Valid values: `MD5`, `SHA`, `SHA-256`. Default Value is `MD5`. +* `ike_proto_encry_algorithm` - (Optional, String) Proto encrypt algorithm of the IKE operation specification. Valid values: `3DES-CBC`, `AES-CBC-128`, `AES-CBC-192`, `AES-CBC-256`, `DES-CBC`, `SM4`, `AES128GCM128`, `AES192GCM128`, `AES256GCM128`,`AES128GCM128`, `AES192GCM128`, `AES256GCM128`. Default value is `3DES-CBC`. +* `ike_remote_address` - (Optional, String) Remote address of IKE operation specification, valid when ike_remote_identity is `ADDRESS`, generally the value is `public_ip_address` of the related customer gateway. +* `ike_remote_fqdn_name` - (Optional, String) Remote FQDN name of the IKE operation specification. +* `ike_remote_identity` - (Optional, String) Remote identity way of IKE operation specification. Valid values: `ADDRESS`, `FQDN`. Default value is `ADDRESS`. +* `ike_sa_lifetime_seconds` - (Optional, Int) SA lifetime of the IKE operation specification, unit is `second`. The value ranges from 60 to 604800. Default value is 86400 seconds. +* `ike_version` - (Optional, String) Version of the IKE operation specification, values: `IKEV1`, `IKEV2`. Default value is `IKEV1`. +* `ipsec_encrypt_algorithm` - (Optional, String) Encrypt algorithm of the IPSEC operation specification. Valid values: `3DES-CBC`, `AES-CBC-128`, `AES-CBC-192`, `AES-CBC-256`, `DES-CBC`, `SM4`, `NULL`, `AES128GCM128`, `AES192GCM128`, `AES256GCM128`. Default value is `3DES-CBC`. +* `ipsec_integrity_algorithm` - (Optional, String) Integrity algorithm of the IPSEC operation specification. Valid values: `SHA1`, `MD5`, `SHA-256`. Default value is `MD5`. +* `ipsec_pfs_dh_group` - (Optional, String) PFS DH group. Valid value: `GROUP1`, `GROUP2`, `GROUP5`, `GROUP14`, `GROUP24`, `NULL`. Default value is `NULL`. +* `ipsec_sa_lifetime_seconds` - (Optional, Int) SA lifetime of the IPSEC operation specification, unit is second. Valid value ranges: [180~604800]. Default value is 3600 seconds. +* `ipsec_sa_lifetime_traffic` - (Optional, Int) SA lifetime of the IPSEC operation specification, unit is KB. The value should not be less then 2560. Default value is 1843200. +* `tags` - (Optional, Map) A list of tags used to associate different resources. +* `vpc_id` - (Optional, String, ForceNew) ID of the VPC. Required if vpn gateway is not in `CCN` type, and doesn't make sense for `CCN` vpn gateway. + +The `security_group_policy` object supports the following: + +* `local_cidr_block` - (Required, String) Local cidr block. +* `remote_cidr_block` - (Required, Set) Remote cidr block list. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the VPN connection. +* `encrypt_proto` - Encrypt proto of the VPN connection. +* `is_ccn_type` - Indicate whether is ccn type. Modification of this field only impacts force new logic of `vpc_id`. If `is_ccn_type` is true, modification of `vpc_id` will be ignored. +* `net_status` - Net status of the VPN connection. Valid value: `AVAILABLE`. +* `route_type` - Route type of the VPN connection. +* `state` - State of the connection. Valid value: `PENDING`, `AVAILABLE`, `DELETING`. +* `vpn_proto` - Vpn proto of the VPN connection. + + +## Import + +VPN connection can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_vpn_connection.foo vpnx-nadifg3s +``` + diff --git a/config/docs/r/vpn_connection_reset.html.markdown b/config/docs/r/vpn_connection_reset.html.markdown new file mode 100644 index 0000000..dea7eba --- /dev/null +++ b/config/docs/r/vpn_connection_reset.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_connection_reset" +sidebar_current: "docs-tencentcloud-resource-vpn_connection_reset" +description: |- + Provides a resource to create a vpc vpn_connection_reset +--- + +# tencentcloud_vpn_connection_reset + +Provides a resource to create a vpc vpn_connection_reset + +## Example Usage + +```hcl +resource "tencentcloud_vpn_connection_reset" "vpn_connection_reset" { + vpn_gateway_id = "vpngw-gt8bianl" + vpn_connection_id = "vpnx-kme2tx8m" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `vpn_connection_id` - (Required, String, ForceNew) VPN CONNECTION INSTANCE ID. +* `vpn_gateway_id` - (Required, String, ForceNew) VPN GATEWAY INSTANCE ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/vpn_customer_gateway.html.markdown b/config/docs/r/vpn_customer_gateway.html.markdown new file mode 100644 index 0000000..355a10d --- /dev/null +++ b/config/docs/r/vpn_customer_gateway.html.markdown @@ -0,0 +1,50 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_customer_gateway" +sidebar_current: "docs-tencentcloud-resource-vpn_customer_gateway" +description: |- + Provides a resource to create a VPN customer gateway. +--- + +# tencentcloud_vpn_customer_gateway + +Provides a resource to create a VPN customer gateway. + +## Example Usage + +```hcl +resource "tencentcloud_vpn_customer_gateway" "foo" { + name = "test_vpn_customer_gateway" + public_ip_address = "1.1.1.1" + + tags = { + tag = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the customer gateway. The length of character is limited to 1-60. +* `public_ip_address` - (Required, String, ForceNew) Public IP of the customer gateway. +* `tags` - (Optional, Map) A list of tags used to associate different resources. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the customer gateway. + + +## Import + +VPN customer gateway can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_vpn_customer_gateway.foo cgw-xfqag +``` + diff --git a/config/docs/r/vpn_customer_gateway_configuration_download.html.markdown b/config/docs/r/vpn_customer_gateway_configuration_download.html.markdown new file mode 100644 index 0000000..0191474 --- /dev/null +++ b/config/docs/r/vpn_customer_gateway_configuration_download.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_customer_gateway_configuration_download" +sidebar_current: "docs-tencentcloud-resource-vpn_customer_gateway_configuration_download" +description: |- + Provides a resource to create a vpc vpn_customer_gateway_configuration_download +--- + +# tencentcloud_vpn_customer_gateway_configuration_download + +Provides a resource to create a vpc vpn_customer_gateway_configuration_download + +## Example Usage + +```hcl +resource "tencentcloud_vpn_customer_gateway_configuration_download" "vpn_customer_gateway_configuration_download" { + vpn_gateway_id = "vpngw-gt8bianl" + vpn_connection_id = "vpnx-kme2tx8m" + customer_gateway_vendor { + platform = "comware" + software_version = "V1.0" + vendor_name = "h3c" + } + interface_name = "test" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `customer_gateway_vendor` - (Required, List, ForceNew) Customer Gateway Vendor Info. +* `interface_name` - (Required, String, ForceNew) VPN connection access device physical interface name. +* `vpn_connection_id` - (Required, String, ForceNew) VPN Connection Instance id. +* `vpn_gateway_id` - (Required, String, ForceNew) VPN Gateway Instance ID. + +The `customer_gateway_vendor` object supports the following: + +* `platform` - (Required, String) Platform. +* `software_version` - (Required, String) SoftwareVersion. +* `vendor_name` - (Required, String) VendorName. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `customer_gateway_configuration` - xml configuration. + + diff --git a/config/docs/r/vpn_gateway.html.markdown b/config/docs/r/vpn_gateway.html.markdown new file mode 100644 index 0000000..6f4f762 --- /dev/null +++ b/config/docs/r/vpn_gateway.html.markdown @@ -0,0 +1,133 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_gateway" +sidebar_current: "docs-tencentcloud-resource-vpn_gateway" +description: |- + Provides a resource to create a VPN gateway. +--- + +# tencentcloud_vpn_gateway + +Provides a resource to create a VPN gateway. + +-> **NOTE:** The prepaid VPN gateway do not support renew operation or delete operation with terraform. + +## Example Usage + +### VPC SSL VPN gateway + +```hcl +resource "tencentcloud_vpn_gateway" "my_cgw" { + name = "test" + bandwidth = 5 + zone = "ap-guangzhou-3" + type = "SSL" + vpc_id = "vpc-86v957zb" + + tags = { + test = "test" + } +} +``` + +### CCN IPEC VPN gateway + +```hcl +resource "tencentcloud_vpn_gateway" "my_cgw" { + name = "test" + bandwidth = 5 + zone = "ap-guangzhou-3" + type = "CCN" + + tags = { + test = "test" + } +} +``` + +### CCN SSL VPN gateway + +```hcl +resource "tencentcloud_vpn_gateway" "my_cgw" { + name = "test" + bandwidth = 5 + zone = "ap-guangzhou-3" + type = "SSL_CCN" + + tags = { + test = "test" + } +} +``` + +### POSTPAID_BY_HOUR VPN gateway + +```hcl +resource "tencentcloud_vpn_gateway" "my_cgw" { + name = "test" + vpc_id = "vpc-dk8zmwuf" + bandwidth = 5 + zone = "ap-guangzhou-3" + + tags = { + test = "test" + } +} +``` + +### PREPAID VPN gateway + +```hcl +resource "tencentcloud_vpn_gateway" "my_cgw" { + name = "test" + vpc_id = "vpc-dk8zmwuf" + bandwidth = 5 + zone = "ap-guangzhou-3" + charge_type = "PREPAID" + prepaid_period = 1 + + tags = { + test = "test" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `name` - (Required, String) Name of the VPN gateway. The length of character is limited to 1-60. +* `bandwidth` - (Optional, Int) The maximum public network output bandwidth of VPN gateway (unit: Mbps), the available values include: 5,10,20,50,100,200,500,1000. Default is 5. When charge type is `PREPAID`, bandwidth degradation operation is unsupported. +* `cdc_id` - (Optional, String) CDC instance ID. +* `charge_type` - (Optional, String) Charge Type of the VPN gateway. Valid value: `PREPAID`, `POSTPAID_BY_HOUR`. The default is `POSTPAID_BY_HOUR`. +* `max_connection` - (Optional, Int) Maximum number of connected clients allowed for the SSL VPN gateway. Valid values: [5, 10, 20, 50, 100]. This parameter is only required for SSL VPN gateways. +* `prepaid_period` - (Optional, Int) Period of instance to be prepaid. Valid value: `1`, `2`, `3`, `4`, `6`, `7`, `8`, `9`, `12`, `24`, `36`. The unit is month. Caution: when this para and renew_flag para are valid, the request means to renew several months more pre-paid period. This para can only be changed on `IPSEC` vpn gateway. +* `prepaid_renew_flag` - (Optional, String) Flag indicates whether to renew or not. Valid value: `NOTIFY_AND_AUTO_RENEW`, `NOTIFY_AND_MANUAL_RENEW`. +* `tags` - (Optional, Map) A list of tags used to associate different resources. +* `type` - (Optional, String) Type of gateway instance, Default is `IPSEC`. Valid value: `IPSEC`, `SSL`, `CCN` and `SSL_CCN`. +* `vpc_id` - (Optional, String, ForceNew) ID of the VPC. Required if vpn gateway is not in `CCN` or `SSL_CCN` type, and doesn't make sense for `CCN` or `SSL_CCN` vpn gateway. +* `zone` - (Optional, String, ForceNew) Zone of the VPN gateway. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time of the VPN gateway. +* `expired_time` - Expired time of the VPN gateway when charge type is `PREPAID`. +* `is_address_blocked` - Indicates whether ip address is blocked. +* `new_purchase_plan` - The plan of new purchase. Valid value: `PREPAID_TO_POSTPAID`. +* `public_ip_address` - Public IP of the VPN gateway. +* `restrict_state` - Restrict state of gateway. Valid value: `PRETECIVELY_ISOLATED`, `NORMAL`. +* `state` - State of the VPN gateway. Valid value: `PENDING`, `DELETING`, `AVAILABLE`. + + +## Import + +VPN gateway can be imported using the id, e.g. + +``` +$ terraform import tencentcloud_vpn_gateway.foo vpngw-8ccsnclt +``` + diff --git a/config/docs/r/vpn_gateway_ccn_routes.html.markdown b/config/docs/r/vpn_gateway_ccn_routes.html.markdown new file mode 100644 index 0000000..f0016a1 --- /dev/null +++ b/config/docs/r/vpn_gateway_ccn_routes.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_gateway_ccn_routes" +sidebar_current: "docs-tencentcloud-resource-vpn_gateway_ccn_routes" +description: |- + Provides a resource to create a vpn_gateway_ccn_routes +--- + +# tencentcloud_vpn_gateway_ccn_routes + +Provides a resource to create a vpn_gateway_ccn_routes + +## Example Usage + +```hcl +resource "tencentcloud_vpn_gateway_ccn_routes" "vpn_gateway_ccn_routes" { + destination_cidr_block = "192.168.1.0/24" + route_id = "vpnr-akdy0757" + status = "DISABLE" + vpn_gateway_id = "vpngw-lie1a4u7" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `destination_cidr_block` - (Required, String, ForceNew) Routing CIDR. +* `route_id` - (Required, String, ForceNew) Route Id. +* `status` - (Required, String) Whether routing information is enabled. `ENABLE`: Enable Route, `DISABLE`: Disable Route. +* `vpn_gateway_id` - (Required, String, ForceNew) VPN GATEWAY INSTANCE ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc vpn_gateway_ccn_routes can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpn_gateway_ccn_routes.vpn_gateway_ccn_routes vpn_gateway_id#ccn_routes_id +``` + diff --git a/config/docs/r/vpn_gateway_route.html.markdown b/config/docs/r/vpn_gateway_route.html.markdown new file mode 100644 index 0000000..2f1189e --- /dev/null +++ b/config/docs/r/vpn_gateway_route.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_gateway_route" +sidebar_current: "docs-tencentcloud-resource-vpn_gateway_route" +description: |- + Provides a resource to create a VPN gateway route. +--- + +# tencentcloud_vpn_gateway_route + +Provides a resource to create a VPN gateway route. + +## Example Usage + +```hcl +resource "tencentcloud_vpn_gateway_route" "route" { + vpn_gateway_id = "vpngw-ak9sjem2" + destination_cidr_block = "10.0.0.0/16" + instance_id = "vpnx-5b5dmao3" + instance_type = "VPNCONN" + priority = 100 + status = "DISABLE" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `destination_cidr_block` - (Required, String, ForceNew) Destination IDC IP range. +* `instance_id` - (Required, String, ForceNew) Instance ID of the next hop. +* `instance_type` - (Required, String, ForceNew) Next hop type (type of the associated instance). Valid values: VPNCONN (VPN tunnel) and CCN (CCN instance). +* `priority` - (Required, Int, ForceNew) Priority. Valid values: 0 and 100. +* `status` - (Required, String) Status. Valid values: ENABLE and DISABLE. +* `vpn_gateway_id` - (Required, String, ForceNew) VPN gateway ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `create_time` - Create time. +* `route_id` - Route ID. +* `type` - Route type. Default value: Static. +* `update_time` - Update time. + + +## Import + +VPN gateway route can be imported using the id, the id format must be '{vpn_gateway_id}#{route_id}', e.g. + +``` +$ terraform import tencentcloud_vpn_gateway_route.route1 vpngw-ak9sjem2#vpngw-8ccsnclt +``` + diff --git a/config/docs/r/vpn_gateway_ssl_client_cert.html.markdown b/config/docs/r/vpn_gateway_ssl_client_cert.html.markdown new file mode 100644 index 0000000..cfe6bb1 --- /dev/null +++ b/config/docs/r/vpn_gateway_ssl_client_cert.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_gateway_ssl_client_cert" +sidebar_current: "docs-tencentcloud-resource-vpn_gateway_ssl_client_cert" +description: |- + Provides a resource to create a vpc vpn_gateway_ssl_client_cert +--- + +# tencentcloud_vpn_gateway_ssl_client_cert + +Provides a resource to create a vpc vpn_gateway_ssl_client_cert + +## Example Usage + +```hcl +resource "tencentcloud_vpn_gateway_ssl_client_cert" "vpn_gateway_ssl_client_cert" { + ssl_vpn_client_id = "vpnc-123456" + switch = "off" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ssl_vpn_client_id` - (Required, String) SSL-VPN-CLIENT Instance ID. +* `switch` - (Optional, String) `on`: Enable, `off`: Disable. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +vpc vpn_gateway_ssl_client_cert can be imported using the id, e.g. + +``` +terraform import tencentcloud_vpn_gateway_ssl_client_cert.vpn_gateway_ssl_client_cert ssl_client_id +``` + diff --git a/config/docs/r/vpn_ssl_client.html.markdown b/config/docs/r/vpn_ssl_client.html.markdown new file mode 100644 index 0000000..2d6581c --- /dev/null +++ b/config/docs/r/vpn_ssl_client.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_ssl_client" +sidebar_current: "docs-tencentcloud-resource-vpn_ssl_client" +description: |- + Provide a resource to create a VPN SSL Client. +--- + +# tencentcloud_vpn_ssl_client + +Provide a resource to create a VPN SSL Client. + +## Example Usage + +```hcl +resource "tencentcloud_vpn_ssl_client" "client" { + ssl_vpn_server_id = "vpns-aog5xcjj" + ssl_vpn_client_name = "hello" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `ssl_vpn_client_name` - (Required, String, ForceNew) The name of ssl vpn client to be created. +* `ssl_vpn_server_id` - (Required, String, ForceNew) VPN ssl server id. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +VPN SSL Client can be imported, e.g. + +``` +$ terraform import tencentcloud_vpn_ssl_client.client vpn-client-id +``` + diff --git a/config/docs/r/vpn_ssl_server.html.markdown b/config/docs/r/vpn_ssl_server.html.markdown new file mode 100644 index 0000000..87fd70c --- /dev/null +++ b/config/docs/r/vpn_ssl_server.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "VPN Connections(VPN)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_vpn_ssl_server" +sidebar_current: "docs-tencentcloud-resource-vpn_ssl_server" +description: |- + Provide a resource to create a VPN SSL Server. +--- + +# tencentcloud_vpn_ssl_server + +Provide a resource to create a VPN SSL Server. + +## Example Usage + +```hcl +resource "tencentcloud_vpn_ssl_server" "server" { + local_address = [ + "10.0.0.0/17", + ] + remote_address = "11.0.0.0/16" + ssl_vpn_server_name = "helloworld" + vpn_gateway_id = "vpngw-335lwf7d" + ssl_vpn_protocol = "UDP" + ssl_vpn_port = 1194 + integrity_algorithm = "MD5" + encrypt_algorithm = "AES-128-CBC" + compress = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `local_address` - (Required, List: [`String`]) List of local CIDR. +* `remote_address` - (Required, String) Remote CIDR for client. +* `ssl_vpn_server_name` - (Required, String) The name of ssl vpn server to be created. +* `vpn_gateway_id` - (Required, String, ForceNew) VPN gateway ID. +* `compress` - (Optional, Bool) need compressed. Default value: False. +* `encrypt_algorithm` - (Optional, String) The encrypt algorithm. Valid values: AES-128-CBC, AES-192-CBC, AES-256-CBC, NONE.Default value: NONE. +* `integrity_algorithm` - (Optional, String) The integrity algorithm. Valid values: SHA1, MD5 and NONE. Default value: NONE. +* `ssl_vpn_port` - (Optional, Int) The port of ssl vpn. Default value: 1194. +* `ssl_vpn_protocol` - (Optional, String) The protocol of ssl vpn. Default value: UDP. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +VPN SSL Server can be imported, e.g. + +``` +$ terraform import tencentcloud_vpn_ssl_server.server vpn-server-id +``` + diff --git a/config/docs/r/waf_anti_fake.html.markdown b/config/docs/r/waf_anti_fake.html.markdown new file mode 100644 index 0000000..9fe6993 --- /dev/null +++ b/config/docs/r/waf_anti_fake.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_anti_fake" +sidebar_current: "docs-tencentcloud-resource-waf_anti_fake" +description: |- + Provides a resource to create a waf anti_fake +--- + +# tencentcloud_waf_anti_fake + +Provides a resource to create a waf anti_fake + +~> **NOTE:** Uri: Please configure static resources such as. html,. shtml,. txt,. js,. css,. jpg,. png, or access paths for static resources.. + +## Example Usage + +```hcl +resource "tencentcloud_waf_anti_fake" "example" { + domain = "www.waf.com" + name = "tf_example" + uri = "/anti_fake_url.html" + status = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Domain. +* `name` - (Required, String) Name. +* `uri` - (Required, String) Uri. +* `status` - (Optional, Int) status. 0: Turn off rules and log switches, 1: Turn on the rule switch and Turn off the log switch; 2: Turn off the rule switch and turn on the log switch;3: Turn on the log switch. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `protocol` - protocol. +* `rule_id` - rule id. + + +## Import + +waf anti_fake can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_anti_fake.example 3200035516#www.waf.com +``` + diff --git a/config/docs/r/waf_anti_info_leak.html.markdown b/config/docs/r/waf_anti_info_leak.html.markdown new file mode 100644 index 0000000..0ae4cc9 --- /dev/null +++ b/config/docs/r/waf_anti_info_leak.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_anti_info_leak" +sidebar_current: "docs-tencentcloud-resource-waf_anti_info_leak" +description: |- + Provides a resource to create a waf anti_info_leak +--- + +# tencentcloud_waf_anti_info_leak + +Provides a resource to create a waf anti_info_leak + +## Example Usage + +```hcl +resource "tencentcloud_waf_anti_info_leak" "example" { + domain = "tf.example.com" + name = "tf_example" + action_type = 0 + strategies { + field = "information" + content = "phone" + } + uri = "/anti_info_leak_url" + status = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `action_type` - (Required, Int) Rule Action. 0: alarm; 1: replacement; 2: only displaying the first four digits; 3: only displaying the last four digits; 4: blocking. +* `domain` - (Required, String) Domain. +* `name` - (Required, String) Rule Name. +* `strategies` - (Required, List) Strategies detail. +* `uri` - (Required, String) Uri. +* `status` - (Optional, Int) status. + +The `strategies` object supports the following: + +* `content` - (Required, String) Matching Content. If field is returncode support: 400, 403, 404, 4xx, 500, 501, 502, 504, 5xx; If field is information support: idcard, phone, bankcard; If field is keywords users input matching content themselves. +* `field` - (Required, String) Matching Fields. support: returncode, keywords, information. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +waf anti_info_leak can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_anti_info_leak.example 3100077499#tf.example.com +``` + diff --git a/config/docs/r/waf_auto_deny_rules.html.markdown b/config/docs/r/waf_auto_deny_rules.html.markdown new file mode 100644 index 0000000..097d0fe --- /dev/null +++ b/config/docs/r/waf_auto_deny_rules.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_auto_deny_rules" +sidebar_current: "docs-tencentcloud-resource-waf_auto_deny_rules" +description: |- + Provides a resource to create a waf auto_deny_rules +--- + +# tencentcloud_waf_auto_deny_rules + +Provides a resource to create a waf auto_deny_rules + +## Example Usage + +```hcl +resource "tencentcloud_waf_auto_deny_rules" "example" { + domain = "demo.waf.com" + attack_threshold = 20 + time_threshold = 12 + deny_time_threshold = 5 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `attack_threshold` - (Required, Int, ForceNew) The threshold number of attacks that triggers IP autodeny, ranging from 2 to 100 times. +* `deny_time_threshold` - (Required, Int, ForceNew) The IP autodeny time after triggering the IP autodeny, ranging from 5 to 360 minutes. +* `domain` - (Required, String, ForceNew) Domain. +* `time_threshold` - (Required, Int, ForceNew) IP autodeny statistical time, ranging from 1-60 minutes. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +waf auto_deny_rules can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_auto_deny_rules.example demo.waf.com +``` + diff --git a/config/docs/r/waf_cc.html.markdown b/config/docs/r/waf_cc.html.markdown new file mode 100644 index 0000000..ba400e0 --- /dev/null +++ b/config/docs/r/waf_cc.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_cc" +sidebar_current: "docs-tencentcloud-resource-waf_cc" +description: |- + Provides a resource to create a waf cc +--- + +# tencentcloud_waf_cc + +Provides a resource to create a waf cc + +## Example Usage + +```hcl +resource "tencentcloud_waf_cc" "example" { + domain = "www.demo.com" + name = "terraform" + status = 1 + advance = "0" + limit = "60" + interval = "60" + url = "/cc_demo" + match_func = 0 + action_type = "22" + priority = 50 + valid_time = 600 + edition = "sparta-waf" + type = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `action_type` - (Required, String) Rule Action, 20 log, 21 captcha, 22 deny, 23 accurate deny. +* `advance` - (Required, String) Session match mode, 0 use session, 1 use ip. +* `domain` - (Required, String) Domain. +* `edition` - (Required, String) WAF edition. clb-waf means clb-waf, sparta-waf means saas-waf. +* `interval` - (Required, String) Interval. +* `limit` - (Required, String) CC detection threshold. +* `match_func` - (Required, Int) Match method, 0 equal, 1 contains, 2 prefix. +* `name` - (Required, String) Rule Name. +* `priority` - (Required, Int) Rule Priority. +* `status` - (Required, Int) Rule Status, 0 rule close, 1 rule open. +* `url` - (Required, String) Check URL. +* `valid_time` - (Required, Int) Action ValidTime, minute unit. Min: 60, Max: 604800. +* `event_id` - (Optional, String) Event ID. +* `session_applied` - (Optional, Set: [`Int`]) Advance mode use session id. +* `type` - (Optional, Int) Operate Type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `rule_id` - Rule ID. + + diff --git a/config/docs/r/waf_cc_auto_status.html.markdown b/config/docs/r/waf_cc_auto_status.html.markdown new file mode 100644 index 0000000..5fd9728 --- /dev/null +++ b/config/docs/r/waf_cc_auto_status.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_cc_auto_status" +sidebar_current: "docs-tencentcloud-resource-waf_cc_auto_status" +description: |- + Provides a resource to create a waf cc_auto_status +--- + +# tencentcloud_waf_cc_auto_status + +Provides a resource to create a waf cc_auto_status + +## Example Usage + +```hcl +resource "tencentcloud_waf_cc_auto_status" "example" { + domain = "www.demo.com" + edition = "sparta-waf" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String, ForceNew) Domain. +* `edition` - (Required, String, ForceNew) Waf edition. clb-waf means clb-waf, sparta-waf means saas-waf. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `status` - cc auto status, 1 means open, 0 means close. + + +## Import + +waf cc_auto_status can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_cc_auto_status.example www.demo.com#sparta-waf +``` + diff --git a/config/docs/r/waf_cc_session.html.markdown b/config/docs/r/waf_cc_session.html.markdown new file mode 100644 index 0000000..8c7fc76 --- /dev/null +++ b/config/docs/r/waf_cc_session.html.markdown @@ -0,0 +1,59 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_cc_session" +sidebar_current: "docs-tencentcloud-resource-waf_cc_session" +description: |- + Provides a resource to create a waf cc_session +--- + +# tencentcloud_waf_cc_session + +Provides a resource to create a waf cc_session + +## Example Usage + +```hcl +resource "tencentcloud_waf_cc_session" "example" { + domain = "www.demo.com" + source = "get" + category = "match" + key_or_start_mat = "key_a=123" + end_mat = "&" + start_offset = "-1" + end_offset = "-1" + edition = "sparta-waf" + session_name = "terraformDemo" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `category` - (Required, String) Session match pattern, Optional patterns are match, location. +* `domain` - (Required, String) Domain. +* `edition` - (Required, String) Waf edition. clb-waf means clb-waf, sparta-waf means saas-waf. +* `end_mat` - (Required, String) Session end identifier, when Category is match. +* `end_offset` - (Required, String) End offset position, when Category is location. +* `key_or_start_mat` - (Required, String) Session identifier. +* `session_name` - (Required, String) Session Name. +* `source` - (Required, String) Session matching position, Optional locations are get, post, header, cookie. +* `start_offset` - (Required, String) Starting offset position, when Category is location. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `session_id` - Session ID. + + +## Import + +waf cc_session can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_cc_session.example www.demo.com#sparta-waf#2000000253 +``` + diff --git a/config/docs/r/waf_clb_domain.html.markdown b/config/docs/r/waf_clb_domain.html.markdown new file mode 100644 index 0000000..255a9cd --- /dev/null +++ b/config/docs/r/waf_clb_domain.html.markdown @@ -0,0 +1,160 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_clb_domain" +sidebar_current: "docs-tencentcloud-resource-waf_clb_domain" +description: |- + Provides a resource to create a waf clb_domain +--- + +# tencentcloud_waf_clb_domain + +Provides a resource to create a waf clb_domain + +## Example Usage + +### Create a basic waf clb domain + +```hcl +resource "tencentcloud_waf_clb_domain" "example" { + instance_id = "waf_2kxtlbky00b2v1fn" + domain = "test.com" + + load_balancer_set { + load_balancer_id = "lb-5dnrkgry" + load_balancer_name = "keep-listener-clb" + listener_id = "lbl-nonkgvc2" + listener_name = "dsadasd" + vip = "106.55.220.8" + vport = "80" + region = "gz" + protocol = "HTTP" + zone = "ap-guangzhou-6" + numerical_vpc_id = "5232945" + load_balancer_type = "OPEN" + } + + region = "gz" + alb_type = "clb" +} +``` + +### Create a complete waf clb domain + +```hcl +resource "tencentcloud_waf_clb_domain" "example" { + instance_id = "waf_2kxtlbky00b2v1fn" + domain = "test.com" + is_cdn = 3 + status = 1 + engine = 21 + + load_balancer_set { + load_balancer_id = "lb-5dnrkgry" + load_balancer_name = "keep-listener-clb" + listener_id = "lbl-nonkgvc2" + listener_name = "dsadasd" + vip = "106.55.220.8" + vport = "80" + region = "gz" + protocol = "HTTP" + zone = "ap-guangzhou-6" + numerical_vpc_id = "5232945" + load_balancer_type = "OPEN" + } + + region = "gz" + flow_mode = 1 + alb_type = "clb" + bot_status = 1 + api_safe_status = 1 + ip_headers = [ + "headers_1", + "headers_2", + "headers_3", + ] +} +``` + +### Create a complete waf tsegw domain + +```hcl +resource "tencentcloud_waf_clb_domain" "example" { + instance_id = "waf_2kxtlbky00b2v1fn" + domain = "xxx.com" + is_cdn = 0 + status = 1 + engine = 12 + region = "gz" + flow_mode = 0 + alb_type = "tsegw" + bot_status = 0 + api_safe_status = 0 +} +``` + +### Create a complete waf apisix domain + +```hcl +resource "tencentcloud_waf_clb_domain" "example" { + instance_id = "waf_2kxtlbky00b2v1fn" + domain = "xxx.com" + is_cdn = 0 + status = 1 + engine = 12 + region = "gz" + flow_mode = 0 + alb_type = "apisix" + bot_status = 0 + api_safe_status = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Domain name. +* `instance_id` - (Required, String) Instance unique ID. +* `region` - (Required, String) Regions of LB bound by domain. +* `alb_type` - (Optional, String) Load balancer type: clb, apisix or tsegw, default clb. +* `api_safe_status` - (Optional, Int) Whether to enable api safe, 1 enable, 0 disable. +* `bot_status` - (Optional, Int) Whether to enable bot, 1 enable, 0 disable. +* `cls_status` - (Optional, Int) Whether to enable access logs, 1 enable, 0 disable. +* `engine` - (Optional, Int) Protection Status: 10: Rule Observation&&AI Off Mode, 11: Rule Observation&&AI Observation Mode, 12: Rule Observation&&AI Interception Mode, 20: Rule Interception&&AI Off Mode, 21: Rule Interception&&AI Observation Mode, 22: Rule Interception&&AI Interception Mode, Default 20. +* `flow_mode` - (Optional, Int) WAF traffic mode, 1 cleaning mode, 0 mirroring mode. +* `ip_headers` - (Optional, List: [`String`]) When is_cdn=3, this parameter needs to be filled in to indicate a custom header. +* `is_cdn` - (Optional, Int) Whether a proxy has been enabled before WAF, 0 no deployment, 1 deployment and use first IP in X-Forwarded-For as client IP, 2 deployment and use remote_addr as client IP, 3 deployment and use values of custom headers as client IP. +* `load_balancer_set` - (Optional, List) List of bound LB. +* `status` - (Optional, Int) Binding status between waf and LB, 0:not bind, 1:binding. + +The `load_balancer_set` object supports the following: + +* `listener_id` - (Required, String) Unique ID of listener in LB. +* `listener_name` - (Required, String) Listener name. +* `load_balancer_id` - (Required, String) LoadBalancer unique ID. +* `load_balancer_name` - (Required, String) LoadBalancer name. +* `protocol` - (Required, String) Protocol of listener, http or https. +* `region` - (Required, String) LoadBalancer region. +* `vip` - (Required, String) LoadBalancer IP. +* `vport` - (Required, Int) LoadBalancer port. +* `zone` - (Required, String) LoadBalancer zone. +* `load_balancer_type` - (Optional, String) Network type for load balancer. +* `numerical_vpc_id` - (Optional, Int) VPCID for load balancer, public network is -1, and internal network is filled in according to actual conditions. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `domain_id` - Domain id. + + +## Import + +waf clb_domain can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_clb_domain.example waf_2kxtlbky00b2v1fn#test.com#waf-0FSehoRU +``` + diff --git a/config/docs/r/waf_clb_instance.html.markdown b/config/docs/r/waf_clb_instance.html.markdown new file mode 100644 index 0000000..ac12c27 --- /dev/null +++ b/config/docs/r/waf_clb_instance.html.markdown @@ -0,0 +1,83 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_clb_instance" +sidebar_current: "docs-tencentcloud-resource-waf_clb_instance" +description: |- + Provides a resource to create a waf clb instance +--- + +# tencentcloud_waf_clb_instance + +Provides a resource to create a waf clb instance + +~> **NOTE:** Region only supports `ap-guangzhou` and `ap-seoul`. + +## Example Usage + +### Create a basic waf premium clb instance + +```hcl +resource "tencentcloud_waf_clb_instance" "example" { + goods_category = "premium_clb" + instance_name = "tf-example-clb-waf" +} +``` + +### Create a complete waf ultimate_clb instance + +```hcl +resource "tencentcloud_waf_clb_instance" "example" { + goods_category = "ultimate_clb" + instance_name = "tf-example-clb-waf" + time_span = 1 + time_unit = "m" + auto_renew_flag = 1 + elastic_mode = 1 + bot_management = 1 + api_security = 1 +} +``` + +### Set waf ultimate_clb instance qps limit + +```hcl +resource "tencentcloud_waf_clb_instance" "example" { + goods_category = "ultimate_clb" + instance_name = "tf-example-clb-waf" + time_span = 1 + time_unit = "m" + auto_renew_flag = 1 + elastic_mode = 1 + qps_limit = 200000 + bot_management = 1 + api_security = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `goods_category` - (Required, String) Billing order parameters. support: premium_clb, enterprise_clb, ultimate_clb. +* `api_security` - (Optional, Int) Whether to purchase API Security, 1: yes, 0: no. Default is 0. +* `auto_renew_flag` - (Optional, Int) Auto renew flag, 1: enable, 0: disable. +* `bot_management` - (Optional, Int) Whether to purchase Bot management, 1: yes, 0: no. Default is 0. +* `elastic_mode` - (Optional, Int) Is elastic billing enabled, 1: enable, 0: disable. +* `instance_name` - (Optional, String) Waf instance name. +* `qps_limit` - (Optional, Int) QPS Limit, Minimum setting 10000. Only `elastic_mode` is 1, can be set. +* `time_span` - (Optional, Int) Time interval. +* `time_unit` - (Optional, String) Time unit, support d, m, y. d: day, m: month, y: year. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `begin_time` - waf instance start time. +* `edition` - waf instance edition, clb or saas. +* `instance_id` - waf instance id. +* `status` - waf instance status. +* `valid_time` - waf instance valid time. + + diff --git a/config/docs/r/waf_custom_rule.html.markdown b/config/docs/r/waf_custom_rule.html.markdown new file mode 100644 index 0000000..e6041c6 --- /dev/null +++ b/config/docs/r/waf_custom_rule.html.markdown @@ -0,0 +1,71 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_custom_rule" +sidebar_current: "docs-tencentcloud-resource-waf_custom_rule" +description: |- + Provides a resource to create a waf custom_rule +--- + +# tencentcloud_waf_custom_rule + +Provides a resource to create a waf custom_rule + +## Example Usage + +```hcl +resource "tencentcloud_waf_custom_rule" "example" { + name = "tf-example" + sort_id = "50" + redirect = "/" + expire_time = "0" + + strategies { + field = "IP" + compare_func = "ipmatch" + content = "2.2.2.2" + arg = "" + } + + status = "1" + domain = "test.com" + action_type = "1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `action_type` - (Required, String) Action type, 1 represents blocking, 2 represents captcha, 3 represents observation, and 4 represents redirection. +* `domain` - (Required, String) Domain name that needs to add policy. +* `expire_time` - (Required, String) Expiration time, measured in seconds, such as 1677254399, which means the expiration time is 2023-02-24 23:59:59 0 means never expires. +* `name` - (Required, String) Rule Name. +* `sort_id` - (Required, String) Priority, value range 0-100. +* `strategies` - (Required, List) Strategies detail. +* `redirect` - (Optional, String) If the action is a redirect, it represents the redirect address; Other situations can be left blank. +* `status` - (Optional, String) The status of the switch, 1 is on, 0 is off, default 1. + +The `strategies` object supports the following: + +* `arg` - (Required, String) Matching parameters. +* `compare_func` - (Required, String) Logical symbol. +* `content` - (Required, String) Matching Content. +* `field` - (Required, String) Matching Fields. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `rule_id` - rule ID. + + +## Import + +waf custom_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_custom_rule.example test.com#1100310609 +``` + diff --git a/config/docs/r/waf_custom_white_rule.html.markdown b/config/docs/r/waf_custom_white_rule.html.markdown new file mode 100644 index 0000000..bc76f8b --- /dev/null +++ b/config/docs/r/waf_custom_white_rule.html.markdown @@ -0,0 +1,69 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_custom_white_rule" +sidebar_current: "docs-tencentcloud-resource-waf_custom_white_rule" +description: |- + Provides a resource to create a waf custom_white_rule +--- + +# tencentcloud_waf_custom_white_rule + +Provides a resource to create a waf custom_white_rule + +## Example Usage + +```hcl +resource "tencentcloud_waf_custom_white_rule" "example" { + name = "tf-example" + sort_id = "30" + expire_time = "0" + + strategies { + field = "IP" + compare_func = "ipmatch" + content = "1.1.1.1" + arg = "" + } + + status = "1" + domain = "test.com" + bypass = "geoip,cc,owasp" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bypass` - (Required, String) Details of bypass. +* `domain` - (Required, String) Domain name that needs to add policy. +* `expire_time` - (Required, String) Expiration time, measured in seconds, such as 1677254399, which means the expiration time is 2023-02-24 23:59:59 0 means never expires. +* `name` - (Required, String) Rule Name. +* `sort_id` - (Required, String) Priority, value range 1-100, The smaller the number, the higher the execution priority of this rule. +* `strategies` - (Required, List) Strategies detail. +* `status` - (Optional, String) The status of the switch, 1 is on, 0 is off, default 1. + +The `strategies` object supports the following: + +* `arg` - (Required, String) Matching parameters. +* `compare_func` - (Required, String) Logical symbol. +* `content` - (Required, String) Matching Content. +* `field` - (Required, String) Matching Fields. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `rule_id` - rule ID. + + +## Import + +waf custom_white_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_custom_white_rule.example test.com#1100310837 +``` + diff --git a/config/docs/r/waf_ip_access_control.html.markdown b/config/docs/r/waf_ip_access_control.html.markdown new file mode 100644 index 0000000..3624137 --- /dev/null +++ b/config/docs/r/waf_ip_access_control.html.markdown @@ -0,0 +1,75 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_ip_access_control" +sidebar_current: "docs-tencentcloud-resource-waf_ip_access_control" +description: |- + Provides a resource to create a waf ip_access_control +--- + +# tencentcloud_waf_ip_access_control + +Provides a resource to create a waf ip_access_control + +## Example Usage + +```hcl +resource "tencentcloud_waf_ip_access_control" "example" { + instance_id = "waf_2kxtlbky00b3b4qz" + domain = "www.demo.com" + edition = "sparta-waf" + items { + ip = "1.1.1.1" + note = "desc info." + action = 40 + valid_ts = "2019571199" + } + + items { + ip = "2.2.2.2" + note = "desc info." + action = 42 + valid_ts = "2019571199" + } + + items { + ip = "3.3.3.3" + note = "desc info." + action = 40 + valid_ts = "1680570420" + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Domain. +* `edition` - (Required, String) Waf edition. clb-waf means clb-waf, sparta-waf means saas-waf. +* `instance_id` - (Required, String) Waf instance Id. +* `items` - (Required, Set) Ip parameter list. + +The `items` object supports the following: + +* `action` - (Required, Int) Action value 40 is whitelist, 42 is blacklist. +* `ip` - (Required, String) IP address. +* `note` - (Required, String) Note info. +* `valid_ts` - (Required, Int) Effective date, with a second level timestamp value. For example, 1680570420 represents 2023-04-04 09:07:00; 2019571199 means permanently effective. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +waf ip_access_control can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_ip_access_control.example waf_2kxtlbky00b3b4qz#www.demo.com#sparta-waf +``` + diff --git a/config/docs/r/waf_modify_access_period.html.markdown b/config/docs/r/waf_modify_access_period.html.markdown new file mode 100644 index 0000000..90fd0ac --- /dev/null +++ b/config/docs/r/waf_modify_access_period.html.markdown @@ -0,0 +1,37 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_modify_access_period" +sidebar_current: "docs-tencentcloud-resource-waf_modify_access_period" +description: |- + Provides a resource to create a waf modify_access_period +--- + +# tencentcloud_waf_modify_access_period + +Provides a resource to create a waf modify_access_period + +## Example Usage + +```hcl +resource "tencentcloud_waf_modify_access_period" "example" { + topic_id = "1ae37c76-df99-4e2b-998c-20f39eba6226" + period = 30 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `period` - (Required, Int, ForceNew) Access log retention period, range is [1, 180]. +* `topic_id` - (Required, String, ForceNew) Log topic, new version does not need to be uploaded. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/waf_module_status.html.markdown b/config/docs/r/waf_module_status.html.markdown new file mode 100644 index 0000000..b54cc62 --- /dev/null +++ b/config/docs/r/waf_module_status.html.markdown @@ -0,0 +1,55 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_module_status" +sidebar_current: "docs-tencentcloud-resource-waf_module_status" +description: |- + Provides a resource to create a waf module_status +--- + +# tencentcloud_waf_module_status + +Provides a resource to create a waf module_status + +## Example Usage + +```hcl +resource "tencentcloud_waf_module_status" "example" { + domain = "demo.waf.com" + web_security = 1 + access_control = 0 + cc_protection = 1 + api_protection = 1 + anti_tamper = 1 + anti_leakage = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `access_control` - (Required, Int) ACL module status, 0:closed, 1:opened. +* `api_protection` - (Required, Int) API security module status, 0:closed, 1:opened. +* `cc_protection` - (Required, Int) CC module status, 0:closed, 1:opened. +* `domain` - (Required, String) Domain. +* `web_security` - (Required, Int) WEB security module status, 0:closed, 1:opened. +* `anti_leakage` - (Optional, Int) Anti leakage module status, 0:closed, 1:opened. +* `anti_tamper` - (Optional, Int) Anti tamper module status, 0:closed, 1:opened. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +waf module_status can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_module_status.example demo.waf.com +``` + diff --git a/config/docs/r/waf_protection_mode.html.markdown b/config/docs/r/waf_protection_mode.html.markdown new file mode 100644 index 0000000..259686b --- /dev/null +++ b/config/docs/r/waf_protection_mode.html.markdown @@ -0,0 +1,41 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_protection_mode" +sidebar_current: "docs-tencentcloud-resource-waf_protection_mode" +description: |- + Provides a resource to create a waf protection_mode +--- + +# tencentcloud_waf_protection_mode + +Provides a resource to create a waf protection_mode + +## Example Usage + +```hcl +resource "tencentcloud_waf_protection_mode" "example" { + domain = "keep.qcloudwaf.com" + mode = 10 + edition = "sparta-waf" + type = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Domain. +* `mode` - (Required, Int) Protection status:10: Rule observation; AI off mode, 11: Rule observation; AI observation mode, 12: Rule observation; AI interception mode20: Rule interception; AI off mode, 21: Rule interception; AI observation mode, 22: Rule interception; AI interception mode. +* `edition` - (Optional, String) WAF edition. clb-waf means clb-waf, sparta-waf means saas-waf, default is sparta-waf. +* `type` - (Optional, Int) 0 is to modify the rule engine status, 1 is to modify the AI status. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + diff --git a/config/docs/r/waf_saas_domain.html.markdown b/config/docs/r/waf_saas_domain.html.markdown new file mode 100644 index 0000000..2496f66 --- /dev/null +++ b/config/docs/r/waf_saas_domain.html.markdown @@ -0,0 +1,239 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_saas_domain" +sidebar_current: "docs-tencentcloud-resource-waf_saas_domain" +description: |- + Provides a resource to create a waf saas_domain +--- + +# tencentcloud_waf_saas_domain + +Provides a resource to create a waf saas_domain + +## Example Usage + +### If upstream_type is 0 + +Create a basic waf saas domain + +```hcl +resource "tencentcloud_waf_saas_domain" "example" { + instance_id = "waf_2kxtlbky01b3wceb" + domain = "tf.example.com" + src_list = [ + "1.1.1.1" + ] + + ports { + port = "80" + protocol = "http" + upstream_port = "80" + upstream_protocol = "http" + } +} +``` + +### Create a load balancing strategy is weighted polling saas domain + +```hcl +resource "tencentcloud_waf_saas_domain" "example" { + instance_id = "waf_2kxtlbky01b3wceb" + domain = "tf.example.com" + src_list = [ + "1.1.1.1", + "2.2.2.2" + ] + load_balance = "2" + weights = [ + 30, + 50 + ] + + ports { + port = "80" + protocol = "http" + upstream_port = "80" + upstream_protocol = "http" + } +} +``` + +### If upstream_type is 1 + +```hcl +resource "tencentcloud_waf_saas_domain" "example" { + instance_id = "waf_2kxtlbky01b3wceb" + domain = "tf.example.com" + upstream_type = 1 + upstream_domain = "test.com" + + ports { + port = "80" + protocol = "http" + upstream_port = "80" + upstream_protocol = "http" + } +} +``` + +### Create a waf saas domain with set Http&Https + +```hcl +resource "tencentcloud_waf_saas_domain" "example" { + instance_id = "waf_2kxtlbky01b3wceb" + domain = "tf.example.com" + is_cdn = 3 + cert_type = 2 + ssl_id = "3a6B5y8v" + load_balance = "2" + https_rewrite = 1 + upstream_scheme = "https" + src_list = [ + "1.1.1.1", + "2.2.2.2" + ] + weights = [ + 50, + 60 + ] + + ports { + port = "80" + protocol = "http" + upstream_port = "80" + upstream_protocol = "http" + } + + ports { + port = "443" + protocol = "https" + upstream_port = "443" + upstream_protocol = "https" + } + + ip_headers = [ + "headers_1", + "headers_2", + "headers_3", + ] +} +``` + +### Create a complete waf saas domain + +```hcl +resource "tencentcloud_waf_saas_domain" "example" { + instance_id = "waf_2kxtlbky01b3wceb" + domain = "tf.example.com" + is_cdn = 3 + cert_type = 2 + ssl_id = "3a6B5y8v" + load_balance = "2" + https_rewrite = 1 + is_http2 = 1 + upstream_scheme = "https" + src_list = [ + "1.1.1.1", + "2.2.2.2" + ] + weights = [ + 50, + 60 + ] + + ports { + port = "80" + protocol = "http" + upstream_port = "80" + upstream_protocol = "http" + } + + ports { + port = "443" + protocol = "https" + upstream_port = "443" + upstream_protocol = "https" + } + + ip_headers = [ + "headers_1", + "headers_2", + "headers_3", + ] + + is_keep_alive = "1" + active_check = 1 + tls_version = 3 + cipher_template = 1 + proxy_read_timeout = 500 + proxy_send_timeout = 500 + sni_type = 3 + sni_host = "3.3.3.3" + xff_reset = 1 + bot_status = 1 + api_safe_status = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Domain names that require defense. +* `instance_id` - (Required, String) Unique ID of Instance. +* `ports` - (Required, Set) This field needs to be set for multiple ports in the upstream server. +* `active_check` - (Optional, Int) Whether to enable active health detection, 0 represents disable and 1 represents enable. +* `api_safe_status` - (Optional, Int) Whether to enable api safe, 1 enable, 0 disable. +* `bot_status` - (Optional, Int) Whether to enable bot, 1 enable, 0 disable. +* `cert_type` - (Optional, Int) Certificate type, 0 represents no certificate, CertType=1 represents self owned certificate, and 2 represents managed certificate. +* `cert` - (Optional, String) Certificate content, When CertType=1, this parameter needs to be filled. +* `cipher_template` - (Optional, Int) Encryption Suite Template, 0:default 1:Universal template 2:Security template 3:Custom template. +* `ciphers` - (Optional, List: [`Int`]) Encryption Suite Information. +* `cls_status` - (Optional, Int) Whether to enable access logs, 1 enable, 0 disable. +* `https_rewrite` - (Optional, Int) Whether redirect to https, 1 will redirect and 0 will not. +* `https_upstream_port` - (Optional, String) Upstream port for https, When listen ports has https port and UpstreamScheme is HTTP, the current field needs to be filled. +* `ip_headers` - (Optional, List: [`String`]) When is_cdn=3, this parameter needs to be filled in to indicate a custom header. +* `is_cdn` - (Optional, Int) Whether a proxy has been enabled before WAF, 0 no deployment, 1 deployment and use first IP in X-Forwarded-For as client IP, 2 deployment and use remote_addr as client IP, 3 deployment and use values of custom headers as client IP. +* `is_http2` - (Optional, Int) Whether enable HTTP2, Enabling HTTP2 requires HTTPS support, 1 means enabled, 0 does not. +* `is_keep_alive` - (Optional, String) Whether to enable keep-alive, 0 disable, 1 enable. +* `is_websocket` - (Optional, Int) Is WebSocket support enabled. 1 means enabled, 0 does not. +* `load_balance` - (Optional, String) Load balancing strategy, where 0 represents polling and 1 represents IP hash and 2 weighted round robin. +* `private_key` - (Optional, String) Certificate key, When CertType=1, this parameter needs to be filled. +* `proxy_read_timeout` - (Optional, Int) 300s. +* `proxy_send_timeout` - (Optional, Int) 300s. +* `sni_host` - (Optional, String) When SniType=3, this parameter needs to be filled in to represent a custom host. +* `sni_type` - (Optional, Int) Sni type fo upstream, 0:disable SNI; 1:enable SNI and SNI equal original request host; 2:and SNI equal upstream host 3:enable SNI and equal customize host. +* `src_list` - (Optional, List: [`String`]) Upstream IP List, When UpstreamType=0, this parameter needs to be filled. +* `ssl_id` - (Optional, String) Certificate ID, When CertType=2, this parameter needs to be filled. +* `status` - (Optional, Int) Binding status between waf and LB, 0:not bind, 1:binding. +* `tls_version` - (Optional, Int) Version of TLS Protocol. +* `upstream_domain` - (Optional, String) Upstream domain, When UpstreamType=1, this parameter needs to be filled. +* `upstream_scheme` - (Optional, String) Upstream scheme for https, http or https. +* `upstream_type` - (Optional, Int) Upstream type, 0 represents IP, 1 represents domain name. +* `weights` - (Optional, List: [`Int`]) Weight of each upstream. +* `xff_reset` - (Optional, Int) 0:disable xff reset; 1:ensable xff reset. + +The `ports` object supports the following: + +* `port` - (Required, String) Listening port. +* `protocol` - (Required, String) The listening protocol of listening port. +* `upstream_port` - (Required, String) The upstream port for listening port. +* `upstream_protocol` - (Required, String) The upstream protocol for listening port. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `domain_id` - Domain id. + + +## Import + +waf saas_domain can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_saas_domain.example waf_2kxtlbky01b3wceb#tf.example.com#9647c91da0aa5f5aaa49d0ca40e2af24 +``` + diff --git a/config/docs/r/waf_saas_instance.html.markdown b/config/docs/r/waf_saas_instance.html.markdown new file mode 100644 index 0000000..eb64d6d --- /dev/null +++ b/config/docs/r/waf_saas_instance.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_saas_instance" +sidebar_current: "docs-tencentcloud-resource-waf_saas_instance" +description: |- + Provides a resource to create a waf saas instance +--- + +# tencentcloud_waf_saas_instance + +Provides a resource to create a waf saas instance + +~> **NOTE:** Region only supports `ap-guangzhou` and `ap-seoul`. + +## Example Usage + +### Create a basic waf premium saas instance + +```hcl +resource "tencentcloud_waf_saas_instance" "example" { + goods_category = "premium_saas" + instance_name = "tf-example-saas-waf" +} +``` + +### Create a complete waf ultimate_saas instance + +```hcl +resource "tencentcloud_waf_saas_instance" "example" { + goods_category = "ultimate_saas" + instance_name = "tf-example-saas-waf" + time_span = 1 + time_unit = "m" + auto_renew_flag = 1 + elastic_mode = 1 + real_region = "gz" + bot_management = 1 + api_security = 1 +} +``` + +### Set waf ultimate_saas instance qps limit + +```hcl +resource "tencentcloud_waf_saas_instance" "example" { + goods_category = "ultimate_saas" + instance_name = "tf-example-saas-waf" + time_span = 1 + time_unit = "m" + auto_renew_flag = 1 + elastic_mode = 1 + real_region = "gz" + qps_limit = 200000 + bot_management = 1 + api_security = 1 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `goods_category` - (Required, String) Billing order parameters. support premium_saas, enterprise_saas, ultimate_saas. +* `api_security` - (Optional, Int) Whether to purchase API Security, 1: yes, 0: no. Default is 0. +* `auto_renew_flag` - (Optional, Int) Auto renew flag, 1: enable, 0: disable. +* `bot_management` - (Optional, Int) Whether to purchase Bot management, 1: yes, 0: no. Default is 0. +* `elastic_mode` - (Optional, Int) Is elastic billing enabled, 1: enable, 0: disable. +* `instance_name` - (Optional, String) Waf instance name. +* `qps_limit` - (Optional, Int) QPS Limit, Minimum setting 10000. Only `elastic_mode` is 1, can be set. +* `real_region` - (Optional, String) region. If Region is `ap-guangzhou`, support: gz, sh, bj, cd (Means: GuangZhou, ShangHai, BeiJing, ChengDu); If Region is `ap-seoul`, support: hk, sg, th, kr, in, de, ca, use, sao, usw, jkt (Means: HongKong, Singapore, Bandkok, Seoul, Mumbai, Frankfurt, Toronto, Virginia, SaoPaulo, SiliconValley, Jakarta). +* `time_span` - (Optional, Int) Time interval. +* `time_unit` - (Optional, String) Time unit, support d, m, y. d: day, m: month, y: year. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `begin_time` - waf instance start time. +* `edition` - waf instance edition, clb or saas. +* `instance_id` - waf instance id. +* `status` - waf instance status. +* `valid_time` - waf instance valid time. + + diff --git a/config/docs/r/waf_web_shell.html.markdown b/config/docs/r/waf_web_shell.html.markdown new file mode 100644 index 0000000..0b6702c --- /dev/null +++ b/config/docs/r/waf_web_shell.html.markdown @@ -0,0 +1,45 @@ +--- +subcategory: "Web Application Firewall(WAF)" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_waf_web_shell" +sidebar_current: "docs-tencentcloud-resource-waf_web_shell" +description: |- + Provides a resource to create a waf web_shell +--- + +# tencentcloud_waf_web_shell + +Provides a resource to create a waf web_shell + +## Example Usage + +```hcl +resource "tencentcloud_waf_web_shell" "example" { + domain = "demo.waf.com" + status = 0 +} +``` + +## Argument Reference + +The following arguments are supported: + +* `domain` - (Required, String) Domain. +* `status` - (Required, Int) Webshell status, 1: open; 0: closed; 2: log. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +waf web_shell can be imported using the id, e.g. + +``` +terraform import tencentcloud_waf_web_shell.example demo.waf.com +``` + diff --git a/config/docs/r/wedata_baseline.html.markdown b/config/docs/r/wedata_baseline.html.markdown new file mode 100644 index 0000000..343d31e --- /dev/null +++ b/config/docs/r/wedata_baseline.html.markdown @@ -0,0 +1,124 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_baseline" +sidebar_current: "docs-tencentcloud-resource-wedata_baseline" +description: |- + Provides a resource to create a wedata baseline +--- + +# tencentcloud_wedata_baseline + +Provides a resource to create a wedata baseline + +## Example Usage + +```hcl +resource "tencentcloud_wedata_baseline" "example" { + project_id = "1927766435649077248" + baseline_name = "tf_example" + baseline_type = "D" + create_uin = "100028439226" + create_name = "tf_user" + in_charge_uin = "tf_user" + in_charge_name = "100028439226" + promise_tasks { + project_id = "1927766435649077248" + task_name = "tf_demo_task" + task_id = "20231030145334153" + task_cycle = "D" + workflow_name = "dataflow_mpp" + workflow_id = "e4dafb2e-76eb-11ee-bfeb-b8cef68a6637" + task_in_charge_name = ";tf_user;" + } + promise_time = "00:00:00" + warning_margin = 30 + is_new_alarm = true + baseline_create_alarm_rule_request { + alarm_types = [ + "baseLineBroken", + "baseLineWarning", + "baseLineTaskFailure" + ] + alarm_level = 2 + alarm_ways = [ + "email", + "sms" + ] + alarm_recipient_type = 1 + alarm_recipients = [ + "tf_user" + ] + alarm_recipient_ids = [ + "100028439226" + ] + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `baseline_name` - (Required, String) Baseline Name. +* `baseline_type` - (Required, String) D or H; representing daily baseline and hourly baseline respectively. +* `create_name` - (Required, String) Creator Name. +* `create_uin` - (Required, String) Creator ID. +* `in_charge_name` - (Required, String) Baseline Owner Name. +* `in_charge_uin` - (Required, String) Baseline Owner ID. +* `is_new_alarm` - (Required, Bool) Is it a newly created alarm rule. +* `project_id` - (Required, String) Project ID. +* `promise_tasks` - (Required, List) Promise Tasks. +* `promise_time` - (Required, String) Service Assurance Time. +* `warning_margin` - (Required, Int) Warning Margin in minutes. +* `alarm_rule_dto` - (Optional, List) Existing Alarm Rule Information. +* `baseline_create_alarm_rule_request` - (Optional, List) Description of the New Alarm Rule. + +The `alarm_rule_dto` object supports the following: + +* `alarm_level_type` - (Optional, String) Important;Urgent;Normal. +* `alarm_rule_id` - (Optional, String) Alarm Rule ID. + +The `baseline_create_alarm_rule_request` object supports the following: + +* `alarm_level` - (Optional, Int) Alarm Level, 1. Normal, 2. Important, 3. Urgent (default is 1. Normal)Note: This field may return null, indicating no valid value. +* `alarm_recipient_ids` - (Optional, Set) Alarm Recipient IDsNote: This field may return null, indicating no valid value. +* `alarm_recipient_type` - (Optional, Int) Alarm Recipient Type: 1. Specified Personnel, 2. Task Owner, 3. Duty Roster (default is 1. Specified Personnel)Note: This field may return null, indicating no valid value. +* `alarm_recipients` - (Optional, Set) Alarm RecipientsNote: This field may return null, indicating no valid value. +* `alarm_types` - (Optional, Set) Alarm Types, 1. Failure Alarm, 2. Timeout Alarm, 3. Success Alarm, 4. Baseline Violation, 5. Baseline Warning, 6. Baseline Task Failure (default is 1. Failure Alarm)Note: This field may return null, indicating no valid value. +* `alarm_ways` - (Optional, Set) Alarm Methods, 1. Email, 2. SMS, 3. WeChat, 4. Voice, 5. Enterprise WeChat, 6. HTTP, 7. Enterprise WeChat Group; Alarm method code list (default is 1. Email)Note: This field may return null, indicating no valid value. +* `creator_id` - (Optional, String) Creator NameNote: This field may return null, indicating no valid value. +* `creator` - (Optional, String) Creator UINNote: This field may return null, indicating no valid value. +* `ext_info` - (Optional, String) Extended Information, 1. Estimated Runtime (default), 2. Estimated Completion Time, 3. Estimated Scheduling Time, 4. Incomplete within the Cycle; Value Types: 1. Specified Value, 2. Historical Average (default is 1. Specified Value)Note: This field may return null, indicating no valid value. +* `monitor_object_ids` - (Optional, Set) Monitoring ObjectsNote: This field may return null, indicating no valid value. +* `monitor_type` - (Optional, Int) Monitoring Type, 1. Task, 2. Workflow, 3. Project, 4. Baseline (default is 1. Task)Note: This field may return null, indicating no valid value. +* `project_id` - (Optional, String) Project NameNote: This field may return null, indicating no valid value. +* `rule_name` - (Optional, String) Rule NameNote: This field may return null, indicating no valid value. + +The `promise_tasks` object supports the following: + +* `project_id` - (Optional, String) Project ID. +* `task_cycle` - (Optional, String) Task Scheduling Cycle. +* `task_id` - (Optional, String) Task ID. +* `task_in_charge_name` - (Optional, String) Task Owner Name. +* `task_in_charge_uin` - (Optional, String) Task Owner ID. +* `task_name` - (Optional, String) Task Name. +* `workflow_id` - (Optional, String) Workflow ID. +* `workflow_name` - (Optional, String) Workflow Name. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `baseline_id` - Baseline ID. + + +## Import + +wedata baseline can be imported using the id, e.g. + +``` +terraform import tencentcloud_wedata_baseline.example 1927766435649077248#2 +``` + diff --git a/config/docs/r/wedata_datasource.html.markdown b/config/docs/r/wedata_datasource.html.markdown new file mode 100644 index 0000000..fb3d41d --- /dev/null +++ b/config/docs/r/wedata_datasource.html.markdown @@ -0,0 +1,70 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_datasource" +sidebar_current: "docs-tencentcloud-resource-wedata_datasource" +description: |- + Provides a resource to create a wedata datasource +--- + +# tencentcloud_wedata_datasource + +Provides a resource to create a wedata datasource + +## Example Usage + +```hcl +resource "tencentcloud_wedata_datasource" "example" { + name = "tf_example" + category = "DB" + type = "MYSQL" + owner_project_id = "1612982498218618880" + owner_project_name = "project_demo" + owner_project_ident = "体验项目" + description = "description." + display = "tf_example_demo" + status = 1 + cos_bucket = "wedata-agent-sh-1257305158" + cos_region = "ap-shanghai" + params = jsonencode({ + "connectType" : "public", + "authorityType" : "true", + "deployType" : "CONNSTR_PUBLICDB", + "url" : "jdbc:mysql://1.1.1.1:8080/database", + "username" : "root", + "password" : "password", + "type" : "MYSQL" + }) +} +``` + +## Argument Reference + +The following arguments are supported: + +* `category` - (Required, String) DataSource Category. +* `name` - (Required, String) DataSource Name. +* `owner_project_id` - (Required, String) Owner projectId. +* `owner_project_ident` - (Required, String) Owner Project Ident. +* `owner_project_name` - (Required, String) Owner project name. +* `params` - (Required, String) Params. +* `type` - (Required, String) DataSource Type. +* `biz_params` - (Optional, String) BizParams. +* `cluster_id` - (Optional, String) ClusterId. +* `collect` - (Optional, String) Collect. +* `cos_bucket` - (Optional, String) COSBucket. +* `cos_region` - (Optional, String) Cos region. +* `database_name` - (Optional, String) Dbname. +* `description` - (Optional, String) Description. +* `display` - (Optional, String) Display. +* `instance` - (Optional, String) Instance. +* `status` - (Optional, Int) Status. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `params_out` - Params Out. + + diff --git a/config/docs/r/wedata_dq_rule.html.markdown b/config/docs/r/wedata_dq_rule.html.markdown new file mode 100644 index 0000000..ab9e5cd --- /dev/null +++ b/config/docs/r/wedata_dq_rule.html.markdown @@ -0,0 +1,127 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_dq_rule" +sidebar_current: "docs-tencentcloud-resource-wedata_dq_rule" +description: |- + Provides a resource to create a wedata dq_rule +--- + +# tencentcloud_wedata_dq_rule + +Provides a resource to create a wedata dq_rule + +## Example Usage + +```hcl +resource "tencentcloud_wedata_dq_rule" "example" { + project_id = "1948767646355341312" + rule_group_id = 312 + rule_template_id = 1 + name = "tf_example" + table_id = "N85hbsh5QQ2VLHL2iOUVeQ" + type = 1 + source_object_data_type_name = "table" + source_object_value = "表" + condition_type = 1 + compare_rule { + items { + compare_type = 1 + operator = "==" + value_list { + value_type = 3 + value = "100" + } + } + } + alarm_level = 1 + description = "description." +} +``` + +## Argument Reference + +The following arguments are supported: + +* `alarm_level` - (Required, Int) Alarm trigger levels 1. Low, 2. Medium, 3. High. +* `compare_rule` - (Required, List) Alarm trigger condition. +* `condition_type` - (Required, Int) Detection scope 1. Full Table 2. Conditional scan. +* `name` - (Required, String) Rule name. +* `project_id` - (Required, String) Project id. +* `rule_template_id` - (Required, Int) Rule template id. +* `source_object_data_type_name` - (Required, String) Source field type. int, string. +* `source_object_value` - (Required, String) Source field name. +* `type` - (Required, Int) Rule Type 1. System Template, 2. Custom Template, 3. Custom SQL. +* `condition_expression` - (Optional, String) Condition scans WHERE condition expressions. +* `custom_sql` - (Optional, String) Custom sql. +* `description` - (Optional, String) Rule description. +* `field_config` - (Optional, List) Custom template sql expression field replacement parameters. +* `quality_dim` - (Optional, Int) Rules belong to quality dimensions (1. accuracy, 2. uniqueness, 3. completeness, 4. consistency, 5. timeliness, 6. effectiveness). +* `rel_condition_expr` - (Optional, String) The source field and the target field are associated with a conditional on expression. +* `rule_group_id` - (Optional, Int) Rule group id. +* `source_engine_types` - (Optional, Set: [`Int`]) List of execution engines supported by this rule. +* `table_id` - (Optional, String) Table id. +* `target_condition_expr` - (Optional, String) Target filter condition expression. +* `target_database_id` - (Optional, String) Target database id. +* `target_object_value` - (Optional, String) Target field name CITY. +* `target_table_id` - (Optional, String) Target table id. + +The `compare_rule` object supports the following: + +* `cycle_step` - (Optional, Int) Periodic Indicates the default period of a template, in secondsNote: This field may return null, indicating that a valid value cannot be obtained. +* `items` - (Optional, List) Comparison condition listNote: This field may return null, indicating that a valid value cannot be obtained. + +The `field_config` object supports the following: + +* `field_data_type` - (Optional, String) Field typeNote: This field may return null, indicating that a valid value cannot be obtained. +* `field_key` - (Optional, String) Field keyNote: This field may return null, indicating that a valid value cannot be obtained. +* `field_value` - (Optional, String) Field valueNote: This field may return null, indicating that a valid value cannot be obtained. + +The `field_config` object supports the following: + +* `table_config` - (Optional, List) Library table variableNote: This field may return null, indicating that a valid value cannot be obtained. +* `where_config` - (Optional, List) Where variableNote: This field may return null, indicating that a valid value cannot be obtained. + +The `items` object supports the following: + +* `compare_type` - (Optional, Int) Comparison type 1. Fixed value 2. Fluctuating value 3. Comparison of value range 4. Enumeration range comparison 5. Do not compareNote: This field may return null, indicating that a valid value cannot be obtained. +* `operator` - (Optional, String) Comparison operation type &lt; &lt;= == =&gt; &gt;Note: This field may return null, indicating that a valid value cannot be obtained. +* `value_compute_type` - (Optional, Int) Quality statistics Type 1. Absolute value 2. Increase 3. Decrease 4. C contains 5. N C does not containNote: This field may return null, indicating that a valid value cannot be obtained. +* `value_list` - (Optional, List) Compare the threshold listNote: This field may return null, indicating that a valid value cannot be obtained. + +The `table_config` object supports the following: + +* `database_id` - (Optional, String) Database idNote: This field may return null, indicating that a valid value cannot be obtained. +* `database_name` - (Optional, String) Database nameNote: This field may return null, indicating that a valid value cannot be obtained. +* `field_config` - (Optional, List) Field variableNote: This field may return null, indicating that a valid value cannot be obtained. +* `table_id` - (Optional, String) Table idNote: This field may return null, indicating that a valid value cannot be obtained. +* `table_key` - (Optional, String) Table keyNote: This field may return null, indicating that a valid value cannot be obtained. +* `table_name` - (Optional, String) Table nameNote: This field may return null, indicating that a valid value cannot be obtained. + +The `value_list` object supports the following: + +* `value_type` - (Optional, Int) Threshold type 1. Low threshold 2. High threshold 3. Common threshold 4. Enumerated valueNote: This field may return null, indicating that a valid value cannot be obtained. +* `value` - (Optional, String) Threshold valueNote: This field may return null, indicating that a valid value cannot be obtained. + +The `where_config` object supports the following: + +* `field_data_type` - (Optional, String) Field typeNote: This field may return null, indicating that a valid value cannot be obtained. +* `field_key` - (Optional, String) Field keyNote: This field may return null, indicating that a valid value cannot be obtained. +* `field_value` - (Optional, String) Field valueNote: This field may return null, indicating that a valid value cannot be obtained. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `rule_id` - Rule ID. + + +## Import + +wedata dq_rule can be imported using the id, e.g. + +``` +terraform import tencentcloud_wedata_dq_rule.example 1948767646355341312#894 +``` + diff --git a/config/docs/r/wedata_dq_rule_template.html.markdown b/config/docs/r/wedata_dq_rule_template.html.markdown new file mode 100644 index 0000000..8c65f60 --- /dev/null +++ b/config/docs/r/wedata_dq_rule_template.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_dq_rule_template" +sidebar_current: "docs-tencentcloud-resource-wedata_dq_rule_template" +description: |- + Provides a resource to create a wedata dq_rule_template +--- + +# tencentcloud_wedata_dq_rule_template + +Provides a resource to create a wedata dq_rule_template + +## Example Usage + +```hcl +resource "tencentcloud_wedata_dq_rule_template" "example" { + type = 2 + name = "tf_example" + quality_dim = 1 + source_object_type = 2 + description = "description." + source_engine_types = [2] + multi_source_flag = true + sql_expression = "c2VsZWN0" + project_id = "1948767646355341312" + where_flag = true +} +``` + +## Argument Reference + +The following arguments are supported: + +* `multi_source_flag` - (Required, Bool) Whether to associate other tables. +* `name` - (Required, String) Template name. +* `project_id` - (Required, String) Project id. +* `quality_dim` - (Required, Int) Quality detection dimension 1. Accuracy 2. Uniqueness 3. Completeness 4. Consistency 5. Timeliness 6. effectiveness. +* `source_engine_types` - (Required, Set: [`Int`]) Type of the engine on the source end. +* `source_object_type` - (Required, Int) Source end data object type 1. Constant 2. Offline table level 2. Offline field level. +* `sql_expression` - (Required, String) SQL expression. +* `type` - (Required, Int) Template Type 1. System Template 2. User-defined template. +* `where_flag` - (Required, Bool) Add where parameter or not. +* `description` - (Optional, String) Template description. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `template_id` - Template ID. + + +## Import + +wedata dq_rule_template can be imported using the id, e.g. + +``` +terraform import tencentcloud_wedata_dq_rule_template.example 1948767646355341312#9480 +``` + diff --git a/config/docs/r/wedata_function.html.markdown b/config/docs/r/wedata_function.html.markdown new file mode 100644 index 0000000..63f6d00 --- /dev/null +++ b/config/docs/r/wedata_function.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_function" +sidebar_current: "docs-tencentcloud-resource-wedata_function" +description: |- + Provides a resource to create a wedata function +--- + +# tencentcloud_wedata_function + +Provides a resource to create a wedata function + +## Example Usage + +```hcl +resource "tencentcloud_wedata_function" "example" { + type = "HIVE" + kind = "ANALYSIS" + name = "tf_example" + cluster_identifier = "emr-m6u3qgk0" + db_name = "tf_db_example" + project_id = "1612982498218618880" + class_name = "tf_class_example" + resource_list { + path = "/wedata-demo-1314991481/untitled3-1.0-SNAPSHOT.jar" + name = "untitled3-1.0-SNAPSHOT.jar" + id = "5b28bcdf-a0e6-4022-927d-927d399c4593" + type = "cos" + } + description = "description." + usage = "usage info." + param_desc = "param info." + return_desc = "return value info." + example = "example info." + comment = "V1" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `class_name` - (Required, String) Class name of function entry. +* `cluster_identifier` - (Required, String) Cluster ID. +* `comment` - (Required, String) Comment. +* `db_name` - (Required, String) Database name. +* `description` - (Required, String) Description of the function. +* `example` - (Required, String) Example of the function. +* `kind` - (Required, String) Function Kind, Enum: ANALYSIS, ENCRYPTION, AGGREGATE, LOGIC, DATE_AND_TIME, MATH, CONVERSION, STRING, IP_AND_DOMAIN, WINDOW, OTHER. +* `name` - (Required, String) Function Name. +* `param_desc` - (Required, String) Description of the Parameter. +* `project_id` - (Required, String) Project ID. +* `resource_list` - (Required, List) Resource of the function, stored in WeData COS(.jar,...). +* `return_desc` - (Required, String) Description of the Return value. +* `type` - (Required, String) Function Type, Enum: HIVE, SPARK, DLC. +* `usage` - (Required, String) Usage of the function. + +The `resource_list` object supports the following: + +* `name` - (Required, String) Resource Name. +* `path` - (Required, String) Resource Path. +* `id` - (Optional, String) Resource ID. +* `md5` - (Optional, String) Resource MD5 Value. +* `type` - (Optional, String) Resource Type. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `function_id` - Function ID. + + diff --git a/config/docs/r/wedata_integration_offline_task.html.markdown b/config/docs/r/wedata_integration_offline_task.html.markdown new file mode 100644 index 0000000..5cc6b16 --- /dev/null +++ b/config/docs/r/wedata_integration_offline_task.html.markdown @@ -0,0 +1,191 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_integration_offline_task" +sidebar_current: "docs-tencentcloud-resource-wedata_integration_offline_task" +description: |- + Provides a resource to create a wedata integration_offline_task +--- + +# tencentcloud_wedata_integration_offline_task + +Provides a resource to create a wedata integration_offline_task + +## Example Usage + +```hcl +resource "tencentcloud_wedata_integration_offline_task" "example" { + project_id = "1612982498218618880" + cycle_step = 1 + delay_time = 0 + end_time = "2099-12-31 00:00:00" + notes = "terraform example demo." + start_time = "2023-12-31 00:00:00" + task_name = "tf_example" + task_action = "2" + task_mode = "1" + + task_info { + executor_id = "20230313175748567418" + config { + name = "Args" + value = "args" + } + config { + name = "dirtyDataThreshold" + value = "0" + } + config { + name = "concurrency" + value = "1" + } + config { + name = "syncRateLimitUnit" + value = "0" + } + ext_config { + name = "TaskAlarmRegularList" + value = "73" + } + incharge = "demo" + offline_task_add_entity { + cycle_type = 3 + crontab_expression = "0 0 1 * * ?" + retry_wait = 5 + retriable = 1 + try_limit = 5 + self_depend = 1 + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cycle_step` - (Required, Int) Interval time of scheduling, the minimum value: 1. +* `delay_time` - (Required, Int) Execution time, unit is minutes, only available for day/week/month/year scheduling. For example, daily scheduling is executed once every day at 02:00, and the delayTime is 120 minutes. +* `end_time` - (Required, String) Effective end time, the format is yyyy-MM-dd HH:mm:ss. +* `notes` - (Required, String) Description information. +* `project_id` - (Required, String) Project ID. +* `start_time` - (Required, String) Effective start time, the format is yyyy-MM-dd HH:mm:ss. +* `task_action` - (Required, String) Scheduling configuration: flexible period configuration, only available for hourly/weekly/monthly/yearly scheduling. If the hourly task is specified to run at 0:00, 3:00 and 4:00 every day, it is 0,3,4. +* `task_info` - (Required, List) Task Information. +* `task_mode` - (Required, String) Task display mode, 0: canvas mode, 1: form mode. +* `task_name` - (Required, String) Task name. + +The `config` object supports the following: + +* `name` - (Optional, String) Configuration name. +* `value` - (Optional, String) Configuration value. + +The `execute_context` object supports the following: + +* `name` - (Optional, String) Configuration name. +* `value` - (Optional, String) Configuration value. + +The `ext_config` object supports the following: + +* `name` - (Optional, String) Configuration name. +* `value` - (Optional, String) Configuration value. + +The `mappings` object supports the following: + +* `ext_config` - (Optional, List) Node extension configuration information. +* `schema_mappings` - (Optional, List) Schema mapping information. +* `sink_id` - (Optional, String) Sink node ID. +* `source_id` - (Optional, String) Source node ID. +* `source_schema` - (Optional, List) Source node schema information. + +The `offline_task_add_entity` object supports the following: + +* `crontab_expression` - (Optional, String) Crontab expression. +* `cycle_type` - (Optional, Int) Scheduling type, 0: crontab type, 1: minutes, 2: hours, 3: days, 4: weeks, 5: months, 6: one-time, 7: user-driven, 10: elastic period (week), 11: elastic period (month), 12: year, 13: instant trigger. +* `execution_end_time` - (Optional, String) Scheduling execution end time. +* `execution_start_time` - (Optional, String) Scheduling execution start time. +* `retriable` - (Optional, Int) Whether to retry. +* `retry_wait` - (Optional, Int) Retry waiting time, unit is minutes. +* `self_depend` - (Optional, Int) Self-dependent rules, 1: Ordered serial one at a time, queued execution, 2: Unordered serial one at a time, not queued execution, 3: Parallel, multiple at once. +* `try_limit` - (Optional, Int) Number of retries. + +The `properties` object supports the following: + +* `name` - (Optional, String) Attributes name. +* `value` - (Optional, String) Attributes value. + +The `schema_mappings` object supports the following: + +* `sink_schema_id` - (Required, String) Schema ID from sink node. +* `source_schema_id` - (Required, String) Schema ID from source node. + +The `source_schema` object supports the following: + +* `id` - (Required, String) Schema ID. +* `name` - (Required, String) Schema name. +* `type` - (Required, String) Schema type. +* `alias` - (Optional, String) Schema alias. +* `comment` - (Optional, String) Schema comment. +* `properties` - (Optional, List) Schema extended attributes. +* `value` - (Optional, String) Schema value. + +The `task_info` object supports the following: + +* `app_id` - (Optional, String) User App Id. +* `config` - (Optional, List) Task configuration. +* `create_time` - (Optional, String) Create time. +* `creator_uin` - (Optional, String) Creator User ID. +* `data_proxy_url` - (Optional, Set) Data proxy url. +* `execute_context` - (Optional, List) Execute context. +* `executor_group_name` - (Optional, String) Executor group name. +* `executor_id` - (Optional, String) Executor resource ID. +* `ext_config` - (Optional, List) Node extension configuration information. +* `has_version` - (Optional, Bool) Whether the task been submitted. +* `in_long_manager_url` - (Optional, String) InLong manager url. +* `in_long_manager_version` - (Optional, String) InLong manager version. +* `in_long_stream_id` - (Optional, String) InLong stream id. +* `incharge` - (Optional, String) Incharge user. +* `input_datasource_type` - (Optional, String) Input datasource type. +* `instance_version` - (Optional, Int) Instance version. +* `last_run_time` - (Optional, String) The last time the task was run. +* `locked` - (Optional, Bool) Whether the task been locked. +* `locker` - (Optional, String) User locked task. +* `mappings` - (Optional, List) Node mapping. +* `num_records_in` - (Optional, Int) Number of reads. +* `num_records_out` - (Optional, Int) Number of writes. +* `num_restarts` - (Optional, Int) Times of restarts. +* `offline_task_add_entity` - (Optional, List) Offline task scheduling configuration. +* `operator_uin` - (Optional, String) Operator User ID. +* `output_datasource_type` - (Optional, String) Output datasource type. +* `owner_uin` - (Optional, String) Owner User ID. +* `read_phase` - (Optional, Int) Reading stage, 0: full amount, 1: partial full amount, 2: all incremental. +* `reader_delay` - (Optional, Float64) Read latency. +* `running_cu` - (Optional, Float64) The amount of resources consumed by real-time task. +* `schedule_task_id` - (Optional, String) Task scheduling id (job id such as oceanus or us). +* `status` - (Optional, Int) Task status 1. Not started | Task initialization, 2. Task starting, 3. Running, 4. Paused, 5. Task stopping, 6. Stopped, 7. Execution failed, 8. deleted, 9. Locked, 404. unknown status. +* `stop_time` - (Optional, String) The time the task was stopped. +* `submit` - (Optional, Bool) Whether the task version has been submitted for operation and maintenance. +* `switch_resource` - (Optional, Int) Resource tiering status, 0: in progress, 1: successful, 2: failed. +* `sync_type` - (Optional, Int) Synchronization type: 1. Whole database synchronization, 2. Single table synchronization. +* `task_alarm_regular_list` - (Optional, Set) Task alarm regular. +* `task_group_id` - (Optional, String) Inlong Task Group ID. +* `task_mode` - (Optional, String) Task display mode, 0: canvas mode, 1: form mode. +* `update_time` - (Optional, String) Update time. +* `workflow_id` - (Optional, String) The workflow id to which the task belongs. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `task_id` - Task ID. + + +## Import + +wedata integration_offline_task can be imported using the id, e.g. + +``` +terraform import tencentcloud_wedata_integration_offline_task.example 1612982498218618880#20231102200955095 +``` + diff --git a/config/docs/r/wedata_integration_realtime_task.html.markdown b/config/docs/r/wedata_integration_realtime_task.html.markdown new file mode 100644 index 0000000..bdaf0c7 --- /dev/null +++ b/config/docs/r/wedata_integration_realtime_task.html.markdown @@ -0,0 +1,216 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_integration_realtime_task" +sidebar_current: "docs-tencentcloud-resource-wedata_integration_realtime_task" +description: |- + Provides a resource to create a wedata integration_realtime_task +--- + +# tencentcloud_wedata_integration_realtime_task + +Provides a resource to create a wedata integration_realtime_task + +## Example Usage + +```hcl +resource "tencentcloud_wedata_integration_realtime_task" "example" { + project_id = "1612982498218618880" + task_name = "tf_example" + task_mode = "1" + description = "description." + sync_type = 1 + task_info { + incharge = "100028439226" + executor_id = "20230313175748567418" + config { + name = "concurrency" + value = "1" + } + config { + name = "TaskManager" + value = "1" + } + config { + name = "JobManager" + value = "1" + } + config { + name = "TolerateDirtyData" + value = "0" + } + config { + name = "CheckpointingInterval" + value = "1" + } + config { + name = "CheckpointingIntervalUnit" + value = "min" + } + config { + name = "RestartStrategyFixedDelayAttempts" + value = "-1" + } + config { + name = "ResourceAllocationType" + value = "0" + } + config { + name = "TaskAlarmRegularList" + value = "35" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Required, String) Project ID. +* `sync_type` - (Required, Int) Synchronization type: 1. Whole database synchronization, 2. Single table synchronization. +* `task_info` - (Required, List) Task Information. +* `task_mode` - (Required, String) Task display mode, 0: canvas mode, 1: form mode. +* `task_name` - (Required, String) Task name. +* `description` - (Optional, String) Description information. + +The `config` object supports the following: + +* `name` - (Optional, String) Configuration name. +* `value` - (Optional, String) Configuration value. + +The `execute_context` object supports the following: + +* `name` - (Optional, String) Configuration name. +* `value` - (Optional, String) Configuration value. + +The `ext_config` object supports the following: + +* `name` - (Optional, String) Configuration name. +* `value` - (Optional, String) Configuration value. + +The `mappings` object supports the following: + +* `ext_config` - (Optional, List) Node extension configuration information. +* `schema_mappings` - (Optional, List) Schema mapping information. +* `sink_id` - (Optional, String) Sink node ID. +* `source_id` - (Optional, String) Source node ID. +* `source_schema` - (Optional, List) Source node schema information. + +The `node_mapping` object supports the following: + +* `ext_config` - (Optional, List) Node extension configuration information. +* `schema_mappings` - (Optional, List) Schema mapping information. +* `sink_id` - (Optional, String) Sink node ID. +* `source_id` - (Optional, String) Source node ID. +* `source_schema` - (Optional, List) Source node schema information. + +The `nodes` object supports the following: + +* `app_id` - (Optional, String) User App Id. +* `config` - (Optional, List) Node configuration information. +* `create_time` - (Optional, String) Create time. +* `creator_uin` - (Optional, String) Creator User ID. +* `data_source_type` - (Optional, String) Data source type: MYSQL, POSTGRE, ORACLE, SQLSERVER, FTP, HIVE, HDFS, ICEBERG, KAFKA, HBASE, SPARK, TBASE, DB2, DM, GAUSSDB, GBASE, IMPALA, ES, S3_DATAINSIGHT, GREENPLUM, PHOENIX, SAP_HANA, SFTP, OCEANBASE, CLICKHOUSE, KUDU, VERTICA, REDIS, COS, DLC, DORIS, CKAFKA, DTS_KAFKA, S3, CDW, TDSQLC, TDSQL, MONGODB, SYBASE, REST_API, StarRocks, TCHOUSE_X. +* `datasource_id` - (Optional, String) Datasource ID. +* `description` - (Optional, String) Node Description. +* `ext_config` - (Optional, List) Node extension configuration information. +* `id` - (Optional, String) Node ID. +* `name` - (Optional, String) Node Name. +* `node_mapping` - (Optional, List) Node mapping. +* `node_type` - (Optional, String) Node type: INPUT,OUTPUT,JOIN,FILTER,TRANSFORM. +* `operator_uin` - (Optional, String) Operator User ID. +* `owner_uin` - (Optional, String) Owner User ID. +* `project_id` - (Optional, String) Project ID. +* `schema` - (Optional, List) Schema information. +* `task_id` - (Optional, String) The task id to which the node belongs. +* `update_time` - (Optional, String) Update time. + +The `properties` object supports the following: + +* `name` - (Optional, String) Attributes name. +* `value` - (Optional, String) Attributes value. + +The `schema_mappings` object supports the following: + +* `sink_schema_id` - (Required, String) Schema ID from sink node. +* `source_schema_id` - (Required, String) Schema ID from source node. + +The `schema` object supports the following: + +* `id` - (Required, String) Schema ID. +* `name` - (Required, String) Schema name. +* `type` - (Required, String) Schema type. +* `alias` - (Optional, String) Schema alias. +* `comment` - (Optional, String) Schema comment. +* `properties` - (Optional, List) Schema extended attributes. +* `value` - (Optional, String) Schema value. + +The `source_schema` object supports the following: + +* `id` - (Required, String) Schema ID. +* `name` - (Required, String) Schema name. +* `type` - (Required, String) Schema type. +* `alias` - (Optional, String) Schema alias. +* `comment` - (Optional, String) Schema comment. +* `properties` - (Optional, List) Schema extended attributes. +* `value` - (Optional, String) Schema value. + +The `task_info` object supports the following: + +* `app_id` - (Optional, String) User App Id. +* `config` - (Optional, List) Task configuration. +* `create_time` - (Optional, String) Create time. +* `creator_uin` - (Optional, String) Creator User ID. +* `data_proxy_url` - (Optional, Set) Data proxy url. +* `execute_context` - (Optional, List) Execute context. +* `executor_group_name` - (Optional, String) Executor group name. +* `executor_id` - (Optional, String) Executor resource ID. +* `ext_config` - (Optional, List) Node extension configuration information. +* `has_version` - (Optional, Bool) Whether the task been submitted. +* `in_long_manager_url` - (Optional, String) InLong manager url. +* `in_long_manager_version` - (Optional, String) InLong manager version. +* `in_long_stream_id` - (Optional, String) InLong stream id. +* `incharge` - (Optional, String) Incharge user. +* `input_datasource_type` - (Optional, String) Input datasource type. +* `instance_version` - (Optional, Int) Instance version. +* `last_run_time` - (Optional, String) The last time the task was run. +* `locked` - (Optional, Bool) Whether the task been locked. +* `locker` - (Optional, String) User locked task. +* `mappings` - (Optional, List) Node mapping. +* `nodes` - (Optional, List) Task Node Information. +* `num_records_in` - (Optional, Int) Number of reads. +* `num_records_out` - (Optional, Int) Number of writes. +* `num_restarts` - (Optional, Int) Times of restarts. +* `operator_uin` - (Optional, String) Operator User ID. +* `output_datasource_type` - (Optional, String) Output datasource type. +* `owner_uin` - (Optional, String) Owner User ID. +* `read_phase` - (Optional, Int) Reading stage, 0: full amount, 1: partial full amount, 2: all incremental. +* `reader_delay` - (Optional, Float64) Read latency. +* `running_cu` - (Optional, Float64) The amount of resources consumed by real-time task. +* `schedule_task_id` - (Optional, String) Task scheduling id (job id such as oceanus or us). +* `status` - (Optional, Int) Task status 1. Not started | Task initialization, 2. Task starting, 3. Running, 4. Paused, 5. Task stopping, 6. Stopped, 7. Execution failed, 8. deleted, 9. Locked, 404. unknown status. +* `stop_time` - (Optional, String) The time the task was stopped. +* `submit` - (Optional, Bool) Whether the task version has been submitted for operation and maintenance. +* `switch_resource` - (Optional, Int) Resource tiering status, 0: in progress, 1: successful, 2: failed. +* `task_alarm_regular_list` - (Optional, Set) Task alarm regular. +* `task_group_id` - (Optional, String) Inlong Task Group ID. +* `update_time` - (Optional, String) Update time. +* `workflow_id` - (Optional, String) The workflow id to which the task belongs. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `task_id` - Task ID. + + +## Import + +wedata integration_realtime_task can be imported using the id, e.g. + +``` +terraform import tencentcloud_wedata_integration_realtime_task.example 1776563389209296896#h9d39630a-ae45-4460-90b2-0b093cbfef5d +``` + diff --git a/config/docs/r/wedata_integration_task_node.html.markdown b/config/docs/r/wedata_integration_task_node.html.markdown new file mode 100644 index 0000000..6805c18 --- /dev/null +++ b/config/docs/r/wedata_integration_task_node.html.markdown @@ -0,0 +1,161 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_integration_task_node" +sidebar_current: "docs-tencentcloud-resource-wedata_integration_task_node" +description: |- + Provides a resource to create a wedata integration_task_node +--- + +# tencentcloud_wedata_integration_task_node + +Provides a resource to create a wedata integration_task_node + +## Example Usage + +```hcl +resource "tencentcloud_wedata_integration_task_node" "example" { + project_id = "1612982498218618880" + task_id = "20231022181114990" + name = "tf_example1" + node_type = "INPUT" + data_source_type = "MYSQL" + task_type = 202 + task_mode = 2 + node_info { + datasource_id = "5085" + config { + name = "Type" + value = "MYSQL" + } + config { + name = "splitPk" + value = "id" + } + config { + name = "PrimaryKey" + value = "id" + } + config { + name = "isNew" + value = "true" + } + config { + name = "PrimaryKey_INPUT_SYMBOL" + value = "input" + } + config { + name = "splitPk_INPUT_SYMBOL" + value = "input" + } + config { + name = "Database" + value = "demo_mysql" + } + config { + name = "TableNames" + value = "users" + } + config { + name = "SiblingNodes" + value = "[]" + } + schema { + id = "471331072" + name = "id" + type = "INT" + alias = "id" + } + schema { + id = "422052352" + name = "username" + type = "VARCHAR(50)" + alias = "username" + } + } +} +``` + +## Argument Reference + +The following arguments are supported: + +* `data_source_type` - (Required, String) Data source type: MYSQL, POSTGRE, ORACLE, SQLSERVER, FTP, HIVE, HDFS, ICEBERG, KAFKA, HBASE, SPARK, TBASE, DB2, DM, GAUSSDB, GBASE, IMPALA, ES, S3_DATAINSIGHT, GREENPLUM, PHOENIX, SAP_HANA, SFTP, OCEANBASE, CLICKHOUSE, KUDU, VERTICA, REDIS, COS, DLC, DORIS, CKAFKA, DTS_KAFKA, S3, CDW, TDSQLC, TDSQL, MONGODB, SYBASE, REST_API, StarRocks, TCHOUSE_X. +* `name` - (Required, String) Node Name. +* `node_info` - (Required, List) Node information. +* `node_type` - (Required, String) Node type: INPUT, OUTPUT, JOIN, FILTER, TRANSFORM. +* `project_id` - (Required, String) Project ID. +* `task_id` - (Required, String) The task id to which the node belongs. +* `task_mode` - (Required, Int) Task display mode, 0: canvas mode, 1: form mode. +* `task_type` - (Required, Int) Task type, 201: real-time task, 202: offline task. + +The `config` object supports the following: + +* `name` - (Optional, String) Configuration name. +* `value` - (Optional, String) Configuration value. + +The `ext_config` object supports the following: + +* `name` - (Optional, String) Configuration name. +* `value` - (Optional, String) Configuration value. + +The `node_info` object supports the following: + +* `app_id` - (Optional, String) User App Id. +* `config` - (Optional, List) Node configuration information. +* `create_time` - (Optional, String) Create time. +* `creator_uin` - (Optional, String) Creator User ID. +* `datasource_id` - (Optional, String) Datasource ID. +* `ext_config` - (Optional, List) Node extension configuration information. +* `node_mapping` - (Optional, List) Node mapping. +* `operator_uin` - (Optional, String) Operator User ID. +* `owner_uin` - (Optional, String) Owner User ID. +* `schema` - (Optional, List) Schema information. +* `update_time` - (Optional, String) Update time. + +The `node_mapping` object supports the following: + +* `ext_config` - (Optional, List) Node extension configuration information. +* `schema_mappings` - (Optional, List) Schema mapping information. +* `sink_id` - (Optional, String) Sink node ID. +* `source_id` - (Optional, String) Source node ID. +* `source_schema` - (Optional, List) Source node schema information. + +The `properties` object supports the following: + +* `name` - (Optional, String) Attributes name. +* `value` - (Optional, String) Attributes value. + +The `schema_mappings` object supports the following: + +* `sink_schema_id` - (Required, String) Schema ID from sink node. +* `source_schema_id` - (Required, String) Schema ID from source node. + +The `schema` object supports the following: + +* `id` - (Required, String) Schema ID. +* `name` - (Required, String) Schema name. +* `type` - (Required, String) Schema type. +* `alias` - (Optional, String) Schema alias. +* `comment` - (Optional, String) Schema comment. +* `properties` - (Optional, List) Schema extended attributes. +* `value` - (Optional, String) Schema value. + +The `source_schema` object supports the following: + +* `id` - (Required, String) Schema ID. +* `name` - (Required, String) Schema name. +* `type` - (Required, String) Schema type. +* `alias` - (Optional, String) Schema alias. +* `comment` - (Optional, String) Schema comment. +* `properties` - (Optional, List) Schema extended attributes. +* `value` - (Optional, String) Schema value. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `node_id` - Node ID. + + diff --git a/config/docs/r/wedata_resource.html.markdown b/config/docs/r/wedata_resource.html.markdown new file mode 100644 index 0000000..b0ce705 --- /dev/null +++ b/config/docs/r/wedata_resource.html.markdown @@ -0,0 +1,53 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_resource" +sidebar_current: "docs-tencentcloud-resource-wedata_resource" +description: |- + Provides a resource to create a wedata resource +--- + +# tencentcloud_wedata_resource + +Provides a resource to create a wedata resource + +## Example Usage + +```hcl +resource "tencentcloud_wedata_resource" "example" { + file_path = "/datastudio/resource/demo" + project_id = "1612982498218618880" + file_name = "tf_example" + cos_bucket_name = "wedata-demo-1314991481" + cos_region = "ap-guangzhou" + files_size = "8165" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `cos_bucket_name` - (Required, String) Cos bucket name. +* `cos_region` - (Required, String) Cos bucket region. +* `file_name` - (Required, String) File name. +* `file_path` - (Required, String) For file path:/datastudio/resource/projectId/folderName; for folder path:/datastudio/resource/folderName. +* `files_size` - (Required, String) File size. +* `project_id` - (Required, String) Project ID. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `resource_id` - Resource ID. + + +## Import + +wedata resource can be imported using the id, e.g. + +``` +terraform import tencentcloud_wedata_resource.example 1612982498218618880#/datastudio/resource/demo#75431931-7d27-4034-b3de-3dc3348a220e +``` + diff --git a/config/docs/r/wedata_rule_template.html.markdown b/config/docs/r/wedata_rule_template.html.markdown new file mode 100644 index 0000000..fd106b7 --- /dev/null +++ b/config/docs/r/wedata_rule_template.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_rule_template" +sidebar_current: "docs-tencentcloud-resource-wedata_rule_template" +description: |- + Provides a resource to create a wedata rule_template +--- + +# tencentcloud_wedata_rule_template + +Provides a resource to create a wedata rule_template + +## Example Usage + +```hcl +resource "tencentcloud_wedata_rule_template" "rule_template" { + project_id = "1840731346428280832" + type = 2 + name = "tf-test" + quality_dim = 3 + source_object_type = 2 + description = "for tf test" + source_engine_types = [2, 4, 16] + multi_source_flag = false + sql_expression = base64encode("select * from db") + where_flag = false +} +``` + +## Argument Reference + +The following arguments are supported: + +* `project_id` - (Required, String, ForceNew) Project ID. +* `description` - (Optional, String) Description of Template. +* `multi_source_flag` - (Optional, Bool) Whether to associate other library tables. +* `name` - (Optional, String) Template name. +* `quality_dim` - (Optional, Int) Quality inspection dimensions. `1`: Accuracy, `2`: Uniqueness, `3`: Completeness, `4`: Consistency, `5`: Timeliness, `6`: Effectiveness. +* `source_engine_types` - (Optional, Set: [`Int`]) The engine type corresponding to the source. `2`: hive,`4`: spark, `16`: dlc. +* `source_object_type` - (Optional, Int) Source data object type. `1`: Constant, `2`: Offline table level, `3`: Offline field level. +* `sql_expression` - (Optional, String) SQL Expression. +* `type` - (Optional, Int) Template type. `1` means System template, `2` means Custom template. +* `where_flag` - (Optional, Bool) If add where. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. + + + +## Import + +wedata rule_template can be imported using the id, e.g. + +``` +terraform import tencentcloud_wedata_rule_template.rule_template rule_template_id +``` + diff --git a/config/docs/r/wedata_script.html.markdown b/config/docs/r/wedata_script.html.markdown new file mode 100644 index 0000000..fa7b3ae --- /dev/null +++ b/config/docs/r/wedata_script.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Wedata" +layout: "tencentcloud" +page_title: "TencentCloud: tencentcloud_wedata_script" +sidebar_current: "docs-tencentcloud-resource-wedata_script" +description: |- + Provides a resource to create a wedata script +--- + +# tencentcloud_wedata_script + +Provides a resource to create a wedata script + +## Example Usage + +```hcl +resource "tencentcloud_wedata_script" "example" { + file_path = "/datastudio/project/tf_example.sql" + project_id = "1470575647377821696" + bucket_name = "wedata-demo-1257305158" + region = "ap-guangzhou" + file_extension_type = "sql" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `bucket_name` - (Optional, String) Cos bucket name. +* `file_extension_type` - (Optional, String) File Extension Type:jar, sql, zip, py, sh, txt, di, dg, pyspark, kjb, ktr, csv. +* `file_path` - (Optional, String) Cos file path:/datastudio/project/projectId/. +* `project_id` - (Optional, String) Project id. +* `region` - (Optional, String) Cos region. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `id` - ID of the resource. +* `resource_id` - Resource ID. + + +## Import + +wedata script can be imported using the id, e.g. + +``` +terraform import tencentcloud_wedata_script.example 1470575647377821696#/datastudio/project/tf_example.sql#4147824b-7ba2-432b-8a8b-7e747594c926 +``` + diff --git a/config/snippets/tiat-examples.json b/config/snippets/tiat-examples.json index 4c49947..a6210aa 100644 --- a/config/snippets/tiat-examples.json +++ b/config/snippets/tiat-examples.json @@ -1242,7 +1242,7 @@ "example": "resource \"tencentcloud_image\" \"image_snap\" {\n image_name = \"image-snapshot-keep\"\n snapshot_ids = [\"snap-nbp3xy1d\", \"snap-nvzu3dmh\"]\n force_poweroff = true\n image_description = \"create image with snapshot\"\n}\n" }, "tencentcloud_instance": { - "example": "data \"tencentcloud_images\" \"my_favorite_image\" {\n image_type = [\"PUBLIC_IMAGE\"]\n image_name_regex = \"Final\"\n}\n\ndata \"tencentcloud_instance_types\" \"my_favorite_instance_types\" {\n filter {\n name = \"instance-family\"\n values = [\"S1\", \"S2\", \"S3\", \"S4\", \"S5\"]\n }\n\n cpu_core_count = 2\n exclude_sold_out = true\n}\n\ndata \"tencentcloud_availability_zones\" \"my_favorite_zones\" {\n}\n\n// Create VPC resource\nresource \"tencentcloud_vpc\" \"app\" {\n cidr_block = \"10.0.0.0/16\"\n name = \"awesome_app_vpc\"\n}\n\nresource \"tencentcloud_subnet\" \"app\" {\n vpc_id = tencentcloud_vpc.app.id\n availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name\n name = \"awesome_app_subnet\"\n cidr_block = \"10.0.1.0/24\"\n}\n\n// Create a POSTPAID_BY_HOUR CVM instance\nresource \"tencentcloud_instance\" \"cvm_postpaid\" {\n instance_name = \"cvm_postpaid\"\n availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name\n image_id = data.tencentcloud_images.my_favorite_image.images.0.image_id\n instance_type = data.tencentcloud_instance_types.my_favorite_instance_types.instance_types.0.instance_type\n system_disk_type = \"CLOUD_PREMIUM\"\n system_disk_size = 50\n hostname = \"user\"\n project_id = 0\n vpc_id = tencentcloud_vpc.app.id\n subnet_id = tencentcloud_subnet.app.id\n\n data_disks {\n data_disk_type = \"CLOUD_PREMIUM\"\n data_disk_size = 50\n encrypt = false\n }\n\n tags = {\n tagKey = \"tagValue\"\n }\n}\n\n// Create a PREPAID CVM instance\nresource \"tencentcloud_instance\" \"cvm_prepaid\" {\n timeouts {\n create = \"30m\"\n }\n instance_name = \"cvm_prepaid\"\n availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name\n image_id = data.tencentcloud_images.my_favorite_image.images.0.image_id\n instance_type = data.tencentcloud_instance_types.my_favorite_instance_types.instance_types.0.instance_type\n system_disk_type = \"CLOUD_PREMIUM\"\n system_disk_size = 50\n hostname = \"user\"\n project_id = 0\n vpc_id = tencentcloud_vpc.app.id\n subnet_id = tencentcloud_subnet.app.id\n instance_charge_type = \"PREPAID\"\n instance_charge_type_prepaid_period = 1\n instance_charge_type_prepaid_renew_flag = \"NOTIFY_AND_MANUAL_RENEW\"\n data_disks {\n data_disk_type = \"CLOUD_PREMIUM\"\n data_disk_size = 50\n encrypt = false\n }\n force_delete = true\n tags = {\n tagKey = \"tagValue\"\n }\n}\n" + "example": "data \"tencentcloud_images\" \"my_favorite_image\" {\n image_type = [\"PUBLIC_IMAGE\"]\n image_name_regex = \"Final\"\n}\n\ndata \"tencentcloud_instance_types\" \"my_favorite_instance_types\" {\n filter {\n name = \"instance-family\"\n values = [\"S5\"]\n }\n\n cpu_core_count = 2\n exclude_sold_out = true\n}\n\ndata \"tencentcloud_availability_zones_by_product\" \"my_favorite_zones\" {\n product = \"cvm\"\n}\n\n// Create VPC resource\nresource \"tencentcloud_vpc\" \"app\" {\n cidr_block = \"10.0.0.0/16\"\n name = \"awesome_app_vpc\"\n}\n\nresource \"tencentcloud_subnet\" \"app\" {\n vpc_id = tencentcloud_vpc.app.id\n availability_zone = data.tencentcloud_availability_zones_by_product.my_favorite_zones.zones.0.name\n name = \"awesome_app_subnet\"\n cidr_block = \"10.0.1.0/24\"\n}\n\n// Create a POSTPAID_BY_HOUR CVM instance\nresource \"tencentcloud_instance\" \"cvm_postpaid\" {\n instance_name = \"cvm_postpaid\"\n availability_zone = data.tencentcloud_availability_zones_by_product.my_favorite_zones.zones.0.name\n image_id = data.tencentcloud_images.my_favorite_image.images.0.image_id\n instance_type = data.tencentcloud_instance_types.my_favorite_instance_types.instance_types.0.instance_type\n system_disk_type = \"CLOUD_PREMIUM\"\n system_disk_size = 50\n hostname = \"user\"\n project_id = 0\n vpc_id = tencentcloud_vpc.app.id\n subnet_id = tencentcloud_subnet.app.id\n\n data_disks {\n data_disk_type = \"CLOUD_PREMIUM\"\n data_disk_size = 50\n encrypt = false\n }\n\n tags = {\n tagKey = \"tagValue\"\n }\n}\n" }, "tencentcloud_instance_set": { "example": "data \"tencentcloud_images\" \"my_favorite_image\" {\n image_type = [\"PUBLIC_IMAGE\"]\n os_name = \"Tencent Linux release 3.2 (Final)\"\n}\n\ndata \"tencentcloud_instance_types\" \"my_favorite_instance_types\" {\n filter {\n name = \"instance-family\"\n values = [\"S3\"]\n }\n\n cpu_core_count = 1\n memory_size = 1\n}\n\ndata \"tencentcloud_availability_zones\" \"my_favorite_zones\" {\n}\n\n// Create VPC resource\nresource \"tencentcloud_vpc\" \"app\" {\n cidr_block = \"10.0.0.0/16\"\n name = \"awesome_app_vpc\"\n}\n\nresource \"tencentcloud_subnet\" \"app\" {\n vpc_id = tencentcloud_vpc.app.id\n availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name\n name = \"awesome_app_subnet\"\n cidr_block = \"10.0.1.0/24\"\n}\n\n// Create 10 CVM instances to host awesome_app\nresource \"tencentcloud_instance_set\" \"my_awesome_app\" {\n timeouts {\n create = \"5m\"\n read = \"20s\"\n delete = \"1h\"\n }\n\n instance_count = 10\n instance_name = \"awesome_app\"\n availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name\n image_id = data.tencentcloud_images.my_favorite_image.images.0.image_id\n instance_type = data.tencentcloud_instance_types.my_favorite_instance_types.instance_types.0.instance_type\n system_disk_type = \"CLOUD_PREMIUM\"\n system_disk_size = 50\n hostname = \"user\"\n project_id = 0\n vpc_id = tencentcloud_vpc.app.id\n subnet_id = tencentcloud_subnet.app.id\n}\n" diff --git a/package-lock.json b/package-lock.json index e008fc9..aa5c17d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "vscode-tencentcloud-terraform", - "version": "0.0.23", + "version": "0.0.24", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "vscode-tencentcloud-terraform", - "version": "0.0.23", + "version": "0.0.24", "license": "MIT", "dependencies": { "@types/jsdom": "^21.1.4", @@ -20,7 +20,7 @@ "jsdom": "^22.1.0", "lodash": "^4.17.21", "lodash-es": "^4.17.21", - "marked": "^0.3.6", + "marked": "^11.0.1", "opn": "^6.0.0", "reflect-metadata": "^0.1.13", "shared": "^0.2.0", @@ -38,6 +38,7 @@ "@types/fs-extra": "^11.0.1", "@types/glob": "^8.0.1", "@types/lodash": "^4.14.191", + "@types/marked": "^6.0.0", "@types/mocha": "^10.0.1", "@types/node": "16.x", "@types/opn": "^3.0.28", @@ -622,6 +623,16 @@ "integrity": "sha512-BdZ5BCCvho3EIXw6wUCXHe7rS53AIDPLE+JzwgT+OsJk53oBfbSmZZ7CX4VaRoN78N+TJpFi9QPlfIVNmJYWxQ==", "dev": true }, + "node_modules/@types/marked": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/@types/marked/-/marked-6.0.0.tgz", + "integrity": "sha512-jmjpa4BwUsmhxcfsgUit/7A9KbrC48Q0q8KvnY107ogcjGgTFDlIL3RpihNpx2Mu1hM4mdFQjoVc4O6JoGKHsA==", + "deprecated": "This is a stub types definition. marked provides its own type definitions, so you do not need this installed.", + "dev": true, + "dependencies": { + "marked": "*" + } + }, "node_modules/@types/minimatch": { "version": "5.1.2", "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-5.1.2.tgz", @@ -3495,11 +3506,14 @@ } }, "node_modules/marked": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/marked/-/marked-0.3.6.tgz", - "integrity": "sha512-gE75oL01YUIxaBqgeGBuNNd8u0L+H1N6xeW/s+O57o5EC31aPX1M1lD4W9eGyHFJGTwOgMkqzYODZ4yp5w20gQ==", + "version": "11.0.1", + "resolved": "https://registry.npmjs.org/marked/-/marked-11.0.1.tgz", + "integrity": "sha512-P4kDhFEMlvLePBPRwOcMOv6+lYUbhfbSxJFs3Jb4Qx7v6K7l+k8Dxh9CEGfRvK71tL+qIFz5y7Pe4uzt4+/A3A==", "bin": { - "marked": "bin/marked" + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 18" } }, "node_modules/mdurl": { diff --git a/package.json b/package.json index 1c390fe..2ffa7d4 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "vscode-tencentcloud-terraform", "displayName": "Tencent Cloud Terraform", "description": "VS Code extension for developing with Terraform on Tencent Cloud", - "version": "0.0.23", + "version": "0.0.24", "license": "MIT", "publisher": "Tencent-Cloud", "icon": "images/tc-tf-logo.png", @@ -42,6 +42,7 @@ "onCommand:tcTerraform.refresh", "onCommand:tcTerraform.destroy", "onCommand:tcTerraformer.import", + "onCommand:tcTerraform.doc.show", "workspaceContains:**/*.tf", "onLanguage:terraform" ], @@ -53,6 +54,12 @@ "when": "view == tcTerraform.resourcesExplorer.cvm", "group": "navigation" } + ], + "editor/context": [ + { + "command": "tcTerraform.doc.show", + "group": "navigation" + } ] }, "viewsContainers": { @@ -164,12 +171,25 @@ { "command": "tcTerraformer.import", "title": "Import", - "category": "TencentCloud Terraformer" + "category": "Hidden" }, { "command": "tcTerraformer.plan", "title": "Plan", - "category": "TencentCloud Terraformer" + "category": "Hidden" + }, + { + "command": "tcTerraform.doc.show", + "title": "Go to Terraform Definition", + "category": "Hidden" + } + ], + "keybindings": [ + { + "command": "tcTerraform.doc.show", + "key": "ctrl+shift+d", + "mac": "ctrl+shift+d", + "when": "editorTextFocus" } ], "configuration": { @@ -241,6 +261,7 @@ "@types/fs-extra": "^11.0.1", "@types/glob": "^8.0.1", "@types/lodash": "^4.14.191", + "@types/marked": "^6.0.0", "@types/mocha": "^10.0.1", "@types/node": "16.x", "@types/opn": "^3.0.28", @@ -270,7 +291,7 @@ "jsdom": "^22.1.0", "lodash": "^4.17.21", "lodash-es": "^4.17.21", - "marked": "^0.3.6", + "marked": "^11.0.1", "opn": "^6.0.0", "reflect-metadata": "^0.1.13", "shared": "^0.2.0", diff --git a/src/autocomplete/TerraformResDocProvider.ts b/src/autocomplete/TerraformResDocProvider.ts index 089fb29..50ffb4f 100644 --- a/src/autocomplete/TerraformResDocProvider.ts +++ b/src/autocomplete/TerraformResDocProvider.ts @@ -1,28 +1,150 @@ -import { - DefinitionProvider, - TextDocument, - Position, - CancellationToken, - Definition -} from "vscode"; +import * as vscode from "vscode"; import * as _ from "lodash"; -// import * as opn from "opn"; -import opn from "opn"; -import resources from '../../config/tips/tiat-resources.json'; - -const urlPrefix = "https://www.terraform.io"; - -export class TerraformResDocProvider implements DefinitionProvider { - public provideDefinition(document: TextDocument, position: Position, token: CancellationToken): Definition { - const words = document.getWordRangeAtPosition(position); - const resName = document.getText(words); - - const found = _.get(resources, resName); - const urlSuffix = found.url?.toString() || ""; - var target = (urlPrefix + urlSuffix); - if (urlSuffix && target) { - opn(target); +import * as fs from "fs"; +import * as path from "path"; +import { marked } from 'marked'; + +export class TerraformResDocProvider { + // public provideDefinition(document: TextDocument, position: Position, token: CancellationToken): Definition { + // const words = document.getWordRangeAtPosition(position); + // const resName = document.getText(words); + + // const found = _.get(resources, resName); + // const urlSuffix = found.url?.toString() || ""; + // var target = (urlPrefix + urlSuffix); + // if (urlSuffix && target) { + // opn(target); + // } + // return null; + // } + + public static currentProvider: TerraformResDocProvider | undefined; + private readonly _panel: vscode.WebviewPanel; + private readonly _extensionUri: vscode.Uri; + private _disposables: vscode.Disposable[] = []; + public static readonly viewType = 'tcTerraform.doc.show.id'; + private static tempFile: vscode.TextDocument | null = null; + + public static async createOrShow(context: vscode.ExtensionContext, resType: string) { + // If we already have a panel, clean it. + if (TerraformResDocProvider.currentProvider) { + // TerraformResDocProvider.currentProvider._panel.reveal(targetColumn); + TerraformResDocProvider.currentProvider.dispose(); + } + + const column = vscode.window.activeTextEditor + ? vscode.window.activeTextEditor.viewColumn + : undefined; + + const targetColumn = column + 1; + // display the definition beside the current editor-begin++++++ + // Otherwise, create a new panel. + const panel = vscode.window.createWebviewPanel( + TerraformResDocProvider.viewType, + `Doc Definition: ${resType}`, + targetColumn, + getWebviewOptions(context.extensionUri), + ); + // display the definition beside the current editor-end+++++++ + + // construct the _panel + TerraformResDocProvider.currentProvider = new TerraformResDocProvider(panel, context.extensionUri); + const current = TerraformResDocProvider.currentProvider; + const docsRoot = path.join(context.extensionPath, 'config', 'docs', 'r'); + const mdResType = resType.replace('tencentcloud_', ''); + const markdownPath = path.join(docsRoot, `${mdResType}.html.markdown`); + if (!fs.existsSync(markdownPath)) { + console.error('Can not find the markdownFile: %s', markdownPath); + TerraformResDocProvider.currentProvider.dispose(); + return; + } + const markdownFile = fs.readFileSync(markdownPath, 'utf8'); + + let markdown; + try { + const cleanedMarkdownFile = markdownFile.replace(/---[\s\S]*?---/, ''); + markdown = marked(cleanedMarkdownFile); + const htmlMarkdown = htmlTemplate.replace('{{content}}', markdown); + current._panel.webview.html = htmlMarkdown; + } catch (error) { + console.error('Error processing the Markdown file:', error); + return; } - return null; + // Listen for when the panel is disposed + current._panel.onDidDispose(() => { + current.dispose(); + }, null, current._disposables); } -} \ No newline at end of file + + dispose() { + // Close the WebviewPanel + if (this._panel) { + this._panel.dispose(); + } + // Clean up our resources + TerraformResDocProvider.currentProvider = undefined; + while (this._disposables.length) { + const x = this._disposables.pop(); + if (x) { + x.dispose(); + } + } + } + + public constructor(panel?: vscode.WebviewPanel, extensionUri?: vscode.Uri) { + this._panel = panel; + this._extensionUri = extensionUri; + } +} + +function getWebviewOptions(extensionUri: vscode.Uri): vscode.WebviewOptions { + return { + // Enable javascript in the webview + enableScripts: true, + + // And restrict the webview to only loading content from our extension's `media` directory. + localResourceRoots: [vscode.Uri.joinPath(extensionUri, 'media')] + }; +} + +const htmlTemplate = ` + + + + + + + + + {{content}} + + + `; + diff --git a/src/autocomplete/TerraformTipsProvider.ts b/src/autocomplete/TerraformTipsProvider.ts index 8ff455b..75d471e 100644 --- a/src/autocomplete/TerraformTipsProvider.ts +++ b/src/autocomplete/TerraformTipsProvider.ts @@ -213,7 +213,8 @@ export class TerraformTipsProvider implements CompletionItemProvider { for (const element of topLevelTypes) { let topType = element; if (topType.startsWith(line)) { - const c = new CompletionItem(topType, CompletionItemKind.Enum); + const c = new CompletionItem(`${topType}(tencentcloud)`, CompletionItemKind.Enum); + c.insertText = topType; c.sortText = TEXT_MIN_SORT; return [c]; } diff --git a/src/extension.ts b/src/extension.ts index c40b87d..5f11026 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -42,6 +42,15 @@ export async function activate(context: vscode.ExtensionContext) { terraformShellManager.getShell().runTerraformCmd(TerraformCommand.Destroy); })); + // git operations + context.subscriptions.push(vscode.commands.registerCommand('tcTerraform.git.push', async () => { + if (_.isEmpty(vscode.workspace.workspaceFolders)) { + vscode.window.showInformationMessage("Please open a workspace in VS Code first."); + return; + } + await GitUtils.getInstance().submitToGit(); + })); + // terraformer cmd let disposableTferImport = vscode.commands.registerCommand('tcTerraformer.import', async () => { terraformShellManager.getShell().runTerraformCmd(TerraformerCommand.Import); @@ -56,17 +65,38 @@ export async function activate(context: vscode.ExtensionContext) { context.subscriptions.push(disposableTferPlan); // auto-complete - console.log('activate the tips(resource and options) feature'); - const tipsProvider = new TerraformTipsProvider(); + console.log('activate the auto-complete(resource and argument) feature'); const exampleProvider = new autocomplete.TerraformExampleProvider(); + context.subscriptions.push(vscode.languages.registerCompletionItemProvider(TF_MODE, exampleProvider, autocomplete.EXAMPLE_TRIGGER_CHARACTER)); + + // tips + console.log('activate the tips(options and doc) feature'); + const tipsProvider = new TerraformTipsProvider(); context.subscriptions.push( vscode.workspace.onDidChangeTextDocument((event) => { tipsProvider.handleCharacterEvent(event); }) ); context.subscriptions.push(vscode.languages.registerCompletionItemProvider(TF_MODE, tipsProvider, ...TIPS_TRIGGER_CHARACTER)); - context.subscriptions.push(vscode.languages.registerDefinitionProvider(TF_MODE, new TerraformResDocProvider())); - context.subscriptions.push(vscode.languages.registerCompletionItemProvider(TF_MODE, exampleProvider, autocomplete.EXAMPLE_TRIGGER_CHARACTER)); + + context.subscriptions.push(vscode.commands.registerCommand('tcTerraform.doc.show', () => { + const editor = vscode.window.activeTextEditor; + if (!editor) { + return; // no editor opening + } + + // get the words under current selection + const doc = editor.document; + const selection = editor.selection; + const words = doc.getWordRangeAtPosition(selection.start); + const resType = doc.getText(words); + + const regex = /^tencentcloud(?:_[^\s]+)*$/; + if (!regex.test(resType)) { + return; // not match the regex + } + TerraformResDocProvider.createOrShow(context, resType); + })); // example console.log('activate the auto complete(example) feature'); diff --git a/src/utils/gitUtils.ts b/src/utils/gitUtils.ts index ae30f45..28520ac 100644 --- a/src/utils/gitUtils.ts +++ b/src/utils/gitUtils.ts @@ -2,6 +2,7 @@ import * as vscode from 'vscode'; import { exec } from 'child_process'; import path from 'path'; import * as fs from 'fs'; +import * as workspaceUtils from "./workspaceUtils"; export class GitUtils { private static instance: GitUtils; @@ -15,44 +16,36 @@ export class GitUtils { public async submitToGit(): Promise { console.debug("[DEBUG]#### GitUtils submitToGit begin."); - const gitRootPath = vscode.workspace.rootPath; + const activeDocumentPath = workspaceUtils.getActiveEditorPath(); + const gitRootPath = path.dirname(activeDocumentPath); if (!gitRootPath) { vscode.window.showErrorMessage('Please open a workspace folder first!'); return; } - while (true) { - if (fs.existsSync(path.join(gitRootPath, '.git'))) { - vscode.window.showInformationMessage('Trying to fetch from Git, please wait...'); - await this.fetchFromGit(); - break; - } else { - vscode.window.showInformationMessage(`You are not in a git repository yet, trying to clone from your Git repo...`); - await this.cloneFromGit(); - // retry - } + if (fs.existsSync(path.join(gitRootPath, '.git'))) { + vscode.window.showInformationMessage('Trying to fetch from Git, please wait...'); + await this.fetchFromGit(gitRootPath); + } else { + vscode.window.showInformationMessage(`You are not in a git repository yet, trying to clone from your Git repo...`); + await this.cloneFromGit(gitRootPath); } - exec('git add . && git commit -m "committed by VS Code" && git push', { cwd: gitRootPath }, (error, stdout, stderr) => { - if (error) { - vscode.window.showErrorMessage(`Failed to submit code: ${error.message}`); - return; - } - if (stderr) { - vscode.window.showErrorMessage(`Failed to submit code: ${stderr}`); - return; - } - vscode.window.showInformationMessage('Code has been successfully submitted to Git repo!'); - }); - return; + console.debug("[DEBUG]#### GitUtils pushToGit begin."); + try { + const output = await this.gitPush(gitRootPath); + vscode.window.showInformationMessage(`Code has been successfully submitted to Git repo!\nDetail:[${output}]`); + } catch (error) { + vscode.window.showErrorMessage(`Failed to submit code: ${error.message}`); + } } - private async cloneFromGit(): Promise { + private async cloneFromGit(rootPath: string): Promise { console.debug("[DEBUG]#### GitUtils cloneFromGit begin."); - await vscode.window.showInputBox({ prompt: 'Please enter the Git repository URL:' }).then((url) => { + await vscode.window.showInputBox({ prompt: 'Please enter the Git repository URL:' }).then(async (url) => { if (url) { const folderName = url.split('/').pop()?.replace('.git', ''); - const clonePath = vscode.workspace.rootPath ? `${vscode.workspace.rootPath}/${folderName}` : folderName || ''; + const clonePath = rootPath ? `${rootPath}/${folderName}` : folderName || ''; if (fs.existsSync(clonePath)) { console.debug("[DEBUG]#### GitUtils cloneFromGit: clean and remove the clonePath before cloning the repository."); fs.rm(clonePath, { recursive: true }, () => { }); @@ -72,23 +65,50 @@ export class GitUtils { }); } }); - return; } - private async fetchFromGit(): Promise { + private gitPush(rootPath: string): Promise { + return new Promise((resolve, reject) => { + exec('git add . && git commit -m "committed by VS Code" && git push', { cwd: rootPath }, (error, stdout, stderr) => { + if (error) { + reject(error); + return; + } + if (stdout) { + resolve(stdout); + return; + } + if (stderr) { + reject(new Error(stderr)); + } + }); + }); + } + + private gitPull(rootPath: string): Promise { + return new Promise((resolve, reject) => { + exec('git pull', { cwd: rootPath }, (error, stdout, stderr) => { + if (error) { + reject(error); + return; + } + if (stderr) { + reject(new Error(stderr)); + return; + } + resolve(); + }); + }); + } + + private async fetchFromGit(rootPath: string): Promise { console.debug("[DEBUG]#### GitUtils fetchFromGit begin."); - const gitRootPath = vscode.workspace.rootPath; - exec('git pull', { cwd: gitRootPath }, (error, stdout, stderr) => { - if (error) { - vscode.window.showErrorMessage(`Failed to fetch code: ${error.message}`); - return; - } - if (stderr) { - vscode.window.showErrorMessage(`Failed to fetch code: ${stderr}`); - return; - } + try { + await this.gitPull(rootPath); vscode.window.showInformationMessage('Code has been successfully fetched from Git repo!'); - }); + } catch (error) { + vscode.window.showErrorMessage(`Failed to fetch code: ${error.message}`); + } } } diff --git a/src/utils/workspaceUtils.ts b/src/utils/workspaceUtils.ts index 4f668ce..b5c1c7d 100644 --- a/src/utils/workspaceUtils.ts +++ b/src/utils/workspaceUtils.ts @@ -40,3 +40,20 @@ export async function selectWorkspaceFolder(): Promise { } return folder ? folder.uri.fsPath : undefined; } + +export function getActiveEditorPath(): string { + const activeEditor = vscode.window.activeTextEditor; + if (!activeEditor) { + vscode.window.showInformationMessage('No active editor found.'); + return ""; + } + + const activeDocument = activeEditor.document; + if (!activeDocument) { + vscode.window.showInformationMessage('No active document found.'); + return ""; + } + + const activeDocumentPath = activeDocument.uri.fsPath; + return activeDocumentPath; +}