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. |
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: RosApplicationProps
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.
- 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.
- Type: string
The new logical ID to use for this stack element.
AddCondition
private void AddCondition(RosCondition Con)
- Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition
AddCount
private void AddCount(object Count)
- Type: object
AddDeletionOverride
private void AddDeletionOverride(string Path)
Syntactic sugar for addOverride(path, undefined)
.
- 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.
- Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource
AddDesc
private void AddDesc(string Desc)
- Type: string
AddMetaData
private void AddMetaData(string Key, object Value)
- Type: string
- 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"
...
},
]
...
}
- 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: 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.
- 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)
.
- Type: string
The path of the property.
- Type: object
The value.
AddRosDependency
private void AddRosDependency(string Target)
- 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.
- Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy
- 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.
- 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.
- 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.
- Type: object
IsRosResource
using AlibabaCloud.SDK.ROS.CDK.Sae;
RosApplication.IsRosResource(IConstruct Construct);
Check whether the given construct is a RosResource.
- 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. |
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
AttrChangeOrderId
Required
public IResolvable AttrChangeOrderId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
AppName
Required
public object AppName { get; }
- Type: object
Cpu
Required
public object Cpu { get; }
- Type: object
EnableResourcePropertyConstraint
Required
public bool EnableResourcePropertyConstraint { get; }
- Type: bool
Memory
Required
public object Memory { get; }
- Type: object
NamespaceId
Required
public object NamespaceId { get; }
- Type: object
PackageType
Required
public object PackageType { get; }
- Type: object
Replicas
Required
public object Replicas { get; }
- Type: object
AcrAssumeRoleArn
Optional
public object AcrAssumeRoleArn { get; }
- Type: object
AcrInstanceId
Optional
public object AcrInstanceId { get; }
- Type: object
AppDescription
Optional
public object AppDescription { get; }
- Type: object
AppSource
Optional
public object AppSource { get; }
- Type: object
AssociateEip
Optional
public object AssociateEip { get; }
- Type: object
AutoConfig
Optional
public object AutoConfig { get; }
- Type: object
BaseAppId
Optional
public object BaseAppId { get; }
- Type: object
Command
Optional
public object Command { get; }
- Type: object
CommandArgs
Optional
public object CommandArgs { get; }
- Type: object
ConfigMapMountDesc
Optional
public object ConfigMapMountDesc { get; }
- Type: object
CustomHostAlias
Optional
public object CustomHostAlias { get; }
- Type: object
Deploy
Optional
public object Deploy { get; }
- Type: object
EdasContainerVersion
Optional
public object EdasContainerVersion { get; }
- Type: object
EnableEbpf
Optional
public object EnableEbpf { get; }
- Type: object
Envs
Optional
public object Envs { get; }
- Type: object
ImagePullSecrets
Optional
public object ImagePullSecrets { get; }
- Type: object
ImageUrl
Optional
public object ImageUrl { get; }
- Type: object
JarStartArgs
Optional
public object JarStartArgs { get; }
- Type: object
JarStartOptions
Optional
public object JarStartOptions { get; }
- Type: object
Jdk
Optional
public object Jdk { get; }
- Type: object
KafkaConfigs
Optional
public object KafkaConfigs { get; }
- Type: object
Liveness
Optional
public object Liveness { get; }
- Type: object
MicroRegistration
Optional
public object MicroRegistration { get; }
- Type: object
MicroRegistrationConfig
Optional
public object MicroRegistrationConfig { get; }
- Type: object
MountDesc
Optional
public object MountDesc { get; }
- Type: object
MountHost
Optional
public object MountHost { get; }
- Type: object
NasConfigs
Optional
public object NasConfigs { get; }
- Type: object
NasId
Optional
public object NasId { get; }
- Type: object
OssAkId
Optional
public object OssAkId { get; }
- Type: object
OssAkSecret
Optional
public object OssAkSecret { get; }
- Type: object
OssMountDescs
Optional
public object OssMountDescs { get; }
- Type: object
PackageUrl
Optional
public object PackageUrl { get; }
- Type: object
PackageVersion
Optional
public object PackageVersion { get; }
- Type: object
Php
Optional
public object Php { get; }
- Type: object
PhpArmsConfigLocation
Optional
public object PhpArmsConfigLocation { get; }
- Type: object
PhpConfig
Optional
public object PhpConfig { get; }
- Type: object
PhpConfigLocation
Optional
public object PhpConfigLocation { get; }
- Type: object
PostStart
Optional
public object PostStart { get; }
- Type: object
PreStop
Optional
public object PreStop { get; }
- Type: object
ProgrammingLanguage
Optional
public object ProgrammingLanguage { get; }
- Type: object
PvtzDiscoverySvc
Optional
public object PvtzDiscoverySvc { get; }
- Type: object
Python
Optional
public object Python { get; }
- Type: object
PythonModules
Optional
public object PythonModules { get; }
- Type: object
Readiness
Optional
public object Readiness { get; }
- Type: object
SaeVersion
Optional
public object SaeVersion { get; }
- Type: object
SecurityGroupId
Optional
public object SecurityGroupId { get; }
- Type: object
ServiceTags
Optional
public object ServiceTags { get; }
- Type: object
SlsConfigs
Optional
public object SlsConfigs { get; }
- Type: object
Tags
Optional
public TagsProperty[] Tags { get; }
- Type: TagsProperty[]
TerminationGracePeriodSeconds
Optional
public object TerminationGracePeriodSeconds { get; }
- Type: object
Timezone
Optional
public object Timezone { get; }
- Type: object
TomcatConfig
Optional
public object TomcatConfig { get; }
- Type: object
VpcId
Optional
public object VpcId { get; }
- Type: object
VSwitchId
Optional
public object VSwitchId { get; }
- Type: object
WarStartOptions
Optional
public object WarStartOptions { get; }
- Type: object
WebContainer
Optional
public object WebContainer { 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.