Package software.amazon.awscdk.services.kendra

Interface CfnIndex.JwtTokenTypeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndex.JwtTokenTypeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnIndex

@Stability(Stable)
public static interface CfnIndex.JwtTokenTypeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.kendra.*;
 JwtTokenTypeConfigurationProperty jwtTokenTypeConfigurationProperty = JwtTokenTypeConfigurationProperty.builder()
         .keyLocation("keyLocation")
         // the properties below are optional
         .claimRegex("claimRegex")
         .groupAttributeField("groupAttributeField")
         .issuer("issuer")
         .secretManagerArn("secretManagerArn")
         .url("url")
         .userNameAttributeField("userNameAttributeField")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIndex.JwtTokenTypeConfigurationProperty.Builder	A builder for CfnIndex.JwtTokenTypeConfigurationProperty
static final class	CfnIndex.JwtTokenTypeConfigurationProperty.Jsii$Proxy	An implementation for CfnIndex.JwtTokenTypeConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnIndex.JwtTokenTypeConfigurationProperty.Builder	builder()
default String	getClaimRegex()	The regular expression that identifies the claim.
default String	getGroupAttributeField()	The group attribute field.
default String	getIssuer()	The issuer of the token.
String	getKeyLocation()	The location of the key.
default String	getSecretManagerArn()	The Amazon Resource Name (arn) of the secret.
default String	getUrl()	The signing key URL.
default String	getUserNameAttributeField()	The user name attribute field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKeyLocation

@Stability(Stable)
@NotNull
String getKeyLocation()

The location of the key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-keylocation

getClaimRegex

@Stability(Stable)
@Nullable
default String getClaimRegex()

The regular expression that identifies the claim.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-claimregex

getGroupAttributeField

@Stability(Stable)
@Nullable
default String getGroupAttributeField()

The group attribute field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-groupattributefield

getIssuer

@Stability(Stable)
@Nullable
default String getIssuer()

The issuer of the token.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-issuer

getSecretManagerArn

@Stability(Stable)
@Nullable
default String getSecretManagerArn()

The Amazon Resource Name (arn) of the secret.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-secretmanagerarn

getUrl

@Stability(Stable)
@Nullable
default String getUrl()

The signing key URL.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-url

getUserNameAttributeField

@Stability(Stable)
@Nullable
default String getUserNameAttributeField()

The user name attribute field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-usernameattributefield

builder

@Stability(Stable)
static CfnIndex.JwtTokenTypeConfigurationProperty.Builder builder()

Returns:

a CfnIndex.JwtTokenTypeConfigurationProperty.Builder of CfnIndex.JwtTokenTypeConfigurationProperty