github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/identitystore/getGroup.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 identitystore
     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 an Identity Store Group.
    15  func LookupGroup(ctx *pulumi.Context, args *LookupGroupArgs, opts ...pulumi.InvokeOption) (*LookupGroupResult, error) {
    16  	opts = internal.PkgInvokeDefaultOpts(opts)
    17  	var rv LookupGroupResult
    18  	err := ctx.Invoke("aws:identitystore/getGroup:getGroup", args, &rv, opts...)
    19  	if err != nil {
    20  		return nil, err
    21  	}
    22  	return &rv, nil
    23  }
    24  
    25  // A collection of arguments for invoking getGroup.
    26  type LookupGroupArgs struct {
    27  	// A unique identifier for the group that is not the primary identifier. Conflicts with `groupId` and `filter`. Detailed below.
    28  	AlternateIdentifier *GetGroupAlternateIdentifier `pulumi:"alternateIdentifier"`
    29  	// Configuration block for filtering by a unique attribute of the group. Detailed below.
    30  	//
    31  	// Deprecated: Use the alternateIdentifier attribute instead.
    32  	Filter *GetGroupFilter `pulumi:"filter"`
    33  	// The identifier for a group in the Identity Store.
    34  	//
    35  	// > Exactly one of the above arguments must be provided. Passing both `filter` and `groupId` is allowed for backwards compatibility.
    36  	GroupId *string `pulumi:"groupId"`
    37  	// Identity Store ID associated with the Single Sign-On Instance.
    38  	//
    39  	// The following arguments are optional:
    40  	IdentityStoreId string `pulumi:"identityStoreId"`
    41  }
    42  
    43  // A collection of values returned by getGroup.
    44  type LookupGroupResult struct {
    45  	AlternateIdentifier *GetGroupAlternateIdentifier `pulumi:"alternateIdentifier"`
    46  	// Description of the specified group.
    47  	Description string `pulumi:"description"`
    48  	// Group's display name value.
    49  	DisplayName string `pulumi:"displayName"`
    50  	// List of identifiers issued to this resource by an external identity provider.
    51  	ExternalIds []GetGroupExternalId `pulumi:"externalIds"`
    52  	// Deprecated: Use the alternateIdentifier attribute instead.
    53  	Filter  *GetGroupFilter `pulumi:"filter"`
    54  	GroupId string          `pulumi:"groupId"`
    55  	// The provider-assigned unique ID for this managed resource.
    56  	Id              string `pulumi:"id"`
    57  	IdentityStoreId string `pulumi:"identityStoreId"`
    58  }
    59  
    60  func LookupGroupOutput(ctx *pulumi.Context, args LookupGroupOutputArgs, opts ...pulumi.InvokeOption) LookupGroupResultOutput {
    61  	return pulumi.ToOutputWithContext(context.Background(), args).
    62  		ApplyT(func(v interface{}) (LookupGroupResult, error) {
    63  			args := v.(LookupGroupArgs)
    64  			r, err := LookupGroup(ctx, &args, opts...)
    65  			var s LookupGroupResult
    66  			if r != nil {
    67  				s = *r
    68  			}
    69  			return s, err
    70  		}).(LookupGroupResultOutput)
    71  }
    72  
    73  // A collection of arguments for invoking getGroup.
    74  type LookupGroupOutputArgs struct {
    75  	// A unique identifier for the group that is not the primary identifier. Conflicts with `groupId` and `filter`. Detailed below.
    76  	AlternateIdentifier GetGroupAlternateIdentifierPtrInput `pulumi:"alternateIdentifier"`
    77  	// Configuration block for filtering by a unique attribute of the group. Detailed below.
    78  	//
    79  	// Deprecated: Use the alternateIdentifier attribute instead.
    80  	Filter GetGroupFilterPtrInput `pulumi:"filter"`
    81  	// The identifier for a group in the Identity Store.
    82  	//
    83  	// > Exactly one of the above arguments must be provided. Passing both `filter` and `groupId` is allowed for backwards compatibility.
    84  	GroupId pulumi.StringPtrInput `pulumi:"groupId"`
    85  	// Identity Store ID associated with the Single Sign-On Instance.
    86  	//
    87  	// The following arguments are optional:
    88  	IdentityStoreId pulumi.StringInput `pulumi:"identityStoreId"`
    89  }
    90  
    91  func (LookupGroupOutputArgs) ElementType() reflect.Type {
    92  	return reflect.TypeOf((*LookupGroupArgs)(nil)).Elem()
    93  }
    94  
    95  // A collection of values returned by getGroup.
    96  type LookupGroupResultOutput struct{ *pulumi.OutputState }
    97  
    98  func (LookupGroupResultOutput) ElementType() reflect.Type {
    99  	return reflect.TypeOf((*LookupGroupResult)(nil)).Elem()
   100  }
   101  
   102  func (o LookupGroupResultOutput) ToLookupGroupResultOutput() LookupGroupResultOutput {
   103  	return o
   104  }
   105  
   106  func (o LookupGroupResultOutput) ToLookupGroupResultOutputWithContext(ctx context.Context) LookupGroupResultOutput {
   107  	return o
   108  }
   109  
   110  func (o LookupGroupResultOutput) AlternateIdentifier() GetGroupAlternateIdentifierPtrOutput {
   111  	return o.ApplyT(func(v LookupGroupResult) *GetGroupAlternateIdentifier { return v.AlternateIdentifier }).(GetGroupAlternateIdentifierPtrOutput)
   112  }
   113  
   114  // Description of the specified group.
   115  func (o LookupGroupResultOutput) Description() pulumi.StringOutput {
   116  	return o.ApplyT(func(v LookupGroupResult) string { return v.Description }).(pulumi.StringOutput)
   117  }
   118  
   119  // Group's display name value.
   120  func (o LookupGroupResultOutput) DisplayName() pulumi.StringOutput {
   121  	return o.ApplyT(func(v LookupGroupResult) string { return v.DisplayName }).(pulumi.StringOutput)
   122  }
   123  
   124  // List of identifiers issued to this resource by an external identity provider.
   125  func (o LookupGroupResultOutput) ExternalIds() GetGroupExternalIdArrayOutput {
   126  	return o.ApplyT(func(v LookupGroupResult) []GetGroupExternalId { return v.ExternalIds }).(GetGroupExternalIdArrayOutput)
   127  }
   128  
   129  // Deprecated: Use the alternateIdentifier attribute instead.
   130  func (o LookupGroupResultOutput) Filter() GetGroupFilterPtrOutput {
   131  	return o.ApplyT(func(v LookupGroupResult) *GetGroupFilter { return v.Filter }).(GetGroupFilterPtrOutput)
   132  }
   133  
   134  func (o LookupGroupResultOutput) GroupId() pulumi.StringOutput {
   135  	return o.ApplyT(func(v LookupGroupResult) string { return v.GroupId }).(pulumi.StringOutput)
   136  }
   137  
   138  // The provider-assigned unique ID for this managed resource.
   139  func (o LookupGroupResultOutput) Id() pulumi.StringOutput {
   140  	return o.ApplyT(func(v LookupGroupResult) string { return v.Id }).(pulumi.StringOutput)
   141  }
   142  
   143  func (o LookupGroupResultOutput) IdentityStoreId() pulumi.StringOutput {
   144  	return o.ApplyT(func(v LookupGroupResult) string { return v.IdentityStoreId }).(pulumi.StringOutput)
   145  }
   146  
   147  func init() {
   148  	pulumi.RegisterOutputType(LookupGroupResultOutput{})
   149  }