fix!: INTMDB-1175 fixed cloud Backup snapshot primary identifier (#149)

Author: Adelmar92

API.md

@@ -1,6 +1,6 @@
 import * as cdk from 'aws-cdk-lib';
 import { Construct } from 'constructs';
-import { CfnCloudBackupSnapshot } from 'awscdk-resources-mongodbatlas';
+import { CfnCloudBackupSnapshot,CfnCloudBackupSnapshotPropsInstanceType } from 'awscdk-resources-mongodbatlas';
 
 interface AtlasStackProps {
   readonly projId: string;
@@ -15,8 +15,9 @@ export class CdkTestingStack extends cdk.Stack {
 
     const atlasProps = this.getContextProps();
 
-    const cloudBackupSnapshot = new CfnCloudBackupSnapshot(this, 'CloudBackupSnapshot', {
-        clusterName: atlasProps.clusterName,
+    new CfnCloudBackupSnapshot(this, 'CloudBackupSnapshot', {
+        instanceName: atlasProps.clusterName,
+        instanceType: CfnCloudBackupSnapshotPropsInstanceType.CLUSTER,
         profile: atlasProps.profile,
         projectId: atlasProps.projId,
         description: 'Snapshot created with CDK',

examples/l1-resources/cloud-backup-snapshot.ts

@@ -91,6 +91,7 @@ export {
   CfnCloudBackupSnapshotProps,
   CfnCloudBackupSnapshotPropsFrequencyType,
   CfnCloudBackupSnapshotPropsSnapshotType,
+  CfnCloudBackupSnapshotPropsInstanceType,
 } from "./l1-resources/cloud-backup-snapshot";
 
 export {

src/index.ts

@@ -16,18 +16,18 @@ export interface CfnCloudBackupSnapshotProps {
   readonly profile?: string;
 
   /**
-   * Human-readable label that identifies the cluster.
+   * Type of instance specified on the Instance Name serverless or cluster
    *
-   * @schema CfnCloudBackupSnapshotProps#ClusterName
+   * @schema CfnCloudBackupSnapshotProps#InstanceType
    */
-  readonly clusterName: string;
+  readonly instanceType: CfnCloudBackupSnapshotPropsInstanceType;
 
   /**
-   * Human-readable label that identifies the serverless instance.
+   * The instance name of the Serverless/Cluster whose snapshot you want to restore or you want to retrieve restore snapshot.
    *
    * @schema CfnCloudBackupSnapshotProps#InstanceName
    */
-  readonly instanceName?: string;
+  readonly instanceName: string;
 
   /**
    * Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `"status": "onDemand"`.
@@ -126,7 +126,7 @@ export function toJson_CfnCloudBackupSnapshotProps(
   }
   const result = {
     Profile: obj.profile,
-    ClusterName: obj.clusterName,
+    InstanceType: obj.instanceType,
     InstanceName: obj.instanceName,
     Description: obj.description,
     FrequencyType: obj.frequencyType,
@@ -153,6 +153,18 @@ export function toJson_CfnCloudBackupSnapshotProps(
 }
 /* eslint-enable max-len, quote-props */
 
+/**
+ * Type of instance specified on the Instance Name serverless or cluster
+ *
+ * @schema CfnCloudBackupSnapshotPropsInstanceType
+ */
+export enum CfnCloudBackupSnapshotPropsInstanceType {
+  /** serverless */
+  SERVERLESS = "serverless",
+  /** cluster */
+  CLUSTER = "cluster",
+}
+
 /**
  * Human-readable label that identifies how often this snapshot triggers.
  *

src/l1-resources/cloud-backup-snapshot/index.ts

@@ -14,7 +14,10 @@
 
 import { App, Stack } from "aws-cdk-lib";
 import { Template } from "aws-cdk-lib/assertions";
-import { CfnCloudBackupSnapshot } from "../../../src/l1-resources/cloud-backup-snapshot";
+import {
+  CfnCloudBackupSnapshot,
+  CfnCloudBackupSnapshotPropsInstanceType,
+} from "../../../src/l1-resources/cloud-backup-snapshot";
 
 const RESOURCE_NAME = "MongoDB::Atlas::CloudBackupSnapshot";
 const PROJECT_ID = "testProjectId";
@@ -26,7 +29,8 @@ test("CloudBackupSnapshot construct should contain default properties", () => {
 
   new CfnCloudBackupSnapshot(stack, "testing-stack", {
     projectId: PROJECT_ID,
-    clusterName: CLUSTER_NAME,
+    instanceName: CLUSTER_NAME,
+    instanceType: CfnCloudBackupSnapshotPropsInstanceType.CLUSTER,
     description: "snapshot through cloud formation template",
     retentionInDays: 5,
   });
@@ -35,7 +39,8 @@ test("CloudBackupSnapshot construct should contain default properties", () => {
 
   template.hasResourceProperties(RESOURCE_NAME, {
     ProjectId: PROJECT_ID,
-    ClusterName: CLUSTER_NAME,
+    InstanceName: CLUSTER_NAME,
+    InstanceType: CfnCloudBackupSnapshotPropsInstanceType.CLUSTER,
     Description: "snapshot through cloud formation template",
     RetentionInDays: 5,
   });