Get Involved
aws
The aws connection can be used to access Amazon Web Services resources.
Arguments
| Name | Type | Required? | Description |
|---|---|---|---|
| profile | String | Optional | The AWS Profile to use to obtain connections. |
| access_key | String | Optional | A static AWS access key to use to authenticate. |
| secret_key | String | Optional | A static AWS secret key to use to authenticate. |
| session_token | String | Optional | A static AWS session token to use to authenticate. This is only used if you specify access_key and secret_key. |
| ttl | Number | Optional | The time, in seconds, to cache the connections. By default, the AWS connection will be cached for 5 minutes. |
All arguments are optional, and an aws connection with no arguments will behave the same as the AWS default connection. You may instead specify exactly one of:
- profile
- access_key and secret_key (and optionally session_token)
Attributes (Read-Only)
| Attribute | Type | Description |
|---|---|---|
| access_key | String | The AWS access key to use to authenticate. If you specified the access_key arg, then this is the argument value verbatim. If you have specified profile, then this is the resolved temporary access key for that profile. |
| secret_key | String | The AWS secret key to use to authenticate. If you specified the secret_key arg, then this is the argument value verbatim. If you have specified profile, then this is the resolved temporary secret key for that profile. |
| session_token | String | The AWS session token to use to authenticate. If you specified the session_token arg, then this is the argument value verbatim. If you have specified profile, then this is the resolved temporary session token for that profile. |
| env | Map | A map of the resolved connection-related environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN, AWS_PROFILE) |
Default Connection
The AWS connection type includes an implicit, default connection (connection.aws.default) that will be configured using the same mechanism as the AWS CLI (AWS environment variables, default profile, etc); the effective connections of this default are the same as if you run the aws command.