software.amazon.awscdk.services.codeguruprofiler

Class ProfilingGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.codeguruprofiler.ProfilingGroup

All Implemented Interfaces:

IResource, IProfilingGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.443Z")
 @Stability(value=Stable)
public class ProfilingGroup
extends Resource
implements IProfilingGroup

A new Profiling Group.

Example:

 // The execution role of your application that publishes to the ProfilingGroup via CodeGuru Profiler Profiling Agent. (the following is merely an example)
 Role publishAppRole = Role.Builder.create(this, "PublishAppRole")
         .assumedBy(new AccountRootPrincipal())
         .build();
 ProfilingGroup profilingGroup = new ProfilingGroup(this, "MyProfilingGroup");
 profilingGroup.grantPublish(publishAppRole);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProfilingGroup.Builder A fluent builder for ProfilingGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codeguruprofiler.IProfilingGroup

IProfilingGroup.Jsii$Default, IProfilingGroup.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	ProfilingGroup(software.constructs.Construct scope, String id)
	ProfilingGroup(software.constructs.Construct scope, String id, ProfilingGroupProps props)
protected	ProfilingGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ProfilingGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IProfilingGroup	fromProfilingGroupArn(software.constructs.Construct scope, String id, String profilingGroupArn) Import an existing Profiling Group provided an ARN.
static IProfilingGroup	fromProfilingGroupName(software.constructs.Construct scope, String id, String profilingGroupName) Import an existing Profiling Group provided a Profiling Group Name.
String	getProfilingGroupArn() The ARN of the Profiling Group.
String	getProfilingGroupName() The name of the Profiling Group.
Grant	grantPublish(IGrantable grantee) Grant access to publish profiling information to the Profiling Group to the given identity.
Grant	grantRead(IGrantable grantee) Grant access to read profiling information from the Profiling Group to the given identity.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ProfilingGroup

protected ProfilingGroup(software.amazon.jsii.JsiiObjectRef objRef)

ProfilingGroup

protected ProfilingGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ProfilingGroup

@Stability(value=Stable)
public ProfilingGroup(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @Nullable
                                               ProfilingGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

ProfilingGroup

@Stability(value=Stable)
public ProfilingGroup(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromProfilingGroupArn

@Stability(value=Stable)
 @NotNull
public static IProfilingGroup fromProfilingGroupArn(@NotNull
                                                                                       software.constructs.Construct scope,
                                                                                       @NotNull
                                                                                       String id,
                                                                                       @NotNull
                                                                                       String profilingGroupArn)

Import an existing Profiling Group provided an ARN.

Parameters:

scope - The parent creating construct. This parameter is required.

id - The construct's name. This parameter is required.

profilingGroupArn - Profiling Group ARN. This parameter is required.

fromProfilingGroupName

@Stability(value=Stable)
 @NotNull
public static IProfilingGroup fromProfilingGroupName(@NotNull
                                                                                        software.constructs.Construct scope,
                                                                                        @NotNull
                                                                                        String id,
                                                                                        @NotNull
                                                                                        String profilingGroupName)

Import an existing Profiling Group provided a Profiling Group Name.

Parameters:

scope - The parent creating construct. This parameter is required.

id - The construct's name. This parameter is required.

profilingGroupName - Profiling Group Name. This parameter is required.

grantPublish

@Stability(value=Stable)
 @NotNull
public Grant grantPublish(@NotNull
                                                             IGrantable 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

Specified by:

grantPublish in interface IProfilingGroup

Parameters:

grantee - Principal to grant publish rights to. This parameter is required.

grantRead

@Stability(value=Stable)
 @NotNull
public Grant grantRead(@NotNull
                                                          IGrantable 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

Specified by:

grantRead in interface IProfilingGroup

Parameters:

grantee - Principal to grant read rights to. This parameter is required.

getProfilingGroupArn

@Stability(value=Stable)
 @NotNull
public String getProfilingGroupArn()

The ARN of the Profiling Group.

getProfilingGroupName

@Stability(value=Stable)
 @NotNull
public String getProfilingGroupName()

The name of the Profiling Group.

Specified by:

getProfilingGroupName in interface IProfilingGroup