Package org.apereo.cas.configuration.model.support.aws

Class AmazonSecurityTokenServiceProperties

java.lang.Object

org.apereo.cas.configuration.model.support.aws.BaseAmazonWebServicesProperties

org.apereo.cas.configuration.model.support.aws.AmazonSecurityTokenServiceProperties

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-support-aws")
public class AmazonSecurityTokenServiceProperties
extends BaseAmazonWebServicesProperties

This is AmazonSecurityTokenServiceProperties.

Since:

6.4.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

CasFeatureModule.FeatureCatalog

Constructor Summary

Constructors

Constructor	Description
AmazonSecurityTokenServiceProperties()

Method Summary

Modifier and Type	Method	Description
String	getPrincipalAttributeName()	Attribute name that must be found and resolved for the principal to authorize the user to proceed with obtaining credentials.
String	getPrincipalAttributeValue()	Attribute value, defined as a regex pattern that must be found and resolved for the principal to authorize the user to proceed with obtaining credentials.
boolean	isRbacEnabled()	When set to true, credentials will be obtained based on roles as attributes resolved for the user.
AmazonSecurityTokenServiceProperties	setPrincipalAttributeName(String principalAttributeName)	Attribute name that must be found and resolved for the principal to authorize the user to proceed with obtaining credentials.
AmazonSecurityTokenServiceProperties	setPrincipalAttributeValue(String principalAttributeValue)	Attribute value, defined as a regex pattern that must be found and resolved for the principal to authorize the user to proceed with obtaining credentials.
AmazonSecurityTokenServiceProperties	setRbacEnabled(boolean rbacEnabled)	When set to true, credentials will be obtained based on roles as attributes resolved for the user.

Methods inherited from class org.apereo.cas.configuration.model.support.aws.BaseAmazonWebServicesProperties

getClientExecutionTimeout, getConnectionTimeout, getCredentialAccessKey, getCredentialSecretKey, getEndpoint, getLocalAddress, getMaxConnections, getProfileName, getProfilePath, getProxyHost, getProxyPassword, getProxyUsername, getRegion, getRetryMode, getSocketTimeout, isUseReaper, setClientExecutionTimeout, setConnectionTimeout, setCredentialAccessKey, setCredentialSecretKey, setEndpoint, setLocalAddress, setMaxConnections, setProfileName, setProfilePath, setProxyHost, setProxyPassword, setProxyUsername, setRegion, setRetryMode, setSocketTimeout, setUseReaper

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

isDefined, isUndefined

Constructor Details

AmazonSecurityTokenServiceProperties

public AmazonSecurityTokenServiceProperties()

Method Details

getPrincipalAttributeName

public String getPrincipalAttributeName()

Attribute name that must be found and resolved for the principal to authorize the user to proceed with obtaining credentials.

getPrincipalAttributeValue

public String getPrincipalAttributeValue()

Attribute value, defined as a regex pattern that must be found and resolved for the principal to authorize the user to proceed with obtaining credentials.

isRbacEnabled

public boolean isRbacEnabled()

When set to true, credentials will be obtained based on roles as attributes resolved for the user. Typically, you could use roles wthin your account or for cross-account access.

When set to true, the getPrincipalAttributeName() must contain roleArns as values.

setPrincipalAttributeName

public AmazonSecurityTokenServiceProperties setPrincipalAttributeName(String principalAttributeName)

Attribute name that must be found and resolved for the principal to authorize the user to proceed with obtaining credentials.

Returns:

this.

setPrincipalAttributeValue

public AmazonSecurityTokenServiceProperties setPrincipalAttributeValue(String principalAttributeValue)

Attribute value, defined as a regex pattern that must be found and resolved for the principal to authorize the user to proceed with obtaining credentials.

Returns:

this.

setRbacEnabled

public AmazonSecurityTokenServiceProperties setRbacEnabled(boolean rbacEnabled)

When set to true, credentials will be obtained based on roles as attributes resolved for the user. Typically, you could use roles wthin your account or for cross-account access.

When set to true, the getPrincipalAttributeName() must contain roleArns as values.

Returns:

this.