Class CfnDomain.SAMLOptionsProperty
Container for information about the SAML configuration for OpenSearch Dashboards.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.AWS.OpenSearchService.dll
Syntax (csharp)
public class SAMLOptionsProperty : Object, CfnDomain.ISAMLOptionsProperty
Syntax (vb)
Public Class SAMLOptionsProperty
Inherits Object
Implements CfnDomain.ISAMLOptionsProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.OpenSearchService;
var sAMLOptionsProperty = new SAMLOptionsProperty {
Enabled = false,
Idp = new IdpProperty {
EntityId = "entityId",
MetadataContent = "metadataContent"
},
MasterBackendRole = "masterBackendRole",
MasterUserName = "masterUserName",
RolesKey = "rolesKey",
SessionTimeoutMinutes = 123,
SubjectKey = "subjectKey"
};
Synopsis
Constructors
SAMLOptionsProperty() |
Properties
Enabled | True to enable SAML authentication for a domain. |
Idp | The SAML Identity Provider's information. |
MasterBackendRole | The backend role that the SAML master user is mapped to. |
MasterUserName | The SAML master user name, which is stored in the domain's internal user database. |
RolesKey | Element of the SAML assertion to use for backend roles. |
SessionTimeoutMinutes | The duration, in minutes, after which a user session becomes inactive. |
SubjectKey | Element of the SAML assertion to use for the user name. |
Constructors
SAMLOptionsProperty()
public SAMLOptionsProperty()
Properties
Enabled
True to enable SAML authentication for a domain.
public object Enabled { get; set; }
Property Value
System.Object
Remarks
Idp
The SAML Identity Provider's information.
public object Idp { get; set; }
Property Value
System.Object
Remarks
MasterBackendRole
The backend role that the SAML master user is mapped to.
public string MasterBackendRole { get; set; }
Property Value
System.String
Remarks
MasterUserName
The SAML master user name, which is stored in the domain's internal user database.
public string MasterUserName { get; set; }
Property Value
System.String
Remarks
RolesKey
Element of the SAML assertion to use for backend roles.
public string RolesKey { get; set; }
Property Value
System.String
Remarks
SessionTimeoutMinutes
The duration, in minutes, after which a user session becomes inactive.
public Nullable<double> SessionTimeoutMinutes { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Acceptable values are between 1 and 1440, and the default value is 60.
SubjectKey
Element of the SAML assertion to use for the user name.
public string SubjectKey { get; set; }
Property Value
System.String