Interface ICfnAuthorizerProps

Properties for defining a CfnAuthorizer.

Namespace: Amazon.CDK.AWS.IoT

Assembly: Amazon.CDK.AWS.IoT.dll

Syntax (csharp)

public interface ICfnAuthorizerProps

Syntax (vb)

Public Interface ICfnAuthorizerProps

Remarks

Link: 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;

CfnAuthorizerProps 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	AWS::IoT::Authorizer.EnableCachingForHttp.
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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-authorizerfunctionarn

AuthorizerName

The authorizer name.

virtual string AuthorizerName { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-authorizername

EnableCachingForHttp

AWS::IoT::Authorizer.EnableCachingForHttp.

virtual object EnableCachingForHttp { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-enablecachingforhttp

SigningDisabled

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

virtual object SigningDisabled { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-signingdisabled

Status

The status of the authorizer.

virtual string Status { get; }

Property Value

System.String

Remarks

Valid values: ACTIVE | INACTIVE

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-status

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tags

TokenKeyName

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

virtual string TokenKeyName { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tokenkeyname

TokenSigningPublicKeys

The public keys used to validate the token signature returned by your custom authentication service.

virtual object TokenSigningPublicKeys { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html#cfn-iot-authorizer-tokensigningpublickeys