1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. iam
  5. Group
Viewing docs for volcenginecc v0.0.29
published on Thursday, Apr 2, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.iam.Group

volcenginecc logo
Viewing docs for volcenginecc v0.0.29
published on Thursday, Apr 2, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    A user group is a collection of users. When a user group is associated with a policy, all users in the group gain the corresponding policy permissions. A user can belong to multiple user groups and have permissions from each group.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  groupDemo:
    type: volcenginecc:iam:Group
    name: GroupDemo
    properties:
      userGroupName: GroupDemo
      description: GroupDemo-Description
      displayName: GroupDemo-DisplayName
      users:
        - user_name: demo
      attachedPolicies:
        - policy_type: System
          policy_name: ECSFullAccess
          policy_scope:
            - attachTime: 20230810T071***Z
              policyScopeType: Project
              projectDisplayName: demo
              projectName: Project

    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,
          user_group_name: Optional[str] = None,
          attached_policies: Optional[Sequence[GroupAttachedPolicyArgs]] = None,
          description: Optional[str] = None,
          display_name: Optional[str] = None,
          users: Optional[Sequence[GroupUserArgs]] = 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: volcenginecc:iam: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 examplegroupResourceResourceFromIamgroup = new Volcenginecc.Iam.Group("examplegroupResourceResourceFromIamgroup", new()
{
    UserGroupName = "string",
    AttachedPolicies = new[]
    {
        new Volcenginecc.Iam.Inputs.GroupAttachedPolicyArgs
        {
            PolicyName = "string",
            PolicyScopes = new[]
            {
                new Volcenginecc.Iam.Inputs.GroupAttachedPolicyPolicyScopeArgs
                {
                    AttachTime = "string",
                    PolicyScopeType = "string",
                    ProjectDisplayName = "string",
                    ProjectName = "string",
                },
            },
            PolicyType = "string",
        },
    },
    Description = "string",
    DisplayName = "string",
    Users = new[]
    {
        new Volcenginecc.Iam.Inputs.GroupUserArgs
        {
            UserName = "string",
        },
    },
});

    example, err := iam.NewGroup(ctx, "examplegroupResourceResourceFromIamgroup", &iam.GroupArgs{
	UserGroupName: pulumi.String("string"),
	AttachedPolicies: iam.GroupAttachedPolicyArray{
		&iam.GroupAttachedPolicyArgs{
			PolicyName: pulumi.String("string"),
			PolicyScopes: iam.GroupAttachedPolicyPolicyScopeArray{
				&iam.GroupAttachedPolicyPolicyScopeArgs{
					AttachTime:         pulumi.String("string"),
					PolicyScopeType:    pulumi.String("string"),
					ProjectDisplayName: pulumi.String("string"),
					ProjectName:        pulumi.String("string"),
				},
			},
			PolicyType: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Users: iam.GroupUserArray{
		&iam.GroupUserArgs{
			UserName: pulumi.String("string"),
		},
	},
})

    var examplegroupResourceResourceFromIamgroup = new com.volcengine.volcenginecc.iam.Group("examplegroupResourceResourceFromIamgroup", com.volcengine.volcenginecc.iam.GroupArgs.builder()
    .userGroupName("string")
    .attachedPolicies(GroupAttachedPolicyArgs.builder()
        .policyName("string")
        .policyScopes(GroupAttachedPolicyPolicyScopeArgs.builder()
            .attachTime("string")
            .policyScopeType("string")
            .projectDisplayName("string")
            .projectName("string")
            .build())
        .policyType("string")
        .build())
    .description("string")
    .displayName("string")
    .users(GroupUserArgs.builder()
        .userName("string")
        .build())
    .build());

    examplegroup_resource_resource_from_iamgroup = volcenginecc.iam.Group("examplegroupResourceResourceFromIamgroup",
    user_group_name="string",
    attached_policies=[{
        "policy_name": "string",
        "policy_scopes": [{
            "attach_time": "string",
            "policy_scope_type": "string",
            "project_display_name": "string",
            "project_name": "string",
        }],
        "policy_type": "string",
    }],
    description="string",
    display_name="string",
    users=[{
        "user_name": "string",
    }])

    const examplegroupResourceResourceFromIamgroup = new volcenginecc.iam.Group("examplegroupResourceResourceFromIamgroup", {
    userGroupName: "string",
    attachedPolicies: [{
        policyName: "string",
        policyScopes: [{
            attachTime: "string",
            policyScopeType: "string",
            projectDisplayName: "string",
            projectName: "string",
        }],
        policyType: "string",
    }],
    description: "string",
    displayName: "string",
    users: [{
        userName: "string",
    }],
});

    type: volcenginecc:iam:Group
properties:
    attachedPolicies:
        - policyName: string
          policyScopes:
            - attachTime: string
              policyScopeType: string
              projectDisplayName: string
              projectName: string
          policyType: string
    description: string
    displayName: string
    userGroupName: string
    users:
        - userName: 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:

    UserGroupName string
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    AttachedPolicies List<Volcengine.GroupAttachedPolicy>
    Description string
    User group description. Maximum length: 128 characters.
    DisplayName string
    User group display name. Maximum length: 64 characters.
    Users List<Volcengine.GroupUser>
    UserGroupName string
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    AttachedPolicies []GroupAttachedPolicyArgs
    Description string
    User group description. Maximum length: 128 characters.
    DisplayName string
    User group display name. Maximum length: 64 characters.
    Users []GroupUserArgs
    userGroupName String
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    attachedPolicies List<GroupAttachedPolicy>
    description String
    User group description. Maximum length: 128 characters.
    displayName String
    User group display name. Maximum length: 64 characters.
    users List<GroupUser>
    userGroupName string
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    attachedPolicies GroupAttachedPolicy[]
    description string
    User group description. Maximum length: 128 characters.
    displayName string
    User group display name. Maximum length: 64 characters.
    users GroupUser[]
    user_group_name str
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    attached_policies Sequence[GroupAttachedPolicyArgs]
    description str
    User group description. Maximum length: 128 characters.
    display_name str
    User group display name. Maximum length: 64 characters.
    users Sequence[GroupUserArgs]
    userGroupName String
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    attachedPolicies List<Property Map>
    description String
    User group description. Maximum length: 128 characters.
    displayName String
    User group display name. Maximum length: 64 characters.
    users List<Property Map>

    Outputs

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

    AccountId int
    ID of the primary account to which the user group belongs.
    CreatedTime string
    User group creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedTime string
    User group update time.
    UserGroupId int
    User group ID.
    AccountId int
    ID of the primary account to which the user group belongs.
    CreatedTime string
    User group creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedTime string
    User group update time.
    UserGroupId int
    User group ID.
    accountId Integer
    ID of the primary account to which the user group belongs.
    createdTime String
    User group creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedTime String
    User group update time.
    userGroupId Integer
    User group ID.
    accountId number
    ID of the primary account to which the user group belongs.
    createdTime string
    User group creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedTime string
    User group update time.
    userGroupId number
    User group ID.
    account_id int
    ID of the primary account to which the user group belongs.
    created_time str
    User group creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_time str
    User group update time.
    user_group_id int
    User group ID.
    accountId Number
    ID of the primary account to which the user group belongs.
    createdTime String
    User group creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedTime String
    User group update time.
    userGroupId Number
    User group ID.

    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,
        account_id: Optional[int] = None,
        attached_policies: Optional[Sequence[GroupAttachedPolicyArgs]] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        updated_time: Optional[str] = None,
        user_group_id: Optional[int] = None,
        user_group_name: Optional[str] = None,
        users: Optional[Sequence[GroupUserArgs]] = 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: volcenginecc:iam: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:
    AccountId int
    ID of the primary account to which the user group belongs.
    AttachedPolicies List<Volcengine.GroupAttachedPolicy>
    CreatedTime string
    User group creation time.
    Description string
    User group description. Maximum length: 128 characters.
    DisplayName string
    User group display name. Maximum length: 64 characters.
    UpdatedTime string
    User group update time.
    UserGroupId int
    User group ID.
    UserGroupName string
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    Users List<Volcengine.GroupUser>
    AccountId int
    ID of the primary account to which the user group belongs.
    AttachedPolicies []GroupAttachedPolicyArgs
    CreatedTime string
    User group creation time.
    Description string
    User group description. Maximum length: 128 characters.
    DisplayName string
    User group display name. Maximum length: 64 characters.
    UpdatedTime string
    User group update time.
    UserGroupId int
    User group ID.
    UserGroupName string
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    Users []GroupUserArgs
    accountId Integer
    ID of the primary account to which the user group belongs.
    attachedPolicies List<GroupAttachedPolicy>
    createdTime String
    User group creation time.
    description String
    User group description. Maximum length: 128 characters.
    displayName String
    User group display name. Maximum length: 64 characters.
    updatedTime String
    User group update time.
    userGroupId Integer
    User group ID.
    userGroupName String
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    users List<GroupUser>
    accountId number
    ID of the primary account to which the user group belongs.
    attachedPolicies GroupAttachedPolicy[]
    createdTime string
    User group creation time.
    description string
    User group description. Maximum length: 128 characters.
    displayName string
    User group display name. Maximum length: 64 characters.
    updatedTime string
    User group update time.
    userGroupId number
    User group ID.
    userGroupName string
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    users GroupUser[]
    account_id int
    ID of the primary account to which the user group belongs.
    attached_policies Sequence[GroupAttachedPolicyArgs]
    created_time str
    User group creation time.
    description str
    User group description. Maximum length: 128 characters.
    display_name str
    User group display name. Maximum length: 64 characters.
    updated_time str
    User group update time.
    user_group_id int
    User group ID.
    user_group_name str
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    users Sequence[GroupUserArgs]
    accountId Number
    ID of the primary account to which the user group belongs.
    attachedPolicies List<Property Map>
    createdTime String
    User group creation time.
    description String
    User group description. Maximum length: 128 characters.
    displayName String
    User group display name. Maximum length: 64 characters.
    updatedTime String
    User group update time.
    userGroupId Number
    User group ID.
    userGroupName String
    User group name. Length: 1–64 characters. Supports English letters, numbers, and .-_ symbols.
    users List<Property Map>

    Supporting Types

    GroupAttachedPolicy, GroupAttachedPolicyArgs

    PolicyName string
    Policy name.
    PolicyScopes List<Volcengine.GroupAttachedPolicyPolicyScope>
    PolicyType string
    Policy type. System indicates a system predefined policy; Custom indicates a custom policy.
    PolicyName string
    Policy name.
    PolicyScopes []GroupAttachedPolicyPolicyScope
    PolicyType string
    Policy type. System indicates a system predefined policy; Custom indicates a custom policy.
    policyName String
    Policy name.
    policyScopes List<GroupAttachedPolicyPolicyScope>
    policyType String
    Policy type. System indicates a system predefined policy; Custom indicates a custom policy.
    policyName string
    Policy name.
    policyScopes GroupAttachedPolicyPolicyScope[]
    policyType string
    Policy type. System indicates a system predefined policy; Custom indicates a custom policy.
    policy_name str
    Policy name.
    policy_scopes Sequence[GroupAttachedPolicyPolicyScope]
    policy_type str
    Policy type. System indicates a system predefined policy; Custom indicates a custom policy.
    policyName String
    Policy name.
    policyScopes List<Property Map>
    policyType String
    Policy type. System indicates a system predefined policy; Custom indicates a custom policy.

    GroupAttachedPolicyPolicyScope, GroupAttachedPolicyPolicyScopeArgs

    AttachTime string
    Project authorization time.
    PolicyScopeType string
    Authorization type. Global indicates global authorization (not limited by project); Project indicates project-based authorization.
    ProjectDisplayName string
    Project display name for project-based authorization.
    ProjectName string
    Project name for project-based authorization.
    AttachTime string
    Project authorization time.
    PolicyScopeType string
    Authorization type. Global indicates global authorization (not limited by project); Project indicates project-based authorization.
    ProjectDisplayName string
    Project display name for project-based authorization.
    ProjectName string
    Project name for project-based authorization.
    attachTime String
    Project authorization time.
    policyScopeType String
    Authorization type. Global indicates global authorization (not limited by project); Project indicates project-based authorization.
    projectDisplayName String
    Project display name for project-based authorization.
    projectName String
    Project name for project-based authorization.
    attachTime string
    Project authorization time.
    policyScopeType string
    Authorization type. Global indicates global authorization (not limited by project); Project indicates project-based authorization.
    projectDisplayName string
    Project display name for project-based authorization.
    projectName string
    Project name for project-based authorization.
    attach_time str
    Project authorization time.
    policy_scope_type str
    Authorization type. Global indicates global authorization (not limited by project); Project indicates project-based authorization.
    project_display_name str
    Project display name for project-based authorization.
    project_name str
    Project name for project-based authorization.
    attachTime String
    Project authorization time.
    policyScopeType String
    Authorization type. Global indicates global authorization (not limited by project); Project indicates project-based authorization.
    projectDisplayName String
    Project display name for project-based authorization.
    projectName String
    Project name for project-based authorization.

    GroupUser, GroupUserArgs

    UserName string
    Username.
    UserName string
    Username.
    userName String
    Username.
    userName string
    Username.
    user_name str
    Username.
    userName String
    Username.

    Import

    $ pulumi import volcenginecc:iam/group:Group example "user_group_name"

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.29
    published on Thursday, Apr 2, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.