Skip to content

Commit

Permalink
Update README after release
Browse files Browse the repository at this point in the history
  • Loading branch information
flosell committed May 1, 2018
1 parent 8f132b7 commit 32c56fc
Showing 1 changed file with 35 additions and 35 deletions.
70 changes: 35 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,39 +23,7 @@ $ trailscraper download --bucket some-bucket \
--to 'now' \
```

### Find CloudTrail events and generate an IAM Policy (<0.5.0)
```
$ trailscraper generate-policy
{
"Statement": [
{
"Action": [
"ec2:DescribeInstances",
"ec2:DescribeSecurityGroups",
"ec2:DescribeSubnets",
"ec2:DescribeVolumes",
"ec2:DescribeVpcs",
],
"Effect": "Allow",
"Resource": [
"*"
]
},
{
"Action": [
"sts:AssumeRole"
],
"Effect": "Allow",
"Resource": [
"arn:aws:iam::1111111111:role/someRole"
]
}
],
"Version": "2012-10-17"
}
```

### Find CloudTrail events matching a filter (>=0.5.0) (unreleased)
### Find CloudTrail events matching a filter (>=0.5.0)

```
$ trailscraper select --filter-assumed-role-arn some-arn \
Expand All @@ -70,7 +38,7 @@ $ trailscraper select --filter-assumed-role-arn some-arn \
...
```

### Generate Policy from some CloudTrail records (>=0.5.0) (unreleased)
### Generate Policy from some CloudTrail records (>=0.5.0)

```
$ gzcat some-records.json.gz | trailscraper generate
Expand All @@ -90,7 +58,7 @@ $ gzcat some-records.json.gz | trailscraper generate
}
```

### Find CloudTrail events and generate an IAM Policy (>=0.5.0) (unreleased)
### Find CloudTrail events and generate an IAM Policy (>=0.5.0)
```
$ trailscraper select | trailscraper generate
{
Expand Down Expand Up @@ -122,6 +90,38 @@ $ trailscraper select | trailscraper generate
}
```

### Find CloudTrail events and generate an IAM Policy (<0.5.0)
```
$ trailscraper generate-policy
{
"Statement": [
{
"Action": [
"ec2:DescribeInstances",
"ec2:DescribeSecurityGroups",
"ec2:DescribeSubnets",
"ec2:DescribeVolumes",
"ec2:DescribeVpcs",
],
"Effect": "Allow",
"Resource": [
"*"
]
},
{
"Action": [
"sts:AssumeRole"
],
"Effect": "Allow",
"Resource": [
"arn:aws:iam::1111111111:role/someRole"
]
}
],
"Version": "2012-10-17"
}
```

## FAQ

### How can I generate policies in CloudFormation YAML instead of JSON?
Expand Down

0 comments on commit 32c56fc

Please sign in to comment.