class CfnMethod (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.APIGateway.CfnMethod`
Java	`software.amazon.awscdk.services.apigateway.CfnMethod`
Python	`aws_cdk.aws_apigateway.CfnMethod`
TypeScript	`@aws-cdk/aws-apigateway` » `CfnMethod`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::ApiGateway::Method.

The AWS::ApiGateway::Method resource creates API Gateway methods that define the parameters and body that clients must send in their requests.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigateway from '@aws-cdk/aws-apigateway';
const cfnMethod = new apigateway.CfnMethod(this, 'MyCfnMethod', {
  httpMethod: 'httpMethod',
  resourceId: 'resourceId',
  restApiId: 'restApiId',

  // the properties below are optional
  apiKeyRequired: false,
  authorizationScopes: ['authorizationScopes'],
  authorizationType: 'authorizationType',
  authorizerId: 'authorizerId',
  integration: {
    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',
    }],
    passthroughBehavior: 'passthroughBehavior',
    requestParameters: {
      requestParametersKey: 'requestParameters',
    },
    requestTemplates: {
      requestTemplatesKey: 'requestTemplates',
    },
    timeoutInMillis: 123,
    type: 'type',
    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',
});

Initializer

new CfnMethod(scope: Construct, id: string, props: CfnMethodProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnMethodProps — - resource properties.

Create a new AWS::ApiGateway::Method.

Construct Props

Name	Type	Description
httpMethod	`string`	The method's HTTP verb.
resourceId	`string`	The Resource identifier for the MethodResponse resource.
restApiId	`string`	The string identifier of the associated RestApi.
apiKeyRequired?	`boolean \|` `IResolvable`	A boolean flag specifying whether a valid ApiKey is required to invoke this method.
authorizationScopes?	`string[]`	A list of authorization scopes configured on the method.
authorizationType?	`string`	The method's authorization type.
authorizerId?	`string`	The identifier of an authorizer to use on this method.
integration?	`IResolvable` `\|` `IntegrationProperty`	Represents an `HTTP` , `HTTP_PROXY` , `AWS` , `AWS_PROXY` , or Mock integration.
methodResponses?	`IResolvable` `\|` `IResolvable` `\|` `MethodResponseProperty[]`	Gets a method response associated with a given HTTP status code.
operationName?	`string`	A human-friendly operation identifier for the method.
requestModels?	`IResolvable` `\| { [string]: string }`	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?	`IResolvable` `\| { [string]: boolean \|` `IResolvable` `}`	A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
requestValidatorId?	`string`	The identifier of a RequestValidator for request validation.

httpMethod

Type: string

The method's HTTP verb.

resourceId

Type: string

The Resource identifier for the MethodResponse resource.

restApiId

Type: string

The string identifier of the associated RestApi.

apiKeyRequired?

Type: boolean | IResolvable (optional)

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

authorizationScopes?

Type: string[] (optional)

A list of authorization scopes configured on the method.

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?

Type: string (optional)

The method's authorization type.

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?

Type: string (optional)

The identifier of an authorizer to use on this method.

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

integration?

Type: IResolvable | IntegrationProperty (optional)

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

methodResponses?

Type: IResolvable | IResolvable | MethodResponseProperty[] (optional)

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

operationName?

Type: string (optional)

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?

Type: IResolvable | { [string]: string } (optional)

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?

Type: IResolvable | { [string]: boolean | IResolvable } (optional)

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

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?

Type: string (optional)

The identifier of a RequestValidator for request validation.

Properties

Name	Type	Description
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
httpMethod	`string`	The method's HTTP verb.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
resourceId	`string`	The Resource identifier for the MethodResponse resource.
restApiId	`string`	The string identifier of the associated RestApi.
stack	`Stack`	The stack in which this element is defined.
apiKeyRequired?	`boolean \|` `IResolvable`	A boolean flag specifying whether a valid ApiKey is required to invoke this method.
authorizationScopes?	`string[]`	A list of authorization scopes configured on the method.
authorizationType?	`string`	The method's authorization type.
authorizerId?	`string`	The identifier of an authorizer to use on this method.
integration?	`IResolvable` `\|` `IntegrationProperty`	Represents an `HTTP` , `HTTP_PROXY` , `AWS` , `AWS_PROXY` , or Mock integration.
methodResponses?	`IResolvable` `\|` `IResolvable` `\|` `MethodResponseProperty[]`	Gets a method response associated with a given HTTP status code.
operationName?	`string`	A human-friendly operation identifier for the method.
requestModels?	`IResolvable` `\| { [string]: string }`	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?	`IResolvable` `\| { [string]: boolean \|` `IResolvable` `}`	A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
requestValidatorId?	`string`	The identifier of a RequestValidator for request validation.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

httpMethod

Type: string

The method's HTTP verb.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

resourceId

Type: string

The Resource identifier for the MethodResponse resource.

restApiId

Type: string

The string identifier of the associated RestApi.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

apiKeyRequired?

Type: boolean | IResolvable (optional)

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

authorizationScopes?

Type: string[] (optional)

A list of authorization scopes configured on the method.

authorizationType?

Type: string (optional)

The method's authorization type.

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?

Type: string (optional)

The identifier of an authorizer to use on this method.

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

integration?

Type: IResolvable | IntegrationProperty (optional)

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

methodResponses?

Type: IResolvable | IResolvable | MethodResponseProperty[] (optional)

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

operationName?

Type: string (optional)

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?

Type: IResolvable | { [string]: string } (optional)

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?

Type: IResolvable | { [string]: boolean | IResolvable } (optional)

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

requestValidatorId?

Type: string (optional)

The identifier of a RequestValidator for request validation.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }