Skip to content

RosInstance

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

Initializers

import com.aliyun.ros.cdk.ens.RosInstance;
RosInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dataDiskSize(java.lang.Number)
    .dataDiskSize(IResolvable)
    .ensRegionId(java.lang.String)
    .ensRegionId(IResolvable)
    .imageId(java.lang.String)
    .imageId(IResolvable)
    .instanceType(java.lang.String)
    .instanceType(IResolvable)
    .period(java.lang.Number)
    .period(IResolvable)
    .quantity(java.lang.Number)
    .quantity(IResolvable)
    .systemDiskSize(java.lang.Number)
    .systemDiskSize(IResolvable)
//  .autoRenew(java.lang.String)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .hostName(java.lang.String)
//  .hostName(IResolvable)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .ipType(java.lang.String)
//  .ipType(IResolvable)
//  .keyPairName(java.lang.String)
//  .keyPairName(IResolvable)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .paymentType(java.lang.String)
//  .paymentType(IResolvable)
//  .privateIpAddress(java.lang.String)
//  .privateIpAddress(IResolvable)
//  .uniqueSuffix(java.lang.Boolean)
//  .uniqueSuffix(IResolvable)
//  .userData(java.lang.String)
//  .userData(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(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.
dataDiskSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
ensRegionId 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.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
quantity java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskSize java.lang.Number 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.
hostName 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.
ipType 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.
paymentType 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.
uniqueSuffix 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.
vSwitchId 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

dataDiskSizeRequired

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

ensRegionIdRequired

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

imageIdRequired

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

instanceTypeRequired

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

periodRequired

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

quantityRequired

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

systemDiskSizeRequired

  • Type: java.lang.Number 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

hostNameOptional

  • 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

ipTypeOptional

  • 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

paymentTypeOptional

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

privateIpAddressOptional

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

uniqueSuffixOptional

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

userDataOptional

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

vSwitchIdOptional

  • 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.ens.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.ens.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.ens.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.
attrAutoRenew com.aliyun.ros.cdk.core.IResolvable No description.
attrAutoRenewPeriod com.aliyun.ros.cdk.core.IResolvable No description.
attrDataDiskSize com.aliyun.ros.cdk.core.IResolvable No description.
attrEnsRegionId 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.
attrInstanceId 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.
attrIpType com.aliyun.ros.cdk.core.IResolvable No description.
attrKeyPairName com.aliyun.ros.cdk.core.IResolvable No description.
attrPaymentType 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.
attrPrivateIps com.aliyun.ros.cdk.core.IResolvable No description.
attrPublicIps com.aliyun.ros.cdk.core.IResolvable No description.
attrQuantity com.aliyun.ros.cdk.core.IResolvable No description.
attrSystemDiskSize com.aliyun.ros.cdk.core.IResolvable No description.
attrUniqueSuffix com.aliyun.ros.cdk.core.IResolvable No description.
attrUserData com.aliyun.ros.cdk.core.IResolvable No description.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable No description.
dataDiskSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
ensRegionId 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.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
quantity java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
systemDiskSize java.lang.Number 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.
hostName 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.
ipType 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.
paymentType 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.
uniqueSuffix 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.
vSwitchId 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.


attrAutoRenewRequired

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

attrAutoRenewPeriodRequired

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

attrDataDiskSizeRequired

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

attrEnsRegionIdRequired

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

attrInstanceIdRequired

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

attrIpTypeRequired

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

attrKeyPairNameRequired

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

attrPaymentTypeRequired

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

attrPrivateIpsRequired

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

attrPublicIpsRequired

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

attrQuantityRequired

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

attrSystemDiskSizeRequired

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

attrUniqueSuffixRequired

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

attrUserDataRequired

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

attrVSwitchIdRequired

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

dataDiskSizeRequired

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

enableResourcePropertyConstraintRequired

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

ensRegionIdRequired

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

imageIdRequired

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

instanceTypeRequired

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

periodRequired

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

quantityRequired

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

systemDiskSizeRequired

public java.lang.Object getSystemDiskSize();
  • Type: java.lang.Number 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

hostNameOptional

public java.lang.Object getHostName();
  • 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

ipTypeOptional

public java.lang.Object getIpType();
  • 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

paymentTypeOptional

public java.lang.Object getPaymentType();
  • 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

uniqueSuffixOptional

public java.lang.Object getUniqueSuffix();
  • 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

vSwitchIdOptional

public java.lang.Object getVSwitchId();
  • 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.