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

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

Overview

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)


4687
4688
4689
4690
4691
4692
4693
4694
4695
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4687

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)


4687
4688
4689
4690
4691
4692
4693
4694
4695
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4687

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)


4687
4688
4689
4690
4691
4692
4693
4694
4695
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4687

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)


4687
4688
4689
4690
4691
4692
4693
4694
4695
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4687

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)


4687
4688
4689
4690
4691
4692
4693
4694
4695
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4687

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