Crie um cluster para seu projeto.
Para começar rapidamente, especifique um nome para seu cluster, um fornecedor de serviços em nuvem e uma região para implantar um conjunto de réplicas de três membros com a versão mais recente do servidor MongoDB. Para obter controle total da implantação ou para criar clusters multinuvem, forneça um arquivo de configuração JSON com o sinalizador --file.
Nota de descontinuação: as camadas M2 e M5 estão agora descontinuadas; ao selecionar M2 ou M5, será criada uma camada FLEX. Para o guia de migração, visite: https://dochub.mongodb.org/core/flex-migration.n
Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto.
Sintaxe
atlas clusters create [name] [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | false | Nome do cluster. O nome do cluster não pode ser alterado após a criação do cluster. O nome do cluster pode conter letras ASCII, números e hifens. Você deve especificar o argumento do nome do cluster se não usar a opção --file. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--backup | false | Sinalizador que habilita o Backup em cloud Contínuo para sua implantação. Esta opção não está disponível para clusters menores que M10. | |
--biConnector | false | Sinalizador que habilita o BI Connector for Atlas na implantação. Mutuamente exclusivo com --file. | |
--diskSizeGB | float | false | Capacidade, em gigabytes, do volume raiz do host. Mutuamente exclusivo com --file. Este valor é padronizado como 2. |
--enableTerminationProtection | false | Habilita a proteção contra encerramento para seu cluster. Não é possível excluir um cluster com a proteção de encerramento habilitada. | |
-f, --file | string | false | Caminho para um arquivo de configuração JSON opcional que define as configurações do agrupamento. Observação: os campos não suportados no arquivo JSON são ignorados. Para saber mais sobre arquivos de configuração de cluster para Atlas CLI, consulte https://dochub.mongodb.org/core/cluster-config-file-atlascli. Mutuamente exclusivo com --tier, --provider, --members, --region, --diskSizeGB, --mdbVersion, --biConnector, --type, --shards, --tag. |
-h, --help | false | ajuda para criar | |
--mdbVersion | string | false | Versão MongoDB principal do cluster. Mutualmente exclusivo com --file. Este valor é padronizado para "8.0". |
-m, --members | int | false | Número de nós no conjunto de réplicas. Mutuamente exclusivo com --file. Este valor é padronizado como 3. |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
--provider | string | false | Nome do seu provedor de serviços de cloud. Os valores válidos são Amazon Web Services, Azure ou GCP. Você deve especificar a opção do provedor se não usar a opção --file. Mutuamente exclusivo com --file. |
-r, --region | string | false | Localização física do cluster MongoDB . Você deve especificar a opção region se não usar a opção --file. Para obter uma lista completa das regiões da Amazon Web Services compatíveis, consulte: https://dochub.mongodb.org/core/aws-atlas. Para obter uma lista completa das regiões Azure compatíveis, consulte: https://dochub.mongodb.org/core/azure-atlas. Para obter uma lista completa de regiões GCP compatíveis, consulte: https://dochub.mongodb.org/core/gcp-atlas. Mutuamente exclusivo com --file. |
-s, --shards | int | false | Número de fragmentos no cluster. Mutuamente exclusivo com --file. Este valor é padronizado como 1. |
--tag | chave=valor | false | Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster. Mutuamente exclusivo com --file. |
--tier | string | false | Camada para cada servidor que contém dados no cluster. Para saber mais sobre camadas de cluster, consulte https://dochub.mongodb.org/core/cluster-tier-atlas. Mutualmente exclusivo com --file. Este valor é padronizado como "FLEX". |
--type | string | false | Tipo do cluster que você deseja criar. Os valores válidos são REPLICASET ou Sharded. Mutuamente exclusivo com --file. Este valor é padronizado para "REPLICASET". |
-w, --watch | false | Sinalizador que indica se o comando deve ser observado até que ele conclua a execução ou o aviso expire. Para definir o tempo limite do relógio, use a opção --watchTimeout. | |
--watchTimeout | int | false | Tempo em segundos até que um relógio expire. Após o tempo limite de observação, a CLI não observa mais o comando. |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
Cluster '<Name>' is being created.
Exemplos
# Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3: atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0
# Deploy a Flex cluster named myFlexCluster for the project with the ID 5e2211c17a3e5a48f5497de3 and tag "env=dev": atlas cluster create myFlexCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier FLEX --tag env=dev
# Deploy a free cluster named myCluster for the project with the ID 5e2211c17a3e5a48f5497de3 and tag "env=dev": atlas cluster create myCluster --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --tier M0 --tag env=dev
# Deploy a three-member replica set named myRS in AWS for the project with the ID 5e2211c17a3e5a48f5497de3: atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AWS --region US_EAST_1 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10
# Deploy a three-member replica set named myRS in AZURE for the project with the ID 5e2211c17a3e5a48f5497de3: atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider AZURE --region US_EAST_2 --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10
# Deploy a three-member replica set named myRS in GCP for the project with the ID 5e2211c17a3e5a48f5497de3: atlas cluster create myRS --projectId 5e2211c17a3e5a48f5497de3 --provider GCP --region EASTERN_US --members 3 --tier M10 --mdbVersion 5.0 --diskSizeGB 10
# Deploy a cluster or a multi-cloud cluster from a JSON configuration file named myfile.json for the project with the ID 5e2211c17a3e5a48f5497de3: atlas cluster create --projectId <projectId> --file myfile.json