Interface CfnDomain.SAMLOptionsProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDomain.SAMLOptionsProperty extends
Container for information about the SAML configuration for OpenSearch Dashboards.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 SAMLOptionsProperty sAMLOptionsProperty = SAMLOptionsProperty.builder()
  • Method Details

    • getEnabled

      @Stability(Stable) @Nullable default Object getEnabled()
      True to enable SAML authentication for a domain.
    • getIdp

      @Stability(Stable) @Nullable default Object getIdp()
      The SAML Identity Provider's information.
    • getMasterBackendRole

      @Stability(Stable) @Nullable default String getMasterBackendRole()
      The backend role that the SAML master user is mapped to.
    • getMasterUserName

      @Stability(Stable) @Nullable default String getMasterUserName()
      The SAML master user name, which is stored in the domain's internal user database.
    • getRolesKey

      @Stability(Stable) @Nullable default String getRolesKey()
      Element of the SAML assertion to use for backend roles.

      Default is roles .

    • getSessionTimeoutMinutes

      @Stability(Stable) @Nullable default Number getSessionTimeoutMinutes()
      The duration, in minutes, after which a user session becomes inactive.

      Acceptable values are between 1 and 1440, and the default value is 60.

    • getSubjectKey

      @Stability(Stable) @Nullable default String getSubjectKey()
      Element of the SAML assertion to use for the user name.

      Default is NameID .

    • builder

      @Stability(Stable) static CfnDomain.SAMLOptionsProperty.Builder builder()
      a CfnDomain.SAMLOptionsProperty.Builder of CfnDomain.SAMLOptionsProperty