Modifique os detalhes do reconhecimento de data center de Data Federation especificado 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.
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 dataFederation update <name> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | true | Nome do banco de dados de federação de dados. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--awsRoleId | string | false | Nome de recurso da Amazon (ARN) da função que o Atlas Data Federation usa para acessar os armazenamentos de dados. Mutuamente exclusivo com --file. |
--awsTestS3Bucket | string | false | Nome de um bucket de dados do Amazon S3 que o Atlas Data Federation utiliza para validar a role fornecida. Mutuamente exclusivo com --file. |
-f, --file | string | false | Caminho para um arquivo de configuração JSON opcional que define as configurações de federação de dados. Observação: os campos não suportados no arquivo JSON são ignorados. Para saber mais sobre arquivos de configuração de federação de dados para Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config. Mutuamente exclusivo com --region, --awsRoleId, --awsTestS3Bucket. |
-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. |
--region | string | false | Nome da região para a qual o Atlas Data Federation roteia conexões de cliente para processamento de dados. Mutuamente exclusivo com --file. |
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.
Pipeline <Name> updated.
Exemplos
# update data lake pipeline: atlas dataFederation update DataFederation1