ProfilingGroup

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

Bases: Resource

A new Profiling Group.

ExampleMetadata:

infused

Example:

# 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)
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.DESTROY), 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

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-codeguruprofiler.ProfilingGroup'
env

The environment this resource belongs to.

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.

node

The tree node.

profiling_group_arn

The ARN of the Profiling Group.

Attribute:

true

profiling_group_name

The name of the Profiling Group.

Attribute:

true

stack

The stack in which this resource is defined.

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)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct)

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct)

Return type:

bool