investigation_groups

Creates, updates, deletes or gets an investigation_group resource or lists investigation_groups in a region

Overview

Name	investigation_groups
Type	Resource
Description	Definition of AWS::AIOps::InvestigationGroup Resource Type
Id	awscc.aiops.investigation_groups

Fields

get (all properties)

Name	Datatype	Description
role_arn	string	The Investigation Role's ARN.
name	string	User friendly name for resources.
created_at	string	The timestamp value.
arn	string	The Investigation Group's ARN.
retention_in_days	integer	The number of days to retain the investigation group
▶encryption_config	object
investigation_group_policy	string	Investigation Group policy
is_cloud_trail_event_history_enabled	boolean	Flag to enable cloud trail history
tag_key_boundaries	array
▶chatbot_notification_channels	array	An array of key-value pairs of notification channels to apply to this resource.
cross_account_configurations	array	An array of cross account configurations.
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	The Investigation Group's ARN.
region	string	AWS region.

For more information, see AWS::AIOps::InvestigationGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	investigation_groups	INSERT	Name, region
delete_resource	investigation_groups	DELETE	Identifier, region
update_resource	investigation_groups	UPDATE	Identifier, PatchDocument, region
list_resources	investigation_groups_list_only	SELECT	region
get_resource	investigation_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual investigation_group.

SELECT
  region,
  role_arn,
  name,
  created_by,
  created_at,
  last_modified_by,
  last_modified_at,
  arn,
  retention_in_days,
  encryption_config,
  investigation_group_policy,
  is_cloud_trail_event_history_enabled,
  tag_key_boundaries,
  chatbot_notification_channels,
  cross_account_configurations,
  tags
FROM awscc.aiops.investigation_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all investigation_groups in a region.

SELECT
  region,
  arn
FROM awscc.aiops.investigation_groups_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new investigation_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.aiops.investigation_groups (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.aiops.investigation_groups (
  RoleArn,
  Name,
  RetentionInDays,
  EncryptionConfig,
  InvestigationGroupPolicy,
  IsCloudTrailEventHistoryEnabled,
  TagKeyBoundaries,
  ChatbotNotificationChannels,
  CrossAccountConfigurations,
  Tags,
  region
)
SELECT
  '{{ role_arn }}',
  '{{ name }}',
  '{{ retention_in_days }}',
  '{{ encryption_config }}',
  '{{ investigation_group_policy }}',
  '{{ is_cloud_trail_event_history_enabled }}',
  '{{ tag_key_boundaries }}',
  '{{ chatbot_notification_channels }}',
  '{{ cross_account_configurations }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: investigation_group
  props:
    - name: role_arn
      value: '{{ role_arn }}'
    - name: name
      value: '{{ name }}'
    - name: retention_in_days
      value: '{{ retention_in_days }}'
    - name: encryption_config
      value:
        encryption_configuration_type: '{{ encryption_configuration_type }}'
        kms_key_id: '{{ kms_key_id }}'
    - name: investigation_group_policy
      value: '{{ investigation_group_policy }}'
    - name: is_cloud_trail_event_history_enabled
      value: '{{ is_cloud_trail_event_history_enabled }}'
    - name: tag_key_boundaries
      value:
        - '{{ tag_key_boundaries[0] }}'
    - name: chatbot_notification_channels
      value:
        - sns_topic_arn: '{{ sns_topic_arn }}'
          chat_configuration_arns:
            - '{{ chat_configuration_arns[0] }}'
    - name: cross_account_configurations
      value:
        - source_role_arn: null
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a investigation_group resource, using stack-deploy.

/*+ update */
UPDATE awscc.aiops.investigation_groups
SET PatchDocument = string('{{ {
    "RoleArn": role_arn,
    "EncryptionConfig": encryption_config,
    "InvestigationGroupPolicy": investigation_group_policy,
    "IsCloudTrailEventHistoryEnabled": is_cloud_trail_event_history_enabled,
    "TagKeyBoundaries": tag_key_boundaries,
    "ChatbotNotificationChannels": chatbot_notification_channels,
    "CrossAccountConfigurations": cross_account_configurations,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.aiops.investigation_groups
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the investigation_groups resource, the following permissions are required:

Create

aiops:CreateInvestigationGroup,
aiops:GetInvestigationGroup,
aiops:GetInvestigationGroupPolicy,
aiops:PutInvestigationGroupPolicy,
aiops:TagResource,
aiops:ListTagsForResource,
iam:PassRole,
kms:DescribeKey,
kms:ListAliases,
kms:Decrypt,
kms:Encrypt,
kms:GenerateDataKey

Read

aiops:GetInvestigationGroup,
aiops:GetInvestigationGroupPolicy,
aiops:ListTagsForResource,
kms:DescribeKey,
kms:ListAliases,
kms:Decrypt,
kms:Encrypt

Update

aiops:GetInvestigationGroup,
aiops:UpdateInvestigationGroup,
aiops:GetInvestigationGroupPolicy,
aiops:PutInvestigationGroupPolicy,
aiops:DeleteInvestigationGroupPolicy,
aiops:TagResource,
aiops:UntagResource,
aiops:ListTagsForResource,
iam:PassRole,
kms:DescribeKey,
kms:ListAliases,
kms:Decrypt,
kms:Encrypt,
kms:GenerateDataKey

Delete

aiops:DeleteInvestigationGroup,
aiops:GetInvestigationGroup,
aiops:DeleteInvestigationGroupPolicy,
aiops:GetInvestigationGroupPolicy,
aiops:UntagResource,
kms:DescribeKey,
kms:ListAliases

List

aiops:ListInvestigationGroups,
kms:DescribeKey,
kms:ListAliases