aws-cdk-lib.aws_kendra.CfnIndex.JwtTokenTypeConfigurationProperty

interface JwtTokenTypeConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnIndex.JwtTokenTypeConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnIndex_JwtTokenTypeConfigurationProperty
Javasoftware.amazon.awscdk.services.kendra.CfnIndex.JwtTokenTypeConfigurationProperty
Pythonaws_cdk.aws_kendra.CfnIndex.JwtTokenTypeConfigurationProperty
TypeScript aws-cdk-lib » aws_kendra » CfnIndex » JwtTokenTypeConfigurationProperty

Provides the configuration information for the JWT token type.

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 jwtTokenTypeConfigurationProperty: kendra.CfnIndex.JwtTokenTypeConfigurationProperty = {
  keyLocation: 'keyLocation',

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

Properties

NameTypeDescription
keyLocationstringThe location of the key.
claimRegex?stringThe regular expression that identifies the claim.
groupAttributeField?stringThe group attribute field.
issuer?stringThe issuer of the token.
secretManagerArn?stringThe Amazon Resource Name (arn) of the secret.
url?stringThe signing key URL.
userNameAttributeField?stringThe user name attribute field.

keyLocation

Type: string

The location of the key.


claimRegex?

Type: string (optional)

The regular expression that identifies the claim.


groupAttributeField?

Type: string (optional)

The group attribute field.


issuer?

Type: string (optional)

The issuer of the token.


secretManagerArn?

Type: string (optional)

The Amazon Resource Name (arn) of the secret.


url?

Type: string (optional)

The signing key URL.


userNameAttributeField?

Type: string (optional)

The user name attribute field.