Package software.amazon.awscdk.services.agentregistry

Interface CfnRegistry.CustomJWTAuthorizerConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRegistry.CustomJWTAuthorizerConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnRegistry

@Stability(Stable)
public static interface CfnRegistry.CustomJWTAuthorizerConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configuration for a custom JWT authorizer that validates inbound bearer tokens against an OpenID Connect identity provider.

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.agentregistry.*;
 CustomJWTAuthorizerConfigurationProperty customJWTAuthorizerConfigurationProperty = CustomJWTAuthorizerConfigurationProperty.builder()
         .discoveryUrl("discoveryUrl")
         // the properties below are optional
         .allowedAudience(List.of("allowedAudience"))
         .allowedClients(List.of("allowedClients"))
         .allowedScopes(List.of("allowedScopes"))
         .customClaims(List.of(CustomClaimValidationTypeProperty.builder()
                 .authorizingClaimMatchValue(AuthorizingClaimMatchValueTypeProperty.builder()
                         .claimMatchOperator("claimMatchOperator")
                         .claimMatchValue(ClaimMatchValueTypeProperty.builder()
                                 .matchValueString("matchValueString")
                                 .matchValueStringList(List.of("matchValueStringList"))
                                 .build())
                         .build())
                 .inboundTokenClaimName("inboundTokenClaimName")
                 .inboundTokenClaimValueType("inboundTokenClaimValueType")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-agentregistry-registry-customjwtauthorizerconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRegistry.CustomJWTAuthorizerConfigurationProperty.Builder	builder()
default List<String>	getAllowedAudience()	The audience values accepted during JWT validation.
default List<String>	getAllowedClients()	The client identifiers accepted during JWT validation.
default List<String>	getAllowedScopes()	The scopes accepted during JWT validation.
default Object	getCustomClaims()	Additional custom claim validations applied to the inbound JWT.
String	getDiscoveryUrl()	The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDiscoveryUrl

@Stability(Stable)
@NotNull
String getDiscoveryUrl()

The OpenID Connect discovery URL used to retrieve the identity provider's metadata and signing keys.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-agentregistry-registry-customjwtauthorizerconfiguration.html#cfn-agentregistry-registry-customjwtauthorizerconfiguration-discoveryurl

getAllowedAudience

@Stability(Stable)
@Nullable
default List<String> getAllowedAudience()

The audience values accepted during JWT validation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-agentregistry-registry-customjwtauthorizerconfiguration.html#cfn-agentregistry-registry-customjwtauthorizerconfiguration-allowedaudience

getAllowedClients

@Stability(Stable)
@Nullable
default List<String> getAllowedClients()

The client identifiers accepted during JWT validation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-agentregistry-registry-customjwtauthorizerconfiguration.html#cfn-agentregistry-registry-customjwtauthorizerconfiguration-allowedclients

getAllowedScopes

@Stability(Stable)
@Nullable
default List<String> getAllowedScopes()

The scopes accepted during JWT validation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-agentregistry-registry-customjwtauthorizerconfiguration.html#cfn-agentregistry-registry-customjwtauthorizerconfiguration-allowedscopes

getCustomClaims

@Stability(Stable)
@Nullable
default Object getCustomClaims()

Additional custom claim validations applied to the inbound JWT.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRegistry.CustomClaimValidationTypeProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-agentregistry-registry-customjwtauthorizerconfiguration.html#cfn-agentregistry-registry-customjwtauthorizerconfiguration-customclaims

builder

@Stability(Stable)
static CfnRegistry.CustomJWTAuthorizerConfigurationProperty.Builder builder()

Returns:

a CfnRegistry.CustomJWTAuthorizerConfigurationProperty.Builder of CfnRegistry.CustomJWTAuthorizerConfigurationProperty