AWS CDK Reference

Appearance

v2.274.0

IProfilingGroup Interface ​

IResource represents a Profiling Group.

Source
aws-codeguruprofiler/lib/profiling-group.ts
Type last changed
v2.227.0 · 21 Nov 2025

Properties ​

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
profilingGroupArnstringprofiling_group_arnstrprofilingGroupArnStringProfilingGroupArnstringProfilingGroupArn*stringrequired#
The ARN of the profiling group.
profilingGroupNamestringprofiling_group_namestrprofilingGroupNameStringProfilingGroupNamestringProfilingGroupName*stringrequired#
The name of the profiling group.
profilingGroupRefProfilingGroupReferenceprofiling_group_refProfilingGroupReferenceprofilingGroupRefProfilingGroupReferenceProfilingGroupRefProfilingGroupReferenceProfilingGroupRefProfilingGroupReferencerequired#
A reference to a ProfilingGroup resource.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.

Methods ​

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

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: IGrantable): Grantdef grant_publish(self, grantee: IGrantable) -> Grantpublic Grant grantPublish(IGrantable grantee)public Grant GrantPublish(IGrantable grantee)func GrantPublish(Grantee IGrantable) 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
1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — Principal to grant publish rights to.
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) 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
1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — Principal to grant read rights to.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining