aws_on_demand_tasks

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

Overview

Name	aws_on_demand_tasks
Type	Resource
Id	datadog.security.aws_on_demand_tasks

Fields

The following fields are returned by SELECT queries:

get_aws_on_demand_task

OK.

Name	Datatype	Description
id	string	The UUID of the task. (example: 6d09294c-9ad9-42fd-a759-a0c1599b4828)
attributes	object	Attributes for the AWS on demand task.
type	string	The type of the on demand task. The value should always be aws_resource. (default: aws_resource, example: aws_resource)

list_aws_on_demand_tasks

Name	Datatype	Description
id	string	The UUID of the task. (example: 6d09294c-9ad9-42fd-a759-a0c1599b4828)
attributes	object	Attributes for the AWS on demand task.
type	string	The type of the on demand task. The value should always be aws_resource. (default: aws_resource, example: aws_resource)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_aws_on_demand_task	select	task_id, region		Fetch the data of a specific on demand task.
list_aws_on_demand_tasks	select	region		Fetches the most recent 1000 AWS on demand tasks.
create_aws_on_demand_task	insert	region, data__data		Trigger the scan of an AWS resource with a high priority. Agentless scanning must be activated for the AWS account containing the resource to scan.

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	(default: datadoghq.com)
task_id	string	The UUID of the task. (example: 6d09294c-9ad9-42fd-a759-a0c1599b4828)

SELECT examples

get_aws_on_demand_task

Fetch the data of a specific on demand task.

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

list_aws_on_demand_tasks

Fetches the most recent 1000 AWS on demand tasks.

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

INSERT examples

create_aws_on_demand_task

Trigger the scan of an AWS resource with a high priority. Agentless scanning must be activated for the AWS account containing the resource to scan.

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

Manifest

# Description fields are for documentation purposes
- name: aws_on_demand_tasks
  props:
    - name: region
      value: string
      description: Required parameter for the aws_on_demand_tasks resource.
    - name: data
      value: object
      description: |
        Object for a single AWS on demand task.