RosLaunchTemplate
This class is a base encapsulation around the ROS resource type DATASOURCE::ECS::LaunchTemplate
.
Initializers
import { datasource } from '@alicloud/ros-cdk-ecs'
new datasource.RosLaunchTemplate(scope: Construct, id: string, props: RosLaunchTemplateProps, 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 |
RosLaunchTemplateProps |
- 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: RosLaunchTemplateProps
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 { datasource } from '@alicloud/ros-cdk-ecs'
datasource.RosLaunchTemplate.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
isRosElement
import { datasource } from '@alicloud/ros-cdk-ecs'
datasource.RosLaunchTemplate.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 { datasource } from '@alicloud/ros-cdk-ecs'
datasource.RosLaunchTemplate.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. |
attrAutoReleaseTime |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrCreatedBy |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrCreateTime |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrDataDisk |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrDefaultVersionNumber |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrDeletionProtection |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrDeploymentSetId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrDescription |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrHostName |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrImageId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrImageOwnerAlias |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrInstanceChargeType |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrInstanceName |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrInstanceType |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrInternetChargeType |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrInternetMaxBandwidthIn |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrInternetMaxBandwidthOut |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrIoOptimized |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrIpv6AddressCount |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrKeyPairName |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrLatestVersionNumber |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrLaunchTemplateId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrLaunchTemplateName |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrModifiedTime |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrNetworkInterface |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrNetworkType |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrPasswordInherit |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrPeriod |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrPrivateIpAddress |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrRamRoleName |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrResourceGroupId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrSecurityEnhancementStrategy |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrSecurityGroupIds |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrSpotPriceLimit |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrSpotStrategy |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrSystemDisk |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrTags |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrTemplateResourceGroupId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrTemplateTag |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrUserData |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrVersionDescription |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrVpcId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrVSwitchId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrZoneId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
enableResourcePropertyConstraint |
boolean |
No description. |
launchTemplateId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
refreshOptions |
string | @alicloud/ros-cdk-core.IResolvable |
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.
attrAutoReleaseTime
Required
public readonly attrAutoReleaseTime: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrCreatedBy
Required
public readonly attrCreatedBy: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrCreateTime
Required
public readonly attrCreateTime: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrDataDisk
Required
public readonly attrDataDisk: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrDefaultVersionNumber
Required
public readonly attrDefaultVersionNumber: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrDeletionProtection
Required
public readonly attrDeletionProtection: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrDeploymentSetId
Required
public readonly attrDeploymentSetId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrDescription
Required
public readonly attrDescription: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrHostName
Required
public readonly attrHostName: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrImageId
Required
public readonly attrImageId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrImageOwnerAlias
Required
public readonly attrImageOwnerAlias: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrInstanceChargeType
Required
public readonly attrInstanceChargeType: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrInstanceName
Required
public readonly attrInstanceName: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrInstanceType
Required
public readonly attrInstanceType: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrInternetChargeType
Required
public readonly attrInternetChargeType: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrInternetMaxBandwidthIn
Required
public readonly attrInternetMaxBandwidthIn: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrInternetMaxBandwidthOut
Required
public readonly attrInternetMaxBandwidthOut: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrIoOptimized
Required
public readonly attrIoOptimized: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrIpv6AddressCount
Required
public readonly attrIpv6AddressCount: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrKeyPairName
Required
public readonly attrKeyPairName: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrLatestVersionNumber
Required
public readonly attrLatestVersionNumber: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrLaunchTemplateId
Required
public readonly attrLaunchTemplateId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrLaunchTemplateName
Required
public readonly attrLaunchTemplateName: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrModifiedTime
Required
public readonly attrModifiedTime: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrNetworkInterface
Required
public readonly attrNetworkInterface: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrNetworkType
Required
public readonly attrNetworkType: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrPasswordInherit
Required
public readonly attrPasswordInherit: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrPeriod
Required
public readonly attrPeriod: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrPrivateIpAddress
Required
public readonly attrPrivateIpAddress: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrRamRoleName
Required
public readonly attrRamRoleName: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrResourceGroupId
Required
public readonly attrResourceGroupId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrSecurityEnhancementStrategy
Required
public readonly attrSecurityEnhancementStrategy: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrSecurityGroupIds
Required
public readonly attrSecurityGroupIds: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrSpotPriceLimit
Required
public readonly attrSpotPriceLimit: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrSpotStrategy
Required
public readonly attrSpotStrategy: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrSystemDisk
Required
public readonly attrSystemDisk: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrTags
Required
public readonly attrTags: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrTemplateResourceGroupId
Required
public readonly attrTemplateResourceGroupId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrTemplateTag
Required
public readonly attrTemplateTag: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrUserData
Required
public readonly attrUserData: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrVersionDescription
Required
public readonly attrVersionDescription: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrVpcId
Required
public readonly attrVpcId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrVSwitchId
Required
public readonly attrVSwitchId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrZoneId
Required
public readonly attrZoneId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
enableResourcePropertyConstraint
Required
public readonly enableResourcePropertyConstraint: boolean;
- Type: boolean
launchTemplateId
Required
public readonly launchTemplateId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
refreshOptions
Optional
public readonly refreshOptions: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
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.