software.amazon.awscdk.services.codeguruprofiler

Class CfnProfilingGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.codeguruprofiler.CfnProfilingGroup

All Implemented Interfaces:

IInspectable, 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.440Z")
 @Stability(value=Stable)
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 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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnProfilingGroup(software.constructs.Construct scope, 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
Object	getAgentPermissions() The agent permissions attached to this profiling group.
Object	getAnomalyDetectionNotificationConfiguration() Adds anomaly notifications for a profiling group.
String	getAttrArn() The full Amazon Resource Name (ARN) for that profiling group.
protected Map<String,Object>	getCfnProperties()
String	getComputePlatform() The compute platform of the profiling group.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAgentPermissions(Object value) The agent permissions attached to this profiling group.
void	setAnomalyDetectionNotificationConfiguration(IResolvable value) Adds anomaly notifications for a profiling group.
void	setAnomalyDetectionNotificationConfiguration(List<Object> value) Adds anomaly notifications for a profiling group.
void	setComputePlatform(String value) The compute platform of the profiling group.
void	setProfilingGroupName(String value) The name of the profiling group.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnProfilingGroup(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

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

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getAgentPermissions

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

@Stability(value=Stable)
public void setAgentPermissions(@NotNull
                                                         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

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

The name of the profiling group.

setProfilingGroupName

@Stability(value=Stable)
public void setProfilingGroupName(@NotNull
                                                           String value)

The name of the profiling group.

getAnomalyDetectionNotificationConfiguration

@Stability(value=Stable)
 @Nullable
public Object getAnomalyDetectionNotificationConfiguration()

Adds anomaly notifications for a profiling group.

setAnomalyDetectionNotificationConfiguration

@Stability(value=Stable)
public void setAnomalyDetectionNotificationConfiguration(@Nullable
                                                                                  IResolvable value)

Adds anomaly notifications for a profiling group.

setAnomalyDetectionNotificationConfiguration

@Stability(value=Stable)
public void setAnomalyDetectionNotificationConfiguration(@Nullable
                                                                                  List<Object> value)

Adds anomaly notifications for a profiling group.

getComputePlatform

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setComputePlatform(@Nullable
                                                        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.