EdgeContainerApp

• Implements: IEdgeContainerApp

This class encapsulates and extends the ROS resource type ALIYUN::ESA::EdgeContainerApp.

Initializers

import ros_cdk_esa
ros_cdk_esa.EdgeContainerApp(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

edge_container_app_name^Required

• 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_port^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property servicePort: The server port.

Valid values: 1 to 65535.

target_port^Required

• 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_times^Optional

• 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_host^Optional

• 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_code^Optional

• 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_interval^Optional

• 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_method^Optional

• 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_port^Optional

• 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_times^Optional

• 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_timeout^Optional

• 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_type^Optional

• 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_uri^Optional

• 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: "/".

remarks^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property remarks: The remarks.

This parameter is empty by default.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_esa
ros_cdk_esa.EdgeContainerApp.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_app_status^Required

attr_app_status: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute AppStatus: The status of the application.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute CreateTime: The time when the application was created.

attr_domain_name^Required

attr_domain_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute DomainName: The domain name that is associated with the application.

If no domain name is associated with the application, the value is an empty string.

attr_edge_container_app_name^Required

attr_edge_container_app_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute EdgeContainerAppName: The name of the application.

attr_gateway_type^Required

attr_gateway_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute GatewayType: The type of the gateway.

attr_health_check_fail_times^Required

attr_health_check_fail_times: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheckFailTimes: TThe number of consecutive failed health checks required for an application to be considered as unhealthy.

attr_health_check_host^Required

attr_health_check_host: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheckHost: The domain name that is used for health checks.

attr_health_check_http_code^Required

attr_health_check_http_code: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheckHttpCode: The HTTP status code returned for a successful health check.

attr_health_check_interval^Required

attr_health_check_interval: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheckInterval: The interval between two consecutive health checks.

Unit: seconds.

attr_health_check_method^Required

attr_health_check_method: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheckMethod: The HTTP request method for health checks.

attr_health_check_port^Required

attr_health_check_port: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheckPort: The port used for health checks.

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

attr_health_check_succ_times^Required

attr_health_check_succ_times: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheckSuccTimes: The number of consecutive successful health checks required for an application to be considered as healthy.

attr_health_check_timeout^Required

attr_health_check_timeout: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheckTimeout: The timeout period of a health check response.

attr_health_check_type^Required

attr_health_check_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheckType: The health check type.

attr_health_check_uri^Required

attr_health_check_uri: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheckUri: The URI used for health checks.

attr_quic_cid^Required

attr_quic_cid: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute QuicCid: Indicates whether QUIC is enabled.

attr_remarks^Required

attr_remarks: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Remarks: The remarks.

This parameter is empty by default.

attr_service_port^Required

attr_service_port: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ServicePort: The server port.

attr_target_port^Required

attr_target_port: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TargetPort: The backend port, which is also the service port of the application.

attr_update_time^Required

attr_update_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute UpdateTime: The time when the application was last modified.

The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

attr_version_count^Required

attr_version_count: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute VersionCount: The number of versions of the application.

props^Required

props: EdgeContainerAppProps

• Type: EdgeContainerAppProps