software.amazon.awscdk.services.codeguruprofiler

Class CfnProfilingGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.codeguruprofiler.CfnProfilingGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:26.603Z")
public class CfnProfilingGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CodeGuruProfiler::ProfilingGroup`.

Creates a profiling group.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codeguruprofiler.*;
 Object agentPermissions;
 CfnProfilingGroup cfnProfilingGroup = CfnProfilingGroup.Builder.create(this, "MyCfnProfilingGroup")
         .profilingGroupName("profilingGroupName")
         // the properties below are optional
         .agentPermissions(agentPermissions)
         .anomalyDetectionNotificationConfiguration(List.of(ChannelProperty.builder()
                 .channelUri("channelUri")
                 // the properties below are optional
                 .channelId("channelId")
                 .build()))
         .computePlatform("computePlatform")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnProfilingGroup.AgentPermissionsProperty Example:
static class	CfnProfilingGroup.Builder A fluent builder for CfnProfilingGroup.
static interface	CfnProfilingGroup.ChannelProperty Notification medium for users to get alerted for events that occur in application profile.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnProfilingGroup(Construct scope, java.lang.String id, CfnProfilingGroupProps props) Create a new `AWS::CodeGuruProfiler::ProfilingGroup`.
protected	CfnProfilingGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnProfilingGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAgentPermissions() The agent permissions attached to this profiling group.
java.lang.Object	getAnomalyDetectionNotificationConfiguration() Adds anomaly notifications for a profiling group.
java.lang.String	getAttrArn() The full Amazon Resource Name (ARN) for that profiling group.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getComputePlatform() The compute platform of the profiling group.
java.lang.String	getProfilingGroupName() The name of the profiling group.
TagManager	getTags() A list of tags to add to the created profiling group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAgentPermissions(java.lang.Object value) The agent permissions attached to this profiling group.
void	setAnomalyDetectionNotificationConfiguration(IResolvable value) Adds anomaly notifications for a profiling group.
void	setAnomalyDetectionNotificationConfiguration(java.util.List<java.lang.Object> value) Adds anomaly notifications for a profiling group.
void	setComputePlatform(java.lang.String value) The compute platform of the profiling group.
void	setProfilingGroupName(java.lang.String value) The name of the profiling group.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnProfilingGroup

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

CfnProfilingGroup

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

CfnProfilingGroup

public CfnProfilingGroup(Construct scope,
                         java.lang.String id,
                         CfnProfilingGroupProps props)

Create a new `AWS::CodeGuruProfiler::ProfilingGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The full Amazon Resource Name (ARN) for that profiling group.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

A list of tags to add to the created profiling group.

getAgentPermissions

public java.lang.Object getAgentPermissions()

The agent permissions attached to this profiling group.

This action group grants ConfigureAgent and PostAgentProfile permissions to perform actions required by the profiling agent. The Json consists of key Principals .

Principals : A list of string ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not supported in the ARNs. You are allowed to provide up to 50 ARNs. An empty list is not permitted. This is a required key.

For more information, see Resource-based policies in CodeGuru Profiler in the Amazon CodeGuru Profiler user guide , ConfigureAgent , and PostAgentProfile .

setAgentPermissions

public void setAgentPermissions(java.lang.Object value)

The agent permissions attached to this profiling group.

This action group grants ConfigureAgent and PostAgentProfile permissions to perform actions required by the profiling agent. The Json consists of key Principals .

Principals : A list of string ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not supported in the ARNs. You are allowed to provide up to 50 ARNs. An empty list is not permitted. This is a required key.

For more information, see Resource-based policies in CodeGuru Profiler in the Amazon CodeGuru Profiler user guide , ConfigureAgent , and PostAgentProfile .

getProfilingGroupName

public java.lang.String getProfilingGroupName()

The name of the profiling group.

setProfilingGroupName

public void setProfilingGroupName(java.lang.String value)

The name of the profiling group.

getAnomalyDetectionNotificationConfiguration

public java.lang.Object getAnomalyDetectionNotificationConfiguration()

Adds anomaly notifications for a profiling group.

setAnomalyDetectionNotificationConfiguration

public void setAnomalyDetectionNotificationConfiguration(IResolvable value)

Adds anomaly notifications for a profiling group.

setAnomalyDetectionNotificationConfiguration

public void setAnomalyDetectionNotificationConfiguration(java.util.List<java.lang.Object> value)

Adds anomaly notifications for a profiling group.

getComputePlatform

public java.lang.String getComputePlatform()

The compute platform of the profiling group.

Use AWSLambda if your application runs on AWS Lambda. Use Default if your application runs on a compute platform that is not AWS Lambda , such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, Default is used. This property is immutable.

setComputePlatform

public void setComputePlatform(java.lang.String value)

The compute platform of the profiling group.

Use AWSLambda if your application runs on AWS Lambda. Use Default if your application runs on a compute platform that is not AWS Lambda , such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, Default is used. This property is immutable.