Package software.amazon.awssdk.services.transfer.model

Enum IdentityProviderType

java.lang.Object
java.lang.Enum<IdentityProviderType>
software.amazon.awssdk.services.transfer.model.IdentityProviderType
All Implemented Interfaces:
Serializable, Comparable<IdentityProviderType>
@Generated("software.amazon.awssdk:codegen") public enum IdentityProviderType extends Enum<IdentityProviderType>

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

  • Enum Constant Details

  • Method Details

    • values

      public static IdentityProviderType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static IdentityProviderType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<IdentityProviderType>

    • fromValue

      public static IdentityProviderType fromValue(String value)
      Use this in place of valueOf to convert the raw string returned by the service into the enum value.
      Parameters:
      value - real value
      Returns:
      IdentityProviderType corresponding to the value

    • knownValues

      public static Set<IdentityProviderType> knownValues()
      Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.
      Returns:
      a Set of known IdentityProviderTypes