You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Instance Attribute Details

#authorizer_function_arnString

The ARN of the authorizer's Lambda function.

Returns:

  • (String)


992
993
994
995
996
997
998
999
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 992

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

#authorizer_nameString

The authorizer name.

Returns:

  • (String)


992
993
994
995
996
997
998
999
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 992

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

#statusString

The status of the create authorizer request.

Returns:

  • (String)


992
993
994
995
996
997
998
999
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 992

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

#token_key_nameString

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

Returns:

  • (String)


992
993
994
995
996
997
998
999
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 992

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

#token_signing_public_keysHash<String,String>

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

Returns:

  • (Hash<String,String>)


992
993
994
995
996
997
998
999
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 992

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