ContainerGroup
- Implements: IContainerGroup
This class encapsulates and extends the ROS resource type ALIYUN::ECI::ContainerGroup.
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
- Type: ContainerGroupProps
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- 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.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute ContainerGroupId: The ID of the container group. |
attrContainerGroupName | string | @alicloud/ros-cdk-core.IResolvable | Attribute ContainerGroupName: The name of the container group. |
attrEniInstanceId | string | @alicloud/ros-cdk-core.IResolvable | Attribute EniInstanceId: ENI instance ID. |
attrInternetIp | string | @alicloud/ros-cdk-core.IResolvable | Attribute InternetIp: Internet IP. |
attrIntranetIp | string | @alicloud/ros-cdk-core.IResolvable | Attribute IntranetIp: Intranet IP. |
attrIpv6Address | string | @alicloud/ros-cdk-core.IResolvable | Attribute Ipv6Address: Ipv6 address. |
attrRegionId | string | @alicloud/ros-cdk-core.IResolvable | Attribute RegionId: The ID of the region in which the instance resides. |
attrSecurityGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute SecurityGroupId: The ID of the security group to which the instance belongs. |
attrVSwitchId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VSwitchId: The ID of the VSwitch. |
attrZoneId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ZoneId: The ID of the zone in which the instance resides. |
props | ContainerGroupProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ContainerGroupId: The ID of the container group.
attrContainerGroupNameRequired
public readonly attrContainerGroupName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ContainerGroupName: The name of the container group.
attrEniInstanceIdRequired
public readonly attrEniInstanceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute EniInstanceId: ENI instance ID.
attrInternetIpRequired
public readonly attrInternetIp: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute InternetIp: Internet IP.
attrIntranetIpRequired
public readonly attrIntranetIp: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute IntranetIp: Intranet IP.
attrIpv6AddressRequired
public readonly attrIpv6Address: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Ipv6Address: Ipv6 address.
attrRegionIdRequired
public readonly attrRegionId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RegionId: The ID of the region in which the instance resides.
attrSecurityGroupIdRequired
public readonly attrSecurityGroupId: string | IResolvable;
- Type: string | @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: string | IResolvable;
- Type: string | @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: string | IResolvable;
- Type: string | @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.
propsRequired
public readonly props: ContainerGroupProps;
- Type: ContainerGroupProps