#[non_exhaustive]pub struct GetControlOutput {
pub arn: String,
pub aliases: Option<Vec<String>>,
pub name: String,
pub description: String,
pub behavior: ControlBehavior,
pub severity: Option<ControlSeverity>,
pub region_configuration: Option<RegionConfiguration>,
pub implementation: Option<ImplementationDetails>,
pub parameters: Option<Vec<ControlParameter>>,
pub create_time: Option<DateTime>,
pub governed_resources: Option<Vec<String>>,
/* private fields */
}
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: String
The Amazon Resource Name (ARN) of the control.
aliases: Option<Vec<String>>
A list of alternative identifiers for the control. These are human-readable designators, such as SH.S3.1
. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.
name: String
The display name of the control.
description: String
A description of what the control does.
behavior: ControlBehavior
A term that identifies the control's functional behavior. One of Preventive
, Detective
, Proactive
severity: Option<ControlSeverity>
An enumerated type, with the following possible values:
region_configuration: Option<RegionConfiguration>
Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control is available for deployment. For more information about scope, see Global services.
If you are applying controls through an Amazon Web Services Control Tower landing zone environment, remember that the values returned in the RegionConfiguration
API operation are not related to the governed Regions in your landing zone. For example, if you are governing Regions A
,B
,and C
while the control is available in Regions A
, B
, C,
and D
, you'd see a response with DeployableRegions
of A
, B
, C
, and D
for a control with REGIONAL
scope, even though you may not intend to deploy the control in Region D
, because you do not govern it through your landing zone.
implementation: Option<ImplementationDetails>
Returns information about the control, as an ImplementationDetails
object that shows the underlying implementation type for a control.
parameters: Option<Vec<ControlParameter>>
Returns an array of ControlParameter
objects that specify the parameters a control supports. An empty list is returned for controls that don’t support parameters.
create_time: Option<DateTime>
A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.
governed_resources: Option<Vec<String>>
A list of Amazon Web Services resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. The resources are represented as Amazon Web Services CloudFormation resource types. If GovernedResources
cannot be represented by available CloudFormation resource types, it’s returned as an empty list.
Implementations§
Source§impl GetControlOutput
impl GetControlOutput
Sourcepub fn aliases(&self) -> &[String]
pub fn aliases(&self) -> &[String]
A list of alternative identifiers for the control. These are human-readable designators, such as SH.S3.1
. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .aliases.is_none()
.
Sourcepub fn description(&self) -> &str
pub fn description(&self) -> &str
A description of what the control does.
Sourcepub fn behavior(&self) -> &ControlBehavior
pub fn behavior(&self) -> &ControlBehavior
A term that identifies the control's functional behavior. One of Preventive
, Detective
, Proactive
Sourcepub fn severity(&self) -> Option<&ControlSeverity>
pub fn severity(&self) -> Option<&ControlSeverity>
An enumerated type, with the following possible values:
Sourcepub fn region_configuration(&self) -> Option<&RegionConfiguration>
pub fn region_configuration(&self) -> Option<&RegionConfiguration>
Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control is available for deployment. For more information about scope, see Global services.
If you are applying controls through an Amazon Web Services Control Tower landing zone environment, remember that the values returned in the RegionConfiguration
API operation are not related to the governed Regions in your landing zone. For example, if you are governing Regions A
,B
,and C
while the control is available in Regions A
, B
, C,
and D
, you'd see a response with DeployableRegions
of A
, B
, C
, and D
for a control with REGIONAL
scope, even though you may not intend to deploy the control in Region D
, because you do not govern it through your landing zone.
Sourcepub fn implementation(&self) -> Option<&ImplementationDetails>
pub fn implementation(&self) -> Option<&ImplementationDetails>
Returns information about the control, as an ImplementationDetails
object that shows the underlying implementation type for a control.
Sourcepub fn parameters(&self) -> &[ControlParameter]
pub fn parameters(&self) -> &[ControlParameter]
Returns an array of ControlParameter
objects that specify the parameters a control supports. An empty list is returned for controls that don’t support parameters.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameters.is_none()
.
Sourcepub fn create_time(&self) -> Option<&DateTime>
pub fn create_time(&self) -> Option<&DateTime>
A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.
Sourcepub fn governed_resources(&self) -> &[String]
pub fn governed_resources(&self) -> &[String]
A list of Amazon Web Services resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. The resources are represented as Amazon Web Services CloudFormation resource types. If GovernedResources
cannot be represented by available CloudFormation resource types, it’s returned as an empty list.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .governed_resources.is_none()
.
Source§impl GetControlOutput
impl GetControlOutput
Sourcepub fn builder() -> GetControlOutputBuilder
pub fn builder() -> GetControlOutputBuilder
Creates a new builder-style object to manufacture GetControlOutput
.
Trait Implementations§
Source§impl Clone for GetControlOutput
impl Clone for GetControlOutput
Source§fn clone(&self) -> GetControlOutput
fn clone(&self) -> GetControlOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GetControlOutput
impl Debug for GetControlOutput
Source§impl PartialEq for GetControlOutput
impl PartialEq for GetControlOutput
Source§impl RequestId for GetControlOutput
impl RequestId for GetControlOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for GetControlOutput
Auto Trait Implementations§
impl Freeze for GetControlOutput
impl RefUnwindSafe for GetControlOutput
impl Send for GetControlOutput
impl Sync for GetControlOutput
impl Unpin for GetControlOutput
impl UnwindSafe for GetControlOutput
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);