Interface ICfnAuthorizerProps
Properties for defining a CfnAuthorizer
.
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnAuthorizerProps
Syntax (vb)
Public Interface ICfnAuthorizerProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var cfnAuthorizerProps = new CfnAuthorizerProps {
AuthorizerFunctionArn = "authorizerFunctionArn",
// the properties below are optional
AuthorizerName = "authorizerName",
EnableCachingForHttp = false,
SigningDisabled = false,
Status = "status",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TokenKeyName = "tokenKeyName",
TokenSigningPublicKeys = new Dictionary<string, string> {
{ "tokenSigningPublicKeysKey", "tokenSigningPublicKeys" }
}
};
Synopsis
Properties
AuthorizerFunctionArn | The authorizer's Lambda function ARN. |
AuthorizerName | The authorizer name. |
EnableCachingForHttp | When |
SigningDisabled | Specifies whether AWS IoT validates the token signature in an authorization request. |
Status | The status of the authorizer. |
Tags | Metadata which can be used to manage the custom authorizer. |
TokenKeyName | The key used to extract the token from the HTTP headers. |
TokenSigningPublicKeys | The public keys used to validate the token signature returned by your custom authentication service. |
Properties
AuthorizerFunctionArn
The authorizer's Lambda function ARN.
string AuthorizerFunctionArn { get; }
Property Value
System.String
Remarks
AuthorizerName
The authorizer name.
virtual string AuthorizerName { get; }
Property Value
System.String
Remarks
EnableCachingForHttp
When true
, the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections.
virtual object EnableCachingForHttp { get; }
Property Value
System.Object
Remarks
The results are cached for the time specified by the Lambda function in refreshAfterInSeconds
. This value doesn't affect authorization of clients that use MQTT connections.
SigningDisabled
Specifies whether AWS IoT validates the token signature in an authorization request.
virtual object SigningDisabled { get; }
Property Value
System.Object
Remarks
Status
The status of the authorizer.
virtual string Status { get; }
Property Value
System.String
Remarks
Valid values: ACTIVE
| INACTIVE
Tags
Metadata which can be used to manage the custom authorizer.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
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..."
TokenKeyName
The key used to extract the token from the HTTP headers.
virtual string TokenKeyName { get; }
Property Value
System.String
Remarks
TokenSigningPublicKeys
The public keys used to validate the token signature returned by your custom authentication service.
virtual object TokenSigningPublicKeys { get; }
Property Value
System.Object