Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

atlas cloudProviders accessRoles aws authorize

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output

Authorize an AWS IAM role.

Command Syntax
atlas cloudProviders accessRoles aws authorize <roleId> [options]
Name
Type
Required
Description
roleId
string
true
Unique ID of the role to authorize.
Name
Type
Required
Description
-h, --help
false
help for authorize
--iamAssumedRoleArn
string
false
Role ARN that Atlas assumes to access your AWS account.
-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.
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.

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

AWS IAM role '<RoleId> successfully authorized.

Back

aws