file_system_policies
Creates, updates, deletes, gets or lists a file_system_policies resource.
Overview
| Name | file_system_policies |
| Type | Resource |
| Id | aws.s3files.file_system_policies |
Fields
The following fields are returned by SELECT queries:
- get_file_system_policy
| Name | Datatype | Description |
|---|---|---|
file_system_id | string | The ID of the file system. (pattern: <code>(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})</code>) |
policy | string | The JSON-formatted resource policy for the file system. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_file_system_policy | select | file_system_id, region | Returns the IAM resource policy of an S3 File System. | |
put_file_system_policy | replace | file_system_id, region, policy | Creates or replaces the IAM resource policy for an S3 File System to control access permissions. | |
delete_file_system_policy | delete | file_system_id, region | Deletes the IAM resource policy of an S3 File System. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
file_system_id | string | The ID or Amazon Resource Name (ARN) of the S3 File System whose resource policy to delete. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_file_system_policy
Returns the IAM resource policy of an S3 File System.
SELECT
file_system_id,
policy
FROM aws.s3files.file_system_policies
WHERE file_system_id = '{{ file_system_id }}' -- required
AND region = '{{ region }}' -- required
;
REPLACE examples
- put_file_system_policy
Creates or replaces the IAM resource policy for an S3 File System to control access permissions.
REPLACE aws.s3files.file_system_policies
SET
policy = '{{ policy }}'
WHERE
file_system_id = '{{ file_system_id }}' --required
AND region = '{{ region }}' --required
AND policy = '{{ policy }}' --required;
DELETE examples
- delete_file_system_policy
Deletes the IAM resource policy of an S3 File System.
DELETE FROM aws.s3files.file_system_policies
WHERE file_system_id = '{{ file_system_id }}' --required
AND region = '{{ region }}' --required
;