Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--mongodb-atlas-globalclusterconfig.json
Parent schema serverless-framework-configuration
Type: object

Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

Profile string | Aws_CF_FunctionString

The profile is defined in AWS Secret manager. See Secret Manager Profile setup.

ProjectId string | Aws_CF_FunctionString

The unique identifier of the project for the Atlas cluster.

ClusterName string | Aws_CF_FunctionString

The name of the Atlas cluster that contains the snapshots you want to retrieve.

ManagedNamespaces object[]

List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.

This parameter returns an empty object if no custom zones exist.

Definitions

zoneMapping object
Location string | Aws_CF_FunctionString

Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible.

Zone string | Aws_CF_FunctionString

Human-readable label that identifies the zone in your global cluster. This zone maps to a location code.

managedNamespace object
Collection string | Aws_CF_FunctionString

Human-readable label of the collection to manage for this Global Cluster.

CustomShardKey string | Aws_CF_FunctionString

Database parameter used to divide the collection into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.

Db string | Aws_CF_FunctionString

Human-readable label of the database to manage for this Global Cluster.

IsCustomShardKeyHashed boolean

Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to false, MongoDB Cloud uses ranged sharding.

IsShardKeyUnique boolean

Flag that indicates whether someone hashed the custom shard key. If this parameter returns false, this cluster uses ranged sharding.