Skip to content
v2.277.0

CfnProfilingGroupProps Struct ​

Properties for defining a CfnProfilingGroup.

Example ​

ts
// 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',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codeguruprofiler as codeguruprofiler

# agent_permissions: Any

cfn_profiling_group_props = codeguruprofiler.CfnProfilingGroupProps(
    profiling_group_name="profilingGroupName",

    # the properties below are optional
    agent_permissions=agent_permissions,
    anomaly_detection_notification_configuration=[codeguruprofiler.CfnProfilingGroup.ChannelProperty(
        channel_uri="channelUri",

        # the properties below are optional
        channel_id="channelId"
    )],
    compute_platform="computePlatform",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codeguruprofiler.*;

Object agentPermissions;

CfnProfilingGroupProps cfnProfilingGroupProps = CfnProfilingGroupProps.builder()
        .profilingGroupName("profilingGroupName")

        // the properties below are optional
        .agentPermissions(agentPermissions)
        .anomalyDetectionNotificationConfiguration(List.of(ChannelProperty.builder()
                .channelUri("channelUri")

                // the properties below are optional
                .channelId("channelId")
                .build()))
        .computePlatform("computePlatform")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeGuruProfiler;

var agentPermissions;

var cfnProfilingGroupProps = new CfnProfilingGroupProps {
    ProfilingGroupName = "profilingGroupName",

    // the properties below are optional
    AgentPermissions = agentPermissions,
    AnomalyDetectionNotificationConfiguration = new [] { new ChannelProperty {
        ChannelUri = "channelUri",

        // the properties below are optional
        ChannelId = "channelId"
    } },
    ComputePlatform = "computePlatform",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var agentPermissions interface{}

cfnProfilingGroupProps := &CfnProfilingGroupProps{
	ProfilingGroupName: jsii.String("profilingGroupName"),

	// the properties below are optional
	AgentPermissions: agentPermissions,
	AnomalyDetectionNotificationConfiguration: []interface{}{
		&ChannelProperty{
			ChannelUri: jsii.String("channelUri"),

			// the properties below are optional
			ChannelId: jsii.String("channelId"),
		},
	},
	ComputePlatform: jsii.String("computePlatform"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

agentPermissionsoptionalanyagent_permissionsoptionalAnyagentPermissionsoptionalObjectAgentPermissionsoptionalobjectAgentPermissionsoptionalinterface{} #
The agent permissions attached to this profiling group.
notes

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 .

anomalyDetectionNotificationConfigurationoptionalIResolvable | IResolvable | CfnProfilingGroup.ChannelProperty[]anomaly_detection_notification_configurationoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ChannelProperty]]]anomalyDetectionNotificationConfigurationoptionalIResolvableAnomalyDetectionNotificationConfigurationoptionalIResolvableAnomalyDetectionNotificationConfigurationoptionalinterface{} #
Adds anomaly notifications for a profiling group.
computePlatformoptionalstringcompute_platformoptionalstrcomputePlatformoptionalStringComputePlatformoptionalstringComputePlatformoptional*string #
The compute platform of the profiling group.
notes

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.

profilingGroupNamestring | IFunctionRefprofiling_group_nametyping.Union[str, IFunctionRef]profilingGroupNameStringProfilingGroupNamestringProfilingGroupNameinterface{} required #
The name of the profiling group.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
A list of tags to add to the created profiling group.