public class EvaluationResult extends Object implements Serializable, Cloneable
Contains the results of a simulation.
This data type is used by the return parameter of
SimulateCustomPolicy
and
SimulatePrincipalPolicy
.
Constructor and Description |
---|
EvaluationResult() |
Modifier and Type | Method and Description |
---|---|
EvaluationResult |
addEvalDecisionDetailsEntry(String key,
String value) |
EvaluationResult |
clearEvalDecisionDetailsEntries()
Removes all the entries added into EvalDecisionDetails.
|
EvaluationResult |
clone() |
boolean |
equals(Object obj) |
String |
getEvalActionName()
The name of the API action tested on the indicated resource.
|
String |
getEvalDecision()
The result of the simulation.
|
Map<String,String> |
getEvalDecisionDetails()
Additional details about the results of the evaluation decision.
|
String |
getEvalResourceName()
The ARN of the resource that the indicated API action was tested on.
|
List<Statement> |
getMatchedStatements()
A list of the statements in the input policies that determine the result
for this scenario.
|
List<String> |
getMissingContextValues()
A list of context keys that are required by the included input policies
but that were not provided by one of the input parameters.
|
List<ResourceSpecificResult> |
getResourceSpecificResults()
The individual results of the simulation of the API action specified in
EvalActionName on each resource.
|
int |
hashCode() |
void |
setEvalActionName(String evalActionName)
The name of the API action tested on the indicated resource.
|
void |
setEvalDecision(PolicyEvaluationDecisionType evalDecision)
The result of the simulation.
|
void |
setEvalDecision(String evalDecision)
The result of the simulation.
|
void |
setEvalDecisionDetails(Map<String,String> evalDecisionDetails)
Additional details about the results of the evaluation decision.
|
void |
setEvalResourceName(String evalResourceName)
The ARN of the resource that the indicated API action was tested on.
|
void |
setMatchedStatements(Collection<Statement> matchedStatements)
A list of the statements in the input policies that determine the result
for this scenario.
|
void |
setMissingContextValues(Collection<String> missingContextValues)
A list of context keys that are required by the included input policies
but that were not provided by one of the input parameters.
|
void |
setResourceSpecificResults(Collection<ResourceSpecificResult> resourceSpecificResults)
The individual results of the simulation of the API action specified in
EvalActionName on each resource.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
EvaluationResult |
withEvalActionName(String evalActionName)
The name of the API action tested on the indicated resource.
|
EvaluationResult |
withEvalDecision(PolicyEvaluationDecisionType evalDecision)
The result of the simulation.
|
EvaluationResult |
withEvalDecision(String evalDecision)
The result of the simulation.
|
EvaluationResult |
withEvalDecisionDetails(Map<String,String> evalDecisionDetails)
Additional details about the results of the evaluation decision.
|
EvaluationResult |
withEvalResourceName(String evalResourceName)
The ARN of the resource that the indicated API action was tested on.
|
EvaluationResult |
withMatchedStatements(Collection<Statement> matchedStatements)
A list of the statements in the input policies that determine the result
for this scenario.
|
EvaluationResult |
withMatchedStatements(Statement... matchedStatements)
A list of the statements in the input policies that determine the result
for this scenario.
|
EvaluationResult |
withMissingContextValues(Collection<String> missingContextValues)
A list of context keys that are required by the included input policies
but that were not provided by one of the input parameters.
|
EvaluationResult |
withMissingContextValues(String... missingContextValues)
A list of context keys that are required by the included input policies
but that were not provided by one of the input parameters.
|
EvaluationResult |
withResourceSpecificResults(Collection<ResourceSpecificResult> resourceSpecificResults)
The individual results of the simulation of the API action specified in
EvalActionName on each resource.
|
EvaluationResult |
withResourceSpecificResults(ResourceSpecificResult... resourceSpecificResults)
The individual results of the simulation of the API action specified in
EvalActionName on each resource.
|
public void setEvalActionName(String evalActionName)
The name of the API action tested on the indicated resource.
evalActionName
- The name of the API action tested on the indicated resource.public String getEvalActionName()
The name of the API action tested on the indicated resource.
public EvaluationResult withEvalActionName(String evalActionName)
The name of the API action tested on the indicated resource.
evalActionName
- The name of the API action tested on the indicated resource.public void setEvalResourceName(String evalResourceName)
The ARN of the resource that the indicated API action was tested on.
evalResourceName
- The ARN of the resource that the indicated API action was tested
on.public String getEvalResourceName()
The ARN of the resource that the indicated API action was tested on.
public EvaluationResult withEvalResourceName(String evalResourceName)
The ARN of the resource that the indicated API action was tested on.
evalResourceName
- The ARN of the resource that the indicated API action was tested
on.public void setEvalDecision(String evalDecision)
The result of the simulation.
evalDecision
- The result of the simulation.PolicyEvaluationDecisionType
public String getEvalDecision()
The result of the simulation.
PolicyEvaluationDecisionType
public EvaluationResult withEvalDecision(String evalDecision)
The result of the simulation.
evalDecision
- The result of the simulation.PolicyEvaluationDecisionType
public void setEvalDecision(PolicyEvaluationDecisionType evalDecision)
The result of the simulation.
evalDecision
- The result of the simulation.PolicyEvaluationDecisionType
public EvaluationResult withEvalDecision(PolicyEvaluationDecisionType evalDecision)
The result of the simulation.
evalDecision
- The result of the simulation.PolicyEvaluationDecisionType
public List<Statement> getMatchedStatements()
A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the action on the resource, if only one statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
public void setMatchedStatements(Collection<Statement> matchedStatements)
A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the action on the resource, if only one statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
matchedStatements
- A list of the statements in the input policies that determine the
result for this scenario. Remember that even if multiple
statements allow the action on the resource, if only one statement
denies that action, then the explicit deny overrides any allow,
and the deny statement is the only entry included in the result.public EvaluationResult withMatchedStatements(Statement... matchedStatements)
A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the action on the resource, if only one statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
NOTE: This method appends the values to the existing list (if
any). Use setMatchedStatements(java.util.Collection)
or
withMatchedStatements(java.util.Collection)
if you want to
override the existing values.
matchedStatements
- A list of the statements in the input policies that determine the
result for this scenario. Remember that even if multiple
statements allow the action on the resource, if only one statement
denies that action, then the explicit deny overrides any allow,
and the deny statement is the only entry included in the result.public EvaluationResult withMatchedStatements(Collection<Statement> matchedStatements)
A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the action on the resource, if only one statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
matchedStatements
- A list of the statements in the input policies that determine the
result for this scenario. Remember that even if multiple
statements allow the action on the resource, if only one statement
denies that action, then the explicit deny overrides any allow,
and the deny statement is the only entry included in the result.public List<String> getMissingContextValues()
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.
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.public void setMissingContextValues(Collection<String> missingContextValues)
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.
missingContextValues
- 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.public EvaluationResult withMissingContextValues(String... missingContextValues)
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.
NOTE: This method appends the values to the existing list (if
any). Use setMissingContextValues(java.util.Collection)
or
withMissingContextValues(java.util.Collection)
if you want to
override the existing values.
missingContextValues
- 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.public EvaluationResult withMissingContextValues(Collection<String> missingContextValues)
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.
missingContextValues
- 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.public Map<String,String> getEvalDecisionDetails()
Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access. See How IAM Roles Differ from Resource-based Policies
public void setEvalDecisionDetails(Map<String,String> evalDecisionDetails)
Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access. See How IAM Roles Differ from Resource-based Policies
evalDecisionDetails
- Additional details about the results of the evaluation decision.
When there are both IAM policies and resource policies, this
parameter explains how each set of policies contributes to the
final evaluation decision. When simulating cross-account access to
a resource, both the resource-based policy and the caller's IAM
policy must grant access. See How IAM Roles Differ from Resource-based Policiespublic EvaluationResult withEvalDecisionDetails(Map<String,String> evalDecisionDetails)
Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access. See How IAM Roles Differ from Resource-based Policies
evalDecisionDetails
- Additional details about the results of the evaluation decision.
When there are both IAM policies and resource policies, this
parameter explains how each set of policies contributes to the
final evaluation decision. When simulating cross-account access to
a resource, both the resource-based policy and the caller's IAM
policy must grant access. See How IAM Roles Differ from Resource-based Policiespublic EvaluationResult addEvalDecisionDetailsEntry(String key, String value)
public EvaluationResult clearEvalDecisionDetailsEntries()
public List<ResourceSpecificResult> getResourceSpecificResults()
The individual results of the simulation of the API action specified in EvalActionName on each resource.
public void setResourceSpecificResults(Collection<ResourceSpecificResult> resourceSpecificResults)
The individual results of the simulation of the API action specified in EvalActionName on each resource.
resourceSpecificResults
- The individual results of the simulation of the API action
specified in EvalActionName on each resource.public EvaluationResult withResourceSpecificResults(ResourceSpecificResult... resourceSpecificResults)
The individual results of the simulation of the API action specified in EvalActionName on each resource.
NOTE: This method appends the values to the existing list (if
any). Use setResourceSpecificResults(java.util.Collection)
or
withResourceSpecificResults(java.util.Collection)
if you want to
override the existing values.
resourceSpecificResults
- The individual results of the simulation of the API action
specified in EvalActionName on each resource.public EvaluationResult withResourceSpecificResults(Collection<ResourceSpecificResult> resourceSpecificResults)
The individual results of the simulation of the API action specified in EvalActionName on each resource.
resourceSpecificResults
- The individual results of the simulation of the API action
specified in EvalActionName on each resource.public String toString()
toString
in class Object
Object.toString()
public EvaluationResult clone()
Copyright © 2018. All rights reserved.