Skip to content

DedicatedHostProps

Properties for defining a DedicatedHost.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-dedicatedhost

Initializer 

import com.aliyun.ros.cdk.ecs.DedicatedHostProps;
DedicatedHostProps.builder()
    .dedicatedHostType(java.lang.String)
    .dedicatedHostType(IResolvable)
//  .actionOnMaintenance(java.lang.String)
//  .actionOnMaintenance(IResolvable)
//  .autoPlacement(java.lang.String)
//  .autoPlacement(IResolvable)
//  .autoReleaseTime(java.lang.String)
//  .autoReleaseTime(IResolvable)
//  .autoRenew(java.lang.String)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .chargeType(java.lang.String)
//  .chargeType(IResolvable)
//  .dedicatedHostName(java.lang.String)
//  .dedicatedHostName(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .networkAttributesSlbUdpTimeout(java.lang.Number)
//  .networkAttributesSlbUdpTimeout(IResolvable)
//  .networkAttributesUdpTimeout(java.lang.Number)
//  .networkAttributesUdpTimeout(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .quantity(java.lang.Number)
//  .quantity(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

Properties

Name Type Description
dedicatedHostType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedHostType: The instance type of host.
actionOnMaintenance java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property actionOnMaintenance: The policy used to migrate the instances from the dedicated hostwhen the dedicated host fails or needs to be repaired online.Valid values: Migrate: Instances are migrated to another physical server and restarted.If the dedicated host is attached with disks that are not local disks, the default value is Migrate.Stop: Instances on the dedicated host are stopped. If the dedicated host cannot be repaired,the instances are migrated to another physical server and restarted.If the dedicated host is attached with local disks, the default value is Stop.
autoPlacement java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property autoPlacement: Specifies whether the dedicated host is added to the resource pool for automatic deployment.
autoReleaseTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property autoReleaseTime: Auto release time for created host, Follow ISO8601 standard using UTC time.
autoRenew java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Whether renew the fee automatically?
autoRenewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property autoRenewPeriod: The time period of auto renew.
chargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property chargeType: Instance Charge type, allowed value: Prepaid and Postpaid.
dedicatedHostName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedHostName: The name of the dedicated host, [2, 128] English or Chinese characters.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of host.
networkAttributesSlbUdpTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property networkAttributesSlbUdpTimeout: The duration of UDP timeout for sessions between Server Load Balancer (SLB) and the dedicated host.
networkAttributesUdpTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property networkAttributesUdpTimeout: The duration of UDP timeout for sessions between users and instances on the dedicated host.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: Prepaid time period.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: Unit of prepaid time period, it could be Week\/Month\/Year.
quantity java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property quantity: The number of dedicated hosts that you want to create.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
tags java.util.List<TagsProperty> Property tags: Tags to attach to DedicatedHost.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone to create the host.

dedicatedHostTypeRequired 

public java.lang.Object getDedicatedHostType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dedicatedHostType: The instance type of host.

actionOnMaintenanceOptional 

public java.lang.Object getActionOnMaintenance();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property actionOnMaintenance: The policy used to migrate the instances from the dedicated hostwhen the dedicated host fails or needs to be repaired online.Valid values: Migrate: Instances are migrated to another physical server and restarted.If the dedicated host is attached with disks that are not local disks, the default value is Migrate.Stop: Instances on the dedicated host are stopped. If the dedicated host cannot be repaired,the instances are migrated to another physical server and restarted.If the dedicated host is attached with local disks, the default value is Stop.

autoPlacementOptional 

public java.lang.Object getAutoPlacement();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property autoPlacement: Specifies whether the dedicated host is added to the resource pool for automatic deployment.

If you do not specify the DedicatedHostId parameter when you create an instance on a dedicated host, Alibaba Cloud automatically selects a dedicated host from the resource pool to host the instance. For more information, see Automatic deployment. Valid values:on: The dedicated host is added to the resource pool for automatic deployment.off: The dedicated host is not added to the resource pool for automatic deployment.Default value: on.Note When you create a dedicated host: If you do not specify this parameter, the dedicated host is added to the automatic deployment resource pool.If you do not want to add the dedicated host to the automatic deployment resource pool, set the value to off.

autoReleaseTimeOptional 

public java.lang.Object getAutoReleaseTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property autoReleaseTime: Auto release time for created host, Follow ISO8601 standard using UTC time.

format is 'yyyy-MM-ddTHH:mm:ssZ'. Not bigger than 3 years from this day onwards

autoRenewOptional 

public java.lang.Object getAutoRenew();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenew: Whether renew the fee automatically?

When the parameter InstanceChargeType is PrePaid, it will take effect. Range of value:True: automatic renewal.False: no automatic renewal. Default value is False.

autoRenewPeriodOptional 

public java.lang.Object getAutoRenewPeriod();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenewPeriod: The time period of auto renew.

When the parameter InstanceChargeType is PrePaid, it will take effect.It could be 1, 2, 3, 6, 12, 24, 36, 48, 60. Default value is 1.

chargeTypeOptional 

public java.lang.Object getChargeType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property chargeType: Instance Charge type, allowed value: Prepaid and Postpaid.

If specified Prepaid, please ensure you have sufficient balance in your account. Or instance creation will be failure. Default value is Postpaid.

dedicatedHostNameOptional 

public java.lang.Object getDedicatedHostName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dedicatedHostName: The name of the dedicated host, [2, 128] English or Chinese characters.

It must begin with an uppercase/lowercase letter or a Chinese character, and may contain numbers, '_' or '-'. It cannot begin with http:// or https://.

descriptionOptional 

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of host.

networkAttributesSlbUdpTimeoutOptional 

public java.lang.Object getNetworkAttributesSlbUdpTimeout();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property networkAttributesSlbUdpTimeout: The duration of UDP timeout for sessions between Server Load Balancer (SLB) and the dedicated host.

Unit: seconds. Valid values: 15 to 310.

networkAttributesUdpTimeoutOptional 

public java.lang.Object getNetworkAttributesUdpTimeout();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property networkAttributesUdpTimeout: The duration of UDP timeout for sessions between users and instances on the dedicated host.

Unit: seconds. Valid values: 15 to 310.

periodOptional 

public java.lang.Object getPeriod();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property period: Prepaid time period.

Unit is month, it could be from 1 to 9 or 12, 24, 36, 48, 60. Default value is 1.

periodUnitOptional 

public java.lang.Object getPeriodUnit();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property periodUnit: Unit of prepaid time period, it could be Week\/Month\/Year.

Default value is Month.

quantityOptional 

public java.lang.Object getQuantity();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property quantity: The number of dedicated hosts that you want to create.

Valid values: 1 to 100.Default value: 1.

resourceGroupIdOptional 

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

tagsOptional 

public java.util.List<TagsProperty> getTags();

Property tags: Tags to attach to DedicatedHost.

Max support 20 tags to add during create DedicatedHost. Each tag with two properties Key and Value, and Key is required.

zoneIdOptional 

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The zone to create the host.