Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. identitystore
  5. getGroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.identitystore.getGroup

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::IdentityStore::Group

Using getGroup

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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
Copy
def get_group(group_id: Optional[str] = None,
              identity_store_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(group_id: Optional[pulumi.Input[str]] = None,
              identity_store_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
Copy
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput
Copy

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

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:identitystore:getGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GroupId This property is required. string
The unique identifier for a group in the identity store.
IdentityStoreId This property is required. string
The globally unique identifier for the identity store.
GroupId This property is required. string
The unique identifier for a group in the identity store.
IdentityStoreId This property is required. string
The globally unique identifier for the identity store.
groupId This property is required. String
The unique identifier for a group in the identity store.
identityStoreId This property is required. String
The globally unique identifier for the identity store.
groupId This property is required. string
The unique identifier for a group in the identity store.
identityStoreId This property is required. string
The globally unique identifier for the identity store.
group_id This property is required. str
The unique identifier for a group in the identity store.
identity_store_id This property is required. str
The globally unique identifier for the identity store.
groupId This property is required. String
The unique identifier for a group in the identity store.
identityStoreId This property is required. String
The globally unique identifier for the identity store.

getGroup Result

The following output properties are available:

Description string
A string containing the description of the group.
DisplayName string
A string containing the name of the group. This value is commonly displayed when the group is referenced.
GroupId string
The unique identifier for a group in the identity store.
Description string
A string containing the description of the group.
DisplayName string
A string containing the name of the group. This value is commonly displayed when the group is referenced.
GroupId string
The unique identifier for a group in the identity store.
description String
A string containing the description of the group.
displayName String
A string containing the name of the group. This value is commonly displayed when the group is referenced.
groupId String
The unique identifier for a group in the identity store.
description string
A string containing the description of the group.
displayName string
A string containing the name of the group. This value is commonly displayed when the group is referenced.
groupId string
The unique identifier for a group in the identity store.
description str
A string containing the description of the group.
display_name str
A string containing the name of the group. This value is commonly displayed when the group is referenced.
group_id str
The unique identifier for a group in the identity store.
description String
A string containing the description of the group.
displayName String
A string containing the name of the group. This value is commonly displayed when the group is referenced.
groupId String
The unique identifier for a group in the identity store.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native