Class Method

Inheritance

System.Object

Method

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.AWS.APIGateway.dll

Syntax (csharp)

public class Method : Resource

Syntax (vb)

Public Class Method
    Inherits Resource

Remarks

stability: Stable

Synopsis

Constructors

Method(Construct, String, IMethodProps)

Properties

HttpMethod
MethodArn	Returns an execute-api ARN for this method:.
MethodId
Resource
RestApi
TestMethodArn	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.

Constructors

Method(Construct, String, IMethodProps)

public Method(Construct scope, string id, IMethodProps props)

Parameters

scope Construct

id System.String

props IMethodProps

Remarks

stability: Stable

Properties

HttpMethod

public virtual string HttpMethod { get; }

Property Value

System.String

Remarks

stability: Stable

MethodArn

Returns an execute-api ARN for this method:.

public virtual string MethodArn { get; }

Property Value

System.String

Remarks

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. stability: Stable attribute: true

MethodId

public virtual string MethodId { get; }

Property Value

System.String

Remarks

stability: Stable attribute: true

Resource

public virtual IResource Resource { get; }

Property Value

IResource

Remarks

stability: Stable

RestApi

public virtual RestApi RestApi { get; }

Property Value

APIGateway.RestApi

Remarks

stability: Stable

TestMethodArn

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.

public virtual string TestMethodArn { get; }

Property Value

System.String

Remarks

stability: Stable