failure_mode_findings

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

Overview

Name	failure_mode_findings
Type	Resource
Id	aws.resiliencehubv2.failure_mode_findings

Fields

The following fields are returned by SELECT queries:

get_failure_mode_finding

Name	Datatype	Description
name	string	The name of the finding.
comment	string	A user-provided comment about the finding.
description	string	Resource description.
failure_category	string	The failure category of the finding. (SHARED_FATE, EXCESSIVE_LOAD, EXCESSIVE_LATENCY, MISCONFIGURATION_AND_BUGS, SINGLE_POINT_OF_FAILURE)
finding_id	string	The unique identifier of the finding. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}</code>)
infrastructure_and_code_recommendations	array	Infrastructure and code recommendations to address the finding.
observability_recommendations	array	Observability recommendations to address the finding.
policy_component	string	The policy component associated with the finding. (AVAILABILITY_SLO, MULTI_AZ_DISASTER_RECOVERY, MULTI_REGION_DISASTER_RECOVERY, DATA_RECOVERY)
reasoning	string	The reasoning behind the finding.
service_functions	array	The service functions associated with the finding.
severity	string	The severity of the finding. (LOW, MEDIUM, HIGH)
status	string	The current status of the finding. (OPEN, RESOLVED, IRRELEVANT)
testing_recommendations	array	Testing recommendations to address the finding.
updated_at	string (date-time)	The timestamp when the finding was last updated.

list_failure_mode_findings

Name	Datatype	Description
name	string	The name of the finding.
description	string	Resource description.
failure_category	string	The failure category of the finding. (SHARED_FATE, EXCESSIVE_LOAD, EXCESSIVE_LATENCY, MISCONFIGURATION_AND_BUGS, SINGLE_POINT_OF_FAILURE)
finding_id	string	The unique identifier of the finding. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}</code>)
policy_component	string	The policy component associated with the finding. (AVAILABILITY_SLO, MULTI_AZ_DISASTER_RECOVERY, MULTI_REGION_DISASTER_RECOVERY, DATA_RECOVERY)
service_arn	string	ARN identifier. (pattern: <code>arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}</code>)
severity	string	The severity of the finding. (LOW, MEDIUM, HIGH)
status	string	The current status of the finding. (OPEN, RESOLVED, IRRELEVANT)
updated_at	string (date-time)	The timestamp when the finding was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_failure_mode_finding	select	findingId, serviceArn, region		Retrieves a finding by findingId.
list_failure_mode_findings	select	serviceArn, region	severity, failureCategory, status, maxResults, nextToken	List findings.
update_failure_mode_finding	update	region, findingId, status, serviceArn		Updates an existing finding.

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
findingId	string	The unique identifier of the finding to retrieve.
region	string	AWS region (default: us-east-1)
serviceArn	string
failureCategory	string	Filter findings by failure category.
maxResults	integer
nextToken	string
severity	string	Filter findings by severity.
status	string	Filter findings by status.

SELECT examples

get_failure_mode_finding

Retrieves a finding by findingId.

SELECT
name,
comment,
description,
failure_category,
finding_id,
infrastructure_and_code_recommendations,
observability_recommendations,
policy_component,
reasoning,
service_functions,
severity,
status,
testing_recommendations,
updated_at
FROM aws.resiliencehubv2.failure_mode_findings
WHERE findingId = '{{ findingId }}' -- required
AND serviceArn = '{{ serviceArn }}' -- required
AND region = '{{ region }}' -- required
;

list_failure_mode_findings

List findings.

SELECT
name,
description,
failure_category,
finding_id,
policy_component,
service_arn,
severity,
status,
updated_at
FROM aws.resiliencehubv2.failure_mode_findings
WHERE serviceArn = '{{ serviceArn }}' -- required
AND region = '{{ region }}' -- required
AND severity = '{{ severity }}'
AND failureCategory = '{{ failureCategory }}'
AND status = '{{ status }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_failure_mode_finding

Updates an existing finding.

UPDATE aws.resiliencehubv2.failure_mode_findings
SET 
findingId = '{{ findingId }}',
status = '{{ status }}',
serviceArn = '{{ serviceArn }}',
comment = '{{ comment }}'
WHERE 
region = '{{ region }}' --required
AND findingId = '{{ findingId }}' --required
AND status = '{{ status }}' --required
AND serviceArn = '{{ serviceArn }}' --required
RETURNING
finding;