Package software.amazon.awscdk.services.aiops

Interface CfnInvestigationGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInvestigationGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:25.145Z")
@Stability(Stable)
public interface CfnInvestigationGroupProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.aiops.*;
 CfnInvestigationGroupProps cfnInvestigationGroupProps = CfnInvestigationGroupProps.builder()
         .name("name")
         // the properties below are optional
         .chatbotNotificationChannels(List.of(ChatbotNotificationChannelProperty.builder()
                 .chatConfigurationArns(List.of("chatConfigurationArns"))
                 .snsTopicArn("snsTopicArn")
                 .build()))
         .crossAccountConfigurations(List.of(CrossAccountConfigurationProperty.builder()
                 .sourceRoleArn("sourceRoleArn")
                 .build()))
         .encryptionConfig(EncryptionConfigMapProperty.builder()
                 .encryptionConfigurationType("encryptionConfigurationType")
                 .kmsKeyId("kmsKeyId")
                 .build())
         .investigationGroupPolicy("investigationGroupPolicy")
         .isCloudTrailEventHistoryEnabled(false)
         .retentionInDays(123)
         .roleArn("roleArn")
         .tagKeyBoundaries(List.of("tagKeyBoundaries"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInvestigationGroupProps.Builder	A builder for CfnInvestigationGroupProps
static final class	CfnInvestigationGroupProps.Jsii$Proxy	An implementation for CfnInvestigationGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnInvestigationGroupProps.Builder	builder()
default Object	getChatbotNotificationChannels()	Use this property to integrate CloudWatch investigations with chat applications.
default Object	getCrossAccountConfigurations()	List of sourceRoleArn values that have been configured for cross-account access.
default Object	getEncryptionConfig()	Specifies the customer managed AWS KMS key that the investigation group uses to encrypt data, if there is one.
default String	getInvestigationGroupPolicy()	Returns the JSON of the IAM resource policy associated with the specified investigation group in a string.
default Object	getIsCloudTrailEventHistoryEnabled()	Specify true to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail.
String	getName()	Specify either the name or the ARN of the investigation group that you want to view.
default Number	getRetentionInDays()	Specifies how long that investigation data is kept.
default String	getRoleArn()	The ARN of the IAM role that the investigation group uses for permissions to gather data.
default List<String>	getTagKeyBoundaries()	Displays the custom tag keys for custom applications in your system that you have specified in the investigation group.
default List<CfnTag>	getTags()	The list of key-value pairs to associate with the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

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 Also:

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

getChatbotNotificationChannels

@Stability(Stable)
@Nullable
default Object getChatbotNotificationChannels()

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 Also:

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

getCrossAccountConfigurations

@Stability(Stable)
@Nullable
default Object getCrossAccountConfigurations()

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

See Also:

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

getEncryptionConfig

@Stability(Stable)
@Nullable
default Object getEncryptionConfig()

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 Also:

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

getInvestigationGroupPolicy

@Stability(Stable)
@Nullable
default String getInvestigationGroupPolicy()

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 Also:

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

getIsCloudTrailEventHistoryEnabled

@Stability(Stable)
@Nullable
default Object getIsCloudTrailEventHistoryEnabled()

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

The default is true .

See Also:

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

getRetentionInDays

@Stability(Stable)
@Nullable
default Number getRetentionInDays()

Specifies how long that investigation data is kept.

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

See Also:

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

getTagKeyBoundaries

@Stability(Stable)
@Nullable
default List<String> getTagKeyBoundaries()

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 Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnInvestigationGroupProps.Builder builder()

Returns:

a CfnInvestigationGroupProps.Builder of CfnInvestigationGroupProps