Skip to content

Commit

Permalink
adds deprecation notes to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
americk0 committed May 31, 2024
1 parent 98be480 commit 2955373
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,8 @@ Arguments:

* `-p [password]` Your password
* `-n [roleName]` The name of the role, be sure to wrap in quotes, alphanumeric including: `@+=._-`
* `-t [roleType]` The role type, to see available roles: `alks iam roletypes`, be sure to wrap in quotes. Must include roleType or trust policy, but not both
* `-p [trustPolicy]` A trust policy as a JSON string. Must include trustPolicy or roleType, but not both
* `-t [roleType]` The role type, to see available roles: `alks iam roletypes`, be sure to wrap in quotes. Must include roleType or trust policy, but not both. We recommend specifying the trust policy instead since role types are a legacy feature and no new role types are being created for new AWS services
* `-d`: Include default policies, defaults to false
* `-F` Filters favorite accounts
* `-k [tags]` A list of resource tags. Can either be a JSON representation '[{"Key":"string","Value":"string"},{"Key":"string","Value":"string"}]' or shorthand Key=string,Value=string Key=string,Value=string
Expand All @@ -193,6 +193,8 @@ Outputs the created role's ARN.

### `iam createtrustrole`

DEPRECATED: we recommend using `iam createrole` instead since you can use it to create all the same types of roles as this command and more

`alks iam createtrustrole` Creates a new IAM Trust role for the requested type in the specified AWS account.

Arguments:
Expand All @@ -218,7 +220,7 @@ Arguments:

### `iam roletypes`

`alks iam roletypes` - List the available IAM role types.
`alks iam roletypes` - List the available IAM role types. We recommend specifying the trust policy when creating roles instead since role types are a legacy feature and no new role types are being created for new AWS services

Arguments:

Expand Down
6 changes: 4 additions & 2 deletions src/lib/program.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,9 @@ iam
.command('roletypes')
.alias('role-types')
.alias('list-role-types')
.description('list the available iam role types')
.description(
'list the available iam role types. We recommend specifying the trust policy when creating roles instead since role types are a legacy feature and no new role types are being created for new AWS services'
)
.option(
'-o, --output <format>',
'output format (' + getOutputValuesRoleTypes().join(', ') + ')',
Expand Down Expand Up @@ -237,7 +239,7 @@ iam
.option('-n, --rolename <rolename>', 'the name of the role, ' + nameDesc)
.option(
'-t, --roletype <roletype>',
'the role type, to see available roles: alks iam roletypes. Must provide role type or trust policy'
'the role type, to see available roles: alks iam roletypes. Must provide role type or trust policy. We recommend specifying the trust policy instead since role types are a legacy feature and no new role types are being created for new AWS services'
)
.option(
'-p, --trustPolicy <trustPolicy>',
Expand Down

0 comments on commit 2955373

Please sign in to comment.