mongocli atlas privateEndpoints aws interfaces describe
On this page
mongocli atlas
commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas
commands until April 30, 2023.Return a specific AWS private endpoint interface for your project.
Syntax
mongocli atlas privateEndpoints aws interfaces describe <endpointId> [options]
Arguments
Name | Type | Required | Description |
---|---|---|---|
endpointId | string | true | Unique alphanumeric string that identifies the private endpoint. |
Options
Name | Type | Required | Description |
---|---|---|---|
--endpointServiceId | string | true | Unique identifier of the private endpoint service for which you want to retrieve a private endpoint. |
-h, --help | false | help for describe | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. |
--projectId | string | false | Project ID to use. Overrides the settings in the configuration file or environment variable. |
Inherited Options
Name | Type | Required | Description |
---|---|---|---|
-P, --profile | string | false | Profile to use from your configuration file. |
Examples
This example uses the profile named "myprofile" for accessing Atlas. $ mongocli atlas privateendpoints aws interfaces describe vpce-svc-0123456789abcdefg --endpointServiceId 0123456789abcdefghijklmn -P myprofile