Class Method

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

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

Api

The API Gateway RestApi associated with this method.
HttpMethod
MethodArn

Returns an execute-api ARN for this method:.
MethodId
Resource
RestApi

The RestApi associated with this Method.
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

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

Api

The API Gateway RestApi associated with this method.

public virtual IRestApi Api { get; }
Property Value

IRestApi

HttpMethod

public virtual string HttpMethod { get; }
Property Value

System.String

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, or can be explicitly assigned. When not configured, {stage} will be set to '*', as a shorthand for 'all stages'.

Attribute: true

MethodId

public virtual string MethodId { get; }
Property Value

System.String

Remarks

Attribute: true

Resource

public virtual IResource Resource { get; }
Property Value

IResource

RestApi

The RestApi associated with this Method.

public virtual RestApi RestApi { get; }
Property Value

RestApi

Remarks

Stability: Deprecated

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.

Implements

Constructs.IConstruct