AWS v6.54.2 published on Wednesday, Oct 2, 2024 by Pulumi
aws.identitystore.getGroups
Explore with Pulumi AI
Data source for managing an AWS SSO Identity Store Groups.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.ssoadmin.getInstances({});
const exampleGetGroups = example.then(example => aws.identitystore.getGroups({
identityStoreId: example.identityStoreIds?.[0],
}));
import pulumi
import pulumi_aws as aws
example = aws.ssoadmin.get_instances()
example_get_groups = aws.identitystore.get_groups(identity_store_id=example.identity_store_ids[0])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/identitystore"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssoadmin"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := ssoadmin.GetInstances(ctx, nil, nil)
if err != nil {
return err
}
_, err = identitystore.GetGroups(ctx, &identitystore.GetGroupsArgs{
IdentityStoreId: example.IdentityStoreIds[0],
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.SsoAdmin.GetInstances.Invoke();
var exampleGetGroups = Aws.IdentityStore.GetGroups.Invoke(new()
{
IdentityStoreId = example.Apply(getInstancesResult => getInstancesResult.IdentityStoreIds[0]),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssoadmin.SsoadminFunctions;
import com.pulumi.aws.identitystore.IdentitystoreFunctions;
import com.pulumi.aws.identitystore.inputs.GetGroupsArgs;
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 example = SsoadminFunctions.getInstances();
final var exampleGetGroups = IdentitystoreFunctions.getGroups(GetGroupsArgs.builder()
.identityStoreId(example.applyValue(getInstancesResult -> getInstancesResult.identityStoreIds()[0]))
.build());
}
}
variables:
example:
fn::invoke:
Function: aws:ssoadmin:getInstances
Arguments: {}
exampleGetGroups:
fn::invoke:
Function: aws:identitystore:getGroups
Arguments:
identityStoreId: ${example.identityStoreIds[0]}
Using getGroups
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 getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOptions): Output<GetGroupsResult>
def get_groups(identity_store_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(identity_store_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]
func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput
> Note: This function is named GetGroups
in the Go SDK.
public static class GetGroups
{
public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:identitystore/getGroups:getGroups
arguments:
# arguments dictionary
The following arguments are supported:
- Identity
Store stringId - Identity Store ID associated with the Single Sign-On (SSO) Instance.
- Identity
Store stringId - Identity Store ID associated with the Single Sign-On (SSO) Instance.
- identity
Store StringId - Identity Store ID associated with the Single Sign-On (SSO) Instance.
- identity
Store stringId - Identity Store ID associated with the Single Sign-On (SSO) Instance.
- identity_
store_ strid - Identity Store ID associated with the Single Sign-On (SSO) Instance.
- identity
Store StringId - Identity Store ID associated with the Single Sign-On (SSO) Instance.
getGroups Result
The following output properties are available:
- Groups
List<Get
Groups Group> - List of Identity Store Groups
- Id string
- The provider-assigned unique ID for this managed resource.
- Identity
Store stringId
- Groups
[]Get
Groups Group - List of Identity Store Groups
- Id string
- The provider-assigned unique ID for this managed resource.
- Identity
Store stringId
- groups
List<Get
Groups Group> - List of Identity Store Groups
- id String
- The provider-assigned unique ID for this managed resource.
- identity
Store StringId
- groups
Get
Groups Group[] - List of Identity Store Groups
- id string
- The provider-assigned unique ID for this managed resource.
- identity
Store stringId
- groups
Sequence[Get
Groups Group] - List of Identity Store Groups
- id str
- The provider-assigned unique ID for this managed resource.
- identity_
store_ strid
- groups List<Property Map>
- List of Identity Store Groups
- id String
- The provider-assigned unique ID for this managed resource.
- identity
Store StringId
Supporting Types
GetGroupsGroup
- Description string
- Description of the specified group.
- Display
Name string - Group's display name.
- External
Ids List<GetGroups Group External Id> - List of identifiers issued to this resource by an external identity provider.
- Group
Id string - Identifier of the group in the Identity Store.
- Identity
Store stringId - Identity Store ID associated with the Single Sign-On (SSO) Instance.
- Description string
- Description of the specified group.
- Display
Name string - Group's display name.
- External
Ids []GetGroups Group External Id - List of identifiers issued to this resource by an external identity provider.
- Group
Id string - Identifier of the group in the Identity Store.
- Identity
Store stringId - Identity Store ID associated with the Single Sign-On (SSO) Instance.
- description String
- Description of the specified group.
- display
Name String - Group's display name.
- external
Ids List<GetGroups Group External Id> - List of identifiers issued to this resource by an external identity provider.
- group
Id String - Identifier of the group in the Identity Store.
- identity
Store StringId - Identity Store ID associated with the Single Sign-On (SSO) Instance.
- description string
- Description of the specified group.
- display
Name string - Group's display name.
- external
Ids GetGroups Group External Id[] - List of identifiers issued to this resource by an external identity provider.
- group
Id string - Identifier of the group in the Identity Store.
- identity
Store stringId - Identity Store ID associated with the Single Sign-On (SSO) Instance.
- description str
- Description of the specified group.
- display_
name str - Group's display name.
- external_
ids Sequence[GetGroups Group External Id] - List of identifiers issued to this resource by an external identity provider.
- group_
id str - Identifier of the group in the Identity Store.
- identity_
store_ strid - Identity Store ID associated with the Single Sign-On (SSO) Instance.
- description String
- Description of the specified group.
- display
Name String - Group's display name.
- external
Ids List<Property Map> - List of identifiers issued to this resource by an external identity provider.
- group
Id String - Identifier of the group in the Identity Store.
- identity
Store StringId - Identity Store ID associated with the Single Sign-On (SSO) Instance.
GetGroupsGroupExternalId
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.