aws-cdk-lib.aws_codeguruprofiler.CfnProfilingGroupProps

interface CfnProfilingGroupProps

LanguageType name
.NETAmazon.CDK.AWS.CodeGuruProfiler.CfnProfilingGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodeguruprofiler#CfnProfilingGroupProps
Javasoftware.amazon.awscdk.services.codeguruprofiler.CfnProfilingGroupProps
Pythonaws_cdk.aws_codeguruprofiler.CfnProfilingGroupProps
TypeScript aws-cdk-lib » aws_codeguruprofiler » CfnProfilingGroupProps

Properties for defining a CfnProfilingGroup.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codeguruprofiler as codeguruprofiler } from 'aws-cdk-lib';

declare const agentPermissions: any;
const cfnProfilingGroupProps: codeguruprofiler.CfnProfilingGroupProps = {
  profilingGroupName: 'profilingGroupName',

  // the properties below are optional
  agentPermissions: agentPermissions,
  anomalyDetectionNotificationConfiguration: [{
    channelUri: 'channelUri',

    // the properties below are optional
    channelId: 'channelId',
  }],
  computePlatform: 'computePlatform',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
profilingGroupNamestringThe name of the profiling group.
agentPermissions?anyThe agent permissions attached to this profiling group.
anomalyDetectionNotificationConfiguration?IResolvable | IResolvable | ChannelProperty[]Adds anomaly notifications for a profiling group.
computePlatform?stringThe compute platform of the profiling group.
tags?CfnTag[]A list of tags to add to the created profiling group.

profilingGroupName

Type: string

The name of the profiling group.


agentPermissions?

Type: any (optional)

The agent permissions attached to this profiling group.

This action group grants ConfigureAgent and PostAgentProfile permissions to perform actions required by the profiling agent. The Json consists of key Principals .

Principals : A list of string ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not supported in the ARNs. You are allowed to provide up to 50 ARNs. An empty list is not permitted. This is a required key.

For more information, see Resource-based policies in CodeGuru Profiler in the Amazon CodeGuru Profiler user guide , ConfigureAgent , and PostAgentProfile .


anomalyDetectionNotificationConfiguration?

Type: IResolvable | IResolvable | ChannelProperty[] (optional)

Adds anomaly notifications for a profiling group.


computePlatform?

Type: string (optional)

The compute platform of the profiling group.

Use AWSLambda if your application runs on AWS Lambda. Use Default if your application runs on a compute platform that is not AWS Lambda , such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, Default is used. This property is immutable.


tags?

Type: CfnTag[] (optional)

A list of tags to add to the created profiling group.