Class: Aws::IoT::Types::UpdateAuthorizerRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::UpdateAuthorizerRequest

Defined in:

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

Overview

Note:

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

{
  authorizer_name: "AuthorizerName", # required
  authorizer_function_arn: "AuthorizerFunctionArn",
  token_key_name: "TokenKeyName",
  token_signing_public_keys: {
    "KeyName" => "KeyValue",
  },
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
  enable_caching_for_http: false,
}

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authorizer_function_arn ⇒ String

  The ARN of the authorizer's Lambda function.

• #authorizer_name ⇒ String

  The authorizer name.

• #enable_caching_for_http ⇒ Boolean

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

• #status ⇒ String

  The status of the update authorizer request.

• #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 verify the token signature.

Instance Attribute Details

#authorizer_function_arn ⇒ String

The ARN of the authorizer's Lambda function.

Returns:

• (String)

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

class UpdateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :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 18778

class UpdateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :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 18778

class UpdateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the update authorizer request.

Returns:

• (String)

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

class UpdateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :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 18778

class UpdateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end

#token_signing_public_keys ⇒ Hash<String,String>

The public keys used to verify the token signature.

Returns:

• (Hash<String,String>)

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

class UpdateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :enable_caching_for_http)
  SENSITIVE = []
  include Aws::Structure
end