aws-cdk-lib.aws_codeguruprofiler

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 * as codeguruprofiler from 'aws-cdk-lib/aws-codeguruprofiler';

import aws_cdk.aws_codeguruprofiler as codeguruprofiler

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

using Amazon.CDK.AWS.CodeGuruProfiler;

import codeguruprofiler "github.com/aws/aws-cdk-go/awscdk"

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)
const publishAppRole = new iam.Role(this, 'PublishAppRole', {
  assumedBy: new iam.AccountRootPrincipal(),
});

const profilingGroup = new codeguruprofiler.ProfilingGroup(this, 'MyProfilingGroup');
profilingGroup.grantPublish(publishAppRole);

# The execution role of your application that publishes to the ProfilingGroup via CodeGuru Profiler Profiling Agent. (the following is merely an example)
publish_app_role = iam.Role(self, "PublishAppRole",
    assumed_by=iam.AccountRootPrincipal()
)

profiling_group = codeguruprofiler.ProfilingGroup(self, "MyProfilingGroup")
profiling_group.grant_publish(publish_app_role)

// 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);

// The execution role of your application that publishes to the ProfilingGroup via CodeGuru Profiler Profiling Agent. (the following is merely an example)
var publishAppRole = new Role(this, "PublishAppRole", new RoleProps {
    AssumedBy = new AccountRootPrincipal()
});

var profilingGroup = new ProfilingGroup(this, "MyProfilingGroup");
profilingGroup.GrantPublish(publishAppRole);

// The execution role of your application that publishes to the ProfilingGroup via CodeGuru Profiler Profiling Agent. (the following is merely an example)
publishAppRole := iam.NewRole(this, jsii.String("PublishAppRole"), &RoleProps{
	AssumedBy: iam.NewAccountRootPrincipal(),
})

profilingGroup := codeguruprofiler.NewProfilingGroup(this, jsii.String("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:

const profilingGroup = new codeguruprofiler.ProfilingGroup(this, 'MyProfilingGroup', {
  computePlatform: codeguruprofiler.ComputePlatform.AWS_LAMBDA,
});

profiling_group = codeguruprofiler.ProfilingGroup(self, "MyProfilingGroup",
    compute_platform=codeguruprofiler.ComputePlatform.AWS_LAMBDA
)

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

var profilingGroup = new ProfilingGroup(this, "MyProfilingGroup", new ProfilingGroupProps {
    ComputePlatform = ComputePlatform.AWS_LAMBDA
});

profilingGroup := codeguruprofiler.NewProfilingGroup(this, jsii.String("MyProfilingGroup"), &ProfilingGroupProps{
	ComputePlatform: codeguruprofiler.ComputePlatform_AWS_LAMBDA,
})

Types

Name	Kind	Summary
ProfilingGroup	Construct (L2)	A new Profiling Group.
CfnProfilingGroup	Construct (L1)	Creates a profiling group.
CfnProfilingGroup.AgentPermissionsProperty	Struct	The agent permissions attached to this profiling group.
CfnProfilingGroup.ChannelProperty	Struct	Notification medium for users to get alerted for events that occur in application profile.
CfnProfilingGroupProps	Struct	Properties for defining a CfnProfilingGroup.
ComputePlatform	Enum	The compute platform of the profiling group.
IProfilingGroup	Interface	IResource represents a Profiling Group.
ProfilingGroupGrants	Facade	Collection of grant methods for a IProfilingGroupRef.
ProfilingGroupProps	Struct	Properties for creating a new Profiling Group.