Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. CiamUserGroup
tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.CiamUserGroup

Explore with Pulumi AI

tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

Provides a resource to create a ciam user group

Example Usage

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

const userStore = new tencentcloud.CiamUserStore("userStore", {
    userPoolName: "tf_user_store",
    userPoolDesc: "for terraform test",
    userPoolLogo: "https://ciam-prd-1302490086.cos.ap-guangzhou.myqcloud.com/temporary/92630252a2c5422d9663db5feafd619b.png",
});
const userGroup = new tencentcloud.CiamUserGroup("userGroup", {
    displayName: "tf_user_group",
    userStoreId: userStore.ciamUserStoreId,
    description: "for terrafrom test",
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

user_store = tencentcloud.CiamUserStore("userStore",
    user_pool_name="tf_user_store",
    user_pool_desc="for terraform test",
    user_pool_logo="https://ciam-prd-1302490086.cos.ap-guangzhou.myqcloud.com/temporary/92630252a2c5422d9663db5feafd619b.png")
user_group = tencentcloud.CiamUserGroup("userGroup",
    display_name="tf_user_group",
    user_store_id=user_store.ciam_user_store_id,
    description="for terrafrom test")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		userStore, err := tencentcloud.NewCiamUserStore(ctx, "userStore", &tencentcloud.CiamUserStoreArgs{
			UserPoolName: pulumi.String("tf_user_store"),
			UserPoolDesc: pulumi.String("for terraform test"),
			UserPoolLogo: pulumi.String("https://ciam-prd-1302490086.cos.ap-guangzhou.myqcloud.com/temporary/92630252a2c5422d9663db5feafd619b.png"),
		})
		if err != nil {
			return err
		}
		_, err = tencentcloud.NewCiamUserGroup(ctx, "userGroup", &tencentcloud.CiamUserGroupArgs{
			DisplayName: pulumi.String("tf_user_group"),
			UserStoreId: userStore.CiamUserStoreId,
			Description: pulumi.String("for terrafrom test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var userStore = new Tencentcloud.CiamUserStore("userStore", new()
    {
        UserPoolName = "tf_user_store",
        UserPoolDesc = "for terraform test",
        UserPoolLogo = "https://ciam-prd-1302490086.cos.ap-guangzhou.myqcloud.com/temporary/92630252a2c5422d9663db5feafd619b.png",
    });

    var userGroup = new Tencentcloud.CiamUserGroup("userGroup", new()
    {
        DisplayName = "tf_user_group",
        UserStoreId = userStore.CiamUserStoreId,
        Description = "for terrafrom test",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.CiamUserStore;
import com.pulumi.tencentcloud.CiamUserStoreArgs;
import com.pulumi.tencentcloud.CiamUserGroup;
import com.pulumi.tencentcloud.CiamUserGroupArgs;
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) {
        var userStore = new CiamUserStore("userStore", CiamUserStoreArgs.builder()
            .userPoolName("tf_user_store")
            .userPoolDesc("for terraform test")
            .userPoolLogo("https://ciam-prd-1302490086.cos.ap-guangzhou.myqcloud.com/temporary/92630252a2c5422d9663db5feafd619b.png")
            .build());

        var userGroup = new CiamUserGroup("userGroup", CiamUserGroupArgs.builder()
            .displayName("tf_user_group")
            .userStoreId(userStore.ciamUserStoreId())
            .description("for terrafrom test")
            .build());

    }
}
Copy
resources:
  userStore:
    type: tencentcloud:CiamUserStore
    properties:
      userPoolName: tf_user_store
      userPoolDesc: for terraform test
      userPoolLogo: https://ciam-prd-1302490086.cos.ap-guangzhou.myqcloud.com/temporary/92630252a2c5422d9663db5feafd619b.png
  userGroup:
    type: tencentcloud:CiamUserGroup
    properties:
      displayName: tf_user_group
      userStoreId: ${userStore.ciamUserStoreId}
      description: for terrafrom test
Copy

Create CiamUserGroup Resource

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

Constructor syntax

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

@overload
def CiamUserGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  display_name: Optional[str] = None,
                  user_store_id: Optional[str] = None,
                  ciam_user_group_id: Optional[str] = None,
                  description: Optional[str] = None)
func NewCiamUserGroup(ctx *Context, name string, args CiamUserGroupArgs, opts ...ResourceOption) (*CiamUserGroup, error)
public CiamUserGroup(string name, CiamUserGroupArgs args, CustomResourceOptions? opts = null)
public CiamUserGroup(String name, CiamUserGroupArgs args)
public CiamUserGroup(String name, CiamUserGroupArgs args, CustomResourceOptions options)

type: tencentcloud:CiamUserGroup
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. CiamUserGroupArgs
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. CiamUserGroupArgs
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. CiamUserGroupArgs
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. CiamUserGroupArgs
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. CiamUserGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

DisplayName This property is required. string
User Group Name.
UserStoreId This property is required. string
User Store ID.
CiamUserGroupId string
ID of the resource.
Description string
User Group Description.
DisplayName This property is required. string
User Group Name.
UserStoreId This property is required. string
User Store ID.
CiamUserGroupId string
ID of the resource.
Description string
User Group Description.
displayName This property is required. String
User Group Name.
userStoreId This property is required. String
User Store ID.
ciamUserGroupId String
ID of the resource.
description String
User Group Description.
displayName This property is required. string
User Group Name.
userStoreId This property is required. string
User Store ID.
ciamUserGroupId string
ID of the resource.
description string
User Group Description.
display_name This property is required. str
User Group Name.
user_store_id This property is required. str
User Store ID.
ciam_user_group_id str
ID of the resource.
description str
User Group Description.
displayName This property is required. String
User Group Name.
userStoreId This property is required. String
User Store ID.
ciamUserGroupId String
ID of the resource.
description String
User Group Description.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing CiamUserGroup Resource

Get an existing CiamUserGroup 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?: CiamUserGroupState, opts?: CustomResourceOptions): CiamUserGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ciam_user_group_id: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        user_store_id: Optional[str] = None) -> CiamUserGroup
func GetCiamUserGroup(ctx *Context, name string, id IDInput, state *CiamUserGroupState, opts ...ResourceOption) (*CiamUserGroup, error)
public static CiamUserGroup Get(string name, Input<string> id, CiamUserGroupState? state, CustomResourceOptions? opts = null)
public static CiamUserGroup get(String name, Output<String> id, CiamUserGroupState state, CustomResourceOptions options)
resources:  _:    type: tencentcloud:CiamUserGroup    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:
CiamUserGroupId string
ID of the resource.
Description string
User Group Description.
DisplayName string
User Group Name.
UserStoreId string
User Store ID.
CiamUserGroupId string
ID of the resource.
Description string
User Group Description.
DisplayName string
User Group Name.
UserStoreId string
User Store ID.
ciamUserGroupId String
ID of the resource.
description String
User Group Description.
displayName String
User Group Name.
userStoreId String
User Store ID.
ciamUserGroupId string
ID of the resource.
description string
User Group Description.
displayName string
User Group Name.
userStoreId string
User Store ID.
ciam_user_group_id str
ID of the resource.
description str
User Group Description.
display_name str
User Group Name.
user_store_id str
User Store ID.
ciamUserGroupId String
ID of the resource.
description String
User Group Description.
displayName String
User Group Name.
userStoreId String
User Store ID.

Import

ciam user_group can be imported using the id, e.g.

$ pulumi import tencentcloud:index/ciamUserGroup:CiamUserGroup user_group userStoreId#userGroupId
Copy

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

Package Details

Repository
tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes
This Pulumi package is based on the tencentcloud Terraform Provider.
tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud