class CfnInvestigationGroupPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.AIOps.Mixins.CfnInvestigationGroupPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsaiops/mixins#CfnInvestigationGroupPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.aiops.mixins.CfnInvestigationGroupPropsMixin
Python	aws_cdk.mixins_preview.aws_aiops.mixins.CfnInvestigationGroupPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_aiops » mixins » CfnInvestigationGroupPropsMixin

Implements IMixin

Extends Mixin

Creates an investigation group in your account.

Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

• Who can access the investigations
• Whether investigation data is encrypted with a customer managed AWS Key Management Service key.
• How long investigations and their data are retained by default.

Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with CreateInvestigationGroup and you want to enable alarms to do this, you must use PutInvestigationGroupPolicy to create a resource policy that grants this permission to CloudWatch alarms.

For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as aiops_mixins } from '@aws-cdk/mixins-preview/aws-aiops';
const cfnInvestigationGroupPropsMixin = new aiops_mixins.CfnInvestigationGroupPropsMixin({
  chatbotNotificationChannels: [{
    chatConfigurationArns: ['chatConfigurationArns'],
    snsTopicArn: 'snsTopicArn',
  }],
  crossAccountConfigurations: [{
    sourceRoleArn: 'sourceRoleArn',
  }],
  encryptionConfig: {
    encryptionConfigurationType: 'encryptionConfigurationType',
    kmsKeyId: 'kmsKeyId',
  },
  investigationGroupPolicy: 'investigationGroupPolicy',
  isCloudTrailEventHistoryEnabled: false,
  name: 'name',
  retentionInDays: 123,
  roleArn: 'roleArn',
  tagKeyBoundaries: ['tagKeyBoundaries'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnInvestigationGroupPropsMixin(props: CfnInvestigationGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnInvestigationGroupMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::AIOps::InvestigationGroup.

Properties

Name	Type	Description
props	CfnInvestigationGroupMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnInvestigationGroupMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.