InstanceGroup

• Implements: IInstanceGroup

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

Initializers

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

scope^Required

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

id^Required

• Type: string

props^Required

• Type: InstanceGroupProps

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

attrHostNames^Required

public readonly attrHostNames: string | IResolvable;

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

Attribute HostNames: Host names of created instances.

attrInnerIps^Required

public readonly attrInnerIps: string | IResolvable;

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

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

Only for classical instances.

attrInstanceIds^Required

public readonly attrInstanceIds: string | IResolvable;

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

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

attrIpv6Addresses^Required

public readonly attrIpv6Addresses: string | IResolvable;

• Type: string | @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.

attrIpv6AddressIds^Required

public readonly attrIpv6AddressIds: string | IResolvable;

• Type: string | @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.

attrOrderId^Required

public readonly attrOrderId: string | IResolvable;

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

Attribute OrderId: The order id list of created instance.

attrPrivateIps^Required

public readonly attrPrivateIps: string | IResolvable;

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

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

Only for VPC instance.

attrPublicIps^Required

public readonly attrPublicIps: string | IResolvable;

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

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

attrZoneIds^Required

public readonly attrZoneIds: string | IResolvable;

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

Attribute ZoneIds: Zone id of created instances.

props^Required

public readonly props: InstanceGroupProps;

• Type: InstanceGroupProps