Package software.amazon.awscdk.services.codeguruprofiler

Interface CfnProfilingGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProfilingGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:36.917Z")
@Stability(Stable)
public interface CfnProfilingGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnProfilingGroup.

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;
 CfnProfilingGroupProps cfnProfilingGroupProps = CfnProfilingGroupProps.builder()
         .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	Interface	Description
static final class	CfnProfilingGroupProps.Builder	A builder for CfnProfilingGroupProps
static final class	CfnProfilingGroupProps.Jsii$Proxy	An implementation for CfnProfilingGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnProfilingGroupProps.Builder	builder()
default Object	getAgentPermissions()	The agent permissions attached to this profiling group.
default Object	getAnomalyDetectionNotificationConfiguration()	Adds anomaly notifications for a profiling group.
default String	getComputePlatform()	The compute platform of the profiling group.
String	getProfilingGroupName()	The name of the profiling group.
default List<CfnTag>	getTags()	A list of tags to add to the created profiling group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProfilingGroupName

@Stability(Stable)
@NotNull
String getProfilingGroupName()

The name of the profiling group.

getAgentPermissions

@Stability(Stable)
@Nullable
default 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 .

getAnomalyDetectionNotificationConfiguration

@Stability(Stable)
@Nullable
default Object getAnomalyDetectionNotificationConfiguration()

Adds anomaly notifications for a profiling group.

getComputePlatform

@Stability(Stable)
@Nullable
default 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.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnProfilingGroupProps.Builder builder()

Returns:

a CfnProfilingGroupProps.Builder of CfnProfilingGroupProps