CfnInvestigationGroupProps

class aws_cdk.aws_aiops.CfnInvestigationGroupProps(*, name, chatbot_notification_channels=None, cross_account_configurations=None, encryption_config=None, investigation_group_policy=None, is_cloud_trail_event_history_enabled=None, retention_in_days=None, role_arn=None, tag_key_boundaries=None, tags=None)

Bases: object

Properties for defining a CfnInvestigationGroup.

Parameters:
  • name (str) – Specify either the name or the ARN of the investigation group that you want to view. This is used to set the name of the investigation group.

  • chatbot_notification_channels (Union[IResolvable, Sequence[Union[IResolvable, ChatbotNotificationChannelProperty, Dict[str, Any]]], None]) – Use this property to integrate CloudWatch investigations with chat applications. This property is an array. For the first string, specify the ARN of an Amazon SNS topic. For the array of strings, specify the ARNs of one or more chat applications configurations that you want to associate with that topic. For more information about these configuration ARNs, see Getting started with Amazon Q in chat applications and Resource type defined by AWS Chatbot .

  • cross_account_configurations (Union[IResolvable, Sequence[Union[IResolvable, CrossAccountConfigurationProperty, Dict[str, Any]]], None]) – List of sourceRoleArn values that have been configured for cross-account access.

  • encryption_config (Union[IResolvable, EncryptionConfigMapProperty, Dict[str, Any], None]) – Specifies the customer managed AWS KMS key that the investigation group uses to encrypt data, if there is one. If not, the investigation group uses an AWS key to encrypt the data.

  • investigation_group_policy (Optional[str]) – Returns the JSON of the IAM resource policy associated with the specified investigation group in a string. For example, {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"aiops.alarms.cloudwatch.amazonaws.com\"},\"Action\":[\"aiops:CreateInvestigation\",\"aiops:CreateInvestigationEvent\"],\"Resource\":\"*\",\"Condition\":{\"StringEquals\":{\"aws:SourceAccount\":\"111122223333\"},\"ArnLike\":{\"aws:SourceArn\":\"arn:aws:cloudwatch:us-east-1:111122223333:alarm:*\"}}}]} .

  • is_cloud_trail_event_history_enabled (Union[bool, IResolvable, None]) – Specify true to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail. The default is true .

  • retention_in_days (Union[int, float, None]) – Specifies how long that investigation data is kept.

  • role_arn (Optional[str]) – The ARN of the IAM role that the investigation group uses for permissions to gather data.

  • tag_key_boundaries (Optional[Sequence[str]]) – Displays the custom tag keys for custom applications in your system that you have specified in the investigation group. Resource tags help CloudWatch investigations narrow the search space when it is unable to discover definite relationships between resources.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The list of key-value pairs to associate with the resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html

ExampleMetadata:

fixture=_generated

Example:

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

cfn_investigation_group_props = aiops.CfnInvestigationGroupProps(
    name="name",

    # the properties below are optional
    chatbot_notification_channels=[aiops.CfnInvestigationGroup.ChatbotNotificationChannelProperty(
        chat_configuration_arns=["chatConfigurationArns"],
        sns_topic_arn="snsTopicArn"
    )],
    cross_account_configurations=[aiops.CfnInvestigationGroup.CrossAccountConfigurationProperty(
        source_role_arn="sourceRoleArn"
    )],
    encryption_config=aiops.CfnInvestigationGroup.EncryptionConfigMapProperty(
        encryption_configuration_type="encryptionConfigurationType",
        kms_key_id="kmsKeyId"
    ),
    investigation_group_policy="investigationGroupPolicy",
    is_cloud_trail_event_history_enabled=False,
    retention_in_days=123,
    role_arn="roleArn",
    tag_key_boundaries=["tagKeyBoundaries"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

chatbot_notification_channels

Use this property to integrate CloudWatch investigations with chat applications.

This property is an array. For the first string, specify the ARN of an Amazon SNS topic. For the array of strings, specify the ARNs of one or more chat applications configurations that you want to associate with that topic. For more information about these configuration ARNs, see Getting started with Amazon Q in chat applications and Resource type defined by AWS Chatbot .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-chatbotnotificationchannels

cross_account_configurations

List of sourceRoleArn values that have been configured for cross-account access.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-crossaccountconfigurations

encryption_config

Specifies the customer managed AWS KMS key that the investigation group uses to encrypt data, if there is one.

If not, the investigation group uses an AWS key to encrypt the data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-encryptionconfig

investigation_group_policy

Returns the JSON of the IAM resource policy associated with the specified investigation group in a string.

For example, {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"aiops.alarms.cloudwatch.amazonaws.com\"},\"Action\":[\"aiops:CreateInvestigation\",\"aiops:CreateInvestigationEvent\"],\"Resource\":\"*\",\"Condition\":{\"StringEquals\":{\"aws:SourceAccount\":\"111122223333\"},\"ArnLike\":{\"aws:SourceArn\":\"arn:aws:cloudwatch:us-east-1:111122223333:alarm:*\"}}}]} .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-investigationgrouppolicy

is_cloud_trail_event_history_enabled

Specify true to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail.

The default is true .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-iscloudtraileventhistoryenabled

name

Specify either the name or the ARN of the investigation group that you want to view.

This is used to set the name of the investigation group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-name

retention_in_days

Specifies how long that investigation data is kept.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-retentionindays

role_arn

The ARN of the IAM role that the investigation group uses for permissions to gather data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-rolearn

tag_key_boundaries

Displays the custom tag keys for custom applications in your system that you have specified in the investigation group.

Resource tags help CloudWatch investigations narrow the search space when it is unable to discover definite relationships between resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html#cfn-aiops-investigationgroup-tagkeyboundaries

tags

The list of key-value pairs to associate with the resource.

See:

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