resource_sets

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

Overview

Name	resource_sets
Type	Resource
Id	aws.fms.resource_sets

Fields

The following fields are returned by SELECT queries:

get_resource_set

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

list_resource_sets

Name	Datatype	Description
next_token	string	When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$</code>)
resource_sets	array	An array of ResourceSetSummary objects.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_resource_set	select	region		Gets information about a specific resource set.
list_resource_sets	select	region		Returns an array of ResourceSetSummary objects.
put_resource_set	replace	region, ResourceSet		Creates the resource set. An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.
delete_resource_set	delete	region		Deletes the specified ResourceSet.
batch_associate_resource	exec	region, ResourceSetIdentifier, Items		Associate resources to a Firewall Manager resource set.
batch_disassociate_resource	exec	region, ResourceSetIdentifier, Items		Disassociates resources from a Firewall Manager resource set.

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_resource_set

Gets information about a specific resource set.

SELECT
resource_set,
resource_set_arn
FROM aws.fms.resource_sets
WHERE region = '{{ region }}' -- required
;

list_resource_sets

Returns an array of ResourceSetSummary objects.

SELECT
next_token,
resource_sets
FROM aws.fms.resource_sets
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_resource_set

Creates the resource set. An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.

REPLACE aws.fms.resource_sets
SET 
ResourceSet = '{{ ResourceSet }}',
TagList = '{{ TagList }}'
WHERE 
region = '{{ region }}' --required
AND ResourceSet = '{{ ResourceSet }}' --required
RETURNING
resource_set,
resource_set_arn;

DELETE examples

delete_resource_set

Deletes the specified ResourceSet.

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

Lifecycle Methods

batch_associate_resource

Associate resources to a Firewall Manager resource set.

EXEC aws.fms.resource_sets.batch_associate_resource 
@region='{{ region }}' --required 
@@json=
'{
"ResourceSetIdentifier": "{{ ResourceSetIdentifier }}", 
"Items": "{{ Items }}"
}'
;

batch_disassociate_resource

Disassociates resources from a Firewall Manager resource set.

EXEC aws.fms.resource_sets.batch_disassociate_resource 
@region='{{ region }}' --required 
@@json=
'{
"ResourceSetIdentifier": "{{ ResourceSetIdentifier }}", 
"Items": "{{ Items }}"
}'
;