aws-cdk-lib.aws_apigateway.CfnMethodProps

CfnMethodProps Struct

Properties for defining a CfnMethod.

CfnMethodProps

used as props by

• CfnMethod

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const cfnMethodProps: apigateway.CfnMethodProps = {
  httpMethod: 'httpMethod',
  resourceId: 'resourceId',
  restApiId: 'restApiId',

  // the properties below are optional
  apiKeyRequired: false,
  authorizationScopes: ['authorizationScopes'],
  authorizationType: 'authorizationType',
  authorizerId: 'authorizerId',
  integration: {
    type: 'type',

    // the properties below are optional
    cacheKeyParameters: ['cacheKeyParameters'],
    cacheNamespace: 'cacheNamespace',
    connectionId: 'connectionId',
    connectionType: 'connectionType',
    contentHandling: 'contentHandling',
    credentials: 'credentials',
    integrationHttpMethod: 'integrationHttpMethod',
    integrationResponses: [{
      statusCode: 'statusCode',

      // the properties below are optional
      contentHandling: 'contentHandling',
      responseParameters: {
        responseParametersKey: 'responseParameters',
      },
      responseTemplates: {
        responseTemplatesKey: 'responseTemplates',
      },
      selectionPattern: 'selectionPattern',
    }],
    integrationTarget: 'integrationTarget',
    passthroughBehavior: 'passthroughBehavior',
    requestParameters: {
      requestParametersKey: 'requestParameters',
    },
    requestTemplates: {
      requestTemplatesKey: 'requestTemplates',
    },
    responseTransferMode: 'responseTransferMode',
    timeoutInMillis: 123,
    uri: 'uri',
  },
  methodResponses: [{
    statusCode: 'statusCode',

    // the properties below are optional
    responseModels: {
      responseModelsKey: 'responseModels',
    },
    responseParameters: {
      responseParametersKey: false,
    },
  }],
  operationName: 'operationName',
  requestModels: {
    requestModelsKey: 'requestModels',
  },
  requestParameters: {
    requestParametersKey: false,
  },
  requestValidatorId: 'requestValidatorId',
};

Properties

apiKeyRequired?optionalboolean | IResolvableapi_key_required?optionaltyping.Union[bool, IResolvable]apiKeyRequired?optionalBooleanApiKeyRequired?optionalboolApiKeyRequired?optionalinterface{}#

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

authorizationScopes?optionalstring[]authorization_scopes?optionaltyping.List[str]authorizationScopes?optionalList<String>AuthorizationScopes?optionalstring[]AuthorizationScopes?optional*[]*string#

A list of authorization scopes configured on the method.

notes

The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

authorizationType?optionalstringauthorization_type?optionalstrauthorizationType?optionalStringAuthorizationType?optionalstringAuthorizationType?optional*string#

The method's authorization type.

notes

This parameter is required. For valid values, see Method in the API Gateway API Reference .

If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.

authorizerId?optionalstring | IAuthorizerRefauthorizer_id?optionaltyping.Union[str, IAuthorizerRef]authorizerId?optionalStringAuthorizerId?optionalstringAuthorizerId?optionalinterface{}#

The identifier of an authorizer to use on this method.

The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .

httpMethodstringhttp_methodstrhttpMethodStringHttpMethodstringHttpMethod*stringrequired#

The method's HTTP verb.

integration?optionalIResolvable | CfnMethod.IntegrationPropertyintegration?optionaltyping.Union[IResolvable, IntegrationProperty]integration?optionalIResolvableIntegration?optionalIResolvableIntegration?optionalinterface{}#

Represents an `HTTP` , `HTTP_PROXY` , `AWS` , `AWS_PROXY` , or Mock integration.

methodResponses?optionalIResolvable | IResolvable | CfnMethod.MethodResponseProperty[]method_responses?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MethodResponseProperty]]]methodResponses?optionalIResolvableMethodResponses?optionalIResolvableMethodResponses?optionalinterface{}#

Gets a method response associated with a given HTTP status code.

operationName?optionalstringoperation_name?optionalstroperationName?optionalStringOperationName?optionalstringOperationName?optional*string#

A human-friendly operation identifier for the method.

For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

requestModels?optionalIResolvable | { [key: string]: string }request_models?optionaltyping.Union[IResolvable, typing.Mapping[str, str]]requestModels?optionalIResolvableRequestModels?optionalIResolvableRequestModels?optionalinterface{}#

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

requestParameters?optionalIResolvable | { [key: string]: boolean | IResolvable }request_parameters?optionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[bool, IResolvable]]]requestParameters?optionalIResolvableRequestParameters?optionalIResolvableRequestParameters?optionalinterface{}#

A key-value map defining required or optional method request parameters that can be accepted by API Gateway.

notes

A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true ) or optional ( false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

requestValidatorId?optionalstring | IRequestValidatorRefrequest_validator_id?optionaltyping.Union[str, IRequestValidatorRef]requestValidatorId?optionalStringRequestValidatorId?optionalstringRequestValidatorId?optionalinterface{}#

The identifier of a RequestValidator for request validation.

resourceIdstring | IResourceRefresource_idtyping.Union[str, IResourceRef]resourceIdStringResourceIdstringResourceIdinterface{}required#

The Resource identifier for the MethodResponse resource.

restApiIdstring | IRestApiRefrest_api_idtyping.Union[str, IRestApiRef]restApiIdStringRestApiIdstringRestApiIdinterface{}required#

The string identifier of the associated RestApi.