Struct aws_sdk_iot::operation::create_security_profile::CreateSecurityProfileInput

#[non_exhaustive]
pub struct CreateSecurityProfileInput {
    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 tags: Option<Vec<Tag>>,
    pub metrics_export_config: Option<MetricsExportConfig>,
}

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 you are giving to the security profile.

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>>

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

additional_metrics_to_retain: Option<Vec<String>>

👎Deprecated: Use additionalMetricsToRetainV2.

Please use CreateSecurityProfileRequest$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.

tags: Option<Vec<Tag>>

Metadata that can be used to manage the security profile.

metrics_export_config: Option<MetricsExportConfig>

Specifies the MQTT topic and role ARN required for metric export.

Implementations

impl CreateSecurityProfileInput

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

The name you are giving to the security profile.

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>>

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

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

👎Deprecated: Use additionalMetricsToRetainV2.

Please use CreateSecurityProfileRequest$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 tags(&self) -> &[Tag]

Metadata that can be used to manage the security profile.

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

pub fn metrics_export_config(&self) -> Option<&MetricsExportConfig>

Specifies the MQTT topic and role ARN required for metric export.

impl CreateSecurityProfileInput

pub fn builder() -> CreateSecurityProfileInputBuilder

Creates a new builder-style object to manufacture CreateSecurityProfileInput.

Trait Implementations

impl Clone for CreateSecurityProfileInput

fn clone(&self) -> CreateSecurityProfileInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateSecurityProfileInput

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

Formats the value using the given formatter.

impl PartialEq for CreateSecurityProfileInput

fn eq(&self, other: &CreateSecurityProfileInput) -> 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 CreateSecurityProfileInput