Categorygithub.com/mongodb/awscdk-resources-mongodbatlas-go/awscdkresourcesmongodbatlas/v2
modulepackage
2.0.0
Repository: https://github.com/mongodb/awscdk-resources-mongodbatlas-go.git
Documentation: pkg.go.dev
Overview
Versions
4
Dependencies
9
Dependents
0
Files
37.3k SLOC

# README

MongoDB Atlas AWS CDK Resources

Code Health Package CDK npm version PyPI version NuGet version Maven Central Go Reference

View on Construct Hub

Use MongoDB Atlas AWS CDK (or Cloud Development Kit) constructs to manage MongoDB Atlas. The AWS CDK is a framework for defining infrastructure as code (IaC). It allows developers to write code in their preferred programming language, such as TypeScript for example, to define and deploy infrastructure. AWS CDK gets synthesized down into AWS CloudFormation templates at deployment so users no longer have to write or maintain YAML/JSON based CloudFormation templates.

Available Packages

NPM

The npm package is available at awscdk-resources-mongodbatlas

npm i awscdk-resources-mongodbatlas

PyPI

The PyPI package is available at awscdk-resources-mongodbatlas

pip install awscdk-resources-mongodbatlas

Nuget

The Nuget package is available at MongoDB.AWSCDKResourcesMongoDBAtlas

dotnet add package MongoDB.AWSCDKResourcesMongoDBAtlas --version 1.0.0

Maven

The Maven package is available at awscdk-resources-mongodbatlas

<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>awscdk-resources-mongodbatlas</artifactId>
    <version>1.0.0</version>
</dependency>

Go

The go package is generated into the github.com/mongodb/awscdk-resources-mongodbatlas-go package.

go get github.com/mongodb/awscdk-resources-mongodbatlas-go/awscdkresourcesmongodbatlas

Available Constructors

MongoDB Atlas AWS CDK Resources provides L1, L2 and L3 CDK constructors. Please, have a look at README.md for a full lists of constructors and examples.

Getting Started

See the cdk examples for how to setup prerequisites & get started with your first cluster, using our AWS CDK sample code. We also provide a quick guide on How to Deploy MongoDB Atlas with AWS CDK in TypeScript.

Support, Bugs, Feature Requests

Feature requests can be submitted at feedback.mongodb.com - just select "Atlas CloudFormation Resources" as the category or vote for an already suggested feature.

Support for the MongoDB Atlas Resource Provider for CloudFormation is provided under MongoDB Atlas support plans, starting with Developer. Please submit support questions within the Atlas UI. In addition, support questions submitted under the Issues section of this repo are also being monitored. Bugs should be filed under the Issues section of this repo.

MongoDB Atlas API Keys Credential Management

Atlas API keys Configuration are required for both CloudFormation and CDK resources, and this Atlas API key pair are provided as input by the use of a Profile

AWS CloudFormation limits Third Parties from using non-AWS API Keys as either hardcoded secrets in CloudFormation templates or via CDK, hence we now require all the users store MongoDB Atlas API Keys via AWS Secrets Manager.

NOTE: the process for configuring the PROFILE is the same and is required both for CloudFormation and CDK

1. Configure your MongoDB Atlas API Keys

You'll need to generate an API key pair (public and private keys) for your Atlas organization and configure them to grant CloudFormation access to your Atlas project. Refer to the Atlas documentation for detailed instructions.

2. Configure your Profile

To use Atlas CloudFormation resources, you must configure a "profile" with your API keys using AWS Secrets Manager.

The secret should follow this format:

SecretName: cfn/atlas/profile/{ProfileName}
SecretValue: {"PublicKey": "YourPublicKey", "PrivateKey": "YourPrivateKey"}

To create a new secret for a default profile, use the PROFILE SECRET TEMPLATE file provided in this repository.

Here are some examples of how to use this template:

example 1:

  ProfileName: default
  SecretName: cfn/atlas/profile/default
  SecretValue: {"PublicKey": "YourPublicKey", "PrivateKey": "YourPrivateKey"}

example 2:

  ProfileName: testProfile
  SecretName: cfn/atlas/profile/testProfile
  SecretValue: {"PublicKey": "YourPublicKey", "PrivateKey": "YourPrivateKey"}

Contributing

See our CONTRIBUTING.md guide.

# Packages

Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

# Functions

Checks if `x` is a construct.
Checks if `x` is a construct.
Checks if `x` is a construct.
Checks if `x` is a construct.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
No description provided by the author
Returns `true` if a construct is a stack element (i.e.
Check whether the given construct is a CfnResource.
Checks if `x` is a construct.
Checks if `x` is a construct.
Checks if `x` is a construct.
Checks if `x` is a construct.
Checks if `x` is a construct.
Creates an instance of AtlasBasic.
Creates an instance of AtlasBasic.
Creates an instance of AtlasBasicPrivateEndpoint.
Creates an instance of AtlasBasicPrivateEndpoint.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Creates an instance of AtlasServerlessBasic.
Creates an instance of AtlasServerlessBasic.
Create a new `MongoDB::Atlas::AlertConfiguration`.
Create a new `MongoDB::Atlas::AlertConfiguration`.
Create a new `MongoDB::Atlas::Auditing`.
Create a new `MongoDB::Atlas::Auditing`.
Create a new `MongoDB::Atlas::CloudBackUpRestoreJobs`.
Create a new `MongoDB::Atlas::CloudBackUpRestoreJobs`.
Create a new `MongoDB::Atlas::CloudBackupSchedule`.
Create a new `MongoDB::Atlas::CloudBackupSchedule`.
Create a new `MongoDB::Atlas::CloudBackupSnapshot`.
Create a new `MongoDB::Atlas::CloudBackupSnapshot`.
Create a new `MongoDB::Atlas::CloudBackupSnapshotExportBucket`.
Create a new `MongoDB::Atlas::CloudBackupSnapshotExportBucket`.
Create a new `MongoDB::Atlas::Cluster`.
Create a new `MongoDB::Atlas::Cluster`.
Create a new `MongoDB::Atlas::CustomDBRole`.
Create a new `MongoDB::Atlas::CustomDBRole`.
Create a new `MongoDB::Atlas::CustomDnsConfigurationClusterAws`.
Create a new `MongoDB::Atlas::CustomDnsConfigurationClusterAws`.
Create a new `MongoDB::Atlas::DatabaseUser`.
Create a new `MongoDB::Atlas::DatabaseUser`.
Create a new `MongoDB::Atlas::DataLakes`.
Create a new `MongoDB::Atlas::DataLakes`.
Create a new `MongoDB::Atlas::EncryptionAtRest`.
Create a new `MongoDB::Atlas::EncryptionAtRest`.
Create a new `MongoDB::Atlas::FederatedDatabaseInstance`.
Create a new `MongoDB::Atlas::FederatedDatabaseInstance`.
Create a new `MongoDB::Atlas::FederatedQueryLimit`.
Create a new `MongoDB::Atlas::FederatedQueryLimit`.
Create a new `MongoDB::Atlas::FederatedSettingsOrgRoleMapping`.
Create a new `MongoDB::Atlas::FederatedSettingsOrgRoleMapping`.
Create a new `MongoDB::Atlas::GlobalClusterConfig`.
Create a new `MongoDB::Atlas::GlobalClusterConfig`.
Create a new `MongoDB::Atlas::LDAPConfiguration`.
Create a new `MongoDB::Atlas::LDAPConfiguration`.
Create a new `MongoDB::Atlas::LDAPVerify`.
Create a new `MongoDB::Atlas::LDAPVerify`.
Create a new `MongoDB::Atlas::MaintenanceWindow`.
Create a new `MongoDB::Atlas::MaintenanceWindow`.
Create a new `MongoDB::Atlas::NetworkContainer`.
Create a new `MongoDB::Atlas::NetworkContainer`.
Create a new `MongoDB::Atlas::NetworkPeering`.
Create a new `MongoDB::Atlas::NetworkPeering`.
Create a new `MongoDB::Atlas::OnlineArchive`.
Create a new `MongoDB::Atlas::OnlineArchive`.
Create a new `MongoDB::Atlas::OrgInvitation`.
Create a new `MongoDB::Atlas::OrgInvitation`.
Create a new `MongoDB::Atlas::PrivateEndpoint`.
Create a new `MongoDB::Atlas::PrivateEndpoint`.
Create a new `MongoDB::Atlas::PrivateEndpointADL`.
Create a new `MongoDB::Atlas::PrivateEndpointADL`.
Create a new `MongoDB::Atlas::PrivateEndpointAWS`.
Create a new `MongoDB::Atlas::PrivateEndpointAWS`.
Create a new `MongoDB::Atlas::PrivateEndPointRegionalMode`.
Create a new `MongoDB::Atlas::PrivateEndPointRegionalMode`.
Create a new `MongoDB::Atlas::PrivateEndpointService`.
Create a new `MongoDB::Atlas::PrivateEndpointService`.
Create a new `MongoDB::Atlas::PrivatelinkEndpointServiceDataFederationOnlineArchive`.
Create a new `MongoDB::Atlas::PrivatelinkEndpointServiceDataFederationOnlineArchive`.
Create a new `MongoDB::Atlas::Project`.
Create a new `MongoDB::Atlas::Project`.
Create a new `MongoDB::Atlas::ProjectInvitation`.
Create a new `MongoDB::Atlas::ProjectInvitation`.
Create a new `MongoDB::Atlas::ProjectIpAccessList`.
Create a new `MongoDB::Atlas::ProjectIpAccessList`.
Create a new `MongoDB::Atlas::SearchIndex`.
Create a new `MongoDB::Atlas::SearchIndex`.
Create a new `MongoDB::Atlas::ServerlessInstance`.
Create a new `MongoDB::Atlas::ServerlessInstance`.
Create a new `MongoDB::Atlas::ServerlessPrivateEndpoint`.
Create a new `MongoDB::Atlas::ServerlessPrivateEndpoint`.
Create a new `MongoDB::Atlas::Teams`.
Create a new `MongoDB::Atlas::Teams`.
Create a new `MongoDB::Atlas::ThirdPartyIntegration`.
Create a new `MongoDB::Atlas::ThirdPartyIntegration`.
Create a new `MongoDB::Atlas::Trigger`.
Create a new `MongoDB::Atlas::Trigger`.
Create a new `MongoDB::Atlas::X509AuthenticationDatabaseUser`.
Create a new `MongoDB::Atlas::X509AuthenticationDatabaseUser`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Checks if `x` is a construct.

# Constants

AWS.
AZURE.
GCP.
TENANT.
AWS.
AZURE.
GCP.
daily.
hourly.
monthly.
weekly.
onDemand.
scheduled.
completed.
failed.
inProgress.
queued.
REPLICA_SET.
SHARDED_CLUSTER.
GROUP_CLUSTER_MANAGER.
GROUP_DATA_ACCESS_ADMIN.
GROUP_DATA_ACCESS_READ_ONLY.
GROUP_DATA_ACCESS_READ_WRITE.
GROUP_OWNER.
GROUP_READ_ONLY.
ORG_BILLING_ADMIN.
ORG_GROUP_CREATOR.
ORG_MEMBER.
ORG_OWNER.
ORG_READ_ONLY.
CREATE.
DELETE.
LOGIN.
anon-user.
api-key.
custom-function.
custom-token.
local-userpass.
oauth2-apple.
oauth2-facebook.
oauth2-google.
automated.
download.
pointInTime.
cluster.
serverless.
daily.
hourly.
monthly.
weekly.
cluster.
serverless.
onDemand.
scheduled.
AWS.
AZURE.
GCP.
NONE.
NONE.
ROLE.
USER.
GROUP.
NONE.
USER.
CUSTOMER.
MANAGED.
NONE.
bytesProcessed.daily.
bytesProcessed.monthly.
bytesProcessed.query.
bytesProcessed.weekly.
STANDARD.
TIMESERIES.
GROUP_CLUSTER_MANAGER.
GROUP_DATA_ACCESS_ADMIN.
GROUP_DATA_ACCESS_READ_ONLY.
GROUP_DATA_ACCESS_READ_WRITE.
GROUP_OWNER.
GROUP_READ_ONLY.
ORG_BILLING_ADMIN.
ORG_GROUP_CREATOR.
ORG_MEMBER.
ORG_OWNER.
ORG_READ_ONLY.
AWS.
AZURE.
GCP.
GROUP_CLUSTER_MANAGER.
GROUP_DATA_ACCESS_ADMIN.
GROUP_DATA_ACCESS_READ_ONLY.
GROUP_DATA_ACCESS_READ_WRITE.
GROUP_OWNER.
GROUP_READ_ONLY.
GROUP_CLUSTER_MANAGER.
GROUP_DATA_ACCESS_ADMIN.
GROUP_DATA_ACCESS_READ_ONLY.
GROUP_DATA_ACCESS_READ_WRITE.
GROUP_OWNER.
GROUP_READ_ONLY.
http.
https.
file.
http.
DATADOG.
MICROSOFT_TEAMS.
OPS_GENIE.
PAGER_DUTY.
PROMETHEUS.
SLACK.
VICTOR_OPS.
WEBHOOK.
EPOCH_MILLIS.
EPOCH_NANOSECONDS.
EPOCH_SECONDS.
ISODATE.
CUSTOM.
DATE.
DELETE.
INSERT.
REPLACE.
UPDATE.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
.avro.
.avro.gz.
.bson.
.bson.gz.
.csv.
.json.
.json.gz.
.orc.
.tsv.
.tsv.gz.
AWS.
AZURE.
GCP.
SERVERLESS.
TENANT.
DUBLIN_IRL.
FRANKFURT_DEU.
LONDON_GBR.
MUMBAI_IND.
OREGON_USA.
SYDNEY_AUS.
VIRGINIA_USA.
GREATER_THAN.
LESS_THAN.
CLUSTER_NAME.
HOSTNAME.
HOSTNAME_AND_PORT.
PORT.
REPLICA_SET_NAME.
SHARD_NAME.
TYPE_NAME.
CONTAINS.
ENDS_WITH.
EQUALS.
NOT_CONTAINS.
NOT_EQUALS.
REGEX.
STARTS_WITH.
AVERAGE.
GREATER_THAN.
LESS_THAN.
EU.
US.
EU.
US.
GROUP_CLUSTER_MANAGER.
GROUP_DATA_ACCESS_ADMIN.
GROUP_DATA_ACCESS_READ_ONLY.
GROUP_DATA_ACCESS_READ_WRITE.
GROUP_OWNER.
GROUP_READ_WRITE.
ORG_BILLING_ADMIN.
ORG_GROUP_CREATOR.
ORG_MEMBER.
ORG_OWNER.
ORG_READ_ONLY.
CRITICAL.
ERROR.
WARNING.
DATADOG.
EMAIL.
FLOWDOCK.
GROUP.
MICROSOFT_TEAMS.
OPS_GENIE.
ORG.
PAGER_DUTY.
PROMETHEUS.
SLACK.
SMS.
TEAM.
USER.
VICTOR_OPS.
WEBHOOK.
No description provided by the author
No description provided by the author
date.
int.
long.
objectId.
string.
uuid.
DAILY.
DEFAULT.
MONTHLY.
WEEKLY.
CLUSTER.
DATA_LAKE.
MONGOS.
SERVERLESS.

# Structs

No description provided by the author
No description provided by the author
AWS Automatic Cluster Scaling.
Hardware specifications for nodes set for a given region.
List of settings that configure your cluster regions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.
AWS Private endpoint configuration properties.
Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users.
Returns and edits database auditing settings for MongoDB Cloud projects.
Returns, starts, and cancels Cloud Backup restore jobs.
An example resource schema demonstrating some basic constructs and validation rules.
The exportBuckets resource allows you to grant Atlas access to the specified bucket for exporting backup snapshots.
Returns, takes, and removes Cloud Backup snapshots.
The cluster resource provides access to your cluster configurations.
Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.
No description provided by the author
Returns, adds, edits, and removes custom database user privilege roles.
An example resource schema demonstrating some basic constructs and validation rules.
Returns, adds, edits, and removes database users.
Returns, adds, edits, and removes Federated Database Instances.
Returns and edits the Encryption at Rest using Customer Key Management configuration.
Returns, adds, edits, and removes Federated Database Instances.
Query limit for one federated database instance.
Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.
Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings.
Returns, edits, verifies, and removes LDAP configurations.
Requests a verification of an LDAP configuration over TLS for an Atlas project.
The maintenanceWindow resource provides access to retrieve or update the current Atlas project maintenance window.
Returns, adds, edits, and removes network peering containers.
Returns, adds, edits, and removes network peering containers and peering connections.
Returns, adds, edits, or removes an online archive.
Returns, adds, and edits organizational units in MongoDB Cloud.
Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects.
Creates one private endpoint for the specified cloud service provider.
The Private Endpoint creation flow consists of the creation of three related resources in the next order: 1.
An example resource schema demonstrating some basic constructs and validation rules.
Creates one private endpoint service for the specified cloud service provider.
Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects.
Returns, adds, and edits collections of clusters and users in MongoDB Cloud.
Returns, adds, edits, and removes network access limits to database deployments in MongoDB Cloud.
Retrieves or creates projects in any given Atlas organization.
Returns, adds, edits, and removes Atlas Search indexes.
Returns, adds, edits, and removes serverless instances.
Returns, adds, edits, and removes private endpoints for serverless instances.
Adds one team to the specified project.
Returns, adds, edits, and removes third-party service integration configurations.
View and manage your application's [triggers](https://www.mongodb.com/docs/atlas/app-services/triggers/overview/).
Generates one X.509 certificate for the specified MongoDB user.
Cloud provider linked to this data lake..
No description provided by the author
Array of collections and data sources that map to a stores data store.
Automatic Compute Scaling.
Collection of Uniform Resource Locators that point to the MongoDB database.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Information about the cloud provider region to which the data lake routes client connections.
No description provided by the author
Automatic cluster storage settings that apply to this cluster.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Advanced configuration details to add for one cluster in the specified project.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
List of resources on which you grant the action.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Configuration information for each data store and its mapping to MongoDB Cloud databases.
Array that contains the data stores for the data lake.
Configuration information for each data store and its mapping to MongoDB Cloud databases.
Options that needs to be set to control the synchronous creation flow, this options need to be set if EnableSynchronousCreation is se to TRUE.
No description provided by the author
Advanced configuration details to add for one cluster in the specified project.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A CloudFormation `MongoDB::Atlas::AlertConfiguration`.
A CloudFormation `MongoDB::Atlas::Auditing`.
A CloudFormation `MongoDB::Atlas::CloudBackUpRestoreJobs`.
A CloudFormation `MongoDB::Atlas::CloudBackupSchedule`.
A CloudFormation `MongoDB::Atlas::CloudBackupSnapshot`.
A CloudFormation `MongoDB::Atlas::CloudBackupSnapshotExportBucket`.
A CloudFormation `MongoDB::Atlas::Cluster`.
A CloudFormation `MongoDB::Atlas::CustomDBRole`.
A CloudFormation `MongoDB::Atlas::CustomDnsConfigurationClusterAws`.
A CloudFormation `MongoDB::Atlas::DatabaseUser`.
A CloudFormation `MongoDB::Atlas::DataLakes`.
A CloudFormation `MongoDB::Atlas::EncryptionAtRest`.
A CloudFormation `MongoDB::Atlas::FederatedDatabaseInstance`.
A CloudFormation `MongoDB::Atlas::FederatedQueryLimit`.
A CloudFormation `MongoDB::Atlas::FederatedSettingsOrgRoleMapping`.
A CloudFormation `MongoDB::Atlas::GlobalClusterConfig`.
A CloudFormation `MongoDB::Atlas::LDAPConfiguration`.
A CloudFormation `MongoDB::Atlas::LDAPVerify`.
A CloudFormation `MongoDB::Atlas::MaintenanceWindow`.
A CloudFormation `MongoDB::Atlas::NetworkContainer`.
A CloudFormation `MongoDB::Atlas::NetworkPeering`.
A CloudFormation `MongoDB::Atlas::OnlineArchive`.
A CloudFormation `MongoDB::Atlas::OrgInvitation`.
A CloudFormation `MongoDB::Atlas::PrivateEndpoint`.
A CloudFormation `MongoDB::Atlas::PrivateEndpointADL`.
A CloudFormation `MongoDB::Atlas::PrivateEndpointAWS`.
A CloudFormation `MongoDB::Atlas::PrivateEndPointRegionalMode`.
A CloudFormation `MongoDB::Atlas::PrivateEndpointService`.
A CloudFormation `MongoDB::Atlas::PrivatelinkEndpointServiceDataFederationOnlineArchive`.
A CloudFormation `MongoDB::Atlas::Project`.
A CloudFormation `MongoDB::Atlas::ProjectInvitation`.
A CloudFormation `MongoDB::Atlas::ProjectIpAccessList`.
A CloudFormation `MongoDB::Atlas::SearchIndex`.
A CloudFormation `MongoDB::Atlas::ServerlessInstance`.
A CloudFormation `MongoDB::Atlas::ServerlessPrivateEndpoint`.
A CloudFormation `MongoDB::Atlas::Teams`.
A CloudFormation `MongoDB::Atlas::ThirdPartyIntegration`.
A CloudFormation `MongoDB::Atlas::Trigger`.
A CloudFormation `MongoDB::Atlas::X509AuthenticationDatabaseUser`.
No description provided by the author
No description provided by the author
Generate the CFN extension execution role.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
Human-readable label that identifies the cloud provider that stores this snapshot.
Human-readable label that identifies how often this snapshot triggers.
Human-readable label that identifies when this snapshot triggers.
Human-readable label that indicates the stage of the backup process for this snapshot.
Human-readable label that categorizes the cluster as a replica set or sharded cluster.
Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team.
The type of authentication event that the trigger listens for.
No description provided by the author
Type of restore job to create.The value can be any one of download,automated or point_in_time.
Type of instance specified on the Instance Name serverless or cluster.
Human-readable label that identifies how often this snapshot triggers.
Type of instance specified on the Instance Name serverless or cluster.
Human-readable label that identifies when this snapshot triggers.
Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster.
Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.
Method by which the provided username is authenticated.
Method that briefs who owns the certificate provided.
Human-readable label that identifies this data federation instance limit.
Classification of MongoDB database collection that you want to return.
No description provided by the author
Cloud service provider that manages this private endpoint, default : AWS.
No description provided by the author
No description provided by the author
Security Scheme to apply to HyperText Transfer Protocol (HTTP) traffic between Prometheus and MongoDB Cloud.
Desired method to discover the Prometheus service.
Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud.
Syntax used to write the date after which data moves to the online archive.
Means by which MongoDB Cloud selects data to archive.
No description provided by the author
No description provided by the author
File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.
Name of the cloud service that hosts the data lake's data stores.
Name of the region to which the data lake routes client connections.
Comparison operator to apply when checking the current metric value.
Name of the parameter in the target object that MongoDB Cloud checks.
Comparison operator to apply when checking the current metric value against **matcher[n].value**.
MongoDB Cloud computes the current metric value as an average.
Comparison operator to apply when checking the current metric value.
Datadog region that indicates which API Uniform Resource Locator (URL) to use.
Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.
No description provided by the author
Degree of seriousness given to this notification.
Human-readable label that displays the alert notification type.
No description provided by the author
Data type of the parameter that that MongoDB Cloud uses to partition data.
No description provided by the author
No description provided by the author
MongoDB process type to which your application connects.
Human-readable label that identifies the cloud service provider.