Skip to content

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

using AlibabaCloud.SDK.ROS.CDK.Sae;
new RosApplication(Construct Scope, string Id, RosApplicationProps 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 RosApplicationProps - resource properties.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

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

scope in which this resource is defined.


IdRequired

  • Type: string

scoped id of the resource.


PropsRequired

resource properties.


EnableResourcePropertyConstraintRequired

  • 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.

SessionRequired

  • 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.

NewLogicalIdRequired

  • Type: string

The new logical ID to use for this stack element.


AddCondition

private void AddCondition(RosCondition Con)

ConRequired

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

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

PathRequired

  • 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.

TargetRequired

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

AddDesc

private void AddDesc(string Desc)

DescRequired

  • Type: string

AddMetaData

private void AddMetaData(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • 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"
       ...
     },
   ]
   ...
}

PathRequired

  • 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.


ValueRequired

  • 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.

PropertyPathRequired

  • 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).

PropertyPathRequired

  • Type: string

The path of the property.


ValueRequired

  • Type: object

The value.


AddRosDependency

private void AddRosDependency(string Target)

TargetRequired

  • 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.

PolicyOptional

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

OptionsOptional

  • 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.

AttributeNameRequired

  • 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.Sae;
RosApplication.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Sae;
RosApplication.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.

XRequired

  • Type: object

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Sae;
RosApplication.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

ConstructRequired

  • 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.
AttrChangeOrderId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AppName object No description.
Cpu object No description.
EnableResourcePropertyConstraint bool No description.
Memory object No description.
NamespaceId object No description.
PackageType object No description.
Replicas object No description.
AcrAssumeRoleArn object No description.
AcrInstanceId object No description.
AppDescription object No description.
AppSource object No description.
AssociateEip object No description.
AutoConfig object No description.
BaseAppId object No description.
Command object No description.
CommandArgs object No description.
ConfigMapMountDesc object No description.
CustomHostAlias object No description.
Deploy object No description.
EdasContainerVersion object No description.
EnableEbpf object No description.
Envs object No description.
ImagePullSecrets object No description.
ImageUrl object No description.
JarStartArgs object No description.
JarStartOptions object No description.
Jdk object No description.
KafkaConfigs object No description.
Liveness object No description.
MicroRegistration object No description.
MicroRegistrationConfig object No description.
MountDesc object No description.
MountHost object No description.
NasConfigs object No description.
NasId object No description.
OssAkId object No description.
OssAkSecret object No description.
OssMountDescs object No description.
PackageUrl object No description.
PackageVersion object No description.
Php object No description.
PhpArmsConfigLocation object No description.
PhpConfig object No description.
PhpConfigLocation object No description.
PostStart object No description.
PreStop object No description.
ProgrammingLanguage object No description.
PvtzDiscoverySvc object No description.
Python object No description.
PythonModules object No description.
Readiness object No description.
SaeVersion object No description.
SecurityGroupId object No description.
ServiceTags object No description.
SlsConfigs object No description.
Tags TagsProperty[] No description.
TerminationGracePeriodSeconds object No description.
Timezone object No description.
TomcatConfig object No description.
VpcId object No description.
VSwitchId object No description.
WarStartOptions object No description.
WebContainer object No description.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

public string[] CreationStack { get; }
  • Type: string[]

LogicalIdRequired

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).


StackRequired

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).


RefRequired

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 }).


RosOptionsRequired

public IRosResourceOptions RosOptions { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions

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


RosResourceTypeRequired

public string RosResourceType { get; }
  • Type: string

ROS resource type.


AttrAppIdRequired

public IResolvable AttrAppId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrChangeOrderIdRequired

public IResolvable AttrChangeOrderId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AppNameRequired

public object AppName { get; }
  • Type: object

CpuRequired

public object Cpu { get; }
  • Type: object

EnableResourcePropertyConstraintRequired

public bool EnableResourcePropertyConstraint { get; }
  • Type: bool

MemoryRequired

public object Memory { get; }
  • Type: object

NamespaceIdRequired

public object NamespaceId { get; }
  • Type: object

PackageTypeRequired

public object PackageType { get; }
  • Type: object

ReplicasRequired

public object Replicas { get; }
  • Type: object

AcrAssumeRoleArnOptional

public object AcrAssumeRoleArn { get; }
  • Type: object

AcrInstanceIdOptional

public object AcrInstanceId { get; }
  • Type: object

AppDescriptionOptional

public object AppDescription { get; }
  • Type: object

AppSourceOptional

public object AppSource { get; }
  • Type: object

AssociateEipOptional

public object AssociateEip { get; }
  • Type: object

AutoConfigOptional

public object AutoConfig { get; }
  • Type: object

BaseAppIdOptional

public object BaseAppId { get; }
  • Type: object

CommandOptional

public object Command { get; }
  • Type: object

CommandArgsOptional

public object CommandArgs { get; }
  • Type: object

ConfigMapMountDescOptional

public object ConfigMapMountDesc { get; }
  • Type: object

CustomHostAliasOptional

public object CustomHostAlias { get; }
  • Type: object

DeployOptional

public object Deploy { get; }
  • Type: object

EdasContainerVersionOptional

public object EdasContainerVersion { get; }
  • Type: object

EnableEbpfOptional

public object EnableEbpf { get; }
  • Type: object

EnvsOptional

public object Envs { get; }
  • Type: object

ImagePullSecretsOptional

public object ImagePullSecrets { get; }
  • Type: object

ImageUrlOptional

public object ImageUrl { get; }
  • Type: object

JarStartArgsOptional

public object JarStartArgs { get; }
  • Type: object

JarStartOptionsOptional

public object JarStartOptions { get; }
  • Type: object

JdkOptional

public object Jdk { get; }
  • Type: object

KafkaConfigsOptional

public object KafkaConfigs { get; }
  • Type: object

LivenessOptional

public object Liveness { get; }
  • Type: object

MicroRegistrationOptional

public object MicroRegistration { get; }
  • Type: object

MicroRegistrationConfigOptional

public object MicroRegistrationConfig { get; }
  • Type: object

MountDescOptional

public object MountDesc { get; }
  • Type: object

MountHostOptional

public object MountHost { get; }
  • Type: object

NasConfigsOptional

public object NasConfigs { get; }
  • Type: object

NasIdOptional

public object NasId { get; }
  • Type: object

OssAkIdOptional

public object OssAkId { get; }
  • Type: object

OssAkSecretOptional

public object OssAkSecret { get; }
  • Type: object

OssMountDescsOptional

public object OssMountDescs { get; }
  • Type: object

PackageUrlOptional

public object PackageUrl { get; }
  • Type: object

PackageVersionOptional

public object PackageVersion { get; }
  • Type: object

PhpOptional

public object Php { get; }
  • Type: object

PhpArmsConfigLocationOptional

public object PhpArmsConfigLocation { get; }
  • Type: object

PhpConfigOptional

public object PhpConfig { get; }
  • Type: object

PhpConfigLocationOptional

public object PhpConfigLocation { get; }
  • Type: object

PostStartOptional

public object PostStart { get; }
  • Type: object

PreStopOptional

public object PreStop { get; }
  • Type: object

ProgrammingLanguageOptional

public object ProgrammingLanguage { get; }
  • Type: object

PvtzDiscoverySvcOptional

public object PvtzDiscoverySvc { get; }
  • Type: object

PythonOptional

public object Python { get; }
  • Type: object

PythonModulesOptional

public object PythonModules { get; }
  • Type: object

ReadinessOptional

public object Readiness { get; }
  • Type: object

SaeVersionOptional

public object SaeVersion { get; }
  • Type: object

SecurityGroupIdOptional

public object SecurityGroupId { get; }
  • Type: object

ServiceTagsOptional

public object ServiceTags { get; }
  • Type: object

SlsConfigsOptional

public object SlsConfigs { get; }
  • Type: object

TagsOptional

public TagsProperty[] Tags { get; }

TerminationGracePeriodSecondsOptional

public object TerminationGracePeriodSeconds { get; }
  • Type: object

TimezoneOptional

public object Timezone { get; }
  • Type: object

TomcatConfigOptional

public object TomcatConfig { get; }
  • Type: object

VpcIdOptional

public object VpcId { get; }
  • Type: object

VSwitchIdOptional

public object VSwitchId { get; }
  • Type: object

WarStartOptionsOptional

public object WarStartOptions { get; }
  • Type: object

WebContainerOptional

public object WebContainer { get; }
  • Type: object

Constants

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

RosResourceTypeNameRequired

public string RosResourceTypeName { get; }
  • Type: string

The resource type name for this resource class.