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",
  token_signing_public_keys: {
    "KeyName" => "KeyValue",
  },
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  signing_disabled: false,
  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)


2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2939

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

#authorizer_nameString

The authorizer name.

Returns:

  • (String)


2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2939

class CreateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :tags,
  :signing_disabled,
  :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 clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

The default value is false.

Returns:

  • (Boolean)


2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2939

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

#signing_disabledBoolean

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

Returns:

  • (Boolean)


2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2939

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

#statusString

The status of the create authorizer request.

Returns:

  • (String)


2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2939

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

#tagsArray<Types::Tag>

Metadata which can be used to manage the custom authorizer.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns:



2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2939

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

#token_key_nameString

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

Returns:

  • (String)


2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2939

class CreateAuthorizerRequest < Struct.new(
  :authorizer_name,
  :authorizer_function_arn,
  :token_key_name,
  :token_signing_public_keys,
  :status,
  :tags,
  :signing_disabled,
  :enable_caching_for_http)
  SENSITIVE = []
  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>)


2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2939

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