Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
Commands
/
deployments

atlas deployments setup

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options

Create a local deployment.

To learn more about local atlas deployments, see https://www.mongodb.com/zh-cn/docs/atlas/cli/current/atlas-cli-deploy-local/

Syntax

Command Syntax
atlas deployments setup [deploymentName] [options]

Arguments

Name
Type
Required
Description

deploymentName

string

false

Name of the deployment that you want to set up.

Options

Name
Type
Required
Description

--accessListIp

strings

false

IP address to grant access to the deployment.

Mutually exclusive with --currentIp.

--bindIpAll

false

Flag that indicates whether the LOCAL deployment port binding should happen for all IPs or only for the localhost interface 127.0.0.1.

--connectWith

string

false

Method for connecting to the deployment. Valid values are compass, mongosh and skip.

Mutually exclusive with --skipMongosh.

--currentIp

false

Flag that adds the IP address from the host that is currently executing the command to the access list.

Mutually exclusive with --accessListIp.

--enableTerminationProtection

false

Enables termination protection for your deployment. You can't delete a deployment with termination protection enabled.

--force

false

Flag that indicates whether to skip the request for input and create a deployment with the default settings for any unspecified options.

-h, --help

false

help for setup

--initdb

string

false

Flag that uses a folder to be mapped into LOCAL deployment for initialization

--mdbVersion

string

false

Major MongoDB version of the deployment.

--password

string

false

Password for the user.

--port

int

false

Port that the MongoDB server listens to for client connections.

--projectId

string

false

Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.

--provider

string

false

Name of your cloud service provider. Valid values are AWS, AZURE, or GCP.

-r, --region

string

false

Physical location of your MongoDB deployment. For a complete list of supported AWS regions, see: https://dochub.mongodb.org/core/aws-atlas. For a complete list of supported Azure regions, see: https://dochub.mongodb.org/core/azure-atlas. For a complete list of supported GCP regions, see: https://dochub.mongodb.org/core/gcp-atlas.

--skipSampleData

false

Flag that indicates whether to skip loading sample data into your MongoDB deployment.

--tag

key=value

false

List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the deployment.

--tier

string

false

Tier for each data-bearing server in the deployment. To learn more about cluster tiers, see https://dochub.mongodb.org/core/cluster-tier-atlas. This value defaults to "M0".

--type

string

false

Type of deployment that you want to create. Valid values are ATLAS or LOCAL.

--username

string

false

Username for authenticating to MongoDB.

Inherited Options

Name
Type
Required
Description

-P, --profile

string

false

Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Back

list

Next

start