Class PrivateKeyJwtConfig

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.PrivateKeyJwtConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PrivateKeyJwtConfig.Builder,PrivateKeyJwtConfig>
@Generated("software.amazon.awssdk:codegen") public final class PrivateKeyJwtConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PrivateKeyJwtConfig.Builder,PrivateKeyJwtConfig>

Configuration for private_key_jwt client authentication (RFC 7523). On Create: privateKeySource and signingAlgorithm are required (enforced server-side). On Update: all fields are optional — only provided fields are updated.

See Also:

  • Method Details

    • privateKeySource

      public final PrivateKeySource privateKeySource()

      The private key source for the JWT client assertion.

      Returns:
      The private key source for the JWT client assertion.

    • signingAlgorithm

      public final SigningAlgorithm signingAlgorithm()

      The algorithm used to sign the JWT client assertion. Valid values are RS256, PS256, and ES256.

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

      Returns:
      The algorithm used to sign the JWT client assertion. Valid values are RS256, PS256, and ES256.
      See Also:

    • signingAlgorithmAsString

      public final String signingAlgorithmAsString()

      The algorithm used to sign the JWT client assertion. Valid values are RS256, PS256, and ES256.

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

      Returns:
      The algorithm used to sign the JWT client assertion. Valid values are RS256, PS256, and ES256.
      See Also:

    • hasAdditionalHeaderClaims

      public final boolean hasAdditionalHeaderClaims()
      For responses, this returns true if the service returned a value for the AdditionalHeaderClaims 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.

    • additionalHeaderClaims

      public final Map<String,String> additionalHeaderClaims()

      A map of additional claims to include in the JWT client assertion header. Standard header claims such as alg and typ cannot be added.

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

      Returns:
      A map of additional claims to include in the JWT client assertion header. Standard header claims such as alg and typ cannot be added.

    • hasAdditionalPayloadClaims

      public final boolean hasAdditionalPayloadClaims()
      For responses, this returns true if the service returned a value for the AdditionalPayloadClaims 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.

    • additionalPayloadClaims

      public final Map<String,String> additionalPayloadClaims()

      A map of additional claims to include in the JWT client assertion payload. Payload claims generated by the service, such as iss, sub, jti, and exp, cannot be added.

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

      Returns:
      A map of additional claims to include in the JWT client assertion payload. Payload claims generated by the service, such as iss, sub, jti, and exp, cannot be added.

    • toBuilder

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

    • builder

      public static PrivateKeyJwtConfig.Builder builder()

    • serializableBuilderClass

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