@aws-cdk/aws-apigateway

method contextAccountId

static contextAccountId: () => string;

• The API owner's AWS account ID.

method contextApiId

static contextApiId: () => string;

• The identifier API Gateway assigns to your API.

method contextAuthorizer

static contextAuthorizer: (property: string) => string;

• The stringified value of the specified key-value pair of the context map returned from an API Gateway Lambda authorizer function.

  Parameter property

  key of the context map.

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html

method contextAuthorizerClaims

static contextAuthorizerClaims: (property: string) => string;

• A property of the claims returned from the Amazon Cognito user pool after the method caller is successfully authenticated.

  Parameter property

  A property key of the claims.

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html

method contextAuthorizerIntegrationLatency

static contextAuthorizerIntegrationLatency: () => string;

• The authorizer latency in ms.

method contextAuthorizerPrincipalId

static contextAuthorizerPrincipalId: () => string;

• The principal user identification associated with the token sent by the client and returned from an API Gateway Lambda authorizer (formerly known as a custom authorizer).

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html

method contextAwsEndpointRequestId

static contextAwsEndpointRequestId: () => string;

• The AWS endpoint's request ID.

method contextDomainName

static contextDomainName: () => string;

• The full domain name used to invoke the API. This should be the same as the incoming Host header.

method contextDomainPrefix

static contextDomainPrefix: () => string;

• The first label of the $context.domainName. This is often used as a caller/customer identifier.

method contextErrorMessage

static contextErrorMessage: () => string;

• A string containing an API Gateway error message.

method contextErrorMessageString

static contextErrorMessageString: () => string;

• The quoted value of $context.error.message, namely "$context.error.message".

method contextErrorResponseType

static contextErrorResponseType: () => string;

• A type of GatewayResponse. This variable can only be used for simple variable substitution in a GatewayResponse body-mapping template, which is not processed by the Velocity Template Language engine, and in access logging.

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-logging.html

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html

method contextErrorValidationErrorString

static contextErrorValidationErrorString: () => string;

• A string containing a detailed validation error message.

method contextExtendedRequestId

static contextExtendedRequestId: () => string;

• The extended ID that API Gateway assigns to the API request, which contains more useful information for debugging/troubleshooting.

method contextHttpMethod

static contextHttpMethod: () => string;

• The HTTP method used. Valid values include: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

method contextIdentityAccountId

static contextIdentityAccountId: () => string;

• The AWS account ID associated with the request.

method contextIdentityApiKey

static contextIdentityApiKey: () => string;

• For API methods that require an API key, this variable is the API key associated with the method request. For methods that don't require an API key, this variable is

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html

method contextIdentityApiKeyId

static contextIdentityApiKeyId: () => string;

• The API key ID associated with an API request that requires an API key.

method contextIdentityCaller

static contextIdentityCaller: () => string;

• The principal identifier of the caller making the request.

method contextIdentityCognitoAuthenticationProvider

static contextIdentityCognitoAuthenticationProvider: () => string;

• The Amazon Cognito authentication provider used by the caller making the request. Available only if the request was signed with Amazon Cognito credentials.

  See Also

  • https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html

method contextIdentityCognitoAuthenticationType

static contextIdentityCognitoAuthenticationType: () => string;

• The Amazon Cognito authentication type of the caller making the request. Available only if the request was signed with Amazon Cognito credentials.

method contextIdentityCognitoIdentityId

static contextIdentityCognitoIdentityId: () => string;

• The Amazon Cognito identity ID of the caller making the request. Available only if the request was signed with Amazon Cognito credentials.

method contextIdentityCognitoIdentityPoolId

static contextIdentityCognitoIdentityPoolId: () => string;

• The Amazon Cognito identity pool ID of the caller making the request. Available only if the request was signed with Amazon Cognito credentials.

method contextIdentityPrincipalOrgId

static contextIdentityPrincipalOrgId: () => string;

• The AWS organization ID.

method contextIdentitySourceIp

static contextIdentitySourceIp: () => string;

• The source IP address of the TCP connection making the request to API Gateway. Warning: You should not trust this value if there is any chance that the X-Forwarded-For header could be forged.

method contextIdentityUser

static contextIdentityUser: () => string;

• The principal identifier of the user making the request. Used in Lambda authorizers.

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html

method contextIdentityUserAgent

static contextIdentityUserAgent: () => string;

• The User-Agent header of the API caller.

method contextIdentityUserArn

static contextIdentityUserArn: () => string;

• The Amazon Resource Name (ARN) of the effective user identified after authentication.

  See Also

  • https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html

method contextIntegrationLatency

static contextIntegrationLatency: () => string;

• The integration latency in ms.

method contextIntegrationStatus

static contextIntegrationStatus: () => string;

• For Lambda proxy integration, this parameter represents the status code returned from AWS Lambda, not from the backend Lambda function.

method contextPath

static contextPath: () => string;

• The request path. For example, for a non-proxy request URL of https://{rest-api-id.execute-api.{region}.amazonaws.com/{stage}/root/child, this value is /{stage}/root/child.

method contextProtocol

static contextProtocol: () => string;

• The request protocol, for example, HTTP/1.1.

method contextRequestId

static contextRequestId: () => string;

• The ID that API Gateway assigns to the API request.

method contextRequestOverrideHeader

static contextRequestOverrideHeader: (headerName: string) => string;

• The request header override. If this parameter is defined, it contains the headers to be used instead of the HTTP Headers that are defined in the Integration Request pane.

  Parameter headerName

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html

method contextRequestOverridePath

static contextRequestOverridePath: (pathName: string) => string;

• The request path override. If this parameter is defined, it contains the request path to be used instead of the URL Path Parameters that are defined in the Integration Request pane.

  Parameter pathName

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html

method contextRequestOverrideQuerystring

static contextRequestOverrideQuerystring: (querystringName: string) => string;

• The request query string override. If this parameter is defined, it contains the request query strings to be used instead of the URL Query String Parameters that are defined in the Integration Request pane.

  Parameter querystringName

method contextRequestTime

static contextRequestTime: () => string;

• The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm).

method contextRequestTimeEpoch

static contextRequestTimeEpoch: () => string;

• The Epoch-formatted request time.

method contextResourceId

static contextResourceId: () => string;

• The identifier that API Gateway assigns to your resource.

method contextResourcePath

static contextResourcePath: () => string;

• The path to your resource. For example, for the non-proxy request URI of https://{rest-api-id.execute-api.{region}.amazonaws.com/{stage}/root/child, The $context.resourcePath value is /root/child.

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-step-by-step.html

method contextResponseLatency

static contextResponseLatency: () => string;

• The response latency in ms.

method contextResponseLength

static contextResponseLength: () => string;

• The response payload length.

method contextResponseOverrideHeader

static contextResponseOverrideHeader: (headerName: string) => string;

• The response header override. If this parameter is defined, it contains the header to be returned instead of the Response header that is defined as the Default mapping in the Integration Response pane.

  Parameter headerName

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html

method contextResponseOverrideStatus

static contextResponseOverrideStatus: () => string;

• The response status code override. If this parameter is defined, it contains the status code to be returned instead of the Method response status that is defined as the Default mapping in the Integration Response pane.

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html

method contextStage

static contextStage: () => string;

• The deployment stage of the API request (for example, Beta or Prod).

method contextStatus

static contextStatus: () => string;

• The method response status.

method contextWafResponseCode

static contextWafResponseCode: () => string;

• The response received from AWS WAF: WAF_ALLOW or WAF_BLOCK. Will not be set if the stage is not associated with a web ACL.

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-aws-waf.html

method contextWebaclArn

static contextWebaclArn: () => string;

• The complete ARN of the web ACL that is used to decide whether to allow or block the request. Will not be set if the stage is not associated with a web ACL.

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-aws-waf.html

method contextXrayTraceId

static contextXrayTraceId: () => string;

• The trace ID for the X-Ray trace.

  See Also

  • https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-enabling-xray.html

method clf

static clf: () => AccessLogFormat;

• Generate Common Log Format.

method custom

static custom: (format: string) => AccessLogFormat;

• Custom log format. You can create any log format string. You can easily get the $ context variable by using the methods of AccessLogField.

  Parameter format

  Example 1

  apigateway.AccessLogFormat.custom(JSON.stringify({ requestId: apigateway.AccessLogField.contextRequestId(), sourceIp: apigateway.AccessLogField.contextIdentitySourceIp(), method: apigateway.AccessLogField.contextHttpMethod(), userContext: { sub: apigateway.AccessLogField.contextAuthorizerClaims('sub'), email: apigateway.AccessLogField.contextAuthorizerClaims('email') } }))

method jsonWithStandardFields

static jsonWithStandardFields: (
    fields?: JsonWithStandardFieldProps
) => AccessLogFormat;

• Access log will be produced in the JSON format with a set of fields most useful in the access log. All fields are turned on by default with the option to turn off specific fields.

method toString

toString: () => string;

• Output a format string to be used with CloudFormation.

method bind

abstract bind: (scope: Construct) => ApiDefinitionConfig;

• Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun.

  Parameter scope

  The binding scope. Don't be smart about trying to down-cast or assume it's initialized. You may just use it as a construct scope.

method bindAfterCreate

bindAfterCreate: (_scope: Construct, _restApi: IRestApi) => void;

• Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it. Specifically it's required to allow assets to add metadata for tooling like SAM CLI to be able to find their origins.

method fromAsset

static fromAsset: (
    file: string,
    options?: s3_assets.AssetOptions
) => AssetApiDefinition;

• Loads the API specification from a local disk asset.

method fromBucket

static fromBucket: (
    bucket: s3.IBucket,
    key: string,
    objectVersion?: string
) => S3ApiDefinition;

• Creates an API definition from a specification file in an S3 bucket

method fromInline

static fromInline: (definition: any) => InlineApiDefinition;

• Create an API definition from an inline object. The inline object must follow the schema of OpenAPI 2.0 or OpenAPI 3.0

  Example 1

  apigateway.ApiDefinition.fromInline({ openapi: '3.0.2', paths: { '/pets': { get: { 'responses': { 200: { content: { 'application/json': { schema: { $ref: '#/components/schemas/Empty', }, }, }, }, }, 'x-amazon-apigateway-integration': { responses: { default: { statusCode: '200', }, }, requestTemplates: { 'application/json': '{"statusCode": 200}', }, passthroughBehavior: 'when_no_match', type: 'mock', }, }, }, }, components: { schemas: { Empty: { title: 'Empty Schema', type: 'object', }, }, }, });

constructor

constructor(scope: Construct, id: string, props?: ApiKeyProps);

property keyArn

readonly keyArn: string;

property keyId

readonly keyId: string;

method fromApiKeyId

static fromApiKeyId: (scope: Construct, id: string, apiKeyId: string) => IApiKey;

• Import an ApiKey by its Id

constructor

constructor(path: string, options?: s3_assets.AssetOptions);

method bind

bind: (scope: Construct) => ApiDefinitionConfig;

method bindAfterCreate

bindAfterCreate: (scope: Construct, restApi: IRestApi) => void;

constructor

constructor(scope: Construct, id: string, props?: ResourceProps);

property authorizationType

readonly authorizationType?: AuthorizationType;

property authorizerId

abstract readonly authorizerId: string;

method isAuthorizer

static isAuthorizer: (x: any) => x is Authorizer;

• Return whether the given object is an Authorizer.

constructor

constructor(props: AwsIntegrationProps);

method bind

bind: (method: Method) => IntegrationConfig;

constructor

constructor(scope: Construct, id: string, props: BasePathMappingProps);

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnAccountProps);

• Create a new AWS::ApiGateway::Account.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrId

readonly attrId: string;

• The ID for the account. For example: abc123 . Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property cloudWatchRoleArn

cloudWatchRoleArn: string;

• The ARN of an Amazon CloudWatch role for the current Account.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html#cfn-apigateway-account-cloudwatchrolearn

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnApiKeyProps);

• Create a new AWS::ApiGateway::ApiKey.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrApiKeyId

readonly attrApiKeyId: string;

• The ID for the API key. For example: abc123 . APIKeyId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property customerId

customerId: string;

• An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid

property description

description: string;

• The description of the ApiKey.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description

property enabled

enabled: any;

• Specifies whether the ApiKey can be used by callers.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled

property generateDistinctId

generateDistinctId: any;

• Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid

property name

name: string;

• A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .

  > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name

property stageKeys

stageKeys: any;

• DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys

property tags

readonly tags: cdk.TagManager;

• The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags

property value

value: string;

• Specifies a value of the API key.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: Construct, id: string, props: CfnApiMappingV2Props);

• Create a new AWS::ApiGatewayV2::ApiMapping.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property apiId

apiId: string;

• AWS::ApiGatewayV2::ApiMapping.ApiId

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apiid

property apiMappingKey

apiMappingKey: string;

• AWS::ApiGatewayV2::ApiMapping.ApiMappingKey

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property domainName

domainName: string;

• AWS::ApiGatewayV2::ApiMapping.DomainName

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-domainname

property stage

stage: string;

• AWS::ApiGatewayV2::ApiMapping.Stage

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-stage

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: Construct, id: string, props?: CfnApiV2Props);

• Create a new AWS::ApiGatewayV2::Api.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property apiKeySelectionExpression

apiKeySelectionExpression: string;

• AWS::ApiGatewayV2::Api.ApiKeySelectionExpression

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression

property basePath

basePath: string;

• AWS::ApiGatewayV2::Api.BasePath

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath

property body

body: any;

• AWS::ApiGatewayV2::Api.Body

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body

property bodyS3Location

bodyS3Location: any;

• AWS::ApiGatewayV2::Api.BodyS3Location

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property corsConfiguration

corsConfiguration: any;

• AWS::ApiGatewayV2::Api.CorsConfiguration

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration

property credentialsArn

credentialsArn: string;

• AWS::ApiGatewayV2::Api.CredentialsArn

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn

property description

description: string;

• AWS::ApiGatewayV2::Api.Description

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description

property disableSchemaValidation

disableSchemaValidation: any;

• AWS::ApiGatewayV2::Api.DisableSchemaValidation

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation

property failOnWarnings

failOnWarnings: any;

• AWS::ApiGatewayV2::Api.FailOnWarnings

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings

property name

name: string;

• AWS::ApiGatewayV2::Api.Name

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name

property protocolType

protocolType: string;

• AWS::ApiGatewayV2::Api.ProtocolType

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype

property routeKey

routeKey: string;

• AWS::ApiGatewayV2::Api.RouteKey

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey

property routeSelectionExpression

routeSelectionExpression: string;

• AWS::ApiGatewayV2::Api.RouteSelectionExpression

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression

property tags

readonly tags: cdk.TagManager;

• AWS::ApiGatewayV2::Api.Tags

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags

property target

target: string;

• AWS::ApiGatewayV2::Api.Target

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target

property version

version: string;

• AWS::ApiGatewayV2::Api.Version

  See Also

  • http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnAuthorizerProps);

• Create a new AWS::ApiGateway::Authorizer.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrAuthorizerId

readonly attrAuthorizerId: string;

• The ID for the authorizer. For example: abc123 . AuthorizerId

property authorizerCredentials

authorizerCredentials: string;

• 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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizercredentials

property authorizerResultTtlInSeconds

authorizerResultTtlInSeconds: number;

• 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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizerresultttlinseconds

property authorizerUri

authorizerUri: string;

• 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 .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri

property authType

authType: string;

• Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authtype

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property identitySource

identitySource: string;

• 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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource