1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. ecs
  5. DedicatedHost
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.ecs.DedicatedHost

Explore with Pulumi AI

Import

Ecs dedicated host can be imported using the id, e.g.

$ pulumi import alicloud:ecs/dedicatedHost:DedicatedHost default dh-2zedmxxxx
Copy

Create DedicatedHost Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DedicatedHost(name: string, args: DedicatedHostArgs, opts?: CustomResourceOptions);
@overload
def DedicatedHost(resource_name: str,
                  args: DedicatedHostArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def DedicatedHost(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  dedicated_host_type: Optional[str] = None,
                  detail_fee: Optional[bool] = None,
                  dry_run: Optional[bool] = None,
                  auto_renew: Optional[bool] = None,
                  action_on_maintenance: Optional[str] = None,
                  cpu_over_commit_ratio: Optional[float] = None,
                  dedicated_host_cluster_id: Optional[str] = None,
                  dedicated_host_name: Optional[str] = None,
                  auto_placement: Optional[str] = None,
                  auto_release_time: Optional[str] = None,
                  description: Optional[str] = None,
                  auto_renew_period: Optional[int] = None,
                  expired_time: Optional[str] = None,
                  min_quantity: Optional[int] = None,
                  network_attributes: Optional[Sequence[DedicatedHostNetworkAttributeArgs]] = None,
                  payment_type: Optional[str] = None,
                  resource_group_id: Optional[str] = None,
                  sale_cycle: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  zone_id: Optional[str] = None)
func NewDedicatedHost(ctx *Context, name string, args DedicatedHostArgs, opts ...ResourceOption) (*DedicatedHost, error)
public DedicatedHost(string name, DedicatedHostArgs args, CustomResourceOptions? opts = null)
public DedicatedHost(String name, DedicatedHostArgs args)
public DedicatedHost(String name, DedicatedHostArgs args, CustomResourceOptions options)
type: alicloud:ecs:DedicatedHost
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DedicatedHostArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DedicatedHostArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DedicatedHostArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DedicatedHostArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DedicatedHostArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var alicloudDedicatedHostResource = new AliCloud.Ecs.DedicatedHost("alicloudDedicatedHostResource", new()
{
    DedicatedHostType = "string",
    DetailFee = false,
    DryRun = false,
    AutoRenew = false,
    ActionOnMaintenance = "string",
    CpuOverCommitRatio = 0,
    DedicatedHostClusterId = "string",
    DedicatedHostName = "string",
    AutoPlacement = "string",
    AutoReleaseTime = "string",
    Description = "string",
    AutoRenewPeriod = 0,
    ExpiredTime = "string",
    MinQuantity = 0,
    NetworkAttributes = new[]
    {
        new AliCloud.Ecs.Inputs.DedicatedHostNetworkAttributeArgs
        {
            SlbUdpTimeout = 0,
            UdpTimeout = 0,
        },
    },
    PaymentType = "string",
    ResourceGroupId = "string",
    SaleCycle = "string",
    Tags = 
    {
        { "string", "string" },
    },
    ZoneId = "string",
});
Copy
example, err := ecs.NewDedicatedHost(ctx, "alicloudDedicatedHostResource", &ecs.DedicatedHostArgs{
	DedicatedHostType:      pulumi.String("string"),
	DetailFee:              pulumi.Bool(false),
	DryRun:                 pulumi.Bool(false),
	AutoRenew:              pulumi.Bool(false),
	ActionOnMaintenance:    pulumi.String("string"),
	CpuOverCommitRatio:     pulumi.Float64(0),
	DedicatedHostClusterId: pulumi.String("string"),
	DedicatedHostName:      pulumi.String("string"),
	AutoPlacement:          pulumi.String("string"),
	AutoReleaseTime:        pulumi.String("string"),
	Description:            pulumi.String("string"),
	AutoRenewPeriod:        pulumi.Int(0),
	ExpiredTime:            pulumi.String("string"),
	MinQuantity:            pulumi.Int(0),
	NetworkAttributes: ecs.DedicatedHostNetworkAttributeArray{
		&ecs.DedicatedHostNetworkAttributeArgs{
			SlbUdpTimeout: pulumi.Int(0),
			UdpTimeout:    pulumi.Int(0),
		},
	},
	PaymentType:     pulumi.String("string"),
	ResourceGroupId: pulumi.String("string"),
	SaleCycle:       pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ZoneId: pulumi.String("string"),
})
Copy
var alicloudDedicatedHostResource = new DedicatedHost("alicloudDedicatedHostResource", DedicatedHostArgs.builder()
    .dedicatedHostType("string")
    .detailFee(false)
    .dryRun(false)
    .autoRenew(false)
    .actionOnMaintenance("string")
    .cpuOverCommitRatio(0)
    .dedicatedHostClusterId("string")
    .dedicatedHostName("string")
    .autoPlacement("string")
    .autoReleaseTime("string")
    .description("string")
    .autoRenewPeriod(0)
    .expiredTime("string")
    .minQuantity(0)
    .networkAttributes(DedicatedHostNetworkAttributeArgs.builder()
        .slbUdpTimeout(0)
        .udpTimeout(0)
        .build())
    .paymentType("string")
    .resourceGroupId("string")
    .saleCycle("string")
    .tags(Map.of("string", "string"))
    .zoneId("string")
    .build());
Copy
alicloud_dedicated_host_resource = alicloud.ecs.DedicatedHost("alicloudDedicatedHostResource",
    dedicated_host_type="string",
    detail_fee=False,
    dry_run=False,
    auto_renew=False,
    action_on_maintenance="string",
    cpu_over_commit_ratio=0,
    dedicated_host_cluster_id="string",
    dedicated_host_name="string",
    auto_placement="string",
    auto_release_time="string",
    description="string",
    auto_renew_period=0,
    expired_time="string",
    min_quantity=0,
    network_attributes=[{
        "slb_udp_timeout": 0,
        "udp_timeout": 0,
    }],
    payment_type="string",
    resource_group_id="string",
    sale_cycle="string",
    tags={
        "string": "string",
    },
    zone_id="string")
Copy
const alicloudDedicatedHostResource = new alicloud.ecs.DedicatedHost("alicloudDedicatedHostResource", {
    dedicatedHostType: "string",
    detailFee: false,
    dryRun: false,
    autoRenew: false,
    actionOnMaintenance: "string",
    cpuOverCommitRatio: 0,
    dedicatedHostClusterId: "string",
    dedicatedHostName: "string",
    autoPlacement: "string",
    autoReleaseTime: "string",
    description: "string",
    autoRenewPeriod: 0,
    expiredTime: "string",
    minQuantity: 0,
    networkAttributes: [{
        slbUdpTimeout: 0,
        udpTimeout: 0,
    }],
    paymentType: "string",
    resourceGroupId: "string",
    saleCycle: "string",
    tags: {
        string: "string",
    },
    zoneId: "string",
});
Copy
type: alicloud:ecs:DedicatedHost
properties:
    actionOnMaintenance: string
    autoPlacement: string
    autoReleaseTime: string
    autoRenew: false
    autoRenewPeriod: 0
    cpuOverCommitRatio: 0
    dedicatedHostClusterId: string
    dedicatedHostName: string
    dedicatedHostType: string
    description: string
    detailFee: false
    dryRun: false
    expiredTime: string
    minQuantity: 0
    networkAttributes:
        - slbUdpTimeout: 0
          udpTimeout: 0
    paymentType: string
    resourceGroupId: string
    saleCycle: string
    tags:
        string: string
    zoneId: string
Copy

DedicatedHost Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DedicatedHost resource accepts the following input properties:

DedicatedHostType
This property is required.
Changes to this property will trigger replacement.
string
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
ActionOnMaintenance string
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
AutoPlacement string
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
AutoReleaseTime string
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
AutoRenew bool
Specifies whether to automatically renew the subscription dedicated host.
AutoRenewPeriod int
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
CpuOverCommitRatio double
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
DedicatedHostClusterId string
The dedicated host cluster ID to which the dedicated host belongs.
DedicatedHostName string
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
Description string
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
DetailFee bool
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
DryRun bool
Specifies whether to only validate the request. Default: false.
ExpiredTime string
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
MinQuantity int
Specify the minimum purchase quantity of a dedicated host.
NetworkAttributes List<Pulumi.AliCloud.Ecs.Inputs.DedicatedHostNetworkAttribute>
dedicated host network parameters. contains the following attributes:
PaymentType string
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
ResourceGroupId string
The ID of the resource group to which the dedicated host belongs.
SaleCycle string
The unit of the subscription period of the dedicated host.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.
DedicatedHostType
This property is required.
Changes to this property will trigger replacement.
string
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
ActionOnMaintenance string
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
AutoPlacement string
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
AutoReleaseTime string
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
AutoRenew bool
Specifies whether to automatically renew the subscription dedicated host.
AutoRenewPeriod int
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
CpuOverCommitRatio float64
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
DedicatedHostClusterId string
The dedicated host cluster ID to which the dedicated host belongs.
DedicatedHostName string
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
Description string
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
DetailFee bool
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
DryRun bool
Specifies whether to only validate the request. Default: false.
ExpiredTime string
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
MinQuantity int
Specify the minimum purchase quantity of a dedicated host.
NetworkAttributes []DedicatedHostNetworkAttributeArgs
dedicated host network parameters. contains the following attributes:
PaymentType string
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
ResourceGroupId string
The ID of the resource group to which the dedicated host belongs.
SaleCycle string
The unit of the subscription period of the dedicated host.
Tags map[string]string
A mapping of tags to assign to the resource.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.
dedicatedHostType
This property is required.
Changes to this property will trigger replacement.
String
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
actionOnMaintenance String
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
autoPlacement String
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
autoReleaseTime String
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
autoRenew Boolean
Specifies whether to automatically renew the subscription dedicated host.
autoRenewPeriod Integer
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
cpuOverCommitRatio Double
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
dedicatedHostClusterId String
The dedicated host cluster ID to which the dedicated host belongs.
dedicatedHostName String
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
description String
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
detailFee Boolean
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
dryRun Boolean
Specifies whether to only validate the request. Default: false.
expiredTime String
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
minQuantity Integer
Specify the minimum purchase quantity of a dedicated host.
networkAttributes List<DedicatedHostNetworkAttribute>
dedicated host network parameters. contains the following attributes:
paymentType String
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
resourceGroupId String
The ID of the resource group to which the dedicated host belongs.
saleCycle String
The unit of the subscription period of the dedicated host.
tags Map<String,String>
A mapping of tags to assign to the resource.
zoneId Changes to this property will trigger replacement. String
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.
dedicatedHostType
This property is required.
Changes to this property will trigger replacement.
string
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
actionOnMaintenance string
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
autoPlacement string
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
autoReleaseTime string
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
autoRenew boolean
Specifies whether to automatically renew the subscription dedicated host.
autoRenewPeriod number
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
cpuOverCommitRatio number
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
dedicatedHostClusterId string
The dedicated host cluster ID to which the dedicated host belongs.
dedicatedHostName string
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
description string
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
detailFee boolean
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
dryRun boolean
Specifies whether to only validate the request. Default: false.
expiredTime string
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
minQuantity number
Specify the minimum purchase quantity of a dedicated host.
networkAttributes DedicatedHostNetworkAttribute[]
dedicated host network parameters. contains the following attributes:
paymentType string
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
resourceGroupId string
The ID of the resource group to which the dedicated host belongs.
saleCycle string
The unit of the subscription period of the dedicated host.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
zoneId Changes to this property will trigger replacement. string
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.
dedicated_host_type
This property is required.
Changes to this property will trigger replacement.
str
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
action_on_maintenance str
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
auto_placement str
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
auto_release_time str
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
auto_renew bool
Specifies whether to automatically renew the subscription dedicated host.
auto_renew_period int
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
cpu_over_commit_ratio float
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
dedicated_host_cluster_id str
The dedicated host cluster ID to which the dedicated host belongs.
dedicated_host_name str
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
description str
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
detail_fee bool
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
dry_run bool
Specifies whether to only validate the request. Default: false.
expired_time str
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
min_quantity int
Specify the minimum purchase quantity of a dedicated host.
network_attributes Sequence[DedicatedHostNetworkAttributeArgs]
dedicated host network parameters. contains the following attributes:
payment_type str
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
resource_group_id str
The ID of the resource group to which the dedicated host belongs.
sale_cycle str
The unit of the subscription period of the dedicated host.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
zone_id Changes to this property will trigger replacement. str
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.
dedicatedHostType
This property is required.
Changes to this property will trigger replacement.
String
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
actionOnMaintenance String
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
autoPlacement String
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
autoReleaseTime String
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
autoRenew Boolean
Specifies whether to automatically renew the subscription dedicated host.
autoRenewPeriod Number
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
cpuOverCommitRatio Number
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
dedicatedHostClusterId String
The dedicated host cluster ID to which the dedicated host belongs.
dedicatedHostName String
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
description String
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
detailFee Boolean
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
dryRun Boolean
Specifies whether to only validate the request. Default: false.
expiredTime String
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
minQuantity Number
Specify the minimum purchase quantity of a dedicated host.
networkAttributes List<Property Map>
dedicated host network parameters. contains the following attributes:
paymentType String
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
resourceGroupId String
The ID of the resource group to which the dedicated host belongs.
saleCycle String
The unit of the subscription period of the dedicated host.
tags Map<String>
A mapping of tags to assign to the resource.
zoneId Changes to this property will trigger replacement. String
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.

Outputs

All input properties are implicitly available as output properties. Additionally, the DedicatedHost resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the dedicated host.
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the dedicated host.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the dedicated host.
id string
The provider-assigned unique ID for this managed resource.
status string
The status of the dedicated host.
id str
The provider-assigned unique ID for this managed resource.
status str
The status of the dedicated host.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the dedicated host.

Look up Existing DedicatedHost Resource

Get an existing DedicatedHost resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DedicatedHostState, opts?: CustomResourceOptions): DedicatedHost
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action_on_maintenance: Optional[str] = None,
        auto_placement: Optional[str] = None,
        auto_release_time: Optional[str] = None,
        auto_renew: Optional[bool] = None,
        auto_renew_period: Optional[int] = None,
        cpu_over_commit_ratio: Optional[float] = None,
        dedicated_host_cluster_id: Optional[str] = None,
        dedicated_host_name: Optional[str] = None,
        dedicated_host_type: Optional[str] = None,
        description: Optional[str] = None,
        detail_fee: Optional[bool] = None,
        dry_run: Optional[bool] = None,
        expired_time: Optional[str] = None,
        min_quantity: Optional[int] = None,
        network_attributes: Optional[Sequence[DedicatedHostNetworkAttributeArgs]] = None,
        payment_type: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        sale_cycle: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        zone_id: Optional[str] = None) -> DedicatedHost
func GetDedicatedHost(ctx *Context, name string, id IDInput, state *DedicatedHostState, opts ...ResourceOption) (*DedicatedHost, error)
public static DedicatedHost Get(string name, Input<string> id, DedicatedHostState? state, CustomResourceOptions? opts = null)
public static DedicatedHost get(String name, Output<String> id, DedicatedHostState state, CustomResourceOptions options)
resources:  _:    type: alicloud:ecs:DedicatedHost    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ActionOnMaintenance string
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
AutoPlacement string
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
AutoReleaseTime string
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
AutoRenew bool
Specifies whether to automatically renew the subscription dedicated host.
AutoRenewPeriod int
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
CpuOverCommitRatio double
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
DedicatedHostClusterId string
The dedicated host cluster ID to which the dedicated host belongs.
DedicatedHostName string
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
DedicatedHostType Changes to this property will trigger replacement. string
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
Description string
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
DetailFee bool
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
DryRun bool
Specifies whether to only validate the request. Default: false.
ExpiredTime string
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
MinQuantity int
Specify the minimum purchase quantity of a dedicated host.
NetworkAttributes List<Pulumi.AliCloud.Ecs.Inputs.DedicatedHostNetworkAttribute>
dedicated host network parameters. contains the following attributes:
PaymentType string
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
ResourceGroupId string
The ID of the resource group to which the dedicated host belongs.
SaleCycle string
The unit of the subscription period of the dedicated host.
Status string
The status of the dedicated host.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.
ActionOnMaintenance string
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
AutoPlacement string
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
AutoReleaseTime string
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
AutoRenew bool
Specifies whether to automatically renew the subscription dedicated host.
AutoRenewPeriod int
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
CpuOverCommitRatio float64
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
DedicatedHostClusterId string
The dedicated host cluster ID to which the dedicated host belongs.
DedicatedHostName string
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
DedicatedHostType Changes to this property will trigger replacement. string
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
Description string
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
DetailFee bool
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
DryRun bool
Specifies whether to only validate the request. Default: false.
ExpiredTime string
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
MinQuantity int
Specify the minimum purchase quantity of a dedicated host.
NetworkAttributes []DedicatedHostNetworkAttributeArgs
dedicated host network parameters. contains the following attributes:
PaymentType string
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
ResourceGroupId string
The ID of the resource group to which the dedicated host belongs.
SaleCycle string
The unit of the subscription period of the dedicated host.
Status string
The status of the dedicated host.
Tags map[string]string
A mapping of tags to assign to the resource.
ZoneId Changes to this property will trigger replacement. string
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.
actionOnMaintenance String
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
autoPlacement String
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
autoReleaseTime String
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
autoRenew Boolean
Specifies whether to automatically renew the subscription dedicated host.
autoRenewPeriod Integer
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
cpuOverCommitRatio Double
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
dedicatedHostClusterId String
The dedicated host cluster ID to which the dedicated host belongs.
dedicatedHostName String
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
dedicatedHostType Changes to this property will trigger replacement. String
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
description String
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
detailFee Boolean
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
dryRun Boolean
Specifies whether to only validate the request. Default: false.
expiredTime String
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
minQuantity Integer
Specify the minimum purchase quantity of a dedicated host.
networkAttributes List<DedicatedHostNetworkAttribute>
dedicated host network parameters. contains the following attributes:
paymentType String
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
resourceGroupId String
The ID of the resource group to which the dedicated host belongs.
saleCycle String
The unit of the subscription period of the dedicated host.
status String
The status of the dedicated host.
tags Map<String,String>
A mapping of tags to assign to the resource.
zoneId Changes to this property will trigger replacement. String
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.
actionOnMaintenance string
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
autoPlacement string
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
autoReleaseTime string
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
autoRenew boolean
Specifies whether to automatically renew the subscription dedicated host.
autoRenewPeriod number
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
cpuOverCommitRatio number
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
dedicatedHostClusterId string
The dedicated host cluster ID to which the dedicated host belongs.
dedicatedHostName string
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
dedicatedHostType Changes to this property will trigger replacement. string
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
description string
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
detailFee boolean
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
dryRun boolean
Specifies whether to only validate the request. Default: false.
expiredTime string
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
minQuantity number
Specify the minimum purchase quantity of a dedicated host.
networkAttributes DedicatedHostNetworkAttribute[]
dedicated host network parameters. contains the following attributes:
paymentType string
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
resourceGroupId string
The ID of the resource group to which the dedicated host belongs.
saleCycle string
The unit of the subscription period of the dedicated host.
status string
The status of the dedicated host.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
zoneId Changes to this property will trigger replacement. string
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.
action_on_maintenance str
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
auto_placement str
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
auto_release_time str
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
auto_renew bool
Specifies whether to automatically renew the subscription dedicated host.
auto_renew_period int
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
cpu_over_commit_ratio float
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
dedicated_host_cluster_id str
The dedicated host cluster ID to which the dedicated host belongs.
dedicated_host_name str
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
dedicated_host_type Changes to this property will trigger replacement. str
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
description str
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
detail_fee bool
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
dry_run bool
Specifies whether to only validate the request. Default: false.
expired_time str
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
min_quantity int
Specify the minimum purchase quantity of a dedicated host.
network_attributes Sequence[DedicatedHostNetworkAttributeArgs]
dedicated host network parameters. contains the following attributes:
payment_type str
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
resource_group_id str
The ID of the resource group to which the dedicated host belongs.
sale_cycle str
The unit of the subscription period of the dedicated host.
status str
The status of the dedicated host.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
zone_id Changes to this property will trigger replacement. str
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.
actionOnMaintenance String
The policy used to migrate the instances from the dedicated host when the dedicated host fails or needs to be repaired online. Valid values: Migrate, Stop.
autoPlacement String
Specifies whether to add the dedicated host 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. Valid values: on, off. Default: on.
autoReleaseTime String
The automatic release time of the dedicated host. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
autoRenew Boolean
Specifies whether to automatically renew the subscription dedicated host.
autoRenewPeriod Number
The auto-renewal period of the dedicated host. Unit: months. Valid values: 1, 2, 3, 6, and 12. takes effect and is required only when the AutoRenew parameter is set to true.
cpuOverCommitRatio Number
CPU oversold ratio. Only custom specifications g6s, c6s, r6s support setting the CPU oversold ratio.
dedicatedHostClusterId String
The dedicated host cluster ID to which the dedicated host belongs.
dedicatedHostName String
The name of the dedicated host. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).
dedicatedHostType Changes to this property will trigger replacement. String
The type of the dedicated host. You can call the DescribeDedicatedHostTypes operation to obtain the most recent list of dedicated host types.
description String
The description of the dedicated host. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
detailFee Boolean
Specifies whether to return the billing details of the order when the billing method is changed from subscription to pay-as-you-go. Default: false.
dryRun Boolean
Specifies whether to only validate the request. Default: false.
expiredTime String
The subscription period of the dedicated host. The Period parameter takes effect and is required only when the ChargeType parameter is set to PrePaid.
minQuantity Number
Specify the minimum purchase quantity of a dedicated host.
networkAttributes List<Property Map>
dedicated host network parameters. contains the following attributes:
paymentType String
The billing method of the dedicated host. Valid values: PrePaid, PostPaid. Default: PostPaid.
resourceGroupId String
The ID of the resource group to which the dedicated host belongs.
saleCycle String
The unit of the subscription period of the dedicated host.
status String
The status of the dedicated host.
tags Map<String>
A mapping of tags to assign to the resource.
zoneId Changes to this property will trigger replacement. String
The zone ID of the dedicated host. This parameter is empty by default. If you do not specify this parameter, the system automatically selects a zone.

Supporting Types

DedicatedHostNetworkAttribute
, DedicatedHostNetworkAttributeArgs

SlbUdpTimeout int
The timeout period for a UDP session between Server Load Balancer (SLB) and the dedicated host. Unit: seconds. Valid values: 15 to 310.
UdpTimeout int
The timeout period for a UDP session between a user and an Alibaba Cloud service on the dedicated host. Unit: seconds. Valid values: 15 to 310.
SlbUdpTimeout int
The timeout period for a UDP session between Server Load Balancer (SLB) and the dedicated host. Unit: seconds. Valid values: 15 to 310.
UdpTimeout int
The timeout period for a UDP session between a user and an Alibaba Cloud service on the dedicated host. Unit: seconds. Valid values: 15 to 310.
slbUdpTimeout Integer
The timeout period for a UDP session between Server Load Balancer (SLB) and the dedicated host. Unit: seconds. Valid values: 15 to 310.
udpTimeout Integer
The timeout period for a UDP session between a user and an Alibaba Cloud service on the dedicated host. Unit: seconds. Valid values: 15 to 310.
slbUdpTimeout number
The timeout period for a UDP session between Server Load Balancer (SLB) and the dedicated host. Unit: seconds. Valid values: 15 to 310.
udpTimeout number
The timeout period for a UDP session between a user and an Alibaba Cloud service on the dedicated host. Unit: seconds. Valid values: 15 to 310.
slb_udp_timeout int
The timeout period for a UDP session between Server Load Balancer (SLB) and the dedicated host. Unit: seconds. Valid values: 15 to 310.
udp_timeout int
The timeout period for a UDP session between a user and an Alibaba Cloud service on the dedicated host. Unit: seconds. Valid values: 15 to 310.
slbUdpTimeout Number
The timeout period for a UDP session between Server Load Balancer (SLB) and the dedicated host. Unit: seconds. Valid values: 15 to 310.
udpTimeout Number
The timeout period for a UDP session between a user and an Alibaba Cloud service on the dedicated host. Unit: seconds. Valid values: 15 to 310.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.