software.amazon.awssdk.services.iam.model

Class ContextEntry

java.lang.Object

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

All Implemented Interfaces:

ToCopyableBuilder<ContextEntry.Builder,ContextEntry>

@Generated(value="software.amazon.awssdk:codegen")
public class ContextEntry
extends Object
implements 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 SimulateCustomPolicy .

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ContextEntry.Builder

Method Summary

Modifier and Type	Method and 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 for use when the key is referenced by a Condition element in an input policy.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
static Class<? extends ContextEntry.Builder>	serializableBuilderClass()
ContextEntry.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

contextKeyName

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

contextKeyValues

public List<String> contextKeyValues()

The value (or values, if the condition context key supports multiple values) to provide to the simulation for use 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.

Returns:

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

contextKeyType

public 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 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ContextEntry.Builder,ContextEntry>

Returns:

a builder for type T

builder

public static ContextEntry.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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