Interface CreateInvestigationGroupRequest.Builder
- All Superinterfaces:
AiOpsRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateInvestigationGroupRequest.Builder,
,CreateInvestigationGroupRequest> SdkBuilder<CreateInvestigationGroupRequest.Builder,
,CreateInvestigationGroupRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateInvestigationGroupRequest
-
Method Summary
Modifier and TypeMethodDescriptionchatbotNotificationChannel
(Map<String, ? extends Collection<String>> chatbotNotificationChannel) Use this structure to integrate CloudWatch investigations with Amazon Q in chat applications.crossAccountConfigurations
(Collection<CrossAccountConfiguration> crossAccountConfigurations) Number ofsourceAccountId
values that have been configured for cross-account access.crossAccountConfigurations
(Consumer<CrossAccountConfiguration.Builder>... crossAccountConfigurations) Number ofsourceAccountId
values that have been configured for cross-account access.crossAccountConfigurations
(CrossAccountConfiguration... crossAccountConfigurations) Number ofsourceAccountId
values that have been configured for cross-account access.encryptionConfiguration
(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration) Use this structure if you want to use a customer managed KMS key to encrypt your investigation data.encryptionConfiguration
(EncryptionConfiguration encryptionConfiguration) Use this structure if you want to use a customer managed KMS key to encrypt your investigation data.isCloudTrailEventHistoryEnabled
(Boolean isCloudTrailEventHistoryEnabled) Specifytrue
to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail.Provides a name for the investigation group.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.retentionInDays
(Long retentionInDays) Specify how long that investigation data is kept.Specify the ARN of the IAM role that CloudWatch investigations will use when it gathers investigation data.tagKeyBoundaries
(String... tagKeyBoundaries) Enter the existing custom tag keys for custom applications in your system.tagKeyBoundaries
(Collection<String> tagKeyBoundaries) Enter the existing custom tag keys for custom applications in your system.A list of key-value pairs to associate with the investigation group.Methods inherited from interface software.amazon.awssdk.services.aiops.model.AiOpsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
name
Provides a name for the investigation group.
- Parameters:
name
- Provides a name for the investigation group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleArn
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 Amazon Q has access to during investigations.
- Parameters:
roleArn
- 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 Amazon Q has access to during investigations.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionConfiguration
CreateInvestigationGroupRequest.Builder encryptionConfiguration(EncryptionConfiguration 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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionConfiguration
default CreateInvestigationGroupRequest.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> 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.
This is a convenience method that creates an instance of theEncryptionConfiguration.Builder
avoiding the need to create one manually viaEncryptionConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionConfiguration(EncryptionConfiguration)
.- Parameters:
encryptionConfiguration
- a consumer that will call methods onEncryptionConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
retentionInDays
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.
- Parameters:
retentionInDays
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
tags
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.
- Parameters:
tags
- 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 thecloudwatch: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:
- Returns a reference to this object so that method calls can be chained together.
-
tagKeyBoundaries
Enter the existing custom tag keys for custom applications in your system. Resource tags help Amazon Q 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, Amazon Q can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven't deployed these features, Amazon Q will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by Amazon Q in these cases.
You don't need to enter tags created by myApplications or CloudFormation, because Amazon Q can automatically detect those tags.
- Parameters:
tagKeyBoundaries
- Enter the existing custom tag keys for custom applications in your system. Resource tags help Amazon Q 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, Amazon Q can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven't deployed these features, Amazon Q will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by Amazon Q in these cases.You don't need to enter tags created by myApplications or CloudFormation, because Amazon Q can automatically detect those tags.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagKeyBoundaries
Enter the existing custom tag keys for custom applications in your system. Resource tags help Amazon Q 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, Amazon Q can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven't deployed these features, Amazon Q will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by Amazon Q in these cases.
You don't need to enter tags created by myApplications or CloudFormation, because Amazon Q can automatically detect those tags.
- Parameters:
tagKeyBoundaries
- Enter the existing custom tag keys for custom applications in your system. Resource tags help Amazon Q 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, Amazon Q can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven't deployed these features, Amazon Q will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by Amazon Q in these cases.You don't need to enter tags created by myApplications or CloudFormation, because Amazon Q can automatically detect those tags.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
chatbotNotificationChannel
CreateInvestigationGroupRequest.Builder chatbotNotificationChannel(Map<String, ? extends Collection<String>> chatbotNotificationChannel) Use this structure to integrate CloudWatch investigations with Amazon Q in 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 Amazon Q in 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.
- Parameters:
chatbotNotificationChannel
- Use this structure to integrate CloudWatch investigations with Amazon Q in 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 Amazon Q in 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:
- Returns a reference to this object so that method calls can be chained together.
-
isCloudTrailEventHistoryEnabled
CreateInvestigationGroupRequest.Builder isCloudTrailEventHistoryEnabled(Boolean isCloudTrailEventHistoryEnabled) Specify
true
to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail. The default istrue
.- Parameters:
isCloudTrailEventHistoryEnabled
- Specifytrue
to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail. The default istrue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
crossAccountConfigurations
CreateInvestigationGroupRequest.Builder crossAccountConfigurations(Collection<CrossAccountConfiguration> crossAccountConfigurations) Number of
sourceAccountId
values that have been configured for cross-account access.- Parameters:
crossAccountConfigurations
- Number ofsourceAccountId
values that have been configured for cross-account access.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
crossAccountConfigurations
CreateInvestigationGroupRequest.Builder crossAccountConfigurations(CrossAccountConfiguration... crossAccountConfigurations) Number of
sourceAccountId
values that have been configured for cross-account access.- Parameters:
crossAccountConfigurations
- Number ofsourceAccountId
values that have been configured for cross-account access.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
crossAccountConfigurations
CreateInvestigationGroupRequest.Builder crossAccountConfigurations(Consumer<CrossAccountConfiguration.Builder>... crossAccountConfigurations) Number of
This is a convenience method that creates an instance of thesourceAccountId
values that have been configured for cross-account access.CrossAccountConfiguration.Builder
avoiding the need to create one manually viaCrossAccountConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocrossAccountConfigurations(List<CrossAccountConfiguration>)
.- Parameters:
crossAccountConfigurations
- a consumer that will call methods onCrossAccountConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateInvestigationGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateInvestigationGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-