RosLaunchTemplate
This class is a base encapsulation around the ROS resource type ALIYUN::ECS::LaunchTemplate, which is used to create a launch template.
You can use a launch template to create an Elastic Compute Service (ECS) instance.
Initializers
using AlibabaCloud.SDK.ROS.CDK.Ecs;
new RosLaunchTemplate(Construct Scope, string Id, RosLaunchTemplateProps 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 |
RosLaunchTemplateProps |
- 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
- Type: RosLaunchTemplateProps
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.
- 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.Ecs;
RosLaunchTemplate.IsConstruct(object X);
Return whether the given object is a Construct.
- Type: object
IsRosElement
using AlibabaCloud.SDK.ROS.CDK.Ecs;
RosLaunchTemplate.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.Ecs;
RosLaunchTemplate.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. |
AttrDefaultVersionNumber |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
AttrLatestVersionNumber |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
AttrLaunchTemplateId |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
AttrLaunchTemplateName |
AlibabaCloud.SDK.ROS.CDK.Core.IResolvable |
No description. |
EnableResourcePropertyConstraint |
bool |
No description. |
LaunchTemplateName |
object |
No description. |
AutoReleaseTime |
object |
No description. |
DeploymentSetId |
object |
No description. |
Description |
object |
No description. |
DiskMappings |
object |
No description. |
HostName |
object |
No description. |
ImageId |
object |
No description. |
ImageOwnerAlias |
object |
No description. |
InstanceChargeType |
object |
No description. |
InstanceName |
object |
No description. |
InstanceType |
object |
No description. |
InternetChargeType |
object |
No description. |
InternetMaxBandwidthOut |
object |
No description. |
IoOptimized |
object |
No description. |
Ipv6AddressCount |
object |
No description. |
KeyPairName |
object |
No description. |
NetworkInterfaces |
object |
No description. |
NetworkType |
object |
No description. |
PasswordInherit |
object |
No description. |
Period |
object |
No description. |
PrivateIpAddress |
object |
No description. |
RamRoleName |
object |
No description. |
ResourceGroupId |
object |
No description. |
SecurityEnhancementStrategy |
object |
No description. |
SecurityGroupId |
object |
No description. |
SecurityGroupIds |
object |
No description. |
SpotDuration |
object |
No description. |
SpotPriceLimit |
object |
No description. |
SpotStrategy |
object |
No description. |
SystemDiskCategory |
object |
No description. |
SystemDiskDeleteWithInstance |
object |
No description. |
SystemDiskDescription |
object |
No description. |
SystemDiskDiskName |
object |
No description. |
SystemDiskPerformanceLevel |
object |
No description. |
SystemDiskSize |
object |
No description. |
Tags |
TagsProperty[] |
No description. |
TemplateResourceGroupId |
object |
No description. |
TemplateTags |
object |
No description. |
UserData |
object |
No description. |
VersionDescription |
object |
No description. |
VSwitchId |
object |
No description. |
ZoneId |
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.
AttrDefaultVersionNumberRequired
public IResolvable AttrDefaultVersionNumber { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
AttrLatestVersionNumberRequired
public IResolvable AttrLatestVersionNumber { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
AttrLaunchTemplateIdRequired
public IResolvable AttrLaunchTemplateId { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
AttrLaunchTemplateNameRequired
public IResolvable AttrLaunchTemplateName { get; }
- Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable
EnableResourcePropertyConstraintRequired
public bool EnableResourcePropertyConstraint { get; }
- Type: bool
LaunchTemplateNameRequired
public object LaunchTemplateName { get; }
- Type: object
AutoReleaseTimeOptional
public object AutoReleaseTime { get; }
- Type: object
DeploymentSetIdOptional
public object DeploymentSetId { get; }
- Type: object
DescriptionOptional
public object Description { get; }
- Type: object
DiskMappingsOptional
public object DiskMappings { get; }
- Type: object
HostNameOptional
public object HostName { get; }
- Type: object
ImageIdOptional
public object ImageId { get; }
- Type: object
ImageOwnerAliasOptional
public object ImageOwnerAlias { get; }
- Type: object
InstanceChargeTypeOptional
public object InstanceChargeType { get; }
- Type: object
InstanceNameOptional
public object InstanceName { get; }
- Type: object
InstanceTypeOptional
public object InstanceType { get; }
- Type: object
InternetChargeTypeOptional
public object InternetChargeType { get; }
- Type: object
InternetMaxBandwidthOutOptional
public object InternetMaxBandwidthOut { get; }
- Type: object
IoOptimizedOptional
public object IoOptimized { get; }
- Type: object
Ipv6AddressCountOptional
public object Ipv6AddressCount { get; }
- Type: object
KeyPairNameOptional
public object KeyPairName { get; }
- Type: object
NetworkInterfacesOptional
public object NetworkInterfaces { get; }
- Type: object
NetworkTypeOptional
public object NetworkType { get; }
- Type: object
PasswordInheritOptional
public object PasswordInherit { get; }
- Type: object
PeriodOptional
public object Period { get; }
- Type: object
PrivateIpAddressOptional
public object PrivateIpAddress { get; }
- Type: object
RamRoleNameOptional
public object RamRoleName { get; }
- Type: object
ResourceGroupIdOptional
public object ResourceGroupId { get; }
- Type: object
SecurityEnhancementStrategyOptional
public object SecurityEnhancementStrategy { get; }
- Type: object
SecurityGroupIdOptional
public object SecurityGroupId { get; }
- Type: object
SecurityGroupIdsOptional
public object SecurityGroupIds { get; }
- Type: object
SpotDurationOptional
public object SpotDuration { get; }
- Type: object
SpotPriceLimitOptional
public object SpotPriceLimit { get; }
- Type: object
SpotStrategyOptional
public object SpotStrategy { get; }
- Type: object
SystemDiskCategoryOptional
public object SystemDiskCategory { get; }
- Type: object
SystemDiskDeleteWithInstanceOptional
public object SystemDiskDeleteWithInstance { get; }
- Type: object
SystemDiskDescriptionOptional
public object SystemDiskDescription { get; }
- Type: object
SystemDiskDiskNameOptional
public object SystemDiskDiskName { get; }
- Type: object
SystemDiskPerformanceLevelOptional
public object SystemDiskPerformanceLevel { get; }
- Type: object
SystemDiskSizeOptional
public object SystemDiskSize { get; }
- Type: object
TagsOptional
public TagsProperty[] Tags { get; }
- Type: TagsProperty[]
TemplateResourceGroupIdOptional
public object TemplateResourceGroupId { get; }
- Type: object
TemplateTagsOptional
public object TemplateTags { get; }
- Type: object
UserDataOptional
public object UserData { get; }
- Type: object
VersionDescriptionOptional
public object VersionDescription { get; }
- Type: object
VSwitchIdOptional
public object VSwitchId { get; }
- Type: object
ZoneIdOptional
public object ZoneId { 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.