View a markdown version of this page

JWTOptionsOutput - Amazon OpenSearch Service

JWTOptionsOutput

Describes the JWT options configured for the domain.

Contents

Enabled

True if JWT use is enabled.

Type: Boolean

Required: No

JwksUrl

The configured JWKS URL endpoint from which the cluster retrieves public keys to verify JWT requests.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: ^$|^https://(?!(?:10|127|169\.254|192\.168|172\.(?:1[6-9]|2[0-9]|3[01]))\.)[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\.[a-zA-Z]{2,}(?::[0-9]{1,5})?(?:/[a-zA-Z0-9\-._~%!$&'()*+,;=:']*)?$

Required: No

PublicKey

The key used to verify the signature of incoming JWT requests.

Type: String

Required: No

RolesKey

The key used for matching the JWT roles attribute.

Type: String

Required: No

SubjectKey

The key used for matching the JWT subject attribute.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: