STEP

Assume role

Assumes the given role and returns the assumed credentials and role identifiers.

Specification

aws

Required

object
A mapping of AWS account configuration.
aws.connection

Required

A Relay AWS connection to useConnection docs
!Connection {type: aws, name: my-aws-connection}
aws.region

Required

string
The AWS region to use (for example, us-west-2)
roleARN

Required

string
One of private, public-read, public-read-write, authenticated-read
roleSessionName

Required

string
User-provided identifier for the session

Integrations in this step

Install the Relay CLI

Relay CLI is an essential companion for authoring and managing workflows. You can install it with a package manager or download it.
brew install puppetlabs/puppet/relay
Learn more about setting up Relay.

How to contribute

We’re excited to see and share in our community’s creation. Take a look at our community overview to learn how to begin contributing to Relay.