Instance
- Implements: @alicloud/ros-cdk-eais.datasource.IInstance
This class encapsulates and extends the ROS resource type DATASOURCE::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
- Type: InstanceProps
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- 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.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute ClientInstanceId: The ID of the ECS instance to be bound. |
attrClientInstanceName | string | @alicloud/ros-cdk-core.IResolvable | Attribute ClientInstanceName: The name of the ECS instance bound to the EAIS instance. |
attrClientInstanceType | string | @alicloud/ros-cdk-core.IResolvable | Attribute ClientInstanceType: The type of the ECS instance bound to the EAIS instance. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The creation time of the resource. |
attrInstanceId | string | @alicloud/ros-cdk-core.IResolvable | Attribute InstanceId: Elastic accelerated instance ID. |
attrInstanceName | string | @alicloud/ros-cdk-core.IResolvable | Attribute InstanceName: Name of the instance. |
attrInstanceType | string | @alicloud/ros-cdk-core.IResolvable | Attribute InstanceType: EAIS instance type. |
attrJupyterUrl | string | @alicloud/ros-cdk-core.IResolvable | Attribute JupyterUrl: The address of the Eais Notebook. |
attrResourceGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ResourceGroupId: The ID of the resource group. |
attrSecurityGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute SecurityGroupId: Security group ID. |
attrVSwitchId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VSwitchId: Switch ID. |
attrZoneId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ZoneId: The ID of the region to which the EAIS instance belongs. |
props | InstanceProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ClientInstanceId: The ID of the ECS instance to be bound.
attrClientInstanceNameRequired
public readonly attrClientInstanceName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ClientInstanceName: The name of the ECS instance bound to the EAIS instance.
attrClientInstanceTypeRequired
public readonly attrClientInstanceType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ClientInstanceType: The type of the ECS instance bound to the EAIS instance.
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The creation time of the resource.
attrInstanceIdRequired
public readonly attrInstanceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute InstanceId: Elastic accelerated instance ID.
attrInstanceNameRequired
public readonly attrInstanceName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute InstanceName: Name of the instance.
attrInstanceTypeRequired
public readonly attrInstanceType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute InstanceType: EAIS instance type.
attrJupyterUrlRequired
public readonly attrJupyterUrl: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute JupyterUrl: The address of the Eais Notebook.
attrResourceGroupIdRequired
public readonly attrResourceGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ResourceGroupId: The ID of the resource group.
attrSecurityGroupIdRequired
public readonly attrSecurityGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute SecurityGroupId: Security group ID.
attrVSwitchIdRequired
public readonly attrVSwitchId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VSwitchId: Switch ID.
attrZoneIdRequired
public readonly attrZoneId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ZoneId: The ID of the region to which the EAIS instance belongs.
propsRequired
public readonly props: InstanceProps;
- Type: InstanceProps