software.amazon.awscdk.services.apigateway

Class Method

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.Method

All Implemented Interfaces:

IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.720Z")
 @Stability(value=Stable)
public class Method
extends Resource

Example:

 Resource books;
 User iamUser;
 Method getBooks = books.addMethod("GET", new HttpIntegration("http://amazon.com"), MethodOptions.builder()
         .authorizationType(AuthorizationType.IAM)
         .build());
 iamUser.attachInlinePolicy(Policy.Builder.create(this, "AllowBooks")
         .statements(List.of(
             PolicyStatement.Builder.create()
                     .actions(List.of("execute-api:Invoke"))
                     .effect(Effect.ALLOW)
                     .resources(List.of(getBooks.getMethodArn()))
                     .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Method.Builder A fluent builder for Method.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	Method(software.constructs.Construct scope, String id, MethodProps props)
protected	Method(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Method(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IRestApi	getApi() The API Gateway RestApi associated with this method.
String	getHttpMethod()
String	getMethodArn() Returns an execute-api ARN for this method:.
String	getMethodId()
IResource	getResource()
String	getTestMethodArn() Returns an execute-api ARN for this method's "test-invoke-stage" stage.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Method

protected Method(software.amazon.jsii.JsiiObjectRef objRef)

Method

protected Method(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method

@Stability(value=Stable)
public Method(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id,
                                       @NotNull
                                       MethodProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getApi

@Stability(value=Stable)
 @NotNull
public IRestApi getApi()

The API Gateway RestApi associated with this method.

getHttpMethod

@Stability(value=Stable)
 @NotNull
public String getHttpMethod()

getMethodArn

@Stability(value=Stable)
 @NotNull
public String getMethodArn()

Returns an execute-api ARN for this method:.

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'.

getMethodId

@Stability(value=Stable)
 @NotNull
public String getMethodId()

getResource

@Stability(value=Stable)
 @NotNull
public IResource getResource()

getTestMethodArn

@Stability(value=Stable)
 @NotNull
public String getTestMethodArn()

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.