AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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 IdentityProviderDetails data as a hash:

{
  url: "Url",
  invocation_role: "Role",
  directory_id: "DirectoryId",
  function: "Function",
}

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 Amazon Web ServicesDirectory Service directory that you want to stop sharing.

Returns:

  • (String)


2133
2134
2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2133

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

#functionString

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

Returns:

  • (String)


2133
2134
2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2133

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

#invocation_roleString

Provides the type of InvocationRole used to authenticate the user account.

Returns:

  • (String)


2133
2134
2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2133

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

#urlString

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

Returns:

  • (String)


2133
2134
2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 2133

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