bytepluscc.cloudidentity.Group

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  cloudIdentityGroupDemo:
    type: bytepluscc:cloudidentity:Group
    name: CloudIdentityGroupDemo
    properties:
      description: ccapi-multi-des
      displayName: test for ccapi
      groupName: ccapi-multi
      joinType: Manual
      members:
        - user_id: '***********'
        - user_id: '*************'

Create Group Resource

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

Constructor syntax

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);

@overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          group_name: Optional[str] = None,
          join_type: Optional[str] = None,
          description: Optional[str] = None,
          display_name: Optional[str] = None,
          members: Optional[Sequence[GroupMemberArgs]] = None)

func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)

public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)

public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: bytepluscc:cloudidentity:Group
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 GroupArgs: 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 GroupArgs: 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 GroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GroupArgs: 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 byteplusccGroupResource = new Bytepluscc.Cloudidentity.Group("byteplusccGroupResource", new()
{
    GroupName = "string",
    JoinType = "string",
    Description = "string",
    DisplayName = "string",
    Members = new[]
    {
        new Bytepluscc.Cloudidentity.Inputs.GroupMemberArgs
        {
            UserId = "string",
        },
    },
});

example, err := cloudidentity.NewGroup(ctx, "byteplusccGroupResource", &cloudidentity.GroupArgs{
	GroupName:   pulumi.String("string"),
	JoinType:    pulumi.String("string"),
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Members: cloudidentity.GroupMemberArray{
		&cloudidentity.GroupMemberArgs{
			UserId: pulumi.String("string"),
		},
	},
})

var byteplusccGroupResource = new com.byteplus.bytepluscc.cloudidentity.Group("byteplusccGroupResource", com.byteplus.bytepluscc.cloudidentity.GroupArgs.builder()
    .groupName("string")
    .joinType("string")
    .description("string")
    .displayName("string")
    .members(GroupMemberArgs.builder()
        .userId("string")
        .build())
    .build());

bytepluscc_group_resource = bytepluscc.cloudidentity.Group("byteplusccGroupResource",
    group_name="string",
    join_type="string",
    description="string",
    display_name="string",
    members=[{
        "user_id": "string",
    }])

const byteplusccGroupResource = new bytepluscc.cloudidentity.Group("byteplusccGroupResource", {
    groupName: "string",
    joinType: "string",
    description: "string",
    displayName: "string",
    members: [{
        userId: "string",
    }],
});

type: bytepluscc:cloudidentity:Group
properties:
    description: string
    displayName: string
    groupName: string
    joinType: string
    members:
        - userId: string

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

GroupName string: 用户组名称。
JoinType string: 用户组类型。
Description string: 描述。
DisplayName string: 显示名。
Members List<Byteplus.GroupMember>

GroupName string: 用户组名称。
JoinType string: 用户组类型。
Description string: 描述。
DisplayName string: 显示名。
Members []GroupMemberArgs

groupName String: 用户组名称。
joinType String: 用户组类型。
description String: 描述。
displayName String: 显示名。
members List<GroupMember>

groupName string: 用户组名称。
joinType string: 用户组类型。
description string: 描述。
displayName string: 显示名。
members GroupMember[]

group_name str: 用户组名称。
join_type str: 用户组类型。
description str: 描述。
display_name str: 显示名。
members Sequence[GroupMemberArgs]

groupName String: 用户组名称。
joinType String: 用户组类型。
description String: 描述。
displayName String: 显示名。
members List<Property Map>

Outputs

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

CreatedTime string: 创建时间。
GroupId string: 用户组id。
Id string: The provider-assigned unique ID for this managed resource.
Source string: 用户组来源。
UpdatedTime string: 更新时间。

CreatedTime string: 创建时间。
GroupId string: 用户组id。
Id string: The provider-assigned unique ID for this managed resource.
Source string: 用户组来源。
UpdatedTime string: 更新时间。

createdTime String: 创建时间。
groupId String: 用户组id。
id String: The provider-assigned unique ID for this managed resource.
source String: 用户组来源。
updatedTime String: 更新时间。

createdTime string: 创建时间。
groupId string: 用户组id。
id string: The provider-assigned unique ID for this managed resource.
source string: 用户组来源。
updatedTime string: 更新时间。

created_time str: 创建时间。
group_id str: 用户组id。
id str: The provider-assigned unique ID for this managed resource.
source str: 用户组来源。
updated_time str: 更新时间。

createdTime String: 创建时间。
groupId String: 用户组id。
id String: The provider-assigned unique ID for this managed resource.
source String: 用户组来源。
updatedTime String: 更新时间。

Look up Existing Group Resource

Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        group_id: Optional[str] = None,
        group_name: Optional[str] = None,
        join_type: Optional[str] = None,
        members: Optional[Sequence[GroupMemberArgs]] = None,
        source: Optional[str] = None,
        updated_time: Optional[str] = None) -> Group

func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)

public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)

public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)

resources:  _:    type: bytepluscc:cloudidentity:Group    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:

CreatedTime string: 创建时间。
Description string: 描述。
DisplayName string: 显示名。
GroupId string: 用户组id。
GroupName string: 用户组名称。
JoinType string: 用户组类型。
Members List<Byteplus.GroupMember>
Source string: 用户组来源。
UpdatedTime string: 更新时间。

CreatedTime string: 创建时间。
Description string: 描述。
DisplayName string: 显示名。
GroupId string: 用户组id。
GroupName string: 用户组名称。
JoinType string: 用户组类型。
Members []GroupMemberArgs
Source string: 用户组来源。
UpdatedTime string: 更新时间。

createdTime String: 创建时间。
description String: 描述。
displayName String: 显示名。
groupId String: 用户组id。
groupName String: 用户组名称。
joinType String: 用户组类型。
members List<GroupMember>
source String: 用户组来源。
updatedTime String: 更新时间。

createdTime string: 创建时间。
description string: 描述。
displayName string: 显示名。
groupId string: 用户组id。
groupName string: 用户组名称。
joinType string: 用户组类型。
members GroupMember[]
source string: 用户组来源。
updatedTime string: 更新时间。

created_time str: 创建时间。
description str: 描述。
display_name str: 显示名。
group_id str: 用户组id。
group_name str: 用户组名称。
join_type str: 用户组类型。
members Sequence[GroupMemberArgs]
source str: 用户组来源。
updated_time str: 更新时间。

createdTime String: 创建时间。
description String: 描述。
displayName String: 显示名。
groupId String: 用户组id。
groupName String: 用户组名称。
joinType String: 用户组类型。
members List<Property Map>
source String: 用户组来源。
updatedTime String: 更新时间。

Supporting Types

GroupMember, GroupMemberArgs

UserId string: 用户id。

UserId string: 用户id。

userId String: 用户id。

userId string: 用户id。

user_id str: 用户id。

userId String: 用户id。

Import

$ pulumi import bytepluscc:cloudidentity/group:Group example "group_id"

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

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.cloudidentity.Group

On this page

On this page

Example Usage

Create Group Resource

Constructor syntax

Parameters

Constructor example

Group Resource Properties

Inputs

Outputs

Look up Existing Group Resource

Supporting Types

GroupMember, GroupMemberArgs

Import

Package Details

On this page

On this page