software.amazon.awssdk.services.iam.model

Class ResourceSpecificResult

java.lang.Object

software.amazon.awssdk.services.iam.model.ResourceSpecificResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ResourceSpecificResult.Builder,ResourceSpecificResult>

@Generated(value="software.amazon.awssdk:codegen")
public final class ResourceSpecificResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ResourceSpecificResult.Builder,ResourceSpecificResult>

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResourceSpecificResult.Builder

Method Summary

Modifier and Type	Method and Description
static ResourceSpecificResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,PolicyEvaluationDecisionType>	evalDecisionDetails() Additional details about the results of the evaluation decision on a single resource.
Map<String,String>	evalDecisionDetailsAsStrings() Additional details about the results of the evaluation decision on a single resource.
PolicyEvaluationDecisionType	evalResourceDecision() The result of the simulation of the simulated API operation on the resource specified in EvalResourceName.
String	evalResourceDecisionAsString() The result of the simulation of the simulated API operation on the resource specified in EvalResourceName.
String	evalResourceName() The name of the simulated resource, in Amazon Resource Name (ARN) format.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEvalDecisionDetails() For responses, this returns true if the service returned a value for the EvalDecisionDetails property.
int	hashCode()
boolean	hasMatchedStatements() For responses, this returns true if the service returned a value for the MatchedStatements property.
boolean	hasMissingContextValues() For responses, this returns true if the service returned a value for the MissingContextValues property.
List<Statement>	matchedStatements() A list of the statements in the input policies that determine the result for this part of the simulation.
List<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.
PermissionsBoundaryDecisionDetail	permissionsBoundaryDecisionDetail() Contains information about the effect that a permissions boundary has on a policy simulation when that boundary is applied to an IAM entity.
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceSpecificResult.Builder>	serializableBuilderClass()
ResourceSpecificResult.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

evalResourceName

public final String evalResourceName()

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.

evalResourceDecision

public final PolicyEvaluationDecisionType evalResourceDecision()

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

If the service returns an enum value that is not available in the current SDK version, evalResourceDecision will return PolicyEvaluationDecisionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from evalResourceDecisionAsString().

Returns:

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

See Also:

PolicyEvaluationDecisionType

evalResourceDecisionAsString

public final String evalResourceDecisionAsString()

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

If the service returns an enum value that is not available in the current SDK version, evalResourceDecision will return PolicyEvaluationDecisionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from evalResourceDecisionAsString().

Returns:

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

See Also:

PolicyEvaluationDecisionType

hasMatchedStatements

public final boolean hasMatchedStatements()

For responses, this returns true if the service returned a value for the MatchedStatements property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

matchedStatements

public final List<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 operation on the resource, if any statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMatchedStatements() method.

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 operation on the resource, if any statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

hasMissingContextValues

public final boolean hasMissingContextValues()

For responses, this returns true if the service returned a value for the MissingContextValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

missingContextValues

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMissingContextValues() method.

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.

evalDecisionDetails

public final Map<String,PolicyEvaluationDecisionType> evalDecisionDetails()

Additional details about the results of the evaluation decision on a single resource. This parameter is returned only for cross-account simulations. This parameter explains how each policy type contributes to the resource-specific evaluation decision.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEvalDecisionDetails() method.

Returns:

Additional details about the results of the evaluation decision on a single resource. This parameter is returned only for cross-account simulations. This parameter explains how each policy type contributes to the resource-specific evaluation decision.

hasEvalDecisionDetails

public final boolean hasEvalDecisionDetails()

For responses, this returns true if the service returned a value for the EvalDecisionDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

evalDecisionDetailsAsStrings

public final Map<String,String> evalDecisionDetailsAsStrings()

Additional details about the results of the evaluation decision on a single resource. This parameter is returned only for cross-account simulations. This parameter explains how each policy type contributes to the resource-specific evaluation decision.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEvalDecisionDetails() method.

Returns:

Additional details about the results of the evaluation decision on a single resource. This parameter is returned only for cross-account simulations. This parameter explains how each policy type contributes to the resource-specific evaluation decision.

permissionsBoundaryDecisionDetail

public final PermissionsBoundaryDecisionDetail permissionsBoundaryDecisionDetail()

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

Returns:

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

toBuilder

public ResourceSpecificResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceSpecificResult.Builder,ResourceSpecificResult>

builder

public static ResourceSpecificResult.Builder builder()

serializableBuilderClass

public static Class<? extends ResourceSpecificResult.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo