Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. OrganizationUserGroup
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-aiven

aiven.OrganizationUserGroup

Explore with Pulumi AI

aiven logo
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-aiven

    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", {
    description: "Example group of users.",
    organizationId: main.id,
    name: "Example group",
});

    import pulumi
import pulumi_aiven as aiven

example = aiven.OrganizationUserGroup("example",
    description="Example group of users.",
    organization_id=main["id"],
    name="Example group")

    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{
			Description:    pulumi.String("Example group of users."),
			OrganizationId: pulumi.Any(main.Id),
			Name:           pulumi.String("Example group"),
		})
		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()
    {
        Description = "Example group of users.",
        OrganizationId = main.Id,
        Name = "Example group",
    });

});

    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.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 example = new OrganizationUserGroup("example", OrganizationUserGroupArgs.builder()
            .description("Example group of users.")
            .organizationId(main.id())
            .name("Example group")
            .build());

    }
}

    resources:
  example:
    type: aiven:OrganizationUserGroup
    properties:
      description: Example group of users.
      organizationId: ${main.id}
      name: Example group

    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)
    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.

    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",
});

    example, err := aiven.NewOrganizationUserGroup(ctx, "organizationUserGroupResource", &aiven.OrganizationUserGroupArgs{
	Description:    pulumi.String("string"),
	OrganizationId: pulumi.String("string"),
	Name:           pulumi.String("string"),
})

    var organizationUserGroupResource = new OrganizationUserGroup("organizationUserGroupResource", OrganizationUserGroupArgs.builder()
    .description("string")
    .organizationId("string")
    .name("string")
    .build());

    organization_user_group_resource = aiven.OrganizationUserGroup("organizationUserGroupResource",
    description="string",
    organization_id="string",
    name="string")

    const organizationUserGroupResource = new aiven.OrganizationUserGroup("organizationUserGroupResource", {
    description: "string",
    organizationId: "string",
    name: "string",
});

    type: aiven:OrganizationUserGroup
properties:
    description: string
    name: string
    organizationId: 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
    The description of the user group. Changing this property forces recreation of the resource.
    OrganizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    Name string
    The name of the user group. Changing this property forces recreation of the resource.
    Description string
    The description of the user group. Changing this property forces recreation of the resource.
    OrganizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    Name string
    The name of the user group. Changing this property forces recreation of the resource.
    description String
    The description of the user group. Changing this property forces recreation of the resource.
    organizationId String
    The ID of the organization. Changing this property forces recreation of the resource.
    name String
    The name of the user group. Changing this property forces recreation of the resource.
    description string
    The description of the user group. Changing this property forces recreation of the resource.
    organizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    name string
    The name of the user group. Changing this property forces recreation of the resource.
    description str
    The description of the user group. Changing this property forces recreation of the resource.
    organization_id str
    The ID of the organization. Changing this property forces recreation of the resource.
    name str
    The name of the user group. Changing this property forces recreation of the resource.
    description String
    The description of the user group. Changing this property forces recreation of the resource.
    organizationId String
    The ID of the organization. Changing this property forces recreation of the resource.
    name String
    The name of the user group. Changing this property forces recreation of the resource.

    Outputs

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

    CreateTime string
    Time of creation.
    GroupId string
    The ID of the user group.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    Time of last update.
    CreateTime string
    Time of creation.
    GroupId string
    The ID of the user group.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    Time of last update.
    createTime String
    Time of creation.
    groupId String
    The ID of the user group.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    Time of last update.
    createTime string
    Time of creation.
    groupId string
    The ID of the user group.
    id string
    The provider-assigned unique ID for this managed resource.
    updateTime string
    Time of last update.
    create_time str
    Time of creation.
    group_id str
    The ID of the user group.
    id str
    The provider-assigned unique ID for this managed resource.
    update_time str
    Time of last update.
    createTime String
    Time of creation.
    groupId String
    The ID of the user group.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    Time of last update.

    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,
        name: Optional[str] = None,
        organization_id: Optional[str] = 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)
    Resource lookup is not supported in YAML
    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
    Time of creation.
    Description string
    The description of the user group. Changing this property forces recreation of the resource.
    GroupId string
    The ID of the user group.
    Name string
    The name of the user group. Changing this property forces recreation of the resource.
    OrganizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    UpdateTime string
    Time of last update.
    CreateTime string
    Time of creation.
    Description string
    The description of the user group. Changing this property forces recreation of the resource.
    GroupId string
    The ID of the user group.
    Name string
    The name of the user group. Changing this property forces recreation of the resource.
    OrganizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    UpdateTime string
    Time of last update.
    createTime String
    Time of creation.
    description String
    The description of the user group. Changing this property forces recreation of the resource.
    groupId String
    The ID of the user group.
    name String
    The name of the user group. Changing this property forces recreation of the resource.
    organizationId String
    The ID of the organization. Changing this property forces recreation of the resource.
    updateTime String
    Time of last update.
    createTime string
    Time of creation.
    description string
    The description of the user group. Changing this property forces recreation of the resource.
    groupId string
    The ID of the user group.
    name string
    The name of the user group. Changing this property forces recreation of the resource.
    organizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    updateTime string
    Time of last update.
    create_time str
    Time of creation.
    description str
    The description of the user group. Changing this property forces recreation of the resource.
    group_id str
    The ID of the user group.
    name str
    The name of the user group. Changing this property forces recreation of the resource.
    organization_id str
    The ID of the organization. Changing this property forces recreation of the resource.
    update_time str
    Time of last update.
    createTime String
    Time of creation.
    description String
    The description of the user group. Changing this property forces recreation of the resource.
    groupId String
    The ID of the user group.
    name String
    The name of the user group. Changing this property forces recreation of the resource.
    organizationId String
    The ID of the organization. Changing this property forces recreation of the resource.
    updateTime String
    Time of last update.

    Import

    $ pulumi import aiven:index/organizationUserGroup:OrganizationUserGroup example ORGANIZATION_ID/USER_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 v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-aiven