EdgeContainerAppProps
Properties for defining a EdgeContainerApp.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-edgecontainerapp
Initializer
import { EdgeContainerAppProps } from '@alicloud/ros-cdk-esa'
const edgeContainerAppProps: EdgeContainerAppProps = { ... }
Properties
| Name | Type | Description |
|---|---|---|
edgeContainerAppName | string | @alicloud/ros-cdk-core.IResolvable | Property edgeContainerAppName: The name of the application. |
servicePort | number | @alicloud/ros-cdk-core.IResolvable | Property servicePort: The server port. |
targetPort | number | @alicloud/ros-cdk-core.IResolvable | Property targetPort: The backend port, which is also the service port of the application. |
healthCheckFailTimes | number | @alicloud/ros-cdk-core.IResolvable | Property healthCheckFailTimes: The number of consecutive failed health checks required for an application to be considered as unhealthy. |
healthCheckHost | string | @alicloud/ros-cdk-core.IResolvable | Property healthCheckHost: The domain name that is used for health checks. |
healthCheckHttpCode | string | @alicloud/ros-cdk-core.IResolvable | Property healthCheckHttpCode: The HTTP status code returned for a successful health check. |
healthCheckInterval | number | @alicloud/ros-cdk-core.IResolvable | Property healthCheckInterval: The interval between two consecutive health checks. |
healthCheckMethod | string | @alicloud/ros-cdk-core.IResolvable | Property healthCheckMethod: The HTTP request method for health checks. |
healthCheckPort | number | @alicloud/ros-cdk-core.IResolvable | Property healthCheckPort: The port used for health checks. |
healthCheckSuccTimes | number | @alicloud/ros-cdk-core.IResolvable | Property healthCheckSuccTimes: The number of consecutive successful health checks required for an application to be considered as healthy. |
healthCheckTimeout | number | @alicloud/ros-cdk-core.IResolvable | Property healthCheckTimeout: The timeout period of a health check response. |
healthCheckType | string | @alicloud/ros-cdk-core.IResolvable | Property healthCheckType: The health check type. |
healthCheckUri | string | @alicloud/ros-cdk-core.IResolvable | Property healthCheckUri: The URI used for health checks. |
remarks | string | @alicloud/ros-cdk-core.IResolvable | Property remarks: The remarks. |
edgeContainerAppNameRequired
public readonly edgeContainerAppName: string | IResolvable;
- Type: string | @alicloud/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.
servicePortRequired
public readonly servicePort: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property servicePort: The server port.
Valid values: 1 to 65535.
targetPortRequired
public readonly targetPort: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property targetPort: The backend port, which is also the service port of the application.
Valid values: 1 to 65535.
healthCheckFailTimesOptional
public readonly healthCheckFailTimes: number | IResolvable;
- Type: number | @alicloud/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.
healthCheckHostOptional
public readonly healthCheckHost: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property healthCheckHost: The domain name that is used for health checks.
This parameter is empty by default.
healthCheckHttpCodeOptional
public readonly healthCheckHttpCode: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property healthCheckHttpCode: The HTTP status code returned for a successful health check.
Valid values: http_2xx (default)http_3xx
healthCheckIntervalOptional
public readonly healthCheckInterval: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property healthCheckInterval: The interval between two consecutive health checks.
Unit: seconds. Valid values: 1 to 50. Default value: 5.
healthCheckMethodOptional
public readonly healthCheckMethod: string | IResolvable;
- Type: string | @alicloud/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.
healthCheckPortOptional
public readonly healthCheckPort: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property healthCheckPort: The port used for health checks.
Valid values: 1 to 65535. Default value: 80.
healthCheckSuccTimesOptional
public readonly healthCheckSuccTimes: number | IResolvable;
- Type: number | @alicloud/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.
healthCheckTimeoutOptional
public readonly healthCheckTimeout: number | IResolvable;
- Type: number | @alicloud/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.
healthCheckTypeOptional
public readonly healthCheckType: string | IResolvable;
- Type: string | @alicloud/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.
healthCheckUriOptional
public readonly healthCheckUri: string | IResolvable;
- Type: string | @alicloud/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
public readonly remarks: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property remarks: The remarks.
This parameter is empty by default.