aurora serverless v2

.github/workflows/rspec.yaml

@@ -3,23 +3,6 @@ name: cftest
 on: [push, pull_request]
 
 jobs:
-  test:
-    name: test
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: set up ruby 2.7
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.7.x
-    - name: install gems
-      run: gem install cfhighlander rspec 
-    - name: set cfndsl spec
-      run: cfndsl -u
-    - name: cftest
-      run: rspec
-      env:
-        AWS_ACCESS_KEY: ${{ secrets.AWS_ACCESS_KEY }}
-        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-        AWS_REGION: ap-southeast-2
+  rspec:
+    uses: theonestack/shared-workflows/.github/workflows/rspec.yaml@main
+    secrets: inherit

aurora-postgres.cfhighlander.rb

@@ -7,15 +7,22 @@
   Parameters do
     ComponentParam 'EnvironmentName', 'dev', isGlobal: true
     ComponentParam 'EnvironmentType', 'development', isGlobal: true, allowedValues: ['development', 'production']
-    ComponentParam 'WriterInstanceType'
-    ComponentParam 'ReaderInstanceType'
     ComponentParam 'DnsDomain'
     ComponentParam 'SnapshotID'
-    ComponentParam 'EnableReader', 'false', allowedValues: ['true', 'false']
     ComponentParam 'VPCId', type: 'AWS::EC2::VPC::Id'
     ComponentParam 'SubnetIds', type: 'CommaDelimitedList'
     ComponentParam 'KmsKeyId' if (defined? kms) && (kms)
 
+    if defined?(engine_mode) && engine_mode == 'serverless'
+      ComponentParam 'MaxCapacity', '2'
+      ComponentParam 'MinCapacity', '0.5'
+      ComponentParam 'EnableHttpEndpoint', 'false', allowedValues: ['true', 'false']
+    else
+      ComponentParam 'WriterInstanceType'
+      ComponentParam 'ReaderInstanceType'
+      ComponentParam 'EnableReader', 'false', allowedValues: ['true', 'false']
+    end
+
     ComponentParam 'NamespaceId' if defined? service_discovery
   end
 

aurora-postgres.cfndsl.rb

@@ -1,10 +1,8 @@
 CloudFormation do
 
-  Condition("EnableReader", FnEquals(Ref("EnableReader"), 'true'))
   Condition("UseUsernameAndPassword", FnEquals(Ref(:SnapshotID), ''))
   Condition("UseSnapshotID", FnNot(FnEquals(Ref(:SnapshotID), '')))
   Condition("CreateHostRecord", FnNot(FnEquals(Ref(:DnsDomain), '')))
-  Condition("CreateReaderRecord", FnAnd([FnEquals(Ref("EnableReader"), 'true'), Condition('CreateHostRecord')]))
 
   aurora_tags = []
   tags = external_parameters.fetch(:tags, {})
@@ -163,19 +161,22 @@
   end
 
   engine_version = external_parameters.fetch(:engine_version, nil)
+  engine_mode = external_parameters.fetch(:engine_mode, nil)
   database_name = external_parameters.fetch(:database_name, nil)
   storage_encrypted = external_parameters.fetch(:storage_encrypted, nil)
   kms = external_parameters.fetch(:kms, false)
   cluster_maintenance_window = external_parameters.fetch(:cluster_maintenance_window, nil)
   cloudwatch_log_exports = external_parameters.fetch(:cloudwatch_log_exports, [])
 
+  # for serverless v2 the EngineMode property in the DBCluster is to be left unset
+
   RDS_DBCluster(:DBCluster) {
     Engine 'aurora-postgresql'
     EngineVersion engine_version unless engine_version.nil?
     DBClusterParameterGroupName Ref(:DBClusterParameterGroup)
     EnableCloudwatchLogsExports cloudwatch_log_exports if cloudwatch_log_exports.any?
     PreferredMaintenanceWindow cluster_maintenance_window unless cluster_maintenance_window.nil?
-    SnapshotIdentifier FnIf('UseSnapshotID',Ref(:SnapshotID), Ref('AWS::NoValue'))
+    SnapshotIdentifier FnIf('UseSnapshotID', Ref(:SnapshotID), Ref('AWS::NoValue'))
     MasterUsername  FnIf('UseUsernameAndPassword', instance_username, Ref('AWS::NoValue'))
     MasterUserPassword  FnIf('UseUsernameAndPassword', instance_password, Ref('AWS::NoValue'))
     DBSubnetGroupName Ref(:DBClusterSubnetGroup)
@@ -186,6 +187,14 @@
     Port external_parameters[:cluster_port]
     Tags aurora_tags
     AssociatedRoles cluster_roles if cluster_roles.any?
+
+    if engine_mode == 'serverless'
+      EnableHttpEndpoint Ref(:EnableHttpEndpoint)
+      ServerlessV2ScalingConfiguration({
+        MinCapacity: Ref('MinCapacity'),
+        MaxCapacity: Ref('MaxCapacity')
+      })
+    end
   }
 
   instance_parameters = external_parameters.fetch(:instance_parameters, nil)
@@ -201,43 +210,55 @@
   maint_window = external_parameters.fetch(:maint_window, nil) # key kept for backwards compatibility
   writer_maintenance_window = external_parameters.fetch(:writer_maintenance_window, maint_window)
 
-  RDS_DBInstance(:DBClusterInstanceWriter) {
-    DBSubnetGroupName Ref(:DBClusterSubnetGroup)
-    DBParameterGroupName Ref(:DBInstanceParameterGroup)
-    DBClusterIdentifier Ref(:DBCluster)
-    Engine 'aurora-postgresql'
-    EngineVersion engine_version unless engine_version.nil?
-    AutoMinorVersionUpgrade minor_upgrade unless minor_upgrade.nil?
-    PreferredMaintenanceWindow writer_maintenance_window unless writer_maintenance_window.nil?
-    PubliclyAccessible 'false'
-    DBInstanceClass Ref(:WriterInstanceType)
-    Tags aurora_tags
-  }
+  if engine_mode == 'serverless'
+    RDS_DBInstance(:ServerlessDBInstance) {
+      Engine 'aurora-postgresql'
+      DBInstanceClass 'db.serverless'
+      DBClusterIdentifier Ref(:DBCluster)
+    }
 
-  reader_maintenance_window = external_parameters.fetch(:reader_maintenance_window, nil)
+  else
+    Condition("CreateReaderRecord", FnAnd([FnEquals(Ref("EnableReader"), 'true'), Condition('CreateHostRecord')]))
+    Condition("EnableReader", FnEquals(Ref("EnableReader"), 'true'))
+
+    RDS_DBInstance(:DBClusterInstanceWriter) {
+      DBSubnetGroupName Ref(:DBClusterSubnetGroup)
+      DBParameterGroupName Ref(:DBInstanceParameterGroup)
+      DBClusterIdentifier Ref(:DBCluster)
+      Engine 'aurora-postgresql'
+      EngineVersion engine_version unless engine_version.nil?
+      AutoMinorVersionUpgrade minor_upgrade unless minor_upgrade.nil?
+      PreferredMaintenanceWindow writer_maintenance_window unless writer_maintenance_window.nil?
+      PubliclyAccessible 'false'
+      DBInstanceClass Ref(:WriterInstanceType)
+      Tags aurora_tags
+    }
 
-  RDS_DBInstance(:DBClusterInstanceReader) {
-    Condition(:EnableReader)
-    DBSubnetGroupName Ref(:DBClusterSubnetGroup)
-    DBParameterGroupName Ref(:DBInstanceParameterGroup)
-    DBClusterIdentifier Ref(:DBCluster)
-    Engine 'aurora-postgresql'
-    EngineVersion engine_version unless engine_version.nil?
-    AutoMinorVersionUpgrade minor_upgrade unless minor_upgrade.nil?
-    PreferredMaintenanceWindow reader_maintenance_window unless reader_maintenance_window.nil?
-    PubliclyAccessible 'false'
-    DBInstanceClass Ref(:ReaderInstanceType)
-    Tags aurora_tags
-  }
+    reader_maintenance_window = external_parameters.fetch(:reader_maintenance_window, nil)
+
+    RDS_DBInstance(:DBClusterInstanceReader) {
+      Condition(:EnableReader)
+      DBSubnetGroupName Ref(:DBClusterSubnetGroup)
+      DBParameterGroupName Ref(:DBInstanceParameterGroup)
+      DBClusterIdentifier Ref(:DBCluster)
+      Engine 'aurora-postgresql'
+      EngineVersion engine_version unless engine_version.nil?
+      AutoMinorVersionUpgrade minor_upgrade unless minor_upgrade.nil?
+      PreferredMaintenanceWindow reader_maintenance_window unless reader_maintenance_window.nil?
+      PubliclyAccessible 'false'
+      DBInstanceClass Ref(:ReaderInstanceType)
+      Tags aurora_tags
+    }
 
-  Route53_RecordSet(:DBClusterReaderRecord) {
-    Condition(:CreateReaderRecord)
-    HostedZoneName FnSub("#{external_parameters[:dns_format]}.")
-    Name FnSub("#{external_parameters[:hostname_read_endpoint]}.#{external_parameters[:dns_format]}.")
-    Type 'CNAME'
-    TTL '60'
-    ResourceRecords [ FnGetAtt('DBCluster','ReadEndpoint.Address') ]
-  }
+    Route53_RecordSet(:DBClusterReaderRecord) {
+      Condition(:CreateReaderRecord)
+      HostedZoneName FnSub("#{external_parameters[:dns_format]}.")
+      Name FnSub("#{external_parameters[:hostname_read_endpoint]}.#{external_parameters[:dns_format]}.")
+      Type 'CNAME'
+      TTL '60'
+      ResourceRecords [ FnGetAtt('DBCluster','ReadEndpoint.Address') ]
+    }
+  end
 
   Route53_RecordSet(:DBHostRecord) {
     Condition(:CreateHostRecord)

spec/cloudwatch_log_exports_spec.rb

@@ -95,6 +95,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq(12.1)
+      end
+
       it "to have property DBClusterParameterGroupName" do
           expect(resource["Properties"]["DBClusterParameterGroupName"]).to eq({"Ref"=>"DBClusterParameterGroup"})
       end
@@ -177,6 +181,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq(12.1)
+      end
+
       it "to have property PubliclyAccessible" do
           expect(resource["Properties"]["PubliclyAccessible"]).to eq("false")
       end
@@ -214,6 +222,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq(12.1)
+      end
+
       it "to have property PubliclyAccessible" do
           expect(resource["Properties"]["PubliclyAccessible"]).to eq("false")
       end
@@ -236,11 +248,11 @@
       end
 
       it "to have property HostedZoneName" do
-          expect(resource["Properties"]["HostedZoneName"]).to eq({"Fn::Join"=>["", [{"Ref"=>"EnvironmentName"}, ".", {"Ref"=>"DnsDomain"}, "."]]})
+          expect(resource["Properties"]["HostedZoneName"]).to eq({"Fn::Sub"=>"${EnvironmentName}.${DnsDomain}."})
       end
 
       it "to have property Name" do
-          expect(resource["Properties"]["Name"]).to eq({"Fn::Join"=>["", ["aurora2pg-read", ".", {"Ref"=>"EnvironmentName"}, ".", {"Ref"=>"DnsDomain"}, "."]]})
+          expect(resource["Properties"]["Name"]).to eq({"Fn::Sub"=>"aurora2pg-read.${EnvironmentName}.${DnsDomain}."})
       end
 
       it "to have property Type" do
@@ -265,11 +277,11 @@
       end
 
       it "to have property HostedZoneName" do
-          expect(resource["Properties"]["HostedZoneName"]).to eq({"Fn::Join"=>["", [{"Ref"=>"EnvironmentName"}, ".", {"Ref"=>"DnsDomain"}, "."]]})
+          expect(resource["Properties"]["HostedZoneName"]).to eq({"Fn::Sub"=>"${EnvironmentName}.${DnsDomain}."})
       end
 
       it "to have property Name" do
-          expect(resource["Properties"]["Name"]).to eq({"Fn::Join"=>["", ["aurora2pg", ".", {"Ref"=>"EnvironmentName"}, ".", {"Ref"=>"DnsDomain"}, "."]]})
+          expect(resource["Properties"]["Name"]).to eq({"Fn::Sub"=>"aurora2pg.${EnvironmentName}.${DnsDomain}."})
       end
 
       it "to have property Type" do

spec/database_name_parameter_spec.rb

@@ -95,6 +95,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq(12.1)
+      end
+
       it "to have property DBClusterParameterGroupName" do
           expect(resource["Properties"]["DBClusterParameterGroupName"]).to eq({"Ref"=>"DBClusterParameterGroup"})
       end
@@ -181,6 +185,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq(12.1)
+      end
+
       it "to have property PubliclyAccessible" do
           expect(resource["Properties"]["PubliclyAccessible"]).to eq("false")
       end
@@ -218,6 +226,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq(12.1)
+      end
+
       it "to have property PubliclyAccessible" do
           expect(resource["Properties"]["PubliclyAccessible"]).to eq("false")
       end

spec/database_parameters_spec.rb

@@ -95,6 +95,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq(12.1)
+      end
+
       it "to have property DBClusterParameterGroupName" do
           expect(resource["Properties"]["DBClusterParameterGroupName"]).to eq({"Ref"=>"DBClusterParameterGroup"})
       end
@@ -177,6 +181,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq(12.1)
+      end
+
       it "to have property PubliclyAccessible" do
           expect(resource["Properties"]["PubliclyAccessible"]).to eq("false")
       end
@@ -214,6 +222,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq(12.1)
+      end
+
       it "to have property PubliclyAccessible" do
           expect(resource["Properties"]["PubliclyAccessible"]).to eq("false")
       end

spec/default_spec.rb

@@ -95,6 +95,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq("9.6.12")
+      end
+
       it "to have property DBClusterParameterGroupName" do
           expect(resource["Properties"]["DBClusterParameterGroupName"]).to eq({"Ref"=>"DBClusterParameterGroup"})
       end
@@ -177,6 +181,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq("9.6.12")
+      end
+
       it "to have property PubliclyAccessible" do
           expect(resource["Properties"]["PubliclyAccessible"]).to eq("false")
       end
@@ -214,6 +222,10 @@
           expect(resource["Properties"]["Engine"]).to eq("aurora-postgresql")
       end
 
+      it "to have property EngineVersion" do
+          expect(resource["Properties"]["EngineVersion"]).to eq("9.6.12")
+      end
+
       it "to have property PubliclyAccessible" do
           expect(resource["Properties"]["PubliclyAccessible"]).to eq("false")
       end