Skip to content

InstanceGroup

This class encapsulates and extends the ROS resource type ALIYUN::ECS::InstanceGroup, which is used to create a group of Elastic Compute Service (ECS) instances that have the same configurations.

Initializers 

import { InstanceGroup } from '@alicloud/ros-cdk-ecs'
new InstanceGroup(scope: Construct, id: string, props: InstanceGroupProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props InstanceGroupProps 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 { InstanceGroup } from '@alicloud/ros-cdk-ecs'
InstanceGroup.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.
attrHostNames @alicloud/ros-cdk-core.IResolvable Attribute HostNames: Host names of created instances.
attrInnerIps @alicloud/ros-cdk-core.IResolvable Attribute InnerIps: Inner IP address list of the specified instances.
attrInstanceIds @alicloud/ros-cdk-core.IResolvable Attribute InstanceIds: The instance id list of created ecs instances.
attrIpv6Addresses @alicloud/ros-cdk-core.IResolvable Attribute Ipv6Addresses: IPv6 addresses list of created ecs instances.
attrIpv6AddressIds @alicloud/ros-cdk-core.IResolvable Attribute Ipv6AddressIds: IPv6 address IDs list of created ecs instances.
attrOrderId @alicloud/ros-cdk-core.IResolvable Attribute OrderId: The order id list of created instance.
attrPrivateIps @alicloud/ros-cdk-core.IResolvable Attribute PrivateIps: Private IP address list of created ecs instances.
attrPublicIps @alicloud/ros-cdk-core.IResolvable Attribute PublicIps: Public IP address list of created ecs instances.
attrZoneIds @alicloud/ros-cdk-core.IResolvable Attribute ZoneIds: Zone id of created instances.

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

attrHostNamesRequired 

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

Attribute HostNames: Host names of created instances.

attrInnerIpsRequired 

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

Attribute InnerIps: Inner IP address list of the specified instances.

Only for classical instances.

attrInstanceIdsRequired 

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

Attribute InstanceIds: The instance id list of created ecs instances.

attrIpv6AddressesRequired 

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

Attribute Ipv6Addresses: IPv6 addresses list of created ecs instances.

Note: The return type is a two-tier list. If the instance does not have any IPv6 address, the element at the corresponding position in the list is null. If all instances does not have any IPv address, will return null.

attrIpv6AddressIdsRequired 

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

Attribute Ipv6AddressIds: IPv6 address IDs list of created ecs instances.

Note: The return type is a two-tier list.If the instance does not have any IPv6 address, the element at the corresponding position in the list is null. If all instances does not have any IPv address, will return null.

attrOrderIdRequired 

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

Attribute OrderId: The order id list of created instance.

attrPrivateIpsRequired 

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

Attribute PrivateIps: Private IP address list of created ecs instances.

Only for VPC instance.

attrPublicIpsRequired 

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

Attribute PublicIps: Public IP address list of created ecs instances.

attrZoneIdsRequired 

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

Attribute ZoneIds: Zone id of created instances.