Authenticate with Amazon Web Services (AWS)

The step authenticates with AWS using an OIDC token or access key.

Description

This step authenticates with Amazon Web Services (AWS) using an OpenID Connect (OIDC) token or an access key.

For OIDC based authentication it retrieves an identity token from Bitrise, assumes the specified AWS role using the token, and generates temporary AWS credentials.

The access key details can be created on the AWS Management Console under IAM roles.

The generated AWS credentials are then set as environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN) for use in subsequent steps.

🧩 Get started

Add this step directly to your workflow in the Bitrise Workflow Editor.

You can also run this step directly with Bitrise CLI.

⚙️ Configuration

Inputs

Key	Description	Flags	Default
region	The AWS region to use.		us-east-1
access_key_id	The AWS Access Key ID. You can get this from the AWS Console under IAM users.	sensitive
secret_access_key	The AWS Secret Access Key. You can get this from the AWS Console under IAM users.	sensitive
audience	The audience for the identity token. This could be the URL of the service you want to access with the token or a specific identifier provided by the service.
role_arn	The ARN of the AWS role to assume. You can find the ARN in the AWS Management Console under IAM roles.
session_name	The session name for the assumed role. If not provided, a default name will be generated with the format bitrise-<build-number>.		bitrise-$BITRISE_BUILD_NUMBER
docker_login	Performs Docker login with an auth token. It is supported only on the Linux stacks.	required	false
build_url	Unique build URL of this build on Bitrise.io. By default the step will use the Bitrise API.	required	$BITRISE_BUILD_URL
build_api_token	The build's API Token for the build on Bitrise.io This will be used to communicate with the Bitrise API	required, sensitive	$BITRISE_BUILD_API_TOKEN
verbose	Enable logging additional information for debugging.	required	false

Outputs

Environment Variable	Description
AWS_ACCESS_KEY_ID	The newly generated AWS access key ID.
AWS_SECRET_ACCESS_KEY	The newly generated AWS secret access key.
AWS_SESSION_TOKEN	The newly generated AWS session token.

🙋 Contributing

We welcome pull requests and issues against this repository.

For pull requests, work on your changes in a forked repository and use the Bitrise CLI to run step tests locally.

Learn more about developing steps:

• Create your own step