You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Transfer::Types::TestIdentityProviderRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing TestIdentityProviderRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  server_id: "ServerId", # required
  user_name: "UserName", # required
  user_password: "UserPassword",
  server_protocol: "SFTP", # accepts SFTP, FTP, FTPS
}

Instance Attribute Summary collapse

Instance Attribute Details

#server_idString

A system-assigned identifier for a specific file transfer protocol-enabled server. That server\'s user authentication method is tested with a user name and password.

Returns:

  • (String)

    A system-assigned identifier for a specific file transfer protocol-enabled server.

#server_protocolString

The type of file transfer protocol to be tested.

The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP)

  • File Transfer Protocol Secure (FTPS)

  • File Transfer Protocol (FTP)

    Possible values:

    • SFTP
    • FTP
    • FTPS

Returns:

  • (String)

    The type of file transfer protocol to be tested.

#user_nameString

The name of the user account to be tested.

Returns:

  • (String)

    The name of the user account to be tested.

#user_passwordString

The password of the user account to be tested.

Returns:

  • (String)

    The password of the user account to be tested.