feat: Cluster resource Tagg - Private Endpoint Service (#126)

Co-authored-by: TSowbaranika <[email protected]>

Author: Adelmar92

API.md

@@ -0,0 +1,54 @@
+import * as cdk from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+import { CfnServerlessPrivateEndpoint,  CfnServerlessPrivateEndpointProps,AwsPrivateEndpointConfig} from 'awscdk-resources-mongodbatlas';
+
+interface AtlasStackProps {
+  readonly projectId: string;
+  readonly profile: string;
+  readonly instanceName: string;
+  readonly comment : string;
+  readonly createAndAssignAwsPrivateEndpoint: boolean;
+}
+
+export class CdkTestingStack extends cdk.Stack {
+  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
+    super(scope, id, props);
+
+    const atlasProps = this.getContextProps();
+
+    const awsPrivateEndpointConfig : AwsPrivateEndpointConfig = {
+        vpcId: "vpc-078fe50fc2313c001",
+        subnetIds:["subnet-0a2f7a198e5d6d6a6"],
+        region:""
+    }
+    const myServerlessInstance = new CfnServerlessPrivateEndpoint(this, 'ServerlessPrivateEndpointWithAws', {
+      projectId: atlasProps.projectId,
+      profile:  atlasProps.profile,
+      instanceName: atlasProps.instanceName,
+      comment : atlasProps.comment,
+      createAndAssignAwsPrivateEndpoint:atlasProps.createAndAssignAwsPrivateEndpoint,
+      awsPrivateEndpointConfigurationProperties: awsPrivateEndpointConfig
+    });
+  }
+
+  getContextProps(): AtlasStackProps {
+    const projectId = this.node.tryGetContext('projectId');
+    if (!projectId){
+      throw "No context value specified for orgId. Please specify via the cdk context."
+    }
+    
+    const profile = this.node.tryGetContext('profile') ?? 'default';
+    const instanceName = this.node.tryGetContext('instanceName');
+    const comment = this.node.tryGetContext('comment');
+    const createAndAssignAwsPrivateEndpoint = this.node.tryGetContext('createAndAssignAwsPrivateEndpoint') ?? false;
+
+
+    return {
+      projectId,
+      profile,
+      instanceName,
+      comment,
+      createAndAssignAwsPrivateEndpoint
+    }
+  }
+}

examples/l1-resources/serverless-private-endpoints.ts

@@ -111,6 +111,7 @@ export {
   CfnCluster,
   CfnClusterPropsEncryptionAtRestProvider,
   AdvancedRegionConfigProviderName,
+  Tag,
 } from "./l1-resources/clusters";
 
 export {

src/index.ts

@@ -49,6 +49,12 @@ const clusterRes = new CfnCluster(this, 'ClusterResource', {
       clusterType: atlasProps.clusterType,
       backupEnabled: true,
       pitEnabled: false,
+      tags: [
+        {
+          key: "env",
+          value: "development",
+        },
+      ],
       replicationSpecs: [{
         numShards: 1,
         advancedRegionConfigs: [{

src/l1-resources/clusters/README.md

@@ -124,6 +124,13 @@ export interface CfnClusterProps {
    * @schema CfnClusterProps#TerminationProtectionEnabled
    */
   readonly terminationProtectionEnabled?: boolean;
+
+  /**
+   * List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global replica sets and sharded clusters, this array has one object representing where your clusters nodes deploy.
+   *
+   * @schema CfnClusterProps#Tags
+   */
+  readonly tags?: Tag[];
 }
 
 /**
@@ -156,6 +163,7 @@ export function toJson_CfnClusterProps(
     RootCertType: obj.rootCertType,
     VersionReleaseSystem: obj.versionReleaseSystem,
     TerminationProtectionEnabled: obj.terminationProtectionEnabled,
+    Tags: obj.tags?.map((y) => toJson_Tag(y)),
   };
   // filter undefined values
   return Object.entries(result).reduce(
@@ -526,6 +534,49 @@ export function toJson_AdvancedReplicationSpec(
 }
 /* eslint-enable max-len, quote-props */
 
+/**
+ * Advanced configuration details to add for one cluster in the specified project.
+ *
+ * @schema tag
+ */
+export interface Tag {
+  /**
+   * Constant that defines the set of the tag. For example, environment in the environment : production tag.
+   *
+   * @schema tag#Key
+   */
+  readonly key?: string;
+
+  /**
+   * Variable that belongs to the set of the tag. For example, production in the environment : production tag.
+   *
+   * @schema tag#Value
+   */
+  readonly value?: string;
+}
+
+/**
+ * Converts an object of type 'Tag' to JSON representation.
+ */
+/* eslint-disable max-len, quote-props */
+export function toJson_Tag(
+  obj: Tag | undefined
+): Record<string, any> | undefined {
+  if (obj === undefined) {
+    return undefined;
+  }
+  const result = {
+    Key: obj.key,
+    Value: obj.value,
+  };
+  // filter undefined values
+  return Object.entries(result).reduce(
+    (r, i) => (i[1] === undefined ? r : { ...r, [i[0]]: i[1] }),
+    {}
+  );
+}
+/* eslint-enable max-len, quote-props */
+
 /**
  * Hardware specifications for nodes set for a given region. Each regionConfigs object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each regionConfigs object must have either an analyticsSpecs object, electableSpecs object, or readOnlySpecs object. Tenant clusters only require electableSpecs. Dedicated clusters can specify any of these specifications, but must have at least one electableSpecs object within a replicationSpec. Every hardware specification must use the same instanceSize.
  *

src/l1-resources/clusters/index.ts

@@ -0,0 +1,53 @@
+import * as cdk from "aws-cdk-lib";
+import { CfnCluster } from "./index";
+
+const app = new cdk.App();
+const stack = new cdk.Stack(app, "atlas-test-cdk-test", {
+  env: {
+    region: process.env.CDK_DEFAULT_REGION,
+    account: process.env.CDK_DEFAULT_ACCOUNT,
+  },
+});
+
+const atlasProject = "";
+
+new CfnCluster(stack, "AtlasCluster", {
+  projectId: atlasProject,
+  name: "TestCluster",
+  mongoDbMajorVersion: "6.0",
+  clusterType: "REPLICASET",
+  backupEnabled: true,
+  tags: [
+    {
+      key: "env",
+      value: "development",
+    },
+  ],
+  replicationSpecs: [
+    {
+      numShards: 1,
+      advancedRegionConfigs: [
+        {
+          autoScaling: {
+            diskGb: {
+              enabled: true,
+            },
+            compute: {
+              enabled: true,
+              scaleDownEnabled: false,
+              maxInstanceSize: "M40",
+            },
+          },
+          electableSpecs: {
+            ebsVolumeType: "PROVISIONED",
+            instanceSize: "M30",
+            nodeCount: 3,
+            diskIops: "2000",
+          },
+          priority: 7,
+          regionName: "EU_WEST_1",
+        },
+      ],
+    },
+  ],
+});

src/l1-resources/clusters/integ.default.ts

@@ -0,0 +1,78 @@
+# serverless-private-endpoint
+
+The official [MongoDB Atlas](https://www.mongodb.com/) AWS CDK resource for Node.js.
+
+> AWS CDK [L1 construct] and data structures for the [AWS CloudFormation Registry] type `MongoDB::Atlas::ServerlessPrivateEndpoint` v1.0.0.
+
+[l1 construct]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html
+[aws cloudformation registry]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html
+
+## Description
+
+Returns, adds, edits, and removes serverless instances.
+
+## MongoDB Atlas API Docs
+
+For more information about the API refer to: [API Endpoints](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/serverless-private-endpoints)
+
+## Usage
+
+In order to use this library, you will need to activate this AWS CloudFormation Registry type in your account. You can do this via the AWS Management Console or using the [AWS CLI](https://aws.amazon.com/cli/) using the following command:
+
+```sh
+aws cloudformation activate-type \
+  --type-name MongoDB::Atlas::ServerlessPrivateEndpoint \
+  --publisher-id bb989456c78c398a858fef18f2ca1bfc1fbba082 \
+  --type RESOURCE \
+  --execution-role-arn ROLE-ARN
+```
+
+Alternatively:
+
+```sh
+aws cloudformation activate-type \
+  --public-type-arn arn:aws:cloudformation:us-east-1::type/resource/bb989456c78c398a858fef18f2ca1bfc1fbba082/MongoDB-Atlas-ServerlessPrivateEndpoint \
+  --execution-role-arn ROLE-ARN
+```
+
+You can find more information about activating this type in the [AWS CloudFormation documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html).
+
+## Example: [serverless-private-endpoint.ts](../../../examples/l1-resources/serverless-private-endpoint.ts)
+
+```ts
+import {
+  CfnServerlessPrivateEndpoint,
+  CfnServerlessPrivateEndpointProps
+} from 'awscdk-resources-mongodbatlas'
+
+const myServerlessPrivateEndpoint = new CfnServerlessPrivateEndpoint(
+  stack,
+  'serverless-stack',
+  {
+    profile: 'default',
+    instanceName: 'ServerlessPrivateEndpoint0',
+    projectId: '',
+    comment: 'this is a comment',
+    createAndAssignAwsPrivateEndpoint: true,
+    awsPrivateEndpointConfigurationProperties: {
+      vpcId: 'vpc-',
+      subnetIds: ['subnet-'],
+      region: 'us-east-1'
+    }
+  }
+)
+```
+
+## Feedback
+
+This library is auto-generated and published to all supported programming languages by the [cdklabs/cdk-cloudformation] project based on the API schema published for `MongoDB::Atlas::ServerlessPrivateEndpoint`.
+
+- Issues related to this generated library should be [reported here](https://github.com/cdklabs/cdk-cloudformation/issues/new?title=Issue+with+%40cdk-cloudformation%2Fmongodb-atlas-ServerlessPrivateEndpoint+v1.0.0).
+- Issues related to `MongoDB::Atlas::ServerlessPrivateEndpoint` should be reported to the [publisher](https://github.com/mongodb/mongodbatlas-cloudformation-resources/issues).
+- Feature requests should be [reported here](https://feedback.mongodb.com/forums/924145-atlas?category_id=392596)
+
+[cdklabs/cdk-cloudformation]: https://github.com/cdklabs/cdk-cloudformation
+
+## License
+
+Distributed under the Apache-2.0 License.