#[non_exhaustive]pub struct EvaluationResultBuilder { /* private fields */ }
Expand description
A builder for EvaluationResult
.
Implementations§
Source§impl EvaluationResultBuilder
impl EvaluationResultBuilder
Sourcepub fn eval_action_name(self, input: impl Into<String>) -> Self
pub fn eval_action_name(self, input: impl Into<String>) -> Self
The name of the API operation tested on the indicated resource.
This field is required.Sourcepub fn set_eval_action_name(self, input: Option<String>) -> Self
pub fn set_eval_action_name(self, input: Option<String>) -> Self
The name of the API operation tested on the indicated resource.
Sourcepub fn get_eval_action_name(&self) -> &Option<String>
pub fn get_eval_action_name(&self) -> &Option<String>
The name of the API operation tested on the indicated resource.
Sourcepub fn eval_resource_name(self, input: impl Into<String>) -> Self
pub fn eval_resource_name(self, input: impl Into<String>) -> Self
The ARN of the resource that the indicated API operation was tested on.
Sourcepub fn set_eval_resource_name(self, input: Option<String>) -> Self
pub fn set_eval_resource_name(self, input: Option<String>) -> Self
The ARN of the resource that the indicated API operation was tested on.
Sourcepub fn get_eval_resource_name(&self) -> &Option<String>
pub fn get_eval_resource_name(&self) -> &Option<String>
The ARN of the resource that the indicated API operation was tested on.
Sourcepub fn eval_decision(self, input: PolicyEvaluationDecisionType) -> Self
pub fn eval_decision(self, input: PolicyEvaluationDecisionType) -> Self
The result of the simulation.
This field is required.Sourcepub fn set_eval_decision(
self,
input: Option<PolicyEvaluationDecisionType>,
) -> Self
pub fn set_eval_decision( self, input: Option<PolicyEvaluationDecisionType>, ) -> Self
The result of the simulation.
Sourcepub fn get_eval_decision(&self) -> &Option<PolicyEvaluationDecisionType>
pub fn get_eval_decision(&self) -> &Option<PolicyEvaluationDecisionType>
The result of the simulation.
Sourcepub fn matched_statements(self, input: Statement) -> Self
pub fn matched_statements(self, input: Statement) -> Self
Appends an item to matched_statements
.
To override the contents of this collection use set_matched_statements
.
A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.
Sourcepub fn set_matched_statements(self, input: Option<Vec<Statement>>) -> Self
pub fn set_matched_statements(self, input: Option<Vec<Statement>>) -> Self
A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.
Sourcepub fn get_matched_statements(&self) -> &Option<Vec<Statement>>
pub fn get_matched_statements(&self) -> &Option<Vec<Statement>>
A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.
Sourcepub fn missing_context_values(self, input: impl Into<String>) -> Self
pub fn missing_context_values(self, input: impl Into<String>) -> Self
Appends an item to missing_context_values
.
To override the contents of this collection use set_missing_context_values
.
A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is "*", either explicitly, or when the ResourceArns
parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults
section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
Sourcepub fn set_missing_context_values(self, input: Option<Vec<String>>) -> Self
pub fn set_missing_context_values(self, input: Option<Vec<String>>) -> Self
A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is "*", either explicitly, or when the ResourceArns
parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults
section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
Sourcepub fn get_missing_context_values(&self) -> &Option<Vec<String>>
pub fn get_missing_context_values(&self) -> &Option<Vec<String>>
A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is "*", either explicitly, or when the ResourceArns
parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults
section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
Sourcepub fn organizations_decision_detail(
self,
input: OrganizationsDecisionDetail,
) -> Self
pub fn organizations_decision_detail( self, input: OrganizationsDecisionDetail, ) -> Self
A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.
Sourcepub fn set_organizations_decision_detail(
self,
input: Option<OrganizationsDecisionDetail>,
) -> Self
pub fn set_organizations_decision_detail( self, input: Option<OrganizationsDecisionDetail>, ) -> Self
A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.
Sourcepub fn get_organizations_decision_detail(
&self,
) -> &Option<OrganizationsDecisionDetail>
pub fn get_organizations_decision_detail( &self, ) -> &Option<OrganizationsDecisionDetail>
A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.
Sourcepub fn permissions_boundary_decision_detail(
self,
input: PermissionsBoundaryDecisionDetail,
) -> Self
pub fn permissions_boundary_decision_detail( self, input: PermissionsBoundaryDecisionDetail, ) -> Self
Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.
Sourcepub fn set_permissions_boundary_decision_detail(
self,
input: Option<PermissionsBoundaryDecisionDetail>,
) -> Self
pub fn set_permissions_boundary_decision_detail( self, input: Option<PermissionsBoundaryDecisionDetail>, ) -> Self
Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.
Sourcepub fn get_permissions_boundary_decision_detail(
&self,
) -> &Option<PermissionsBoundaryDecisionDetail>
pub fn get_permissions_boundary_decision_detail( &self, ) -> &Option<PermissionsBoundaryDecisionDetail>
Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.
Sourcepub fn eval_decision_details(
self,
k: impl Into<String>,
v: PolicyEvaluationDecisionType,
) -> Self
pub fn eval_decision_details( self, k: impl Into<String>, v: PolicyEvaluationDecisionType, ) -> Self
Adds a key-value pair to eval_decision_details
.
To override the contents of this collection use set_eval_decision_details
.
Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision.
If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (*
), then the parameter is not returned.
When you make a cross-account request, Amazon Web Services evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return true
. For more information about how policies are evaluated, see Evaluating policies within a single account.
If an Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned.
Sourcepub fn set_eval_decision_details(
self,
input: Option<HashMap<String, PolicyEvaluationDecisionType>>,
) -> Self
pub fn set_eval_decision_details( self, input: Option<HashMap<String, PolicyEvaluationDecisionType>>, ) -> Self
Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision.
If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (*
), then the parameter is not returned.
When you make a cross-account request, Amazon Web Services evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return true
. For more information about how policies are evaluated, see Evaluating policies within a single account.
If an Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned.
Sourcepub fn get_eval_decision_details(
&self,
) -> &Option<HashMap<String, PolicyEvaluationDecisionType>>
pub fn get_eval_decision_details( &self, ) -> &Option<HashMap<String, PolicyEvaluationDecisionType>>
Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision.
If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (*
), then the parameter is not returned.
When you make a cross-account request, Amazon Web Services evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return true
. For more information about how policies are evaluated, see Evaluating policies within a single account.
If an Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned.
Sourcepub fn resource_specific_results(self, input: ResourceSpecificResult) -> Self
pub fn resource_specific_results(self, input: ResourceSpecificResult) -> Self
Appends an item to resource_specific_results
.
To override the contents of this collection use set_resource_specific_results
.
The individual results of the simulation of the API operation specified in EvalActionName on each resource.
Sourcepub fn set_resource_specific_results(
self,
input: Option<Vec<ResourceSpecificResult>>,
) -> Self
pub fn set_resource_specific_results( self, input: Option<Vec<ResourceSpecificResult>>, ) -> Self
The individual results of the simulation of the API operation specified in EvalActionName on each resource.
Sourcepub fn get_resource_specific_results(
&self,
) -> &Option<Vec<ResourceSpecificResult>>
pub fn get_resource_specific_results( &self, ) -> &Option<Vec<ResourceSpecificResult>>
The individual results of the simulation of the API operation specified in EvalActionName on each resource.
Sourcepub fn build(self) -> Result<EvaluationResult, BuildError>
pub fn build(self) -> Result<EvaluationResult, BuildError>
Consumes the builder and constructs a EvaluationResult
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for EvaluationResultBuilder
impl Clone for EvaluationResultBuilder
Source§fn clone(&self) -> EvaluationResultBuilder
fn clone(&self) -> EvaluationResultBuilder
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 EvaluationResultBuilder
impl Debug for EvaluationResultBuilder
Source§impl Default for EvaluationResultBuilder
impl Default for EvaluationResultBuilder
Source§fn default() -> EvaluationResultBuilder
fn default() -> EvaluationResultBuilder
Source§impl PartialEq for EvaluationResultBuilder
impl PartialEq for EvaluationResultBuilder
Source§fn eq(&self, other: &EvaluationResultBuilder) -> bool
fn eq(&self, other: &EvaluationResultBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for EvaluationResultBuilder
Auto Trait Implementations§
impl Freeze for EvaluationResultBuilder
impl RefUnwindSafe for EvaluationResultBuilder
impl Send for EvaluationResultBuilder
impl Sync for EvaluationResultBuilder
impl Unpin for EvaluationResultBuilder
impl UnwindSafe for EvaluationResultBuilder
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);