interface CognitoUserPoolConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.aws_verifiedpermissions.CfnIdentitySource.CognitoUserPoolConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsverifiedpermissions#CfnIdentitySource_CognitoUserPoolConfigurationProperty`
Java	`software.amazon.awscdk.services.verifiedpermissions.CfnIdentitySource.CognitoUserPoolConfigurationProperty`
Python	`aws_cdk.aws_verifiedpermissions.CfnIdentitySource.CognitoUserPoolConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_verifiedpermissions` » `CfnIdentitySource` » `CognitoUserPoolConfigurationProperty`

A structure that contains configuration information used when creating or updating an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_verifiedpermissions as verifiedpermissions } from 'aws-cdk-lib';
const cognitoUserPoolConfigurationProperty: verifiedpermissions.CfnIdentitySource.CognitoUserPoolConfigurationProperty = {
  userPoolArn: 'userPoolArn',

  // the properties below are optional
  clientIds: ['clientIds'],
  groupConfiguration: {
    groupEntityType: 'groupEntityType',
  },
};

Properties

Name	Type	Description
userPoolArn	`string`	The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
clientIds?	`string[]`	The unique application client IDs that are associated with the specified Amazon Cognito user pool.
groupConfiguration?	`IResolvable` `\|` `CognitoGroupConfigurationProperty`	The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

userPoolArn

Type: string

The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

clientIds?

Type: string[] (optional)

The unique application client IDs that are associated with the specified Amazon Cognito user pool.

Example: "ClientIds": ["&ExampleCogClientId;"]

groupConfiguration?

Type: IResolvable | CognitoGroupConfigurationProperty (optional)

The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.