Skip to content

Instance

  • Implements: com.aliyun.ros.cdk.eais.datasource.IInstance

This class encapsulates and extends the ROS resource type DATASOURCE::EAIS::Instance.

Initializers

import com.aliyun.ros.cdk.eais.datasource.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: Elastic accelerated instance ID.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

instanceIdRequired

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

Property instanceId: Elastic accelerated instance ID.


refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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.datasource.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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ClientInstanceId: The ID of the ECS instance to be bound.
attrClientInstanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ClientInstanceName: The name of the ECS instance bound to the EAIS instance.
attrClientInstanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ClientInstanceType: The type of the ECS instance bound to the EAIS instance.
attrCreateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The creation time of the resource.
attrInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: Elastic accelerated instance ID.
attrInstanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceName: Name of the instance.
attrInstanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceType: EAIS instance type.
attrJupyterUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute JupyterUrl: The address of the Eais Notebook.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrSecurityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SecurityGroupId: Security group ID.
attrVSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute VSwitchId: Switch ID.
attrZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ZoneId: The ID of the region to which the EAIS instance belongs.
props InstanceProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


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 java.lang.Object getAttrClientInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrClientInstanceNameRequired

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

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


attrClientInstanceTypeRequired

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

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


attrCreateTimeRequired

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

Attribute CreateTime: The creation time of the resource.


attrInstanceIdRequired

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

Attribute InstanceId: Elastic accelerated instance ID.


attrInstanceNameRequired

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

Attribute InstanceName: Name of the instance.


attrInstanceTypeRequired

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

Attribute InstanceType: EAIS instance type.


attrJupyterUrlRequired

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

Attribute JupyterUrl: The address of the Eais Notebook.


attrResourceGroupIdRequired

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

Attribute ResourceGroupId: The ID of the resource group.


attrSecurityGroupIdRequired

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

Attribute SecurityGroupId: Security group ID.


attrVSwitchIdRequired

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

Attribute VSwitchId: Switch ID.


attrZoneIdRequired

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

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


propsRequired

public InstanceProps getProps();