Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::ECS::Instance, which is used to create an Elastic Compute Service (ECS) instance.

Initializers 

import { Instance } from '@alicloud/ros-cdk-ecs'
new 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.
addSecurityGroups Add one or more security groups to an ECS instance.
addUserDataCommands Add one or more commands to the userdata of an ECS instance.
autoCreateDependencies Create prerequisite resource(s) required to an ECS instance: VPC, VSwitch, and(or) security group.

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

addSecurityGroups 

public addSecurityGroups(securityGroups: string | SecurityGroup): void

Add one or more security groups to an ECS instance.

securityGroupsRequired

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.

commandsRequired

  • 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.

zoneIdOptional

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

Required when creating a VSwitch.

vpcCidrBlockOptional

  • Type: string

Optional when creating a VPC.

Default value is 192.168.0.0/16.

vSwitchCidrBlockOptional

  • Type: string

Optional when creating a VSwitch.

Default value is 192.168.0.0/24.

whetherCreateSecurityGroupOptional

  • Type: boolean

Whether to create a security group.

Default value is true.

Static Functions

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

isConstruct 

import { Instance } from '@alicloud/ros-cdk-ecs'
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.
attrHostName @alicloud/ros-cdk-core.IResolvable Attribute HostName: Host name of created instance.
attrInnerIp @alicloud/ros-cdk-core.IResolvable Attribute InnerIp: Inner IP address of the specified instance.
attrInstanceId @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: The instance ID of created ecs instance.
attrPrimaryNetworkInterfaceId @alicloud/ros-cdk-core.IResolvable Attribute PrimaryNetworkInterfaceId: Primary network interface ID of created instance.
attrPrivateIp @alicloud/ros-cdk-core.IResolvable Attribute PrivateIp: Private IP address of created ecs instance.
attrPublicIp @alicloud/ros-cdk-core.IResolvable Attribute PublicIp: Public IP address of created ecs instance.
attrSecurityGroupIds @alicloud/ros-cdk-core.IResolvable Attribute SecurityGroupIds: Security group ID list of created instance.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: Zone ID of created instance.

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

attrHostNameRequired 

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

Attribute HostName: Host name of created instance.

attrInnerIpRequired 

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

Attribute InnerIp: Inner IP address of the specified instance.

Only for classical instance.

attrInstanceIdRequired 

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

Attribute InstanceId: The instance ID of created ecs instance.

attrPrimaryNetworkInterfaceIdRequired 

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

Attribute PrimaryNetworkInterfaceId: Primary network interface ID of created instance.

attrPrivateIpRequired 

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

Attribute PrivateIp: Private IP address of created ecs instance.

Only for VPC instance.

attrPublicIpRequired 

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

Attribute PublicIp: Public IP address of created ecs instance.

attrSecurityGroupIdsRequired 

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

Attribute SecurityGroupIds: Security group ID list of created instance.

attrZoneIdRequired 

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

Attribute ZoneId: Zone ID of created instance.