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

Class: Aws::CognitoIdentityProvider::Types::ContextDataType

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

Overview

Note:

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

{
  ip_address: "StringType", # required
  server_name: "StringType", # required
  server_path: "StringType", # required
  http_headers: [ # required
    {
      header_name: "StringType",
      header_value: "StringType",
    },
  ],
  encoded_data: "StringType",
}

Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Instance Attribute Summary collapse

Instance Attribute Details

#encoded_dataString

Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.

Returns:

  • (String)


2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2324

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  include Aws::Structure
end

#http_headersArray<Types::HttpHeader>

HttpHeaders received on your server in same order.

Returns:



2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2324

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  include Aws::Structure
end

#ip_addressString

Source IP address of your user.

Returns:

  • (String)


2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2324

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  include Aws::Structure
end

#server_nameString

Your server endpoint where this API is invoked.

Returns:

  • (String)


2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2324

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  include Aws::Structure
end

#server_pathString

Your server path where this API is invoked.

Returns:

  • (String)


2324
2325
2326
2327
2328
2329
2330
2331
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2324

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  include Aws::Structure
end