github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/cognito/getUserGroup.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package cognito
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // Data source for managing an AWS Cognito IDP (Identity Provider) User Group.
    15  //
    16  // ## Example Usage
    17  //
    18  // ### Basic Usage
    19  //
    20  // <!--Start PulumiCodeChooser -->
    21  // ```go
    22  // package main
    23  //
    24  // import (
    25  //
    26  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cognito"
    27  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    28  //
    29  // )
    30  //
    31  //	func main() {
    32  //		pulumi.Run(func(ctx *pulumi.Context) error {
    33  //			_, err := cognito.LookupUserGroup(ctx, &cognito.LookupUserGroupArgs{
    34  //				UserPoolId: "us-west-2_aaaaaaaaa",
    35  //				Name:       "example",
    36  //			}, nil)
    37  //			if err != nil {
    38  //				return err
    39  //			}
    40  //			return nil
    41  //		})
    42  //	}
    43  //
    44  // ```
    45  // <!--End PulumiCodeChooser -->
    46  func LookupUserGroup(ctx *pulumi.Context, args *LookupUserGroupArgs, opts ...pulumi.InvokeOption) (*LookupUserGroupResult, error) {
    47  	opts = internal.PkgInvokeDefaultOpts(opts)
    48  	var rv LookupUserGroupResult
    49  	err := ctx.Invoke("aws:cognito/getUserGroup:getUserGroup", args, &rv, opts...)
    50  	if err != nil {
    51  		return nil, err
    52  	}
    53  	return &rv, nil
    54  }
    55  
    56  // A collection of arguments for invoking getUserGroup.
    57  type LookupUserGroupArgs struct {
    58  	// Name of the user group.
    59  	Name string `pulumi:"name"`
    60  	// User pool the client belongs to.
    61  	UserPoolId string `pulumi:"userPoolId"`
    62  }
    63  
    64  // A collection of values returned by getUserGroup.
    65  type LookupUserGroupResult struct {
    66  	// Description of the user group.
    67  	Description string `pulumi:"description"`
    68  	// A comma-delimited string concatenating `name` and `userPoolId`.
    69  	Id   string `pulumi:"id"`
    70  	Name string `pulumi:"name"`
    71  	// Precedence of the user group.
    72  	Precedence int `pulumi:"precedence"`
    73  	// ARN of the IAM role to be associated with the user group.
    74  	RoleArn    string `pulumi:"roleArn"`
    75  	UserPoolId string `pulumi:"userPoolId"`
    76  }
    77  
    78  func LookupUserGroupOutput(ctx *pulumi.Context, args LookupUserGroupOutputArgs, opts ...pulumi.InvokeOption) LookupUserGroupResultOutput {
    79  	return pulumi.ToOutputWithContext(context.Background(), args).
    80  		ApplyT(func(v interface{}) (LookupUserGroupResult, error) {
    81  			args := v.(LookupUserGroupArgs)
    82  			r, err := LookupUserGroup(ctx, &args, opts...)
    83  			var s LookupUserGroupResult
    84  			if r != nil {
    85  				s = *r
    86  			}
    87  			return s, err
    88  		}).(LookupUserGroupResultOutput)
    89  }
    90  
    91  // A collection of arguments for invoking getUserGroup.
    92  type LookupUserGroupOutputArgs struct {
    93  	// Name of the user group.
    94  	Name pulumi.StringInput `pulumi:"name"`
    95  	// User pool the client belongs to.
    96  	UserPoolId pulumi.StringInput `pulumi:"userPoolId"`
    97  }
    98  
    99  func (LookupUserGroupOutputArgs) ElementType() reflect.Type {
   100  	return reflect.TypeOf((*LookupUserGroupArgs)(nil)).Elem()
   101  }
   102  
   103  // A collection of values returned by getUserGroup.
   104  type LookupUserGroupResultOutput struct{ *pulumi.OutputState }
   105  
   106  func (LookupUserGroupResultOutput) ElementType() reflect.Type {
   107  	return reflect.TypeOf((*LookupUserGroupResult)(nil)).Elem()
   108  }
   109  
   110  func (o LookupUserGroupResultOutput) ToLookupUserGroupResultOutput() LookupUserGroupResultOutput {
   111  	return o
   112  }
   113  
   114  func (o LookupUserGroupResultOutput) ToLookupUserGroupResultOutputWithContext(ctx context.Context) LookupUserGroupResultOutput {
   115  	return o
   116  }
   117  
   118  // Description of the user group.
   119  func (o LookupUserGroupResultOutput) Description() pulumi.StringOutput {
   120  	return o.ApplyT(func(v LookupUserGroupResult) string { return v.Description }).(pulumi.StringOutput)
   121  }
   122  
   123  // A comma-delimited string concatenating `name` and `userPoolId`.
   124  func (o LookupUserGroupResultOutput) Id() pulumi.StringOutput {
   125  	return o.ApplyT(func(v LookupUserGroupResult) string { return v.Id }).(pulumi.StringOutput)
   126  }
   127  
   128  func (o LookupUserGroupResultOutput) Name() pulumi.StringOutput {
   129  	return o.ApplyT(func(v LookupUserGroupResult) string { return v.Name }).(pulumi.StringOutput)
   130  }
   131  
   132  // Precedence of the user group.
   133  func (o LookupUserGroupResultOutput) Precedence() pulumi.IntOutput {
   134  	return o.ApplyT(func(v LookupUserGroupResult) int { return v.Precedence }).(pulumi.IntOutput)
   135  }
   136  
   137  // ARN of the IAM role to be associated with the user group.
   138  func (o LookupUserGroupResultOutput) RoleArn() pulumi.StringOutput {
   139  	return o.ApplyT(func(v LookupUserGroupResult) string { return v.RoleArn }).(pulumi.StringOutput)
   140  }
   141  
   142  func (o LookupUserGroupResultOutput) UserPoolId() pulumi.StringOutput {
   143  	return o.ApplyT(func(v LookupUserGroupResult) string { return v.UserPoolId }).(pulumi.StringOutput)
   144  }
   145  
   146  func init() {
   147  	pulumi.RegisterOutputType(LookupUserGroupResultOutput{})
   148  }