CfnInvestigationGroup

class aws_cdk.aws_aiops.CfnInvestigationGroup(scope, id, *, 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: CfnResource

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
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 = aiops.CfnInvestigationGroup(self, "MyCfnInvestigationGroup",
    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"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::AIOps::InvestigationGroup'

attr_arn

The Amazon Resource Name (ARN) of the investigation group.

CloudformationAttribute:: Arn

attr_created_at

The date and time that the investigation group was created.

CloudformationAttribute:: CreatedAt

attr_created_by

The name of the user who created the investigation group.

CloudformationAttribute:: CreatedBy

attr_last_modified_at

The date and time that the investigation group was most recently modified.

CloudformationAttribute:: LastModifiedAt

attr_last_modified_by

The name of the user who created the investigation group.

CloudformationAttribute:: LastModifiedBy

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

chatbot_notification_channels: Use this property to integrate CloudWatch investigations with chat applications.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

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

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

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

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

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

retention_in_days: Specifies how long that investigation data is kept.

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

ChatbotNotificationChannelProperty

class CfnInvestigationGroup.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 SNS 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 import aws_aiops as aiops

chatbot_notification_channel_property = aiops.CfnInvestigationGroup.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 SNS 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 CfnInvestigationGroup.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 import aws_aiops as aiops

cross_account_configuration_property = aiops.CfnInvestigationGroup.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 CfnInvestigationGroup.EncryptionConfigMapProperty(*, encryption_configuration_type=None, kms_key_id=None)

Bases: object

Use this structure if you want to use a customer managed AWS KMS 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 import aws_aiops as aiops

encryption_config_map_property = aiops.CfnInvestigationGroup.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