Package software.amazon.awscdk.services.apigateway

Class CfnAuthorizer

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigateway.CfnAuthorizer
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.745Z") @Stability(Stable) public class CfnAuthorizer extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGateway::Authorizer.

The AWS::ApiGateway::Authorizer resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 CfnAuthorizer cfnAuthorizer = CfnAuthorizer.Builder.create(this, "MyCfnAuthorizer")
         .name("name")
         .restApiId("restApiId")
         .type("type")
         // the properties below are optional
         .authorizerCredentials("authorizerCredentials")
         .authorizerResultTtlInSeconds(123)
         .authorizerUri("authorizerUri")
         .authType("authType")
         .identitySource("identitySource")
         .identityValidationExpression("identityValidationExpression")
         .providerArns(List.of("providerArns"))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAuthorizer

      protected CfnAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAuthorizer

      protected CfnAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAuthorizer

      @Stability(Stable) public CfnAuthorizer(@NotNull Construct scope, @NotNull String id, @NotNull CfnAuthorizerProps props)
      Create a new AWS::ApiGateway::Authorizer.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAuthorizerId

      @Stability(Stable) @NotNull public String getAttrAuthorizerId()
      The ID for the authorizer.

      For example: abc123 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the authorizer.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the authorizer.

    • getRestApiId

      @Stability(Stable) @NotNull public String getRestApiId()
      The string identifier of the associated RestApi.

    • setRestApiId

      @Stability(Stable) public void setRestApiId(@NotNull String value)
      The string identifier of the associated RestApi.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The authorizer type.

      Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The authorizer type.

      Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

    • getAuthorizerCredentials

      @Stability(Stable) @Nullable public String getAuthorizerCredentials()
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

      To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

    • setAuthorizerCredentials

      @Stability(Stable) public void setAuthorizerCredentials(@Nullable String value)
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

      To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

    • getAuthorizerResultTtlInSeconds

      @Stability(Stable) @Nullable public Number getAuthorizerResultTtlInSeconds()
      The TTL in seconds of cached authorizer results.

      If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

    • setAuthorizerResultTtlInSeconds

      @Stability(Stable) public void setAuthorizerResultTtlInSeconds(@Nullable Number value)
      The TTL in seconds of cached authorizer results.

      If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

    • getAuthorizerUri

      @Stability(Stable) @Nullable public String getAuthorizerUri()
      Specifies the authorizer's Uniform Resource Identifier (URI).

      For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial / . For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations .

    • setAuthorizerUri

      @Stability(Stable) public void setAuthorizerUri(@Nullable String value)
      Specifies the authorizer's Uniform Resource Identifier (URI).

      For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial / . For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations .

    • getAuthType

      @Stability(Stable) @Nullable public String getAuthType()
      Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

    • setAuthType

      @Stability(Stable) public void setAuthType(@Nullable String value)
      Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

    • getIdentitySource

      @Stability(Stable) @Nullable public String getIdentitySource()
      The identity source for which authorization is requested.

      For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

    • setIdentitySource

      @Stability(Stable) public void setIdentitySource(@Nullable String value)
      The identity source for which authorization is requested.

      For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

    • getIdentityValidationExpression

      @Stability(Stable) @Nullable public String getIdentityValidationExpression()
      A validation expression for the incoming identity token.

      For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

    • setIdentityValidationExpression

      @Stability(Stable) public void setIdentityValidationExpression(@Nullable String value)
      A validation expression for the incoming identity token.

      For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

    • getProviderArns

      @Stability(Stable) @Nullable public List<String> getProviderArns()
      A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.

      Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.

    • setProviderArns

      @Stability(Stable) public void setProviderArns(@Nullable List<String> value)
      A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.

      Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.