interface UserTokenConfigurationProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.Kendra.CfnIndexPropsMixin.UserTokenConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awskendra#CfnIndexPropsMixin_UserTokenConfigurationProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.kendra.CfnIndexPropsMixin.UserTokenConfigurationProperty
Python	aws_cdk.cfn_property_mixins.aws_kendra.CfnIndexPropsMixin.UserTokenConfigurationProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_kendra » CfnIndexPropsMixin » 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-usertokenconfiguration.html

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/cfn-property-mixins';
const userTokenConfigurationProperty: kendra.CfnIndexPropsMixin.UserTokenConfigurationProperty = {
  jsonTokenTypeConfiguration: {
    groupAttributeField: 'groupAttributeField',
    userNameAttributeField: 'userNameAttributeField',
  },
  jwtTokenTypeConfiguration: {
    claimRegex: 'claimRegex',
    groupAttributeField: 'groupAttributeField',
    issuer: 'issuer',
    keyLocation: 'keyLocation',
    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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-usertokenconfiguration.html#cfn-kendra-index-usertokenconfiguration-jsontokentypeconfiguration

---

jwtTokenTypeConfiguration?

Type: IResolvable | JwtTokenTypeConfigurationProperty (optional)

Information about the JWT token type configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-usertokenconfiguration.html#cfn-kendra-index-usertokenconfiguration-jwttokentypeconfiguration