Skip to content

RosLaunchTemplate

This class is a base encapsulation around the ROS resource type DATASOURCE::ECS::LaunchTemplate, which is used to query the information about a launch template.

Initializers 

import com.aliyun.ros.cdk.ecs.datasource.RosLaunchTemplate;
RosLaunchTemplate.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .launchTemplateId(java.lang.String)
    .launchTemplateId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct - scope in which this resource is defined.
id java.lang.String - scoped id of the resource.
enableResourcePropertyConstraint java.lang.Boolean No description.
launchTemplateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

scope in which this resource is defined.

idRequired

  • Type: java.lang.String

scoped id of the resource.

enableResourcePropertyConstraintRequired

  • Type: java.lang.Boolean

launchTemplateIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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 java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public 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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

overrideLogicalId 

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired

  • Type: java.lang.String

The new logical ID to use for this stack element.

addCondition 

public void addCondition(RosCondition con)

conRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDeletionOverride 

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: java.lang.String

The path of the value to delete.

addDependsOn 

public 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: com.aliyun.ros.cdk.core.RosResource

addDesc 

public void addDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

addMetaData 

public void addMetaData(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

addOverride 

public void addOverride(java.lang.String path, java.lang.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: java.lang.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: java.lang.Object

The value.

Could be primitive or complex.

addPropertyDeletionOverride 

public void addPropertyDeletionOverride(java.lang.String propertyPath)

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

propertyPathRequired

  • Type: java.lang.String

The path to the property.

addPropertyOverride 

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPathRequired

  • Type: java.lang.String

The path of the property.

valueRequired

  • Type: java.lang.Object

The value.

addRosDependency 

public void addRosDependency(java.lang.String target)

targetRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

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

policyOptional

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

optionsOptional

  • Type: com.aliyun.ros.cdk.core.RemovalPolicyOptions

getAtt 

public Reference getAtt(java.lang.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: java.lang.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 com.aliyun.ros.cdk.ecs.datasource.RosLaunchTemplate;
RosLaunchTemplate.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement 

import com.aliyun.ros.cdk.ecs.datasource.RosLaunchTemplate;
RosLaunchTemplate.isRosElement(java.lang.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: java.lang.Object

isRosResource 

import com.aliyun.ros.cdk.ecs.datasource.RosLaunchTemplate;
RosLaunchTemplate.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

constructRequired

  • Type: com.aliyun.ros.cdk.core.IConstruct

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
creationStack java.util.List No description.
logicalId java.lang.String The logical ID for this stack element.
stack com.aliyun.ros.cdk.core.Stack The stack in which this element is defined.
ref java.lang.String Return a string that will be resolved to a RosTemplate { Ref } for this element.
rosOptions com.aliyun.ros.cdk.core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
rosResourceType java.lang.String ROS resource type.
attrAutoReleaseTime com.aliyun.ros.cdk.core.IResolvable No description.
attrCreatedBy com.aliyun.ros.cdk.core.IResolvable No description.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable No description.
attrDataDisk com.aliyun.ros.cdk.core.IResolvable No description.
attrDefaultVersionNumber com.aliyun.ros.cdk.core.IResolvable No description.
attrDeletionProtection com.aliyun.ros.cdk.core.IResolvable No description.
attrDeploymentSetId com.aliyun.ros.cdk.core.IResolvable No description.
attrDescription com.aliyun.ros.cdk.core.IResolvable No description.
attrHostName com.aliyun.ros.cdk.core.IResolvable No description.
attrImageId com.aliyun.ros.cdk.core.IResolvable No description.
attrImageOwnerAlias com.aliyun.ros.cdk.core.IResolvable No description.
attrInstanceChargeType com.aliyun.ros.cdk.core.IResolvable No description.
attrInstanceName com.aliyun.ros.cdk.core.IResolvable No description.
attrInstanceType com.aliyun.ros.cdk.core.IResolvable No description.
attrInternetChargeType com.aliyun.ros.cdk.core.IResolvable No description.
attrInternetMaxBandwidthIn com.aliyun.ros.cdk.core.IResolvable No description.
attrInternetMaxBandwidthOut com.aliyun.ros.cdk.core.IResolvable No description.
attrIoOptimized com.aliyun.ros.cdk.core.IResolvable No description.
attrIpv6AddressCount com.aliyun.ros.cdk.core.IResolvable No description.
attrKeyPairName com.aliyun.ros.cdk.core.IResolvable No description.
attrLatestVersionNumber com.aliyun.ros.cdk.core.IResolvable No description.
attrLaunchTemplateId com.aliyun.ros.cdk.core.IResolvable No description.
attrLaunchTemplateName com.aliyun.ros.cdk.core.IResolvable No description.
attrModifiedTime com.aliyun.ros.cdk.core.IResolvable No description.
attrNetworkInterface com.aliyun.ros.cdk.core.IResolvable No description.
attrNetworkType com.aliyun.ros.cdk.core.IResolvable No description.
attrPasswordInherit com.aliyun.ros.cdk.core.IResolvable No description.
attrPeriod com.aliyun.ros.cdk.core.IResolvable No description.
attrPrivateIpAddress com.aliyun.ros.cdk.core.IResolvable No description.
attrRamRoleName com.aliyun.ros.cdk.core.IResolvable No description.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable No description.
attrSecurityEnhancementStrategy com.aliyun.ros.cdk.core.IResolvable No description.
attrSecurityGroupIds com.aliyun.ros.cdk.core.IResolvable No description.
attrSpotPriceLimit com.aliyun.ros.cdk.core.IResolvable No description.
attrSpotStrategy com.aliyun.ros.cdk.core.IResolvable No description.
attrSystemDisk com.aliyun.ros.cdk.core.IResolvable No description.
attrTags com.aliyun.ros.cdk.core.IResolvable No description.
attrTemplateResourceGroupId com.aliyun.ros.cdk.core.IResolvable No description.
attrTemplateTag com.aliyun.ros.cdk.core.IResolvable No description.
attrUserData com.aliyun.ros.cdk.core.IResolvable No description.
attrVersionDescription com.aliyun.ros.cdk.core.IResolvable No description.
attrVpcId com.aliyun.ros.cdk.core.IResolvable No description.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable No description.
attrZoneId com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
launchTemplateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

creationStackRequired 

public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List

logicalIdRequired 

public java.lang.String getLogicalId();
  • Type: java.lang.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 getStack();
  • Type: com.aliyun.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 java.lang.String getRef();
  • Type: java.lang.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 getRosOptions();
  • Type: com.aliyun.ros.cdk.core.IRosResourceOptions

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

rosResourceTypeRequired 

public java.lang.String getRosResourceType();
  • Type: java.lang.String

ROS resource type.

attrAutoReleaseTimeRequired 

public IResolvable getAttrAutoReleaseTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrCreatedByRequired 

public IResolvable getAttrCreatedBy();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrDataDiskRequired 

public IResolvable getAttrDataDisk();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrDefaultVersionNumberRequired 

public IResolvable getAttrDefaultVersionNumber();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrDeletionProtectionRequired 

public IResolvable getAttrDeletionProtection();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrDeploymentSetIdRequired 

public IResolvable getAttrDeploymentSetId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrDescriptionRequired 

public IResolvable getAttrDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrHostNameRequired 

public IResolvable getAttrHostName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrImageIdRequired 

public IResolvable getAttrImageId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrImageOwnerAliasRequired 

public IResolvable getAttrImageOwnerAlias();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInstanceChargeTypeRequired 

public IResolvable getAttrInstanceChargeType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInstanceNameRequired 

public IResolvable getAttrInstanceName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInstanceTypeRequired 

public IResolvable getAttrInstanceType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInternetChargeTypeRequired 

public IResolvable getAttrInternetChargeType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInternetMaxBandwidthInRequired 

public IResolvable getAttrInternetMaxBandwidthIn();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInternetMaxBandwidthOutRequired 

public IResolvable getAttrInternetMaxBandwidthOut();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrIoOptimizedRequired 

public IResolvable getAttrIoOptimized();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrIpv6AddressCountRequired 

public IResolvable getAttrIpv6AddressCount();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrKeyPairNameRequired 

public IResolvable getAttrKeyPairName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrLatestVersionNumberRequired 

public IResolvable getAttrLatestVersionNumber();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrLaunchTemplateIdRequired 

public IResolvable getAttrLaunchTemplateId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrLaunchTemplateNameRequired 

public IResolvable getAttrLaunchTemplateName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrModifiedTimeRequired 

public IResolvable getAttrModifiedTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrNetworkInterfaceRequired 

public IResolvable getAttrNetworkInterface();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrNetworkTypeRequired 

public IResolvable getAttrNetworkType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrPasswordInheritRequired 

public IResolvable getAttrPasswordInherit();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrPeriodRequired 

public IResolvable getAttrPeriod();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrPrivateIpAddressRequired 

public IResolvable getAttrPrivateIpAddress();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrRamRoleNameRequired 

public IResolvable getAttrRamRoleName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrResourceGroupIdRequired 

public IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrSecurityEnhancementStrategyRequired 

public IResolvable getAttrSecurityEnhancementStrategy();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrSecurityGroupIdsRequired 

public IResolvable getAttrSecurityGroupIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrSpotPriceLimitRequired 

public IResolvable getAttrSpotPriceLimit();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrSpotStrategyRequired 

public IResolvable getAttrSpotStrategy();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrSystemDiskRequired 

public IResolvable getAttrSystemDisk();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrTagsRequired 

public IResolvable getAttrTags();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrTemplateResourceGroupIdRequired 

public IResolvable getAttrTemplateResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrTemplateTagRequired 

public IResolvable getAttrTemplateTag();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrUserDataRequired 

public IResolvable getAttrUserData();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrVersionDescriptionRequired 

public IResolvable getAttrVersionDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrVpcIdRequired 

public IResolvable getAttrVpcId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrVSwitchIdRequired 

public IResolvable getAttrVSwitchId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrZoneIdRequired 

public IResolvable getAttrZoneId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

enableResourcePropertyConstraintRequired 

public java.lang.Boolean getEnableResourcePropertyConstraint();
  • Type: java.lang.Boolean

launchTemplateIdRequired 

public java.lang.Object getLaunchTemplateId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

refreshOptionsOptional 

public java.lang.Object getRefreshOptions();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME java.lang.String The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired 

public java.lang.String getRosResourceTypeName();
  • Type: java.lang.String

The resource type name for this resource class.