@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
125 lines (124 loc) • 4.39 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Use this data source to get an Identity Store Group.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ssoadmin.getInstances({});
* const exampleGetGroup = example.then(example => aws.identitystore.getGroup({
* identityStoreId: example.identityStoreIds?.[0],
* alternateIdentifier: {
* uniqueAttribute: {
* attributePath: "DisplayName",
* attributeValue: "ExampleGroup",
* },
* },
* }));
* export const groupId = exampleGetGroup.then(exampleGetGroup => exampleGetGroup.groupId);
* ```
*/
export declare function getGroup(args: GetGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupResult>;
/**
* A collection of arguments for invoking getGroup.
*/
export interface GetGroupArgs {
/**
* A unique identifier for the group that is not the primary identifier. Conflicts with `groupId` and `filter`. Detailed below.
*/
alternateIdentifier?: inputs.identitystore.GetGroupAlternateIdentifier;
/**
* The identifier for a group in the Identity Store.
*
* > Exactly one of the above arguments must be provided. Passing both `filter` and `groupId` is allowed for backwards compatibility.
*/
groupId?: string;
/**
* Identity Store ID associated with the Single Sign-On Instance.
*
* The following arguments are optional:
*/
identityStoreId: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
}
/**
* A collection of values returned by getGroup.
*/
export interface GetGroupResult {
readonly alternateIdentifier?: outputs.identitystore.GetGroupAlternateIdentifier;
/**
* Description of the specified group.
*/
readonly description: string;
/**
* Group's display name value.
*/
readonly displayName: string;
/**
* List of identifiers issued to this resource by an external identity provider.
*/
readonly externalIds: outputs.identitystore.GetGroupExternalId[];
readonly groupId: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly identityStoreId: string;
readonly region: string;
}
/**
* Use this data source to get an Identity Store Group.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ssoadmin.getInstances({});
* const exampleGetGroup = example.then(example => aws.identitystore.getGroup({
* identityStoreId: example.identityStoreIds?.[0],
* alternateIdentifier: {
* uniqueAttribute: {
* attributePath: "DisplayName",
* attributeValue: "ExampleGroup",
* },
* },
* }));
* export const groupId = exampleGetGroup.then(exampleGetGroup => exampleGetGroup.groupId);
* ```
*/
export declare function getGroupOutput(args: GetGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetGroupResult>;
/**
* A collection of arguments for invoking getGroup.
*/
export interface GetGroupOutputArgs {
/**
* A unique identifier for the group that is not the primary identifier. Conflicts with `groupId` and `filter`. Detailed below.
*/
alternateIdentifier?: pulumi.Input<inputs.identitystore.GetGroupAlternateIdentifierArgs>;
/**
* The identifier for a group in the Identity Store.
*
* > Exactly one of the above arguments must be provided. Passing both `filter` and `groupId` is allowed for backwards compatibility.
*/
groupId?: pulumi.Input<string>;
/**
* Identity Store ID associated with the Single Sign-On Instance.
*
* The following arguments are optional:
*/
identityStoreId: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
}