Struct SecurityControlDefinition

#[non_exhaustive]
pub struct SecurityControlDefinition {
    pub security_control_id: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub remediation_url: Option<String>,
    pub severity_rating: Option<SeverityRating>,
    pub current_region_availability: Option<RegionAvailabilityStatus>,
    pub customizable_properties: Option<Vec<SecurityControlProperty>>,
    pub parameter_definitions: Option<HashMap<String, ParameterDefinition>>,
}

Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, severity, availability in Amazon Web Services Regions, and a link to remediation steps.

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_control_id: Option<String>

The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a number (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

title: Option<String>

The title of a security control.

description: Option<String>

The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.

remediation_url: Option<String>

A link to Security Hub documentation that explains how to remediate a failed finding for a security control.

severity_rating: Option<SeverityRating>

The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.

current_region_availability: Option<RegionAvailabilityStatus>

Specifies whether a security control is available in the current Amazon Web Services Region.

customizable_properties: Option<Vec<SecurityControlProperty>>

Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

parameter_definitions: Option<HashMap<String, ParameterDefinition>>

An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.

Implementations

impl SecurityControlDefinition

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

The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a number (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

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

The title of a security control.

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

The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.

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

A link to Security Hub documentation that explains how to remediate a failed finding for a security control.

pub fn severity_rating(&self) -> Option<&SeverityRating>

The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.

pub fn current_region_availability(&self) -> Option<&RegionAvailabilityStatus>

Specifies whether a security control is available in the current Amazon Web Services Region.

pub fn customizable_properties(&self) -> &[SecurityControlProperty]

Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.

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

pub fn parameter_definitions( &self, ) -> Option<&HashMap<String, ParameterDefinition>>

An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.

impl SecurityControlDefinition

pub fn builder() -> SecurityControlDefinitionBuilder

Creates a new builder-style object to manufacture SecurityControlDefinition.

Trait Implementations

impl Clone for SecurityControlDefinition

fn clone(&self) -> SecurityControlDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecurityControlDefinition

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

Formats the value using the given formatter.

impl PartialEq for SecurityControlDefinition

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SecurityControlDefinition