software.amazon.awssdk.services.cognitoidentityprovider.model

Class CreateIdentityProviderRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CreateIdentityProviderRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateIdentityProviderRequest.Builder,CreateIdentityProviderRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateIdentityProviderRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<CreateIdentityProviderRequest.Builder,CreateIdentityProviderRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateIdentityProviderRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	attributeMapping() A mapping of identity provider attributes to standard and custom user pool attributes.
static CreateIdentityProviderRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributeMapping() Returns true if the AttributeMapping property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasIdpIdentifiers() Returns true if the IdpIdentifiers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasProviderDetails() Returns true if the ProviderDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	idpIdentifiers() A list of identity provider identifiers.
Map<String,String>	providerDetails() The identity provider details.
String	providerName() The identity provider name.
IdentityProviderTypeType	providerType() The identity provider type.
String	providerTypeAsString() The identity provider type.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateIdentityProviderRequest.Builder>	serializableBuilderClass()
CreateIdentityProviderRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userPoolId() The user pool ID.

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

userPoolId

public String userPoolId()

The user pool ID.

Returns:

The user pool ID.

providerName

public String providerName()

The identity provider name.

Returns:

The identity provider name.

providerType

public IdentityProviderTypeType providerType()

The identity provider type.

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 identity provider type.

See Also:

IdentityProviderTypeType

providerTypeAsString

public String providerTypeAsString()

The identity provider type.

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 identity provider type.

See Also:

IdentityProviderTypeType

hasProviderDetails

public boolean hasProviderDetails()

Returns true if the ProviderDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

providerDetails

public Map<String,String> providerDetails()

The identity provider details. The following list describes the provider detail keys for each identity provider type.

• For Google, Facebook and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

  • authorize_scopes

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignOut optional

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasProviderDetails() to see if a value was sent in this field.

Returns:

The identity provider details. The following list describes the provider detail keys for each identity provider type.

• For Google, Facebook and Login with Amazon:

  • client_id

  • client_secret

  • authorize_scopes

• For Sign in with Apple:

  • client_id

  • team_id

  • key_id

  • private_key

  • authorize_scopes

• For OIDC providers:

  • client_id

  • client_secret

  • attributes_request_method

  • oidc_issuer

  • authorize_scopes

  • authorize_url if not available from discovery URL specified by oidc_issuer key

  • token_url if not available from discovery URL specified by oidc_issuer key

  • attributes_url if not available from discovery URL specified by oidc_issuer key

  • jwks_uri if not available from discovery URL specified by oidc_issuer key

  • authorize_scopes

• For SAML providers:

  • MetadataFile OR MetadataURL

  • IDPSignOut optional

hasAttributeMapping

public boolean hasAttributeMapping()

Returns true if the AttributeMapping property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

attributeMapping

public Map<String,String> attributeMapping()

A mapping of identity provider attributes to standard and custom user pool attributes.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAttributeMapping() to see if a value was sent in this field.

Returns:

A mapping of identity provider attributes to standard and custom user pool attributes.

hasIdpIdentifiers

public boolean hasIdpIdentifiers()

Returns true if the IdpIdentifiers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

idpIdentifiers

public List<String> idpIdentifiers()

A list of identity provider identifiers.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasIdpIdentifiers() to see if a value was sent in this field.

Returns:

A list of identity provider identifiers.

toBuilder

public CreateIdentityProviderRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateIdentityProviderRequest.Builder,CreateIdentityProviderRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static CreateIdentityProviderRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo