aws logo
AWS Classic v5.41.0, May 15 23

AWS Resources Using AssumeRole | TypeScript

View Code

This example demonstrates how to use the AssumeRole functionality of the AWS provider in order to create resources in the security context of an IAM Role assumed by the IAM User running the Pulumi program.

Deploying the Example

These instructions assume you are familiar with running Pulumi programs written in TypeScript. Some other examples which describe each step in more detail are:

Part 1: Privileged Components

The Pulumi program in create-role requires credentials with permissions to create an IAM User, an IAM Role, and assign an AWS Access Key to the user. The program creates a new, unprivileged user with no policies attached, and a role which specifies a trust policy allowing assumption by the unprivileged user. The role allows the s3:* actions on all resources.

You’ll need to set the create-role:unprivilegedUsername configuration variable to the name of the unprivilged user, as well as the AWS region in which to operate.

$ cd create-role
$ npm install
$ pulumi stack init assume-role-create
$ pulumi config set create-role:unprivilegedUsername
$ pulumi config set aws:region us-east-1
$ pulumi up

The program can then be run with pulumi up. The outputs of the program tell you the ARN of the Role, and the Access Key ID and Secret associated with the User:

$ pulumi stack output --json
    "accessKeyId": "AKIAI7JE74TLY2LOEIJA",
    "secretAccessKey": "[secret]",
    "roleArn": "arn:aws:iam::<redacted>:role/allow-s3-management-ad477e6"

If we just use the above command then the secretAccessKey would not be shown. In order to show the secret value use this

$ pulumi stack output --json --show-secrets
  "accessKeyId": "AKIAYJ7EUPHL3DSDH4CX",
  "secretAccessKey": "[plain text value]",
  "roleArn": "arn:aws:iam::571173272023:role/allow-s3-management-fcc71c0"

Part 2: Assuming the Role

The Pulumi program in assume-role creates an S3 bucket after assuming the Role created in Part 1. It should be run with the unprivileged user credentials created in Part 1. This can be configured as follows, from the assume-role directory, replacing {YOUR_STACK_PATH/assume-role-create} with the full name of your stack from Part 1. Full name of your stack is available at

$ cd assume-role
$ npm install
$ export AWS_ACCESS_KEY_ID="$(pulumi stack output --stack {YOUR_STACK_PATH/assume-role-create} accessKeyId)"
$ export AWS_SECRET_ACCESS_KEY="$(pulumi stack output --stack {YOUR_STACK_PATH/assume-role-create} --show-secrets secretAccessKey)"

The configuration variable roleToAssumeARN must be set to the ARN of the role allowing S3 access, and the AWS region must be set to the region in which you wish to operate:

$ pulumi stack init assume-role-assume
$ pulumi config set roleToAssumeARN "$(pulumi stack output --stack {YOUR_STACK_PATH/assume-role-create} roleArn)"
$ pulumi config set aws:region us-east-1

Unset the AWS_SESSION_TOKEN or any additional credential setting if you have set for previous access


The program can then be run with pulumi up. You can verify that the role is indeed assumed by looking at the CloudTrail logs of the bucket creation operation, or by commenting out the assumeRole configuration in the provider and ensuring creation is not successful.

Clean up

To clean up your resources, run pulumi destroy and respond yes to the confirmation prompt.