Class: Aws::IoT::Types::AuthorizerDescription

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

Overview

The authorizer description.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authorizer_arn ⇒ String

The authorizer ARN.

Returns:

  • (String) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1186

class AuthorizerDescription < Struct.new(
  :authorizer_name,
  :authorizer_arn,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :creation_date,
  :last_modified_date,
  :signing_disabled,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_function_arn ⇒ String

The authorizer's Lambda function ARN.

Returns:

  • (String) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1186

class AuthorizerDescription < Struct.new(
  :authorizer_name,
  :authorizer_arn,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :creation_date,
  :last_modified_date,
  :signing_disabled,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_name ⇒ String

The authorizer name.

Returns:

  • (String) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1186

class AuthorizerDescription < Struct.new(
  :authorizer_name,
  :authorizer_arn,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :creation_date,
  :last_modified_date,
  :signing_disabled,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

The UNIX timestamp of when the authorizer was created.

Returns:

  • (Time) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1186

class AuthorizerDescription < Struct.new(
  :authorizer_name,
  :authorizer_arn,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :creation_date,
  :last_modified_date,
  :signing_disabled,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end

#enable_caching_for_http ⇒ Boolean

When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.

Returns:

  • (Boolean) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1186

class AuthorizerDescription < Struct.new(
  :authorizer_name,
  :authorizer_arn,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :creation_date,
  :last_modified_date,
  :signing_disabled,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Time

The UNIX timestamp of when the authorizer was last updated.

Returns:

  • (Time) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1186

class AuthorizerDescription < Struct.new(
  :authorizer_name,
  :authorizer_arn,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :creation_date,
  :last_modified_date,
  :signing_disabled,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end

#signing_disabled ⇒ Boolean

Specifies whether IoT validates the token signature in an authorization request.

Returns:

  • (Boolean) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1186

class AuthorizerDescription < Struct.new(
  :authorizer_name,
  :authorizer_arn,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :creation_date,
  :last_modified_date,
  :signing_disabled,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the authorizer.

Returns:

  • (String) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1186

class AuthorizerDescription < Struct.new(
  :authorizer_name,
  :authorizer_arn,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :creation_date,
  :last_modified_date,
  :signing_disabled,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end

#token_key_name ⇒ String

The key used to extract the token from the HTTP headers.

Returns:

  • (String) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1186

class AuthorizerDescription < Struct.new(
  :authorizer_name,
  :authorizer_arn,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :creation_date,
  :last_modified_date,
  :signing_disabled,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end

#token_signing_public_keys ⇒ Hash<String,String>

The public keys used to validate the token signature returned by your custom authentication service.

Returns:

  • (Hash<String,String>) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1186

class AuthorizerDescription < Struct.new(
  :authorizer_name,
  :authorizer_arn,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :creation_date,
  :last_modified_date,
  :signing_disabled,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end