EdgeContainerApp

• Implements: IEdgeContainerApp

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

Initializers

import com.aliyun.ros.cdk.esa.EdgeContainerApp;
EdgeContainerApp.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

edgeContainerAppName^Required

• 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.

servicePort^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property servicePort: The server port.

Valid values: 1 to 65535.

targetPort^Required

• 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.

healthCheckFailTimes^Optional

• 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.

healthCheckHost^Optional

• 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.

healthCheckHttpCode^Optional

• 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

healthCheckInterval^Optional

• 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.

healthCheckMethod^Optional

• 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.

healthCheckPort^Optional

• 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.

healthCheckSuccTimes^Optional

• 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.

healthCheckTimeout^Optional

• 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.

healthCheckType^Optional

• 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.

healthCheckUri^Optional

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

remarks^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property remarks: The remarks.

This parameter is empty by default.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.esa.EdgeContainerApp;
EdgeContainerApp.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrAppStatus^Required

public java.lang.Object getAttrAppStatus();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AppStatus: The status of the application.

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The time when the application was created.

attrDomainName^Required

public java.lang.Object getAttrDomainName();

• Type: java.lang.String OR com.aliyun.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.

attrEdgeContainerAppName^Required

public java.lang.Object getAttrEdgeContainerAppName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EdgeContainerAppName: The name of the application.

attrGatewayType^Required

public java.lang.Object getAttrGatewayType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute GatewayType: The type of the gateway.

attrHealthCheckFailTimes^Required

public java.lang.Object getAttrHealthCheckFailTimes();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrHealthCheckHost^Required

public java.lang.Object getAttrHealthCheckHost();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrHealthCheckHttpCode^Required

public java.lang.Object getAttrHealthCheckHttpCode();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrHealthCheckInterval^Required

public java.lang.Object getAttrHealthCheckInterval();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HealthCheckInterval: The interval between two consecutive health checks.

Unit: seconds.

attrHealthCheckMethod^Required

public java.lang.Object getAttrHealthCheckMethod();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HealthCheckMethod: The HTTP request method for health checks.

attrHealthCheckPort^Required

public java.lang.Object getAttrHealthCheckPort();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HealthCheckPort: The port used for health checks.

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

attrHealthCheckSuccTimes^Required

public java.lang.Object getAttrHealthCheckSuccTimes();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrHealthCheckTimeout^Required

public java.lang.Object getAttrHealthCheckTimeout();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrHealthCheckType^Required

public java.lang.Object getAttrHealthCheckType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HealthCheckType: The health check type.

attrHealthCheckUri^Required

public java.lang.Object getAttrHealthCheckUri();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HealthCheckUri: The URI used for health checks.

attrQuicCid^Required

public java.lang.Object getAttrQuicCid();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute QuicCid: Indicates whether QUIC is enabled.

attrRemarks^Required

public java.lang.Object getAttrRemarks();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Remarks: The remarks.

This parameter is empty by default.

attrServicePort^Required

public java.lang.Object getAttrServicePort();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ServicePort: The server port.

attrTargetPort^Required

public java.lang.Object getAttrTargetPort();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrUpdateTime^Required

public java.lang.Object getAttrUpdateTime();

• Type: java.lang.String OR com.aliyun.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.

attrVersionCount^Required

public java.lang.Object getAttrVersionCount();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VersionCount: The number of versions of the application.

props^Required

public EdgeContainerAppProps getProps();

• Type: EdgeContainerAppProps