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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::AuthorizerDescription

Defined in:

gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

The authorizer description.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authorizer_arn ⇒ String

  The authorizer ARN.

• #authorizer_function_arn ⇒ String

  The authorizer's Lambda function ARN.

• #authorizer_name ⇒ String

  The authorizer name.

• #creation_date ⇒ Time

  The UNIX timestamp of when the authorizer was created.

• #enable_caching_for_http ⇒ Boolean

  When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds.

• #last_modified_date ⇒ Time

  The UNIX timestamp of when the authorizer was last updated.

• #signing_disabled ⇒ Boolean

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

• #status ⇒ String

  The status of the authorizer.

• #token_key_name ⇒ String

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

• #token_signing_public_keys ⇒ Hash<String,String>

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

Instance Attribute Details

#authorizer_arn ⇒ String

The authorizer ARN.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1157

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)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1157

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)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1157

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)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1157

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)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1157

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)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1157

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)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1157

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)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1157

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)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1157

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>)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1157

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