Skip to content

Commit

Permalink
fix readme format
Browse files Browse the repository at this point in the history
  • Loading branch information
dlicheva committed Jan 21, 2025
1 parent 3a23eee commit 1b37a23
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions new-components/reporters/pdf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@ The component uses environment variables for configuration.
It requires the component
environment variables defined [here](https://github.com/smithy-security/smithy/blob/main/sdk/README.md#component) as the following:

Environment Variable | Type | Required | Default | Description
|---|---|---|---|---|
CONSUMER_PDF_S3_ACCESS_KEY_ID | string | yes | - | Your S3 access key ID for a user that has write access to the bucket
CONSUMER_PDF_S3_ACCESS_KEY | string | yes | - | Your S3 access key for a user that has write access to the bucket
CONSUMER_PDF_S3_BUCKET_NAME | string | yes | - | Your S3 bucket name, e.g. "test-bucket"
CONSUMER_PDF_S3_BUCKET_REGION | string | yes | - | Your S3 bucket region, e.g. "us-west-1"

On AWS, you will need a new IAM user with programmatic access and with write permissions for your S3 bucket.
| Environment Variable | Type | Required | Default | Description |
|-------------------------------|--------|----------|---------|----------------------------------------------------------------------|
| CONSUMER_PDF_S3_ACCESS_KEY_ID | string | yes | - | Your S3 access key ID for a user that has write access to the bucket |
| CONSUMER_PDF_S3_ACCESS_KEY | string | yes | - | Your S3 access key for a user that has write access to the bucket |
| CONSUMER_PDF_S3_BUCKET_NAME | string | yes | - | Your S3 bucket name, e.g. "test-bucket" |
| CONSUMER_PDF_S3_BUCKET_REGION | string | yes | - | Your S3 bucket region, e.g. "us-west-1" |

On AWS, you will need a new IAM user with programmatic access and
with write permissions for your S3 bucket.

## How to run

Expand Down

0 comments on commit 1b37a23

Please sign in to comment.