protocols_lists

Creates, updates, deletes, gets or lists a protocols_lists resource.

Overview

Name	protocols_lists
Type	Resource
Id	aws.fms.protocols_lists

Fields

The following fields are returned by SELECT queries:

get_protocols_list

Name	Datatype	Description
protocols_list	object	Information about the specified Firewall Manager protocols list.
protocols_list_arn	string	The Amazon Resource Name (ARN) of the specified protocols list. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$</code>)

list_protocols_lists

Name	Datatype	Description
list_arn	string	The Amazon Resource Name (ARN) of the specified protocols list. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$</code>)
list_id	string	The ID of the specified protocols list. (pattern: <code>^[a-z0-9A-Z-]{36}$</code>)
list_name	string	The name of the specified protocols list. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$</code>)
protocols_list	array	An array of protocols in the Firewall Manager protocols list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_protocols_list	select	region		Returns information about the specified Firewall Manager protocols list.
list_protocols_lists	select	region		Returns an array of ProtocolsListDataSummary objects.
put_protocols_list	replace	region, ProtocolsList		Creates an Firewall Manager protocols list.
delete_protocols_list	delete	region		Permanently deletes an Firewall Manager protocols 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_protocols_list

Returns information about the specified Firewall Manager protocols list.

SELECT
protocols_list,
protocols_list_arn
FROM aws.fms.protocols_lists
WHERE region = '{{ region }}' -- required
;

list_protocols_lists

Returns an array of ProtocolsListDataSummary objects.

SELECT
list_arn,
list_id,
list_name,
protocols_list
FROM aws.fms.protocols_lists
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_protocols_list

Creates an Firewall Manager protocols list.

REPLACE aws.fms.protocols_lists
SET 
ProtocolsList = '{{ ProtocolsList }}',
TagList = '{{ TagList }}'
WHERE 
region = '{{ region }}' --required
AND ProtocolsList = '{{ ProtocolsList }}' --required
RETURNING
protocols_list,
protocols_list_arn;

DELETE examples

delete_protocols_list

Permanently deletes an Firewall Manager protocols list.

DELETE FROM aws.fms.protocols_lists
WHERE region = '{{ region }}' --required
;