Class: Aws::OpenSearchService::Types::SAMLOptionsOutput

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchService::Types::SAMLOptionsOutput

Defined in:

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

Overview

Describes the SAML application configured for the domain.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enabled ⇒ Boolean

  True if SAML is enabled.

• #idp ⇒ Types::SAMLIdp

  Describes the SAML identity provider's information.

• #roles_key ⇒ String

  The key used for matching the SAML roles attribute.

• #session_timeout_minutes ⇒ Integer

  The duration, in minutes, after which a user session becomes inactive.

• #subject_key ⇒ String

  The key used for matching the SAML subject attribute.

Instance Attribute Details

#enabled ⇒ Boolean

True if SAML is enabled.

Returns:

• (Boolean)

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

class SAMLOptionsOutput < Struct.new(
  :enabled,
  :idp,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#idp ⇒ Types::SAMLIdp

Describes the SAML identity provider's information.

Returns:

• (Types::SAMLIdp)

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

class SAMLOptionsOutput < Struct.new(
  :enabled,
  :idp,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#roles_key ⇒ String

The key used for matching the SAML roles attribute.

Returns:

• (String)

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

class SAMLOptionsOutput < Struct.new(
  :enabled,
  :idp,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#session_timeout_minutes ⇒ Integer

The duration, in minutes, after which a user session becomes inactive.

Returns:

• (Integer)

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

class SAMLOptionsOutput < Struct.new(
  :enabled,
  :idp,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#subject_key ⇒ String

The key used for matching the SAML subject attribute.

Returns:

• (String)

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

class SAMLOptionsOutput < Struct.new(
  :enabled,
  :idp,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = []
  include Aws::Structure
end