Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class ProviderDescription

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.ProviderDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ProviderDescription.Builder,ProviderDescription>

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

The details of a user pool identity provider (IdP), including name and type.

This data type is a response parameter of ListIdentityProviders.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProviderDescription.Builder

Method Summary

Modifier and Type	Method	Description
static ProviderDescription.Builder	builder()
Instant	creationDate()	The date and time when the item was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedDate()	The date and time when the item was modified.
String	providerName()	The name of the IdP, for example MySAMLProvider.
IdentityProviderTypeType	providerType()	The type of the provider, for example SAML.
String	providerTypeAsString()	The type of the provider, for example SAML.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ProviderDescription.Builder>	serializableBuilderClass()
ProviderDescription.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

providerName

public final String providerName()

The name of the IdP, for example MySAMLProvider.

Returns:

The name of the IdP, for example MySAMLProvider.

providerType

public final IdentityProviderTypeType providerType()

The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0, OIDC, and social IdPs. User pools list supported social IdPs by name in this response parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.

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

Returns:

The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0, OIDC, and social IdPs. User pools list supported social IdPs by name in this response parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.

See Also:

IdentityProviderTypeType

providerTypeAsString

public final String providerTypeAsString()

The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0, OIDC, and social IdPs. User pools list supported social IdPs by name in this response parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.

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

Returns:

The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0, OIDC, and social IdPs. User pools list supported social IdPs by name in this response parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.

See Also:

IdentityProviderTypeType

lastModifiedDate

public final Instant lastModifiedDate()

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

creationDate

public final Instant creationDate()

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

toBuilder

public ProviderDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProviderDescription.Builder,ProviderDescription>

builder

public static ProviderDescription.Builder builder()

serializableBuilderClass

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

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)

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