Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. cloud_identity
  5. Group
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.cloud_identity.Group

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage cloud identity group

    Example Usage

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

const foo = new volcengine.cloud_identity.Group("foo", {
    description: "tf",
    displayName: "tf-test-group",
    groupName: "acc-test-group",
    joinType: "Manual",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.cloud_identity.Group("foo",
    description="tf",
    display_name="tf-test-group",
    group_name="acc-test-group",
    join_type="Manual")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/cloud_identity"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloud_identity.NewGroup(ctx, "foo", &cloud_identity.GroupArgs{
			Description: pulumi.String("tf"),
			DisplayName: pulumi.String("tf-test-group"),
			GroupName:   pulumi.String("acc-test-group"),
			JoinType:    pulumi.String("Manual"),
		})
		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.Cloud_identity.Group("foo", new()
    {
        Description = "tf",
        DisplayName = "tf-test-group",
        GroupName = "acc-test-group",
        JoinType = "Manual",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.cloud_identity.Group;
import com.pulumi.volcengine.cloud_identity.GroupArgs;
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 Group("foo", GroupArgs.builder()        
            .description("tf")
            .displayName("tf-test-group")
            .groupName("acc-test-group")
            .joinType("Manual")
            .build());

    }
}

    resources:
  foo:
    type: volcengine:cloud_identity:Group
    properties:
      description: tf
      displayName: tf-test-group
      groupName: acc-test-group
      joinType: Manual

    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)
    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: volcengine:cloud_identity: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 groupResource = new Volcengine.Cloud_identity.Group("groupResource", new()
{
    GroupName = "string",
    JoinType = "string",
    Description = "string",
    DisplayName = "string",
});

    example, err := cloud_identity.NewGroup(ctx, "groupResource", &cloud_identity.GroupArgs{
	GroupName:   pulumi.String("string"),
	JoinType:    pulumi.String("string"),
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
})

    var groupResource = new Group("groupResource", GroupArgs.builder()
    .groupName("string")
    .joinType("string")
    .description("string")
    .displayName("string")
    .build());

    group_resource = volcengine.cloud_identity.Group("groupResource",
    group_name="string",
    join_type="string",
    description="string",
    display_name="string")

    const groupResource = new volcengine.cloud_identity.Group("groupResource", {
    groupName: "string",
    joinType: "string",
    description: "string",
    displayName: "string",
});

    type: volcengine:cloud_identity:Group
properties:
    description: string
    displayName: string
    groupName: string
    joinType: 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
    The name of the cloud identity group.
    JoinType string
    The user join type of the cloud identity group.
    Description string
    The description of the cloud identity group.
    DisplayName string
    The display name of the cloud identity group.
    GroupName string
    The name of the cloud identity group.
    JoinType string
    The user join type of the cloud identity group.
    Description string
    The description of the cloud identity group.
    DisplayName string
    The display name of the cloud identity group.
    groupName String
    The name of the cloud identity group.
    joinType String
    The user join type of the cloud identity group.
    description String
    The description of the cloud identity group.
    displayName String
    The display name of the cloud identity group.
    groupName string
    The name of the cloud identity group.
    joinType string
    The user join type of the cloud identity group.
    description string
    The description of the cloud identity group.
    displayName string
    The display name of the cloud identity group.
    group_name str
    The name of the cloud identity group.
    join_type str
    The user join type of the cloud identity group.
    description str
    The description of the cloud identity group.
    display_name str
    The display name of the cloud identity group.
    groupName String
    The name of the cloud identity group.
    joinType String
    The user join type of the cloud identity group.
    description String
    The description of the cloud identity group.
    displayName String
    The display name of the cloud identity group.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Members List<GroupMember>
    The member user info of the cloud identity group.
    Source string
    The source of the cloud identity group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Members []GroupMember
    The member user info of the cloud identity group.
    Source string
    The source of the cloud identity group.
    id String
    The provider-assigned unique ID for this managed resource.
    members List<GroupMember>
    The member user info of the cloud identity group.
    source String
    The source of the cloud identity group.
    id string
    The provider-assigned unique ID for this managed resource.
    members GroupMember[]
    The member user info of the cloud identity group.
    source string
    The source of the cloud identity group.
    id str
    The provider-assigned unique ID for this managed resource.
    members Sequence[GroupMember]
    The member user info of the cloud identity group.
    source str
    The source of the cloud identity group.
    id String
    The provider-assigned unique ID for this managed resource.
    members List<Property Map>
    The member user info of the cloud identity group.
    source String
    The source of the cloud identity group.

    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,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        group_name: Optional[str] = None,
        join_type: Optional[str] = None,
        members: Optional[Sequence[GroupMemberArgs]] = None,
        source: 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: volcengine:cloud_identity: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:
    Description string
    The description of the cloud identity group.
    DisplayName string
    The display name of the cloud identity group.
    GroupName string
    The name of the cloud identity group.
    JoinType string
    The user join type of the cloud identity group.
    Members List<GroupMember>
    The member user info of the cloud identity group.
    Source string
    The source of the cloud identity group.
    Description string
    The description of the cloud identity group.
    DisplayName string
    The display name of the cloud identity group.
    GroupName string
    The name of the cloud identity group.
    JoinType string
    The user join type of the cloud identity group.
    Members []GroupMemberArgs
    The member user info of the cloud identity group.
    Source string
    The source of the cloud identity group.
    description String
    The description of the cloud identity group.
    displayName String
    The display name of the cloud identity group.
    groupName String
    The name of the cloud identity group.
    joinType String
    The user join type of the cloud identity group.
    members List<GroupMember>
    The member user info of the cloud identity group.
    source String
    The source of the cloud identity group.
    description string
    The description of the cloud identity group.
    displayName string
    The display name of the cloud identity group.
    groupName string
    The name of the cloud identity group.
    joinType string
    The user join type of the cloud identity group.
    members GroupMember[]
    The member user info of the cloud identity group.
    source string
    The source of the cloud identity group.
    description str
    The description of the cloud identity group.
    display_name str
    The display name of the cloud identity group.
    group_name str
    The name of the cloud identity group.
    join_type str
    The user join type of the cloud identity group.
    members Sequence[GroupMemberArgs]
    The member user info of the cloud identity group.
    source str
    The source of the cloud identity group.
    description String
    The description of the cloud identity group.
    displayName String
    The display name of the cloud identity group.
    groupName String
    The name of the cloud identity group.
    joinType String
    The user join type of the cloud identity group.
    members List<Property Map>
    The member user info of the cloud identity group.
    source String
    The source of the cloud identity group.

    Supporting Types

    GroupMember, GroupMemberArgs

    Description string
    The description of the cloud identity group.
    DisplayName string
    The display name of the cloud identity group.
    Email string
    The email of the cloud identity user.
    IdentityType string
    The identity type of the cloud identity user.
    JoinTime string
    The join time of the cloud identity user.
    Phone string
    The phone of the cloud identity user.
    Source string
    The source of the cloud identity group.
    UserId string
    The id of the cloud identity user.
    UserName string
    The name of the cloud identity user.
    Description string
    The description of the cloud identity group.
    DisplayName string
    The display name of the cloud identity group.
    Email string
    The email of the cloud identity user.
    IdentityType string
    The identity type of the cloud identity user.
    JoinTime string
    The join time of the cloud identity user.
    Phone string
    The phone of the cloud identity user.
    Source string
    The source of the cloud identity group.
    UserId string
    The id of the cloud identity user.
    UserName string
    The name of the cloud identity user.
    description String
    The description of the cloud identity group.
    displayName String
    The display name of the cloud identity group.
    email String
    The email of the cloud identity user.
    identityType String
    The identity type of the cloud identity user.
    joinTime String
    The join time of the cloud identity user.
    phone String
    The phone of the cloud identity user.
    source String
    The source of the cloud identity group.
    userId String
    The id of the cloud identity user.
    userName String
    The name of the cloud identity user.
    description string
    The description of the cloud identity group.
    displayName string
    The display name of the cloud identity group.
    email string
    The email of the cloud identity user.
    identityType string
    The identity type of the cloud identity user.
    joinTime string
    The join time of the cloud identity user.
    phone string
    The phone of the cloud identity user.
    source string
    The source of the cloud identity group.
    userId string
    The id of the cloud identity user.
    userName string
    The name of the cloud identity user.
    description str
    The description of the cloud identity group.
    display_name str
    The display name of the cloud identity group.
    email str
    The email of the cloud identity user.
    identity_type str
    The identity type of the cloud identity user.
    join_time str
    The join time of the cloud identity user.
    phone str
    The phone of the cloud identity user.
    source str
    The source of the cloud identity group.
    user_id str
    The id of the cloud identity user.
    user_name str
    The name of the cloud identity user.
    description String
    The description of the cloud identity group.
    displayName String
    The display name of the cloud identity group.
    email String
    The email of the cloud identity user.
    identityType String
    The identity type of the cloud identity user.
    joinTime String
    The join time of the cloud identity user.
    phone String
    The phone of the cloud identity user.
    source String
    The source of the cloud identity group.
    userId String
    The id of the cloud identity user.
    userName String
    The name of the cloud identity user.

    Import

    CloudIdentityGroup can be imported using the id, e.g.

    $ pulumi import volcengine:cloud_identity/group:Group default resource_id

    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.
    volcengine logo
    Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
    volcengine/pulumi-volcengine