Skip to content

EdgeContainerAppProps

Properties for defining a EdgeContainerApp.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-edgecontainerapp

Initializer

import com.aliyun.ros.cdk.esa.EdgeContainerAppProps;
EdgeContainerAppProps.builder()
    .edgeContainerAppName(java.lang.String)
    .edgeContainerAppName(IResolvable)
    .servicePort(java.lang.Number)
    .servicePort(IResolvable)
    .targetPort(java.lang.Number)
    .targetPort(IResolvable)
//  .healthCheckFailTimes(java.lang.Number)
//  .healthCheckFailTimes(IResolvable)
//  .healthCheckHost(java.lang.String)
//  .healthCheckHost(IResolvable)
//  .healthCheckHttpCode(java.lang.String)
//  .healthCheckHttpCode(IResolvable)
//  .healthCheckInterval(java.lang.Number)
//  .healthCheckInterval(IResolvable)
//  .healthCheckMethod(java.lang.String)
//  .healthCheckMethod(IResolvable)
//  .healthCheckPort(java.lang.Number)
//  .healthCheckPort(IResolvable)
//  .healthCheckSuccTimes(java.lang.Number)
//  .healthCheckSuccTimes(IResolvable)
//  .healthCheckTimeout(java.lang.Number)
//  .healthCheckTimeout(IResolvable)
//  .healthCheckType(java.lang.String)
//  .healthCheckType(IResolvable)
//  .healthCheckUri(java.lang.String)
//  .healthCheckUri(IResolvable)
//  .remarks(java.lang.String)
//  .remarks(IResolvable)
    .build();

Properties

Name Type Description
edgeContainerAppName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property edgeContainerAppName: The name of the application.
servicePort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property servicePort: The server port.
targetPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property targetPort: The backend port, which is also the service port of the application.
healthCheckFailTimes java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckFailTimes: The number of consecutive failed health checks required for an application to be considered as unhealthy.
healthCheckHost java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckHost: The domain name that is used for health checks.
healthCheckHttpCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckHttpCode: The HTTP status code returned for a successful health check.
healthCheckInterval java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckInterval: The interval between two consecutive health checks.
healthCheckMethod java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckMethod: The HTTP request method for health checks.
healthCheckPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckPort: The port used for health checks.
healthCheckSuccTimes java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckSuccTimes: The number of consecutive successful health checks required for an application to be considered as healthy.
healthCheckTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckTimeout: The timeout period of a health check response.
healthCheckType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckType: The health check type.
healthCheckUri java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckUri: The URI used for health checks.
remarks java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property remarks: The remarks.

edgeContainerAppNameRequired

public java.lang.Object getEdgeContainerAppName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getServicePort();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property servicePort: The server port.

Valid values: 1 to 65535.


targetPortRequired

public java.lang.Object getTargetPort();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getHealthCheckFailTimes();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getHealthCheckHost();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property healthCheckHost: The domain name that is used for health checks.

This parameter is empty by default.


healthCheckHttpCodeOptional

public java.lang.Object getHealthCheckHttpCode();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getHealthCheckInterval();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getHealthCheckMethod();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getHealthCheckPort();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property healthCheckPort: The port used for health checks.

Valid values: 1 to 65535. Default value: 80.


healthCheckSuccTimesOptional

public java.lang.Object getHealthCheckSuccTimes();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getHealthCheckTimeout();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getHealthCheckType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getHealthCheckUri();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getRemarks();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property remarks: The remarks.

This parameter is empty by default.