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

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateSamlProviderRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	addPrivateKey()	Specifies the new private key from your external identity provider.
AssertionEncryptionModeType	assertionEncryptionMode()	Specifies the encryption setting for the SAML provider.
String	assertionEncryptionModeAsString()	Specifies the encryption setting for the SAML provider.
static UpdateSamlProviderRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	removePrivateKey()	The Key ID of the private key to remove.
String	samlMetadataDocument()	An XML document generated by an identity provider (IdP) that supports SAML 2.0.
String	samlProviderArn()	The Amazon Resource Name (ARN) of the SAML provider to update.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateSamlProviderRequest.Builder>	serializableBuilderClass()
UpdateSamlProviderRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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:

AssertionEncryptionModeType

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:

AssertionEncryptionModeType

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

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateSamlProviderRequest.Builder,UpdateSamlProviderRequest>

Specified by:

toBuilder in class IamRequest

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)

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)

Overrides:

getValueForField in class SdkRequest

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