Cria uma conexão para uma instância do Atlas Stream Processing.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
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 streams connections create [connectionName] [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
connectionName | string | false | Nome da conexão |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-f, --file | string | true | Caminho para um arquivo de configuração JSON que define uma conexão Atlas Stream Processing . Observação: os campos não suportados no arquivo JSON são ignorados. |
-h, --help | false | ajuda para criar | |
-i, --instance | string | true | Nome da sua instância do Atlas Stream Processing. |
-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. |
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.
Connection <Name> created.
Exemplos
# create a new connection for Atlas Stream Processing: atlas streams connection create kafkaprod -i test01 -f kafkaConfig.json
# create a new connection using the name from a cluster configuration file atlas streams connection create -i test01 -f clusterConfig.json