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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

Note:

When making an API call, you may pass TestIdentityProviderRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[:user_password]

Instance Attribute Summary collapse

Instance Attribute Details

#server_idString

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

Returns:

  • (String)


1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1666

class TestIdentityProviderRequest < Struct.new(
  :server_id,
  :server_protocol,
  :source_ip,
  :user_name,
  :user_password)
  SENSITIVE = [:user_password]
  include Aws::Structure
end

#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)

Returns:

  • (String)


1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1666

class TestIdentityProviderRequest < Struct.new(
  :server_id,
  :server_protocol,
  :source_ip,
  :user_name,
  :user_password)
  SENSITIVE = [:user_password]
  include Aws::Structure
end

#source_ipString

The source IP address of the user account to be tested.

Returns:

  • (String)


1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1666

class TestIdentityProviderRequest < Struct.new(
  :server_id,
  :server_protocol,
  :source_ip,
  :user_name,
  :user_password)
  SENSITIVE = [:user_password]
  include Aws::Structure
end

#user_nameString

The name of the user account to be tested.

Returns:

  • (String)


1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1666

class TestIdentityProviderRequest < Struct.new(
  :server_id,
  :server_protocol,
  :source_ip,
  :user_name,
  :user_password)
  SENSITIVE = [:user_password]
  include Aws::Structure
end

#user_passwordString

The password of the user account to be tested.

Returns:

  • (String)


1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1666

class TestIdentityProviderRequest < Struct.new(
  :server_id,
  :server_protocol,
  :source_ip,
  :user_name,
  :user_password)
  SENSITIVE = [:user_password]
  include Aws::Structure
end