interface CfnInvestigationGroupProps

Language	Type name
.NET	`Amazon.CDK.aws_aiops.CfnInvestigationGroupProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsaiops#CfnInvestigationGroupProps`
Java	`software.amazon.awscdk.services.aiops.CfnInvestigationGroupProps`
Python	`aws_cdk.aws_aiops.CfnInvestigationGroupProps`
TypeScript	`aws-cdk-lib` » `aws_aiops` » `CfnInvestigationGroupProps`

Properties for defining a CfnInvestigationGroup.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_aiops as aiops } from 'aws-cdk-lib';
const cfnInvestigationGroupProps: aiops.CfnInvestigationGroupProps = {
  name: 'name',

  // the properties below are optional
  chatbotNotificationChannels: [{
    chatConfigurationArns: ['chatConfigurationArns'],
    snsTopicArn: 'snsTopicArn',
  }],
  crossAccountConfigurations: [{
    sourceRoleArn: 'sourceRoleArn',
  }],
  encryptionConfig: {
    encryptionConfigurationType: 'encryptionConfigurationType',
    kmsKeyId: 'kmsKeyId',
  },
  investigationGroupPolicy: 'investigationGroupPolicy',
  isCloudTrailEventHistoryEnabled: false,
  retentionInDays: 123,
  roleArn: 'roleArn',
  tagKeyBoundaries: ['tagKeyBoundaries'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
name	`string`	Specify either the name or the ARN of the investigation group that you want to view.
chatbotNotificationChannels?	`IResolvable` `\|` `IResolvable` `\|` `ChatbotNotificationChannelProperty[]`	Use this property to integrate CloudWatch investigations with chat applications.
crossAccountConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `CrossAccountConfigurationProperty[]`	List of `sourceRoleArn` values that have been configured for cross-account access.
encryptionConfig?	`IResolvable` `\|` `EncryptionConfigMapProperty`	Specifies the customer managed AWS KMS key that the investigation group uses to encrypt data, if there is one.
investigationGroupPolicy?	`string`	Returns the JSON of the IAM resource policy associated with the specified investigation group in a string.
isCloudTrailEventHistoryEnabled?	`boolean \|` `IResolvable`	Specify `true` to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail.
retentionInDays?	`number`	Specifies how long that investigation data is kept.
roleArn?	`string`	The ARN of the IAM role that the investigation group uses for permissions to gather data.
tagKeyBoundaries?	`string[]`	Displays the custom tag keys for custom applications in your system that you have specified in the investigation group.
tags?	`CfnTag[]`	The list of key-value pairs to associate with the resource.

name

Type: string

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.

chatbotNotificationChannels?

Type: IResolvable | IResolvable | ChatbotNotificationChannelProperty[] (optional)

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 .

crossAccountConfigurations?

Type: IResolvable | IResolvable | CrossAccountConfigurationProperty[] (optional)

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

encryptionConfig?

Type: IResolvable | EncryptionConfigMapProperty (optional)

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.

investigationGroupPolicy?

Type: string (optional)

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:*\"}}}]} .

isCloudTrailEventHistoryEnabled?

Type: boolean | IResolvable (optional)

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

The default is true .

retentionInDays?

Type: number (optional)

Specifies how long that investigation data is kept.

roleArn?

Type: string (optional)

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

tagKeyBoundaries?

Type: string[] (optional)

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?

Type: CfnTag[] (optional)

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