EdgeContainerAppProps
Properties for defining a EdgeContainerApp.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-edgecontainerapp
Initializer
import ros_cdk_esa
ros_cdk_esa.EdgeContainerAppProps(
edge_container_app_name: typing.Union[str, IResolvable],
service_port: typing.Union[typing.Union[int, float], IResolvable],
target_port: typing.Union[typing.Union[int, float], IResolvable],
health_check_fail_times: typing.Union[typing.Union[int, float], IResolvable] = None,
health_check_host: typing.Union[str, IResolvable] = None,
health_check_http_code: typing.Union[str, IResolvable] = None,
health_check_interval: typing.Union[typing.Union[int, float], IResolvable] = None,
health_check_method: typing.Union[str, IResolvable] = None,
health_check_port: typing.Union[typing.Union[int, float], IResolvable] = None,
health_check_succ_times: typing.Union[typing.Union[int, float], IResolvable] = None,
health_check_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
health_check_type: typing.Union[str, IResolvable] = None,
health_check_uri: typing.Union[str, IResolvable] = None,
remarks: typing.Union[str, IResolvable] = None
)
Properties
| Name | Type | Description |
|---|---|---|
edge_container_app_name | typing.Union[str, ros_cdk_core.IResolvable] | Property edgeContainerAppName: The name of the application. |
service_port | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property servicePort: The server port. |
target_port | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property targetPort: The backend port, which is also the service port of the application. |
health_check_fail_times | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property healthCheckFailTimes: The number of consecutive failed health checks required for an application to be considered as unhealthy. |
health_check_host | typing.Union[str, ros_cdk_core.IResolvable] | Property healthCheckHost: The domain name that is used for health checks. |
health_check_http_code | typing.Union[str, ros_cdk_core.IResolvable] | Property healthCheckHttpCode: The HTTP status code returned for a successful health check. |
health_check_interval | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property healthCheckInterval: The interval between two consecutive health checks. |
health_check_method | typing.Union[str, ros_cdk_core.IResolvable] | Property healthCheckMethod: The HTTP request method for health checks. |
health_check_port | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property healthCheckPort: The port used for health checks. |
health_check_succ_times | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property healthCheckSuccTimes: The number of consecutive successful health checks required for an application to be considered as healthy. |
health_check_timeout | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property healthCheckTimeout: The timeout period of a health check response. |
health_check_type | typing.Union[str, ros_cdk_core.IResolvable] | Property healthCheckType: The health check type. |
health_check_uri | typing.Union[str, ros_cdk_core.IResolvable] | Property healthCheckUri: The URI used for health checks. |
remarks | typing.Union[str, ros_cdk_core.IResolvable] | Property remarks: The remarks. |
edge_container_app_nameRequired
edge_container_app_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property edgeContainerAppName: The name of the application.
The name must start with a lowercase letter and can contain lowercase letters, digits, and hyphens (-). The name must be 6 to 128 characters in length.
service_portRequired
service_port: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property servicePort: The server port.
Valid values: 1 to 65535.
target_portRequired
target_port: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property targetPort: The backend port, which is also the service port of the application.
Valid values: 1 to 65535.
health_check_fail_timesOptional
health_check_fail_times: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property healthCheckFailTimes: The number of consecutive failed health checks required for an application to be considered as unhealthy.
Valid values: 1 to 10. Default value: 5.
health_check_hostOptional
health_check_host: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property healthCheckHost: The domain name that is used for health checks.
This parameter is empty by default.
health_check_http_codeOptional
health_check_http_code: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property healthCheckHttpCode: The HTTP status code returned for a successful health check.
Valid values: http_2xx (default)http_3xx
health_check_intervalOptional
health_check_interval: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property healthCheckInterval: The interval between two consecutive health checks.
Unit: seconds. Valid values: 1 to 50. Default value: 5.
health_check_methodOptional
health_check_method: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property healthCheckMethod: The HTTP request method for health checks.
Valid values: HEAD (default): requests the headers of the resource. GET: requests the specified resource and returns both the headers and entity body.
health_check_portOptional
health_check_port: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property healthCheckPort: The port used for health checks.
Valid values: 1 to 65535. Default value: 80.
health_check_succ_timesOptional
health_check_succ_times: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property healthCheckSuccTimes: The number of consecutive successful health checks required for an application to be considered as healthy.
Valid values: 1 to 10. Default value: 2.
health_check_timeoutOptional
health_check_timeout: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property healthCheckTimeout: The timeout period of a health check response.
If a backend ECS instance does not respond within the specified timeout period, the ECS instance fails the health check. Unit: seconds. Valid values: 1 to 100. Default value: 3.
health_check_typeOptional
health_check_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property healthCheckType: The health check type.
By default, this parameter is left empty. Valid values: l4: Layer 4 health check. l7: Layer 7 health check.
health_check_uriOptional
health_check_uri: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property healthCheckUri: The URI used for health checks.
The URI must be 1 to 80 characters in length. Default value: "/".
remarksOptional
remarks: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property remarks: The remarks.
This parameter is empty by default.