RosApplication

This class is a base encapsulation around the ROS resource type ALIYUN::SAE::Application, which is used to create an application in Serverless App Engine (SAE).

Initializers

import { RosApplication } from '@alicloud/ros-cdk-sae'
new RosApplication(scope: Construct, id: string, props: RosApplicationProps, enableResourcePropertyConstraint: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	- scope in which this resource is defined.
id	string	- scoped id of the resource.
props	RosApplicationProps	- resource properties.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

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

scope in which this resource is defined.

---

id^Required

• Type: string

scoped id of the resource.

---

props^Required

• Type: RosApplicationProps

resource properties.

---

enableResourcePropertyConstraint^Required

• Type: boolean

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
addCondition	No description.
addCount	No description.
addDeletionOverride	Syntactic sugar for addOverride(path, undefined).
addDependsOn	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDesc	No description.
addMetaData	No description.
addOverride	Adds an override to the synthesized ROS resource.
addPropertyDeletionOverride	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride	Adds an override to a resource property.
addRosDependency	No description.
applyRemovalPolicy	Sets the deletion policy of the resource based on the removal policy specified.
getAtt	Returns a token for an runtime attribute of this resource.

---

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.

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

addCondition

public addCondition(con: RosCondition): void

con^Required

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

---

addCount

public addCount(count: number | IResolvable): void

count^Required

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

---

addDeletionOverride

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: string

The path of the value to delete.

---

addDependsOn

public addDependsOn(target: RosResource): void

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

---

addDesc

public addDesc(desc: string): void

desc^Required

• Type: string

---

addMetaData

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

key^Required

• Type: string

---

value^Required

• Type: any

---

addOverride

public addOverride(path: string, value: any): void

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: 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: any

The value.

Could be primitive or complex.

---

addPropertyDeletionOverride

public addPropertyDeletionOverride(propertyPath: string): void

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

propertyPath^Required

• Type: string

The path to the property.

---

addPropertyOverride

public addPropertyOverride(propertyPath: string, value: any): void

Adds an override to a resource property.

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

propertyPath^Required

• Type: string

The path of the property.

---

value^Required

• Type: any

The value.

---

addRosDependency

public addRosDependency(target: string): void

target^Required

• Type: string

---

applyRemovalPolicy

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

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

policy^Optional

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

---

options^Optional

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

---

getAtt

public getAtt(attributeName: string): Reference

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: string

The name of the attribute.

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.
isRosElement	Returns true if a construct is a stack element (i.e. part of the synthesized template).
isRosResource	Check whether the given construct is a RosResource.

---

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

---

isRosElement

import { RosApplication } from '@alicloud/ros-cdk-sae'
RosApplication.isRosElement(x: any)

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: any

---

isRosResource

import { RosApplication } from '@alicloud/ros-cdk-sae'
RosApplication.isRosResource(construct: IConstruct)

Check whether the given construct is a RosResource.

construct^Required

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

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
creationStack	string[]	No description.
logicalId	string	The logical ID for this stack element.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this element is defined.
ref	string	Return a string that will be resolved to a RosTemplate { Ref } for this element.
rosOptions	@alicloud/ros-cdk-core.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
rosResourceType	string	ROS resource type.
attrAppId	@alicloud/ros-cdk-core.IResolvable	No description.
attrChangeOrderId	@alicloud/ros-cdk-core.IResolvable	No description.
appName	string | @alicloud/ros-cdk-core.IResolvable	No description.
cpu	number | @alicloud/ros-cdk-core.IResolvable	No description.
enableResourcePropertyConstraint	boolean	No description.
memory	number | @alicloud/ros-cdk-core.IResolvable	No description.
namespaceId	string | @alicloud/ros-cdk-core.IResolvable	No description.
packageType	string | @alicloud/ros-cdk-core.IResolvable	No description.
replicas	number | @alicloud/ros-cdk-core.IResolvable	No description.
acrAssumeRoleArn	string | @alicloud/ros-cdk-core.IResolvable	No description.
acrInstanceId	string | @alicloud/ros-cdk-core.IResolvable	No description.
appDescription	string | @alicloud/ros-cdk-core.IResolvable	No description.
appSource	string | @alicloud/ros-cdk-core.IResolvable	No description.
associateEip	boolean | @alicloud/ros-cdk-core.IResolvable	No description.
autoConfig	boolean | @alicloud/ros-cdk-core.IResolvable	No description.
baseAppId	string | @alicloud/ros-cdk-core.IResolvable	No description.
command	string | @alicloud/ros-cdk-core.IResolvable	No description.
commandArgs	string | @alicloud/ros-cdk-core.IResolvable	No description.
configMapMountDesc	string | @alicloud/ros-cdk-core.IResolvable	No description.
customHostAlias	string | @alicloud/ros-cdk-core.IResolvable	No description.
deploy	boolean | @alicloud/ros-cdk-core.IResolvable	No description.
edasContainerVersion	string | @alicloud/ros-cdk-core.IResolvable	No description.
enableEbpf	string | @alicloud/ros-cdk-core.IResolvable	No description.
envs	string | @alicloud/ros-cdk-core.IResolvable	No description.
imagePullSecrets	string | @alicloud/ros-cdk-core.IResolvable	No description.
imageUrl	string | @alicloud/ros-cdk-core.IResolvable	No description.
jarStartArgs	string | @alicloud/ros-cdk-core.IResolvable	No description.
jarStartOptions	string | @alicloud/ros-cdk-core.IResolvable	No description.
jdk	string | @alicloud/ros-cdk-core.IResolvable	No description.
kafkaConfigs	string | @alicloud/ros-cdk-core.IResolvable	No description.
liveness	string | @alicloud/ros-cdk-core.IResolvable	No description.
microRegistration	string | @alicloud/ros-cdk-core.IResolvable	No description.
microRegistrationConfig	string | @alicloud/ros-cdk-core.IResolvable	No description.
mountDesc	string | @alicloud/ros-cdk-core.IResolvable	No description.
mountHost	string | @alicloud/ros-cdk-core.IResolvable	No description.
nasConfigs	string | @alicloud/ros-cdk-core.IResolvable	No description.
nasId	string | @alicloud/ros-cdk-core.IResolvable	No description.
ossAkId	string | @alicloud/ros-cdk-core.IResolvable	No description.
ossAkSecret	string | @alicloud/ros-cdk-core.IResolvable	No description.
ossMountDescs	any[] | @alicloud/ros-cdk-core.IResolvable	No description.
packageUrl	string | @alicloud/ros-cdk-core.IResolvable	No description.
packageVersion	string | @alicloud/ros-cdk-core.IResolvable	No description.
php	string | @alicloud/ros-cdk-core.IResolvable	No description.
phpArmsConfigLocation	string | @alicloud/ros-cdk-core.IResolvable	No description.
phpConfig	string | @alicloud/ros-cdk-core.IResolvable	No description.
phpConfigLocation	string | @alicloud/ros-cdk-core.IResolvable	No description.
postStart	string | @alicloud/ros-cdk-core.IResolvable	No description.
preStop	string | @alicloud/ros-cdk-core.IResolvable	No description.
programmingLanguage	string | @alicloud/ros-cdk-core.IResolvable	No description.
pvtzDiscoverySvc	string | @alicloud/ros-cdk-core.IResolvable	No description.
python	string | @alicloud/ros-cdk-core.IResolvable	No description.
pythonModules	string | @alicloud/ros-cdk-core.IResolvable	No description.
readiness	string | @alicloud/ros-cdk-core.IResolvable	No description.
saeVersion	string | @alicloud/ros-cdk-core.IResolvable	No description.
securityGroupId	string | @alicloud/ros-cdk-core.IResolvable	No description.
serviceTags	string | @alicloud/ros-cdk-core.IResolvable	No description.
slsConfigs	string | @alicloud/ros-cdk-core.IResolvable	No description.
tags	TagsProperty[]	No description.
terminationGracePeriodSeconds	number | @alicloud/ros-cdk-core.IResolvable	No description.
timezone	string | @alicloud/ros-cdk-core.IResolvable	No description.
tomcatConfig	string | @alicloud/ros-cdk-core.IResolvable	No description.
vpcId	string | @alicloud/ros-cdk-core.IResolvable	No description.
vSwitchId	string | @alicloud/ros-cdk-core.IResolvable	No description.
warStartOptions	string | @alicloud/ros-cdk-core.IResolvable	No description.
webContainer	string | @alicloud/ros-cdk-core.IResolvable	No description.

---

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

---

logicalId^Required

public readonly logicalId: string;

• Type: 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 readonly stack: Stack;

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

• Type: 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 readonly rosOptions: IRosResourceOptions;

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

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

---

rosResourceType^Required

public readonly rosResourceType: string;

• Type: string

ROS resource type.

---

attrAppId^Required

public readonly attrAppId: IResolvable;

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

---

attrChangeOrderId^Required

public readonly attrChangeOrderId: IResolvable;

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

---

appName^Required

public readonly appName: string | IResolvable;

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

---

cpu^Required

public readonly cpu: number | IResolvable;

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

---

enableResourcePropertyConstraint^Required

public readonly enableResourcePropertyConstraint: boolean;

• Type: boolean

---

memory^Required

public readonly memory: number | IResolvable;

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

---

namespaceId^Required

public readonly namespaceId: string | IResolvable;

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

---

packageType^Required

public readonly packageType: string | IResolvable;

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

---

replicas^Required

public readonly replicas: number | IResolvable;

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

---

acrAssumeRoleArn^Optional

public readonly acrAssumeRoleArn: string | IResolvable;

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

---

acrInstanceId^Optional

public readonly acrInstanceId: string | IResolvable;

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

---

appDescription^Optional

public readonly appDescription: string | IResolvable;

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

---

appSource^Optional

public readonly appSource: string | IResolvable;

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

---

associateEip^Optional

public readonly associateEip: boolean | IResolvable;

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

---

autoConfig^Optional

public readonly autoConfig: boolean | IResolvable;

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

---

baseAppId^Optional

public readonly baseAppId: string | IResolvable;

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

---

command^Optional

public readonly command: string | IResolvable;

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

---

commandArgs^Optional

public readonly commandArgs: string | IResolvable;

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

---

configMapMountDesc^Optional

public readonly configMapMountDesc: string | IResolvable;

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

---

customHostAlias^Optional

public readonly customHostAlias: string | IResolvable;

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

---

deploy^Optional

public readonly deploy: boolean | IResolvable;

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

---

edasContainerVersion^Optional

public readonly edasContainerVersion: string | IResolvable;

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

---

enableEbpf^Optional

public readonly enableEbpf: string | IResolvable;

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

---

envs^Optional

public readonly envs: string | IResolvable;

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

---

imagePullSecrets^Optional

public readonly imagePullSecrets: string | IResolvable;

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

---

imageUrl^Optional

public readonly imageUrl: string | IResolvable;

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

---

jarStartArgs^Optional

public readonly jarStartArgs: string | IResolvable;

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

---

jarStartOptions^Optional

public readonly jarStartOptions: string | IResolvable;

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

---

jdk^Optional

public readonly jdk: string | IResolvable;

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

---

kafkaConfigs^Optional

public readonly kafkaConfigs: string | IResolvable;

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

---

liveness^Optional

public readonly liveness: string | IResolvable;

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

---

microRegistration^Optional

public readonly microRegistration: string | IResolvable;

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

---

microRegistrationConfig^Optional

public readonly microRegistrationConfig: string | IResolvable;

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

---

mountDesc^Optional

public readonly mountDesc: string | IResolvable;

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

---

mountHost^Optional

public readonly mountHost: string | IResolvable;

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

---

nasConfigs^Optional

public readonly nasConfigs: string | IResolvable;

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

---

nasId^Optional

public readonly nasId: string | IResolvable;

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

---

ossAkId^Optional

public readonly ossAkId: string | IResolvable;

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

---

ossAkSecret^Optional

public readonly ossAkSecret: string | IResolvable;

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

---

ossMountDescs^Optional

public readonly ossMountDescs: any[] | IResolvable;

• Type: any[] | @alicloud/ros-cdk-core.IResolvable

---

packageUrl^Optional

public readonly packageUrl: string | IResolvable;

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

---

packageVersion^Optional

public readonly packageVersion: string | IResolvable;

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

---

php^Optional

public readonly php: string | IResolvable;

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

---

phpArmsConfigLocation^Optional

public readonly phpArmsConfigLocation: string | IResolvable;

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

---

phpConfig^Optional

public readonly phpConfig: string | IResolvable;

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

---

phpConfigLocation^Optional

public readonly phpConfigLocation: string | IResolvable;

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

---

postStart^Optional

public readonly postStart: string | IResolvable;

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

---

preStop^Optional

public readonly preStop: string | IResolvable;

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

---

programmingLanguage^Optional

public readonly programmingLanguage: string | IResolvable;

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

---

pvtzDiscoverySvc^Optional

public readonly pvtzDiscoverySvc: string | IResolvable;

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

---

python^Optional

public readonly python: string | IResolvable;

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

---

pythonModules^Optional

public readonly pythonModules: string | IResolvable;

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

---

readiness^Optional

public readonly readiness: string | IResolvable;

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

---

saeVersion^Optional

public readonly saeVersion: string | IResolvable;

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

---

securityGroupId^Optional

public readonly securityGroupId: string | IResolvable;

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

---

serviceTags^Optional

public readonly serviceTags: string | IResolvable;

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

---

slsConfigs^Optional

public readonly slsConfigs: string | IResolvable;

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

---

tags^Optional

public readonly tags: TagsProperty[];

• Type: TagsProperty[]

---

terminationGracePeriodSeconds^Optional

public readonly terminationGracePeriodSeconds: number | IResolvable;

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

---

timezone^Optional

public readonly timezone: string | IResolvable;

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

---

tomcatConfig^Optional

public readonly tomcatConfig: string | IResolvable;

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

---

vpcId^Optional

public readonly vpcId: string | IResolvable;

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

---

vSwitchId^Optional

public readonly vSwitchId: string | IResolvable;

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

---

warStartOptions^Optional

public readonly warStartOptions: string | IResolvable;

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

---

webContainer^Optional

public readonly webContainer: string | IResolvable;

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

---

Constants

Name	Type	Description
ROS_RESOURCE_TYPE_NAME	string	The resource type name for this resource class.

---

ROS_RESOURCE_TYPE_NAME^Required

public readonly ROS_RESOURCE_TYPE_NAME: string;

• Type: string

The resource type name for this resource class.

---