View a markdown version of this page

JWTOptionsInput - Amazon OpenSearch Service

JWTOptionsInput

The JWT authentication and authorization configuration for an Amazon OpenSearch Service domain.

Contents

Enabled

True to enable JWT authentication and authorization for a domain.

Type: Boolean

Required: No

JwksUrl

The URL endpoint that hosts the JSON Web Key Set (JWKS) containing public keys used to verify JWT signatures.

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

Element of the JWT assertion used by the cluster to verify JWT signatures.

Type: String

Required: No

RolesKey

Element of the JWT assertion to use for roles.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

SubjectKey

Element of the JWT assertion to use for the user name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

See Also

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