AWS Classic
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<Get
Group Filter> Configuration block(s) for filtering. Currently, the AWS Identity Store API supports only 1 filter. Detailed below.
- Identity
Store stringId The Identity Store ID associated with the Single Sign-On Instance.
- Group
Id string The identifier for a group in the Identity Store.
- Filters
[]Get
Group Filter Configuration block(s) for filtering. Currently, the AWS Identity Store API supports only 1 filter. Detailed below.
- Identity
Store stringId The Identity Store ID associated with the Single Sign-On Instance.
- Group
Id string The identifier for a group in the Identity Store.
- filters
List<Get
Group Filter> Configuration block(s) for filtering. Currently, the AWS Identity Store API supports only 1 filter. Detailed below.
- identity
Store StringId The Identity Store ID associated with the Single Sign-On Instance.
- group
Id String The identifier for a group in the Identity Store.
- filters
Get
Group Filter[] Configuration block(s) for filtering. Currently, the AWS Identity Store API supports only 1 filter. Detailed below.
- identity
Store stringId The Identity Store ID associated with the Single Sign-On Instance.
- group
Id string The identifier for a group in the Identity Store.
- filters
Sequence[Get
Group Filter] Configuration block(s) for filtering. Currently, the AWS Identity Store API supports only 1 filter. Detailed below.
- identity_
store_ strid 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.
- identity
Store StringId The Identity Store ID associated with the Single Sign-On Instance.
- group
Id String The identifier for a group in the Identity Store.
getGroup Result
The following output properties are available:
- Display
Name string The group's display name value.
- Filters
List<Get
Group Filter> - Group
Id string - Id string
The provider-assigned unique ID for this managed resource.
- Identity
Store stringId
- Display
Name string The group's display name value.
- Filters
[]Get
Group Filter - Group
Id string - Id string
The provider-assigned unique ID for this managed resource.
- Identity
Store stringId
- display
Name String The group's display name value.
- filters
List<Get
Group Filter> - group
Id String - id String
The provider-assigned unique ID for this managed resource.
- identity
Store StringId
- display
Name string The group's display name value.
- filters
Get
Group Filter[] - group
Id string - id string
The provider-assigned unique ID for this managed resource.
- identity
Store stringId
- display_
name str The group's display name value.
- filters
Sequence[Get
Group Filter] - group_
id str - id str
The provider-assigned unique ID for this managed resource.
- identity_
store_ strid
- display
Name String The group's display name value.
- filters List<Property Map>
- group
Id String - id String
The provider-assigned unique ID for this managed resource.
- identity
Store StringId
Supporting Types
GetGroupFilter
- Attribute
Path string The attribute path that is used to specify which attribute name to search. Currently,
DisplayName
is the only valid attribute path.- Attribute
Value string The value for an attribute.
- Attribute
Path string The attribute path that is used to specify which attribute name to search. Currently,
DisplayName
is the only valid attribute path.- Attribute
Value string The value for an attribute.
- attribute
Path String The attribute path that is used to specify which attribute name to search. Currently,
DisplayName
is the only valid attribute path.- attribute
Value String The value for an attribute.
- attribute
Path string The attribute path that is used to specify which attribute name to search. Currently,
DisplayName
is the only valid attribute path.- attribute
Value 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.
- attribute
Path String The attribute path that is used to specify which attribute name to search. Currently,
DisplayName
is the only valid attribute path.- attribute
Value 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.