RosEdgeContainerApp

This class is a base encapsulation around the ROS resource type ALIYUN::ESA::EdgeContainerApp.

Initializers

import com.aliyun.ros.cdk.esa.RosEdgeContainerApp;
RosEdgeContainerApp.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

scope in which this resource is defined.

id^Required

• Type: java.lang.String

scoped id of the resource.

enableResourcePropertyConstraint^Required

• Type: java.lang.Boolean

edgeContainerAppName^Required

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

servicePort^Required

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

targetPort^Required

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

healthCheckFailTimes^Optional

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

healthCheckHost^Optional

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

healthCheckHttpCode^Optional

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

healthCheckInterval^Optional

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

healthCheckMethod^Optional

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

healthCheckPort^Optional

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

healthCheckSuccTimes^Optional

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

healthCheckTimeout^Optional

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

healthCheckType^Optional

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

healthCheckUri^Optional

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

remarks^Optional

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

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.

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: java.lang.String

The new logical ID to use for this stack element.

addCondition

public void addCondition(RosCondition con)

con^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

addDeletionOverride

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: java.lang.String

The path of the value to delete.

addDependsOn

public void addDependsOn(RosResource target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

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

addDesc

public void addDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

addMetaData

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

addOverride

public void addOverride(java.lang.String path, java.lang.Object value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: java.lang.String

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

value^Required

• Type: java.lang.Object

The value.

Could be primitive or complex.

addPropertyDeletionOverride

public void addPropertyDeletionOverride(java.lang.String propertyPath)

Adds an override that deletes the value of a property from the resource definition.

propertyPath^Required

• Type: java.lang.String

The path to the property.

addPropertyOverride

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPath^Required

• Type: java.lang.String

The path of the property.

value^Required

• Type: java.lang.Object

The value.

addRosDependency

public void addRosDependency(java.lang.String target)

target^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

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

options^Optional

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

fetchCondition

public RosCondition fetchCondition()

fetchDesc

public java.lang.String fetchDesc()

fetchRosDependency

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

getAtt

public Reference getAtt(java.lang.String attributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeName^Required

• Type: java.lang.String

The name of the attribute.

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

isRosElement

import com.aliyun.ros.cdk.esa.RosEdgeContainerApp;
RosEdgeContainerApp.isRosElement(java.lang.Object x)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: java.lang.Object

isRosResource

import com.aliyun.ros.cdk.esa.RosEdgeContainerApp;
RosEdgeContainerApp.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

construct^Required

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

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

creationStack^Required

public java.util.List<java.lang.String> getCreationStack();

• Type: java.util.List

logicalId^Required

public java.lang.String getLogicalId();

• Type: java.lang.String

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

stack^Required

public Stack getStack();

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

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rosOptions^Required

public IRosResourceOptions getRosOptions();

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

Options for this resource, such as condition, update policy etc.

rosResourceType^Required

public java.lang.String getRosResourceType();

• Type: java.lang.String

ROS resource type.

attrAppStatus^Required

public IResolvable getAttrAppStatus();

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

attrCreateTime^Required

public IResolvable getAttrCreateTime();

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

attrDomainName^Required

public IResolvable getAttrDomainName();

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

attrEdgeContainerAppName^Required

public IResolvable getAttrEdgeContainerAppName();

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

attrGatewayType^Required

public IResolvable getAttrGatewayType();

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

attrHealthCheckFailTimes^Required

public IResolvable getAttrHealthCheckFailTimes();

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

attrHealthCheckHost^Required

public IResolvable getAttrHealthCheckHost();

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

attrHealthCheckHttpCode^Required

public IResolvable getAttrHealthCheckHttpCode();

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

attrHealthCheckInterval^Required

public IResolvable getAttrHealthCheckInterval();

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

attrHealthCheckMethod^Required

public IResolvable getAttrHealthCheckMethod();

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

attrHealthCheckPort^Required

public IResolvable getAttrHealthCheckPort();

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

attrHealthCheckSuccTimes^Required

public IResolvable getAttrHealthCheckSuccTimes();

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

attrHealthCheckTimeout^Required

public IResolvable getAttrHealthCheckTimeout();

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

attrHealthCheckType^Required

public IResolvable getAttrHealthCheckType();

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

attrHealthCheckUri^Required

public IResolvable getAttrHealthCheckUri();

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

attrQuicCid^Required

public IResolvable getAttrQuicCid();

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

attrRemarks^Required

public IResolvable getAttrRemarks();

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

attrServicePort^Required

public IResolvable getAttrServicePort();

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

attrTargetPort^Required

public IResolvable getAttrTargetPort();

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

attrUpdateTime^Required

public IResolvable getAttrUpdateTime();

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

attrVersionCount^Required

public IResolvable getAttrVersionCount();

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

edgeContainerAppName^Required

public java.lang.Object getEdgeContainerAppName();

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

enableResourcePropertyConstraint^Required

public java.lang.Boolean getEnableResourcePropertyConstraint();

• Type: java.lang.Boolean

servicePort^Required

public java.lang.Object getServicePort();

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

targetPort^Required

public java.lang.Object getTargetPort();

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

healthCheckFailTimes^Optional

public java.lang.Object getHealthCheckFailTimes();

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

healthCheckHost^Optional

public java.lang.Object getHealthCheckHost();

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

healthCheckHttpCode^Optional

public java.lang.Object getHealthCheckHttpCode();

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

healthCheckInterval^Optional

public java.lang.Object getHealthCheckInterval();

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

healthCheckMethod^Optional

public java.lang.Object getHealthCheckMethod();

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

healthCheckPort^Optional

public java.lang.Object getHealthCheckPort();

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

healthCheckSuccTimes^Optional

public java.lang.Object getHealthCheckSuccTimes();

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

healthCheckTimeout^Optional

public java.lang.Object getHealthCheckTimeout();

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

healthCheckType^Optional

public java.lang.Object getHealthCheckType();

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

healthCheckUri^Optional

public java.lang.Object getHealthCheckUri();

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

remarks^Optional

public java.lang.Object getRemarks();

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

Constants

ROS_RESOURCE_TYPE_NAME^Required

public java.lang.String getRosResourceTypeName();

• Type: java.lang.String

The resource type name for this resource class.