RosK8sApplication
This class is a base encapsulation around the ROS resource type ALIYUN::EDAS::K8sApplication
, which is used to create an application in a Kubernetes cluster.
Initializers
import { RosK8sApplication } from '@alicloud/ros-cdk-edas'
new RosK8sApplication(scope: Construct, id: string, props: RosK8sApplicationProps, 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 |
RosK8sApplicationProps |
- 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: RosK8sApplicationProps
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.
- 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.
- Type: string
The new logical ID to use for this stack element.
addCondition
public addCondition(con: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDeletionOverride
public addDeletionOverride(path: string): void
Syntactic sugar for addOverride(path, undefined)
.
- 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.
- Type: @alicloud/ros-cdk-core.RosResource
addDesc
public addDesc(desc: string): void
- Type: string
addMetaData
public addMetaData(key: string, value: any): void
- Type: string
- 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"
...
},
]
...
}
- 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.
- 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.
- 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)
.
- Type: string
The path of the property.
- Type: any
The value.
addRosDependency
public addRosDependency(target: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Sets the deletion policy of the resource based on the removal policy specified.
- Type: @alicloud/ros-cdk-core.RemovalPolicy
- 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.
- 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 { RosK8sApplication } from '@alicloud/ros-cdk-edas'
RosK8sApplication.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
isRosElement
import { RosK8sApplication } from '@alicloud/ros-cdk-edas'
RosK8sApplication.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.
- Type: any
isRosResource
import { RosK8sApplication } from '@alicloud/ros-cdk-edas'
RosK8sApplication.isRosResource(construct: IConstruct)
Check whether the given construct is a RosResource.
- 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. |
attrAppName |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrChangeOrderId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrClusterId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrCsClusterId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
appName |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
clusterId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
enableResourcePropertyConstraint |
boolean |
No description. |
applicationDescription |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
command |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
commandArgs |
@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | CommandArgsProperty[] |
No description. |
deployAcrossNodes |
boolean | @alicloud/ros-cdk-core.IResolvable |
No description. |
deployAcrossZones |
boolean | @alicloud/ros-cdk-core.IResolvable |
No description. |
edasContainerVersion |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
enableAhas |
boolean | @alicloud/ros-cdk-core.IResolvable |
No description. |
envs |
@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | EnvsProperty[] |
No description. |
imageUrl |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
internetSlbId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
internetSlbPort |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
internetSlbProtocol |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
internetTargetPort |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
intranetSlbId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
intranetSlbPort |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
intranetSlbProtocol |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
intranetTargetPort |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
isMultilingualApp |
boolean | @alicloud/ros-cdk-core.IResolvable |
No description. |
javaStartUpConfig |
@alicloud/ros-cdk-core.IResolvable | JavaStartUpConfigProperty |
No description. |
jdk |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
limitCpu |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
limitMem |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
liveness |
@alicloud/ros-cdk-core.IResolvable | LivenessProperty |
No description. |
localVolume |
@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | LocalVolumeProperty[] |
No description. |
logicalRegionId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
mountDescs |
@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | MountDescsProperty[] |
No description. |
namespace |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
nasId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
packageType |
string | @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. |
postStart |
@alicloud/ros-cdk-core.IResolvable | PostStartProperty |
No description. |
preStop |
@alicloud/ros-cdk-core.IResolvable | PreStopProperty |
No description. |
readiness |
@alicloud/ros-cdk-core.IResolvable | ReadinessProperty |
No description. |
replicas |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
repoId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
requestsCpu |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
requestsMem |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
runtimeClassName |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
slsConfigs |
@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | SlsConfigsProperty[] |
No description. |
storageType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
timeout |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
uriEncoding |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
useBodyEncoding |
boolean | @alicloud/ros-cdk-core.IResolvable |
No description. |
webContainer |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
webContainerConfig |
@alicloud/ros-cdk-core.IResolvable | WebContainerConfigProperty |
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
attrAppName
Required
public readonly attrAppName: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrChangeOrderId
Required
public readonly attrChangeOrderId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrClusterId
Required
public readonly attrClusterId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrCsClusterId
Required
public readonly attrCsClusterId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
appName
Required
public readonly appName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
clusterId
Required
public readonly clusterId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
enableResourcePropertyConstraint
Required
public readonly enableResourcePropertyConstraint: boolean;
- Type: boolean
applicationDescription
Optional
public readonly applicationDescription: 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: IResolvable | IResolvable | CommandArgsProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | CommandArgsProperty[]
deployAcrossNodes
Optional
public readonly deployAcrossNodes: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
deployAcrossZones
Optional
public readonly deployAcrossZones: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
edasContainerVersion
Optional
public readonly edasContainerVersion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
enableAhas
Optional
public readonly enableAhas: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
envs
Optional
public readonly envs: IResolvable | IResolvable | EnvsProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | EnvsProperty[]
imageUrl
Optional
public readonly imageUrl: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
internetSlbId
Optional
public readonly internetSlbId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
internetSlbPort
Optional
public readonly internetSlbPort: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
internetSlbProtocol
Optional
public readonly internetSlbProtocol: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
internetTargetPort
Optional
public readonly internetTargetPort: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
intranetSlbId
Optional
public readonly intranetSlbId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
intranetSlbPort
Optional
public readonly intranetSlbPort: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
intranetSlbProtocol
Optional
public readonly intranetSlbProtocol: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
intranetTargetPort
Optional
public readonly intranetTargetPort: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
isMultilingualApp
Optional
public readonly isMultilingualApp: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
javaStartUpConfig
Optional
public readonly javaStartUpConfig: IResolvable | JavaStartUpConfigProperty;
- Type: @alicloud/ros-cdk-core.IResolvable | JavaStartUpConfigProperty
jdk
Optional
public readonly jdk: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
limitCpu
Optional
public readonly limitCpu: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
limitMem
Optional
public readonly limitMem: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
liveness
Optional
public readonly liveness: IResolvable | LivenessProperty;
- Type: @alicloud/ros-cdk-core.IResolvable | LivenessProperty
localVolume
Optional
public readonly localVolume: IResolvable | IResolvable | LocalVolumeProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | LocalVolumeProperty[]
logicalRegionId
Optional
public readonly logicalRegionId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
mountDescs
Optional
public readonly mountDescs: IResolvable | IResolvable | MountDescsProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | MountDescsProperty[]
namespace
Optional
public readonly namespace: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
nasId
Optional
public readonly nasId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
packageType
Optional
public readonly packageType: string | IResolvable;
- Type: string | @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
postStart
Optional
public readonly postStart: IResolvable | PostStartProperty;
- Type: @alicloud/ros-cdk-core.IResolvable | PostStartProperty
preStop
Optional
public readonly preStop: IResolvable | PreStopProperty;
- Type: @alicloud/ros-cdk-core.IResolvable | PreStopProperty
readiness
Optional
public readonly readiness: IResolvable | ReadinessProperty;
- Type: @alicloud/ros-cdk-core.IResolvable | ReadinessProperty
replicas
Optional
public readonly replicas: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
repoId
Optional
public readonly repoId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
requestsCpu
Optional
public readonly requestsCpu: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
requestsMem
Optional
public readonly requestsMem: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
runtimeClassName
Optional
public readonly runtimeClassName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
slsConfigs
Optional
public readonly slsConfigs: IResolvable | IResolvable | SlsConfigsProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | SlsConfigsProperty[]
storageType
Optional
public readonly storageType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
timeout
Optional
public readonly timeout: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
uriEncoding
Optional
public readonly uriEncoding: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
useBodyEncoding
Optional
public readonly useBodyEncoding: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
webContainer
Optional
public readonly webContainer: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
webContainerConfig
Optional
public readonly webContainerConfig: IResolvable | WebContainerConfigProperty;
- Type: @alicloud/ros-cdk-core.IResolvable | WebContainerConfigProperty
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.