Package software.amazon.awscdk.services.codeguruprofiler

Class CfnProfilingGroup

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.913Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnProfilingGroup

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

    • CfnProfilingGroup

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

    • CfnProfilingGroup

      @Stability(Stable) public CfnProfilingGroup(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The full Amazon Resource Name (ARN) for that profiling group.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of tags to add to the created profiling group.

    • getAgentPermissions

      @Stability(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(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(Stable) @NotNull public String getProfilingGroupName()
      The name of the profiling group.

    • setProfilingGroupName

      @Stability(Stable) public void setProfilingGroupName(@NotNull String value)
      The name of the profiling group.

    • getAnomalyDetectionNotificationConfiguration

      @Stability(Stable) @Nullable public Object getAnomalyDetectionNotificationConfiguration()
      Adds anomaly notifications for a profiling group.

    • setAnomalyDetectionNotificationConfiguration

      @Stability(Stable) public void setAnomalyDetectionNotificationConfiguration(@Nullable IResolvable value)
      Adds anomaly notifications for a profiling group.

    • setAnomalyDetectionNotificationConfiguration

      @Stability(Stable) public void setAnomalyDetectionNotificationConfiguration(@Nullable List<Object> value)
      Adds anomaly notifications for a profiling group.

    • getComputePlatform

      @Stability(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(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.