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

using AlibabaCloud.SDK.ROS.CDK.Edas;
new RosK8sApplication(Construct Scope, string Id, RosK8sApplicationProps Props, bool EnableResourcePropertyConstraint);

Name	Type	Description
Scope	AlibabaCloud.SDK.ROS.CDK.Core.Construct	- scope in which this resource is defined.
Id	string	- scoped id of the resource.
Props	RosK8sApplicationProps	- resource properties.
EnableResourcePropertyConstraint	bool	No description.

---

Scope^Required

• Type: AlibabaCloud.SDK.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: bool

---

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

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

private void AddCondition(RosCondition Con)

Con^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

---

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

---

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

Path^Required

• Type: string

The path of the value to delete.

---

AddDependsOn

private 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: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

---

AddDesc

private void AddDesc(string Desc)

Desc^Required

• Type: string

---

AddMetaData

private void AddMetaData(string Key, object Value)

Key^Required

• Type: string

---

Value^Required

• Type: object

---

AddOverride

private void AddOverride(string Path, 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: 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: object

The value.

Could be primitive or complex.

---

AddPropertyDeletionOverride

private void AddPropertyDeletionOverride(string PropertyPath)

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

PropertyPath^Required

• Type: string

The path to the property.

---

AddPropertyOverride

private void AddPropertyOverride(string PropertyPath, object Value)

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

The value.

---

AddRosDependency

private void AddRosDependency(string Target)

Target^Required

• Type: string

---

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)

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

Policy^Optional

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

---

Options^Optional

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicyOptions

---

GetAtt

private Reference GetAtt(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: 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

using AlibabaCloud.SDK.ROS.CDK.Edas;
RosK8sApplication.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

---

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Edas;
RosK8sApplication.IsRosElement(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: object

---

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Edas;
RosK8sApplication.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

Construct^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IConstruct

---

Properties

Name	Type	Description
Node	AlibabaCloud.SDK.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	AlibabaCloud.SDK.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	AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
RosResourceType	string	ROS resource type.
AttrAppId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrAppName	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrChangeOrderId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrClusterId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrCsClusterId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AppName	object	No description.
ClusterId	object	No description.
EnableResourcePropertyConstraint	bool	No description.
ApplicationDescription	object	No description.
Command	object	No description.
CommandArgs	object	No description.
DeployAcrossNodes	object	No description.
DeployAcrossZones	object	No description.
EdasContainerVersion	object	No description.
EnableAhas	object	No description.
Envs	object	No description.
ImageUrl	object	No description.
InternetSlbId	object	No description.
InternetSlbPort	object	No description.
InternetSlbProtocol	object	No description.
InternetTargetPort	object	No description.
IntranetSlbId	object	No description.
IntranetSlbPort	object	No description.
IntranetSlbProtocol	object	No description.
IntranetTargetPort	object	No description.
IsMultilingualApp	object	No description.
JavaStartUpConfig	object	No description.
Jdk	object	No description.
LimitCpu	object	No description.
LimitMem	object	No description.
Liveness	object	No description.
LocalVolume	object	No description.
LogicalRegionId	object	No description.
MountDescs	object	No description.
Namespace	object	No description.
NasId	object	No description.
PackageType	object	No description.
PackageUrl	object	No description.
PackageVersion	object	No description.
PostStart	object	No description.
PreStop	object	No description.
Readiness	object	No description.
Replicas	object	No description.
RepoId	object	No description.
RequestsCpu	object	No description.
RequestsMem	object	No description.
RuntimeClassName	object	No description.
SlsConfigs	object	No description.
StorageType	object	No description.
Timeout	object	No description.
UriEncoding	object	No description.
UseBodyEncoding	object	No description.
WebContainer	object	No description.
WebContainerConfig	object	No description.

---

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

---

CreationStack^Required

public string[] CreationStack { get; }

• Type: string[]

---

LogicalId^Required

public string LogicalId { get; }

• 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 Stack Stack { get; }

• Type: AlibabaCloud.SDK.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 string Ref { get; }

• 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 IRosResourceOptions RosOptions { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions

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

---

RosResourceType^Required

public string RosResourceType { get; }

• Type: string

ROS resource type.

---

AttrAppId^Required

public IResolvable AttrAppId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrAppName^Required

public IResolvable AttrAppName { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrChangeOrderId^Required

public IResolvable AttrChangeOrderId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrClusterId^Required

public IResolvable AttrClusterId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrCsClusterId^Required

public IResolvable AttrCsClusterId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AppName^Required

public object AppName { get; }

• Type: object

---

ClusterId^Required

public object ClusterId { get; }

• Type: object

---

EnableResourcePropertyConstraint^Required

public bool EnableResourcePropertyConstraint { get; }

• Type: bool

---

ApplicationDescription^Optional

public object ApplicationDescription { get; }

• Type: object

---

Command^Optional

public object Command { get; }

• Type: object

---

CommandArgs^Optional

public object CommandArgs { get; }

• Type: object

---

DeployAcrossNodes^Optional

public object DeployAcrossNodes { get; }

• Type: object

---

DeployAcrossZones^Optional

public object DeployAcrossZones { get; }

• Type: object

---

EdasContainerVersion^Optional

public object EdasContainerVersion { get; }

• Type: object

---

EnableAhas^Optional

public object EnableAhas { get; }

• Type: object

---

Envs^Optional

public object Envs { get; }

• Type: object

---

ImageUrl^Optional

public object ImageUrl { get; }

• Type: object

---

InternetSlbId^Optional

public object InternetSlbId { get; }

• Type: object

---

InternetSlbPort^Optional

public object InternetSlbPort { get; }

• Type: object

---

InternetSlbProtocol^Optional

public object InternetSlbProtocol { get; }

• Type: object

---

InternetTargetPort^Optional

public object InternetTargetPort { get; }

• Type: object

---

IntranetSlbId^Optional

public object IntranetSlbId { get; }

• Type: object

---

IntranetSlbPort^Optional

public object IntranetSlbPort { get; }

• Type: object

---

IntranetSlbProtocol^Optional

public object IntranetSlbProtocol { get; }

• Type: object

---

IntranetTargetPort^Optional

public object IntranetTargetPort { get; }

• Type: object

---

IsMultilingualApp^Optional

public object IsMultilingualApp { get; }

• Type: object

---

JavaStartUpConfig^Optional

public object JavaStartUpConfig { get; }

• Type: object

---

Jdk^Optional

public object Jdk { get; }

• Type: object

---

LimitCpu^Optional

public object LimitCpu { get; }

• Type: object

---

LimitMem^Optional

public object LimitMem { get; }

• Type: object

---

Liveness^Optional

public object Liveness { get; }

• Type: object

---

LocalVolume^Optional

public object LocalVolume { get; }

• Type: object

---

LogicalRegionId^Optional

public object LogicalRegionId { get; }

• Type: object

---

MountDescs^Optional

public object MountDescs { get; }

• Type: object

---

Namespace^Optional

public object Namespace { get; }

• Type: object

---

NasId^Optional

public object NasId { get; }

• Type: object

---

PackageType^Optional

public object PackageType { get; }

• Type: object

---

PackageUrl^Optional

public object PackageUrl { get; }

• Type: object

---

PackageVersion^Optional

public object PackageVersion { get; }

• Type: object

---

PostStart^Optional

public object PostStart { get; }

• Type: object

---

PreStop^Optional

public object PreStop { get; }

• Type: object

---

Readiness^Optional

public object Readiness { get; }

• Type: object

---

Replicas^Optional

public object Replicas { get; }

• Type: object

---

RepoId^Optional

public object RepoId { get; }

• Type: object

---

RequestsCpu^Optional

public object RequestsCpu { get; }

• Type: object

---

RequestsMem^Optional

public object RequestsMem { get; }

• Type: object

---

RuntimeClassName^Optional

public object RuntimeClassName { get; }

• Type: object

---

SlsConfigs^Optional

public object SlsConfigs { get; }

• Type: object

---

StorageType^Optional

public object StorageType { get; }

• Type: object

---

Timeout^Optional

public object Timeout { get; }

• Type: object

---

UriEncoding^Optional

public object UriEncoding { get; }

• Type: object

---

UseBodyEncoding^Optional

public object UseBodyEncoding { get; }

• Type: object

---

WebContainer^Optional

public object WebContainer { get; }

• Type: object

---

WebContainerConfig^Optional

public object WebContainerConfig { get; }

• Type: object

---

Constants

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

---

RosResourceTypeName^Required

public string RosResourceTypeName { get; }

• Type: string

The resource type name for this resource class.

---