workloads

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

Overview

Name	workloads
Type	Resource
Id	aws.application_insights.workloads

Fields

The following fields are returned by SELECT queries:

describe_workload

Name	Datatype	Description
workload_configuration	object	The configuration settings of the workload. The value is the escaped JSON of the configuration.
workload_id	string	The ID of the workload. (pattern: <code>w-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)
workload_remarks	string	If logging is supported for the resource type, shows whether the component has configured logs to be monitored.

list_workloads

Name	Datatype	Description
next_token	string	The token to request the next page of results. (pattern: <code>.+</code>)
workload_list	array	The list of workloads.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_workload	select	region		Describes a workload and its configuration.
list_workloads	select	region		Lists the workloads that are configured on a given component.
add_workload	update	region, ResourceGroupName, ComponentName, WorkloadConfiguration		Adds a workload to a component. Each component can have at most five workloads.
remove_workload	update	region, ResourceGroupName, ComponentName, WorkloadId		Remove workload from a component.
update_workload	exec	region, ResourceGroupName, ComponentName, WorkloadConfiguration		Adds a workload to a component. Each component can have at most five workloads.

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

describe_workload

Describes a workload and its configuration.

SELECT
workload_configuration,
workload_id,
workload_remarks
FROM aws.application_insights.workloads
WHERE region = '{{ region }}' -- required
;

list_workloads

Lists the workloads that are configured on a given component.

SELECT
next_token,
workload_list
FROM aws.application_insights.workloads
WHERE region = '{{ region }}' -- required
;

UPDATE examples

add_workload

Adds a workload to a component. Each component can have at most five workloads.

UPDATE aws.application_insights.workloads
SET 
ResourceGroupName = '{{ ResourceGroupName }}',
ComponentName = '{{ ComponentName }}',
WorkloadConfiguration = '{{ WorkloadConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND ResourceGroupName = '{{ ResourceGroupName }}' --required
AND ComponentName = '{{ ComponentName }}' --required
AND WorkloadConfiguration = '{{ WorkloadConfiguration }}' --required
RETURNING
workload_configuration,
workload_id;

remove_workload

Remove workload from a component.

UPDATE aws.application_insights.workloads
SET 
ResourceGroupName = '{{ ResourceGroupName }}',
ComponentName = '{{ ComponentName }}',
WorkloadId = '{{ WorkloadId }}'
WHERE 
region = '{{ region }}' --required
AND ResourceGroupName = '{{ ResourceGroupName }}' --required
AND ComponentName = '{{ ComponentName }}' --required
AND WorkloadId = '{{ WorkloadId }}' --required;

Lifecycle Methods

update_workload

Adds a workload to a component. Each component can have at most five workloads.

EXEC aws.application_insights.workloads.update_workload 
@region='{{ region }}' --required 
@@json=
'{
"ResourceGroupName": "{{ ResourceGroupName }}", 
"ComponentName": "{{ ComponentName }}", 
"WorkloadId": "{{ WorkloadId }}", 
"WorkloadConfiguration": "{{ WorkloadConfiguration }}"
}'
;