Skip to content

RosInstance

This class is a base encapsulation around the ROS resource type ALIYUN::ECS::Instance, which is used to create an Elastic Compute Service (ECS) instance.

Initializers 

import com.aliyun.ros.cdk.ecs.RosInstance;
RosInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceType(java.lang.String)
    .instanceType(IResolvable)
//  .affinity(java.lang.String)
//  .affinity(IResolvable)
//  .allocatePublicIp(java.lang.Boolean)
//  .allocatePublicIp(IResolvable)
//  .autoRenew(java.lang.String)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .creditSpecification(java.lang.String)
//  .creditSpecification(IResolvable)
//  .dedicatedHostId(java.lang.String)
//  .dedicatedHostId(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .deploymentSetGroupNo(java.lang.Number)
//  .deploymentSetGroupNo(IResolvable)
//  .deploymentSetId(java.lang.String)
//  .deploymentSetId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .diskMappings(IResolvable)
//  .diskMappings(java.util.List<IResolvable)
//  .diskMappings(DiskMappingsProperty>)
//  .hostName(java.lang.String)
//  .hostName(IResolvable)
//  .hpcClusterId(java.lang.String)
//  .hpcClusterId(IResolvable)
//  .httpEndpoint(java.lang.String)
//  .httpEndpoint(IResolvable)
//  .httpTokens(java.lang.String)
//  .httpTokens(IResolvable)
//  .imageFamily(java.lang.String)
//  .imageFamily(IResolvable)
//  .imageId(java.lang.String)
//  .imageId(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .internetMaxBandwidthOut(java.lang.Number)
//  .internetMaxBandwidthOut(IResolvable)
//  .ioOptimized(java.lang.String)
//  .ioOptimized(IResolvable)
//  .keyPairName(java.lang.String)
//  .keyPairName(IResolvable)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .passwordInherit(java.lang.Boolean)
//  .passwordInherit(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .privateIpAddress(java.lang.String)
//  .privateIpAddress(IResolvable)
//  .privatePoolOptions(IResolvable)
//  .privatePoolOptions(PrivatePoolOptionsProperty)
//  .ramRoleName(java.lang.String)
//  .ramRoleName(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .securityEnhancementStrategy(java.lang.String)
//  .securityEnhancementStrategy(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .securityGroupIds(IResolvable)
//  .securityGroupIds(java.util.List<java.lang.String)
//  .securityGroupIds(IResolvable>)
//  .spotDuration(java.lang.Number)
//  .spotDuration(IResolvable)
//  .spotInterruptionBehavior(java.lang.String)
//  .spotInterruptionBehavior(IResolvable)
//  .spotPriceLimit(java.lang.String)
//  .spotPriceLimit(IResolvable)
//  .spotStrategy(java.lang.String)
//  .spotStrategy(IResolvable)
//  .storageSetId(java.lang.String)
//  .storageSetId(IResolvable)
//  .storageSetPartitionNumber(java.lang.Number)
//  .storageSetPartitionNumber(IResolvable)
//  .systemDiskCategory(java.lang.String)
//  .systemDiskCategory(IResolvable)
//  .systemDiskDescription(java.lang.String)
//  .systemDiskDescription(IResolvable)
//  .systemDiskDiskName(java.lang.String)
//  .systemDiskDiskName(IResolvable)
//  .systemDiskPerformanceLevel(java.lang.String)
//  .systemDiskPerformanceLevel(IResolvable)
//  .systemDiskSize(java.lang.Number)
//  .systemDiskSize(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .tenancy(java.lang.String)
//  .tenancy(IResolvable)
//  .useAdditionalService(java.lang.Boolean)
//  .useAdditionalService(IResolvable)
//  .userData(java.lang.String)
//  .userData(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
//  .zoneIds(IResolvable)
//  .zoneIds(java.util.List<java.lang.String)
//  .zoneIds(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.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
affinity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
allocatePublicIp java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenew java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
creditSpecification java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dedicatedHostId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
deploymentSetGroupNo java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
deploymentSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
diskMappings com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDiskMappingsProperty> No description.
hostName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
hpcClusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
httpEndpoint java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
httpTokens java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
imageFamily java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
imageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
internetMaxBandwidthOut java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
ioOptimized java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
keyPairName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
passwordInherit java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
privateIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
privatePoolOptions com.aliyun.ros.cdk.core.IResolvable OR PrivatePoolOptionsProperty No description.
ramRoleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
securityEnhancementStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
securityGroupIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
spotDuration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
spotInterruptionBehavior java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
spotPriceLimit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
spotStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
storageSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
storageSetPartitionNumber java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskDiskName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskPerformanceLevel java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
tenancy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
useAdditionalService java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
userData java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
zoneIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List 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

instanceTypeRequired

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

affinityOptional

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

allocatePublicIpOptional

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

autoRenewOptional

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

autoRenewPeriodOptional

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

creditSpecificationOptional

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

dedicatedHostIdOptional

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

deletionProtectionOptional

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

deploymentSetGroupNoOptional

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

deploymentSetIdOptional

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

descriptionOptional

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

diskMappingsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDiskMappingsProperty>

hostNameOptional

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

hpcClusterIdOptional

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

httpEndpointOptional

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

httpTokensOptional

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

imageFamilyOptional

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

imageIdOptional

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

instanceChargeTypeOptional

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

instanceNameOptional

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

internetChargeTypeOptional

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

internetMaxBandwidthOutOptional

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

ioOptimizedOptional

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

keyPairNameOptional

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

passwordOptional

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

passwordInheritOptional

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

periodOptional

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

periodUnitOptional

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

privateIpAddressOptional

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

privatePoolOptionsOptional

ramRoleNameOptional

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

resourceGroupIdOptional

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

securityEnhancementStrategyOptional

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

securityGroupIdOptional

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

securityGroupIdsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

spotDurationOptional

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

spotInterruptionBehaviorOptional

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

spotPriceLimitOptional

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

spotStrategyOptional

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

storageSetIdOptional

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

storageSetPartitionNumberOptional

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

systemDiskCategoryOptional

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

systemDiskDescriptionOptional

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

systemDiskDiskNameOptional

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

systemDiskPerformanceLevelOptional

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

systemDiskSizeOptional

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

tagsOptional

tenancyOptional

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

useAdditionalServiceOptional

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

userDataOptional

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

vpcIdOptional

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

vSwitchIdOptional

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

zoneIdOptional

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

zoneIdsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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.RosInstance;
RosInstance.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.RosInstance;
RosInstance.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.RosInstance;
RosInstance.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.
attrHostName com.aliyun.ros.cdk.core.IResolvable No description.
attrInnerIp com.aliyun.ros.cdk.core.IResolvable No description.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable No description.
attrPrimaryNetworkInterfaceId com.aliyun.ros.cdk.core.IResolvable No description.
attrPrivateIp com.aliyun.ros.cdk.core.IResolvable No description.
attrPublicIp com.aliyun.ros.cdk.core.IResolvable No description.
attrSecurityGroupIds com.aliyun.ros.cdk.core.IResolvable No description.
attrZoneId com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
affinity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
allocatePublicIp java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenew java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
creditSpecification java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dedicatedHostId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
deploymentSetGroupNo java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
deploymentSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
diskMappings com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDiskMappingsProperty> No description.
hostName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
hpcClusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
httpEndpoint java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
httpTokens java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
imageFamily java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
imageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
internetMaxBandwidthOut java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
ioOptimized java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
keyPairName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
passwordInherit java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
privateIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
privatePoolOptions com.aliyun.ros.cdk.core.IResolvable OR PrivatePoolOptionsProperty No description.
ramRoleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
securityEnhancementStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
securityGroupIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
spotDuration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
spotInterruptionBehavior java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
spotPriceLimit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
spotStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
storageSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
storageSetPartitionNumber java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskDiskName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskPerformanceLevel java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
tenancy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
useAdditionalService java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
userData java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
zoneIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List 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.

attrHostNameRequired 

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

attrInnerIpRequired 

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

attrInstanceIdRequired 

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

attrPrimaryNetworkInterfaceIdRequired 

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

attrPrivateIpRequired 

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

attrPublicIpRequired 

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

attrSecurityGroupIdsRequired 

public IResolvable getAttrSecurityGroupIds();
  • 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

instanceTypeRequired 

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

affinityOptional 

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

allocatePublicIpOptional 

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

autoRenewOptional 

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

autoRenewPeriodOptional 

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

creditSpecificationOptional 

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

dedicatedHostIdOptional 

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

deletionProtectionOptional 

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

deploymentSetGroupNoOptional 

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

deploymentSetIdOptional 

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

descriptionOptional 

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

diskMappingsOptional 

public java.lang.Object getDiskMappings();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDiskMappingsProperty>

hostNameOptional 

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

hpcClusterIdOptional 

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

httpEndpointOptional 

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

httpTokensOptional 

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

imageFamilyOptional 

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

imageIdOptional 

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

instanceChargeTypeOptional 

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

instanceNameOptional 

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

internetChargeTypeOptional 

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

internetMaxBandwidthOutOptional 

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

ioOptimizedOptional 

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

keyPairNameOptional 

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

passwordOptional 

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

passwordInheritOptional 

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

periodOptional 

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

periodUnitOptional 

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

privateIpAddressOptional 

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

privatePoolOptionsOptional 

public java.lang.Object getPrivatePoolOptions();

ramRoleNameOptional 

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

resourceGroupIdOptional 

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

securityEnhancementStrategyOptional 

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

securityGroupIdOptional 

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

securityGroupIdsOptional 

public java.lang.Object getSecurityGroupIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

spotDurationOptional 

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

spotInterruptionBehaviorOptional 

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

spotPriceLimitOptional 

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

spotStrategyOptional 

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

storageSetIdOptional 

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

storageSetPartitionNumberOptional 

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

systemDiskCategoryOptional 

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

systemDiskDescriptionOptional 

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

systemDiskDiskNameOptional 

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

systemDiskPerformanceLevelOptional 

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

systemDiskSizeOptional 

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

tagsOptional 

public java.util.List<TagsProperty> getTags();

tenancyOptional 

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

useAdditionalServiceOptional 

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

userDataOptional 

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

vpcIdOptional 

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

vSwitchIdOptional 

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

zoneIdOptional 

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

zoneIdsOptional 

public java.lang.Object getZoneIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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.