interface UserTokenConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Kendra.CfnIndex.UserTokenConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnIndex_UserTokenConfigurationProperty`
Java	`software.amazon.awscdk.services.kendra.CfnIndex.UserTokenConfigurationProperty`
Python	`aws_cdk.aws_kendra.CfnIndex.UserTokenConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_kendra` » `CfnIndex` » `UserTokenConfigurationProperty`

Provides the configuration information for a token.

If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const userTokenConfigurationProperty: kendra.CfnIndex.UserTokenConfigurationProperty = {
  jsonTokenTypeConfiguration: {
    groupAttributeField: 'groupAttributeField',
    userNameAttributeField: 'userNameAttributeField',
  },
  jwtTokenTypeConfiguration: {
    keyLocation: 'keyLocation',

    // the properties below are optional
    claimRegex: 'claimRegex',
    groupAttributeField: 'groupAttributeField',
    issuer: 'issuer',
    secretManagerArn: 'secretManagerArn',
    url: 'url',
    userNameAttributeField: 'userNameAttributeField',
  },
};

Properties

Name	Type	Description
jsonTokenTypeConfiguration?	`IResolvable` `\|` `JsonTokenTypeConfigurationProperty`	Information about the JSON token type configuration.
jwtTokenTypeConfiguration?	`IResolvable` `\|` `JwtTokenTypeConfigurationProperty`	Information about the JWT token type configuration.

jsonTokenTypeConfiguration?

Type: IResolvable | JsonTokenTypeConfigurationProperty (optional)

Information about the JSON token type configuration.

jwtTokenTypeConfiguration?

Type: IResolvable | JwtTokenTypeConfigurationProperty (optional)

Information about the JWT token type configuration.