github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/cognito/getUserPoolClients.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  // Use this data source to get a list of Cognito user pools clients for a Cognito IdP user pool.
    15  //
    16  // ## Example Usage
    17  //
    18  // <!--Start PulumiCodeChooser -->
    19  // ```go
    20  // package main
    21  //
    22  // import (
    23  //
    24  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cognito"
    25  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    26  //
    27  // )
    28  //
    29  //	func main() {
    30  //		pulumi.Run(func(ctx *pulumi.Context) error {
    31  //			_, err := cognito.GetUserPoolClients(ctx, &cognito.GetUserPoolClientsArgs{
    32  //				UserPoolId: mainAwsCognitoUserPool.Id,
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  func GetUserPoolClients(ctx *pulumi.Context, args *GetUserPoolClientsArgs, opts ...pulumi.InvokeOption) (*GetUserPoolClientsResult, error) {
    44  	opts = internal.PkgInvokeDefaultOpts(opts)
    45  	var rv GetUserPoolClientsResult
    46  	err := ctx.Invoke("aws:cognito/getUserPoolClients:getUserPoolClients", args, &rv, opts...)
    47  	if err != nil {
    48  		return nil, err
    49  	}
    50  	return &rv, nil
    51  }
    52  
    53  // A collection of arguments for invoking getUserPoolClients.
    54  type GetUserPoolClientsArgs struct {
    55  	// Cognito user pool ID.
    56  	UserPoolId string `pulumi:"userPoolId"`
    57  }
    58  
    59  // A collection of values returned by getUserPoolClients.
    60  type GetUserPoolClientsResult struct {
    61  	// List of Cognito user pool client IDs.
    62  	ClientIds []string `pulumi:"clientIds"`
    63  	// List of Cognito user pool client names.
    64  	ClientNames []string `pulumi:"clientNames"`
    65  	// The provider-assigned unique ID for this managed resource.
    66  	Id         string `pulumi:"id"`
    67  	UserPoolId string `pulumi:"userPoolId"`
    68  }
    69  
    70  func GetUserPoolClientsOutput(ctx *pulumi.Context, args GetUserPoolClientsOutputArgs, opts ...pulumi.InvokeOption) GetUserPoolClientsResultOutput {
    71  	return pulumi.ToOutputWithContext(context.Background(), args).
    72  		ApplyT(func(v interface{}) (GetUserPoolClientsResult, error) {
    73  			args := v.(GetUserPoolClientsArgs)
    74  			r, err := GetUserPoolClients(ctx, &args, opts...)
    75  			var s GetUserPoolClientsResult
    76  			if r != nil {
    77  				s = *r
    78  			}
    79  			return s, err
    80  		}).(GetUserPoolClientsResultOutput)
    81  }
    82  
    83  // A collection of arguments for invoking getUserPoolClients.
    84  type GetUserPoolClientsOutputArgs struct {
    85  	// Cognito user pool ID.
    86  	UserPoolId pulumi.StringInput `pulumi:"userPoolId"`
    87  }
    88  
    89  func (GetUserPoolClientsOutputArgs) ElementType() reflect.Type {
    90  	return reflect.TypeOf((*GetUserPoolClientsArgs)(nil)).Elem()
    91  }
    92  
    93  // A collection of values returned by getUserPoolClients.
    94  type GetUserPoolClientsResultOutput struct{ *pulumi.OutputState }
    95  
    96  func (GetUserPoolClientsResultOutput) ElementType() reflect.Type {
    97  	return reflect.TypeOf((*GetUserPoolClientsResult)(nil)).Elem()
    98  }
    99  
   100  func (o GetUserPoolClientsResultOutput) ToGetUserPoolClientsResultOutput() GetUserPoolClientsResultOutput {
   101  	return o
   102  }
   103  
   104  func (o GetUserPoolClientsResultOutput) ToGetUserPoolClientsResultOutputWithContext(ctx context.Context) GetUserPoolClientsResultOutput {
   105  	return o
   106  }
   107  
   108  // List of Cognito user pool client IDs.
   109  func (o GetUserPoolClientsResultOutput) ClientIds() pulumi.StringArrayOutput {
   110  	return o.ApplyT(func(v GetUserPoolClientsResult) []string { return v.ClientIds }).(pulumi.StringArrayOutput)
   111  }
   112  
   113  // List of Cognito user pool client names.
   114  func (o GetUserPoolClientsResultOutput) ClientNames() pulumi.StringArrayOutput {
   115  	return o.ApplyT(func(v GetUserPoolClientsResult) []string { return v.ClientNames }).(pulumi.StringArrayOutput)
   116  }
   117  
   118  // The provider-assigned unique ID for this managed resource.
   119  func (o GetUserPoolClientsResultOutput) Id() pulumi.StringOutput {
   120  	return o.ApplyT(func(v GetUserPoolClientsResult) string { return v.Id }).(pulumi.StringOutput)
   121  }
   122  
   123  func (o GetUserPoolClientsResultOutput) UserPoolId() pulumi.StringOutput {
   124  	return o.ApplyT(func(v GetUserPoolClientsResult) string { return v.UserPoolId }).(pulumi.StringOutput)
   125  }
   126  
   127  func init() {
   128  	pulumi.RegisterOutputType(GetUserPoolClientsResultOutput{})
   129  }