Interface EvaluationResult.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<EvaluationResult.Builder,
,EvaluationResult> SdkBuilder<EvaluationResult.Builder,
,EvaluationResult> SdkPojo
- Enclosing class:
EvaluationResult
-
Method Summary
Modifier and TypeMethodDescriptionevalActionName
(String evalActionName) The name of the API operation tested on the indicated resource.evalDecision
(String evalDecision) The result of the simulation.evalDecision
(PolicyEvaluationDecisionType evalDecision) The result of the simulation.evalDecisionDetails
(Map<String, PolicyEvaluationDecisionType> evalDecisionDetails) Additional details about the results of the cross-account evaluation decision.evalDecisionDetailsWithStrings
(Map<String, String> evalDecisionDetails) Additional details about the results of the cross-account evaluation decision.evalResourceName
(String evalResourceName) The ARN of the resource that the indicated API operation was tested on.matchedStatements
(Collection<Statement> matchedStatements) A list of the statements in the input policies that determine the result for this scenario.matchedStatements
(Consumer<Statement.Builder>... matchedStatements) A list of the statements in the input policies that determine the result for this scenario.matchedStatements
(Statement... matchedStatements) A list of the statements in the input policies that determine the result for this scenario.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.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.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.organizationsDecisionDetail
(OrganizationsDecisionDetail organizationsDecisionDetail) A structure that details how Organizations and its service control policies affect the results of the simulation.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.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.resourceSpecificResults
(Collection<ResourceSpecificResult> resourceSpecificResults) The individual results of the simulation of the API operation specified in EvalActionName on each resource.resourceSpecificResults
(Consumer<ResourceSpecificResult.Builder>... resourceSpecificResults) The individual results of the simulation of the API operation specified in EvalActionName on each resource.resourceSpecificResults
(ResourceSpecificResult... resourceSpecificResults) The individual results of the simulation of the API operation specified in EvalActionName on each resource.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
The ARN of the resource that the indicated API operation was tested on.
- Parameters:
evalResourceName
- The ARN of the resource that the indicated API operation was tested on.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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.
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theStatement.Builder
avoiding the need to create one manually viaStatement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomatchedStatements(List<Statement>)
.- Parameters:
matchedStatements
- a consumer that will call methods onStatement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theResourceSpecificResults
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 the resource in a simulation is "*", either explicitly, or when theResourceArns
parameter blank. If you include a list of resources, then any missing context values are instead included under theResourceSpecificResults
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.
-
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 theResourceSpecificResults
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 the resource in a simulation is "*", either explicitly, or when theResourceArns
parameter blank. If you include a list of resources, then any missing context values are instead included under theResourceSpecificResults
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.
-
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.
- 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.- 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.
This is a convenience method that creates an instance of theOrganizationsDecisionDetail.Builder
avoiding the need to create one manually viaOrganizationsDecisionDetail.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toorganizationsDecisionDetail(OrganizationsDecisionDetail)
.- Parameters:
organizationsDecisionDetail
- a consumer that will call methods onOrganizationsDecisionDetail.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 thePermissionsBoundaryDecisionDetail.Builder
avoiding the need to create one manually viaPermissionsBoundaryDecisionDetail.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topermissionsBoundaryDecisionDetail(PermissionsBoundaryDecisionDetail)
.- Parameters:
permissionsBoundaryDecisionDetail
- a consumer that will call methods onPermissionsBoundaryDecisionDetail.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
evalDecisionDetailsWithStrings
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.
- 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.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.
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.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
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 theResourceSpecificResult.Builder
avoiding the need to create one manually viaResourceSpecificResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresourceSpecificResults(List<ResourceSpecificResult>)
.- Parameters:
resourceSpecificResults
- a consumer that will call methods onResourceSpecificResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-