@Stability(value=Stable)

Package software.amazon.awscdk.services.codeguruprofiler

AWS::CodeGuruProfiler Construct Library

See: Description

Interface Summary

Interface	Description
CfnProfilingGroup.AgentPermissionsProperty	Example:
CfnProfilingGroup.ChannelProperty	Notification medium for users to get alerted for events that occur in application profile.
CfnProfilingGroupProps	Properties for defining a `CfnProfilingGroup`.
IProfilingGroup	IResource represents a Profiling Group.
IProfilingGroup.Jsii$Default	Internal default implementation for IProfilingGroup.
ProfilingGroupProps	Properties for creating a new Profiling Group.

Class Summary

Class	Description
$Module
CfnProfilingGroup	A CloudFormation `AWS::CodeGuruProfiler::ProfilingGroup`.
CfnProfilingGroup.AgentPermissionsProperty.Builder	A builder for CfnProfilingGroup.AgentPermissionsProperty
CfnProfilingGroup.AgentPermissionsProperty.Jsii$Proxy	An implementation for CfnProfilingGroup.AgentPermissionsProperty
CfnProfilingGroup.Builder	A fluent builder for CfnProfilingGroup.
CfnProfilingGroup.ChannelProperty.Builder	A builder for CfnProfilingGroup.ChannelProperty
CfnProfilingGroup.ChannelProperty.Jsii$Proxy	An implementation for CfnProfilingGroup.ChannelProperty
CfnProfilingGroupProps.Builder	A builder for CfnProfilingGroupProps
CfnProfilingGroupProps.Jsii$Proxy	An implementation for CfnProfilingGroupProps
IProfilingGroup.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
ProfilingGroup	A new Profiling Group.
ProfilingGroup.Builder	A fluent builder for ProfilingGroup.
ProfilingGroupProps.Builder	A builder for ProfilingGroupProps
ProfilingGroupProps.Jsii$Proxy	An implementation for ProfilingGroupProps

Enum Summary

Enum	Description
ComputePlatform	The compute platform of the profiling group.

Package software.amazon.awscdk.services.codeguruprofiler Description

AWS::CodeGuruProfiler Construct Library

---

Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance.

Installation

Import to your project:

 import software.amazon.awscdk.services.codeguruprofiler.*;
 

Basic usage

Here's how to setup a profiling group and give your compute role permissions to publish to the profiling group to the profiling agent can publish profiling information:

 // The execution role of your application that publishes to the ProfilingGroup via CodeGuru Profiler Profiling Agent. (the following is merely an example)
 Role publishAppRole = Role.Builder.create(this, "PublishAppRole")
         .assumedBy(new AccountRootPrincipal())
         .build();
 
 ProfilingGroup profilingGroup = new ProfilingGroup(this, "MyProfilingGroup");
 profilingGroup.grantPublish(publishAppRole);
 

Compute Platform configuration

Code Guru Profiler supports multiple compute environments. They can be configured when creating a Profiling Group by using the computePlatform property:

 ProfilingGroup profilingGroup = ProfilingGroup.Builder.create(this, "MyProfilingGroup")
         .computePlatform(ComputePlatform.AWS_LAMBDA)
         .build();