pub struct CreateInvestigationGroupFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateInvestigationGroup.
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 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.
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
Implementations§
Source§impl CreateInvestigationGroupFluentBuilder
impl CreateInvestigationGroupFluentBuilder
Sourcepub fn as_input(&self) -> &CreateInvestigationGroupInputBuilder
pub fn as_input(&self) -> &CreateInvestigationGroupInputBuilder
Access the CreateInvestigationGroup as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateInvestigationGroupOutput, SdkError<CreateInvestigationGroupError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateInvestigationGroupOutput, SdkError<CreateInvestigationGroupError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateInvestigationGroupOutput, CreateInvestigationGroupError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateInvestigationGroupOutput, CreateInvestigationGroupError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
Provides a name for the investigation group.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
Provides a name for the investigation group.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<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.
Sourcepub fn encryption_configuration(self, input: EncryptionConfiguration) -> Self
pub fn encryption_configuration(self, input: EncryptionConfiguration) -> Self
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.
Sourcepub fn set_encryption_configuration(
self,
input: Option<EncryptionConfiguration>,
) -> Self
pub fn set_encryption_configuration( self, input: Option<EncryptionConfiguration>, ) -> Self
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.
Sourcepub fn get_encryption_configuration(&self) -> &Option<EncryptionConfiguration>
pub fn get_encryption_configuration(&self) -> &Option<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.
Sourcepub fn retention_in_days(self, input: i64) -> Self
pub fn retention_in_days(self, input: i64) -> Self
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.
Sourcepub fn set_retention_in_days(self, input: Option<i64>) -> Self
pub fn set_retention_in_days(self, input: Option<i64>) -> Self
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.
Sourcepub fn get_retention_in_days(&self) -> &Option<i64>
pub fn get_retention_in_days(&self) -> &Option<i64>
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.
Adds a key-value pair to tags.
To override the contents of this collection use set_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.
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.
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.
Sourcepub fn tag_key_boundaries(self, input: impl Into<String>) -> Self
pub fn tag_key_boundaries(self, input: impl Into<String>) -> Self
Appends an item to tagKeyBoundaries.
To override the contents of this collection use set_tag_key_boundaries.
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.
Sourcepub fn set_tag_key_boundaries(self, input: Option<Vec<String>>) -> Self
pub fn set_tag_key_boundaries(self, input: Option<Vec<String>>) -> Self
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.
Sourcepub fn get_tag_key_boundaries(&self) -> &Option<Vec<String>>
pub fn get_tag_key_boundaries(&self) -> &Option<Vec<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.
Sourcepub fn chatbot_notification_channel(
self,
k: impl Into<String>,
v: Vec<String>,
) -> Self
pub fn chatbot_notification_channel( self, k: impl Into<String>, v: Vec<String>, ) -> Self
Adds a key-value pair to chatbotNotificationChannel.
To override the contents of this collection use set_chatbot_notification_channel.
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.
Sourcepub fn set_chatbot_notification_channel(
self,
input: Option<HashMap<String, Vec<String>>>,
) -> Self
pub fn set_chatbot_notification_channel( self, input: Option<HashMap<String, Vec<String>>>, ) -> Self
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.
Sourcepub fn get_chatbot_notification_channel(
&self,
) -> &Option<HashMap<String, Vec<String>>>
pub fn get_chatbot_notification_channel( &self, ) -> &Option<HashMap<String, Vec<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.
Sourcepub fn is_cloud_trail_event_history_enabled(self, input: bool) -> Self
pub fn is_cloud_trail_event_history_enabled(self, input: bool) -> Self
Specify true to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail. The default is true.
Sourcepub fn set_is_cloud_trail_event_history_enabled(
self,
input: Option<bool>,
) -> Self
pub fn set_is_cloud_trail_event_history_enabled( self, input: Option<bool>, ) -> Self
Specify true to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail. The default is true.
Sourcepub fn get_is_cloud_trail_event_history_enabled(&self) -> &Option<bool>
pub fn get_is_cloud_trail_event_history_enabled(&self) -> &Option<bool>
Specify true to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail. The default is true.
Sourcepub fn cross_account_configurations(
self,
input: CrossAccountConfiguration,
) -> Self
pub fn cross_account_configurations( self, input: CrossAccountConfiguration, ) -> Self
Appends an item to crossAccountConfigurations.
To override the contents of this collection use set_cross_account_configurations.
List of sourceRoleArn values that have been configured for cross-account access.
Sourcepub fn set_cross_account_configurations(
self,
input: Option<Vec<CrossAccountConfiguration>>,
) -> Self
pub fn set_cross_account_configurations( self, input: Option<Vec<CrossAccountConfiguration>>, ) -> Self
List of sourceRoleArn values that have been configured for cross-account access.
Sourcepub fn get_cross_account_configurations(
&self,
) -> &Option<Vec<CrossAccountConfiguration>>
pub fn get_cross_account_configurations( &self, ) -> &Option<Vec<CrossAccountConfiguration>>
List of sourceRoleArn values that have been configured for cross-account access.
Trait Implementations§
Source§impl Clone for CreateInvestigationGroupFluentBuilder
impl Clone for CreateInvestigationGroupFluentBuilder
Source§fn clone(&self) -> CreateInvestigationGroupFluentBuilder
fn clone(&self) -> CreateInvestigationGroupFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateInvestigationGroupFluentBuilder
impl !RefUnwindSafe for CreateInvestigationGroupFluentBuilder
impl Send for CreateInvestigationGroupFluentBuilder
impl Sync for CreateInvestigationGroupFluentBuilder
impl Unpin for CreateInvestigationGroupFluentBuilder
impl !UnwindSafe for CreateInvestigationGroupFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);