Class: AWSCDK::OpenSearchServerless::CfnSecurityConfig::SamlConfigOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
open_search_serverless/cfn_security_config.rb

Overview

Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metadata:, group_attribute: nil, open_search_serverless_entity_id: nil, session_timeout: nil, user_attribute: nil) ⇒ SamlConfigOptionsProperty

Returns a new instance of SamlConfigOptionsProperty.

Parameters:

  • metadata (String) —

    The XML IdP metadata file generated from your identity provider.

  • group_attribute (String, nil) (defaults to: nil) —

    The group attribute for this SAML integration.

  • open_search_serverless_entity_id (String, nil) (defaults to: nil) —

    Custom entity ID attribute to override the default entity ID for this SAML integration.

  • session_timeout (Numeric, nil) (defaults to: nil) —

    The session timeout, in minutes.

  • user_attribute (String, nil) (defaults to: nil) —

    A user attribute for this SAML integration.



736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'open_search_serverless/cfn_security_config.rb', line 736

def initialize(metadata:, group_attribute: nil, open_search_serverless_entity_id: nil, session_timeout: nil, user_attribute: nil)
  @metadata = metadata
  Jsii::Type.check_type(@metadata, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metadata")
  @group_attribute = group_attribute
  Jsii::Type.check_type(@group_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "groupAttribute") unless @group_attribute.nil?
  @open_search_serverless_entity_id = open_search_serverless_entity_id
  Jsii::Type.check_type(@open_search_serverless_entity_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "openSearchServerlessEntityId") unless @open_search_serverless_entity_id.nil?
  @session_timeout = session_timeout
  Jsii::Type.check_type(@session_timeout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "sessionTimeout") unless @session_timeout.nil?
  @user_attribute = user_attribute
  Jsii::Type.check_type(@user_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userAttribute") unless @user_attribute.nil?
end

Instance Attribute Details

#group_attribute ⇒ String? (readonly)

The group attribute for this SAML integration.

Returns:

  • (String, nil)

See Also:



758
759
760
 
# File 'open_search_serverless/cfn_security_config.rb', line 758

def group_attribute
  @group_attribute
end

#metadata ⇒ String (readonly)

The XML IdP metadata file generated from your identity provider.

Returns:

  • (String)

See Also:



753
754
755
 
# File 'open_search_serverless/cfn_security_config.rb', line 753

def metadata
  @metadata
end

#open_search_serverless_entity_id ⇒ String? (readonly)

Custom entity ID attribute to override the default entity ID for this SAML integration.

Returns:

  • (String, nil)

See Also:



763
764
765
 
# File 'open_search_serverless/cfn_security_config.rb', line 763

def open_search_serverless_entity_id
  @open_search_serverless_entity_id
end

#session_timeout ⇒ Numeric? (readonly)

The session timeout, in minutes.

Default is 60 minutes (12 hours).

Returns:

  • (Numeric, nil)

See Also:



770
771
772
 
# File 'open_search_serverless/cfn_security_config.rb', line 770

def session_timeout
  @session_timeout
end

#user_attribute ⇒ String? (readonly)

A user attribute for this SAML integration.

Returns:

  • (String, nil)

See Also:



775
776
777
 
# File 'open_search_serverless/cfn_security_config.rb', line 775

def user_attribute
  @user_attribute
end

Class Method Details

.jsii_properties ⇒ Object 



777
778
779
780
781
782
783
784
785
 
# File 'open_search_serverless/cfn_security_config.rb', line 777

def self.jsii_properties
  {
    :metadata => "metadata",
    :group_attribute => "groupAttribute",
    :open_search_serverless_entity_id => "openSearchServerlessEntityId",
    :session_timeout => "sessionTimeout",
    :user_attribute => "userAttribute",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



787
788
789
790
791
792
793
794
795
796
797
 
# File 'open_search_serverless/cfn_security_config.rb', line 787

def to_jsii
  result = {}
  result.merge!({
    "metadata" => @metadata,
    "groupAttribute" => @group_attribute,
    "openSearchServerlessEntityId" => @open_search_serverless_entity_id,
    "sessionTimeout" => @session_timeout,
    "userAttribute" => @user_attribute,
  })
  result.compact
end