Package software.amazon.awssdk.services.iam.model

Class ContextEntry

java.lang.Object

software.amazon.awssdk.services.iam.model.ContextEntry

All Implemented Interfaces:

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

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

Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.

This data type is used as an input parameter to SimulateCustomPolicy and SimulatePrincipalPolicy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ContextEntry.Builder

Method Summary

Modifier and Type	Method	Description
static ContextEntry.Builder	builder()
String	contextKeyName()	The full name of a condition context key, including the service prefix.
ContextKeyTypeEnum	contextKeyType()	The data type of the value (or values) specified in the ContextKeyValues parameter.
String	contextKeyTypeAsString()	The data type of the value (or values) specified in the ContextKeyValues parameter.
List<String>	contextKeyValues()	The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a Condition element in an input policy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContextKeyValues()	For responses, this returns true if the service returned a value for the ContextKeyValues property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ContextEntry.Builder>	serializableBuilderClass()
ContextEntry.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

contextKeyName

public final String contextKeyName()

The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.

Returns:

The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.

hasContextKeyValues

public final boolean hasContextKeyValues()

For responses, this returns true if the service returned a value for the ContextKeyValues 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.

contextKeyValues

public final List<String> contextKeyValues()

The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a Condition element in an input policy.

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 hasContextKeyValues() method.

Returns:

The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a Condition element in an input policy.

contextKeyType

public final ContextKeyTypeEnum contextKeyType()

The data type of the value (or values) specified in the ContextKeyValues parameter.

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

Returns:

The data type of the value (or values) specified in the ContextKeyValues parameter.

See Also:

ContextKeyTypeEnum

contextKeyTypeAsString

public final String contextKeyTypeAsString()

The data type of the value (or values) specified in the ContextKeyValues parameter.

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

Returns:

The data type of the value (or values) specified in the ContextKeyValues parameter.

See Also:

ContextKeyTypeEnum

toBuilder

public ContextEntry.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContextEntry.Builder,ContextEntry>

builder

public static ContextEntry.Builder builder()

serializableBuilderClass

public static Class<? extends ContextEntry.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo