Class Method

Inheritance
System.Object
Construct
Resource
Method
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public class Method : Resource, IResource, IConstruct, IDependable
Syntax (vb)
Public Class Method
    Inherits Resource
    Implements IResource, IConstruct, IDependable
Remarks

Stability: Stable

Synopsis

Constructors

Method(Construct, String, IMethodProps)
Method(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
Method(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

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.

Constructors

Method(Construct, String, IMethodProps)

public Method(Construct scope, string id, IMethodProps props)
Parameters
scope Construct
id System.String
props IMethodProps
Remarks

Stability: Stable

Method(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Method(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

Method(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Method(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

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

RestApi

Remarks

Stability: Stable

TestMethodArn

Returns an execute-api ARN for this method's "test-invoke-stage" stage.

public virtual string TestMethodArn { get; }
Property Value

System.String

Remarks

This stage is used by the AWS Console UI when testing the method.

Stability: Stable

Implements