Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::ENS::Instance, which is used to create Edge Node Service (ENS) instances.

Initializers

import { Instance } from '@alicloud/ros-cdk-ens'
new Instance(scope: Construct, id: string, props: InstanceProps, enableResourcePropertyConstraint?: boolean)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: InstanceProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrAutoRenew^Required

public readonly attrAutoRenew: string | IResolvable;

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

Attribute AutoRenew: Whether renew the fee automatically?it could be True,FalseDefault value is False.

attrAutoRenewPeriod^Required

public readonly attrAutoRenewPeriod: string | IResolvable;

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

Attribute AutoRenewPeriod: The time period of auto renew.

it will take effect.It could be 1, 2, 3, 6, 12. Default value is 1.

attrDataDiskSize^Required

public readonly attrDataDiskSize: string | IResolvable;

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

Attribute DataDiskSize: Disk size of the system disk, range from 20 to 500 GB.

If you specify with your own image, make sure the system disk size bigger than image size.

attrEnsRegionId^Required

public readonly attrEnsRegionId: string | IResolvable;

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

Attribute EnsRegionId: ENS Region Id.

attrHostName^Required

public readonly attrHostName: string | IResolvable;

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

Attribute HostName: The hostname of the instance.

attrImageId^Required

public readonly attrImageId: string | IResolvable;

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

Attribute ImageId: Image ID to create ens instance.

attrInstanceId^Required

public readonly attrInstanceId: string | IResolvable;

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

Attribute InstanceId: InstanceId.

attrInstanceName^Required

public readonly attrInstanceName: string | IResolvable;

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

Attribute InstanceName: Instance name.

attrInstanceType^Required

public readonly attrInstanceType: string | IResolvable;

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

Attribute InstanceType: ENS instance supported instance type, make sure it should be correct.

attrInternetChargeType^Required

public readonly attrInternetChargeType: string | IResolvable;

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

Attribute InternetChargeType: Instance Charge type.it could be 95BandwidthByMonth, PayByBandwidth4thMonth.

attrIpType^Required

public readonly attrIpType: string | IResolvable;

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

Attribute IpType: ip type, It could be ipv4Andipv6,ipv4,ipv6.default value isi pv4.

attrKeyPairName^Required

public readonly attrKeyPairName: string | IResolvable;

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

Attribute KeyPairName: SSH key pair name.

attrPaymentType^Required

public readonly attrPaymentType: string | IResolvable;

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

Attribute PaymentType: Payment Type.only support value Subscription.

attrPeriod^Required

public readonly attrPeriod: string | IResolvable;

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

Attribute Period: Prepaid time period.

Unit is month, it could be from 1 to 9 or 12. Default value is 1.

attrPrivateIpAddress^Required

public readonly attrPrivateIpAddress: string | IResolvable;

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

Attribute PrivateIpAddress: Private IP for the instance created.

attrPrivateIps^Required

public readonly attrPrivateIps: string | IResolvable;

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

Attribute PrivateIps: Private IP.

attrPublicIps^Required

public readonly attrPublicIps: string | IResolvable;

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

Attribute PublicIps: Public IP.

attrQuantity^Required

public readonly attrQuantity: string | IResolvable;

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

Attribute Quantity: number of instances to create.

attrSystemDiskSize^Required

public readonly attrSystemDiskSize: string | IResolvable;

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

Attribute SystemDiskSize: Disk size of the system disk.

attrUniqueSuffix^Required

public readonly attrUniqueSuffix: string | IResolvable;

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

Attribute UniqueSuffix: Specifies whether to automatically append sequential suffixes to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter when you create multiple instances at a time.

The sequential suffix ranges from 001 to 999. Valid values: true false Default value: false.

attrUserData^Required

public readonly attrUserData: string | IResolvable;

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

Attribute UserData: User data to pass to instance.

[1, 16KB] characters.User data should not be base64 encoded. If you want to pass base64 encoded string to the property, use function Fn::Base64Decode to decode the base64 string first.

attrVSwitchId^Required

public readonly attrVSwitchId: string | IResolvable;

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

Attribute VSwitchId: The vSwitch Id to create ens instance.

props^Required

public readonly props: InstanceProps;

• Type: InstanceProps