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 Summary

Enum Constants

Enum Constant	Description
API_GATEWAY
AWS_DIRECTORY_SERVICE
AWS_LAMBDA
SERVICE_MANAGED
UNKNOWN_TO_SDK_VERSION

Method Summary

Modifier and Type	Method	Description
static IdentityProviderType	fromValue(String value)	Use this in place of valueOf to convert the raw string returned by the service into the enum value.
static Set<IdentityProviderType>	knownValues()	Use this in place of values() to return a Set of all values known to the SDK.
String	toString()
static IdentityProviderType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IdentityProviderType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SERVICE_MANAGED

public static final IdentityProviderType SERVICE_MANAGED

API_GATEWAY

public static final IdentityProviderType API_GATEWAY

AWS_DIRECTORY_SERVICE

public static final IdentityProviderType AWS_DIRECTORY_SERVICE

AWS_LAMBDA

public static final IdentityProviderType AWS_LAMBDA

UNKNOWN_TO_SDK_VERSION

public static final IdentityProviderType UNKNOWN_TO_SDK_VERSION

Method Detail

values

public static IdentityProviderType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IdentityProviderType c : IdentityProviderType.values())
    System.out.println(c);

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