Package 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("software.amazon.awssdk:codegen") public final class CreateIdentityProviderRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<CreateIdentityProviderRequest.Builder,CreateIdentityProviderRequest>

  • Method Details

    • userPoolId

      public final String userPoolId()

      The user pool ID.

      Returns:
      The user pool ID.

    • providerName

      public final String providerName()

      The IdP name.

      Returns:
      The IdP name.

    • providerType

      public final IdentityProviderTypeType providerType()

      The IdP 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 IdP type.
      See Also:

    • providerTypeAsString

      public final String providerTypeAsString()

      The IdP 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 IdP type.
      See Also:

    • hasProviderDetails

      public final boolean hasProviderDetails()
      For responses, this returns true if the service returned a value for the ProviderDetails 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.

    • providerDetails

      public final Map<String,String> providerDetails()

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

      • For Google and Login with Amazon:

        • client_id

        • client_secret

        • authorize_scopes

      • For Facebook:

        • client_id

        • client_secret

        • authorize_scopes

        • api_version

      • For Sign in with Apple:

        • client_id

        • team_id

        • key_id

        • private_key

        • authorize_scopes

      • For OpenID Connect (OIDC) providers:

        • client_id

        • client_secret

        • attributes_request_method

        • oidc_issuer

        • authorize_scopes

        • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

          • authorize_url

          • token_url

          • attributes_url

          • jwks_uri

        • Amazon Cognito sets the value of the following keys automatically. They are read-only.

          • attributes_url_add_attributes

      • For SAML providers:

        • MetadataFile or MetadataURL

        • IDPSignout optional

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

      Returns:
      The IdP details. The following list describes the provider detail keys for each IdP type.

      • For Google and Login with Amazon:

        • client_id

        • client_secret

        • authorize_scopes

      • For Facebook:

        • client_id

        • client_secret

        • authorize_scopes

        • api_version

      • For Sign in with Apple:

        • client_id

        • team_id

        • key_id

        • private_key

        • authorize_scopes

      • For OpenID Connect (OIDC) providers:

        • client_id

        • client_secret

        • attributes_request_method

        • oidc_issuer

        • authorize_scopes

        • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.

          • authorize_url

          • token_url

          • attributes_url

          • jwks_uri

        • Amazon Cognito sets the value of the following keys automatically. They are read-only.

          • attributes_url_add_attributes

      • For SAML providers:

        • MetadataFile or MetadataURL

        • IDPSignout optional

    • hasAttributeMapping

      public final boolean hasAttributeMapping()
      For responses, this returns true if the service returned a value for the AttributeMapping 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.

    • attributeMapping

      public final Map<String,String> attributeMapping()

      A mapping of IdP attributes to standard and custom user pool attributes.

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

      Returns:
      A mapping of IdP attributes to standard and custom user pool attributes.

    • hasIdpIdentifiers

      public final boolean hasIdpIdentifiers()
      For responses, this returns true if the service returned a value for the IdpIdentifiers 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.

    • idpIdentifiers

      public final List<String> idpIdentifiers()

      A list of IdP identifiers.

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

      Returns:
      A list of IdP identifiers.

    • toBuilder

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

    • builder

      public static CreateIdentityProviderRequest.Builder builder()

    • serializableBuilderClass

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