#[non_exhaustive]pub struct Framework {Show 14 fields
pub arn: Option<String>,
pub id: Option<String>,
pub name: Option<String>,
pub type: Option<FrameworkType>,
pub compliance_type: Option<String>,
pub description: Option<String>,
pub logo: Option<String>,
pub control_sources: Option<String>,
pub control_sets: Option<Vec<ControlSet>>,
pub created_at: Option<DateTime>,
pub last_updated_at: Option<DateTime>,
pub created_by: Option<String>,
pub last_updated_by: Option<String>,
pub tags: Option<HashMap<String, String>>,
}
Expand description
The file that's used to structure and automate Audit Manager assessments for a given compliance standard.
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.arn: Option<String>
The Amazon Resource Name (ARN) of the framework.
id: Option<String>
The unique identifier for the framework.
name: Option<String>
The name of the framework.
type: Option<FrameworkType>
Specifies whether the framework is a standard framework or a custom framework.
compliance_type: Option<String>
The compliance type that the framework supports, such as CIS or HIPAA.
description: Option<String>
The description of the framework.
logo: Option<String>
The logo that's associated with the framework.
control_sources: Option<String>
The control data sources where Audit Manager collects evidence from.
This API parameter is no longer supported.
control_sets: Option<Vec<ControlSet>>
The control sets that are associated with the framework.
The Controls
object returns a partial response when called through Framework APIs. For a complete Controls
object, use GetControl
.
created_at: Option<DateTime>
The time when the framework was created.
last_updated_at: Option<DateTime>
The time when the framework was most recently updated.
created_by: Option<String>
The user or role that created the framework.
last_updated_by: Option<String>
The user or role that most recently updated the framework.
The tags that are associated with the framework.
Implementations§
Source§impl Framework
impl Framework
Sourcepub fn type(&self) -> Option<&FrameworkType>
pub fn type(&self) -> Option<&FrameworkType>
Specifies whether the framework is a standard framework or a custom framework.
Sourcepub fn compliance_type(&self) -> Option<&str>
pub fn compliance_type(&self) -> Option<&str>
The compliance type that the framework supports, such as CIS or HIPAA.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the framework.
Sourcepub fn control_sources(&self) -> Option<&str>
👎Deprecated since 2025-07-24: Use controlSources from the Control
pub fn control_sources(&self) -> Option<&str>
The control data sources where Audit Manager collects evidence from.
This API parameter is no longer supported.
Sourcepub fn control_sets(&self) -> &[ControlSet]
pub fn control_sets(&self) -> &[ControlSet]
The control sets that are associated with the framework.
The Controls
object returns a partial response when called through Framework APIs. For a complete Controls
object, use GetControl
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .control_sets.is_none()
.
Sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The time when the framework was created.
Sourcepub fn last_updated_at(&self) -> Option<&DateTime>
pub fn last_updated_at(&self) -> Option<&DateTime>
The time when the framework was most recently updated.
Sourcepub fn created_by(&self) -> Option<&str>
pub fn created_by(&self) -> Option<&str>
The user or role that created the framework.
Sourcepub fn last_updated_by(&self) -> Option<&str>
pub fn last_updated_by(&self) -> Option<&str>
The user or role that most recently updated the framework.
The tags that are associated with the framework.
Trait Implementations§
impl StructuralPartialEq for Framework
Auto Trait Implementations§
impl Freeze for Framework
impl RefUnwindSafe for Framework
impl Send for Framework
impl Sync for Framework
impl Unpin for Framework
impl UnwindSafe for Framework
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);