AWS IAM Integration

The AWS IAM Integration is used to connect the Shippable DevOps Assembly Lines platform to Amazon Web Services to interact with its cloud services like ECR, ECS, EC2, S3, and so on.

Adding account integration

You will need to add an IAM user to your AWS account to create this integration. Instructions are in the AWS docs.

You can add an account integration to Shippable by following steps on the Adding an account integration page.

Here is the information you need to create this integration:

  • Integration type -- AWS IAM
  • Name -- choose a friendly name for the integration
  • Assume Role ARN -- Role to Assume when connecting to AWS

Usage in Assembly Lines

The AWS IAM integration can be used in the following resources:

The main scenarios for using this integration are:

Default Environment Variables

When you create a resource with this integration, and use it as an IN or OUT for a runSh or runCI job, a set of environment variables is automatically made available that you can use in your scripts.

<NAME> is the the friendly name of the resource with all letters capitalized and all characters that are not letters, numbers or underscores removed. For example, my-key-1 will be converted to MYKEY1, and my_key_1 will be converted to MY_KEY_1.

Environment variable Description
<NAME>_INTEGRATION_NAME Name supplied in the integration
<NAME>_INTEGRATION_ASSUMEROLEARN ARN Role supplied in the integration

Shippable Utility Functions

To make it easy to use these environment variables, the platform provides a command line utility that can be used to work with these values.

How to use these utility functions is documented here.

Further Reading