aws-cdk-lib.aws_verifiedpermissions.CfnIdentitySourceProps

interface CfnIdentitySourceProps

LanguageType name
.NETAmazon.CDK.aws_verifiedpermissions.CfnIdentitySourceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsverifiedpermissions#CfnIdentitySourceProps
Javaservices.verifiedpermissions.CfnIdentitySourceProps
Pythonaws_cdk.aws_verifiedpermissions.CfnIdentitySourceProps
TypeScript aws-cdk-lib » aws_verifiedpermissions » CfnIdentitySourceProps

Properties for defining a CfnIdentitySource.

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 cfnIdentitySourceProps: verifiedpermissions.CfnIdentitySourceProps = {
  configuration: {
    cognitoUserPoolConfiguration: {
      userPoolArn: 'userPoolArn',

      // the properties below are optional
      clientIds: ['clientIds'],
    },
  },

  // the properties below are optional
  policyStoreId: 'policyStoreId',
  principalEntityType: 'principalEntityType',
};

Properties

NameTypeDescription
configurationIResolvable | IdentitySourceConfigurationPropertyContains configuration information used when creating or updating an identity source.
policyStoreId?stringSpecifies the ID of the policy store in which you want to store this identity source.
principalEntityType?stringSpecifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

configuration

Type: IResolvable | IdentitySourceConfigurationProperty

Contains configuration information used when creating or updating an identity source.

At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.

You must specify a userPoolArn , and optionally, a ClientId .


policyStoreId?

Type: string (optional)

Specifies the ID of the policy store in which you want to store this identity source.

Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.


principalEntityType?

Type: string (optional)

Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.