Package software.amazon.awssdk.services.verifiedpermissions.model

Class IdentitySourceItemDetails

java.lang.Object

software.amazon.awssdk.services.verifiedpermissions.model.IdentitySourceItemDetails

All Implemented Interfaces:

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

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

A structure that contains configuration of the identity source.

This data type is used as a response parameter for the CreateIdentitySource operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IdentitySourceItemDetails.Builder

Method Summary

Modifier and Type	Method	Description
static IdentitySourceItemDetails.Builder	builder()
List<String>	clientIds()	The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.
String	discoveryUrl()	The well-known URL that points to this user pool's OIDC discovery endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClientIds()	For responses, this returns true if the service returned a value for the ClientIds property.
int	hashCode()
OpenIdIssuer	openIdIssuer()	A string that identifies the type of OIDC service represented by this identity source.
String	openIdIssuerAsString()	A string that identifies the type of OIDC service represented by this identity source.
List<SdkField<?>>	sdkFields()
static Class<? extends IdentitySourceItemDetails.Builder>	serializableBuilderClass()
IdentitySourceItemDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPoolArn()	The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

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

hasClientIds

public final boolean hasClientIds()

For responses, this returns true if the service returned a value for the ClientIds 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.

clientIds

public final List<String> clientIds()

The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.

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

Returns:

The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.

userPoolArn

public final String userPoolArn()

The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

Returns:

The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.

discoveryUrl

public final String discoveryUrl()

The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.

https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration

Returns:

The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.

https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration

openIdIssuer

public final OpenIdIssuer openIdIssuer()

A string that identifies the type of OIDC service represented by this identity source.

At this time, the only valid value is cognito.

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

Returns:

A string that identifies the type of OIDC service represented by this identity source.

At this time, the only valid value is cognito.

See Also:

OpenIdIssuer

openIdIssuerAsString

public final String openIdIssuerAsString()

A string that identifies the type of OIDC service represented by this identity source.

At this time, the only valid value is cognito.

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

Returns:

A string that identifies the type of OIDC service represented by this identity source.

At this time, the only valid value is cognito.

See Also:

OpenIdIssuer

toBuilder

public IdentitySourceItemDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IdentitySourceItemDetails.Builder,IdentitySourceItemDetails>

builder

public static IdentitySourceItemDetails.Builder builder()

serializableBuilderClass

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