Class: Aws::IoT::Types::CreateAuthorizerRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::CreateAuthorizerRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

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

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

Instance Attribute Summary

• #authorizer_function_arn ⇒ String

  The ARN of the authorizer’s Lambda function.

• #authorizer_name ⇒ String

  The authorizer name.

• #status ⇒ String

  The status of the create authorizer request.

• #token_key_name ⇒ String

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

• #token_signing_public_keys ⇒ Hash<String,String>

  The public keys used to verify the digital signature returned by your custom authentication service.

Instance Attribute Details

#authorizer_function_arn ⇒ String

The ARN of the authorizer’s Lambda function.

Returns:

• (String)

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

class CreateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status)
  include Aws::Structure
end

#authorizer_name ⇒ String

The authorizer name.

Returns:

• (String)

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

class CreateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status)
  include Aws::Structure
end

#status ⇒ String

The status of the create authorizer request.

Returns:

• (String)

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

class CreateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status)
  include Aws::Structure
end

#token_key_name ⇒ String

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

Returns:

• (String)

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

class CreateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status)
  include Aws::Structure
end

#token_signing_public_keys ⇒ Hash<String,String>

The public keys used to verify the digital signature returned by your custom authentication service.

Returns:

• (Hash<String,String>)

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

class CreateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status)
  include Aws::Structure
end