dependencies

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

Overview

Name	dependencies
Type	Resource
Id	aws.resiliencehubv2.dependencies

Fields

The following fields are returned by SELECT queries:

list_dependencies

Name	Datatype	Description
comment	string	A user-provided comment about the dependency.
criticality	string	The criticality level of the dependency. (HARD, SOFT, UNKNOWN)
dependency_id	string	The unique identifier of the dependency. (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>)
dependency_name	string	The name of the dependency.
dns_name	string	The DNS name associated with the dependency.
last_detected_time	string (date-time)	The timestamp when the dependency was last detected.
location	string	The location of the dependency.
provider	string	The provider of the dependency.
query_range	object	The query range data for the dependency.
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>)
source_regions	array	The source Regions from which the dependency was detected.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_dependencies	select	region	serviceArn, queryRangeStartTime, queryRangeEndTime, queryRangeGranularity, maxResults, nextToken	Lists dependencies discovered for services.
update_dependency	update	region, serviceArn, dependencyId		Updates a dependency classification.

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)
maxResults	integer
nextToken	string
queryRangeEndTime	string (date-time)	The end time for the dependency query range.
queryRangeGranularity	string	The granularity for the dependency query range.
queryRangeStartTime	string (date-time)	The start time for the dependency query range.
serviceArn	string

SELECT examples

list_dependencies

Lists dependencies discovered for services.

SELECT
comment,
criticality,
dependency_id,
dependency_name,
dns_name,
last_detected_time,
location,
provider,
query_range,
service_arn,
source_regions
FROM aws.resiliencehubv2.dependencies
WHERE region = '{{ region }}' -- required
AND serviceArn = '{{ serviceArn }}'
AND queryRangeStartTime = '{{ queryRangeStartTime }}'
AND queryRangeEndTime = '{{ queryRangeEndTime }}'
AND queryRangeGranularity = '{{ queryRangeGranularity }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_dependency

Updates a dependency classification.

UPDATE aws.resiliencehubv2.dependencies
SET 
serviceArn = '{{ serviceArn }}',
dependencyId = '{{ dependencyId }}',
criticality = '{{ criticality }}',
comment = '{{ comment }}'
WHERE 
region = '{{ region }}' --required
AND serviceArn = '{{ serviceArn }}' --required
AND dependencyId = '{{ dependencyId }}' --required
RETURNING
comment,
criticality,
dependency_id,
dependency_name,
location,
provider,
updated_at;