aws-cdk-lib.aws_codeguruprofiler.IProfilingGroup

interface IProfilingGroup

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

Implemented by ProfilingGroup

Obtainable from ProfilingGroup.fromProfilingGroupArn(), ProfilingGroup.fromProfilingGroupName()

IResource represents a Profiling Group.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
profilingGroupArnstringThe ARN of the profiling group.
profilingGroupNamestringThe name of the profiling group.
stackStackThe stack in which this resource is defined.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node

Type: Node

The tree node.


profilingGroupArn

Type: string

The ARN of the profiling group.


profilingGroupName

Type: string

The name of the profiling group.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
grantPublish(grantee)Grant access to publish profiling information to the Profiling Group to the given identity.
grantRead(grantee)Grant access to read profiling information from the Profiling Group to the given identity.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


grantPublish(grantee)

public grantPublish(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable — Principal to grant publish rights to.

Returns

  • Grant

Grant access to publish profiling information to the Profiling Group to the given identity.

This will grant the following permissions:

  • codeguru-profiler:ConfigureAgent
  • codeguru-profiler:PostAgentProfile

grantRead(grantee)

public grantRead(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable — Principal to grant read rights to.

Returns

  • Grant

Grant access to read profiling information from the Profiling Group to the given identity.

This will grant the following permissions:

  • codeguru-profiler:GetProfile
  • codeguru-profiler:DescribeProfilingGroup