WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

DynamoDb Ticket Registry

DynamoDb ticket registry integration is enabled by including the following dependency in the WAR overlay:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-dynamodb-ticket-registry</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-dynamodb-ticket-registry:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-dynamodb-ticket-registry"
}

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-ticket-registry"
}

This registry stores tickets in DynamoDb instances. Each ticket type is linked to a distinct table.

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:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

cas.ticket.registry.dynamo-db.crypto.encryption.key=

The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

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.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.encryption.key=...

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          encryption: 
            key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.encryption.key="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as 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.

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_ENCRYPTION_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.encryption.key="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.crypto.signing.key=

The signing key is a JWT whose length is defined by the signing key size setting.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.signing.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          signing: 
            key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.signing.key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_SIGNING_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.signing.key="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.dax.url=

Cluster url. For example, dax://my-cluster.l6fzcv.dax-clusters.us-east-1.amazonaws.com.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbDaxProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.dax.url=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        dax: 
          url: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.dax.url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_DAX_URL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.dax.url="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.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.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.credential-access-key=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        credential-access-key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.credential-access-key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CREDENTIAL_ACCESS_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.credential-access-key="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.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.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.credential-secret-key=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        credential-secret-key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.credential-secret-key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CREDENTIAL_SECRET_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.credential-secret-key="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.endpoint=

AWS custom endpoint.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.endpoint=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        endpoint: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.endpoint="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_ENDPOINT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.endpoint="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.region=

AWS region used.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.region=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        region: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.region="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_REGION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.region="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

cas.ticket.registry.dynamo-db.crypto.alg=AES

The signing/encryption algorithm to use.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.alg=AES

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          alg: "AES"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.alg="AES" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_ALG="AES"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.alg="AES"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.crypto.enabled=true

Whether crypto operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.crypto.encryption.key-size=16

Encryption key size.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.encryption.key-size=16

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          encryption: 
            key-size: "16"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.encryption.key-size="16" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_ENCRYPTION_KEY_SIZE="16"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.encryption.key-size="16"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.crypto.signing-enabled=true

Whether signing encryption operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.signing-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          signing-enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.signing-enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_SIGNING_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.signing-enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.crypto.signing.key-size=512

The signing key size.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.signing.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          signing: 
            key-size: "512"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.signing.key-size="512" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_SIGNING_KEY_SIZE="512"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.signing.key-size="512"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.dax.connect-timeout=PT5S

Connection timeout, calculated in milliseconds.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbDaxProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.dax.connect-timeout=PT5S

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        dax: 
          connect-timeout: "PT5S"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.dax.connect-timeout="PT5S" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_DAX_CONNECT_TIMEOUT="PT5S"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.dax.connect-timeout="PT5S"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.dax.connection-ttl=PT0S

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        dax: 
          connection-ttl: "PT0S"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.dax.connection-ttl="PT0S" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_DAX_CONNECTION_TTL="PT0S"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.dax.connection-ttl="PT0S"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.dax.idle-timeout=PT15S

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        dax: 
          idle-timeout: "PT15S"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.dax.idle-timeout="PT15S" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_DAX_IDLE_TIMEOUT="PT15S"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.dax.idle-timeout="PT15S"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.dax.max-concurrency=1000

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        dax: 
          max-concurrency: "1000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.dax.max-concurrency="1000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_DAX_MAX_CONCURRENCY="1000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.dax.max-concurrency="1000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.dax.read-retries=2

Number of read retry attempts.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbDaxProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.dax.read-retries=2

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        dax: 
          read-retries: "2"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.dax.read-retries="2" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_DAX_READ_RETRIES="2"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.dax.read-retries="2"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.dax.request-timeout=PT5S

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        dax: 
          request-timeout: "PT5S"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.dax.request-timeout="PT5S" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_DAX_REQUEST_TIMEOUT="PT5S"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.dax.request-timeout="PT5S"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.dax.write-retries=2

Number of write retry attempts.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbDaxProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.dax.write-retries=2

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        dax: 
          write-retries: "2"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.dax.write-retries="2" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_DAX_WRITE_RETRIES="2"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.dax.write-retries="2"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.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.
You can use auto scaling to automatically adjust capacity based on the specified utilization rate to ensure application performance while reducing 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.
Tables using on-demand mode support all DynamoDB features (such as encryption at rest, point-in-time recovery, global tables, and so on) with the exception of auto scaling, which is not applicable with this mode.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.billing-mode=PROVISIONED

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        billing-mode: "PROVISIONED"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.billing-mode="PROVISIONED" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_BILLING_MODE="PROVISIONED"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.billing-mode="PROVISIONED"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.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.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.client-execution-timeout=10000

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        client-execution-timeout: "10000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.client-execution-timeout="10000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CLIENT_EXECUTION_TIMEOUT="10000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.client-execution-timeout="10000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.connection-timeout=5000

Connection timeout.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.connection-timeout=5000

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        connection-timeout: "5000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.connection-timeout="5000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CONNECTION_TIMEOUT="5000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.connection-timeout="5000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.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.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.drop-tables-on-startup=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        drop-tables-on-startup: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.drop-tables-on-startup="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_DROP_TABLES_ON_STARTUP="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.drop-tables-on-startup="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.local-address=

Local address.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.local-address=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        local-address: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.local-address="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_LOCAL_ADDRESS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.local-address="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.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.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.local-instance=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        local-instance: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.local-instance="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_LOCAL_INSTANCE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.local-instance="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.max-connections=10

Maximum connections setting.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.max-connections=10

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        max-connections: "10"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.max-connections="10" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_MAX_CONNECTIONS="10"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.max-connections="10"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.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.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.prevent-table-creation-on-startup=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        prevent-table-creation-on-startup: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.prevent-table-creation-on-startup="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_PREVENT_TABLE_CREATION_ON_STARTUP="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.prevent-table-creation-on-startup="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.profile-name=

Profile name to use.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.profile-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        profile-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.profile-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_PROFILE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.profile-name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.profile-path=

Profile path.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.profile-path=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        profile-path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.profile-path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_PROFILE_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.profile-path="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.proxy-granting-tickets-table-name=proxyGrantingTicketsTable

The table name used and created by CAS to hold proxy ticket granting tickets in DynamoDb.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.proxy-granting-tickets-table-name=proxyGrantingTicketsTable

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        proxy-granting-tickets-table-name: "proxyGrantingTicketsTable"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.proxy-granting-tickets-table-name="proxyGrantingTicketsTable" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_PROXY_GRANTING_TICKETS_TABLE_NAME="proxyGrantingTicketsTable"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.proxy-granting-tickets-table-name="proxyGrantingTicketsTable"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.proxy-host=

Optionally specifies the proxy host to connect through.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.proxy-host=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        proxy-host: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.proxy-host="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_PROXY_HOST="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.proxy-host="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.proxy-password=

Optionally specifies the proxy password to connect through.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.proxy-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        proxy-password: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.proxy-password="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_PROXY_PASSWORD="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.proxy-password="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.proxy-tickets-table-name=proxyTicketsTable

The table name used and created by CAS to hold proxy tickets in DynamoDb.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.proxy-tickets-table-name=proxyTicketsTable

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        proxy-tickets-table-name: "proxyTicketsTable"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.proxy-tickets-table-name="proxyTicketsTable" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_PROXY_TICKETS_TABLE_NAME="proxyTicketsTable"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.proxy-tickets-table-name="proxyTicketsTable"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.proxy-username=

Optionally specifies the proxy username to connect through.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.proxy-username=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        proxy-username: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.proxy-username="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_PROXY_USERNAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.proxy-username="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.read-capacity=10

Read capacity.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.read-capacity=10

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        read-capacity: "10"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.read-capacity="10" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_READ_CAPACITY="10"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.read-capacity="10"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.retry-mode=STANDARD

Outline the requested retry mode. Accepted values are STANDARD, LEGACY.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.retry-mode=STANDARD

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        retry-mode: "STANDARD"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.retry-mode="STANDARD" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_RETRY_MODE="STANDARD"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.retry-mode="STANDARD"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.service-tickets-table-name=serviceTicketsTable

The table name used and created by CAS to hold service tickets in DynamoDb.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.service-tickets-table-name=serviceTicketsTable

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        service-tickets-table-name: "serviceTicketsTable"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.service-tickets-table-name="serviceTicketsTable" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_SERVICE_TICKETS_TABLE_NAME="serviceTicketsTable"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.service-tickets-table-name="serviceTicketsTable"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.socket-timeout=5000

Socket timeout.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.socket-timeout=5000

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        socket-timeout: "5000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.socket-timeout="5000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_SOCKET_TIMEOUT="5000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.socket-timeout="5000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.ticket-granting-tickets-table-name=ticketGrantingTicketsTable

The table name used and created by CAS to hold ticket granting tickets in DynamoDb.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.ticket-granting-tickets-table-name=ticketGrantingTicketsTable

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        ticket-granting-tickets-table-name: "ticketGrantingTicketsTable"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.ticket-granting-tickets-table-name="ticketGrantingTicketsTable" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_TICKET_GRANTING_TICKETS_TABLE_NAME="ticketGrantingTicketsTable"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.ticket-granting-tickets-table-name="ticketGrantingTicketsTable"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.time-offset=0

Time offset.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.time-offset=0

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        time-offset: "0"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.time-offset="0" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_TIME_OFFSET="0"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.time-offset="0"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.transient-session-tickets-table-name=transientSessionTicketsTable

The table name used and created by CAS to hold transient session ticket tickets in DynamoDb.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.transient-session-tickets-table-name=transientSessionTicketsTable

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        transient-session-tickets-table-name: "transientSessionTicketsTable"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.transient-session-tickets-table-name="transientSessionTicketsTable" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_TRANSIENT_SESSION_TICKETS_TABLE_NAME="transientSessionTicketsTable"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.transient-session-tickets-table-name="transientSessionTicketsTable"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.use-reaper=false

Flag that indicates whether to use reaper.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.use-reaper=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        use-reaper: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.use-reaper="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_USE_REAPER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.use-reaper="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.write-capacity=10

Write capacity.

org.apereo.cas.configuration.model.support.dynamodb.DynamoDbTicketRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.write-capacity=10

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        write-capacity: "10"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.write-capacity="10" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_WRITE_CAPACITY="10"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.write-capacity="10"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

# The signing/encryption algorithm to use.
# cas.ticket.registry.dynamo-db.crypto.alg=AES

# Whether crypto operations are enabled.
# cas.ticket.registry.dynamo-db.crypto.enabled=true

# Encryption key size.
# cas.ticket.registry.dynamo-db.crypto.encryption.key-size=16

# Whether signing encryption operations are enabled.
# cas.ticket.registry.dynamo-db.crypto.signing-enabled=true

# The signing key size.
# cas.ticket.registry.dynamo-db.crypto.signing.key-size=512

# Connection timeout, calculated in milliseconds.
# cas.ticket.registry.dynamo-db.dax.connect-timeout=PT5S

# How long should connections be kept alive, calculated in milliseconds.
# cas.ticket.registry.dynamo-db.dax.connection-ttl=PT0S

# Connection idle timeout, calculated in milliseconds.
# cas.ticket.registry.dynamo-db.dax.idle-timeout=PT15S

# Determines the maximum number of concurrent requests that can be made to the DAX cluster.
# cas.ticket.registry.dynamo-db.dax.max-concurrency=1000

# Number of read retry attempts.
# cas.ticket.registry.dynamo-db.dax.read-retries=2

# Request execution timeout, calculated in milliseconds.
# cas.ticket.registry.dynamo-db.dax.request-timeout=PT5S

# Number of write retry attempts.
# cas.ticket.registry.dynamo-db.dax.write-retries=2

# Billing mode specifies how you are charged for read and write throughput and how you manage capacity.
# cas.ticket.registry.dynamo-db.billing-mode=PROVISIONED

# Client execution timeout.
# cas.ticket.registry.dynamo-db.client-execution-timeout=10000

# Connection timeout.
# cas.ticket.registry.dynamo-db.connection-timeout=5000

# Flag that indicates whether to drop tables on start up.
# cas.ticket.registry.dynamo-db.drop-tables-on-startup=false

# Local address.
# cas.ticket.registry.dynamo-db.local-address=

# 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.
# cas.ticket.registry.dynamo-db.local-instance=false

# Maximum connections setting.
# cas.ticket.registry.dynamo-db.max-connections=10

# Flag that indicates whether to prevent CAS from creating tables.
# cas.ticket.registry.dynamo-db.prevent-table-creation-on-startup=false

# Profile name to use.
# cas.ticket.registry.dynamo-db.profile-name=

# Profile path.
# cas.ticket.registry.dynamo-db.profile-path=

# The table name used and created by CAS to hold proxy ticket granting tickets in DynamoDb.
# cas.ticket.registry.dynamo-db.proxy-granting-tickets-table-name=proxyGrantingTicketsTable

# Optionally specifies the proxy host to connect through.
# cas.ticket.registry.dynamo-db.proxy-host=

# Optionally specifies the proxy password to connect through.
# cas.ticket.registry.dynamo-db.proxy-password=

# The table name used and created by CAS to hold proxy tickets in DynamoDb.
# cas.ticket.registry.dynamo-db.proxy-tickets-table-name=proxyTicketsTable

# Optionally specifies the proxy username to connect through.
# cas.ticket.registry.dynamo-db.proxy-username=

# Read capacity.
# cas.ticket.registry.dynamo-db.read-capacity=10

# Outline the requested retry mode.
# cas.ticket.registry.dynamo-db.retry-mode=STANDARD

# The table name used and created by CAS to hold service tickets in DynamoDb.
# cas.ticket.registry.dynamo-db.service-tickets-table-name=serviceTicketsTable

# Socket timeout.
# cas.ticket.registry.dynamo-db.socket-timeout=5000

# The table name used and created by CAS to hold ticket granting tickets in DynamoDb.
# cas.ticket.registry.dynamo-db.ticket-granting-tickets-table-name=ticketGrantingTicketsTable

# Time offset.
# cas.ticket.registry.dynamo-db.time-offset=0

# The table name used and created by CAS to hold transient session ticket tickets in DynamoDb.
# cas.ticket.registry.dynamo-db.transient-session-tickets-table-name=transientSessionTicketsTable

# Flag that indicates whether to use reaper.
# cas.ticket.registry.dynamo-db.use-reaper=false

# Write capacity.
# cas.ticket.registry.dynamo-db.write-capacity=10

cas.ticket.registry.dynamo-db.crypto.encryption.key=

The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.encryption.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          encryption: 
            key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.encryption.key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_ENCRYPTION_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.encryption.key="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.crypto.signing.key=

The signing key is a JWT whose length is defined by the signing key size setting.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.signing.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          signing: 
            key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.signing.key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_SIGNING_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.signing.key="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.crypto.alg=AES

The signing/encryption algorithm to use.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.alg=AES

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          alg: "AES"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.alg="AES" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_ALG="AES"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.alg="AES"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.crypto.enabled=true

Whether crypto operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.crypto.encryption.key-size=16

Encryption key size.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.encryption.key-size=16

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          encryption: 
            key-size: "16"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.encryption.key-size="16" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_ENCRYPTION_KEY_SIZE="16"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.encryption.key-size="16"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.crypto.signing-enabled=true

Whether signing encryption operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.signing-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          signing-enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.signing-enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_SIGNING_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.signing-enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.ticket.registry.dynamo-db.crypto.signing.key-size=512

The signing key size.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.ticket.registry.dynamo-db.crypto.signing.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    registry: 
      dynamo-db: 
        crypto: 
          signing: 
            key-size: "512"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.ticket.registry.dynamo-db.crypto.signing.key-size="512" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_TICKET_REGISTRY_DYNAMO_DB_CRYPTO_SIGNING_KEY_SIZE="512"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.ticket.registry.dynamo-db.crypto.signing.key-size="512"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys.

Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:

wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
java -jar jwk-gen.jar -t oct -s [size]

The outcome would be similar to:

{
  "kty": "oct",
  "kid": "...",
  "k": "..."
}

The generated value for k needs to be assigned to the relevant CAS settings. Note that keys generated via the above algorithm are processed by CAS using the Advanced Encryption Standard (AES) algorithm which is a specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology.

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.

Note

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:

...
<Logger name="com.amazonaws" level="debug" additivity="false">
    <AppenderRef ref="casConsole"/>
    <AppenderRef ref="casFile"/>
</Logger>
...