Class IdentityProviderDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The identifier of the Directory Service directory that you want to use as your identity provider.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
function()
The ARN for a Lambda function to use for the Identity provider.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
This parameter is only applicable if yourIdentityProviderType
isAPI_GATEWAY
.static Class
<? extends IdentityProviderDetails.Builder> For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.final String
For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
url()
Provides the location of the service endpoint used to authenticate users.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
This parameter is only applicable if your
IdentityProviderType
isAPI_GATEWAY
. Provides the type ofInvocationRole
used to authenticate the user account.- Returns:
- This parameter is only applicable if your
IdentityProviderType
isAPI_GATEWAY
. Provides the type ofInvocationRole
used to authenticate the user account.
-
directoryId
The identifier of the Directory Service directory that you want to use as your identity provider.
- Returns:
- The identifier of the Directory Service directory that you want to use as your identity provider.
-
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
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 returnSftpAuthenticationMethods.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsftpAuthenticationMethodsAsString()
.- 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:
-
-
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 returnSftpAuthenticationMethods.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsftpAuthenticationMethodsAsString()
.- 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:
-
-
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 interfaceToCopyableBuilder<IdentityProviderDetails.Builder,
IdentityProviderDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-