feat(DBInstance): add support for read only properties of DBInstance for AutomaticRestartTime, PercentProgress, ResumeFullAutomationModeTime, SecondaryAvailabilityZone, StatusInfos

Author: levincent51

aws-rds-dbinstance/aws-rds-dbinstance.json

@@ -54,6 +54,28 @@
         "RoleArn"
       ]
     },
+    "DBInstanceStatusInfo": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "Message": {
+          "type": "string",
+          "description": "Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank."
+        },
+        "Normal": {
+          "type": "boolean",
+          "description": "Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE)."
+        },
+        "Status": {
+          "type": "string",
+          "description": "The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated."
+        },
+        "StatusType": {
+          "type": "string",
+          "description": "This value is currently \"read replication.\""
+        }
+      }
+    },
     "ProcessorFeature": {
       "type": "object",
       "additionalProperties": false,
@@ -143,6 +165,10 @@
       "minimum": 1,
       "description": "The number of days for which automated cross-region replicated backups are retained. If this value is unset, default to BackupRetentionPeriod."
     },
+    "AutomaticRestartTime": {
+      "type": "string",
+      "description": "The time when a stopped DB instance is restarted automatically."
+    },
     "AvailabilityZone": {
       "type": "string",
       "description": "The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones."
@@ -389,6 +415,10 @@
       "type": "string",
       "description": "Indicates that the DB instance should be associated with the specified option group."
     },
+    "PercentProgress": {
+      "type": "string",
+      "description": "The progress of the storage optimization operation as a percentage."
+    },
     "PerformanceInsightsKMSKeyId": {
       "type": "string",
       "description": "The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key."
@@ -449,6 +479,14 @@
       "type": "string",
       "format": "date-time"
     },
+    "ResumeFullAutomationModeTime": {
+      "type": "string",
+      "description": "The duration in minutes to pause automation. Valid values: 60 (default) to 1,440."
+    },
+    "SecondaryAvailabilityZone": {
+      "type": "string",
+      "description": "If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support."
+    },
     "SourceDBClusterIdentifier": {
       "description": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.",
       "type": "string"
@@ -469,6 +507,13 @@
       "type": "string",
       "description": "The ID of the region that contains the source DB instance for the Read Replica."
     },
+    "StatusInfos": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/DBInstanceStatusInfo"
+      },
+      "description": "The status of a read replica. If the DB instance isn't a read replica, the value is blank."
+    },
     "StorageEncrypted": {
       "type": "boolean",
       "description": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted."
@@ -602,6 +647,7 @@
     "/properties/ApplyImmediately"
   ],
   "readOnlyProperties": [
+    "/properties/AutomaticRestartTime",
     "/properties/CertificateDetails",
     "/properties/CertificateDetails/CAIdentifier",
     "/properties/CertificateDetails/ValidTill",
@@ -620,8 +666,12 @@
     "/properties/ListenerEndpoint/Port",
     "/properties/ListenerEndpoint/HostedZoneId",
     "/properties/MasterUserSecret/SecretArn",
+    "/properties/PercentProgress",
     "/properties/ReadReplicaDBClusterIdentifiers",
-    "/properties/ReadReplicaDBInstanceIdentifiers"
+    "/properties/ReadReplicaDBInstanceIdentifiers",
+    "/properties/ResumeFullAutomationModeTime",
+    "/properties/SecondaryAvailabilityZone",
+    "/properties/StatusInfo"
   ],
   "primaryIdentifier": [
     "/properties/DBInstanceIdentifier"

aws-rds-dbinstance/src/main/java/software/amazon/rds/dbinstance/Translator.java

@@ -877,6 +877,7 @@ public static ResourceModel.ResourceModelBuilder translateDbInstanceFromSdkBuild
                 .allocatedStorage(allocatedStorage)
                 .associatedRoles(translateAssociatedRolesFromSdk(dbInstance.associatedRoles()))
                 .automaticBackupReplicationRegion(automatedReplicationRegion)
+                .automaticRestartTime(translateInstantToString(dbInstance.automaticRestartTime()))
                 .autoMinorVersionUpgrade(dbInstance.autoMinorVersionUpgrade())
                 .availabilityZone(dbInstance.availabilityZone())
                 .backupRetentionPeriod(dbInstance.backupRetentionPeriod())
@@ -914,10 +915,10 @@ public static ResourceModel.ResourceModelBuilder translateDbInstanceFromSdkBuild
                 .engineLifecycleSupport(dbInstance.engineLifecycleSupport())
                 .engineVersion(dbInstance.engineVersion())
                 .iops(dbInstance.iops())
-                .instanceCreateTime(dbInstance.instanceCreateTime() == null ? null : dbInstance.instanceCreateTime().toString())
+                .instanceCreateTime(translateInstantToString(dbInstance.instanceCreateTime()))
                 .isStorageConfigUpgradeAvailable(dbInstance.isStorageConfigUpgradeAvailable())
                 .kmsKeyId(dbInstance.kmsKeyId())
-                .latestRestorableTime(dbInstance.latestRestorableTime() == null ? null : dbInstance.latestRestorableTime().toString())
+                .latestRestorableTime(translateInstantToString(dbInstance.latestRestorableTime()))
                 .licenseModel(dbInstance.licenseModel())
                 .listenerEndpoint(listenerEndpoint)
                 .manageMasterUserPassword(dbInstance.masterUserSecret() != null)
@@ -930,6 +931,7 @@ public static ResourceModel.ResourceModelBuilder translateDbInstanceFromSdkBuild
                 .ncharCharacterSetName(dbInstance.ncharCharacterSetName())
                 .networkType(dbInstance.networkType())
                 .optionGroupName(optionGroupName)
+                .percentProgress(dbInstance.percentProgress())
                 .performanceInsightsKMSKeyId(dbInstance.performanceInsightsKMSKeyId())
                 .performanceInsightsRetentionPeriod(dbInstance.performanceInsightsRetentionPeriod())
                 .port(port == null ? null : port.toString())
@@ -941,8 +943,11 @@ public static ResourceModel.ResourceModelBuilder translateDbInstanceFromSdkBuild
                 .sourceDBClusterIdentifier(dbInstance.readReplicaSourceDBClusterIdentifier())
                 .readReplicaDBClusterIdentifiers(translateReadReplicaDBClusterIdentifiers(dbInstance.readReplicaDBClusterIdentifiers()))
                 .readReplicaDBInstanceIdentifiers(translateReadReplicaDBInstanceIdentifiers(dbInstance.readReplicaDBInstanceIdentifiers()))
+                .resumeFullAutomationModeTime(translateInstantToString(dbInstance.resumeFullAutomationModeTime()))
                 .replicaMode(dbInstance.replicaModeAsString())
+                .secondaryAvailabilityZone(dbInstance.secondaryAvailabilityZone())
                 .sourceDBInstanceIdentifier(dbInstance.readReplicaSourceDBInstanceIdentifier())
+                .statusInfos(translateStatusInfosFromSdk(dbInstance.statusInfos()))
                 .storageEncrypted(dbInstance.storageEncrypted())
                 .storageThroughput(dbInstance.storageThroughput())
                 .storageType(dbInstance.storageType())
@@ -974,6 +979,10 @@ public static List<String> translateEnableCloudwatchLogsExport(final Collection<
         return enabledCloudwatchLogsExports == null ? null : new ArrayList<>(enabledCloudwatchLogsExports);
     }
 
+    private static String translateInstantToString(final Instant instant) {
+        return instant == null ? null : instant.toString();
+    }
+
     public static List<String> translateReadReplicaDBClusterIdentifiers(final Collection<String> readReplicaDBClusterIdentifiers) {
         return readReplicaDBClusterIdentifiers == null ? null : new ArrayList<>(readReplicaDBClusterIdentifiers);
     }
@@ -982,6 +991,20 @@ public static List<String> translateReadReplicaDBInstanceIdentifiers(final Colle
         return readReplicaDBInstanceIdentifiers == null ? null : new ArrayList<>(readReplicaDBInstanceIdentifiers);
     }
 
+    public static List<DBInstanceStatusInfo> translateStatusInfosFromSdk(
+            final Collection<software.amazon.awssdk.services.rds.model.DBInstanceStatusInfo> statusInfos
+    ) {
+        return streamOfOrEmpty(statusInfos)
+                .map(statusInfo -> DBInstanceStatusInfo
+                        .builder()
+                        .message(statusInfo.message())
+                        .normal(statusInfo.normal())
+                        .status(statusInfo.status())
+                        .statusType(statusInfo.statusType())
+                        .build())
+                .collect(Collectors.toList());
+    }
+
     public static List<String> translateVpcSecurityGroupsFromSdk(
             final Collection<software.amazon.awssdk.services.rds.model.VpcSecurityGroupMembership> vpcSecurityGroups
     ) {

aws-rds-dbinstance/src/test/java/software/amazon/rds/dbinstance/ListHandlerTest.java

@@ -104,6 +104,7 @@ public void handleRequest_Success() {
                 .vPCSecurityGroups(Collections.emptyList())
                 .readReplicaDBClusterIdentifiers(Collections.emptyList())
                 .readReplicaDBInstanceIdentifiers(Collections.emptyList())
+                .statusInfos(Collections.emptyList())
                 .dBInstanceIdentifier(DB_INSTANCE_IDENTIFIER)
                 .build();
 

aws-rds-dbinstance/src/test/java/software/amazon/rds/dbinstance/TranslatorTest.java

@@ -1017,6 +1017,30 @@ public void translateDbInstanceFromSdk_setLatestRestorableTime() {
         assertThat(model.getLatestRestorableTime()).isEqualTo(latestRestorableTime.toString());
     }
 
+    @Test
+    public void translateDbInstanceFromSdk_setAutomaticRestartTime() {
+        final Instant automaticRestartTime = Instant.parse("2023-01-09T15:55:37.123Z");
+
+        final DBInstance dbInstance = DBInstance.builder()
+                .automaticRestartTime(automaticRestartTime)
+                .build();
+
+        final ResourceModel model = Translator.translateDbInstanceFromSdk(dbInstance);
+        assertThat(model.getAutomaticRestartTime()).isEqualTo(automaticRestartTime.toString());
+    }
+
+    @Test
+    public void translateDbInstanceFromSdk_setResumeFullAutomationModeTime() {
+        final Instant resumeFullAutomationModeTime = Instant.parse("2023-01-09T15:55:37.123Z");
+
+        final DBInstance dbInstance = DBInstance.builder()
+                .resumeFullAutomationModeTime(resumeFullAutomationModeTime)
+                .build();
+
+        final ResourceModel model = Translator.translateDbInstanceFromSdk(dbInstance);
+        assertThat(model.getResumeFullAutomationModeTime()).isEqualTo(resumeFullAutomationModeTime.toString());
+    }
+
     @Test
     public void translateDbInstanceFromSdk_setListenerEndpoint() {
         final Endpoint listenerEndpoint = Endpoint.builder()
@@ -1056,6 +1080,27 @@ public void translateDbInstanceFromSdk_readReplicaDBInstanceIdentifiers() {
         assertThat(model.getReadReplicaDBInstanceIdentifiers()).containsExactly("instance-replica-1", "instance-replica-2");
     }
 
+    @Test
+    public void translateDbInstanceFromSdk_statusInfos() {
+        final software.amazon.awssdk.services.rds.model.DBInstanceStatusInfo statusInfo =
+                software.amazon.awssdk.services.rds.model.DBInstanceStatusInfo.builder()
+                        .message("test message")
+                        .normal(true)
+                        .status("replicating")
+                        .statusType("read replication")
+                        .build();
+
+        final DBInstance dbInstance = DBInstance.builder()
+                .statusInfos(statusInfo)
+                .build();
+
+        final ResourceModel model = Translator.translateDbInstanceFromSdk(dbInstance);
+        assertThat(model.getStatusInfos().get(0).getMessage()).isEqualTo("test message");
+        assertThat(model.getStatusInfos().get(0).getNormal()).isTrue();
+        assertThat(model.getStatusInfos().get(0).getStatus()).isEqualTo("replicating");
+        assertThat(model.getStatusInfos().get(0).getStatusType()).isEqualTo("read replication");
+    }
+
     @Test
     public void translateDbInstanceFromSdk_port_getFromEndpoint() {
         final DBInstance dbInstance = DBInstance.builder()