Class CfnProfilingGroup
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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 ClassesModifier and TypeClassDescriptionstatic interface
Example:static final class
A fluent builder forCfnProfilingGroup
.static interface
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.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnProfilingGroup
(Construct scope, String id, CfnProfilingGroupProps props) Create a newAWS::CodeGuruProfiler::ProfilingGroup
.protected
CfnProfilingGroup
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnProfilingGroup
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe agent permissions attached to this profiling group.Adds anomaly notifications for a profiling group.The full Amazon Resource Name (ARN) for that profiling group.The compute platform of the profiling group.The name of the profiling group.getTags()
A list of tags to add to the created profiling group.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAgentPermissions
(Object value) The agent permissions attached to this profiling group.void
Adds anomaly notifications for a profiling group.void
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.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 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 Details
-
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 newAWS::CodeGuruProfiler::ProfilingGroup
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The full Amazon Resource Name (ARN) for that profiling group. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
A list of tags to add to the created profiling group. -
getAgentPermissions
The agent permissions attached to this profiling group.This action group grants
ConfigureAgent
andPostAgentProfile
permissions to perform actions required by the profiling agent. The Json consists of keyPrincipals
.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
The agent permissions attached to this profiling group.This action group grants
ConfigureAgent
andPostAgentProfile
permissions to perform actions required by the profiling agent. The Json consists of keyPrincipals
.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
The name of the profiling group. -
setProfilingGroupName
The name of the profiling group. -
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
The compute platform of the profiling group.Use
AWSLambda
if your application runs on AWS Lambda. UseDefault
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
The compute platform of the profiling group.Use
AWSLambda
if your application runs on AWS Lambda. UseDefault
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.
-