Docs Menu

Docs HomeAtlas Command Line Interface

atlas cloudProviders accessRoles aws create

On this page

  • Syntax
  • Options
  • Inherited Options
  • Output

Create an AWS IAM role.

To use this command, you must authenticate with a user account or an API key that has the Project Owner role.

atlas cloudProviders accessRoles aws create [options]
Name
Type
Required
Description
-h, --help
false
help for create
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false
Human-readable label that identifies 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. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

AWS IAM role '<RoleID>' successfully created.
Atlas AWS Account ARN: <AtlasAWSAccountARN>
Unique External ID: <AtlasAssumedRoleExternalID>
←  atlas cloudProviders accessRoles aws authorizeatlas cloudProviders accessRoles aws deauthorize →

Specify your version