-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add new configuration document for connection aws
- Loading branch information
1 parent
b9989e9
commit 6d14fa1
Showing
3 changed files
with
87 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
title: aws | ||
sidebar_label: aws | ||
--- | ||
|
||
# aws | ||
|
||
The `aws` connection can be used to access Amazon Web Services resources. | ||
|
||
```hcl | ||
connection "aws" "my_creds" { | ||
profile = "aws-account-01" | ||
} | ||
``` | ||
|
||
## Arguments | ||
|
||
| Name | Type | Required? | Description | | ||
| --------------- | ------ | --------- | -------------------------------------------------------------------------------------------------------------------------- | | ||
| `profile` | String | Optional | The [AWS Profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) 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](#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](https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_connections_environment.html) (`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. | ||
|
||
## Examples | ||
|
||
### Static Connections | ||
|
||
```hcl | ||
connection "aws" "aws_static" { | ||
access_key = "ASIAQGDFAKEKGUI5MCEU" | ||
secret_key = "QhLNLGM5MBkXiZm2k2tfake+TduEaCkCdpCSLl6U" | ||
} | ||
``` | ||
|
||
### AWS Profile | ||
|
||
```hcl | ||
connection "aws" "aws_profile" { | ||
profile = "awx_prod_01" | ||
} | ||
``` | ||
|
||
### Using AWS Connections in Container Step | ||
|
||
```hcl | ||
pipeline "ex1" { | ||
param "cred" { | ||
type = string | ||
default = "default" | ||
} | ||
step "container" "aws" { | ||
image = "public.ecr.aws/aws-cli/aws-cli" | ||
cmd = [ "s3", "ls" ] | ||
env = connection.aws[param.cred].env | ||
} | ||
} | ||
``` |