Class ContextProviderKeyDefinition

java.lang.Object
software.amazon.awssdk.services.iam.model.ContextProviderKeyDefinition
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ContextProviderKeyDefinition.Builder,ContextProviderKeyDefinition>

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

Defines a single mapping from a source key in the external identity provider's assertion or token to a target trusted context key.

This data type is used as a member of the ContextProvider data type.

See Also:
  • Method Details

    • sourceKey

      public final String sourceKey()

      The key in the external identity provider's assertion or token to read the value from.

      The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      Returns:
      The key in the external identity provider's assertion or token to read the value from.

      The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

    • targetKey

      public final String targetKey()

      The trusted context key to map the source value into.

      The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

      Returns:
      The trusted context key to map the source value into.

      The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters: _ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.

    • 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<ContextProviderKeyDefinition.Builder,ContextProviderKeyDefinition>
      Returns:
      a builder for type T
    • builder

      public static ContextProviderKeyDefinition.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ContextProviderKeyDefinition.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.