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

Inherits:
Struct
  • Object
show all
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 collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authorizer_function_arnString

The ARN of the authorizer's Lambda function.

Returns:

  • (String)


19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19134

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_nameString

The authorizer name.

Returns:

  • (String)


19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19134

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_httpBoolean

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)


19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19134

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

#statusString

The status of the update authorizer request.

Returns:

  • (String)


19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19134

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_nameString

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

Returns:

  • (String)


19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19134

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_keysHash<String,String>

The public keys used to verify the token signature.

Returns:

  • (Hash<String,String>)


19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 19134

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