AWS::Kendra::Index JwtTokenTypeConfiguration - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Kendra::Index JwtTokenTypeConfiguration

Provides the configuration information for the JWT token type.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "ClaimRegex" : String,
  "GroupAttributeField" : String,
  "Issuer" : String,
  "KeyLocation" : String,
  "SecretManagerArn" : String,
  "URL" : String,
  "UserNameAttributeField" : String
}

YAML

  ClaimRegex: String
  GroupAttributeField: String
  Issuer: String
  KeyLocation: String
  SecretManagerArn: String
  URL: String
  UserNameAttributeField: String

Properties

ClaimRegex

The regular expression that identifies the claim.

Required: No

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

GroupAttributeField

The group attribute field.

Required: No

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

Issuer

The issuer of the token.

Required: No

Type: String

Minimum: 1

Maximum: 65

Update requires: No interruption

KeyLocation

The location of the key.

Required: Yes

Type: String

Allowed values: URL | SECRET_MANAGER

Update requires: No interruption

SecretManagerArn

The Amazon Resource Name (arn) of the secret.

Required: No

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Minimum: 1

Maximum: 1284

Update requires: No interruption

URL

The signing key URL.

Required: No

Type: String

Pattern: ^(https?|ftp|file):\/\/([^\s]*)

Minimum: 1

Maximum: 2048

Update requires: No interruption

UserNameAttributeField

The user name attribute field.

Required: No

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption