SamlConfigOptions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opensearchserverless.model.SamlConfigOptions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SamlConfigOptions
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SamlConfigOptions()

Constructors
Constructor and Description
`SamlConfigOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SamlConfigOptions`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getGroupAttribute()` The group attribute for this SAML integration.
`String`	`getMetadata()` The XML IdP metadata file generated from your identity provider.
`Integer`	`getSessionTimeout()` The session timeout, in minutes.
`String`	`getUserAttribute()` A user attribute for this SAML integration.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setGroupAttribute(String groupAttribute)` The group attribute for this SAML integration.
`void`	`setMetadata(String metadata)` The XML IdP metadata file generated from your identity provider.
`void`	`setSessionTimeout(Integer sessionTimeout)` The session timeout, in minutes.
`void`	`setUserAttribute(String userAttribute)` A user attribute for this SAML integration.
`String`	`toString()` Returns a string representation of this object.
`SamlConfigOptions`	`withGroupAttribute(String groupAttribute)` The group attribute for this SAML integration.
`SamlConfigOptions`	`withMetadata(String metadata)` The XML IdP metadata file generated from your identity provider.
`SamlConfigOptions`	`withSessionTimeout(Integer sessionTimeout)` The session timeout, in minutes.
`SamlConfigOptions`	`withUserAttribute(String userAttribute)` A user attribute for this SAML integration.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SamlConfigOptions
```
public SamlConfigOptions()
```
- Method Detail
  - setGroupAttribute
```
public void setGroupAttribute(String groupAttribute)
```
    The group attribute for this SAML integration.
    
    Parameters:
    
    groupAttribute - The group attribute for this SAML integration.
  - getGroupAttribute
```
public String getGroupAttribute()
```
    The group attribute for this SAML integration.
    
    Returns:
    
    The group attribute for this SAML integration.
  - withGroupAttribute
```
public SamlConfigOptions withGroupAttribute(String groupAttribute)
```
    The group attribute for this SAML integration.
    
    Parameters:
    
    groupAttribute - The group attribute for this SAML integration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetadata
```
public void setMetadata(String metadata)
```
    The XML IdP metadata file generated from your identity provider.
    
    Parameters:
    
    metadata - The XML IdP metadata file generated from your identity provider.
  - getMetadata
```
public String getMetadata()
```
    The XML IdP metadata file generated from your identity provider.
    
    Returns:
    
    The XML IdP metadata file generated from your identity provider.
  - withMetadata
```
public SamlConfigOptions withMetadata(String metadata)
```
    The XML IdP metadata file generated from your identity provider.
    
    Parameters:
    
    metadata - The XML IdP metadata file generated from your identity provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSessionTimeout
```
public void setSessionTimeout(Integer sessionTimeout)
```
    The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.
    
    Parameters:
    
    sessionTimeout - The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.
  - getSessionTimeout
```
public Integer getSessionTimeout()
```
    The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.
    
    Returns:
    
    The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.
  - withSessionTimeout
```
public SamlConfigOptions withSessionTimeout(Integer sessionTimeout)
```
    The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.
    
    Parameters:
    
    sessionTimeout - The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserAttribute
```
public void setUserAttribute(String userAttribute)
```
    A user attribute for this SAML integration.
    
    Parameters:
    
    userAttribute - A user attribute for this SAML integration.
  - getUserAttribute
```
public String getUserAttribute()
```
    A user attribute for this SAML integration.
    
    Returns:
    
    A user attribute for this SAML integration.
  - withUserAttribute
```
public SamlConfigOptions withUserAttribute(String userAttribute)
```
    A user attribute for this SAML integration.
    
    Parameters:
    
    userAttribute - A user attribute for this SAML integration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SamlConfigOptions clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class SamlConfigOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SamlConfigOptions

Method Detail

setGroupAttribute

getGroupAttribute

withGroupAttribute

setMetadata

getMetadata

withMetadata

setSessionTimeout

getSessionTimeout

withSessionTimeout

setUserAttribute

getUserAttribute

withUserAttribute

toString

equals

hashCode

clone

marshall