Interface EvaluationResult.Builder

All Superinterfaces:
Buildable, CopyableBuilder<EvaluationResult.Builder,EvaluationResult>, SdkBuilder<EvaluationResult.Builder,EvaluationResult>, SdkPojo
Enclosing class:
EvaluationResult
@Mutable @NotThreadSafe public static interface EvaluationResult.Builder extends SdkPojo, CopyableBuilder<EvaluationResult.Builder,EvaluationResult>

  • Method Details

    • evalActionName

      EvaluationResult.Builder evalActionName(String evalActionName)

      The name of the API operation tested on the indicated resource.

      Parameters:
      evalActionName - The name of the API operation tested on the indicated resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • evalResourceName

      EvaluationResult.Builder evalResourceName(String evalResourceName)

      The ARN template for the simulated resource type (for example, arn:${Partition}:s3:::${BucketName}/${KeyName}), or * if no ARN format is defined for the action. This is not a specific customer-provided resource ARN. To find the decision for a specific resource, use ResourceSpecificResults.

      If you previously relied on EvalResourceName to identify which specific resource a result applies to, you must now use the EvalResourceName field within individual entries in ResourceSpecificResults instead.

      Parameters:
      evalResourceName - The ARN template for the simulated resource type (for example, arn:${Partition}:s3:::${BucketName}/${KeyName}), or * if no ARN format is defined for the action. This is not a specific customer-provided resource ARN. To find the decision for a specific resource, use ResourceSpecificResults.

      If you previously relied on EvalResourceName to identify which specific resource a result applies to, you must now use the EvalResourceName field within individual entries in ResourceSpecificResults instead.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • evalDecision

      EvaluationResult.Builder evalDecision(String evalDecision)

      The result of the simulation.

      Parameters:
      evalDecision - The result of the simulation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • evalDecision

      EvaluationResult.Builder evalDecision(PolicyEvaluationDecisionType evalDecision)

      The result of the simulation.

      Parameters:
      evalDecision - The result of the simulation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • matchedStatements

      EvaluationResult.Builder matchedStatements(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 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.

      In the top-level result, this field contains the union of matched statements across all requested resources. Only statements that contributed to the reported decision are included. For per-resource matched statements, see ResourceSpecificResults. This field doesn't include statements from service control policies (SCPs). Only statements from identity-based and resource-based policies appear here.

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

      In the top-level result, this field contains the union of matched statements across all requested resources. Only statements that contributed to the reported decision are included. For per-resource matched statements, see ResourceSpecificResults. This field doesn't include statements from service control policies (SCPs). Only statements from identity-based and resource-based policies appear here.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matchedStatements

      EvaluationResult.Builder matchedStatements(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 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.

      In the top-level result, this field contains the union of matched statements across all requested resources. Only statements that contributed to the reported decision are included. For per-resource matched statements, see ResourceSpecificResults. This field doesn't include statements from service control policies (SCPs). Only statements from identity-based and resource-based policies appear here.

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

      In the top-level result, this field contains the union of matched statements across all requested resources. Only statements that contributed to the reported decision are included. For per-resource matched statements, see ResourceSpecificResults. This field doesn't include statements from service control policies (SCPs). Only statements from identity-based and resource-based policies appear here.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matchedStatements

      EvaluationResult.Builder matchedStatements(Consumer<Statement.Builder>... 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 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.

      In the top-level result, this field contains the union of matched statements across all requested resources. Only statements that contributed to the reported decision are included. For per-resource matched statements, see ResourceSpecificResults. This field doesn't include statements from service control policies (SCPs). Only statements from identity-based and resource-based policies appear here.

      This is a convenience method that creates an instance of the Statement.Builder avoiding the need to create one manually via Statement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to matchedStatements(List<Statement>).

      Parameters:
      matchedStatements - a consumer that will call methods on Statement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • missingContextValues

      EvaluationResult.Builder missingContextValues(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.

      In the top-level result, this field contains the deduplicated set of missing context values across all requested resources. This field doesn't include context keys referenced by service control policies (SCPs). Only context keys referenced by identity-based and resource-based policies appear here.

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

      In the top-level result, this field contains the deduplicated set of missing context values across all requested resources. This field doesn't include context keys referenced by service control policies (SCPs). Only context keys referenced by identity-based and resource-based policies appear here.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • missingContextValues

      EvaluationResult.Builder missingContextValues(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.

      In the top-level result, this field contains the deduplicated set of missing context values across all requested resources. This field doesn't include context keys referenced by service control policies (SCPs). Only context keys referenced by identity-based and resource-based policies appear here.

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

      In the top-level result, this field contains the deduplicated set of missing context values across all requested resources. This field doesn't include context keys referenced by service control policies (SCPs). Only context keys referenced by identity-based and resource-based policies appear here.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationsDecisionDetail

      EvaluationResult.Builder organizationsDecisionDetail(OrganizationsDecisionDetail 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.

      For resources that don't support organization-level evaluation, this field is omitted from the top-level result. For per-resource details, see ResourceSpecificResults.

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

      For resources that don't support organization-level evaluation, this field is omitted from the top-level result. For per-resource details, see ResourceSpecificResults.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationsDecisionDetail

      default EvaluationResult.Builder organizationsDecisionDetail(Consumer<OrganizationsDecisionDetail.Builder> 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.

      For resources that don't support organization-level evaluation, this field is omitted from the top-level result. For per-resource details, see ResourceSpecificResults.

      This is a convenience method that creates an instance of the OrganizationsDecisionDetail.Builder avoiding the need to create one manually via OrganizationsDecisionDetail.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to organizationsDecisionDetail(OrganizationsDecisionDetail).

      Parameters:
      organizationsDecisionDetail - a consumer that will call methods on OrganizationsDecisionDetail.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • permissionsBoundaryDecisionDetail

      EvaluationResult.Builder permissionsBoundaryDecisionDetail(PermissionsBoundaryDecisionDetail permissionsBoundaryDecisionDetail)

      Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.

      Parameters:
      permissionsBoundaryDecisionDetail - Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissionsBoundaryDecisionDetail

      default EvaluationResult.Builder permissionsBoundaryDecisionDetail(Consumer<PermissionsBoundaryDecisionDetail.Builder> permissionsBoundaryDecisionDetail)

      Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.

      This is a convenience method that creates an instance of the PermissionsBoundaryDecisionDetail.Builder avoiding the need to create one manually via PermissionsBoundaryDecisionDetail.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to permissionsBoundaryDecisionDetail(PermissionsBoundaryDecisionDetail).

      Parameters:
      permissionsBoundaryDecisionDetail - a consumer that will call methods on PermissionsBoundaryDecisionDetail.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • evalDecisionDetailsWithStrings

      EvaluationResult.Builder evalDecisionDetailsWithStrings(Map<String,String> evalDecisionDetails)

      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.

      In the top-level result, this map reports the most restrictive decision per policy type across all requested resources.

      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.

      Parameters:
      evalDecisionDetails - 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.

      In the top-level result, this map reports the most restrictive decision per policy type across all requested resources.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • evalDecisionDetails

      EvaluationResult.Builder evalDecisionDetails(Map<String,PolicyEvaluationDecisionType> evalDecisionDetails)

      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.

      In the top-level result, this map reports the most restrictive decision per policy type across all requested resources.

      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.

      Parameters:
      evalDecisionDetails - 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.

      In the top-level result, this map reports the most restrictive decision per policy type across all requested resources.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceSpecificResults

      EvaluationResult.Builder resourceSpecificResults(Collection<ResourceSpecificResult> resourceSpecificResults)

      The individual results of the simulation of the API operation specified in EvalActionName on each resource.

      Parameters:
      resourceSpecificResults - The individual results of the simulation of the API operation specified in EvalActionName on each resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceSpecificResults

      EvaluationResult.Builder resourceSpecificResults(ResourceSpecificResult... resourceSpecificResults)

      The individual results of the simulation of the API operation specified in EvalActionName on each resource.

      Parameters:
      resourceSpecificResults - The individual results of the simulation of the API operation specified in EvalActionName on each resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceSpecificResults

      EvaluationResult.Builder resourceSpecificResults(Consumer<ResourceSpecificResult.Builder>... resourceSpecificResults)

      The individual results of the simulation of the API operation specified in EvalActionName on each resource.

      This is a convenience method that creates an instance of the ResourceSpecificResult.Builder avoiding the need to create one manually via ResourceSpecificResult.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceSpecificResults(List<ResourceSpecificResult>).

      Parameters:
      resourceSpecificResults - a consumer that will call methods on ResourceSpecificResult.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: