Class CfnAuthorizer

The AWS::ApiGatewayV2::Authorizer resource creates an authorizer for a WebSocket API or an HTTP API.

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

To learn more, see Controlling and managing access to a WebSocket API in API Gateway and Controlling and managing access to an HTTP API in API Gateway in the API Gateway Developer Guide .

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

CloudformationResource: AWS::ApiGatewayV2::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.Apigatewayv2;

var cfnAuthorizer = new CfnAuthorizer(this, "MyCfnAuthorizer", new CfnAuthorizerProps {
    ApiId = "apiId",
    AuthorizerType = "authorizerType",
    Name = "name",

    // the properties below are optional
    AuthorizerCredentialsArn = "authorizerCredentialsArn",
    AuthorizerPayloadFormatVersion = "authorizerPayloadFormatVersion",
    AuthorizerResultTtlInSeconds = 123,
    AuthorizerUri = "authorizerUri",
    EnableSimpleResponses = false,
    IdentitySource = new [] { "identitySource" },
    IdentityValidationExpression = "identityValidationExpression",
    JwtConfiguration = new JWTConfigurationProperty {
        Audience = new [] { "audience" },
        Issuer = "issuer"
    }
});

Synopsis

Constructors

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
CfnAuthorizer(Construct, String, ICfnAuthorizerProps)

Properties

ApiId

The API identifier.
AttrAuthorizerId

The authorizer ID.
AuthorizerCredentialsArn

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
AuthorizerPayloadFormatVersion

Specifies the format of the payload sent to an HTTP API Lambda authorizer.
AuthorizerResultTtlInSeconds

The time to live (TTL) for cached authorizer results, in seconds.
AuthorizerType

The authorizer type.
AuthorizerUri

The authorizer's Uniform Resource Identifier (URI).
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
EnableSimpleResponses

Specifies whether a Lambda authorizer returns a response in a simple format.
IdentitySource

The identity source for which authorization is requested.
IdentityValidationExpression

This parameter is not used.
JwtConfiguration

The JWTConfiguration property specifies the configuration of a JWT authorizer.
Name

The name of the authorizer.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

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

CfnAuthorizer(Construct, String, ICfnAuthorizerProps)

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

Scope in which this resource is defined.

id System.String

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

props ICfnAuthorizerProps

Resource properties.

Properties

ApiId

The API identifier.

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

System.String

AttrAuthorizerId

The authorizer ID.

public virtual string AttrAuthorizerId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: AuthorizerId

AuthorizerCredentialsArn

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

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

System.String

AuthorizerPayloadFormatVersion

Specifies the format of the payload sent to an HTTP API Lambda authorizer.

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

System.String

AuthorizerResultTtlInSeconds

The time to live (TTL) for cached authorizer results, in seconds.

public virtual Nullable<double> AuthorizerResultTtlInSeconds { get; set; }
Property Value

System.Nullable<System.Double>

AuthorizerType

The authorizer type.

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

System.String

AuthorizerUri

The authorizer's Uniform Resource Identifier (URI).

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

System.String

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

EnableSimpleResponses

Specifies whether a Lambda authorizer returns a response in a simple format.

public virtual object EnableSimpleResponses { get; set; }
Property Value

System.Object

IdentitySource

The identity source for which authorization is requested.

public virtual string[] IdentitySource { get; set; }
Property Value

System.String[]

IdentityValidationExpression

This parameter is not used.

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

System.String

JwtConfiguration

The JWTConfiguration property specifies the configuration of a JWT authorizer.

public virtual object JwtConfiguration { get; set; }
Property Value

System.Object

Name

The name of the authorizer.

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

System.String

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>

Overrides

Implements