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

alicloud.bastionhost.UserGroup

Explore with Pulumi AI

Provides a Bastion Host User Group resource.

For information about Bastion Host User Group and how to use it, see What is User Group.

NOTE: Available since v1.132.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "tf_example";
const _default = alicloud.getZones({
    availableResourceCreation: "VSwitch",
});
const defaultGetNetworks = alicloud.vpc.getNetworks({
    nameRegex: "^default-NODELETING$",
    cidrBlock: "10.4.0.0/16",
});
const defaultGetSwitches = Promise.all([defaultGetNetworks, _default]).then(([defaultGetNetworks, _default]) => alicloud.vpc.getSwitches({
    cidrBlock: "10.4.0.0/24",
    vpcId: defaultGetNetworks.ids?.[0],
    zoneId: _default.zones?.[0]?.id,
}));
const defaultSecurityGroup = new alicloud.ecs.SecurityGroup("default", {vpcId: defaultGetNetworks.then(defaultGetNetworks => defaultGetNetworks.ids?.[0])});
const defaultInstance = new alicloud.bastionhost.Instance("default", {
    description: name,
    licenseCode: "bhah_ent_50_asset",
    planCode: "cloudbastion",
    storage: "5",
    bandwidth: "5",
    period: 1,
    vswitchId: defaultGetSwitches.then(defaultGetSwitches => defaultGetSwitches.ids?.[0]),
    securityGroupIds: [defaultSecurityGroup.id],
});
const defaultUserGroup = new alicloud.bastionhost.UserGroup("default", {
    instanceId: defaultInstance.id,
    userGroupName: name,
});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "tf_example"
default = alicloud.get_zones(available_resource_creation="VSwitch")
default_get_networks = alicloud.vpc.get_networks(name_regex="^default-NODELETING$",
    cidr_block="10.4.0.0/16")
default_get_switches = alicloud.vpc.get_switches(cidr_block="10.4.0.0/24",
    vpc_id=default_get_networks.ids[0],
    zone_id=default.zones[0].id)
default_security_group = alicloud.ecs.SecurityGroup("default", vpc_id=default_get_networks.ids[0])
default_instance = alicloud.bastionhost.Instance("default",
    description=name,
    license_code="bhah_ent_50_asset",
    plan_code="cloudbastion",
    storage="5",
    bandwidth="5",
    period=1,
    vswitch_id=default_get_switches.ids[0],
    security_group_ids=[default_security_group.id])
default_user_group = alicloud.bastionhost.UserGroup("default",
    instance_id=default_instance.id,
    user_group_name=name)
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/bastionhost"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"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, "")
		name := "tf_example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
			AvailableResourceCreation: pulumi.StringRef("VSwitch"),
		}, nil)
		if err != nil {
			return err
		}
		defaultGetNetworks, err := vpc.GetNetworks(ctx, &vpc.GetNetworksArgs{
			NameRegex: pulumi.StringRef("^default-NODELETING$"),
			CidrBlock: pulumi.StringRef("10.4.0.0/16"),
		}, nil)
		if err != nil {
			return err
		}
		defaultGetSwitches, err := vpc.GetSwitches(ctx, &vpc.GetSwitchesArgs{
			CidrBlock: pulumi.StringRef("10.4.0.0/24"),
			VpcId:     pulumi.StringRef(defaultGetNetworks.Ids[0]),
			ZoneId:    pulumi.StringRef(_default.Zones[0].Id),
		}, nil)
		if err != nil {
			return err
		}
		defaultSecurityGroup, err := ecs.NewSecurityGroup(ctx, "default", &ecs.SecurityGroupArgs{
			VpcId: pulumi.String(defaultGetNetworks.Ids[0]),
		})
		if err != nil {
			return err
		}
		defaultInstance, err := bastionhost.NewInstance(ctx, "default", &bastionhost.InstanceArgs{
			Description: pulumi.String(name),
			LicenseCode: pulumi.String("bhah_ent_50_asset"),
			PlanCode:    pulumi.String("cloudbastion"),
			Storage:     pulumi.String("5"),
			Bandwidth:   pulumi.String("5"),
			Period:      pulumi.Int(1),
			VswitchId:   pulumi.String(defaultGetSwitches.Ids[0]),
			SecurityGroupIds: pulumi.StringArray{
				defaultSecurityGroup.ID(),
			},
		})
		if err != nil {
			return err
		}
		_, err = bastionhost.NewUserGroup(ctx, "default", &bastionhost.UserGroupArgs{
			InstanceId:    defaultInstance.ID(),
			UserGroupName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "tf_example";
    var @default = AliCloud.GetZones.Invoke(new()
    {
        AvailableResourceCreation = "VSwitch",
    });

    var defaultGetNetworks = AliCloud.Vpc.GetNetworks.Invoke(new()
    {
        NameRegex = "^default-NODELETING$",
        CidrBlock = "10.4.0.0/16",
    });

    var defaultGetSwitches = AliCloud.Vpc.GetSwitches.Invoke(new()
    {
        CidrBlock = "10.4.0.0/24",
        VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
        ZoneId = @default.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
    });

    var defaultSecurityGroup = new AliCloud.Ecs.SecurityGroup("default", new()
    {
        VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
    });

    var defaultInstance = new AliCloud.BastionHost.Instance("default", new()
    {
        Description = name,
        LicenseCode = "bhah_ent_50_asset",
        PlanCode = "cloudbastion",
        Storage = "5",
        Bandwidth = "5",
        Period = 1,
        VswitchId = defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Ids[0]),
        SecurityGroupIds = new[]
        {
            defaultSecurityGroup.Id,
        },
    });

    var defaultUserGroup = new AliCloud.BastionHost.UserGroup("default", new()
    {
        InstanceId = defaultInstance.Id,
        UserGroupName = name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.VpcFunctions;
import com.pulumi.alicloud.vpc.inputs.GetNetworksArgs;
import com.pulumi.alicloud.vpc.inputs.GetSwitchesArgs;
import com.pulumi.alicloud.ecs.SecurityGroup;
import com.pulumi.alicloud.ecs.SecurityGroupArgs;
import com.pulumi.alicloud.bastionhost.Instance;
import com.pulumi.alicloud.bastionhost.InstanceArgs;
import com.pulumi.alicloud.bastionhost.UserGroup;
import com.pulumi.alicloud.bastionhost.UserGroupArgs;
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 name = config.get("name").orElse("tf_example");
        final var default = AlicloudFunctions.getZones(GetZonesArgs.builder()
            .availableResourceCreation("VSwitch")
            .build());

        final var defaultGetNetworks = VpcFunctions.getNetworks(GetNetworksArgs.builder()
            .nameRegex("^default-NODELETING$")
            .cidrBlock("10.4.0.0/16")
            .build());

        final var defaultGetSwitches = VpcFunctions.getSwitches(GetSwitchesArgs.builder()
            .cidrBlock("10.4.0.0/24")
            .vpcId(defaultGetNetworks.applyValue(getNetworksResult -> getNetworksResult.ids()[0]))
            .zoneId(default_.zones()[0].id())
            .build());

        var defaultSecurityGroup = new SecurityGroup("defaultSecurityGroup", SecurityGroupArgs.builder()
            .vpcId(defaultGetNetworks.applyValue(getNetworksResult -> getNetworksResult.ids()[0]))
            .build());

        var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
            .description(name)
            .licenseCode("bhah_ent_50_asset")
            .planCode("cloudbastion")
            .storage("5")
            .bandwidth("5")
            .period("1")
            .vswitchId(defaultGetSwitches.applyValue(getSwitchesResult -> getSwitchesResult.ids()[0]))
            .securityGroupIds(defaultSecurityGroup.id())
            .build());

        var defaultUserGroup = new UserGroup("defaultUserGroup", UserGroupArgs.builder()
            .instanceId(defaultInstance.id())
            .userGroupName(name)
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: tf_example
resources:
  defaultSecurityGroup:
    type: alicloud:ecs:SecurityGroup
    name: default
    properties:
      vpcId: ${defaultGetNetworks.ids[0]}
  defaultInstance:
    type: alicloud:bastionhost:Instance
    name: default
    properties:
      description: ${name}
      licenseCode: bhah_ent_50_asset
      planCode: cloudbastion
      storage: '5'
      bandwidth: '5'
      period: '1'
      vswitchId: ${defaultGetSwitches.ids[0]}
      securityGroupIds:
        - ${defaultSecurityGroup.id}
  defaultUserGroup:
    type: alicloud:bastionhost:UserGroup
    name: default
    properties:
      instanceId: ${defaultInstance.id}
      userGroupName: ${name}
variables:
  default:
    fn::invoke:
      function: alicloud:getZones
      arguments:
        availableResourceCreation: VSwitch
  defaultGetNetworks:
    fn::invoke:
      function: alicloud:vpc:getNetworks
      arguments:
        nameRegex: ^default-NODELETING$
        cidrBlock: 10.4.0.0/16
  defaultGetSwitches:
    fn::invoke:
      function: alicloud:vpc:getSwitches
      arguments:
        cidrBlock: 10.4.0.0/24
        vpcId: ${defaultGetNetworks.ids[0]}
        zoneId: ${default.zones[0].id}
Copy

Create UserGroup Resource

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

Constructor syntax

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

@overload
def UserGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              instance_id: Optional[str] = None,
              user_group_name: Optional[str] = None,
              comment: Optional[str] = None)
func NewUserGroup(ctx *Context, name string, args UserGroupArgs, opts ...ResourceOption) (*UserGroup, error)
public UserGroup(string name, UserGroupArgs args, CustomResourceOptions? opts = null)
public UserGroup(String name, UserGroupArgs args)
public UserGroup(String name, UserGroupArgs args, CustomResourceOptions options)
type: alicloud:bastionhost:UserGroup
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. UserGroupArgs
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. UserGroupArgs
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. UserGroupArgs
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. UserGroupArgs
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. UserGroupArgs
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 userGroupResource = new AliCloud.BastionHost.UserGroup("userGroupResource", new()
{
    InstanceId = "string",
    UserGroupName = "string",
    Comment = "string",
});
Copy
example, err := bastionhost.NewUserGroup(ctx, "userGroupResource", &bastionhost.UserGroupArgs{
	InstanceId:    pulumi.String("string"),
	UserGroupName: pulumi.String("string"),
	Comment:       pulumi.String("string"),
})
Copy
var userGroupResource = new UserGroup("userGroupResource", UserGroupArgs.builder()
    .instanceId("string")
    .userGroupName("string")
    .comment("string")
    .build());
Copy
user_group_resource = alicloud.bastionhost.UserGroup("userGroupResource",
    instance_id="string",
    user_group_name="string",
    comment="string")
Copy
const userGroupResource = new alicloud.bastionhost.UserGroup("userGroupResource", {
    instanceId: "string",
    userGroupName: "string",
    comment: "string",
});
Copy
type: alicloud:bastionhost:UserGroup
properties:
    comment: string
    instanceId: string
    userGroupName: string
Copy

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

InstanceId
This property is required.
Changes to this property will trigger replacement.
string
Specify the New Group of the Bastion Host of Instance Id.
UserGroupName This property is required. string
Specify the New Group Name. Supports up to 128 Characters.
Comment string
Specify the New Group of Remark Information. Supports up to 500 Characters.
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
Specify the New Group of the Bastion Host of Instance Id.
UserGroupName This property is required. string
Specify the New Group Name. Supports up to 128 Characters.
Comment string
Specify the New Group of Remark Information. Supports up to 500 Characters.
instanceId
This property is required.
Changes to this property will trigger replacement.
String
Specify the New Group of the Bastion Host of Instance Id.
userGroupName This property is required. String
Specify the New Group Name. Supports up to 128 Characters.
comment String
Specify the New Group of Remark Information. Supports up to 500 Characters.
instanceId
This property is required.
Changes to this property will trigger replacement.
string
Specify the New Group of the Bastion Host of Instance Id.
userGroupName This property is required. string
Specify the New Group Name. Supports up to 128 Characters.
comment string
Specify the New Group of Remark Information. Supports up to 500 Characters.
instance_id
This property is required.
Changes to this property will trigger replacement.
str
Specify the New Group of the Bastion Host of Instance Id.
user_group_name This property is required. str
Specify the New Group Name. Supports up to 128 Characters.
comment str
Specify the New Group of Remark Information. Supports up to 500 Characters.
instanceId
This property is required.
Changes to this property will trigger replacement.
String
Specify the New Group of the Bastion Host of Instance Id.
userGroupName This property is required. String
Specify the New Group Name. Supports up to 128 Characters.
comment String
Specify the New Group of Remark Information. Supports up to 500 Characters.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
UserGroupId string
The User Group self ID.
Id string
The provider-assigned unique ID for this managed resource.
UserGroupId string
The User Group self ID.
id String
The provider-assigned unique ID for this managed resource.
userGroupId String
The User Group self ID.
id string
The provider-assigned unique ID for this managed resource.
userGroupId string
The User Group self ID.
id str
The provider-assigned unique ID for this managed resource.
user_group_id str
The User Group self ID.
id String
The provider-assigned unique ID for this managed resource.
userGroupId String
The User Group self ID.

Look up Existing UserGroup Resource

Get an existing UserGroup 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?: UserGroupState, opts?: CustomResourceOptions): UserGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        instance_id: Optional[str] = None,
        user_group_id: Optional[str] = None,
        user_group_name: Optional[str] = None) -> UserGroup
func GetUserGroup(ctx *Context, name string, id IDInput, state *UserGroupState, opts ...ResourceOption) (*UserGroup, error)
public static UserGroup Get(string name, Input<string> id, UserGroupState? state, CustomResourceOptions? opts = null)
public static UserGroup get(String name, Output<String> id, UserGroupState state, CustomResourceOptions options)
resources:  _:    type: alicloud:bastionhost:UserGroup    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:
Comment string
Specify the New Group of Remark Information. Supports up to 500 Characters.
InstanceId Changes to this property will trigger replacement. string
Specify the New Group of the Bastion Host of Instance Id.
UserGroupId string
The User Group self ID.
UserGroupName string
Specify the New Group Name. Supports up to 128 Characters.
Comment string
Specify the New Group of Remark Information. Supports up to 500 Characters.
InstanceId Changes to this property will trigger replacement. string
Specify the New Group of the Bastion Host of Instance Id.
UserGroupId string
The User Group self ID.
UserGroupName string
Specify the New Group Name. Supports up to 128 Characters.
comment String
Specify the New Group of Remark Information. Supports up to 500 Characters.
instanceId Changes to this property will trigger replacement. String
Specify the New Group of the Bastion Host of Instance Id.
userGroupId String
The User Group self ID.
userGroupName String
Specify the New Group Name. Supports up to 128 Characters.
comment string
Specify the New Group of Remark Information. Supports up to 500 Characters.
instanceId Changes to this property will trigger replacement. string
Specify the New Group of the Bastion Host of Instance Id.
userGroupId string
The User Group self ID.
userGroupName string
Specify the New Group Name. Supports up to 128 Characters.
comment str
Specify the New Group of Remark Information. Supports up to 500 Characters.
instance_id Changes to this property will trigger replacement. str
Specify the New Group of the Bastion Host of Instance Id.
user_group_id str
The User Group self ID.
user_group_name str
Specify the New Group Name. Supports up to 128 Characters.
comment String
Specify the New Group of Remark Information. Supports up to 500 Characters.
instanceId Changes to this property will trigger replacement. String
Specify the New Group of the Bastion Host of Instance Id.
userGroupId String
The User Group self ID.
userGroupName String
Specify the New Group Name. Supports up to 128 Characters.

Import

Bastion Host User Group can be imported using the id, e.g.

$ pulumi import alicloud:bastionhost/userGroup:UserGroup example <instance_id>:<user_group_id>
Copy

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

Package Details

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