Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::EAIS::Instance, which is used to create an Elastic Accelerated Computing Instances (EAIS) instance.

Initializers 

import com.aliyun.ros.cdk.eais.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .createWithNotebook(java.lang.Boolean)
    .createWithNotebook(IResolvable)
    .instanceType(java.lang.String)
    .instanceType(IResolvable)
    .securityGroupId(java.lang.String)
    .securityGroupId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
//  .environmentVar(IResolvable)
//  .environmentVar(java.util.List<IResolvable)
//  .environmentVar(EnvironmentVarProperty>)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .paymentType(java.lang.String)
//  .paymentType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
createWithNotebook java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property createWithNotebook: When the value is true, CreateEaiJupyter is called to create an eais instance, and when the value is false, CreateEai is called to create an eais instance.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: EAIS instance type.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityGroupId: Security group ID.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: Switch ID.
environmentVar com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEnvironmentVarProperty> Property environmentVar: Setting environment variables in eais instance on Initialization.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: Name of the instance.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentType: The payment type of the resource.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

createWithNotebookRequired

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

Property createWithNotebook: When the value is true, CreateEaiJupyter is called to create an eais instance, and when the value is false, CreateEai is called to create an eais instance.

instanceTypeRequired

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

Property instanceType: EAIS instance type.

securityGroupIdRequired

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

Property securityGroupId: Security group ID.

vSwitchIdRequired

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

Property vSwitchId: Switch ID.

environmentVarOptional

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

Property environmentVar: Setting environment variables in eais instance on Initialization.

instanceNameOptional

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

Property instanceName: Name of the instance.

paymentTypeOptional

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

Property paymentType: The payment type of the resource.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • 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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.eais.Instance;
Instance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrClientInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute ClientInstanceId: The ID of the ECS instance to be bound.
attrClientInstanceName com.aliyun.ros.cdk.core.IResolvable Attribute ClientInstanceName: The name of the ECS instance bound to the EAIS instance.
attrClientInstanceType com.aliyun.ros.cdk.core.IResolvable Attribute ClientInstanceType: The type of the ECS instance bound to the EAIS instance.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The creation time of the resource.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: Elastic accelerated instance ID.
attrInstanceName com.aliyun.ros.cdk.core.IResolvable Attribute InstanceName: Name of the instance.
attrInstanceType com.aliyun.ros.cdk.core.IResolvable Attribute InstanceType: EAIS instance type.
attrJupyterUrl com.aliyun.ros.cdk.core.IResolvable Attribute JupyterUrl: The address of the Eais Notebook.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrSecurityGroupId com.aliyun.ros.cdk.core.IResolvable Attribute SecurityGroupId: Security group ID.
attrVSwitchId com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchId: Switch ID.
attrZoneId com.aliyun.ros.cdk.core.IResolvable Attribute ZoneId: The ID of the region to which the EAIS instance belongs.

nodeRequired 

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

The construct tree node associated with this construct.

refRequired 

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

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrClientInstanceIdRequired 

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

Attribute ClientInstanceId: The ID of the ECS instance to be bound.

attrClientInstanceNameRequired 

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

Attribute ClientInstanceName: The name of the ECS instance bound to the EAIS instance.

attrClientInstanceTypeRequired 

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

Attribute ClientInstanceType: The type of the ECS instance bound to the EAIS instance.

attrCreateTimeRequired 

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

Attribute CreateTime: The creation time of the resource.

attrInstanceIdRequired 

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

Attribute InstanceId: Elastic accelerated instance ID.

attrInstanceNameRequired 

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

Attribute InstanceName: Name of the instance.

attrInstanceTypeRequired 

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

Attribute InstanceType: EAIS instance type.

attrJupyterUrlRequired 

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

Attribute JupyterUrl: The address of the Eais Notebook.

attrResourceGroupIdRequired 

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

Attribute ResourceGroupId: The ID of the resource group.

attrSecurityGroupIdRequired 

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

Attribute SecurityGroupId: Security group ID.

attrVSwitchIdRequired 

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

Attribute VSwitchId: Switch ID.

attrZoneIdRequired 

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

Attribute ZoneId: The ID of the region to which the EAIS instance belongs.