|
| 1 | +# cluster |
| 2 | + |
| 3 | +The official [MongoDB Atlas](https://www.mongodb.com/) AWS CDK resource for Node.js. |
| 4 | + |
| 5 | +> AWS CDK [L1 construct] and data structures for the [AWS CloudFormation Registry] type `MongoDB::Atlas::Cluster` v1.0.0. |
| 6 | +
|
| 7 | +[L1 construct]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html |
| 8 | +[AWS CloudFormation Registry]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html |
| 9 | + |
| 10 | +## Description |
| 11 | + |
| 12 | +Atlas Data Lake takes snapshots of your Atlas cluster, so you can easily analyze data over time. As data is ingested, Atlas Data Lake reformats, creates partition indexes, and partitions data, creating an isolated workload ready to support large and complex queries without impacting your production application. |
| 13 | + |
| 14 | +## MongoDB Atlas API Docs |
| 15 | + |
| 16 | +For more information about the API refer to: [API Endpoints](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline) |
| 17 | + |
| 18 | +## Usage |
| 19 | + |
| 20 | +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: |
| 21 | + |
| 22 | +```sh |
| 23 | +aws cloudformation activate-type \ |
| 24 | + --type-name MongoDB::Atlas::DataLakePipeline \ |
| 25 | + --publisher-id bb989456c78c398a858fef18f2ca1bfc1fbba082 \ |
| 26 | + --type RESOURCE \ |
| 27 | + --execution-role-arn ROLE-ARN |
| 28 | +``` |
| 29 | + |
| 30 | +Alternatively: |
| 31 | + |
| 32 | +```sh |
| 33 | +aws cloudformation activate-type \ |
| 34 | + --public-type-arn arn:aws:cloudformation:us-east-1::type/resource/bb989456c78c398a858fef18f2ca1bfc1fbba082/MongoDB-Atlas-Cluster \ |
| 35 | + --execution-role-arn ROLE-ARN |
| 36 | +``` |
| 37 | + |
| 38 | +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). |
| 39 | + |
| 40 | + |
| 41 | +## Example: [cluster.ts](../../../examples/l1-resources/dataLakePipeline.ts) |
| 42 | +```ts |
| 43 | +import { CfnDataLakePipeline } from 'awscdk-resources-mongodbatlas'; |
| 44 | + |
| 45 | +const clusterRes = new CfnDataLakePipeline(this, 'ClusterResource', { |
| 46 | + name: atlasProps.clusterName, |
| 47 | + projectId: projectRes.attrId, |
| 48 | + profile: atlasProps.profile, |
| 49 | + clusterType: atlasProps.clusterType, |
| 50 | + backupEnabled: true, |
| 51 | + pitEnabled: false, |
| 52 | + replicationSpecs: [{ |
| 53 | + numShards: 1, |
| 54 | + advancedRegionConfigs: [{ |
| 55 | + autoScaling: { |
| 56 | + diskGb: { |
| 57 | + enabled: true, |
| 58 | + }, |
| 59 | + compute: { |
| 60 | + enabled: false, |
| 61 | + scaleDownEnabled: false, |
| 62 | + }, |
| 63 | + }, |
| 64 | + analyticsSpecs: { |
| 65 | + ebsVolumeType: "STANDARD", |
| 66 | + instanceSize: atlasProps.instanceSize, |
| 67 | + nodeCount: 3, |
| 68 | + }, |
| 69 | + electableSpecs: { |
| 70 | + ebsVolumeType: "STANDARD", |
| 71 | + instanceSize: atlasProps.instanceSize, |
| 72 | + nodeCount: 3, |
| 73 | + }, |
| 74 | + readOnlySpecs: { |
| 75 | + ebsVolumeType: "STANDARD", |
| 76 | + instanceSize: atlasProps.instanceSize, |
| 77 | + nodeCount: 3, |
| 78 | + }, |
| 79 | + priority: 7, |
| 80 | + regionName: atlasProps.region, |
| 81 | + }] |
| 82 | + }] |
| 83 | + }); |
| 84 | + |
| 85 | +``` |
| 86 | + |
| 87 | +## Feedback |
| 88 | + |
| 89 | +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::Cluster`. |
| 90 | + |
| 91 | +* 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-cluster+v1.0.0). |
| 92 | +* Issues related to `MongoDB::Atlas::Cluster` should be reported to the [publisher](https://github.com/mongodb/mongodbatlas-cloudformation-resources/issues). |
| 93 | +* Feature requests should be [reported here](https://feedback.mongodb.com/forums/924145-atlas?category_id=392596) |
| 94 | + |
| 95 | +[cdklabs/cdk-cloudformation]: https://github.com/cdklabs/cdk-cloudformation |
| 96 | + |
| 97 | +## License |
| 98 | + |
| 99 | +Distributed under the Apache-2.0 License. |
0 commit comments