2.233.0

interface UserTokenConfigurationProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.Kendra.Mixins.CfnIndexPropsMixin.UserTokenConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskendra/mixins#CfnIndexPropsMixin_UserTokenConfigurationProperty
Javasoftware.amazon.awscdk.mixins.preview.services.kendra.mixins.CfnIndexPropsMixin.UserTokenConfigurationProperty
Pythonaws_cdk.mixins_preview.aws_kendra.mixins.CfnIndexPropsMixin.UserTokenConfigurationProperty
TypeScript @aws-cdk/mixins-preview » aws_kendra » mixins » 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 { mixins as kendra_mixins } from '@aws-cdk/mixins-preview/aws-kendra';
const userTokenConfigurationProperty: kendra_mixins.CfnIndexPropsMixin.UserTokenConfigurationProperty = {
  jsonTokenTypeConfiguration: {
    groupAttributeField: 'groupAttributeField',
    userNameAttributeField: 'userNameAttributeField',
  },
  jwtTokenTypeConfiguration: {
    claimRegex: 'claimRegex',
    groupAttributeField: 'groupAttributeField',
    issuer: 'issuer',
    keyLocation: 'keyLocation',
    secretManagerArn: 'secretManagerArn',
    url: 'url',
    userNameAttributeField: 'userNameAttributeField',
  },
};

Properties

NameTypeDescription
jsonTokenTypeConfiguration?IResolvable | JsonTokenTypeConfigurationPropertyInformation about the JSON token type configuration.
jwtTokenTypeConfiguration?IResolvable | JwtTokenTypeConfigurationPropertyInformation 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

← PreviousNext →