Crie um destino de exportação para backups do Atlas usando um bucket do Amazon Web Services S3 existente.
Visualização pública: o subcomando atlas api, 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 backups exports buckets create <bucketName> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
bucketName | string | true | Nome do bucket S3 existente que o ID de role fornecido está autorizado a acessar. |
Opções
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
--cloudProvider | string | true | Nome do provedor do serviço de cloud onde o Atlas pode acessar o bucket S3. O Atlas é compatível apenas com Amazon Web Services. |
-h, --help | false | ajuda para criar | |
--iamRoleId | string | true | Identificador exclusivo que o Atlas atribui ao role de acesso do provedor de nuvem para o bucket. Para saber mais sobre como configurar e recuperar uma função de acesso do provedor de nuvem, consulte: https://dochub.mongodb.org/core/set-up-unified-aws-access. |
-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.
Export destination created using '<BucketName>'.
Exemplos
# The following command creates an export destination for Atlas backups using the existing AWS S3 bucket named test-bucket: atlas backup export buckets create test-bucket --cloudProvider AWS --iamRoleId 12345678f901a234dbdb00ca