ec2_deep_inspection_configurations

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

Overview

Name	ec2_deep_inspection_configurations
Type	Resource
Id	aws.inspector2.ec2_deep_inspection_configurations

Fields

The following fields are returned by SELECT queries:

get_ec2_deep_inspection_configuration

Name	Datatype	Description
error_message	string	An error message explaining why Amazon Inspector deep inspection configurations could not be retrieved for your account.
org_package_paths	array	The Amazon Inspector deep inspection custom paths for your organization.
package_paths	array	The Amazon Inspector deep inspection custom paths for your account.
status	string	The activation status of Amazon Inspector deep inspection in your account. (ACTIVATED, DEACTIVATED, PENDING, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ec2_deep_inspection_configuration	select	region		Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.
update_org_ec2_deep_inspection_configuration	update	region, orgPackagePaths		Updates the Amazon Inspector deep inspection custom paths for your organization. You must be an Amazon Inspector delegated administrator to use this API.
update_ec2_deep_inspection_configuration	update	region		Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.

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_ec2_deep_inspection_configuration

Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.

SELECT
error_message,
org_package_paths,
package_paths,
status
FROM aws.inspector2.ec2_deep_inspection_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_org_ec2_deep_inspection_configuration

Updates the Amazon Inspector deep inspection custom paths for your organization. You must be an Amazon Inspector delegated administrator to use this API.

UPDATE aws.inspector2.ec2_deep_inspection_configurations
SET 
orgPackagePaths = '{{ orgPackagePaths }}'
WHERE 
region = '{{ region }}' --required
AND orgPackagePaths = '{{ orgPackagePaths }}' --required;

update_ec2_deep_inspection_configuration

Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.

UPDATE aws.inspector2.ec2_deep_inspection_configurations
SET 
activateDeepInspection = {{ activateDeepInspection }},
packagePaths = '{{ packagePaths }}'
WHERE 
region = '{{ region }}' --required
RETURNING
error_message,
org_package_paths,
package_paths,
status;