← All packages

AWS Classic

Pulumi Official

Package maintained by Pulumi

v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

Source code

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(filters: Optional[Sequence[GetGroupFilter]] = None,
              group_id: Optional[str] = None,
              identity_store_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(filters: Optional[pulumi.Input[Sequence[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 GetGroup(ctx *Context, args *GetGroupArgs, opts ...InvokeOption) (*GetGroupResult, error)
func GetGroupOutput(ctx *Context, args *GetGroupOutputArgs, opts ...InvokeOption) GetGroupResultOutput

> Note: This function is named GetGroup 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:

Filters List<GetGroupFilter>: Configuration block(s) for filtering. Currently, the AWS Identity Store API supports only 1 filter. Detailed below.
IdentityStoreId string: The Identity Store ID associated with the Single Sign-On Instance.
GroupId string: The identifier for a group in the Identity Store.

Filters []GetGroupFilter: Configuration block(s) for filtering. Currently, the AWS Identity Store API supports only 1 filter. Detailed below.
IdentityStoreId string: The Identity Store ID associated with the Single Sign-On Instance.
GroupId string: The identifier for a group in the Identity Store.

filters List<GetGroupFilter>: Configuration block(s) for filtering. Currently, the AWS Identity Store API supports only 1 filter. Detailed below.
identityStoreId String: The Identity Store ID associated with the Single Sign-On Instance.
groupId String: The identifier for a group in the Identity Store.

filters GetGroupFilter[]: Configuration block(s) for filtering. Currently, the AWS Identity Store API supports only 1 filter. Detailed below.
identityStoreId string: The Identity Store ID associated with the Single Sign-On Instance.
groupId string: The identifier for a group in the Identity Store.

filters Sequence[GetGroupFilter]: Configuration block(s) for filtering. Currently, the AWS Identity Store API supports only 1 filter. Detailed below.
identity_store_id str: The Identity Store ID associated with the Single Sign-On Instance.
group_id str: The identifier for a group in the Identity Store.

filters List<Property Map>: Configuration block(s) for filtering. Currently, the AWS Identity Store API supports only 1 filter. Detailed below.
identityStoreId String: The Identity Store ID associated with the Single Sign-On Instance.
groupId String: The identifier for a group in the Identity Store.

getGroup Result

The following output properties are available:

DisplayName string: The group's display name value.
Filters List<GetGroupFilter>
GroupId string
Id string: The provider-assigned unique ID for this managed resource.
IdentityStoreId string

DisplayName string: The group's display name value.
Filters []GetGroupFilter
GroupId string
Id string: The provider-assigned unique ID for this managed resource.
IdentityStoreId string

displayName String: The group's display name value.
filters List<GetGroupFilter>
groupId String
id String: The provider-assigned unique ID for this managed resource.
identityStoreId String

displayName string: The group's display name value.
filters GetGroupFilter[]
groupId string
id string: The provider-assigned unique ID for this managed resource.
identityStoreId string

display_name str: The group's display name value.
filters Sequence[GetGroupFilter]
group_id str
id str: The provider-assigned unique ID for this managed resource.
identity_store_id str

displayName String: The group's display name value.
filters List<Property Map>
groupId String
id String: The provider-assigned unique ID for this managed resource.
identityStoreId String

Supporting Types

GetGroupFilter

AttributePath string: The attribute path that is used to specify which attribute name to search. Currently, DisplayName is the only valid attribute path.
AttributeValue string: The value for an attribute.

AttributePath string: The attribute path that is used to specify which attribute name to search. Currently, DisplayName is the only valid attribute path.
AttributeValue string: The value for an attribute.

attributePath String: The attribute path that is used to specify which attribute name to search. Currently, DisplayName is the only valid attribute path.
attributeValue String: The value for an attribute.

attributePath string: The attribute path that is used to specify which attribute name to search. Currently, DisplayName is the only valid attribute path.
attributeValue string: The value for an attribute.

attribute_path str: The attribute path that is used to specify which attribute name to search. Currently, DisplayName is the only valid attribute path.
attribute_value str: The value for an attribute.

attributePath String: The attribute path that is used to specify which attribute name to search. Currently, DisplayName is the only valid attribute path.
attributeValue String: The 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.