#[non_exhaustive]pub struct SecurityControlDefinitionBuilder { /* private fields */ }
Expand description
A builder for SecurityControlDefinition
.
Implementations§
Source§impl SecurityControlDefinitionBuilder
impl SecurityControlDefinitionBuilder
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 (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).
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 (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).
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 (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).
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 current_region_availability(
self,
input: RegionAvailabilityStatus,
) -> Self
pub fn current_region_availability( self, input: RegionAvailabilityStatus, ) -> Self
Specifies whether a security control is available in the current Amazon Web Services Region.
This field is required.Sourcepub fn set_current_region_availability(
self,
input: Option<RegionAvailabilityStatus>,
) -> Self
pub fn set_current_region_availability( self, input: Option<RegionAvailabilityStatus>, ) -> Self
Specifies whether a security control is available in the current Amazon Web Services Region.
Sourcepub fn get_current_region_availability(
&self,
) -> &Option<RegionAvailabilityStatus>
pub fn get_current_region_availability( &self, ) -> &Option<RegionAvailabilityStatus>
Specifies whether a security control is available in the current Amazon Web Services Region.
Sourcepub fn customizable_properties(self, input: SecurityControlProperty) -> Self
pub fn customizable_properties(self, input: SecurityControlProperty) -> Self
Appends an item to customizable_properties
.
To override the contents of this collection use set_customizable_properties
.
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.
Sourcepub fn set_customizable_properties(
self,
input: Option<Vec<SecurityControlProperty>>,
) -> Self
pub fn set_customizable_properties( self, input: Option<Vec<SecurityControlProperty>>, ) -> Self
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.
Sourcepub fn get_customizable_properties(
&self,
) -> &Option<Vec<SecurityControlProperty>>
pub fn get_customizable_properties( &self, ) -> &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.
Sourcepub fn parameter_definitions(
self,
k: impl Into<String>,
v: ParameterDefinition,
) -> Self
pub fn parameter_definitions( self, k: impl Into<String>, v: ParameterDefinition, ) -> Self
Adds a key-value pair to parameter_definitions
.
To override the contents of this collection use set_parameter_definitions
.
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.
Sourcepub fn set_parameter_definitions(
self,
input: Option<HashMap<String, ParameterDefinition>>,
) -> Self
pub fn set_parameter_definitions( self, input: Option<HashMap<String, ParameterDefinition>>, ) -> Self
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.
Sourcepub fn get_parameter_definitions(
&self,
) -> &Option<HashMap<String, ParameterDefinition>>
pub fn get_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.
Sourcepub fn build(self) -> SecurityControlDefinition
pub fn build(self) -> SecurityControlDefinition
Consumes the builder and constructs a SecurityControlDefinition
.
Trait Implementations§
Source§impl Clone for SecurityControlDefinitionBuilder
impl Clone for SecurityControlDefinitionBuilder
Source§fn clone(&self) -> SecurityControlDefinitionBuilder
fn clone(&self) -> SecurityControlDefinitionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for SecurityControlDefinitionBuilder
impl Default for SecurityControlDefinitionBuilder
Source§fn default() -> SecurityControlDefinitionBuilder
fn default() -> SecurityControlDefinitionBuilder
Source§impl PartialEq for SecurityControlDefinitionBuilder
impl PartialEq for SecurityControlDefinitionBuilder
Source§fn eq(&self, other: &SecurityControlDefinitionBuilder) -> bool
fn eq(&self, other: &SecurityControlDefinitionBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for SecurityControlDefinitionBuilder
Auto Trait Implementations§
impl Freeze for SecurityControlDefinitionBuilder
impl RefUnwindSafe for SecurityControlDefinitionBuilder
impl Send for SecurityControlDefinitionBuilder
impl Sync for SecurityControlDefinitionBuilder
impl Unpin for SecurityControlDefinitionBuilder
impl UnwindSafe for SecurityControlDefinitionBuilder
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);