volcengine.iam.UserGroup
Explore with Pulumi AI
Provides a resource to manage iam user group
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";
const foo = new volcengine.iam.UserGroup("foo", {
description: "acc-test",
displayName: "acctest",
userGroupName: "acc-test-group",
});
import pulumi
import pulumi_volcengine as volcengine
foo = volcengine.iam.UserGroup("foo",
description="acc-test",
display_name="acctest",
user_group_name="acc-test-group")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/iam"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := iam.NewUserGroup(ctx, "foo", &iam.UserGroupArgs{
Description: pulumi.String("acc-test"),
DisplayName: pulumi.String("acctest"),
UserGroupName: pulumi.String("acc-test-group"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var foo = new Volcengine.Iam.UserGroup("foo", new()
{
Description = "acc-test",
DisplayName = "acctest",
UserGroupName = "acc-test-group",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.iam.UserGroup;
import com.pulumi.volcengine.iam.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) {
var foo = new UserGroup("foo", UserGroupArgs.builder()
.description("acc-test")
.displayName("acctest")
.userGroupName("acc-test-group")
.build());
}
}
resources:
foo:
type: volcengine:iam:UserGroup
properties:
description: acc-test
displayName: acctest
userGroupName: acc-test-group
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,
user_group_name: Optional[str] = None,
description: Optional[str] = None,
display_name: 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: volcengine:iam: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 Volcengine.Iam.UserGroup("userGroupResource", new()
{
UserGroupName = "string",
Description = "string",
DisplayName = "string",
});
example, err := iam.NewUserGroup(ctx, "userGroupResource", &iam.UserGroupArgs{
UserGroupName: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
})
var userGroupResource = new UserGroup("userGroupResource", UserGroupArgs.builder()
.userGroupName("string")
.description("string")
.displayName("string")
.build());
user_group_resource = volcengine.iam.UserGroup("userGroupResource",
user_group_name="string",
description="string",
display_name="string")
const userGroupResource = new volcengine.iam.UserGroup("userGroupResource", {
userGroupName: "string",
description: "string",
displayName: "string",
});
type: volcengine:iam:UserGroup
properties:
description: string
displayName: string
userGroupName: string
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:
- User
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the user group.
- Description string
- The description of the user group.
- Display
Name string - The display name of the user group.
- User
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the user group.
- Description string
- The description of the user group.
- Display
Name string - The display name of the user group.
- user
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the user group.
- description String
- The description of the user group.
- display
Name String - The display name of the user group.
- user
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the user group.
- description string
- The description of the user group.
- display
Name string - The display name of the user group.
- user_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the user group.
- description str
- The description of the user group.
- display_
name str - The display name of the user group.
- user
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the user group.
- description String
- The description of the user group.
- display
Name String - The display name of the user group.
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.
- 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 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,
description: Optional[str] = None,
display_name: 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: volcengine:iam: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.
- Description string
- The description of the user group.
- Display
Name string - The display name of the user group.
- User
Group Name Changes to this property will trigger replacement.
- The name of the user group.
- Description string
- The description of the user group.
- Display
Name string - The display name of the user group.
- User
Group Name Changes to this property will trigger replacement.
- The name of the user group.
- description String
- The description of the user group.
- display
Name String - The display name of the user group.
- user
Group Name Changes to this property will trigger replacement.
- The name of the user group.
- description string
- The description of the user group.
- display
Name string - The display name of the user group.
- user
Group Name Changes to this property will trigger replacement.
- The name of the user group.
- description str
- The description of the user group.
- display_
name str - The display name of the user group.
- user_
group_ name Changes to this property will trigger replacement.
- The name of the user group.
- description String
- The description of the user group.
- display
Name String - The display name of the user group.
- user
Group Name Changes to this property will trigger replacement.
- The name of the user group.
Import
IamUserGroup can be imported using the id, e.g.
$ pulumi import volcengine:iam/userGroup:UserGroup default user_group_name
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengine
Terraform Provider.