You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::CreateAuthorizerRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::CreateAuthorizerRequest
- Defined in:
- (unknown)
Overview
When passing CreateAuthorizerRequest as input to an Aws::Client method, you can use a vanilla 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,
}
Instance Attribute Summary collapse
-
#authorizer_function_arn ⇒ String
The ARN of the authorizer\'s Lambda function.
-
#authorizer_name ⇒ String
The authorizer name.
-
#signing_disabled ⇒ Boolean
Specifies whether AWS IoT validates the token signature in an authorization request.
-
#status ⇒ String
The status of the create authorizer request.
-
#tags ⇒ Array<Types::Tag>
Metadata which can be used to manage the custom authorizer.
-
#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.
#authorizer_name ⇒ String
The authorizer name.
#signing_disabled ⇒ Boolean
Specifies whether AWS IoT validates the token signature in an authorization request.
#status ⇒ String
The status of the create authorizer request.
Possible values:
- ACTIVE
- INACTIVE
#tags ⇒ Array<Types::Tag>
Metadata which can be used to manage the custom authorizer.
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...\"
#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.