Class CfnAuthorizer

Specifies an authorizer.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnAuthorizer
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAuthorizer : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnAuthorizer Inherits CfnResource Implements IInspectable, ITaggable
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

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 cfnAuthorizer = new CfnAuthorizer(this, "MyCfnAuthorizer", 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

Constructors

CfnAuthorizer(Construct, string, ICfnAuthorizerProps)

Specifies an authorizer.

Properties

AttrArn

The Amazon Resource Name (ARN) of the authorizer.
AuthorizerFunctionArn

The authorizer's Lambda function ARN.
AuthorizerName

The authorizer name.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

Specifies an authorizer.
EnableCachingForHttp

When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections.
SigningDisabled

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

The status of the authorizer.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

Specifies an authorizer.

Constructors

CfnAuthorizer(Construct, string, ICfnAuthorizerProps)

Specifies an authorizer.

public CfnAuthorizer(Construct scope, string id, ICfnAuthorizerProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnAuthorizerProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the authorizer.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AuthorizerFunctionArn

The authorizer's Lambda function ARN.

public virtual string AuthorizerFunctionArn { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

AuthorizerName

The authorizer name.

public virtual string? AuthorizerName { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

CfnProperties

Specifies an authorizer.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

EnableCachingForHttp

When true , the result from the authorizer's Lambda function is cached for clients that use persistent HTTP connections.

public virtual object? EnableCachingForHttp { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

SigningDisabled

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

public virtual object? SigningDisabled { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

Status

The status of the authorizer.

public virtual string? Status { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

TagsRaw

Metadata which can be used to manage the custom authorizer.

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

TokenKeyName

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

public virtual string? TokenKeyName { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

TokenSigningPublicKeys

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

public virtual object? TokenSigningPublicKeys { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies an authorizer.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-authorizer.html

CloudformationResource: AWS::IoT::Authorizer

ExampleMetadata: fixture=_generated

Implements