Class: Aws::OpenSearchService::Types::JWTOptionsOutput

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchService::Types::JWTOptionsOutput

Defined in:

gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb

Overview

Describes the JWT options configured for the domain.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enabled ⇒ Boolean

  True if JWT use is enabled.

• #jwks_url ⇒ String

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

• #public_key ⇒ String

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

• #roles_key ⇒ String

  The key used for matching the JWT roles attribute.

• #subject_key ⇒ String

  The key used for matching the JWT subject attribute.

Instance Attribute Details

#enabled ⇒ Boolean

True if JWT use is enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5716

class JWTOptionsOutput < Struct.new(
  :enabled,
  :subject_key,
  :roles_key,
  :jwks_url,
  :public_key)
  SENSITIVE = []
  include Aws::Structure
end

#jwks_url ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5716

class JWTOptionsOutput < Struct.new(
  :enabled,
  :subject_key,
  :roles_key,
  :jwks_url,
  :public_key)
  SENSITIVE = []
  include Aws::Structure
end

#public_key ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5716

class JWTOptionsOutput < Struct.new(
  :enabled,
  :subject_key,
  :roles_key,
  :jwks_url,
  :public_key)
  SENSITIVE = []
  include Aws::Structure
end

#roles_key ⇒ String

The key used for matching the JWT roles attribute.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5716

class JWTOptionsOutput < Struct.new(
  :enabled,
  :subject_key,
  :roles_key,
  :jwks_url,
  :public_key)
  SENSITIVE = []
  include Aws::Structure
end

#subject_key ⇒ String

The key used for matching the JWT subject attribute.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5716

class JWTOptionsOutput < Struct.new(
  :enabled,
  :subject_key,
  :roles_key,
  :jwks_url,
  :public_key)
  SENSITIVE = []
  include Aws::Structure
end