Class UpdateSamlProviderRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iam.model.IamRequest
software.amazon.awssdk.services.iam.model.UpdateSamlProviderRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateSamlProviderRequest.Builder,UpdateSamlProviderRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateSamlProviderRequest extends IamRequest implements ToCopyableBuilder<UpdateSamlProviderRequest.Builder,UpdateSamlProviderRequest>

  • Method Details

    • samlMetadataDocument

      public final String samlMetadataDocument()

      An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your IdP.

      Returns:
      An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your IdP.

    • samlProviderArn

      public final String samlProviderArn()

      The Amazon Resource Name (ARN) of the SAML provider to update.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      Returns:
      The Amazon Resource Name (ARN) of the SAML provider to update.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

    • assertionEncryptionMode

      public final AssertionEncryptionModeType assertionEncryptionMode()

      Specifies the encryption setting for the SAML provider.

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

      Returns:
      Specifies the encryption setting for the SAML provider.
      See Also:

    • assertionEncryptionModeAsString

      public final String assertionEncryptionModeAsString()

      Specifies the encryption setting for the SAML provider.

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

      Returns:
      Specifies the encryption setting for the SAML provider.
      See Also:

    • addPrivateKey

      public final String addPrivateKey()

      Specifies the new private key from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

      Returns:
      Specifies the new private key from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.

    • removePrivateKey

      public final String removePrivateKey()

      The Key ID of the private key to remove.

      Returns:
      The Key ID of the private key to remove.

    • toBuilder

      public UpdateSamlProviderRequest.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<UpdateSamlProviderRequest.Builder,UpdateSamlProviderRequest>
      Specified by:
      toBuilder in class IamRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateSamlProviderRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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