Skip to content

Commit 55cd4e1

Browse files
author
wuychloe@amazon.com chloe1818
committed
Fixed README to use aws-region when configuring credentials and clarified usage section description.
1 parent 319493d commit 55cd4e1

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,11 @@ jobs:
6060
# Add any additional inputs your action supports
6161
```
6262

63-
The required parameters to deploy are function name, code artifacts directory, handler, and runtime. The function name and code artifacts directory need to be provided by the user. However, the handler and runtime do not and will default to index.handler and nodejs20.x if not provided.
63+
The action automatically updates your Lambda function code when the required parameters are provided. If the function doesn't exist, it will be created first and then updated.
64+
65+
Required parameters include function name, code artifacts directory, handler, and runtime. While function name and code artifacts directory must be specified, handler and runtime will default to `index.handler` and `nodejs20.x` respectively if not provided.
66+
67+
The following examples demonstrate additional features available:
6468

6569
### Update Function Configuration
6670

@@ -178,7 +182,8 @@ Here's an example of using OIDC with the aws-actions/configure-aws-credentials a
178182
- name: Configure AWS credentials with OIDC
179183
uses: aws-actions/configure-aws-credentials@v2
180184
with:
181-
role-to-assume: arn:aws:iam::123456789012:role/GitHubActionRole
185+
role-to-assume: my-role
186+
aws-region: my-region
182187
```
183188

184189
To use OIDC authentication, you must configure a trust policy in AWS IAM that allows GitHub Actions to assume an IAM role. Here's an example trust policy:

0 commit comments

Comments
 (0)