Skip to content

Instance

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

Initializers 

import { datasource } from '@alicloud/ros-cdk-ens'
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-ens'
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.
attrDataDisk @alicloud/ros-cdk-core.IResolvable Attribute DataDisk: Data disk specifications.
attrEnsRegionId @alicloud/ros-cdk-core.IResolvable Attribute EnsRegionId: The node ID.
attrHostName @alicloud/ros-cdk-core.IResolvable Attribute HostName: The hostname of the instance.
attrImageId @alicloud/ros-cdk-core.IResolvable Attribute ImageId: The ID of the image.
attrInstanceId @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: The ID of the instance.
attrInstanceName @alicloud/ros-cdk-core.IResolvable Attribute InstanceName: The instance name.
attrInstanceType @alicloud/ros-cdk-core.IResolvable Attribute InstanceType: The specification of the instance.
attrInternetMaxBandwidthOut @alicloud/ros-cdk-core.IResolvable Attribute InternetMaxBandwidthOut: Maximum public network bandwidth.
attrNetworkId @alicloud/ros-cdk-core.IResolvable Attribute NetworkId: The ID of the network.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: Instance payment method.
attrPrivateIpAddress @alicloud/ros-cdk-core.IResolvable Attribute PrivateIpAddress: The private IP address.
attrSecurityId @alicloud/ros-cdk-core.IResolvable Attribute SecurityId: ID of the security group to which the instance belongs.
attrSystemDisk @alicloud/ros-cdk-core.IResolvable Attribute SystemDisk: System Disk Specification.
attrVSwitchId @alicloud/ros-cdk-core.IResolvable Attribute VSwitchId: The ID of the vSwitch to which the 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

attrDataDiskRequired 

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

Attribute DataDisk: Data disk specifications.

attrEnsRegionIdRequired 

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

Attribute EnsRegionId: The node ID.

When ScheduleAreaLevel is Region, EnsRegionId is required. When ScheduleAreaLevel is Big,Middle,Small, EnsRegionId is invalid.

attrHostNameRequired 

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

Attribute HostName: The hostname of the instance.

attrImageIdRequired 

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

Attribute ImageId: The ID of the image.

attrInstanceIdRequired 

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

Attribute InstanceId: The ID of the instance.

attrInstanceNameRequired 

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

Attribute InstanceName: The instance name.

Example value: test-InstanceName. It must be 2 to 128 characters in length and must start with an uppercase or lowercase letter or a Chinese character. It cannot start with http:// or https. Can contain Chinese, English, numbers, half-width colons (:), underscores (_), periods (.

attrInstanceTypeRequired 

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

Attribute InstanceType: The specification of the instance.

Example value: ens.sn1.

attrInternetMaxBandwidthOutRequired 

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

Attribute InternetMaxBandwidthOut: Maximum public network bandwidth.

The field type is Long, and the precision may be lost during serialization/deserialization.

attrNetworkIdRequired 

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

Attribute NetworkId: The ID of the network.

attrPaymentTypeRequired 

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

Attribute PaymentType: Instance payment method.

attrPrivateIpAddressRequired 

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

Attribute PrivateIpAddress: The private IP address.

Can only be used for node-level scheduling. If a private IP address is specified, the number of instances can only be one, and both the private IP address and the vSwitch ID are not empty, the private IP address takes effect.

attrSecurityIdRequired 

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

Attribute SecurityId: ID of the security group to which the instance belongs.

attrSystemDiskRequired 

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

Attribute SystemDisk: System Disk Specification.

SystemDisk is a non-required parameter when InstanceType is x86_pm,x86_bmi,x86_bm,pc_bmi, or arm_bmi. SystemDisk is a required parameter when instanceType is other specification families.

attrVSwitchIdRequired 

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

Attribute VSwitchId: The ID of the vSwitch to which the instance belongs.