DynamoDb Service Registry
Stores registered service data in a DynamoDb instance.
Support is enabled by adding the following module into the overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-dynamodb-service-registry</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-dynamodb-service-registry:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-dynamodb-service-registry"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references should be included automatically and are listed here for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:cas-server-support-dynamodb-service-registry"
}
Configuration
You will need to provide CAS with your AWS credentials. Also, to gain a better understanding of DynamoDb’s core components and concepts, please start with this guide first.
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- Groovy Scripting
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Notes
cas.service-registry.dynamo-db.dax.url=
Cluster url. For example,
CAS Property:
|
1 |
cas.service-registry.dynamo-db.dax.url=... |
1
cas:
service-registry:
dynamo-db:
dax:
url: "..."
1
java -Dcas.service-registry.dynamo-db.dax.url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_DAX_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.dax.url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.credential-access-key=
Use access-key provided by AWS to authenticate.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.credential-access-key
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.credential-access-key=...
1
cas:
service-registry:
dynamo-db:
credential-access-key: "..."
1
java -Dcas.service-registry.dynamo-db.credential-access-key="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_CREDENTIAL_ACCESS_KEY="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.credential-access-key="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.credential-secret-key=
Use secret key provided by AWS to authenticate.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.credential-secret-key
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.credential-secret-key=...
1
cas:
service-registry:
dynamo-db:
credential-secret-key: "..."
1
java -Dcas.service-registry.dynamo-db.credential-secret-key="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_CREDENTIAL_SECRET_KEY="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.credential-secret-key="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.endpoint=
AWS custom endpoint.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.endpoint
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.endpoint=...
1
cas:
service-registry:
dynamo-db:
endpoint: "..."
1
java -Dcas.service-registry.dynamo-db.endpoint="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_ENDPOINT="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.endpoint="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.region=
AWS region used.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.region
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.region=...
1
cas:
service-registry:
dynamo-db:
region: "..."
1
java -Dcas.service-registry.dynamo-db.region="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_REGION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.region="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.dax.connect-timeout=PT5S
Connection timeout, calculated in milliseconds. This settings supports the
CAS Property:
|
1 |
cas.service-registry.dynamo-db.dax.connect-timeout=PT5S |
1
cas:
service-registry:
dynamo-db:
dax:
connect-timeout: "PT5S"
1
java -Dcas.service-registry.dynamo-db.dax.connect-timeout="PT5S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_DAX_CONNECT_TIMEOUT="PT5S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.dax.connect-timeout="PT5S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.dax.connection-ttl=PT0S
How long should connections be kept alive, calculated in milliseconds.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbDaxProperties.
CAS Property: cas.service-registry.dynamo-db.dax.connection-ttl
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.dax.connection-ttl=PT0S
1
cas:
service-registry:
dynamo-db:
dax:
connection-ttl: "PT0S"
1
java -Dcas.service-registry.dynamo-db.dax.connection-ttl="PT0S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_DAX_CONNECTION_TTL="PT0S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.dax.connection-ttl="PT0S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.dax.idle-timeout=PT15S
Connection idle timeout, calculated in milliseconds.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbDaxProperties.
CAS Property: cas.service-registry.dynamo-db.dax.idle-timeout
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.dax.idle-timeout=PT15S
1
cas:
service-registry:
dynamo-db:
dax:
idle-timeout: "PT15S"
1
java -Dcas.service-registry.dynamo-db.dax.idle-timeout="PT15S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_DAX_IDLE_TIMEOUT="PT15S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.dax.idle-timeout="PT15S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.dax.max-concurrency=1000
Determines the maximum number of concurrent requests that can be made to the DAX cluster.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbDaxProperties.
CAS Property: cas.service-registry.dynamo-db.dax.max-concurrency
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.dax.max-concurrency=1000
1
cas:
service-registry:
dynamo-db:
dax:
max-concurrency: "1000"
1
java -Dcas.service-registry.dynamo-db.dax.max-concurrency="1000" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_DAX_MAX_CONCURRENCY="1000"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.dax.max-concurrency="1000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.dax.read-retries=2
Number of read retry attempts.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbDaxProperties.
CAS Property: cas.service-registry.dynamo-db.dax.read-retries
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.dax.read-retries=2
1
cas:
service-registry:
dynamo-db:
dax:
read-retries: "2"
1
java -Dcas.service-registry.dynamo-db.dax.read-retries="2" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_DAX_READ_RETRIES="2"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.dax.read-retries="2"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.dax.request-timeout=PT5S
Request execution timeout, calculated in milliseconds.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbDaxProperties.
CAS Property: cas.service-registry.dynamo-db.dax.request-timeout
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.dax.request-timeout=PT5S
1
cas:
service-registry:
dynamo-db:
dax:
request-timeout: "PT5S"
1
java -Dcas.service-registry.dynamo-db.dax.request-timeout="PT5S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_DAX_REQUEST_TIMEOUT="PT5S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.dax.request-timeout="PT5S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.dax.write-retries=2
Number of write retry attempts.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbDaxProperties.
CAS Property: cas.service-registry.dynamo-db.dax.write-retries
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.dax.write-retries=2
1
cas:
service-registry:
dynamo-db:
dax:
write-retries: "2"
1
java -Dcas.service-registry.dynamo-db.dax.write-retries="2" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_DAX_WRITE_RETRIES="2"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.dax.write-retries="2"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.billing-mode=PROVISIONED
Billing mode specifies how you are charged for read and write throughput and how you manage capacity. Available values are as follows:
-
PROVISIONED
: Provisioned mode means that you specify the number of reads and writes per second that you expect your application to use. Provisioned mode is a good option if any of the following are true:- You have predictable application traffic.
- You run applications whose traffic is consistent or ramps gradually.
- You can forecast capacity requirements to control costs.
-
PAY_PER_REQUEST
: Pay-per-request or on-demand billing means that you're charged for only the read/write requests that you use. On-demand mode is a good option if any of the following are true:- You create new tables with unknown workloads.
- You have unpredictable application traffic.
- You prefer the ease of paying for only what you use.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.billing-mode
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.billing-mode=PROVISIONED
1
cas:
service-registry:
dynamo-db:
billing-mode: "PROVISIONED"
1
java -Dcas.service-registry.dynamo-db.billing-mode="PROVISIONED" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_BILLING_MODE="PROVISIONED"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.billing-mode="PROVISIONED"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.client-execution-timeout=10000
Client execution timeout.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.client-execution-timeout
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.client-execution-timeout=10000
1
cas:
service-registry:
dynamo-db:
client-execution-timeout: "10000"
1
java -Dcas.service-registry.dynamo-db.client-execution-timeout="10000" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_CLIENT_EXECUTION_TIMEOUT="10000"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.client-execution-timeout="10000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.connection-timeout=5000
Connection timeout.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.connection-timeout
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.connection-timeout=5000
1
cas:
service-registry:
dynamo-db:
connection-timeout: "5000"
1
java -Dcas.service-registry.dynamo-db.connection-timeout="5000" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_CONNECTION_TIMEOUT="5000"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.connection-timeout="5000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.drop-tables-on-startup=false
Flag that indicates whether to drop tables on start up.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.drop-tables-on-startup
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.drop-tables-on-startup=...
1
cas:
service-registry:
dynamo-db:
drop-tables-on-startup: "..."
1
java -Dcas.service-registry.dynamo-db.drop-tables-on-startup="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_DROP_TABLES_ON_STARTUP="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.drop-tables-on-startup="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.local-address=
Local address.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.local-address
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.local-address=...
1
cas:
service-registry:
dynamo-db:
local-address: "..."
1
java -Dcas.service-registry.dynamo-db.local-address="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_LOCAL_ADDRESS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.local-address="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.local-instance=false
Indicates that the database instance is local to the deployment that does not require or use any credentials or other configuration other than host and region. This is mostly used during development and testing.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.local-instance
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.local-instance=...
1
cas:
service-registry:
dynamo-db:
local-instance: "..."
1
java -Dcas.service-registry.dynamo-db.local-instance="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_LOCAL_INSTANCE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.local-instance="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.max-connections=10
Maximum connections setting.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.max-connections
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.max-connections=10
1
cas:
service-registry:
dynamo-db:
max-connections: "10"
1
java -Dcas.service-registry.dynamo-db.max-connections="10" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_MAX_CONNECTIONS="10"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.max-connections="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.prevent-table-creation-on-startup=false
Flag that indicates whether to prevent CAS from creating tables.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.prevent-table-creation-on-startup
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.prevent-table-creation-on-startup=...
1
cas:
service-registry:
dynamo-db:
prevent-table-creation-on-startup: "..."
1
java -Dcas.service-registry.dynamo-db.prevent-table-creation-on-startup="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_PREVENT_TABLE_CREATION_ON_STARTUP="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.prevent-table-creation-on-startup="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.profile-name=
Profile name to use.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.profile-name
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.profile-name=...
1
cas:
service-registry:
dynamo-db:
profile-name: "..."
1
java -Dcas.service-registry.dynamo-db.profile-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_PROFILE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.profile-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.profile-path=
Profile path.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.profile-path
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.profile-path=...
1
cas:
service-registry:
dynamo-db:
profile-path: "..."
1
java -Dcas.service-registry.dynamo-db.profile-path="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_PROFILE_PATH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.profile-path="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.proxy-host=
Optionally specifies the proxy host to connect through.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.proxy-host
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.proxy-host=...
1
cas:
service-registry:
dynamo-db:
proxy-host: "..."
1
java -Dcas.service-registry.dynamo-db.proxy-host="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_PROXY_HOST="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.proxy-host="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.proxy-password=
Optionally specifies the proxy password to connect through.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.proxy-password
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.proxy-password=...
1
cas:
service-registry:
dynamo-db:
proxy-password: "..."
1
java -Dcas.service-registry.dynamo-db.proxy-password="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_PROXY_PASSWORD="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.proxy-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.proxy-username=
Optionally specifies the proxy username to connect through.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.proxy-username
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.proxy-username=...
1
cas:
service-registry:
dynamo-db:
proxy-username: "..."
1
java -Dcas.service-registry.dynamo-db.proxy-username="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_PROXY_USERNAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.proxy-username="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.read-capacity=10
Read capacity.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.read-capacity
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.read-capacity=10
1
cas:
service-registry:
dynamo-db:
read-capacity: "10"
1
java -Dcas.service-registry.dynamo-db.read-capacity="10" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_READ_CAPACITY="10"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.read-capacity="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.retry-mode=STANDARD
Outline the requested retry mode. Accepted values are STANDARD, LEGACY
.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.retry-mode
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.retry-mode=STANDARD
1
cas:
service-registry:
dynamo-db:
retry-mode: "STANDARD"
1
java -Dcas.service-registry.dynamo-db.retry-mode="STANDARD" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_RETRY_MODE="STANDARD"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.retry-mode="STANDARD"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.socket-timeout=5000
Socket timeout.
This settings supports the
java.time.Duration
syntax [?].
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.socket-timeout
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.socket-timeout=5000
1
cas:
service-registry:
dynamo-db:
socket-timeout: "5000"
1
java -Dcas.service-registry.dynamo-db.socket-timeout="5000" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_SOCKET_TIMEOUT="5000"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.socket-timeout="5000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.table-name=DynamoDbCasServices
The table name used and created by CAS to hold service definitions in DynamoDb.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.table-name
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.table-name=DynamoDbCasServices
1
cas:
service-registry:
dynamo-db:
table-name: "DynamoDbCasServices"
1
java -Dcas.service-registry.dynamo-db.table-name="DynamoDbCasServices" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_TABLE_NAME="DynamoDbCasServices"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.table-name="DynamoDbCasServices"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.time-offset=0
Time offset.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.time-offset
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.time-offset=0
1
cas:
service-registry:
dynamo-db:
time-offset: "0"
1
java -Dcas.service-registry.dynamo-db.time-offset="0" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_TIME_OFFSET="0"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.time-offset="0"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.use-reaper=false
Flag that indicates whether to use reaper.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.use-reaper
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.use-reaper=...
1
cas:
service-registry:
dynamo-db:
use-reaper: "..."
1
java -Dcas.service-registry.dynamo-db.use-reaper="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_USE_REAPER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.use-reaper="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.dynamo-db.write-capacity=10
Write capacity.
org.apereo.cas.configuration.model.support.dynamodb.DynamoDbServiceRegistryProperties.
CAS Property: cas.service-registry.dynamo-db.write-capacity
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.dynamo-db.write-capacity=10
1
cas:
service-registry:
dynamo-db:
write-capacity: "10"
1
java -Dcas.service-registry.dynamo-db.write-capacity="10" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_DYNAMO_DB_WRITE_CAPACITY="10"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.dynamo-db.write-capacity="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
Troubleshooting
To enable additional logging, configure the log4j configuration file to add the following levels:
1
2
3
4
5
6
...
<Logger name="com.amazonaws" level="debug" additivity="false">
<AppenderRef ref="casConsole"/>
<AppenderRef ref="casFile"/>
</Logger>
...
Auto Initialization
Upon startup and configuration permitting, the registry is able to auto initialize itself from default JSON service definitions available to CAS. See this guide for more info.