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

Interface IdentityProviderDetails.Builder

    • Method Detail

      • url

        IdentityProviderDetails.Builder url​(String url)

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

        Parameters:
        url - Provides the location of the service endpoint used to authenticate users.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • invocationRole

        IdentityProviderDetails.Builder invocationRole​(String invocationRole)

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

        Parameters:
        invocationRole - This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • directoryId

        IdentityProviderDetails.Builder directoryId​(String directoryId)

        The identifier of the Directory Service directory that you want to use as your identity provider.

        Parameters:
        directoryId - The identifier of the Directory Service directory that you want to use as your identity provider.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • function

        IdentityProviderDetails.Builder function​(String function)

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

        Parameters:
        function - The ARN for a Lambda function to use for the Identity provider.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sftpAuthenticationMethods

        IdentityProviderDetails.Builder sftpAuthenticationMethods​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SftpAuthenticationMethods, SftpAuthenticationMethods

      • sftpAuthenticationMethods

        IdentityProviderDetails.Builder sftpAuthenticationMethods​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SftpAuthenticationMethods, SftpAuthenticationMethods