Class ResourceSpecificResult

java.lang.Object
com.amazonaws.services.identitymanagement.model.ResourceSpecificResult
All Implemented Interfaces:
Serializable, Cloneable

public class ResourceSpecificResult extends Object implements Serializable, Cloneable

Contains the result of the simulation of a single API action call on a single resource.

This data type is used by a member of the EvaluationResult data type.

See Also:
  • Constructor Details

    • ResourceSpecificResult

      public ResourceSpecificResult()
  • Method Details

    • setEvalResourceName

      public void setEvalResourceName(String evalResourceName)

      The name of the simulated resource, in Amazon Resource Name (ARN) format.

      Parameters:
      evalResourceName - The name of the simulated resource, in Amazon Resource Name (ARN) format.
    • getEvalResourceName

      public String getEvalResourceName()

      The name of the simulated resource, in Amazon Resource Name (ARN) format.

      Returns:
      The name of the simulated resource, in Amazon Resource Name (ARN) format.
    • withEvalResourceName

      public ResourceSpecificResult withEvalResourceName(String evalResourceName)

      The name of the simulated resource, in Amazon Resource Name (ARN) format.

      Parameters:
      evalResourceName - The name of the simulated resource, in Amazon Resource Name (ARN) format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setEvalResourceDecision

      public void setEvalResourceDecision(String evalResourceDecision)

      The result of the simulation of the simulated API action on the resource specified in EvalResourceName.

      Parameters:
      evalResourceDecision - The result of the simulation of the simulated API action on the resource specified in EvalResourceName.
      See Also:
    • getEvalResourceDecision

      public String getEvalResourceDecision()

      The result of the simulation of the simulated API action on the resource specified in EvalResourceName.

      Returns:
      The result of the simulation of the simulated API action on the resource specified in EvalResourceName.
      See Also:
    • withEvalResourceDecision

      public ResourceSpecificResult withEvalResourceDecision(String evalResourceDecision)

      The result of the simulation of the simulated API action on the resource specified in EvalResourceName.

      Parameters:
      evalResourceDecision - The result of the simulation of the simulated API action on the resource specified in EvalResourceName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setEvalResourceDecision

      public void setEvalResourceDecision(PolicyEvaluationDecisionType evalResourceDecision)

      The result of the simulation of the simulated API action on the resource specified in EvalResourceName.

      Parameters:
      evalResourceDecision - The result of the simulation of the simulated API action on the resource specified in EvalResourceName.
      See Also:
    • withEvalResourceDecision

      public ResourceSpecificResult withEvalResourceDecision(PolicyEvaluationDecisionType evalResourceDecision)

      The result of the simulation of the simulated API action on the resource specified in EvalResourceName.

      Parameters:
      evalResourceDecision - The result of the simulation of the simulated API action on the resource specified in EvalResourceName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • getMatchedStatements

      public List<Statement> getMatchedStatements()

      A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the action on the resource, if any statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.

      Returns:
      A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the action on the resource, if any statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
    • setMatchedStatements

      public void setMatchedStatements(Collection<Statement> matchedStatements)

      A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the action on the resource, if any statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.

      Parameters:
      matchedStatements - A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the action on the resource, if any statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
    • withMatchedStatements

      public ResourceSpecificResult withMatchedStatements(Statement... matchedStatements)

      A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the action on the resource, if any 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.

      Parameters:
      matchedStatements - A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the action on the resource, if any statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withMatchedStatements

      public ResourceSpecificResult withMatchedStatements(Collection<Statement> matchedStatements)

      A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the action on the resource, if any statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.

      Parameters:
      matchedStatements - A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the action on the resource, if any statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getMissingContextValues

      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 a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

      Returns:
      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 a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
    • setMissingContextValues

      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 a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

      Parameters:
      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 a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
    • withMissingContextValues

      public ResourceSpecificResult 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 a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults 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.

      Parameters:
      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 a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withMissingContextValues

      public ResourceSpecificResult 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 a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

      Parameters:
      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 a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getEvalDecisionDetails

      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.

      Returns:
      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.
    • setEvalDecisionDetails

      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.

      Parameters:
      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.
    • withEvalDecisionDetails

      public ResourceSpecificResult 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • addEvalDecisionDetailsEntry

      public ResourceSpecificResult addEvalDecisionDetailsEntry(String key, String value)
    • clearEvalDecisionDetailsEntries

      public ResourceSpecificResult clearEvalDecisionDetailsEntries()
      Removes all the entries added into EvalDecisionDetails. <p> Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public ResourceSpecificResult clone()
      Overrides:
      clone in class Object