Class ProfilingGroup

A new Profiling Group.

Inheritance

object

Resource

ProfilingGroup

Implements

IProfilingGroup

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.CodeGuruProfiler

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ProfilingGroup : Resource, IProfilingGroup, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class ProfilingGroup Inherits Resource Implements IProfilingGroup, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

ExampleMetadata: infused

Examples

// The execution role of your application that publishes to the ProfilingGroup via CodeGuru Profiler Profiling Agent. (the following is merely an example)
            var publishAppRole = new Role(this, "PublishAppRole", new RoleProps {
                AssumedBy = new AccountRootPrincipal()
            });

            var profilingGroup = new ProfilingGroup(this, "MyProfilingGroup");
            profilingGroup.GrantPublish(publishAppRole);

Synopsis

Constructors

ProfilingGroup(Construct, string, IProfilingGroupProps?)

A new Profiling Group.

Properties

PROPERTY_INJECTION_ID	Uniquely identifies this class.
ProfilingGroupArn	The ARN of the Profiling Group.
ProfilingGroupName	The name of the Profiling Group.

Methods

FromProfilingGroupArn(Construct, string, string)	Import an existing Profiling Group provided an ARN.
FromProfilingGroupName(Construct, string, string)	Import an existing Profiling Group provided a Profiling Group Name.
GrantPublish(IGrantable)	Grant access to publish profiling information to the Profiling Group to the given identity.
GrantRead(IGrantable)	Grant access to read profiling information from the Profiling Group to the given identity.

Constructors

ProfilingGroup(Construct, string, IProfilingGroupProps?)

A new Profiling Group.

public ProfilingGroup(Construct scope, string id, IProfilingGroupProps? props = null)

Parameters

scope Construct
id string
props IProfilingGroupProps

Remarks

ExampleMetadata: infused

Examples

// The execution role of your application that publishes to the ProfilingGroup via CodeGuru Profiler Profiling Agent. (the following is merely an example)
            var publishAppRole = new Role(this, "PublishAppRole", new RoleProps {
                AssumedBy = new AccountRootPrincipal()
            });

            var profilingGroup = new ProfilingGroup(this, "MyProfilingGroup");
            profilingGroup.GrantPublish(publishAppRole);

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

ExampleMetadata: infused

ProfilingGroupArn

The ARN of the Profiling Group.

public virtual string ProfilingGroupArn { get; }

Property Value

string

Remarks

Attribute: true

ProfilingGroupName

The name of the Profiling Group.

public virtual string ProfilingGroupName { get; }

Property Value

string

Remarks

Attribute: true

Methods

FromProfilingGroupArn(Construct, string, string)

Import an existing Profiling Group provided an ARN.

public static IProfilingGroup FromProfilingGroupArn(Construct scope, string id, string profilingGroupArn)

Parameters

scope Construct: The parent creating construct.
id string: The construct's name.
profilingGroupArn string: Profiling Group ARN.

Returns

IProfilingGroup

Remarks

ExampleMetadata: infused

FromProfilingGroupName(Construct, string, string)

Import an existing Profiling Group provided a Profiling Group Name.

public static IProfilingGroup FromProfilingGroupName(Construct scope, string id, string profilingGroupName)

Parameters

scope Construct: The parent creating construct.
id string: The construct's name.
profilingGroupName string: Profiling Group Name.

Returns

IProfilingGroup

Remarks

ExampleMetadata: infused

GrantPublish(IGrantable)

Grant access to publish profiling information to the Profiling Group to the given identity.

public virtual Grant GrantPublish(IGrantable grantee)

Parameters

grantee IGrantable: Principal to grant publish rights to.

Returns

Grant

Remarks

This will grant the following permissions:

GrantRead(IGrantable)

Grant access to read profiling information from the Profiling Group to the given identity.

public virtual Grant GrantRead(IGrantable grantee)

Parameters

grantee IGrantable: Principal to grant read rights to.

Returns

Grant

Remarks

This will grant the following permissions:

Implements

IProfilingGroup

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware