1. Registry
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. OrganizationUserGroup
Viewing docs for Aiven v6.60.0
published on Wednesday, Sep 23, 2026 by Pulumi
aiven logo aiven logo
Viewing docs for Aiven v6.60.0
published on Wednesday, Sep 23, 2026 by Pulumi

    Creates and manages a user group in an organization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const example = new aiven.OrganizationUserGroup("example", {
        organizationId: "org1a23f456789",
        description: "The group of admins for the organization",
        name: "Admin Users",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    example = aiven.OrganizationUserGroup("example",
        organization_id="org1a23f456789",
        description="The group of admins for the organization",
        name="Admin Users")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aiven.NewOrganizationUserGroup(ctx, "example", &aiven.OrganizationUserGroupArgs{
    			OrganizationId: pulumi.String("org1a23f456789"),
    			Description:    pulumi.String("The group of admins for the organization"),
    			Name:           pulumi.String("Admin Users"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aiven.OrganizationUserGroup("example", new()
        {
            OrganizationId = "org1a23f456789",
            Description = "The group of admins for the organization",
            Name = "Admin Users",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aiven.OrganizationUserGroup;
    import com.pulumi.aiven.OrganizationUserGroupArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = new OrganizationUserGroup("example", OrganizationUserGroupArgs.builder()
                .organizationId("org1a23f456789")
                .description("The group of admins for the organization")
                .name("Admin Users")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aiven:OrganizationUserGroup
        properties:
          organizationId: org1a23f456789
          description: The group of admins for the organization
          name: Admin Users
    
    pulumi {
      required_providers {
        aiven = {
          source = "pulumi/aiven"
        }
      }
    }
    
    resource "aiven_organizationusergroup" "example" {
      organization_id = "org1a23f456789"
      description     = "The group of admins for the organization"
      name            = "Admin Users"
    }
    

    Create OrganizationUserGroup Resource

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

    Constructor syntax

    new OrganizationUserGroup(name: string, args: OrganizationUserGroupArgs, opts?: CustomResourceOptions);
    @overload
    def OrganizationUserGroup(resource_name: str,
                              args: OrganizationUserGroupArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def OrganizationUserGroup(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              description: Optional[str] = None,
                              organization_id: Optional[str] = None,
                              name: Optional[str] = None,
                              timeouts: Optional[OrganizationUserGroupTimeoutsArgs] = None)
    func NewOrganizationUserGroup(ctx *Context, name string, args OrganizationUserGroupArgs, opts ...ResourceOption) (*OrganizationUserGroup, error)
    public OrganizationUserGroup(string name, OrganizationUserGroupArgs args, CustomResourceOptions? opts = null)
    public OrganizationUserGroup(String name, OrganizationUserGroupArgs args)
    public OrganizationUserGroup(String name, OrganizationUserGroupArgs args, CustomResourceOptions options)
    
    type: aiven:OrganizationUserGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aiven_organization_user_group" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args OrganizationUserGroupArgs
    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 OrganizationUserGroupArgs
    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 OrganizationUserGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationUserGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationUserGroupArgs
    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 organizationUserGroupResource = new Aiven.OrganizationUserGroup("organizationUserGroupResource", new()
    {
        Description = "string",
        OrganizationId = "string",
        Name = "string",
        Timeouts = new Aiven.Inputs.OrganizationUserGroupTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Read = "string",
            Update = "string",
        },
    });
    
    example, err := aiven.NewOrganizationUserGroup(ctx, "organizationUserGroupResource", &aiven.OrganizationUserGroupArgs{
    	Description:    pulumi.String("string"),
    	OrganizationId: pulumi.String("string"),
    	Name:           pulumi.String("string"),
    	Timeouts: &aiven.OrganizationUserGroupTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Read:   pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    })
    
    resource "aiven_organization_user_group" "organizationUserGroupResource" {
      lifecycle {
        create_before_destroy = true
      }
      description     = "string"
      organization_id = "string"
      name            = "string"
      timeouts = {
        create = "string"
        delete = "string"
        read   = "string"
        update = "string"
      }
    }
    
    var organizationUserGroupResource = new OrganizationUserGroup("organizationUserGroupResource", OrganizationUserGroupArgs.builder()
        .description("string")
        .organizationId("string")
        .name("string")
        .timeouts(OrganizationUserGroupTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .read("string")
            .update("string")
            .build())
        .build());
    
    organization_user_group_resource = aiven.OrganizationUserGroup("organizationUserGroupResource",
        description="string",
        organization_id="string",
        name="string",
        timeouts={
            "create": "string",
            "delete": "string",
            "read": "string",
            "update": "string",
        })
    
    const organizationUserGroupResource = new aiven.OrganizationUserGroup("organizationUserGroupResource", {
        description: "string",
        organizationId: "string",
        name: "string",
        timeouts: {
            create: "string",
            "delete": "string",
            read: "string",
            update: "string",
        },
    });
    
    type: aiven:OrganizationUserGroup
    properties:
        description: string
        name: string
        organizationId: string
        timeouts:
            create: string
            delete: string
            read: string
            update: string
    

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

    Description string
    Description. Maximum length: 4096.
    OrganizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    Name string
    User Group Name. Maximum length: 128.
    Timeouts OrganizationUserGroupTimeouts
    Description string
    Description. Maximum length: 4096.
    OrganizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    Name string
    User Group Name. Maximum length: 128.
    Timeouts OrganizationUserGroupTimeoutsArgs
    description string
    Description. Maximum length: 4096.
    organization_id string
    ID of an organization. Changing this property forces recreation of the resource.
    name string
    User Group Name. Maximum length: 128.
    timeouts object
    description String
    Description. Maximum length: 4096.
    organizationId String
    ID of an organization. Changing this property forces recreation of the resource.
    name String
    User Group Name. Maximum length: 128.
    timeouts OrganizationUserGroupTimeouts
    description string
    Description. Maximum length: 4096.
    organizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    name string
    User Group Name. Maximum length: 128.
    timeouts OrganizationUserGroupTimeouts
    description str
    Description. Maximum length: 4096.
    organization_id str
    ID of an organization. Changing this property forces recreation of the resource.
    name str
    User Group Name. Maximum length: 128.
    timeouts OrganizationUserGroupTimeoutsArgs
    description String
    Description. Maximum length: 4096.
    organizationId String
    ID of an organization. Changing this property forces recreation of the resource.
    name String
    User Group Name. Maximum length: 128.
    timeouts Property Map

    Outputs

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

    CreateTime string
    User group creation time.
    GroupId string
    ID of the user group.
    Id string
    The provider-assigned unique ID for this managed resource.
    ManagedByScim bool
    Managed By Scim.
    UpdateTime string
    User group last update time.
    CreateTime string
    User group creation time.
    GroupId string
    ID of the user group.
    Id string
    The provider-assigned unique ID for this managed resource.
    ManagedByScim bool
    Managed By Scim.
    UpdateTime string
    User group last update time.
    create_time string
    User group creation time.
    group_id string
    ID of the user group.
    id string
    The provider-assigned unique ID for this managed resource.
    managed_by_scim bool
    Managed By Scim.
    update_time string
    User group last update time.
    createTime String
    User group creation time.
    groupId String
    ID of the user group.
    id String
    The provider-assigned unique ID for this managed resource.
    managedByScim Boolean
    Managed By Scim.
    updateTime String
    User group last update time.
    createTime string
    User group creation time.
    groupId string
    ID of the user group.
    id string
    The provider-assigned unique ID for this managed resource.
    managedByScim boolean
    Managed By Scim.
    updateTime string
    User group last update time.
    create_time str
    User group creation time.
    group_id str
    ID of the user group.
    id str
    The provider-assigned unique ID for this managed resource.
    managed_by_scim bool
    Managed By Scim.
    update_time str
    User group last update time.
    createTime String
    User group creation time.
    groupId String
    ID of the user group.
    id String
    The provider-assigned unique ID for this managed resource.
    managedByScim Boolean
    Managed By Scim.
    updateTime String
    User group last update time.

    Look up Existing OrganizationUserGroup Resource

    Get an existing OrganizationUserGroup 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?: OrganizationUserGroupState, opts?: CustomResourceOptions): OrganizationUserGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            create_time: Optional[str] = None,
            description: Optional[str] = None,
            group_id: Optional[str] = None,
            managed_by_scim: Optional[bool] = None,
            name: Optional[str] = None,
            organization_id: Optional[str] = None,
            timeouts: Optional[OrganizationUserGroupTimeoutsArgs] = None,
            update_time: Optional[str] = None) -> OrganizationUserGroup
    func GetOrganizationUserGroup(ctx *Context, name string, id IDInput, state *OrganizationUserGroupState, opts ...ResourceOption) (*OrganizationUserGroup, error)
    public static OrganizationUserGroup Get(string name, Input<string> id, OrganizationUserGroupState? state, CustomResourceOptions? opts = null)
    public static OrganizationUserGroup get(String name, Output<String> id, OrganizationUserGroupState state, CustomResourceOptions options)
    resources:  _:    type: aiven:OrganizationUserGroup    get:      id: ${id}
    import {
      to = aiven_organization_user_group.example
      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:
    CreateTime string
    User group creation time.
    Description string
    Description. Maximum length: 4096.
    GroupId string
    ID of the user group.
    ManagedByScim bool
    Managed By Scim.
    Name string
    User Group Name. Maximum length: 128.
    OrganizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    Timeouts OrganizationUserGroupTimeouts
    UpdateTime string
    User group last update time.
    CreateTime string
    User group creation time.
    Description string
    Description. Maximum length: 4096.
    GroupId string
    ID of the user group.
    ManagedByScim bool
    Managed By Scim.
    Name string
    User Group Name. Maximum length: 128.
    OrganizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    Timeouts OrganizationUserGroupTimeoutsArgs
    UpdateTime string
    User group last update time.
    create_time string
    User group creation time.
    description string
    Description. Maximum length: 4096.
    group_id string
    ID of the user group.
    managed_by_scim bool
    Managed By Scim.
    name string
    User Group Name. Maximum length: 128.
    organization_id string
    ID of an organization. Changing this property forces recreation of the resource.
    timeouts object
    update_time string
    User group last update time.
    createTime String
    User group creation time.
    description String
    Description. Maximum length: 4096.
    groupId String
    ID of the user group.
    managedByScim Boolean
    Managed By Scim.
    name String
    User Group Name. Maximum length: 128.
    organizationId String
    ID of an organization. Changing this property forces recreation of the resource.
    timeouts OrganizationUserGroupTimeouts
    updateTime String
    User group last update time.
    createTime string
    User group creation time.
    description string
    Description. Maximum length: 4096.
    groupId string
    ID of the user group.
    managedByScim boolean
    Managed By Scim.
    name string
    User Group Name. Maximum length: 128.
    organizationId string
    ID of an organization. Changing this property forces recreation of the resource.
    timeouts OrganizationUserGroupTimeouts
    updateTime string
    User group last update time.
    create_time str
    User group creation time.
    description str
    Description. Maximum length: 4096.
    group_id str
    ID of the user group.
    managed_by_scim bool
    Managed By Scim.
    name str
    User Group Name. Maximum length: 128.
    organization_id str
    ID of an organization. Changing this property forces recreation of the resource.
    timeouts OrganizationUserGroupTimeoutsArgs
    update_time str
    User group last update time.
    createTime String
    User group creation time.
    description String
    Description. Maximum length: 4096.
    groupId String
    ID of the user group.
    managedByScim Boolean
    Managed By Scim.
    name String
    User Group Name. Maximum length: 128.
    organizationId String
    ID of an organization. Changing this property forces recreation of the resource.
    timeouts Property Map
    updateTime String
    User group last update time.

    Supporting Types

    OrganizationUserGroupTimeouts, OrganizationUserGroupTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Default string
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Default string
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    default string
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    default_ String
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    default string
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    default str
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    default String
    Timeout for all operations. Deprecated, use operation-specific timeouts instead.

    Deprecated: Use operation-specific timeouts instead. This field will be removed in the next major version.

    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    $ pulumi import aiven:index/organizationUserGroup:OrganizationUserGroup example ORGANIZATION_ID/GROUP_ID
    

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

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo aiven logo
    Viewing docs for Aiven v6.60.0
    published on Wednesday, Sep 23, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial