osls/docs/cli-reference/config-credentials.md

Open-source alternative to Serverless Framework

# AWS - Config Credentials

```bash
serverless config credentials --provider provider --key key --secret secret
```

## Options

- `--provider` or `-p` The provider (in this case `aws`). **Required**.
- `--key` or `-k` The `aws_access_key_id`. **Required**.
- `--secret` or `-s` The `aws_secret_access_key`. **Required**.
- `--profile` or `-n` The name of the profile which should be created.
- `--overwrite` or `-o` Overwrite the profile if it exists.

## Provided lifecycle events

- `config:credentials:config`

## Examples

### Configure the `default` profile

```bash
serverless config credentials --provider aws --key 1234 --secret 5678
```

This example will configure the `default` profile with the `aws_access_key_id` of `1234` and the `aws_secret_access_key` of `5678`.

### Configure a custom profile

```bash
serverless config credentials \
  --provider aws \
  --key 1234 \
  --secret 5678 \
  --profile custom-profile
```

This example create and configure a `custom-profile` profile with the `aws_access_key_id` of `1234` and the `aws_secret_access_key` of `5678`.

### Update an existing profile

```bash
serverless config credentials \
  --provider aws \
  --key 1234 \
  --secret 5678 \
  --profile custom-profile \
  --overwrite
```

This example overwrite `custom-profile` profile with the `aws_access_key_id` of `1234` and the `aws_secret_access_key` of `5678`.

If the profile does not exist, it will be added anyway.