README
¶
MongoDB::Atlas::Cluster
Description
The cluster resource provides access to your cluster configurations. The resource lets you create, edit and delete clusters. The resource requires your Project ID.
Attributes
ID : Unique identifier of the cluster.
MongoURI : Base connection string for the cluster.
MongoURIUpdated : Timestamp in ISO 8601 date and time format in UTC when the connection string was last updated. The connection string changes if you update any of the other values.
MongoURIWithOptions : Connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
Paused : Flag that indicates whether the cluster is paused or not.
SrvAddress : Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS. The mongoURI parameter lists additional options.
StateName : Current state of the cluster.
Parameters
AutoScaling (optional) : Configure your cluster to automatically scale its storage and cluster tier.
BackupEnabled (optional) : Applicable only for M10+ clusters. Set to true to enable Atlas continuous backups for the cluster. Set to false to disable continuous backups for the cluster. Atlas deletes any stored snapshots. See the continuous backup Snapshot Schedule for more information. You cannot enable continuous backups if you have an existing cluster in the project with Cloud Provider Snapshots enabled. The default value is false.
BiConnector (optional) : Specifies BI Connector for Atlas configuration on this cluster.
ClusterType (optional) : Type of the cluster that you want to create.
DiskSizeGB (optional) : Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.
EncryptionAtRestProvider (optional) : Set the Encryption at Rest parameter.
ProjectID (required) : Unique identifier of the project the cluster belongs to.
Labels (optional) : Array containing key-value pairs that tag and categorize the cluster.
MongoDBVersion (optional) : Major version of the cluster to deploy.
MongoDBMajorVersion (optional) : Major version of the cluster to deploy.
Name (required) : Name of the cluster. Once the cluster is created, its name cannot be changed.
NumShards (optional) : Positive integer that specifies the number of shards to deploy for a sharded cluster.
PitEnabled (optional) : Flag that indicates if the cluster uses Point-in-Time backups. If set to true, providerBackupEnabled must also be set to true.
ProviderSettings (required) : Configuration for the provisioned servers on which MongoDB runs.
ProviderBackupEnabled (optional) : Applicable only for M10+ clusters. Set to true to enable Atlas Cloud Provider Snapshots backups for the cluster. Set to false to disable Cloud Provider Snapshots backups for the cluster. You cannot enable Cloud Provider Snapshots if you have an existing cluster in the project with continuous backups enabled. Note that you must set this value to true for NVMe clusters. The default value is false.
ReplicationFactor (optional) : ReplicationFactor is deprecated. Use replicationSpecs.
ReplicationSpecs (optional) : Configuration for cluster regions.
ApiKeys (required) : The private and public keys of the MongoDB Atlas organization or project.
Installation
$ make
$ cfn submit
...
Directories