HostGroup
- Implements: IHostGroup
This class encapsulates and extends the ROS resource type ALIYUN::DEVOPS::HostGroup.
Initializers
import com.aliyun.ros.cdk.devops.HostGroup;
HostGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.name(java.lang.String)
.name(IResolvable)
.organizationId(java.lang.String)
.organizationId(IResolvable)
.serviceConnectionId(java.lang.Number)
.serviceConnectionId(IResolvable)
// .aliyunRegion(java.lang.String)
// .aliyunRegion(IResolvable)
// .ecsLabelKey(java.lang.String)
// .ecsLabelKey(IResolvable)
// .ecsLabelValue(java.lang.String)
// .ecsLabelValue(IResolvable)
// .ecsType(java.lang.String)
// .ecsType(IResolvable)
// .envId(java.lang.String)
// .envId(IResolvable)
// .machineInfos(IResolvable)
// .machineInfos(java.util.List<IResolvable)
// .machineInfos(MachineInfosProperty>)
// .tagIds(IResolvable)
// .tagIds(java.util.List<java.lang.String)
// .tagIds(IResolvable>)
// .type(java.lang.String)
// .type(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: Host group name. |
organizationId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links. |
serviceConnectionId | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property serviceConnectionId: Service connection. |
aliyunRegion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property aliyunRegion: The aliyun region. |
ecsLabelKey | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ecsLabelKey: The tag key of the ECS. |
ecsLabelValue | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ecsLabelValue: The tag value of the ECS. |
ecsType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ecsType: The type of ECS, currently only supports ECS_ALIYUN. |
envId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property envId: Environment id. |
machineInfos | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property machineInfos: The machine infos. |
tagIds | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property tagIds: The ids of tag. |
type | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property type: Host group type, currently only supports ECS. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
nameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: Host group name.
organizationIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links.
serviceConnectionIdRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property serviceConnectionId: Service connection.
aliyunRegionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property aliyunRegion: The aliyun region.
ecsLabelKeyOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ecsLabelKey: The tag key of the ECS.
ecsLabelValueOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ecsLabelValue: The tag value of the ECS.
ecsTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ecsType: The type of ECS, currently only supports ECS_ALIYUN.
envIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property envId: Environment id.
machineInfosOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
MachineInfosProperty>
Property machineInfos: The machine infos.
tagIdsOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property tagIds: The ids of tag.
typeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property type: Host group type, currently only supports ECS.
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 java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
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: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.devops.HostGroup;
HostGroup.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrHostGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute HostGroupId: The id of the host group. |
props | HostGroupProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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 java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrHostGroupIdRequired
public java.lang.Object getAttrHostGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute HostGroupId: The id of the host group.
propsRequired
public HostGroupProps getProps();
- Type: HostGroupProps