apps_lists
Creates, updates, deletes, gets or lists an apps_lists resource.
Overview
| Name | apps_lists |
| Type | Resource |
| Id | aws.fms.apps_lists |
Fields
The following fields are returned by SELECT queries:
- get_apps_list
- list_apps_lists
| Name | Datatype | Description |
|---|---|---|
apps_list | object | Information about the specified Firewall Manager applications list. |
apps_list_arn | string | The Amazon Resource Name (ARN) of the applications list. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$</code>) |
| Name | Datatype | Description |
|---|---|---|
apps_list | array | An array of App objects in the Firewall Manager applications list. |
list_arn | string | The Amazon Resource Name (ARN) of the applications list. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$</code>) |
list_id | string | The ID of the applications list. (pattern: <code>^[a-z0-9A-Z-]{36}$</code>) |
list_name | string | The name of the applications list. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_apps_list | select | region | Returns information about the specified Firewall Manager applications list. | |
list_apps_lists | select | region | Returns an array of AppsListDataSummary objects. | |
put_apps_list | replace | region, AppsList | Creates an Firewall Manager applications list. | |
delete_apps_list | delete | region | Permanently deletes an Firewall Manager applications list. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_apps_list
- list_apps_lists
Returns information about the specified Firewall Manager applications list.
SELECT
apps_list,
apps_list_arn
FROM aws.fms.apps_lists
WHERE region = '{{ region }}' -- required
;
Returns an array of AppsListDataSummary objects.
SELECT
apps_list,
list_arn,
list_id,
list_name
FROM aws.fms.apps_lists
WHERE region = '{{ region }}' -- required
;
REPLACE examples
- put_apps_list
Creates an Firewall Manager applications list.
REPLACE aws.fms.apps_lists
SET
AppsList = '{{ AppsList }}',
TagList = '{{ TagList }}'
WHERE
region = '{{ region }}' --required
AND AppsList = '{{ AppsList }}' --required
RETURNING
apps_list,
apps_list_arn;
DELETE examples
- delete_apps_list
Permanently deletes an Firewall Manager applications list.
DELETE FROM aws.fms.apps_lists
WHERE region = '{{ region }}' --required
;