Skip to content

Commit 572c8d3

Browse files
committed
add readme
1 parent 04aaeb7 commit 572c8d3

File tree

5 files changed

+44
-4113
lines changed

5 files changed

+44
-4113
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ dist
1818
build/
1919
.env*
2020
env.js
21+
package-lock.json

.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package-lock=false

README.md

+41-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
11
# AwsIamRole
2-
A serverless component that provisions an IAM Role
2+
A serverless component that provisions an IAM Role.
3+
4+
## Usage
5+
6+
### Declarative
7+
8+
```yml
9+
10+
name: my-aws-role
11+
stage: dev
12+
13+
14+
name: my-role
15+
service: lambda.amazonaws.com
16+
policy:
17+
arn: arn:aws:iam::aws:policy/AdministratorAccess
18+
regoin: us-east-1
19+
```
20+
21+
### Programatic
22+
23+
```js
24+
npm i --save @serverless/aws-iam-role
25+
```
26+
27+
```js
28+
29+
const role = await this.load('@serverless/aws-iam-role')
30+
31+
const inputs = {
32+
name: 'my-role',
33+
service: 'lambda.amazonaws.com',
34+
policy: {
35+
arn: 'arn:aws:iam::aws:policy/AdministratorAccess'
36+
},
37+
region: 'us-east-1'
38+
}
39+
40+
await role(inputs)
41+
42+
```

0 commit comments

Comments
 (0)