Skip to content

ContainerGroup

This class encapsulates and extends the ROS resource type ALIYUN::ECI::ContainerGroup, which is used to create a container group.

A container group is an elastic container instance.

Initializers 

import { ContainerGroup } from '@alicloud/ros-cdk-eci'
new ContainerGroup(scope: Construct, id: string, props: ContainerGroupProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props ContainerGroupProps 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 { ContainerGroup } from '@alicloud/ros-cdk-eci'
ContainerGroup.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.
attrContainerGroupId @alicloud/ros-cdk-core.IResolvable Attribute ContainerGroupId: The ID of the container group.
attrContainerGroupName @alicloud/ros-cdk-core.IResolvable Attribute ContainerGroupName: The name of the container group.
attrEniInstanceId @alicloud/ros-cdk-core.IResolvable Attribute EniInstanceId: ENI instance ID.
attrInternetIp @alicloud/ros-cdk-core.IResolvable Attribute InternetIp: Internet IP.
attrIntranetIp @alicloud/ros-cdk-core.IResolvable Attribute IntranetIp: Intranet IP.
attrIpv6Address @alicloud/ros-cdk-core.IResolvable Attribute Ipv6Address: Ipv6 address.
attrRegionId @alicloud/ros-cdk-core.IResolvable Attribute RegionId: The ID of the region in which the instance resides.
attrSecurityGroupId @alicloud/ros-cdk-core.IResolvable Attribute SecurityGroupId: The ID of the security group to which the instance belongs.
attrVSwitchId @alicloud/ros-cdk-core.IResolvable Attribute VSwitchId: The ID of the VSwitch.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: The ID of the zone in which the instance resides.

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

attrContainerGroupIdRequired 

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

Attribute ContainerGroupId: The ID of the container group.

attrContainerGroupNameRequired 

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

Attribute ContainerGroupName: The name of the container group.

attrEniInstanceIdRequired 

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

Attribute EniInstanceId: ENI instance ID.

attrInternetIpRequired 

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

Attribute InternetIp: Internet IP.

attrIntranetIpRequired 

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

Attribute IntranetIp: Intranet IP.

attrIpv6AddressRequired 

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

Attribute Ipv6Address: Ipv6 address.

attrRegionIdRequired 

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

Attribute RegionId: The ID of the region in which the instance resides.

attrSecurityGroupIdRequired 

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

Attribute SecurityGroupId: The ID of the security group to which the instance belongs.

Instances in the same security group can access one another.

attrVSwitchIdRequired 

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

Attribute VSwitchId: The ID of the VSwitch.

Currently, ECI instances can only be deployed in VPCs.

attrZoneIdRequired 

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

Attribute ZoneId: The ID of the zone in which the instance resides.

If you leave the parameter blank, the system assigns a zone for you. The default value is blank.