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	awscc.codeguruprofiler.profiling_groups

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
profiling_group_name	string	The name of the profiling group.
region	string	AWS region.

For more information, see AWS::CodeGuruProfiler::ProfilingGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	profiling_groups	INSERT	ProfilingGroupName, region
delete_resource	profiling_groups	DELETE	Identifier, region
update_resource	profiling_groups	UPDATE	Identifier, PatchDocument, region
list_resources	profiling_groups_list_only	SELECT	region
get_resource	profiling_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual profiling_group.

SELECT
  region,
  profiling_group_name,
  compute_platform,
  agent_permissions,
  anomaly_detection_notification_configuration,
  arn,
  tags
FROM awscc.codeguruprofiler.profiling_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ profiling_group_name }}';

list (identifiers only)

Lists all profiling_groups in a region.

SELECT
  region,
  profiling_group_name
FROM awscc.codeguruprofiler.profiling_groups_list_only
WHERE
  region = 'us-east-1';

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 awscc.codeguruprofiler.profiling_groups (
  ProfilingGroupName,
  region
)
SELECT
  '{{ profiling_group_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.codeguruprofiler.profiling_groups (
  ProfilingGroupName,
  ComputePlatform,
  AgentPermissions,
  AnomalyDetectionNotificationConfiguration,
  Tags,
  region
)
SELECT
  '{{ profiling_group_name }}',
  '{{ compute_platform }}',
  '{{ agent_permissions }}',
  '{{ anomaly_detection_notification_configuration }}',
  '{{ 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: profiling_group_name
        value: '{{ profiling_group_name }}'
      - name: compute_platform
        value: '{{ compute_platform }}'
      - name: agent_permissions
        value:
          principals:
            - '{{ principals[0] }}'
      - name: anomaly_detection_notification_configuration
        value:
          - channel_id: '{{ channel_id }}'
            channel_uri: '{{ channel_uri }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.codeguruprofiler.profiling_groups
SET PatchDocument = string('{{ {
    "AgentPermissions": agent_permissions,
    "AnomalyDetectionNotificationConfiguration": anomaly_detection_notification_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ profiling_group_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.codeguruprofiler.profiling_groups
WHERE
  Identifier = '{{ profiling_group_name }}' 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,
codeguru-profiler:GetNotificationConfiguration,
codeguru-profiler:GetPolicy

Update

sns:Publish,
codeguru-profiler:DescribeProfilingGroup,
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,
codeguru-profiler:GetNotificationConfiguration,
codeguru-profiler:GetPolicy