Class: Aws::AIOps::Types::CreateInvestigationGroupInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-aiops/lib/aws-sdk-aiops/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#chatbot_notification_channel ⇒ Hash<String,Array<String>>

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 Amazon Web Services Chatbot.

Returns:

  • (Hash<String,Array<String>>) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/types.rb', line 140

class CreateInvestigationGroupInput < Struct.new(
  :name,
  :role_arn,
  :encryption_configuration,
  :retention_in_days,
  :tags,
  :tag_key_boundaries,
  :chatbot_notification_channel,
  :is_cloud_trail_event_history_enabled,
  :cross_account_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#cross_account_configurations ⇒ Array<Types::CrossAccountConfiguration>

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

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/types.rb', line 140

class CreateInvestigationGroupInput < Struct.new(
  :name,
  :role_arn,
  :encryption_configuration,
  :retention_in_days,
  :tags,
  :tag_key_boundaries,
  :chatbot_notification_channel,
  :is_cloud_trail_event_history_enabled,
  :cross_account_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfiguration

Use this structure if you want to use a customer managed KMS key to encrypt your investigation data. If you omit this parameter, CloudWatch investigations will use an Amazon Web Services key to encrypt the data. For more information, see Encryption of investigation data.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/types.rb', line 140

class CreateInvestigationGroupInput < Struct.new(
  :name,
  :role_arn,
  :encryption_configuration,
  :retention_in_days,
  :tags,
  :tag_key_boundaries,
  :chatbot_notification_channel,
  :is_cloud_trail_event_history_enabled,
  :cross_account_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#is_cloud_trail_event_history_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/types.rb', line 140

class CreateInvestigationGroupInput < Struct.new(
  :name,
  :role_arn,
  :encryption_configuration,
  :retention_in_days,
  :tags,
  :tag_key_boundaries,
  :chatbot_notification_channel,
  :is_cloud_trail_event_history_enabled,
  :cross_account_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Provides a name for the investigation group.

Returns:

  • (String) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/types.rb', line 140

class CreateInvestigationGroupInput < Struct.new(
  :name,
  :role_arn,
  :encryption_configuration,
  :retention_in_days,
  :tags,
  :tag_key_boundaries,
  :chatbot_notification_channel,
  :is_cloud_trail_event_history_enabled,
  :cross_account_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#retention_in_days ⇒ Integer

Specify how long that investigation data is kept. For more information, see Operational investigation data retention.

If you omit this parameter, the default of 90 days is used.

Returns:

  • (Integer) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/types.rb', line 140

class CreateInvestigationGroupInput < Struct.new(
  :name,
  :role_arn,
  :encryption_configuration,
  :retention_in_days,
  :tags,
  :tag_key_boundaries,
  :chatbot_notification_channel,
  :is_cloud_trail_event_history_enabled,
  :cross_account_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

Specify the ARN of the IAM role that CloudWatch investigations will use when it gathers investigation data. The permissions in this role determine which of your resources that CloudWatch investigations will have access to during investigations.

For more information, see How to control what data CloudWatch investigations has access to during investigations.

Returns:

  • (String) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/types.rb', line 140

class CreateInvestigationGroupInput < Struct.new(
  :name,
  :role_arn,
  :encryption_configuration,
  :retention_in_days,
  :tags,
  :tag_key_boundaries,
  :chatbot_notification_channel,
  :is_cloud_trail_event_history_enabled,
  :cross_account_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#tag_key_boundaries ⇒ Array<String>

Enter the existing custom tag keys for custom applications in your system. Resource tags help CloudWatch investigations narrow the search space when it is unable to discover definite relationships between resources. For example, to discover that an Amazon ECS service depends on an Amazon RDS database, CloudWatch investigations can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven't deployed these features, CloudWatch investigations will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by CloudWatch investigations in these cases.

You don't need to enter tags created by myApplications or CloudFormation, because CloudWatch investigations can automatically detect those tags.

Returns:

  • (Array<String>) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/types.rb', line 140

class CreateInvestigationGroupInput < Struct.new(
  :name,
  :role_arn,
  :encryption_configuration,
  :retention_in_days,
  :tags,
  :tag_key_boundaries,
  :chatbot_notification_channel,
  :is_cloud_trail_event_history_enabled,
  :cross_account_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of key-value pairs to associate with the investigation group. You can associate as many as 50 tags with an investigation group. To be able to associate tags when you create the investigation group, you must have the cloudwatch:TagResource permission.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Returns:

  • (Hash<String,String>) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'gems/aws-sdk-aiops/lib/aws-sdk-aiops/types.rb', line 140

class CreateInvestigationGroupInput < Struct.new(
  :name,
  :role_arn,
  :encryption_configuration,
  :retention_in_days,
  :tags,
  :tag_key_boundaries,
  :chatbot_notification_channel,
  :is_cloud_trail_event_history_enabled,
  :cross_account_configurations)
  SENSITIVE = []
  include Aws::Structure
end