AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateAuthorizer operation. Creates an authorizer.

Requires permission to access the CreateAuthorizer action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IoT.AmazonIoTRequest
      Amazon.IoT.Model.CreateAuthorizerRequest

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C# 
public class CreateAuthorizerRequest : AmazonIoTRequest
         IAmazonWebServiceRequest

The CreateAuthorizerRequest type exposes the following members

Constructors

NameDescription
Public Method CreateAuthorizerRequest()

Properties

NameTypeDescription
Public Property AuthorizerFunctionArn System.String

Gets and sets the property AuthorizerFunctionArn.

The ARN of the authorizer's Lambda function.

Public Property AuthorizerName System.String

Gets and sets the property AuthorizerName.

The authorizer name.

Public Property EnableCachingForHttp System.Nullable<System.Boolean>

Gets and sets the property EnableCachingForHttp.

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.

Public Property SigningDisabled System.Nullable<System.Boolean>

Gets and sets the property SigningDisabled.

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

Public Property Status Amazon.IoT.AuthorizerStatus

Gets and sets the property Status.

The status of the create authorizer request.

Public Property Tags System.Collections.Generic.List<Amazon.IoT.Model.Tag>

Gets and sets the property Tags.

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..."

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property TokenKeyName System.String

Gets and sets the property TokenKeyName.

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

Public Property TokenSigningPublicKeys System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property TokenSigningPublicKeys.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer