Class: Aws::Kendra::Types::JwtTokenTypeConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass JwtTokenTypeConfiguration data as a hash:

{
  key_location: "URL", # required, accepts URL, SECRET_MANAGER
  url: "Url",
  secret_manager_arn: "RoleArn",
  user_name_attribute_field: "UserNameAttributeField",
  group_attribute_field: "GroupAttributeField",
  issuer: "Issuer",
  claim_regex: "ClaimRegex",
}

Configuration information for the JWT token type.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#claim_regexString

The regular expression that identifies the claim.

Returns:

  • (String)


5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5181

class JwtTokenTypeConfiguration < Struct.new(
  :key_location,
  :url,
  :secret_manager_arn,
  :user_name_attribute_field,
  :group_attribute_field,
  :issuer,
  :claim_regex)
  SENSITIVE = []
  include Aws::Structure
end

#group_attribute_fieldString

The group attribute field.

Returns:

  • (String)


5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5181

class JwtTokenTypeConfiguration < Struct.new(
  :key_location,
  :url,
  :secret_manager_arn,
  :user_name_attribute_field,
  :group_attribute_field,
  :issuer,
  :claim_regex)
  SENSITIVE = []
  include Aws::Structure
end

#issuerString

The issuer of the token.

Returns:

  • (String)


5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5181

class JwtTokenTypeConfiguration < Struct.new(
  :key_location,
  :url,
  :secret_manager_arn,
  :user_name_attribute_field,
  :group_attribute_field,
  :issuer,
  :claim_regex)
  SENSITIVE = []
  include Aws::Structure
end

#key_locationString

The location of the key.

Returns:

  • (String)


5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5181

class JwtTokenTypeConfiguration < Struct.new(
  :key_location,
  :url,
  :secret_manager_arn,
  :user_name_attribute_field,
  :group_attribute_field,
  :issuer,
  :claim_regex)
  SENSITIVE = []
  include Aws::Structure
end

#secret_manager_arnString

The Amazon Resource Name (arn) of the secret.

Returns:

  • (String)


5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5181

class JwtTokenTypeConfiguration < Struct.new(
  :key_location,
  :url,
  :secret_manager_arn,
  :user_name_attribute_field,
  :group_attribute_field,
  :issuer,
  :claim_regex)
  SENSITIVE = []
  include Aws::Structure
end

#urlString

The signing key URL.

Returns:

  • (String)


5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5181

class JwtTokenTypeConfiguration < Struct.new(
  :key_location,
  :url,
  :secret_manager_arn,
  :user_name_attribute_field,
  :group_attribute_field,
  :issuer,
  :claim_regex)
  SENSITIVE = []
  include Aws::Structure
end

#user_name_attribute_fieldString

The user name attribute field.

Returns:

  • (String)


5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5181

class JwtTokenTypeConfiguration < Struct.new(
  :key_location,
  :url,
  :secret_manager_arn,
  :user_name_attribute_field,
  :group_attribute_field,
  :issuer,
  :claim_regex)
  SENSITIVE = []
  include Aws::Structure
end