Skip to content

Commit 9b2c1c9

Browse files
committed
docs: IAM policy support doc
1 parent ff4e921 commit 9b2c1c9

File tree

3 files changed

+29
-0
lines changed

3 files changed

+29
-0
lines changed

docs/iam/iam-policy-support.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Tigris IAM Policy Support
2+
3+
An IAM (Identity and Access Management) policy is a set of rules that define
4+
permissions, specifying what actions can be performed on specific resources
5+
optionally with some conditions. IAM policy is very broad and in context of
6+
Tigris we support the following blocks.
7+
8+
| Block | Supported | Description |
9+
| ------------------- | --------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
10+
| Version | Yes | Specifies the version of the policy language. The supported version is `2012-10-17` |
11+
| Id | Yes | An optional identifier of the policy. |
12+
| Statement | Yes | An array of one or more statements that define the permissions. |
13+
| statement.sid_block | Yes | An optional identifier for the statement. |
14+
| statement.effect | Yes | Specifies whether the action is allowed or denied. |
15+
| statement.action | Yes | Specifies the action that is allowed. Note that here Tigris supports format `s3:MethodName`, For example: `s3:PutBucket`. Tigris supports wildcard (`*`)and prefixes (eg: `s3:Put*`) here. |
16+
| statement.resource | Yes | Specifies the Amazon Resource Name (ARN) of the resource to which the policy applies. Tigris supports wildcard (`*`) and prefixes for object (e.g.: `arn:aws:s3:::my-bucket/images/*`) |
17+
| statement.condition | Partially | Tigris supports `IpAddress`, `NotIpAddress`, `DateEquals`, `DateNotEquals`, `DateGreaterThan`, `DateGreaterThanEquals`, `DateLessThan`, `DateLessThanEquals` condition. |
18+
19+
Note that for date-time conditions - only supported variable is
20+
`aws:CurrentTime` which represents the current time when server is processing
21+
the request.

docs/iam/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ you'll need to attach IAM policies to the new access key.
3636
Let's create an IAM policy and attach it to an access key. Here's an example IAM
3737
policy. You'll need to save it as a `.json` file.
3838

39+
:::note
40+
41+
Refer [here](./iam-policy-support.md) for more information on what blocks of IAM
42+
policies are supported by Tigris.
43+
44+
:::
45+
3946
```
4047
nano file:///path/to/policy.json
4148

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ const sidebars = {
8484
label: "IAM",
8585
items: [
8686
"iam/index",
87+
"iam/iam-policy-support",
8788
"iam/limited-access-key",
8889
"iam/ip-restrictions",
8990
"iam/date-time-restrictions",

0 commit comments

Comments
 (0)