Method

class aws_cdk.aws_apigateway.Method(scope, id, *, http_method, resource, integration=None, options=None)

Bases: aws_cdk.core.Resource

__init__(scope, id, *, http_method, resource, integration=None, options=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • props

  • http_method (str) – The HTTP method (“GET”, “POST”, “PUT”, …) that clients use to call this method.

  • resource (IResource) – The resource this method is associated with. For root resource methods, specify the RestApi object.

  • integration (Optional[Integration]) – The backend system that the method calls when it receives a request. Default: - a new MockIntegration.

  • options (Optional[MethodOptions]) – Method options. Default: - No options.

Return type

None

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

http_method
Return type

str

method_arn

.

arn:aws:execute-api:{region}:{account}:{restApiId}/{stage}/{method}/{path}

NOTE: {stage} will refer to the restApi.deploymentStage, which will automatically set if auto-deploy is enabled.

attribute: :attribute:: true

Type

Returns an execute-api ARN for this method

Return type

str

method_id

attribute: :attribute:: true

Return type

str

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

resource
Return type

IResource

rest_api
Return type

RestApi

stack

The stack in which this resource is defined.

Return type

Stack

test_method_arn

Returns an execute-api ARN for this method’s “test-invoke-stage” stage. This stage is used by the AWS Console UI when testing the method.

Return type

str

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool