atlas privateEndpoints aws interfaces descrever
Retorne os detalhes da interface de endpoint privado da Amazon Web Services especificada para seu projeto.
Para usar esse comando, você deve autenticar com uma conta de usuário ou uma chave de API com o role de Somente Leitura do projeto.
Sintaxe
Sintaxe do comando
atlas privateEndpoints aws interfaces describe <interfaceEndpointId> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
interfaceEndpointId | string | true | String exclusiva que identifica a interface de endpoint privado da Amazon Web Services na Amazon Web Services. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--endpointServiceId | string | true | String única alfanumérica de 24 caracteres que identifica o endpoint privado no Atlas. |
-h, --help | false | ajuda para descrever | |
-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.
ID STATUS ERROR <InterfaceEndpointId> <ConnectionStatus> <ErrorMessage>
Exemplos
# Return the JSON-formatted details of the AWS private endpoint interface with the ID vpce-00713b5e644e830a3 in AWS for an AWS private endpoint with the ID 5f4fc14da2b47835a58c63a2 in Atlas: atlas privateEndpoints aws interfaces describe vpce-00713b5e644e830a3 --endpointServiceId 5f4fc14da2b47835a58c63a2