atlas customDns aws describe
On this page
Describe the custom DNS configuration of an Atlas cluster deployed to AWS in the specified project.
To use this command, you must authenticate with a user account or an API key with the Project Read Only role.
Syntax
Command Syntax
atlas customDns aws describe [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for describe | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ENABLED <Enabled>
Examples
# Return the details for the custom DNS configuration deployed to AWS in the project with ID 618d48e05277a606ed2496fe: atlas customDns aws describe --projectId 618d48e05277a606ed2496fe