IAM

@aws-lite/iam

Maintained by: @architect

Install

npm i @aws-lite/iam

Optionally install types:

npm i -D @aws-lite/iam-types

Methods

CreateRole

Canonical AWS API doc

Properties

AssumeRolePolicyDocument (string, object) [required]

Trust relationship policy document granting an entity permission to assume the role; can be an object, or JSON or YAML string

RoleName (string) [required]

Name of the role

Description (string)

Description of the role

MaxSessionDuration (number)

Maximum session duration (in seconds) to set for the specified role

Path (string)

Path for the role identifier

More details (AWS)

Example

await aws.IAM.CreateRole({
  AssumeRolePolicyDocument: String || Object, // required
  RoleName: String, // required
  Description: String,
  MaxSessionDuration: Number,
  Path: String,
  PermissionsBoundary: String,
  Tags: Array,
})

DeleteRole

Canonical AWS API doc

Properties

RoleName (string) [required]

Name of the role

Example

await aws.IAM.DeleteRole({
  RoleName: String, // required
})

GetRole

Canonical AWS API doc

Properties

RoleName (string) [required]

Name of the role

Example

await aws.IAM.GetRole({
  RoleName: String, // required
})

UpdateRole

Canonical AWS API doc

Properties

RoleName (string) [required]

Name of the role

Description (string)

Description of the role

MaxSessionDuration (number)

Maximum session duration (in seconds) to set for the specified role

Example

await aws.IAM.UpdateRole({
  RoleName: String, // required
  Description: String,
  MaxSessionDuration: Number,
})

Methods yet to be implemented

Please help out by opening a PR!

aws-lite is an Apache 2.0-licensed open source project under the umbrella of OpenJS Foundation Architect. aws-lite is not in any way affiliated with Amazon Web Services, Inc. (AWS). All names and trademarks are the property of their respective owners.