#[non_exhaustive]pub struct SecurityControl {
pub security_control_id: Option<String>,
pub security_control_arn: Option<String>,
pub title: Option<String>,
pub description: Option<String>,
pub remediation_url: Option<String>,
pub severity_rating: Option<SeverityRating>,
pub security_control_status: Option<ControlStatus>,
pub update_status: Option<UpdateStatus>,
pub parameters: Option<HashMap<String, ParameterConfiguration>>,
pub last_update_reason: Option<String>,
}
Expand description
A security control in Security Hub describes a security best practice related to a specific resource.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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, such as APIGateway.3.
security_control_arn: Option<String>
The Amazon Resource Name (ARN) for a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1
. This parameter doesn't mention a specific standard.
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.
security_control_status: Option<ControlStatus>
The enablement status of a security control in a specific standard.
update_status: Option<UpdateStatus>
Identifies whether customizable properties of a security control are reflected in Security Hub findings. A status of READY
indicates that Security Hub uses the current control parameter values when running security checks of the control. A status of UPDATING
indicates that all security checks might not use the current parameter values.
parameters: Option<HashMap<String, ParameterConfiguration>>
An object that identifies the name of a control parameter, its current value, and whether it has been customized.
last_update_reason: Option<String>
The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason
field of the BatchUpdateStandardsControlAssociations
API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
Implementations§
Source§impl SecurityControl
impl SecurityControl
Sourcepub fn security_control_id(&self) -> Option<&str>
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, such as APIGateway.3.
Sourcepub fn security_control_arn(&self) -> Option<&str>
pub fn security_control_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1
. This parameter doesn't mention a specific standard.
Sourcepub fn description(&self) -> Option<&str>
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.
Sourcepub fn remediation_url(&self) -> Option<&str>
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.
Sourcepub fn severity_rating(&self) -> Option<&SeverityRating>
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.
Sourcepub fn security_control_status(&self) -> Option<&ControlStatus>
pub fn security_control_status(&self) -> Option<&ControlStatus>
The enablement status of a security control in a specific standard.
Sourcepub fn update_status(&self) -> Option<&UpdateStatus>
pub fn update_status(&self) -> Option<&UpdateStatus>
Identifies whether customizable properties of a security control are reflected in Security Hub findings. A status of READY
indicates that Security Hub uses the current control parameter values when running security checks of the control. A status of UPDATING
indicates that all security checks might not use the current parameter values.
Sourcepub fn parameters(&self) -> Option<&HashMap<String, ParameterConfiguration>>
pub fn parameters(&self) -> Option<&HashMap<String, ParameterConfiguration>>
An object that identifies the name of a control parameter, its current value, and whether it has been customized.
Sourcepub fn last_update_reason(&self) -> Option<&str>
pub fn last_update_reason(&self) -> Option<&str>
The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason
field of the BatchUpdateStandardsControlAssociations
API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
Source§impl SecurityControl
impl SecurityControl
Sourcepub fn builder() -> SecurityControlBuilder
pub fn builder() -> SecurityControlBuilder
Creates a new builder-style object to manufacture SecurityControl
.
Trait Implementations§
Source§impl Clone for SecurityControl
impl Clone for SecurityControl
Source§fn clone(&self) -> SecurityControl
fn clone(&self) -> SecurityControl
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SecurityControl
impl Debug for SecurityControl
Source§impl PartialEq for SecurityControl
impl PartialEq for SecurityControl
impl StructuralPartialEq for SecurityControl
Auto Trait Implementations§
impl Freeze for SecurityControl
impl RefUnwindSafe for SecurityControl
impl Send for SecurityControl
impl Sync for SecurityControl
impl Unpin for SecurityControl
impl UnwindSafe for SecurityControl
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);