#[non_exhaustive]pub struct SecurityControlBuilder { /* private fields */ }
Expand description
A builder for SecurityControl
.
Implementations§
Source§impl SecurityControlBuilder
impl SecurityControlBuilder
Sourcepub fn security_control_id(self, input: impl Into<String>) -> Self
pub fn security_control_id(self, input: impl Into<String>) -> Self
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.
This field is required.Sourcepub fn set_security_control_id(self, input: Option<String>) -> Self
pub fn set_security_control_id(self, input: Option<String>) -> Self
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 get_security_control_id(&self) -> &Option<String>
pub fn get_security_control_id(&self) -> &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.
Sourcepub fn security_control_arn(self, input: impl Into<String>) -> Self
pub fn security_control_arn(self, input: impl Into<String>) -> Self
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 set_security_control_arn(self, input: Option<String>) -> Self
pub fn set_security_control_arn(self, input: Option<String>) -> Self
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 get_security_control_arn(&self) -> &Option<String>
pub fn get_security_control_arn(&self) -> &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.
Sourcepub fn title(self, input: impl Into<String>) -> Self
pub fn title(self, input: impl Into<String>) -> Self
The title of a security control.
This field is required.Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
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.
This field is required.Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
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 get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &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.
Sourcepub fn remediation_url(self, input: impl Into<String>) -> Self
pub fn remediation_url(self, input: impl Into<String>) -> Self
A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
This field is required.Sourcepub fn set_remediation_url(self, input: Option<String>) -> Self
pub fn set_remediation_url(self, input: Option<String>) -> Self
A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
Sourcepub fn get_remediation_url(&self) -> &Option<String>
pub fn get_remediation_url(&self) -> &Option<String>
A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
Sourcepub fn severity_rating(self, input: SeverityRating) -> Self
pub fn severity_rating(self, input: SeverityRating) -> Self
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.
This field is required.Sourcepub fn set_severity_rating(self, input: Option<SeverityRating>) -> Self
pub fn set_severity_rating(self, input: Option<SeverityRating>) -> Self
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 get_severity_rating(&self) -> &Option<SeverityRating>
pub fn get_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, input: ControlStatus) -> Self
pub fn security_control_status(self, input: ControlStatus) -> Self
The enablement status of a security control in a specific standard.
This field is required.Sourcepub fn set_security_control_status(self, input: Option<ControlStatus>) -> Self
pub fn set_security_control_status(self, input: Option<ControlStatus>) -> Self
The enablement status of a security control in a specific standard.
Sourcepub fn get_security_control_status(&self) -> &Option<ControlStatus>
pub fn get_security_control_status(&self) -> &Option<ControlStatus>
The enablement status of a security control in a specific standard.
Sourcepub fn update_status(self, input: UpdateStatus) -> Self
pub fn update_status(self, input: UpdateStatus) -> Self
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 set_update_status(self, input: Option<UpdateStatus>) -> Self
pub fn set_update_status(self, input: Option<UpdateStatus>) -> Self
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 get_update_status(&self) -> &Option<UpdateStatus>
pub fn get_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, k: impl Into<String>, v: ParameterConfiguration) -> Self
pub fn parameters(self, k: impl Into<String>, v: ParameterConfiguration) -> Self
Adds a key-value pair to parameters
.
To override the contents of this collection use set_parameters
.
An object that identifies the name of a control parameter, its current value, and whether it has been customized.
Sourcepub fn set_parameters(
self,
input: Option<HashMap<String, ParameterConfiguration>>,
) -> Self
pub fn set_parameters( self, input: Option<HashMap<String, ParameterConfiguration>>, ) -> Self
An object that identifies the name of a control parameter, its current value, and whether it has been customized.
Sourcepub fn get_parameters(&self) -> &Option<HashMap<String, ParameterConfiguration>>
pub fn get_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, input: impl Into<String>) -> Self
pub fn last_update_reason(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_last_update_reason(self, input: Option<String>) -> Self
pub fn set_last_update_reason(self, input: Option<String>) -> Self
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.
Sourcepub fn get_last_update_reason(&self) -> &Option<String>
pub fn get_last_update_reason(&self) -> &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.
Sourcepub fn build(self) -> SecurityControl
pub fn build(self) -> SecurityControl
Consumes the builder and constructs a SecurityControl
.
Trait Implementations§
Source§impl Clone for SecurityControlBuilder
impl Clone for SecurityControlBuilder
Source§fn clone(&self) -> SecurityControlBuilder
fn clone(&self) -> SecurityControlBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SecurityControlBuilder
impl Debug for SecurityControlBuilder
Source§impl Default for SecurityControlBuilder
impl Default for SecurityControlBuilder
Source§fn default() -> SecurityControlBuilder
fn default() -> SecurityControlBuilder
Source§impl PartialEq for SecurityControlBuilder
impl PartialEq for SecurityControlBuilder
impl StructuralPartialEq for SecurityControlBuilder
Auto Trait Implementations§
impl Freeze for SecurityControlBuilder
impl RefUnwindSafe for SecurityControlBuilder
impl Send for SecurityControlBuilder
impl Sync for SecurityControlBuilder
impl Unpin for SecurityControlBuilder
impl UnwindSafe for SecurityControlBuilder
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);