aws_scan_options

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

Overview

Name	aws_scan_options
Type	Resource
Id	datadog.security.aws_scan_options

Fields

The following fields are returned by SELECT queries:

get_aws_scan_options

Name	Datatype	Description
id	string	The ID of the AWS account. (example: 184366314700)
attributes	object	Attributes for the AWS scan options.
type	string	The type of the resource. The value should always be aws_scan_options. (default: aws_scan_options, example: aws_scan_options)

list_aws_scan_options

Name	Datatype	Description
id	string	The ID of the AWS account. (example: 184366314700)
attributes	object	Attributes for the AWS scan options.
type	string	The type of the resource. The value should always be aws_scan_options. (default: aws_scan_options, example: aws_scan_options)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_aws_scan_options	select	account_id, region		Fetches the Agentless scan options for an activated account.
list_aws_scan_options	select	region		Fetches the scan options configured for AWS accounts.
create_aws_scan_options	insert	region, data__data		Activate Agentless scan options for an AWS account.
update_aws_scan_options	update	account_id, region, data__data		Update the Agentless scan options for an activated account.
delete_aws_scan_options	delete	account_id, region		Delete Agentless scan options for an AWS 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
account_id	string	The ID of an AWS account. (example: 123456789012)
region	string	(default: datadoghq.com)

SELECT examples

get_aws_scan_options

Fetches the Agentless scan options for an activated account.

SELECT
id,
attributes,
type
FROM datadog.security.aws_scan_options
WHERE account_id = '{{ account_id }}' -- required
AND region = '{{ region }}' -- required
;

list_aws_scan_options

Fetches the scan options configured for AWS accounts.

SELECT
id,
attributes,
type
FROM datadog.security.aws_scan_options
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_aws_scan_options

Activate Agentless scan options for an AWS account.

INSERT INTO datadog.security.aws_scan_options (
data__data,
region
)
SELECT 
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: aws_scan_options
  props:
    - name: region
      value: string
      description: Required parameter for the aws_scan_options resource.
    - name: data
      value: object
      description: |
        Object for the scan options of a single AWS account.

UPDATE examples

update_aws_scan_options

Update the Agentless scan options for an activated account.

UPDATE datadog.security.aws_scan_options
SET 
data__data = '{{ data }}'
WHERE 
account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required;

DELETE examples

delete_aws_scan_options

Delete Agentless scan options for an AWS account.

DELETE FROM datadog.security.aws_scan_options
WHERE account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
;