Struct aws_sdk_iot::operation::update_security_profile::UpdateSecurityProfileInput

#[non_exhaustive]
pub struct UpdateSecurityProfileInput {
    pub security_profile_name: Option<String>,
    pub security_profile_description: Option<String>,
    pub behaviors: Option<Vec<Behavior>>,
    pub alert_targets: Option<HashMap<AlertTargetType, AlertTarget>>,
    pub additional_metrics_to_retain: Option<Vec<String>>,
    pub additional_metrics_to_retain_v2: Option<Vec<MetricToRetain>>,
    pub delete_behaviors: Option<bool>,
    pub delete_alert_targets: Option<bool>,
    pub delete_additional_metrics_to_retain: Option<bool>,
    pub expected_version: Option<i64>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

security_profile_name: Option<String>

The name of the security profile you want to update.

security_profile_description: Option<String>

A description of the security profile.

behaviors: Option<Vec<Behavior>>

Specifies the behaviors that, when violated by a device (thing), cause an alert.

alert_targets: Option<HashMap<AlertTargetType, AlertTarget>>

Where the alerts are sent. (Alerts are always sent to the console.)

additional_metrics_to_retain: Option<Vec<String>>

👎Deprecated: Use additionalMetricsToRetainV2.

Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

additional_metrics_to_retain_v2: Option<Vec<MetricToRetain>>

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

delete_behaviors: Option<bool>

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

delete_alert_targets: Option<bool>

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

delete_additional_metrics_to_retain: Option<bool>

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

expected_version: Option<i64>

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

Implementations

impl UpdateSecurityProfileInput

pub fn security_profile_name(&self) -> Option<&str>

The name of the security profile you want to update.

pub fn security_profile_description(&self) -> Option<&str>

A description of the security profile.

pub fn behaviors(&self) -> &[Behavior]

Specifies the behaviors that, when violated by a device (thing), cause an alert.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .behaviors.is_none().

pub fn alert_targets(&self) -> Option<&HashMap<AlertTargetType, AlertTarget>>

Where the alerts are sent. (Alerts are always sent to the console.)

pub fn additional_metrics_to_retain(&self) -> &[String]

👎Deprecated: Use additionalMetricsToRetainV2.

Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_metrics_to_retain.is_none().

pub fn additional_metrics_to_retain_v2(&self) -> &[MetricToRetain]

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_metrics_to_retain_v2.is_none().

pub fn delete_behaviors(&self) -> Option<bool>

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

pub fn delete_alert_targets(&self) -> Option<bool>

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

pub fn delete_additional_metrics_to_retain(&self) -> Option<bool>

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

pub fn expected_version(&self) -> Option<i64>

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

impl UpdateSecurityProfileInput

pub fn builder() -> UpdateSecurityProfileInputBuilder

Creates a new builder-style object to manufacture UpdateSecurityProfileInput.

Trait Implementations

impl Clone for UpdateSecurityProfileInput

fn clone(&self) -> UpdateSecurityProfileInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateSecurityProfileInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UpdateSecurityProfileInput

fn eq(&self, other: &UpdateSecurityProfileInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateSecurityProfileInput