@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class IdentityProviderDetails extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
IdentityProviderDetails() |
Modifier and Type | Method and Description |
---|---|
IdentityProviderDetails |
clone() |
boolean |
equals(Object obj) |
String |
getDirectoryId()
The identifier of the Directory Service directory that you want to use as your identity provider.
|
String |
getFunction()
The ARN for a Lambda function to use for the Identity provider.
|
String |
getInvocationRole()
This parameter is only applicable if your
IdentityProviderType is API_GATEWAY . |
String |
getSftpAuthenticationMethods()
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 |
getUrl()
Provides the location of the service endpoint used to authenticate users.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setDirectoryId(String directoryId)
The identifier of the Directory Service directory that you want to use as your identity provider.
|
void |
setFunction(String function)
The ARN for a Lambda function to use for the Identity provider.
|
void |
setInvocationRole(String invocationRole)
This parameter is only applicable if your
IdentityProviderType is API_GATEWAY . |
void |
setSftpAuthenticationMethods(String 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.
|
void |
setUrl(String url)
Provides the location of the service endpoint used to authenticate users.
|
String |
toString()
Returns a string representation of this object.
|
IdentityProviderDetails |
withDirectoryId(String directoryId)
The identifier of the Directory Service directory that you want to use as your identity provider.
|
IdentityProviderDetails |
withFunction(String function)
The ARN for a Lambda function to use for the Identity provider.
|
IdentityProviderDetails |
withInvocationRole(String invocationRole)
This parameter is only applicable if your
IdentityProviderType is API_GATEWAY . |
IdentityProviderDetails |
withSftpAuthenticationMethods(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.
|
IdentityProviderDetails |
withSftpAuthenticationMethods(String 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.
|
IdentityProviderDetails |
withUrl(String url)
Provides the location of the service endpoint used to authenticate users.
|
public void setUrl(String url)
Provides the location of the service endpoint used to authenticate users.
url
- Provides the location of the service endpoint used to authenticate users.public String getUrl()
Provides the location of the service endpoint used to authenticate users.
public IdentityProviderDetails withUrl(String url)
Provides the location of the service endpoint used to authenticate users.
url
- Provides the location of the service endpoint used to authenticate users.public void setInvocationRole(String invocationRole)
This parameter is only applicable if your IdentityProviderType
is API_GATEWAY
. Provides
the type of InvocationRole
used to authenticate the user account.
invocationRole
- This parameter is only applicable if your IdentityProviderType
is API_GATEWAY
.
Provides the type of InvocationRole
used to authenticate the user account.public String getInvocationRole()
This parameter is only applicable if your IdentityProviderType
is API_GATEWAY
. Provides
the type of InvocationRole
used to authenticate the user account.
IdentityProviderType
is API_GATEWAY
.
Provides the type of InvocationRole
used to authenticate the user account.public IdentityProviderDetails withInvocationRole(String invocationRole)
This parameter is only applicable if your IdentityProviderType
is API_GATEWAY
. Provides
the type of InvocationRole
used to authenticate the user account.
invocationRole
- This parameter is only applicable if your IdentityProviderType
is API_GATEWAY
.
Provides the type of InvocationRole
used to authenticate the user account.public void setDirectoryId(String directoryId)
The identifier of the Directory Service directory that you want to use as your identity provider.
directoryId
- The identifier of the Directory Service directory that you want to use as your identity provider.public String getDirectoryId()
The identifier of the Directory Service directory that you want to use as your identity provider.
public IdentityProviderDetails withDirectoryId(String directoryId)
The identifier of the Directory Service directory that you want to use as your identity provider.
directoryId
- The identifier of the Directory Service directory that you want to use as your identity provider.public void setFunction(String function)
The ARN for a Lambda function to use for the Identity provider.
function
- The ARN for a Lambda function to use for the Identity provider.public String getFunction()
The ARN for a Lambda function to use for the Identity provider.
public IdentityProviderDetails withFunction(String function)
The ARN for a Lambda function to use for the Identity provider.
function
- The ARN for a Lambda function to use for the Identity provider.public void setSftpAuthenticationMethods(String 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.
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.
SftpAuthenticationMethods
public String getSftpAuthenticationMethods()
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.
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.
SftpAuthenticationMethods
public IdentityProviderDetails withSftpAuthenticationMethods(String 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.
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.
SftpAuthenticationMethods
public IdentityProviderDetails withSftpAuthenticationMethods(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.
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.
SftpAuthenticationMethods
public String toString()
toString
in class Object
Object.toString()
public IdentityProviderDetails clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.