CfnInvestigationGroupPropsMixin

class aws_cdk.mixins_preview.aws_aiops.mixins.CfnInvestigationGroupPropsMixin(props, *, strategy=None)

Bases: 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. .. epigraph:

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 <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html>`_

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aiops-investigationgroup.html
CloudformationResource:: AWS::AIOps::InvestigationGroup
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_aiops import mixins as aiops_mixins

cfn_investigation_group_props_mixin = aiops_mixins.CfnInvestigationGroupPropsMixin(aiops_mixins.CfnInvestigationGroupMixinProps(
    chatbot_notification_channels=[aiops_mixins.CfnInvestigationGroupPropsMixin.ChatbotNotificationChannelProperty(
        chat_configuration_arns=["chatConfigurationArns"],
        sns_topic_arn="snsTopicArn"
    )],
    cross_account_configurations=[aiops_mixins.CfnInvestigationGroupPropsMixin.CrossAccountConfigurationProperty(
        source_role_arn="sourceRoleArn"
    )],
    encryption_config=aiops_mixins.CfnInvestigationGroupPropsMixin.EncryptionConfigMapProperty(
        encryption_configuration_type="encryptionConfigurationType",
        kms_key_id="kmsKeyId"
    ),
    investigation_group_policy="investigationGroupPolicy",
    is_cloud_trail_event_history_enabled=False,
    name="name",
    retention_in_days=123,
    role_arn="roleArn",
    tag_key_boundaries=["tagKeyBoundaries"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnInvestigationGroupMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['chatbotNotificationChannels', 'crossAccountConfigurations', 'encryptionConfig', 'investigationGroupPolicy', 'isCloudTrailEventHistoryEnabled', 'name', 'retentionInDays', 'roleArn', 'tagKeyBoundaries', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ChatbotNotificationChannelProperty

class CfnInvestigationGroupPropsMixin.ChatbotNotificationChannelProperty(*, chat_configuration_arns=None, sns_topic_arn=None)

Bases: object

Use this structure to integrate CloudWatch investigations with chat applications.

This structure is a string 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 .

Parameters:

chat_configuration_arns (Optional[Sequence[str]]) – Returns the Amazon Resource Name (ARN) of any third-party chat integrations configured for the account.
sns_topic_arn (Optional[str]) – Returns the ARN of an Amazon topic used for third-party chat integrations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-chatbotnotificationchannel.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.mixins_preview.aws_aiops import mixins as aiops_mixins

chatbot_notification_channel_property = aiops_mixins.CfnInvestigationGroupPropsMixin.ChatbotNotificationChannelProperty(
    chat_configuration_arns=["chatConfigurationArns"],
    sns_topic_arn="snsTopicArn"
)

Attributes

chat_configuration_arns

Returns the Amazon Resource Name (ARN) of any third-party chat integrations configured for the account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-chatbotnotificationchannel.html#cfn-aiops-investigationgroup-chatbotnotificationchannel-chatconfigurationarns

sns_topic_arn

Returns the ARN of an Amazon topic used for third-party chat integrations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-chatbotnotificationchannel.html#cfn-aiops-investigationgroup-chatbotnotificationchannel-snstopicarn

CrossAccountConfigurationProperty

class CfnInvestigationGroupPropsMixin.CrossAccountConfigurationProperty(*, source_role_arn=None)

Bases: object

This structure contains information about the cross-account configuration in the account.

Parameters:: source_role_arn (Optional[str]) – The ARN of an existing role which will be used to do investigations on your behalf.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-crossaccountconfiguration.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.mixins_preview.aws_aiops import mixins as aiops_mixins

cross_account_configuration_property = aiops_mixins.CfnInvestigationGroupPropsMixin.CrossAccountConfigurationProperty(
    source_role_arn="sourceRoleArn"
)

Attributes

source_role_arn

The ARN of an existing role which will be used to do investigations on your behalf.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-crossaccountconfiguration.html#cfn-aiops-investigationgroup-crossaccountconfiguration-sourcerolearn

EncryptionConfigMapProperty

class CfnInvestigationGroupPropsMixin.EncryptionConfigMapProperty(*, encryption_configuration_type=None, kms_key_id=None)

Bases: object

Use this structure if you want to use a customer managed AWS key to encrypt your investigation data.

If you omit this parameter, CloudWatch investigations will use an AWS key to encrypt the data. For more information, see Encryption of investigation data .

Parameters:

encryption_configuration_type (Optional[str]) – Displays whether investigation data is encrypted by a customer managed key or an AWS owned key.
kms_key_id (Optional[str]) – If the investigation group uses a customer managed key for encryption, this field displays the ID of that key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-encryptionconfigmap.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.mixins_preview.aws_aiops import mixins as aiops_mixins

encryption_config_map_property = aiops_mixins.CfnInvestigationGroupPropsMixin.EncryptionConfigMapProperty(
    encryption_configuration_type="encryptionConfigurationType",
    kms_key_id="kmsKeyId"
)

Attributes

encryption_configuration_type

Displays whether investigation data is encrypted by a customer managed key or an AWS owned key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-encryptionconfigmap.html#cfn-aiops-investigationgroup-encryptionconfigmap-encryptionconfigurationtype

kms_key_id

If the investigation group uses a customer managed key for encryption, this field displays the ID of that key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aiops-investigationgroup-encryptionconfigmap.html#cfn-aiops-investigationgroup-encryptionconfigmap-kmskeyid