Class CfnIndexPropsMixin.UserTokenConfigurationProperty

Provides the configuration information for a token.

Inheritance

object

CfnIndexPropsMixin.UserTokenConfigurationProperty

Implements

CfnIndexPropsMixin.IUserTokenConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnIndexPropsMixin.UserTokenConfigurationProperty : CfnIndexPropsMixin.IUserTokenConfigurationProperty

Syntax (vb)

Public Class CfnIndexPropsMixin.UserTokenConfigurationProperty Implements CfnIndexPropsMixin.IUserTokenConfigurationProperty

Remarks

If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use <code>UserTokenConfigurations</code> to configure user context policy, Amazon Kendra returns a <code>ValidationException</code> error.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins;

             var userTokenConfigurationProperty = new UserTokenConfigurationProperty {
                 JsonTokenTypeConfiguration = new JsonTokenTypeConfigurationProperty {
                     GroupAttributeField = "groupAttributeField",
                     UserNameAttributeField = "userNameAttributeField"
                 },
                 JwtTokenTypeConfiguration = new JwtTokenTypeConfigurationProperty {
                     ClaimRegex = "claimRegex",
                     GroupAttributeField = "groupAttributeField",
                     Issuer = "issuer",
                     KeyLocation = "keyLocation",
                     SecretManagerArn = "secretManagerArn",
                     Url = "url",
                     UserNameAttributeField = "userNameAttributeField"
                 }
             };

Synopsis

Constructors

UserTokenConfigurationProperty()

Provides the configuration information for a token.

Properties

JsonTokenTypeConfiguration	Information about the JSON token type configuration.
JwtTokenTypeConfiguration	Information about the JWT token type configuration.

Constructors

UserTokenConfigurationProperty()

Provides the configuration information for a token.

public UserTokenConfigurationProperty()

Remarks

If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use <code>UserTokenConfigurations</code> to configure user context policy, Amazon Kendra returns a <code>ValidationException</code> error.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins;

             var userTokenConfigurationProperty = new UserTokenConfigurationProperty {
                 JsonTokenTypeConfiguration = new JsonTokenTypeConfigurationProperty {
                     GroupAttributeField = "groupAttributeField",
                     UserNameAttributeField = "userNameAttributeField"
                 },
                 JwtTokenTypeConfiguration = new JwtTokenTypeConfigurationProperty {
                     ClaimRegex = "claimRegex",
                     GroupAttributeField = "groupAttributeField",
                     Issuer = "issuer",
                     KeyLocation = "keyLocation",
                     SecretManagerArn = "secretManagerArn",
                     Url = "url",
                     UserNameAttributeField = "userNameAttributeField"
                 }
             };

Properties

JsonTokenTypeConfiguration

Information about the JSON token type configuration.

public object? JsonTokenTypeConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-usertokenconfiguration.html#cfn-kendra-index-usertokenconfiguration-jsontokentypeconfiguration

Type union: either IResolvable or CfnIndexPropsMixin.IJsonTokenTypeConfigurationProperty

JwtTokenTypeConfiguration

Information about the JWT token type configuration.

public object? JwtTokenTypeConfiguration { get; set; }