EdgeContainerApp

• Implements: IEdgeContainerApp

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

Initializers

import { EdgeContainerApp } from '@alicloud/ros-cdk-esa'
new EdgeContainerApp(scope: Construct, id: string, props: EdgeContainerAppProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: EdgeContainerAppProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { EdgeContainerApp } from '@alicloud/ros-cdk-esa'
EdgeContainerApp.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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 readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrAppStatus^Required

public readonly attrAppStatus: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AppStatus: The status of the application.

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The time when the application was created.

attrDomainName^Required

public readonly attrDomainName: string | IResolvable;

• Type: string | @alicloud/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 readonly attrEdgeContainerAppName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute EdgeContainerAppName: The name of the application.

attrGatewayType^Required

public readonly attrGatewayType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute GatewayType: The type of the gateway.

attrHealthCheckFailTimes^Required

public readonly attrHealthCheckFailTimes: string | IResolvable;

• Type: string | @alicloud/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 readonly attrHealthCheckHost: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrHealthCheckHttpCode^Required

public readonly attrHealthCheckHttpCode: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrHealthCheckInterval^Required

public readonly attrHealthCheckInterval: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckInterval: The interval between two consecutive health checks.

Unit: seconds.

attrHealthCheckMethod^Required

public readonly attrHealthCheckMethod: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckMethod: The HTTP request method for health checks.

attrHealthCheckPort^Required

public readonly attrHealthCheckPort: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckPort: The port used for health checks.

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

attrHealthCheckSuccTimes^Required

public readonly attrHealthCheckSuccTimes: string | IResolvable;

• Type: string | @alicloud/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 readonly attrHealthCheckTimeout: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrHealthCheckType^Required

public readonly attrHealthCheckType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckType: The health check type.

attrHealthCheckUri^Required

public readonly attrHealthCheckUri: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckUri: The URI used for health checks.

attrQuicCid^Required

public readonly attrQuicCid: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute QuicCid: Indicates whether QUIC is enabled.

attrRemarks^Required

public readonly attrRemarks: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Remarks: The remarks.

This parameter is empty by default.

attrServicePort^Required

public readonly attrServicePort: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ServicePort: The server port.

attrTargetPort^Required

public readonly attrTargetPort: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrUpdateTime^Required

public readonly attrUpdateTime: string | IResolvable;

• Type: string | @alicloud/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 readonly attrVersionCount: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VersionCount: The number of versions of the application.

props^Required

public readonly props: EdgeContainerAppProps;

• Type: EdgeContainerAppProps