software.amazon.awssdk.services.transfer.model

Class IdentityProviderDetails

java.lang.Object

software.amazon.awssdk.services.transfer.model.IdentityProviderDetails

All Implemented Interfaces:

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

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

Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IdentityProviderDetails.Builder

Method Summary

Modifier and Type	Method and Description
static IdentityProviderDetails.Builder	builder()
String	directoryId() The identifier of the Directory Service directory that you want to stop sharing.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	function() The ARN for a Lambda function to use for the Identity provider.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	invocationRole() This parameter is only applicable if your IdentityProviderType is API_GATEWAY.
List<SdkField<?>>	sdkFields()
static Class<? extends IdentityProviderDetails.Builder>	serializableBuilderClass()
SftpAuthenticationMethods	sftpAuthenticationMethods() For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.
String	sftpAuthenticationMethodsAsString() For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.
IdentityProviderDetails.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() Provides the location of the service endpoint used to authenticate users.

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

url

public final String url()

Provides the location of the service endpoint used to authenticate users.

Returns:

Provides the location of the service endpoint used to authenticate users.

invocationRole

public final String invocationRole()

This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.

Returns:

This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.

directoryId

public final String directoryId()

The identifier of the Directory Service directory that you want to stop sharing.

Returns:

The identifier of the Directory Service directory that you want to stop sharing.

function

public final String function()

The ARN for a Lambda function to use for the Identity provider.

Returns:

The ARN for a Lambda function to use for the Identity provider.

sftpAuthenticationMethods

public final SftpAuthenticationMethods sftpAuthenticationMethods()

For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.

• PASSWORD - users must provide their password to connect.

• PUBLIC_KEY - users must provide their private key to connect.

• PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.

• PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

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

Returns:

For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.

• PASSWORD - users must provide their password to connect.

• PUBLIC_KEY - users must provide their private key to connect.

• PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.

• PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

See Also:

SftpAuthenticationMethods

sftpAuthenticationMethodsAsString

public final String sftpAuthenticationMethodsAsString()

For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.

• PASSWORD - users must provide their password to connect.

• PUBLIC_KEY - users must provide their private key to connect.

• PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.

• PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

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

Returns:

For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.

• PASSWORD - users must provide their password to connect.

• PUBLIC_KEY - users must provide their private key to connect.

• PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.

• PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

See Also:

SftpAuthenticationMethods

toBuilder

public IdentityProviderDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IdentityProviderDetails.Builder,IdentityProviderDetails>

builder

public static IdentityProviderDetails.Builder builder()

serializableBuilderClass

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