AWS Classic

v5.23.0 published on Monday, Dec 5, 2022 by Pulumi

getGroup

Use this data source to get an Identity Store 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>

def get_group(alternate_identifier: Optional[GetGroupAlternateIdentifier] = None,
              filter: Optional[GetGroupFilter] = None,
              group_id: Optional[str] = None,
              identity_store_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(alternate_identifier: Optional[pulumi.Input[GetGroupAlternateIdentifierArgs]] = None,
              filter: Optional[pulumi.Input[GetGroupFilterArgs]] = None,
              group_id: Optional[pulumi.Input[str]] = None,
              identity_store_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]

func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

> 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)
}

public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:identitystore/getGroup:getGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

IdentityStoreId string

Identity Store ID associated with the Single Sign-On Instance.

AlternateIdentifier GetGroupAlternateIdentifier

A unique identifier for the group that is not the primary identifier. Conflicts with group_id and filter. Detailed below.

Filter GetGroupFilter

Configuration block for filtering by a unique attribute of the group. Detailed below.

Deprecated:

Use the alternate_identifier attribute instead.

GroupId string

The identifier for a group in the Identity Store.

IdentityStoreId string

Identity Store ID associated with the Single Sign-On Instance.

AlternateIdentifier GetGroupAlternateIdentifier

A unique identifier for the group that is not the primary identifier. Conflicts with group_id and filter. Detailed below.

Filter GetGroupFilter

Configuration block for filtering by a unique attribute of the group. Detailed below.

Deprecated:

Use the alternate_identifier attribute instead.

GroupId string

The identifier for a group in the Identity Store.

identityStoreId String

Identity Store ID associated with the Single Sign-On Instance.

alternateIdentifier GetGroupAlternateIdentifier

A unique identifier for the group that is not the primary identifier. Conflicts with group_id and filter. Detailed below.

filter GetGroupFilter

Configuration block for filtering by a unique attribute of the group. Detailed below.

Deprecated:

Use the alternate_identifier attribute instead.

groupId String

The identifier for a group in the Identity Store.

identityStoreId string

Identity Store ID associated with the Single Sign-On Instance.

alternateIdentifier GetGroupAlternateIdentifier

A unique identifier for the group that is not the primary identifier. Conflicts with group_id and filter. Detailed below.

filter GetGroupFilter

Configuration block for filtering by a unique attribute of the group. Detailed below.

Deprecated:

Use the alternate_identifier attribute instead.

groupId string

The identifier for a group in the Identity Store.

identity_store_id str

Identity Store ID associated with the Single Sign-On Instance.

alternate_identifier GetGroupAlternateIdentifier

A unique identifier for the group that is not the primary identifier. Conflicts with group_id and filter. Detailed below.

filter GetGroupFilter

Configuration block for filtering by a unique attribute of the group. Detailed below.

Deprecated:

Use the alternate_identifier attribute instead.

group_id str

The identifier for a group in the Identity Store.

identityStoreId String

Identity Store ID associated with the Single Sign-On Instance.

alternateIdentifier Property Map

A unique identifier for the group that is not the primary identifier. Conflicts with group_id and filter. Detailed below.

filter Property Map

Configuration block for filtering by a unique attribute of the group. Detailed below.

Deprecated:

Use the alternate_identifier attribute instead.

groupId String

The identifier for a group in the Identity Store.

getGroup Result

The following output properties are available:

Description string

Description of the specified group.

DisplayName string

Group's display name value.

ExternalIds List<GetGroupExternalId>

List of identifiers issued to this resource by an external identity provider.

GroupId string

Id string

The provider-assigned unique ID for this managed resource.

IdentityStoreId string

AlternateIdentifier GetGroupAlternateIdentifier

Filter GetGroupFilter

Deprecated:

Use the alternate_identifier attribute instead.

Description string

Description of the specified group.

DisplayName string

Group's display name value.

ExternalIds []GetGroupExternalId

List of identifiers issued to this resource by an external identity provider.

GroupId string

Id string

The provider-assigned unique ID for this managed resource.

IdentityStoreId string

AlternateIdentifier GetGroupAlternateIdentifier

Filter GetGroupFilter

Deprecated:

Use the alternate_identifier attribute instead.

description String

Description of the specified group.

displayName String

Group's display name value.

externalIds List<GetGroupExternalId>

List of identifiers issued to this resource by an external identity provider.

groupId String

id String

The provider-assigned unique ID for this managed resource.

identityStoreId String

alternateIdentifier GetGroupAlternateIdentifier

filter GetGroupFilter

Deprecated:

Use the alternate_identifier attribute instead.

description string

Description of the specified group.

displayName string

Group's display name value.

externalIds GetGroupExternalId[]

List of identifiers issued to this resource by an external identity provider.

groupId string

id string

The provider-assigned unique ID for this managed resource.

identityStoreId string

alternateIdentifier GetGroupAlternateIdentifier

filter GetGroupFilter

Deprecated:

Use the alternate_identifier attribute instead.

description str

Description of the specified group.

display_name str

Group's display name value.

external_ids Sequence[GetGroupExternalId]

List of identifiers issued to this resource by an external identity provider.

group_id str

id str

The provider-assigned unique ID for this managed resource.

identity_store_id str

alternate_identifier GetGroupAlternateIdentifier

filter GetGroupFilter

Deprecated:

Use the alternate_identifier attribute instead.

description String

Description of the specified group.

displayName String

Group's display name value.

externalIds List<Property Map>

List of identifiers issued to this resource by an external identity provider.

groupId String

id String

The provider-assigned unique ID for this managed resource.

identityStoreId String

alternateIdentifier Property Map

filter Property Map

Deprecated:

Use the alternate_identifier attribute instead.

Supporting Types

GetGroupAlternateIdentifier

ExternalId GetGroupAlternateIdentifierExternalId: Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
UniqueAttribute GetGroupAlternateIdentifierUniqueAttribute: An entity attribute that's unique to a specific entity. Detailed below.

ExternalId GetGroupAlternateIdentifierExternalId: Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
UniqueAttribute GetGroupAlternateIdentifierUniqueAttribute: An entity attribute that's unique to a specific entity. Detailed below.

externalId GetGroupAlternateIdentifierExternalId: Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
uniqueAttribute GetGroupAlternateIdentifierUniqueAttribute: An entity attribute that's unique to a specific entity. Detailed below.

externalId GetGroupAlternateIdentifierExternalId: Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
uniqueAttribute GetGroupAlternateIdentifierUniqueAttribute: An entity attribute that's unique to a specific entity. Detailed below.

external_id GetGroupAlternateIdentifierExternalId: Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
unique_attribute GetGroupAlternateIdentifierUniqueAttribute: An entity attribute that's unique to a specific entity. Detailed below.

externalId Property Map: Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
uniqueAttribute Property Map: An entity attribute that's unique to a specific entity. Detailed below.

GetGroupAlternateIdentifierExternalId

Id string: The identifier issued to this resource by an external identity provider.
Issuer string: The issuer for an external identifier.

Id string: The identifier issued to this resource by an external identity provider.
Issuer string: The issuer for an external identifier.

id String: The identifier issued to this resource by an external identity provider.
issuer String: The issuer for an external identifier.

id string: The identifier issued to this resource by an external identity provider.
issuer string: The issuer for an external identifier.

id str: The identifier issued to this resource by an external identity provider.
issuer str: The issuer for an external identifier.

id String: The identifier issued to this resource by an external identity provider.
issuer String: The issuer for an external identifier.

GetGroupAlternateIdentifierUniqueAttribute

AttributePath string: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
AttributeValue string: Value for an attribute.

AttributePath string: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
AttributeValue string: Value for an attribute.

attributePath String: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
attributeValue String: Value for an attribute.

attributePath string: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
attributeValue string: Value for an attribute.

attribute_path str: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
attribute_value str: Value for an attribute.

attributePath String: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
attributeValue String: Value for an attribute.

GetGroupExternalId

Id string: The identifier issued to this resource by an external identity provider.
Issuer string: The issuer for an external identifier.

Id string: The identifier issued to this resource by an external identity provider.
Issuer string: The issuer for an external identifier.

id String: The identifier issued to this resource by an external identity provider.
issuer String: The issuer for an external identifier.

id string: The identifier issued to this resource by an external identity provider.
issuer string: The issuer for an external identifier.

id str: The identifier issued to this resource by an external identity provider.
issuer str: The issuer for an external identifier.

id String: The identifier issued to this resource by an external identity provider.
issuer String: The issuer for an external identifier.

GetGroupFilter

AttributePath string: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
AttributeValue string: Value for an attribute.

AttributePath string: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
AttributeValue string: Value for an attribute.

attributePath String: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
attributeValue String: Value for an attribute.

attributePath string: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
attributeValue string: Value for an attribute.

attribute_path str: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
attribute_value str: Value for an attribute.

attributePath String: Attribute path that is used to specify which attribute name to search. For example: DisplayName. Refer to the Group data type.
attributeValue String: Value for an attribute.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS Classic

getGroup

Using getGroup

getGroup Result

Supporting Types

GetGroupAlternateIdentifier

GetGroupAlternateIdentifierExternalId

GetGroupAlternateIdentifierUniqueAttribute

GetGroupExternalId

GetGroupFilter

Package Details

Contents