Skip to content

Instance

This class encapsulates and extends the ROS resource type DATASOURCE::EAIS::Instance, which is used to query the information about a created Elastic Accelerated Computing Instances (EAIS) instance.

Initializers 

import { datasource } from '@alicloud/ros-cdk-eais'
new datasource.Instance(scope: Construct, id: string, props: InstanceProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props InstanceProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

import { datasource } from '@alicloud/ros-cdk-eais'
datasource.Instance.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

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

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrClientInstanceIdRequired 

public readonly attrClientInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrClientInstanceNameRequired 

public readonly attrClientInstanceName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrClientInstanceTypeRequired 

public readonly attrClientInstanceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The creation time of the resource.

attrInstanceIdRequired 

public readonly attrInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: Elastic accelerated instance ID.

attrInstanceNameRequired 

public readonly attrInstanceName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceName: Name of the instance.

attrInstanceTypeRequired 

public readonly attrInstanceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceType: EAIS instance type.

attrJupyterUrlRequired 

public readonly attrJupyterUrl: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute JupyterUrl: The address of the Eais Notebook.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrSecurityGroupIdRequired 

public readonly attrSecurityGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SecurityGroupId: Security group ID.

attrVSwitchIdRequired 

public readonly attrVSwitchId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VSwitchId: Switch ID.

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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