1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. HssHostGroupV5
opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud

opentelekomcloud.HssHostGroupV5

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud

    Up-to-date reference of API arguments for HSS host group you can get at documentation portal.

    Manages an HSS host group resource within OpenTelekomCloud.

    Example Usage

    Create an HSS host group and bind ECS instances

    import * as pulumi from "@pulumi/pulumi";
    import * as opentelekomcloud from "@pulumi/opentelekomcloud";
    
    const config = new pulumi.Config();
    const hostGroupName = config.requireObject("hostGroupName");
    const hostIds = config.requireObject<Array<string>>("hostIds");
    const test = new opentelekomcloud.HssHostGroupV5("test", {hostIds: hostIds});
    
    import pulumi
    import pulumi_opentelekomcloud as opentelekomcloud
    
    config = pulumi.Config()
    host_group_name = config.require_object("hostGroupName")
    host_ids = config.require_object("hostIds")
    test = opentelekomcloud.HssHostGroupV5("test", host_ids=host_ids)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		hostGroupName := cfg.RequireObject("hostGroupName")
    		hostIds := cfg.Require("hostIds")
    		_, err := opentelekomcloud.NewHssHostGroupV5(ctx, "test", &opentelekomcloud.HssHostGroupV5Args{
    			HostIds: hostIds,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Opentelekomcloud = Pulumi.Opentelekomcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var hostGroupName = config.RequireObject<dynamic>("hostGroupName");
        var hostIds = config.RequireObject<string[]>("hostIds");
        var test = new Opentelekomcloud.HssHostGroupV5("test", new()
        {
            HostIds = hostIds,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opentelekomcloud.HssHostGroupV5;
    import com.pulumi.opentelekomcloud.HssHostGroupV5Args;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var config = ctx.config();
            final var hostGroupName = config.get("hostGroupName");
            final var hostIds = config.get("hostIds");
            var test = new HssHostGroupV5("test", HssHostGroupV5Args.builder()
                .hostIds(hostIds)
                .build());
    
        }
    }
    
    configuration:
      hostGroupName:
        type: dynamic
      hostIds:
        type: list(string)
    resources:
      test:
        type: opentelekomcloud:HssHostGroupV5
        properties:
          hostIds: ${hostIds}
    

    Create HssHostGroupV5 Resource

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

    Constructor syntax

    new HssHostGroupV5(name: string, args?: HssHostGroupV5Args, opts?: CustomResourceOptions);
    @overload
    def HssHostGroupV5(resource_name: str,
                       args: Optional[HssHostGroupV5Args] = None,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def HssHostGroupV5(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       host_ids: Optional[Sequence[str]] = None,
                       hss_host_group_v5_id: Optional[str] = None,
                       name: Optional[str] = None,
                       timeouts: Optional[HssHostGroupV5TimeoutsArgs] = None)
    func NewHssHostGroupV5(ctx *Context, name string, args *HssHostGroupV5Args, opts ...ResourceOption) (*HssHostGroupV5, error)
    public HssHostGroupV5(string name, HssHostGroupV5Args? args = null, CustomResourceOptions? opts = null)
    public HssHostGroupV5(String name, HssHostGroupV5Args args)
    public HssHostGroupV5(String name, HssHostGroupV5Args args, CustomResourceOptions options)
    
    type: opentelekomcloud:HssHostGroupV5
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args HssHostGroupV5Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args HssHostGroupV5Args
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args HssHostGroupV5Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HssHostGroupV5Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HssHostGroupV5Args
    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 hssHostGroupV5Resource = new Opentelekomcloud.HssHostGroupV5("hssHostGroupV5Resource", new()
    {
        HostIds = new[]
        {
            "string",
        },
        HssHostGroupV5Id = "string",
        Name = "string",
        Timeouts = new Opentelekomcloud.Inputs.HssHostGroupV5TimeoutsArgs
        {
            Create = "string",
            Update = "string",
        },
    });
    
    example, err := opentelekomcloud.NewHssHostGroupV5(ctx, "hssHostGroupV5Resource", &opentelekomcloud.HssHostGroupV5Args{
    HostIds: pulumi.StringArray{
    pulumi.String("string"),
    },
    HssHostGroupV5Id: pulumi.String("string"),
    Name: pulumi.String("string"),
    Timeouts: &.HssHostGroupV5TimeoutsArgs{
    Create: pulumi.String("string"),
    Update: pulumi.String("string"),
    },
    })
    
    var hssHostGroupV5Resource = new HssHostGroupV5("hssHostGroupV5Resource", HssHostGroupV5Args.builder()
        .hostIds("string")
        .hssHostGroupV5Id("string")
        .name("string")
        .timeouts(HssHostGroupV5TimeoutsArgs.builder()
            .create("string")
            .update("string")
            .build())
        .build());
    
    hss_host_group_v5_resource = opentelekomcloud.HssHostGroupV5("hssHostGroupV5Resource",
        host_ids=["string"],
        hss_host_group_v5_id="string",
        name="string",
        timeouts={
            "create": "string",
            "update": "string",
        })
    
    const hssHostGroupV5Resource = new opentelekomcloud.HssHostGroupV5("hssHostGroupV5Resource", {
        hostIds: ["string"],
        hssHostGroupV5Id: "string",
        name: "string",
        timeouts: {
            create: "string",
            update: "string",
        },
    });
    
    type: opentelekomcloud:HssHostGroupV5
    properties:
        hostIds:
            - string
        hssHostGroupV5Id: string
        name: string
        timeouts:
            create: string
            update: string
    

    HssHostGroupV5 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 HssHostGroupV5 resource accepts the following input properties:

    HostIds List<string>
    Specifies the list of host IDs.
    HssHostGroupV5Id string
    The resource ID in UUID format.
    Name string
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    Timeouts HssHostGroupV5Timeouts
    HostIds []string
    Specifies the list of host IDs.
    HssHostGroupV5Id string
    The resource ID in UUID format.
    Name string
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    Timeouts HssHostGroupV5TimeoutsArgs
    hostIds List<String>
    Specifies the list of host IDs.
    hssHostGroupV5Id String
    The resource ID in UUID format.
    name String
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    timeouts HssHostGroupV5Timeouts
    hostIds string[]
    Specifies the list of host IDs.
    hssHostGroupV5Id string
    The resource ID in UUID format.
    name string
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    timeouts HssHostGroupV5Timeouts
    host_ids Sequence[str]
    Specifies the list of host IDs.
    hss_host_group_v5_id str
    The resource ID in UUID format.
    name str
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    timeouts HssHostGroupV5TimeoutsArgs
    hostIds List<String>
    Specifies the list of host IDs.
    hssHostGroupV5Id String
    The resource ID in UUID format.
    name String
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    timeouts Property Map

    Outputs

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

    HostNum double
    The total host number.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    The region where the host group is located.
    RiskHostNum double
    The number of hosts at risk.
    UnprotectHostIds List<string>
    The ID list of the unprotect hosts.
    UnprotectHostNum double
    The number of unprotect hosts.
    HostNum float64
    The total host number.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    The region where the host group is located.
    RiskHostNum float64
    The number of hosts at risk.
    UnprotectHostIds []string
    The ID list of the unprotect hosts.
    UnprotectHostNum float64
    The number of unprotect hosts.
    hostNum Double
    The total host number.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    The region where the host group is located.
    riskHostNum Double
    The number of hosts at risk.
    unprotectHostIds List<String>
    The ID list of the unprotect hosts.
    unprotectHostNum Double
    The number of unprotect hosts.
    hostNum number
    The total host number.
    id string
    The provider-assigned unique ID for this managed resource.
    region string
    The region where the host group is located.
    riskHostNum number
    The number of hosts at risk.
    unprotectHostIds string[]
    The ID list of the unprotect hosts.
    unprotectHostNum number
    The number of unprotect hosts.
    host_num float
    The total host number.
    id str
    The provider-assigned unique ID for this managed resource.
    region str
    The region where the host group is located.
    risk_host_num float
    The number of hosts at risk.
    unprotect_host_ids Sequence[str]
    The ID list of the unprotect hosts.
    unprotect_host_num float
    The number of unprotect hosts.
    hostNum Number
    The total host number.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    The region where the host group is located.
    riskHostNum Number
    The number of hosts at risk.
    unprotectHostIds List<String>
    The ID list of the unprotect hosts.
    unprotectHostNum Number
    The number of unprotect hosts.

    Look up Existing HssHostGroupV5 Resource

    Get an existing HssHostGroupV5 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?: HssHostGroupV5State, opts?: CustomResourceOptions): HssHostGroupV5
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            host_ids: Optional[Sequence[str]] = None,
            host_num: Optional[float] = None,
            hss_host_group_v5_id: Optional[str] = None,
            name: Optional[str] = None,
            region: Optional[str] = None,
            risk_host_num: Optional[float] = None,
            timeouts: Optional[HssHostGroupV5TimeoutsArgs] = None,
            unprotect_host_ids: Optional[Sequence[str]] = None,
            unprotect_host_num: Optional[float] = None) -> HssHostGroupV5
    func GetHssHostGroupV5(ctx *Context, name string, id IDInput, state *HssHostGroupV5State, opts ...ResourceOption) (*HssHostGroupV5, error)
    public static HssHostGroupV5 Get(string name, Input<string> id, HssHostGroupV5State? state, CustomResourceOptions? opts = null)
    public static HssHostGroupV5 get(String name, Output<String> id, HssHostGroupV5State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:HssHostGroupV5    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    HostIds List<string>
    Specifies the list of host IDs.
    HostNum double
    The total host number.
    HssHostGroupV5Id string
    The resource ID in UUID format.
    Name string
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    Region string
    The region where the host group is located.
    RiskHostNum double
    The number of hosts at risk.
    Timeouts HssHostGroupV5Timeouts
    UnprotectHostIds List<string>
    The ID list of the unprotect hosts.
    UnprotectHostNum double
    The number of unprotect hosts.
    HostIds []string
    Specifies the list of host IDs.
    HostNum float64
    The total host number.
    HssHostGroupV5Id string
    The resource ID in UUID format.
    Name string
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    Region string
    The region where the host group is located.
    RiskHostNum float64
    The number of hosts at risk.
    Timeouts HssHostGroupV5TimeoutsArgs
    UnprotectHostIds []string
    The ID list of the unprotect hosts.
    UnprotectHostNum float64
    The number of unprotect hosts.
    hostIds List<String>
    Specifies the list of host IDs.
    hostNum Double
    The total host number.
    hssHostGroupV5Id String
    The resource ID in UUID format.
    name String
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    region String
    The region where the host group is located.
    riskHostNum Double
    The number of hosts at risk.
    timeouts HssHostGroupV5Timeouts
    unprotectHostIds List<String>
    The ID list of the unprotect hosts.
    unprotectHostNum Double
    The number of unprotect hosts.
    hostIds string[]
    Specifies the list of host IDs.
    hostNum number
    The total host number.
    hssHostGroupV5Id string
    The resource ID in UUID format.
    name string
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    region string
    The region where the host group is located.
    riskHostNum number
    The number of hosts at risk.
    timeouts HssHostGroupV5Timeouts
    unprotectHostIds string[]
    The ID list of the unprotect hosts.
    unprotectHostNum number
    The number of unprotect hosts.
    host_ids Sequence[str]
    Specifies the list of host IDs.
    host_num float
    The total host number.
    hss_host_group_v5_id str
    The resource ID in UUID format.
    name str
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    region str
    The region where the host group is located.
    risk_host_num float
    The number of hosts at risk.
    timeouts HssHostGroupV5TimeoutsArgs
    unprotect_host_ids Sequence[str]
    The ID list of the unprotect hosts.
    unprotect_host_num float
    The number of unprotect hosts.
    hostIds List<String>
    Specifies the list of host IDs.
    hostNum Number
    The total host number.
    hssHostGroupV5Id String
    The resource ID in UUID format.
    name String
    Specifies the name of the host group. The valid length is limited from 1 to 64, only Chinese characters, English letters, digits, hyphens (-), underscores (_), dots (.), pluses (+) and asterisks (*) are allowed. The Chinese characters must be in UTF-8 or Unicode format.
    region String
    The region where the host group is located.
    riskHostNum Number
    The number of hosts at risk.
    timeouts Property Map
    unprotectHostIds List<String>
    The ID list of the unprotect hosts.
    unprotectHostNum Number
    The number of unprotect hosts.

    Supporting Types

    HssHostGroupV5Timeouts, HssHostGroupV5TimeoutsArgs

    Create string
    Update string
    Create string
    Update string
    create String
    update String
    create string
    update string
    create str
    update str
    create String
    update String

    Import

    The host group resource can be imported using id, e.g.

    bash

    $ pulumi import opentelekomcloud:index/hssHostGroupV5:HssHostGroupV5 group <id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.35 published on Monday, Apr 14, 2025 by opentelekomcloud