Atualiza uma instância do Atlas Stream Processing para seu projeto.
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.
Antes de atualizar uma instância do Atlas Streams Processing, você deve primeiro parar todos os processos associados a ela. 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 instances update <name> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | true | Nome da instância do Atlas Stream Processing. Após a criação, você não pode alterar o nome da instância. O nome pode conter letras ASCII, números e hifens. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-h, --help | false | ajuda para atualização | |
-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 | true | Fornecedor de serviços de nuvem que se aplica à instância provisionada do Atlas Stream Processing . Os valores válidos são Amazon Web Services ou Azure. Este valor padrão é "Amazon Web Services". |
-r, --region | string | true | Etiqueta legível por humanos que identifica a localização física da instância de Atlas Stream Processing . A região pode afetar a latência e o desempenho da rede se estiver longe de sua origem ou coletor. Para Amazon Web Services, o nome da região deve estar no seguinte formato: VIRGINIA_EUA. Para obter uma lista de valores válidos, consulte https://www.mongodb.com/pt-br/docs/atlas/reference/amazon-aws/#std-label-aws-stream-processing-regions. Para o Azure, o nome da região deve estar no seguinte formato:eastus. Para obter uma lista de valores válidos, consulte https://www.mongodb.com/pt-br/docs/atlas/reference/microsoft-azure/#std-label-azure-stream-processing-regions. |
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.
Atlas Streams Processor Instance '<Name>' successfully updated.
Exemplos
# Modify the Atlas Stream Processing instance configuration with the name MyInstance: atlas streams instance update MyInstance --provider AWS --region VIRGINIA_USA