Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::ECS::Instance.

Initializers

import { Instance } from '@alicloud/ros-cdk-ecs'
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

addSecurityGroups

public addSecurityGroups(securityGroups: string | SecurityGroup): void

Add one or more security groups to an ECS instance.

securityGroups^Required

• Type: string | SecurityGroup

Security groups or security group IDs.

addUserDataCommands

public addUserDataCommands(commands: string | IResolvable): void

Add one or more commands to the userdata of an ECS instance.

commands^Required

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

Commands to be added.

autoCreateDependencies

public autoCreateDependencies(zoneId?: string | IResolvable, vpcCidrBlock?: string, vSwitchCidrBlock?: string, whetherCreateSecurityGroup?: boolean): any[]

Create prerequisite resource(s) required to an ECS instance: VPC, VSwitch, and(or) security group.

zoneId^Optional

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

Required when creating a VSwitch.

vpcCidrBlock^Optional

• Type: string

Optional when creating a VPC.

Default value is 192.168.0.0/16.

vSwitchCidrBlock^Optional

• Type: string

Optional when creating a VSwitch.

Default value is 192.168.0.0/24.

whetherCreateSecurityGroup^Optional

• Type: boolean

Whether to create a security group.

Default value is true.

Static Functions

isConstruct

import { Instance } from '@alicloud/ros-cdk-ecs'
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

attrHostName^Required

public readonly attrHostName: string | IResolvable;

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

Attribute HostName: Host name of created instance.

attrInnerIp^Required

public readonly attrInnerIp: string | IResolvable;

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

Attribute InnerIp: Inner IP address of the specified instance.

Only for classical instance.

attrInstanceId^Required

public readonly attrInstanceId: string | IResolvable;

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

Attribute InstanceId: The instance ID of created ecs instance.

attrPrimaryNetworkInterfaceId^Required

public readonly attrPrimaryNetworkInterfaceId: string | IResolvable;

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

Attribute PrimaryNetworkInterfaceId: Primary network interface ID of created instance.

attrPrivateIp^Required

public readonly attrPrivateIp: string | IResolvable;

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

Attribute PrivateIp: Private IP address of created ecs instance.

Only for VPC instance.

attrPublicIp^Required

public readonly attrPublicIp: string | IResolvable;

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

Attribute PublicIp: Public IP address of created ecs instance.

attrSecurityGroupIds^Required

public readonly attrSecurityGroupIds: string | IResolvable;

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

Attribute SecurityGroupIds: Security group ID list of created instance.

attrZoneId^Required

public readonly attrZoneId: string | IResolvable;

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

Attribute ZoneId: Zone ID of created instance.

props^Required

public readonly props: InstanceProps;

• Type: InstanceProps