Assume role

step

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

Outputs

connection

Required

A Relay AWS connection to useConnection docs
!Connection {type: aws, name: my-aws-connection}
role
Optional
object
The identifiers for the temporary security credentials that the operation returns.
role.assumedRoleId
Optional
string
A unique identifier that contains the role ID and the role session name of the role that is being assumed.
role.arn
Optional
string
The ARN of the temporary security credentials that are returned from the AssumeRole action.

Join our community

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.