1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. getIdentityGroup
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

flexibleengine.getIdentityGroup

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

    Use this data source to get details of the specified IAM user group.

    You must have IAM read privileges to use this data source.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as flexibleengine from "@pulumi/flexibleengine";
    
    const group = flexibleengine.getIdentityGroup({
        name: "my_group",
    });
    
    import pulumi
    import pulumi_flexibleengine as flexibleengine
    
    group = flexibleengine.get_identity_group(name="my_group")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := flexibleengine.GetIdentityGroup(ctx, &flexibleengine.GetIdentityGroupArgs{
    			Name: pulumi.StringRef("my_group"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Flexibleengine = Pulumi.Flexibleengine;
    
    return await Deployment.RunAsync(() => 
    {
        var @group = Flexibleengine.GetIdentityGroup.Invoke(new()
        {
            Name = "my_group",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.flexibleengine.FlexibleengineFunctions;
    import com.pulumi.flexibleengine.inputs.GetIdentityGroupArgs;
    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) {
            final var group = FlexibleengineFunctions.getIdentityGroup(GetIdentityGroupArgs.builder()
                .name("my_group")
                .build());
    
        }
    }
    
    variables:
      group:
        fn::invoke:
          function: flexibleengine:getIdentityGroup
          arguments:
            name: my_group
    

    Using getIdentityGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIdentityGroup(args: GetIdentityGroupArgs, opts?: InvokeOptions): Promise<GetIdentityGroupResult>
    function getIdentityGroupOutput(args: GetIdentityGroupOutputArgs, opts?: InvokeOptions): Output<GetIdentityGroupResult>
    def get_identity_group(description: Optional[str] = None,
                           id: Optional[str] = None,
                           name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetIdentityGroupResult
    def get_identity_group_output(description: Optional[pulumi.Input[str]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetIdentityGroupResult]
    func GetIdentityGroup(ctx *Context, args *GetIdentityGroupArgs, opts ...InvokeOption) (*GetIdentityGroupResult, error)
    func GetIdentityGroupOutput(ctx *Context, args *GetIdentityGroupOutputArgs, opts ...InvokeOption) GetIdentityGroupResultOutput

    > Note: This function is named GetIdentityGroup in the Go SDK.

    public static class GetIdentityGroup 
    {
        public static Task<GetIdentityGroupResult> InvokeAsync(GetIdentityGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetIdentityGroupResult> Invoke(GetIdentityGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIdentityGroupResult> getIdentityGroup(GetIdentityGroupArgs args, InvokeOptions options)
    public static Output<GetIdentityGroupResult> getIdentityGroup(GetIdentityGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: flexibleengine:index/getIdentityGroup:getIdentityGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Description string
    Specifies the description of the identity group.
    Id string
    Specifies the ID of the identity group.
    Name string
    Specifies the name of the identity group.
    Description string
    Specifies the description of the identity group.
    Id string
    Specifies the ID of the identity group.
    Name string
    Specifies the name of the identity group.
    description String
    Specifies the description of the identity group.
    id String
    Specifies the ID of the identity group.
    name String
    Specifies the name of the identity group.
    description string
    Specifies the description of the identity group.
    id string
    Specifies the ID of the identity group.
    name string
    Specifies the name of the identity group.
    description str
    Specifies the description of the identity group.
    id str
    Specifies the ID of the identity group.
    name str
    Specifies the name of the identity group.
    description String
    Specifies the description of the identity group.
    id String
    Specifies the ID of the identity group.
    name String
    Specifies the name of the identity group.

    getIdentityGroup Result

    The following output properties are available:

    Description string
    Indicates the description of the IAM user.
    DomainId string
    Indicates the domain the group belongs to.
    Id string
    Indicates the ID of the User.
    Name string
    Indicates the IAM user name.
    Users List<GetIdentityGroupUser>
    Indicates the users the group contains. Structure is documented below.
    Description string
    Indicates the description of the IAM user.
    DomainId string
    Indicates the domain the group belongs to.
    Id string
    Indicates the ID of the User.
    Name string
    Indicates the IAM user name.
    Users []GetIdentityGroupUser
    Indicates the users the group contains. Structure is documented below.
    description String
    Indicates the description of the IAM user.
    domainId String
    Indicates the domain the group belongs to.
    id String
    Indicates the ID of the User.
    name String
    Indicates the IAM user name.
    users List<GetIdentityGroupUser>
    Indicates the users the group contains. Structure is documented below.
    description string
    Indicates the description of the IAM user.
    domainId string
    Indicates the domain the group belongs to.
    id string
    Indicates the ID of the User.
    name string
    Indicates the IAM user name.
    users GetIdentityGroupUser[]
    Indicates the users the group contains. Structure is documented below.
    description str
    Indicates the description of the IAM user.
    domain_id str
    Indicates the domain the group belongs to.
    id str
    Indicates the ID of the User.
    name str
    Indicates the IAM user name.
    users Sequence[GetIdentityGroupUser]
    Indicates the users the group contains. Structure is documented below.
    description String
    Indicates the description of the IAM user.
    domainId String
    Indicates the domain the group belongs to.
    id String
    Indicates the ID of the User.
    name String
    Indicates the IAM user name.
    users List<Property Map>
    Indicates the users the group contains. Structure is documented below.

    Supporting Types

    GetIdentityGroupUser

    Description string
    Specifies the description of the identity group.
    Enabled bool
    Indicates the whether the IAM user is enabled.
    Id string
    Specifies the ID of the identity group.
    Name string
    Specifies the name of the identity group.
    PasswordExpiresAt string
    Indicates the time when the password will expire. Null indicates that the password has unlimited validity.
    PasswordStatus bool
    Indicates the password status. True means that the password needs to be changed, and false means that the password is normal.
    PasswordStrength string
    Indicates the password strength. The value can be high, mid, or low.
    Description string
    Specifies the description of the identity group.
    Enabled bool
    Indicates the whether the IAM user is enabled.
    Id string
    Specifies the ID of the identity group.
    Name string
    Specifies the name of the identity group.
    PasswordExpiresAt string
    Indicates the time when the password will expire. Null indicates that the password has unlimited validity.
    PasswordStatus bool
    Indicates the password status. True means that the password needs to be changed, and false means that the password is normal.
    PasswordStrength string
    Indicates the password strength. The value can be high, mid, or low.
    description String
    Specifies the description of the identity group.
    enabled Boolean
    Indicates the whether the IAM user is enabled.
    id String
    Specifies the ID of the identity group.
    name String
    Specifies the name of the identity group.
    passwordExpiresAt String
    Indicates the time when the password will expire. Null indicates that the password has unlimited validity.
    passwordStatus Boolean
    Indicates the password status. True means that the password needs to be changed, and false means that the password is normal.
    passwordStrength String
    Indicates the password strength. The value can be high, mid, or low.
    description string
    Specifies the description of the identity group.
    enabled boolean
    Indicates the whether the IAM user is enabled.
    id string
    Specifies the ID of the identity group.
    name string
    Specifies the name of the identity group.
    passwordExpiresAt string
    Indicates the time when the password will expire. Null indicates that the password has unlimited validity.
    passwordStatus boolean
    Indicates the password status. True means that the password needs to be changed, and false means that the password is normal.
    passwordStrength string
    Indicates the password strength. The value can be high, mid, or low.
    description str
    Specifies the description of the identity group.
    enabled bool
    Indicates the whether the IAM user is enabled.
    id str
    Specifies the ID of the identity group.
    name str
    Specifies the name of the identity group.
    password_expires_at str
    Indicates the time when the password will expire. Null indicates that the password has unlimited validity.
    password_status bool
    Indicates the password status. True means that the password needs to be changed, and false means that the password is normal.
    password_strength str
    Indicates the password strength. The value can be high, mid, or low.
    description String
    Specifies the description of the identity group.
    enabled Boolean
    Indicates the whether the IAM user is enabled.
    id String
    Specifies the ID of the identity group.
    name String
    Specifies the name of the identity group.
    passwordExpiresAt String
    Indicates the time when the password will expire. Null indicates that the password has unlimited validity.
    passwordStatus Boolean
    Indicates the password status. True means that the password needs to be changed, and false means that the password is normal.
    passwordStrength String
    Indicates the password strength. The value can be high, mid, or low.

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud