Class CfnAuthorizer
A CloudFormation AWS::IoT::Authorizer
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public class CfnAuthorizer : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAuthorizer
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies an authorizer.
CloudformationResource: AWS::IoT::Authorizer
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;
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) | Create a new |
CfnAuthorizer(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAuthorizer(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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 | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAuthorizer(Construct, String, ICfnAuthorizerProps)
Create a new AWS::IoT::Authorizer
.
public CfnAuthorizer(Construct scope, string id, ICfnAuthorizerProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAuthorizerProps
- resource properties.
CfnAuthorizer(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAuthorizer(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAuthorizer(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAuthorizer(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the authorizer.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AuthorizerFunctionArn
The authorizer's Lambda function ARN.
public virtual string AuthorizerFunctionArn { get; set; }
Property Value
System.String
Remarks
AuthorizerName
The authorizer name.
public virtual string AuthorizerName { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
EnableCachingForHttp
AWS::IoT::Authorizer.EnableCachingForHttp
.
public virtual object EnableCachingForHttp { get; set; }
Property Value
System.Object
Remarks
SigningDisabled
Specifies whether AWS IoT validates the token signature in an authorization request.
public virtual object SigningDisabled { get; set; }
Property Value
System.Object
Remarks
Status
The status of the authorizer.
public virtual string Status { get; set; }
Property Value
System.String
Remarks
Valid values: ACTIVE
| INACTIVE
Tags
Metadata which can be used to manage the custom authorizer.
public virtual TagManager Tags { get; }
Property Value
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.
public virtual string TokenKeyName { get; set; }
Property Value
System.String
Remarks
TokenSigningPublicKeys
The public keys used to validate the token signature returned by your custom authentication service.
public virtual object TokenSigningPublicKeys { get; set; }
Property Value
System.Object
Remarks
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>