#[non_exhaustive]pub struct AccessPreviewBuilder { /* private fields */ }
Expand description
A builder for AccessPreview
.
Implementations§
Source§impl AccessPreviewBuilder
impl AccessPreviewBuilder
Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The unique ID for the access preview.
This field is required.Sourcepub fn analyzer_arn(self, input: impl Into<String>) -> Self
pub fn analyzer_arn(self, input: impl Into<String>) -> Self
The ARN of the analyzer used to generate the access preview.
This field is required.Sourcepub fn set_analyzer_arn(self, input: Option<String>) -> Self
pub fn set_analyzer_arn(self, input: Option<String>) -> Self
The ARN of the analyzer used to generate the access preview.
Sourcepub fn get_analyzer_arn(&self) -> &Option<String>
pub fn get_analyzer_arn(&self) -> &Option<String>
The ARN of the analyzer used to generate the access preview.
Sourcepub fn configurations(self, k: impl Into<String>, v: Configuration) -> Self
pub fn configurations(self, k: impl Into<String>, v: Configuration) -> Self
Adds a key-value pair to configurations
.
To override the contents of this collection use set_configurations
.
A map of resource ARNs for the proposed resource configuration.
Sourcepub fn set_configurations(
self,
input: Option<HashMap<String, Configuration>>,
) -> Self
pub fn set_configurations( self, input: Option<HashMap<String, Configuration>>, ) -> Self
A map of resource ARNs for the proposed resource configuration.
Sourcepub fn get_configurations(&self) -> &Option<HashMap<String, Configuration>>
pub fn get_configurations(&self) -> &Option<HashMap<String, Configuration>>
A map of resource ARNs for the proposed resource configuration.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The time at which the access preview was created.
This field is required.Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The time at which the access preview was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The time at which the access preview was created.
Sourcepub fn status(self, input: AccessPreviewStatus) -> Self
pub fn status(self, input: AccessPreviewStatus) -> Self
The status of the access preview.
-
Creating
- The access preview creation is in progress. -
Completed
- The access preview is complete. You can preview findings for external access to the resource. -
Failed
- The access preview creation has failed.
Sourcepub fn set_status(self, input: Option<AccessPreviewStatus>) -> Self
pub fn set_status(self, input: Option<AccessPreviewStatus>) -> Self
The status of the access preview.
-
Creating
- The access preview creation is in progress. -
Completed
- The access preview is complete. You can preview findings for external access to the resource. -
Failed
- The access preview creation has failed.
Sourcepub fn get_status(&self) -> &Option<AccessPreviewStatus>
pub fn get_status(&self) -> &Option<AccessPreviewStatus>
The status of the access preview.
-
Creating
- The access preview creation is in progress. -
Completed
- The access preview is complete. You can preview findings for external access to the resource. -
Failed
- The access preview creation has failed.
Sourcepub fn status_reason(self, input: AccessPreviewStatusReason) -> Self
pub fn status_reason(self, input: AccessPreviewStatusReason) -> Self
Provides more details about the current status of the access preview.
For example, if the creation of the access preview fails, a Failed
status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.
Sourcepub fn set_status_reason(self, input: Option<AccessPreviewStatusReason>) -> Self
pub fn set_status_reason(self, input: Option<AccessPreviewStatusReason>) -> Self
Provides more details about the current status of the access preview.
For example, if the creation of the access preview fails, a Failed
status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.
Sourcepub fn get_status_reason(&self) -> &Option<AccessPreviewStatusReason>
pub fn get_status_reason(&self) -> &Option<AccessPreviewStatusReason>
Provides more details about the current status of the access preview.
For example, if the creation of the access preview fails, a Failed
status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.
Sourcepub fn build(self) -> Result<AccessPreview, BuildError>
pub fn build(self) -> Result<AccessPreview, BuildError>
Consumes the builder and constructs a AccessPreview
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for AccessPreviewBuilder
impl Clone for AccessPreviewBuilder
Source§fn clone(&self) -> AccessPreviewBuilder
fn clone(&self) -> AccessPreviewBuilder
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 AccessPreviewBuilder
impl Debug for AccessPreviewBuilder
Source§impl Default for AccessPreviewBuilder
impl Default for AccessPreviewBuilder
Source§fn default() -> AccessPreviewBuilder
fn default() -> AccessPreviewBuilder
Source§impl PartialEq for AccessPreviewBuilder
impl PartialEq for AccessPreviewBuilder
impl StructuralPartialEq for AccessPreviewBuilder
Auto Trait Implementations§
impl Freeze for AccessPreviewBuilder
impl RefUnwindSafe for AccessPreviewBuilder
impl Send for AccessPreviewBuilder
impl Sync for AccessPreviewBuilder
impl Unpin for AccessPreviewBuilder
impl UnwindSafe for AccessPreviewBuilder
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);