Skip to main content
Version: v1.4

Alibaba Cloud PRIVATE-ZONE

Description

Terraform-based modules are used to create a Private Zone on AliCloud, while you can add records to the Zone and associate it with a VPC.

Specification

NameDescriptionTypeRequiredDefault
adjustment_type(Deprecated from version 1.2.0) The method only used by the simple and step scaling rule to adjust the number of ECS instances. Valid values: QuantityChangeInCapacity, PercentChangeInCapacity and TotalCapacity. Use simple_rule_adjustment_type and step_rule_adjustment_type instead.stringfalse
adjustment_valueThe number of ECS instances to be adjusted in the simple scaling rule. The number of ECS instances to be adjusted in a single scaling activity cannot exceed 500.numberfalse
alarm_descriptionThe description for the alarm.stringfalse
alarm_task_metric_nameThe monitoring index name. Details see [system monitoring index](https://help.aliyun.com/document_detail/141651.htm) and [custom monidoring index](https://www.alibabacloud.com/help/doc-detail/74861.htm).stringfalse
alarm_task_metric_typeThe monitoring type for alarm task. Valid values system, custom. system means the metric data is collected by Aliyun Cloud Monitor Service(CMS); custom means the metric data is upload to CMS by users.stringfalse
alarm_task_nameThe name for alarm task. Default to a random string prefixed with terraform-alarm-task-.stringfalse
alarm_task_settingThe setting of monitoring index setting. It contains the following parameters: period(A reference period used to collect, summary, and compute data. Default to 60 seconds), method(The method used to statistics data, default to Average), threshold(Verify whether the statistics data value of a metric exceeds the specified threshold. Default to 0), comparison_operator(The arithmetic operation to use when comparing the specified method and threshold. Default to >=), trigger_after(You can select one the following options, such as 1, 2, 3, and 5 times. When the value of a metric exceeds the threshold for specified times, an event is triggered, and the specified scaling rule is applied. Default to 3 times.).map(string)false
cooldownThe cooldown time of the simple scaling rule. Valid values: 0 to 86400. Unit: seconds. If not set, the scaling group's cooldown will be used.numberfalse
create_alarm_taskIf true, the module will create a scheduled task for each scaling rule.boolfalse
create_scheduled_taskIf true, the module will create a scheduled task for each scaling rule.boolfalse
create_simple_ruleWhether to create a simple scaling rule in the specified scaling group.boolfalse
create_step_ruleWhether to create a step scaling rule in the specified scaling group.boolfalse
create_target_tracking_ruleWhether to create a target tracking scaling rule in the specified scaling group.boolfalse
disable_scale_inWhether to disable scale-in. This parameter is applicable only to target tracking scaling rules.boolfalse
enable_alarm_taskWhether to enable the alarm task.boolfalse
enable_scheduled_taskWhether to enable the scheduled task.boolfalse
estimated_instance_warmup(Deprecated from version 1.2.0) The warm-up period of the ECS instances. It is applicable to target tracking and step scaling rules. The system adds ECS instances that are in the warm-up state to the scaling group, but does not report monitoring data during the warm-up period to CloudMonitor. Valid values: 0 to 86400. Unit: seconds. Use target_tracking_rule_estimated_instance_warmup and step_rule_estimated_instance_warmup instead.numberfalse
metric_name(Deprecated from version 1.2.0) The monitoring index name. Details see [system monitoring index](https://help.aliyun.com/document_detail/141651.htm) and [custom monidoring index](https://www.alibabacloud.com/help/doc-detail/74861.htm). Use target_tracking_rule_metric_name instead.stringfalse
profile(Deprecated from version 1.1.0) The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable.stringfalse
region(Deprecated from version 1.1.0) The region ID used to launch this module resources. If not set, it will be sourced from followed by ALICLOUD_REGION environment variable and profile.stringfalse
scaling_group_idSpecifying existing autoscaling group ID. If not set, it can be retrieved automatically by specifying filter scaling_group_name_regex.stringfalse
scaling_group_name_regexUsing a name regex to retrieve existing scaling group automactially.stringfalse
scaling_rule_name(Deprecated from version 1.2.0) The name for scaling rule. Default to a random string prefixed with terraform-ess-<rule type>-. Use scaling_simple_rule_name, scaling_target_tracking_rule_name and scaling_step_rule_name instead.stringfalse
scaling_simple_rule_nameThe name for scaling rule. Default to a random string prefixed with terraform-ess-<rule type>-.stringfalse
scaling_step_rule_nameThe name for scaling rule. Default to a random string prefixed with terraform-ess-<rule type>-.stringfalse
scaling_target_tracking_rule_nameThe name for scaling rule. Default to a random string prefixed with terraform-ess-<rule type>-.stringfalse
scheduled_task_descriptionDescription of the scheduled task, which is 2-200 characters (English or Chinese) long.stringfalse
scheduled_task_nameThe name for scheduled task. Default to a random string prefixed with terraform-scheduled-task-.stringfalse
scheduled_task_settingThe setting of running a scheduled task. It contains basic and recurrence setting. Deails see run_at(the time at which the scheduled task is triggered), retry_interval(the time period during which a failed scheduled task is retried, default to 600 seconds), recurrence_type(the recurrence type of the scheduled task: Daily, Weekly, Monthly or Cron, default to empty), recurrence_value(the recurrence frequency of the scheduled task, it must be set when recurrence_type is set) and end_at(the end time after which the scheduled task is no longer repeated. it will ignored if recurrence_type is not set).map(string)false
shared_credentials_file(Deprecated from version 1.1.0) This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used.stringfalse
simple_rule_adjustment_typeThe method only used by the simple and step scaling rule to adjust the number of ECS instances. Valid values: QuantityChangeInCapacity, PercentChangeInCapacity and TotalCapacity.stringfalse
skip_region_validation(Deprecated from version 1.1.0) Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet).boolfalse
step_adjustmentsThe predefined metric to monitor. This parameter is required and applicable only to step scaling rules. Each item contains the following parameters: lower_limit(The lower limit value specified. Valid values: -9.999999E18 to 9.999999E18.), upper_limit(The upper limit value specified. Valid values: -9.999999E18 to 9.999999E18.), adjustment_value(The specified number of ECS instances to be adjusted).list(map(string))false
step_rule_adjustment_typeThe method only used by the simple and step scaling rule to adjust the number of ECS instances. Valid values: QuantityChangeInCapacity, PercentChangeInCapacity and TotalCapacity.stringfalse
step_rule_estimated_instance_warmupThe warm-up period of the ECS instances. It is applicable to target tracking and step scaling rules. The system adds ECS instances that are in the warm-up state to the scaling group, but does not report monitoring data during the warm-up period to CloudMonitor. Valid values: 0 to 86400. Unit: seconds.numberfalse
target_tracking_rule_estimated_instance_warmupThe warm-up period of the ECS instances. It is applicable to target tracking and step scaling rules. The system adds ECS instances that are in the warm-up state to the scaling group, but does not report monitoring data during the warm-up period to CloudMonitor. Valid values: 0 to 86400. Unit: seconds.numberfalse
target_tracking_rule_metric_nameThe predefined metric to monitor. This parameter is required and applicable only to target tracking scaling rules. See valid values: https://www.alibabacloud.com/help/doc-detail/25948.htm.stringfalse
target_valueThe target value of a metric. This parameter is required and applicable only to target tracking scaling rules. It must be greater than 0 and can have a maximum of three decimal places.stringfalse
task_actionsThe list of actions to execute when this alarm transition into an ALARM state.list(string)false
writeConnectionSecretToRefThe secret which the cloud resource connection will be written to.writeConnectionSecretToReffalse

writeConnectionSecretToRef

NameDescriptionTypeRequiredDefault
nameThe secret name which the cloud resource connection will be written to.stringtrue
namespaceThe secret namespace which the cloud resource connection will be written to.stringfalse