Skip to content

DedicatedHosts

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::DedicatedHosts, which is used to query dedicated hosts.

Initializers 

import com.aliyun.ros.cdk.ecs.datasource.DedicatedHosts;
DedicatedHosts.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .dedicatedHostClusterId(java.lang.String)
//  .dedicatedHostClusterId(IResolvable)
//  .dedicatedHostIds(IResolvable)
//  .dedicatedHostIds(java.util.List<java.lang.String)
//  .dedicatedHostIds(IResolvable>)
//  .dedicatedHostName(java.lang.String)
//  .dedicatedHostName(IResolvable)
//  .dedicatedHostType(java.lang.String)
//  .dedicatedHostType(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .status(java.lang.String)
//  .status(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .zoneId(java.lang.String)
//  .zoneId(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.
dedicatedHostClusterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedHostClusterId: The ID of the dedicated host cluster.
dedicatedHostIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property dedicatedHostIds: The IDs of the dedicated hosts.
dedicatedHostName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedHostName: The name of the dedicated host.
dedicatedHostType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedHostType: The type of the dedicated host.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which the dedicated host belongs.
status java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property status: The service status of the dedicated host.
tags java.util.List Property tags: Tags of ddh.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone ID of the dedicated host.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dedicatedHostClusterIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dedicatedHostClusterId: The ID of the dedicated host cluster.

dedicatedHostIdsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property dedicatedHostIds: The IDs of the dedicated hosts.

You can specify up to 100 dedicated host IDs.

dedicatedHostNameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dedicatedHostName: The name of the dedicated host.

dedicatedHostTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dedicatedHostType: The type of the dedicated host.

refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group to which the dedicated host belongs.

statusOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property status: The service status of the dedicated host.

Valid values: Available: The dedicated host is running normally. UnderAssessment: The dedicated host is at risk, which may cause issues to ECS instances on the dedicated host. PermanentFailure: A permanent failure exists and the dedicated host is unavailable. Default value: Available.

tagsOptional

  • Type: java.util.List

Property tags: Tags of ddh.

zoneIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The zone ID of the dedicated host.

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 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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.ecs.datasource.DedicatedHosts;
DedicatedHosts.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
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.
attrDedicatedHostIds com.aliyun.ros.cdk.core.IResolvable Attribute DedicatedHostIds: The list of dedicated host ids.
attrDedicatedHosts com.aliyun.ros.cdk.core.IResolvable Attribute DedicatedHosts: The list of dedicated hosts.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

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

attrDedicatedHostIdsRequired 

public IResolvable getAttrDedicatedHostIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DedicatedHostIds: The list of dedicated host ids.

attrDedicatedHostsRequired 

public IResolvable getAttrDedicatedHosts();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DedicatedHosts: The list of dedicated hosts.