Struct Compliance

#[non_exhaustive]
pub struct Compliance {
    pub status: Option<ComplianceStatus>,
    pub related_requirements: Option<Vec<String>>,
    pub status_reasons: Option<Vec<StatusReason>>,
    pub security_control_id: Option<String>,
    pub associated_standards: Option<Vec<AssociatedStandard>>,
    pub security_control_parameters: Option<Vec<SecurityControlParameter>>,
}

This object typically provides details about a control finding, such as applicable standards and the status of control checks. While finding providers can add custom content in Compliance object fields, they are typically used to review details of Security Hub control findings.

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.

status: Option<ComplianceStatus>

Typically summarizes the result of a control check.

For Security Hub controls, valid values for Status are as follows.

• • PASSED - Standards check passed for all evaluated resources.

  • WARNING - Some information is missing or this check is not supported for your configuration.

  • FAILED - Standards check failed for at least one evaluated resource.

  • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE for a Security Hub control, Security Hub automatically archives the finding after 3 days.

related_requirements: Option<Vec<String>>

Typically provides the industry or regulatory framework requirements that are related to a control. The check for that control is aligned with these requirements.

Array Members: Maximum number of 32 items.

status_reasons: Option<Vec<StatusReason>>

Typically used to provide a list of reasons for the value of Status.

security_control_id: Option<String>

Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an Amazon Web Services service and a unique number, such as APIGateway.5.

associated_standards: Option<Vec<AssociatedStandard>>

Typically provides an array of enabled security standards in which a security control is currently enabled.

security_control_parameters: Option<Vec<SecurityControlParameter>>

Typically an object that includes security control parameter names and values.

Implementations

impl Compliance

pub fn status(&self) -> Option<&ComplianceStatus>

Typically summarizes the result of a control check.

For Security Hub controls, valid values for Status are as follows.

• • PASSED - Standards check passed for all evaluated resources.

  • WARNING - Some information is missing or this check is not supported for your configuration.

  • FAILED - Standards check failed for at least one evaluated resource.

  • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE for a Security Hub control, Security Hub automatically archives the finding after 3 days.

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

Typically provides the industry or regulatory framework requirements that are related to a control. The check for that control is aligned with these requirements.

Array Members: Maximum number of 32 items.

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

pub fn status_reasons(&self) -> &[StatusReason]

Typically used to provide a list of reasons for the value of Status.

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

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

Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an Amazon Web Services service and a unique number, such as APIGateway.5.

pub fn associated_standards(&self) -> &[AssociatedStandard]

Typically provides an array of enabled security standards in which a security control is currently enabled.

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

pub fn security_control_parameters(&self) -> &[SecurityControlParameter]

Typically an object that includes security control parameter names and values.

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

impl Compliance

pub fn builder() -> ComplianceBuilder

Creates a new builder-style object to manufacture Compliance.

Trait Implementations

impl Clone for Compliance

fn clone(&self) -> Compliance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Compliance

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

Formats the value using the given formatter.

impl PartialEq for Compliance

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