mongocli atlas cloudProviders accessRoles aws authorize
On this page
mongocli atlas commands are now deprecated and will be removed in a future release. To enjoy the same capabilities and the latest features, use the new, dedicated CLI for Atlas users. To learn more, see Migrate to the Atlas CLI.Authorize an AWS IAM role.
Syntax
Command Syntax
mongocli atlas cloudProviders accessRoles aws authorize <roleId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
roleId | string | true | Unique ID of the role to authorize. |
Options
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 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 MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
AWS IAM role '<CloudProviderAccessAWSIAMRole.RoleId> successfully authorized.