Class: Aws::Transfer::Types::IdentityProviderDetails

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

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#directory_idString

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

Returns:

  • (String)


3212
3213
3214
3215
3216
3217
3218
3219
3220
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3212

class IdentityProviderDetails < Struct.new(
  :url,
  :invocation_role,
  :directory_id,
  :function,
  :sftp_authentication_methods)
  SENSITIVE = []
  include Aws::Structure
end

#functionString

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

Returns:

  • (String)


3212
3213
3214
3215
3216
3217
3218
3219
3220
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3212

class IdentityProviderDetails < Struct.new(
  :url,
  :invocation_role,
  :directory_id,
  :function,
  :sftp_authentication_methods)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_roleString

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

Returns:

  • (String)


3212
3213
3214
3215
3216
3217
3218
3219
3220
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3212

class IdentityProviderDetails < Struct.new(
  :url,
  :invocation_role,
  :directory_id,
  :function,
  :sftp_authentication_methods)
  SENSITIVE = []
  include Aws::Structure
end

#sftp_authentication_methodsString

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:

  • (String)


3212
3213
3214
3215
3216
3217
3218
3219
3220
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3212

class IdentityProviderDetails < Struct.new(
  :url,
  :invocation_role,
  :directory_id,
  :function,
  :sftp_authentication_methods)
  SENSITIVE = []
  include Aws::Structure
end

#urlString

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

Returns:

  • (String)


3212
3213
3214
3215
3216
3217
3218
3219
3220
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3212

class IdentityProviderDetails < Struct.new(
  :url,
  :invocation_role,
  :directory_id,
  :function,
  :sftp_authentication_methods)
  SENSITIVE = []
  include Aws::Structure
end