Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. Me
  5. IdentityGroup
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
ovh/pulumi-ovh

ovh.Me.IdentityGroup

Explore with Pulumi AI

ovh logo
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
ovh/pulumi-ovh

    Creates an identity group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const myGroup = new ovh.me.IdentityGroup("myGroup", {
    description: "Some custom description",
    role: "NONE",
});

    import pulumi
import pulumi_ovh as ovh

my_group = ovh.me.IdentityGroup("myGroup",
    description="Some custom description",
    role="NONE")

    package main

import (
	"github.com/ovh/pulumi-ovh/sdk/go/ovh/Me"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Me.NewIdentityGroup(ctx, "myGroup", &Me.IdentityGroupArgs{
			Description: pulumi.String("Some custom description"),
			Role:        pulumi.String("NONE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;

return await Deployment.RunAsync(() => 
{
    var myGroup = new Ovh.Me.IdentityGroup("myGroup", new()
    {
        Description = "Some custom description",
        Role = "NONE",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.Me.IdentityGroup;
import com.pulumi.ovh.Me.IdentityGroupArgs;
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 myGroup = new IdentityGroup("myGroup", IdentityGroupArgs.builder()
            .description("Some custom description")
            .role("NONE")
            .build());

    }
}

    resources:
  myGroup:
    type: ovh:Me:IdentityGroup
    properties:
      description: Some custom description
      role: NONE

    Create IdentityGroup Resource

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

    Constructor syntax

    new IdentityGroup(name: string, args?: IdentityGroupArgs, opts?: CustomResourceOptions);
    @overload
def IdentityGroup(resource_name: str,
                  args: Optional[IdentityGroupArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def IdentityGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  role: Optional[str] = None)
    func NewIdentityGroup(ctx *Context, name string, args *IdentityGroupArgs, opts ...ResourceOption) (*IdentityGroup, error)
    public IdentityGroup(string name, IdentityGroupArgs? args = null, CustomResourceOptions? opts = null)
    public IdentityGroup(String name, IdentityGroupArgs args)
public IdentityGroup(String name, IdentityGroupArgs args, CustomResourceOptions options)

    type: ovh:Me:IdentityGroup
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 IdentityGroupArgs
    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 IdentityGroupArgs
    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 IdentityGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityGroupArgs
    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 identityGroupResource = new Ovh.Me.IdentityGroup("identityGroupResource", new()
{
    Description = "string",
    Name = "string",
    Role = "string",
});

    example, err := Me.NewIdentityGroup(ctx, "identityGroupResource", &Me.IdentityGroupArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Role:        pulumi.String("string"),
})

    var identityGroupResource = new IdentityGroup("identityGroupResource", IdentityGroupArgs.builder()
    .description("string")
    .name("string")
    .role("string")
    .build());

    identity_group_resource = ovh.me.IdentityGroup("identityGroupResource",
    description="string",
    name="string",
    role="string")

    const identityGroupResource = new ovh.me.IdentityGroup("identityGroupResource", {
    description: "string",
    name: "string",
    role: "string",
});

    type: ovh:Me:IdentityGroup
properties:
    description: string
    name: string
    role: string

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

    Description string
    Group description.
    Name string
    Group name.
    Role string
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    Description string
    Group description.
    Name string
    Group name.
    Role string
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    description String
    Group description.
    name String
    Group name.
    role String
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    description string
    Group description.
    name string
    Group name.
    role string
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    description str
    Group description.
    name str
    Group name.
    role str
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    description String
    Group description.
    name String
    Group name.
    role String
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.

    Outputs

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

    Creation string
    Creation date of this group.
    DefaultGroup bool
    Is the group a default and immutable one.
    GroupURN string
    URN of the user group, used when writing IAM policies
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdate string
    Date of the last update of this group.
    Creation string
    Creation date of this group.
    DefaultGroup bool
    Is the group a default and immutable one.
    GroupURN string
    URN of the user group, used when writing IAM policies
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdate string
    Date of the last update of this group.
    GroupURN String
    URN of the user group, used when writing IAM policies
    creation String
    Creation date of this group.
    defaultGroup Boolean
    Is the group a default and immutable one.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdate String
    Date of the last update of this group.
    GroupURN string
    URN of the user group, used when writing IAM policies
    creation string
    Creation date of this group.
    defaultGroup boolean
    Is the group a default and immutable one.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdate string
    Date of the last update of this group.
    creation str
    Creation date of this group.
    default_group bool
    Is the group a default and immutable one.
    group_urn str
    URN of the user group, used when writing IAM policies
    id str
    The provider-assigned unique ID for this managed resource.
    last_update str
    Date of the last update of this group.
    GroupURN String
    URN of the user group, used when writing IAM policies
    creation String
    Creation date of this group.
    defaultGroup Boolean
    Is the group a default and immutable one.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdate String
    Date of the last update of this group.

    Look up Existing IdentityGroup Resource

    Get an existing IdentityGroup 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?: IdentityGroupState, opts?: CustomResourceOptions): IdentityGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group_urn: Optional[str] = None,
        creation: Optional[str] = None,
        default_group: Optional[bool] = None,
        description: Optional[str] = None,
        last_update: Optional[str] = None,
        name: Optional[str] = None,
        role: Optional[str] = None) -> IdentityGroup
    func GetIdentityGroup(ctx *Context, name string, id IDInput, state *IdentityGroupState, opts ...ResourceOption) (*IdentityGroup, error)
    public static IdentityGroup Get(string name, Input<string> id, IdentityGroupState? state, CustomResourceOptions? opts = null)
    public static IdentityGroup get(String name, Output<String> id, IdentityGroupState 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:
    Creation string
    Creation date of this group.
    DefaultGroup bool
    Is the group a default and immutable one.
    Description string
    Group description.
    GroupURN string
    URN of the user group, used when writing IAM policies
    LastUpdate string
    Date of the last update of this group.
    Name string
    Group name.
    Role string
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    Creation string
    Creation date of this group.
    DefaultGroup bool
    Is the group a default and immutable one.
    Description string
    Group description.
    GroupURN string
    URN of the user group, used when writing IAM policies
    LastUpdate string
    Date of the last update of this group.
    Name string
    Group name.
    Role string
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    GroupURN String
    URN of the user group, used when writing IAM policies
    creation String
    Creation date of this group.
    defaultGroup Boolean
    Is the group a default and immutable one.
    description String
    Group description.
    lastUpdate String
    Date of the last update of this group.
    name String
    Group name.
    role String
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    GroupURN string
    URN of the user group, used when writing IAM policies
    creation string
    Creation date of this group.
    defaultGroup boolean
    Is the group a default and immutable one.
    description string
    Group description.
    lastUpdate string
    Date of the last update of this group.
    name string
    Group name.
    role string
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    creation str
    Creation date of this group.
    default_group bool
    Is the group a default and immutable one.
    description str
    Group description.
    group_urn str
    URN of the user group, used when writing IAM policies
    last_update str
    Date of the last update of this group.
    name str
    Group name.
    role str
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.
    GroupURN String
    URN of the user group, used when writing IAM policies
    creation String
    Creation date of this group.
    defaultGroup Boolean
    Is the group a default and immutable one.
    description String
    Group description.
    lastUpdate String
    Date of the last update of this group.
    name String
    Group name.
    role String
    Role associated with the group. Valid roles are ADMIN, REGULAR, UNPRIVILEGED, and NONE.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
    ovh/pulumi-ovh