profiling_groups

Creates, updates, deletes or gets a profiling_group resource or lists profiling_groups in a region

Overview

Name	profiling_groups
Type	Resource
Description	This resource schema represents the Profiling Group resource in the Amazon CodeGuru Profiler service.
Id	aws.codeguruprofiler.profiling_groups

Fields

Name	Datatype	Description
profiling_group_name	string	The name of the profiling group.
compute_platform	string	The compute platform of the profiling group.
agent_permissions	object	The agent permissions attached to this profiling group.
anomaly_detection_notification_configuration	array	Configuration for Notification Channels for Anomaly Detection feature in CodeGuru Profiler which enables customers to detect anomalies in the application profile for those methods that represent the highest proportion of CPU time or latency
arn	string	The Amazon Resource Name (ARN) of the specified profiling group.
tags	array	The tags associated with a profiling group.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ProfilingGroupName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all profiling_groups in a region.

SELECT
region,
profiling_group_name,
compute_platform,
agent_permissions,
anomaly_detection_notification_configuration,
arn,
tags
FROM aws.codeguruprofiler.profiling_groups
WHERE region = 'us-east-1';

Gets all properties from an individual profiling_group.

SELECT
region,
profiling_group_name,
compute_platform,
agent_permissions,
anomaly_detection_notification_configuration,
arn,
tags
FROM aws.codeguruprofiler.profiling_groups
WHERE region = 'us-east-1' AND data__Identifier = '<ProfilingGroupName>';

INSERT example

Use the following StackQL query and manifest file to create a new profiling_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.codeguruprofiler.profiling_groups (
 ProfilingGroupName,
 region
)
SELECT 
'{{ ProfilingGroupName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.codeguruprofiler.profiling_groups (
 ProfilingGroupName,
 ComputePlatform,
 AgentPermissions,
 AnomalyDetectionNotificationConfiguration,
 Tags,
 region
)
SELECT 
 '{{ ProfilingGroupName }}',
 '{{ ComputePlatform }}',
 '{{ AgentPermissions }}',
 '{{ AnomalyDetectionNotificationConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: profiling_group
    props:
      - name: ProfilingGroupName
        value: '{{ ProfilingGroupName }}'
      - name: ComputePlatform
        value: '{{ ComputePlatform }}'
      - name: AgentPermissions
        value:
          Principals:
            - '{{ Principals[0] }}'
      - name: AnomalyDetectionNotificationConfiguration
        value:
          - channelId: '{{ channelId }}'
            channelUri: '{{ channelUri }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.codeguruprofiler.profiling_groups
WHERE data__Identifier = '<ProfilingGroupName>'
AND region = 'us-east-1';

Permissions

To operate on the profiling_groups resource, the following permissions are required:

Create

sns:Publish,
codeguru-profiler:AddNotificationChannels,
codeguru-profiler:CreateProfilingGroup,
codeguru-profiler:PutPermission,
codeguru-profiler:TagResource

Read

codeguru-profiler:DescribeProfilingGroup,
codeguru-profiler:ListTagsForResource

Update

sns:Publish,
codeguru-profiler:AddNotificationChannels,
codeguru-profiler:GetNotificationConfiguration,
codeguru-profiler:RemoveNotificationChannel,
codeguru-profiler:PutPermission,
codeguru-profiler:RemovePermission,
codeguru-profiler:GetPolicy,
codeguru-profiler:TagResource,
codeguru-profiler:UntagResource,
codeguru-profiler:ListTagsForResource

Delete

codeguru-profiler:DeleteProfilingGroup

List

codeguru-profiler:ListProfilingGroups,
codeguru-profiler:ListTagsForResource