#[non_exhaustive]pub struct ResourceDetail {
pub resource_type: Option<String>,
pub logical_resource_id: Option<String>,
pub resource_identifier: Option<HashMap<String, String>>,
pub resource_status: Option<GeneratedTemplateResourceStatus>,
pub resource_status_reason: Option<String>,
pub warnings: Option<Vec<WarningDetail>>,
}
Expand description
Details about a resource in a generated template
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.resource_type: Option<String>
The type of the resource, such as AWS::DynamoDB::Table
. For the list of supported resources, see Resource type support for imports and drift detection In the CloudFormation User Guide
logical_resource_id: Option<String>
The logical id for this resource in the final generated template.
resource_identifier: Option<HashMap<String, String>>
A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier
list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table
resource, the primary identifiers is TableName
so the key-value pair could be "TableName": "MyDDBTable"
. For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
resource_status: Option<GeneratedTemplateResourceStatus>
Status of the processing of a resource in a generated template.
- InProgress
-
The resource processing is still in progress.
- Complete
-
The resource processing is complete.
- Pending
-
The resource processing is pending.
- Failed
-
The resource processing has failed.
resource_status_reason: Option<String>
The reason for the resource detail, providing more information if a failure happened.
warnings: Option<Vec<WarningDetail>>
The warnings generated for this resource.
Implementations§
Source§impl ResourceDetail
impl ResourceDetail
Sourcepub fn resource_type(&self) -> Option<&str>
pub fn resource_type(&self) -> Option<&str>
The type of the resource, such as AWS::DynamoDB::Table
. For the list of supported resources, see Resource type support for imports and drift detection In the CloudFormation User Guide
Sourcepub fn logical_resource_id(&self) -> Option<&str>
pub fn logical_resource_id(&self) -> Option<&str>
The logical id for this resource in the final generated template.
Sourcepub fn resource_identifier(&self) -> Option<&HashMap<String, String>>
pub fn resource_identifier(&self) -> Option<&HashMap<String, String>>
A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier
list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table
resource, the primary identifiers is TableName
so the key-value pair could be "TableName": "MyDDBTable"
. For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.
Sourcepub fn resource_status(&self) -> Option<&GeneratedTemplateResourceStatus>
pub fn resource_status(&self) -> Option<&GeneratedTemplateResourceStatus>
Status of the processing of a resource in a generated template.
- InProgress
-
The resource processing is still in progress.
- Complete
-
The resource processing is complete.
- Pending
-
The resource processing is pending.
- Failed
-
The resource processing has failed.
Sourcepub fn resource_status_reason(&self) -> Option<&str>
pub fn resource_status_reason(&self) -> Option<&str>
The reason for the resource detail, providing more information if a failure happened.
Sourcepub fn warnings(&self) -> &[WarningDetail]
pub fn warnings(&self) -> &[WarningDetail]
The warnings generated for this resource.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .warnings.is_none()
.
Source§impl ResourceDetail
impl ResourceDetail
Sourcepub fn builder() -> ResourceDetailBuilder
pub fn builder() -> ResourceDetailBuilder
Creates a new builder-style object to manufacture ResourceDetail
.
Trait Implementations§
Source§impl Clone for ResourceDetail
impl Clone for ResourceDetail
Source§fn clone(&self) -> ResourceDetail
fn clone(&self) -> ResourceDetail
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ResourceDetail
impl Debug for ResourceDetail
Source§impl PartialEq for ResourceDetail
impl PartialEq for ResourceDetail
impl StructuralPartialEq for ResourceDetail
Auto Trait Implementations§
impl Freeze for ResourceDetail
impl RefUnwindSafe for ResourceDetail
impl Send for ResourceDetail
impl Sync for ResourceDetail
impl Unpin for ResourceDetail
impl UnwindSafe for ResourceDetail
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);