Class CfnAuthorizer
The AWS::ApiGateway::Authorizer
resource creates an authorization layer that API Gateway activates for methods that have authorization enabled.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAuthorizer : CfnResource, IInspectable
Syntax (vb)
Public Class CfnAuthorizer
Inherits CfnResource
Implements IInspectable
Remarks
API Gateway activates the authorizer when a client calls those methods.
CloudformationResource: AWS::ApiGateway::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.APIGateway;
var cfnAuthorizer = new CfnAuthorizer(this, "MyCfnAuthorizer", new CfnAuthorizerProps {
Name = "name",
RestApiId = "restApiId",
Type = "type",
// the properties below are optional
AuthorizerCredentials = "authorizerCredentials",
AuthorizerResultTtlInSeconds = 123,
AuthorizerUri = "authorizerUri",
AuthType = "authType",
IdentitySource = "identitySource",
IdentityValidationExpression = "identityValidationExpression",
ProviderArns = new [] { "providerArns" }
});
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
AttrAuthorizerId | The ID for the authorizer. |
AuthorizerCredentials | Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. |
AuthorizerResultTtlInSeconds | The TTL in seconds of cached authorizer results. |
AuthorizerUri | Specifies the authorizer's Uniform Resource Identifier (URI). |
AuthType | Optional customer-defined field, used in OpenAPI imports and exports without functional impact. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
IdentitySource | The identity source for which authorization is requested. |
IdentityValidationExpression | A validation expression for the incoming identity token. |
Name | The name of the authorizer. |
ProviderArns | A list of the Amazon Cognito user pool ARNs for the |
RestApiId | The string identifier of the associated RestApi. |
Type | The authorizer type. |
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
AttrAuthorizerId
The ID for the authorizer.
public virtual string AttrAuthorizerId { get; }
Property Value
System.String
Remarks
For example: abc123
.
CloudformationAttribute: AuthorizerId
AuthorizerCredentials
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
public virtual string AuthorizerCredentials { get; set; }
Property Value
System.String
AuthorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results.
public virtual Nullable<double> AuthorizerResultTtlInSeconds { get; set; }
Property Value
System.Nullable<System.Double>
AuthorizerUri
Specifies the authorizer's Uniform Resource Identifier (URI).
public virtual string AuthorizerUri { get; set; }
Property Value
System.String
AuthType
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
public virtual string AuthType { 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
IdentitySource
The identity source for which authorization is requested.
public virtual string IdentitySource { get; set; }
Property Value
System.String
IdentityValidationExpression
A validation expression for the incoming identity token.
public virtual string IdentityValidationExpression { get; set; }
Property Value
System.String
Name
The name of the authorizer.
public virtual string Name { get; set; }
Property Value
System.String
ProviderArns
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS
authorizer.
public virtual string[] ProviderArns { get; set; }
Property Value
System.String[]
RestApiId
The string identifier of the associated RestApi.
public virtual string RestApiId { get; set; }
Property Value
System.String
Type
The authorizer type.
public virtual string Type { 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>