RuntimeCustomClaim Class
Represents a custom claim validation configuration for Runtime JWT authorizers.
Custom claims allow you to validate additional fields in JWT tokens beyond the standard audience, client, and scope validations.
| Source | lib/runtime/inbound-auth/custom-claim.ts |
|---|
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
const runtimeCustomClaim = bedrock_agentcore_alpha.RuntimeCustomClaim.withStringArrayValue('name', ['values'], /* all optional props */ bedrock_agentcore_alpha.CustomClaimOperator.EQUALS);
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha
runtime_custom_claim = bedrock_agentcore_alpha.RuntimeCustomClaim.with_string_array_value("name", ["values"], bedrock_agentcore_alpha.CustomClaimOperator.EQUALS)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.agentcore.alpha.*;
RuntimeCustomClaim runtimeCustomClaim = RuntimeCustomClaim.withStringArrayValue("name", List.of("values"), CustomClaimOperator.EQUALS);
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;
var runtimeCustomClaim = RuntimeCustomClaim.WithStringArrayValue("name", new [] { "values" }, CustomClaimOperator.EQUALS);
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"
runtimeCustomClaim := bedrock_agentcore_alpha.RuntimeCustomClaim_WithStringArrayValue(jsii.String("name"), []*string{
jsii.String("values"),
}, bedrock_agentcore_alpha.CustomClaimOperator_EQUALS)
Methods
withStringArrayValue(name: string, values: string[], operator?: CustomClaimOperator): RuntimeCustomClaim // chainable@staticmethod def with_string_array_value(name: str, values: typing.List[str], operator: typing.Optional[CustomClaimOperator] = None) -> RuntimeCustomClaimpublic static RuntimeCustomClaim withStringArrayValue(String name, List<String> values, CustomClaimOperator operator)public static RuntimeCustomClaim WithStringArrayValue(string name, string[] values, CustomClaimOperator? operator = null)func WithStringArrayValue(Name *string, Values *[]*string, Operator CustomClaimOperator) RuntimeCustomClaim static #Create a custom claim with a string array value.
String array claims can use CONTAINS (default) or CONTAINS_ANY operator.
3 parameters · returns
Parameters
namenamenamenameName— The name of the claim in the JWT token.valuesvaluesvaluesvaluesValues— The array of string values to match.operatoroperatoroperatoroperatorOperator— The match operator (defaults to CONTAINS).
Returns: A RuntimeCustomClaim configured for string array validation
withStringValue(name: string, value: string): RuntimeCustomClaim // chainable@staticmethod def with_string_value(name: str, value: str) -> RuntimeCustomClaimpublic static RuntimeCustomClaim withStringValue(String name, String value)public static RuntimeCustomClaim WithStringValue(string name, string value)func WithStringValue(Name *string, Value *string) RuntimeCustomClaim static #Create a custom claim with a string value.
String claims must use the EQUALS operator.
2 parameters · returns
Parameters
namenamenamenameName— The name of the claim in the JWT token.valuevaluevaluevalueValue— The string value to match (must exactly equal).
Returns: A RuntimeCustomClaim configured for string validation