feat: add keycloak version 22.0.4

aws-samples · Oct 15, 2023 · eba426b · eba426b
1 parent 6885c41
commit eba426b
Show file tree

Hide file tree

Showing 6 changed files with 153 additions and 138 deletions.
diff --git a/API.md b/API.md
diff --git a/README.md b/README.md
@@ -14,6 +14,8 @@ CDK construct library that allows you to create [KeyCloak](https://www.keycloak.
 
 # Sample
 
+For Keycloak 17+ versions, please specify hostname for the Keycloak server.
+
 ```ts
 import { KeyCloak } from 'cdk-keycloak';
 
@@ -26,8 +28,9 @@ const env = {
 
 const stack = new cdk.Stack(app, 'keycloak-demo', { env });
 new KeyCloak(stack, 'KeyCloak', {
+  hostname: 'keycloak.example.com',
   certificateArn: 'arn:aws:acm:us-east-1:123456789012:certificate/293cf875-ca98-4c2e-a797-e1cf6df2553c',
-  keycloakVersion,
+  keycloakVersion: KeycloakVersion.V22_0_4,
 });
 ```
 
@@ -37,8 +40,9 @@ Use `keycloakVersion` to specify the version.
 
 ```ts
 new KeyCloak(stack, 'KeyCloak', {
+  hostname,
   certificateArn,
-  keycloakVersion: KeycloakVersion.V15_0_2,
+  keycloakVersion: KeycloakVersion.V22_0_4,
 });
 ```
 
@@ -52,13 +56,15 @@ The `KeyCloak` construct provisions the **Amaozn RDS cluster for MySQL** with **
 ```ts
 // Aurora Serverless v1
 new KeyCloak(stack, 'KeyCloak', {
+  hostname,
   certificateArn,
   auroraServerless: true,
   keycloakVersion,
 });
 
 // Aurora Serverless v2
 new KeyCloak(stack, 'KeyCloak', {
+  hostname,
   certificateArn,
   auroraServerlessV2: true,
   keycloakVersion,
@@ -76,6 +82,7 @@ Plesae note this is not recommended for production environment.
 
 ```ts
 new KeyCloak(stack, 'KeyCloak', {
+  hostname,
   certificateArn,
   singleDbInstance: true,
   keycloakVersion,
@@ -89,7 +96,7 @@ Define `autoScaleTask` for the ecs service task autoscaling. For example:
 
 ```ts
 new KeyCloak(stack, 'KeyCloak', {
-  auroraServerless: true,
+  auroraServerlessV2: true,
   nodeCount: 2,
   autoScaleTask: {
     min: 2,
@@ -125,6 +132,7 @@ Consider the sample below:
 
 ```ts
 new KeyCloak(stack, 'KeyCloak', {
+  hostname: 'keycloak.example.com',
   certificateArn: 'arn:aws:acm:us-east-1:123456789012:certificate/293cf875-ca98-4c2e-a797-e1cf6df2553c',
   vpc: ec2.Vpc.fromLookup(stack, 'Vpc', { vpcId: 'vpc-0417e46d' }),
   publicSubnets: {

diff --git a/src/integ.default.ts b/src/integ.default.ts
@@ -20,8 +20,9 @@ export class IntegTesting {
     // create a default keycloak workload with minimal required props
     new KeyCloak(stack, 'KeyCloak', {
       certificateArn: stack.node.tryGetContext('ACM_CERT_ARN') || 'MOCK_ARN',
-      keycloakVersion: KeycloakVersion.V15_0_2,
-      auroraServerless: true,
+      keycloakVersion: KeycloakVersion.V22_0_4,
+      hostname: 'hostname for keycloak server',
+      auroraServerlessV2: true,
       nodeCount: 2,
       autoScaleTask: {
         min: 2,

diff --git a/src/keycloak.ts b/src/keycloak.ts
@@ -90,6 +90,11 @@ export class KeycloakVersion {
    */
   public static readonly V21_0_1 = KeycloakVersion.of('21.0.1');
 
+  /**
+   * Keycloak version 22.0.4
+   */
+  public static readonly V22_0_4 = KeycloakVersion.of('22.0.4');
+
   /**
    * Custom cluster version
    * @param version custom version number