CfnProfilingGroupProps

class aws_cdk.aws_codeguruprofiler.CfnProfilingGroupProps(*, profiling_group_name, agent_permissions=None, anomaly_detection_notification_configuration=None, compute_platform=None, tags=None)

Bases: object

Properties for defining a CfnProfilingGroup.

Parameters
  • profiling_group_name (str) – The name of the profiling group.

  • agent_permissions (Optional[Any]) – 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 .

  • anomaly_detection_notification_configuration (Union[IResolvable, Sequence[Union[IResolvable, ChannelProperty, Dict[str, Any]]], None]) – Adds anomaly notifications for a profiling group.

  • compute_platform (Optional[str]) – 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.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags to add to the created profiling group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codeguruprofiler as codeguruprofiler

# agent_permissions: Any

cfn_profiling_group_props = codeguruprofiler.CfnProfilingGroupProps(
    profiling_group_name="profilingGroupName",

    # the properties below are optional
    agent_permissions=agent_permissions,
    anomaly_detection_notification_configuration=[codeguruprofiler.CfnProfilingGroup.ChannelProperty(
        channel_uri="channelUri",

        # the properties below are optional
        channel_id="channelId"
    )],
    compute_platform="computePlatform",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

agent_permissions

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html#cfn-codeguruprofiler-profilinggroup-agentpermissions

Return type

Any

anomaly_detection_notification_configuration

Adds anomaly notifications for a profiling group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html#cfn-codeguruprofiler-profilinggroup-anomalydetectionnotificationconfiguration

Return type

Union[IResolvable, List[Union[IResolvable, ChannelProperty]], None]

compute_platform

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html#cfn-codeguruprofiler-profilinggroup-computeplatform

Return type

Optional[str]

profiling_group_name

The name of the profiling group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html#cfn-codeguruprofiler-profilinggroup-profilinggroupname

Return type

str

tags

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeguruprofiler-profilinggroup.html#cfn-codeguruprofiler-profilinggroup-tags

Return type

Optional[List[CfnTag]]