archive_rules

Creates, updates, deletes, gets or lists an archive_rules resource.

Overview

Name	archive_rules
Type	Resource
Id	aws.accessanalyzer.archive_rules

Fields

The following fields are returned by SELECT queries:

get_archive_rule

Name	Datatype	Description
created_at	string (date-time)	The time at which the archive rule was created.
filter	object	A filter used to define the archive rule.
rule_name	string	The name of the archive rule. (pattern: <code>[A-Za-z][A-Za-z0-9_.-]*</code>)
updated_at	string (date-time)	The time at which the archive rule was last updated.

list_archive_rules

Name	Datatype	Description
created_at	string (date-time)	The time at which the archive rule was created.
filter	object	A filter used to define the archive rule.
rule_name	string	The name of the archive rule. (pattern: <code>[A-Za-z][A-Za-z0-9_.-]*</code>)
updated_at	string (date-time)	The time at which the archive rule was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_archive_rule	select	analyzer_name, rule_name, region		Retrieves information about an archive rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
list_archive_rules	select	analyzer_name, region	nextToken, maxResults	Retrieves a list of archive rules created for the specified analyzer.
create_archive_rule	insert	analyzer_name, region, ruleName, filter		Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
update_archive_rule	update	analyzer_name, rule_name, region, filter		Updates the criteria and values for the specified archive rule.
delete_archive_rule	delete	analyzer_name, rule_name, region	clientToken	Deletes the specified archive rule.

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
analyzer_name	string	The name of the analyzer that associated with the archive rule to delete.
region	string	AWS region (default: us-east-1)
rule_name	string	The name of the rule to delete.
clientToken	string	A client token.
maxResults	integer	The maximum number of results to return in the request.
nextToken	string	A token used for pagination of results returned.

SELECT examples

get_archive_rule

Retrieves information about an archive rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.

SELECT
created_at,
filter,
rule_name,
updated_at
FROM aws.accessanalyzer.archive_rules
WHERE analyzer_name = '{{ analyzer_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND region = '{{ region }}' -- required
;

list_archive_rules

Retrieves a list of archive rules created for the specified analyzer.

SELECT
created_at,
filter,
rule_name,
updated_at
FROM aws.accessanalyzer.archive_rules
WHERE analyzer_name = '{{ analyzer_name }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_archive_rule

Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.

INSERT INTO aws.accessanalyzer.archive_rules (
ruleName,
filter,
clientToken,
analyzer_name,
region
)
SELECT 
'{{ ruleName }}' /* required */,
'{{ filter }}' /* required */,
'{{ clientToken }}',
'{{ analyzer_name }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: archive_rules
props:
  - name: analyzer_name
    value: "{{ analyzer_name }}"
    description: Required parameter for the archive_rules resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the archive_rules resource.
  - name: ruleName
    value: "{{ ruleName }}"
  - name: filter
    value: "{{ filter }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_archive_rule

Updates the criteria and values for the specified archive rule.

UPDATE aws.accessanalyzer.archive_rules
SET 
filter = '{{ filter }}',
clientToken = '{{ clientToken }}'
WHERE 
analyzer_name = '{{ analyzer_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND region = '{{ region }}' --required
AND filter = '{{ filter }}' --required;

DELETE examples

delete_archive_rule

Deletes the specified archive rule.

DELETE FROM aws.accessanalyzer.archive_rules
WHERE analyzer_name = '{{ analyzer_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;