ProfilingGroup

class aws_cdk.aws_codeguruprofiler.ProfilingGroup(scope, id, *, compute_platform=None, profiling_group_name=None)

Bases: aws_cdk.core.Resource

A new Profiling Group.

Parameters
  • scope (Construct) –

  • id (str) –

  • compute_platform (Optional[ComputePlatform]) – The compute platform of the profiling group. Default: ComputePlatform.DEFAULT

  • profiling_group_name (Optional[str]) – A name for the profiling group. Default: - automatically generated name.

Methods

apply_removal_policy(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.DELETE), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

grant_publish(grantee)

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

Parameters

grantee (IGrantable) – Principal to grant publish rights to.

Return type

Grant

grant_read(grantee)

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

Parameters

grantee (IGrantable) – Principal to grant read rights to.

Return type

Grant

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

env

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.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

profiling_group_arn

The ARN of the Profiling Group.

Attribute

true

Return type

str

profiling_group_name

The name of the Profiling Group.

Attribute

true

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_profiling_group_arn(scope, id, profiling_group_arn)

Import an existing Profiling Group provided an ARN.

Parameters
  • scope (Construct) – The parent creating construct.

  • id (str) – The construct’s name.

  • profiling_group_arn (str) – Profiling Group ARN.

Return type

IProfilingGroup

classmethod from_profiling_group_name(scope, id, profiling_group_name)

Import an existing Profiling Group provided a Profiling Group Name.

Parameters
  • scope (Construct) – The parent creating construct.

  • id (str) – The construct’s name.

  • profiling_group_name (str) – Profiling Group Name.

Return type

IProfilingGroup

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool