interface IProfilingGroup
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.CodeGuruProfiler.IProfilingGroup |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awscodeguruprofiler#IProfilingGroup |
Java | software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup |
Python | aws_cdk.aws_codeguruprofiler.IProfilingGroup |
TypeScript (source) | aws-cdk-lib » aws_codeguruprofiler » IProfilingGroup |
Implemented by
Profiling
Obtainable from
Profiling
.fromProfilingGroupArn()
, Profiling
.fromProfilingGroupName()
IResource represents a Profiling Group.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
profiling | string | The ARN of the profiling group. |
profiling | string | The name of the profiling group. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
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
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
grant | Grant access to publish profiling information to the Profiling Group to the given identity. |
grant | Grant access to read profiling information from the Profiling Group to the given identity. |
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).
Publish(grantee)
grantpublic grantPublish(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
— Principal to grant publish rights to.
Returns
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
Read(grantee)
grantpublic grantRead(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
— Principal to grant read rights to.
Returns
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