Method class
Provides a HTTP Method for an API Gateway Resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const myDemoAPI = new aws.apigateway.RestApi("MyDemoAPI", {
name: "MyDemoAPI",
description: "This is my API for demonstration purposes",
});
const myDemoResource = new aws.apigateway.Resource("MyDemoResource", {
restApi: myDemoAPI.id,
parentId: myDemoAPI.rootResourceId,
pathPart: "mydemoresource",
});
const myDemoMethod = new aws.apigateway.Method("MyDemoMethod", {
restApi: myDemoAPI.id,
resourceId: myDemoResource.id,
httpMethod: "GET",
authorization: "NONE",
});
import pulumi
import pulumi_aws as aws
my_demo_api = aws.apigateway.RestApi("MyDemoAPI",
name="MyDemoAPI",
description="This is my API for demonstration purposes")
my_demo_resource = aws.apigateway.Resource("MyDemoResource",
rest_api=my_demo_api.id,
parent_id=my_demo_api.root_resource_id,
path_part="mydemoresource")
my_demo_method = aws.apigateway.Method("MyDemoMethod",
rest_api=my_demo_api.id,
resource_id=my_demo_resource.id,
http_method="GET",
authorization="NONE")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var myDemoAPI = new Aws.ApiGateway.RestApi("MyDemoAPI", new()
{
Name = "MyDemoAPI",
Description = "This is my API for demonstration purposes",
});
var myDemoResource = new Aws.ApiGateway.Resource("MyDemoResource", new()
{
RestApi = myDemoAPI.Id,
ParentId = myDemoAPI.RootResourceId,
PathPart = "mydemoresource",
});
var myDemoMethod = new Aws.ApiGateway.Method("MyDemoMethod", new()
{
RestApi = myDemoAPI.Id,
ResourceId = myDemoResource.Id,
HttpMethod = "GET",
Authorization = "NONE",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
myDemoAPI, err := apigateway.NewRestApi(ctx, "MyDemoAPI", &apigateway.RestApiArgs{
Name: pulumi.String("MyDemoAPI"),
Description: pulumi.String("This is my API for demonstration purposes"),
})
if err != nil {
return err
}
myDemoResource, err := apigateway.NewResource(ctx, "MyDemoResource", &apigateway.ResourceArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
ParentId: myDemoAPI.RootResourceId,
PathPart: pulumi.String("mydemoresource"),
})
if err != nil {
return err
}
_, err = apigateway.NewMethod(ctx, "MyDemoMethod", &apigateway.MethodArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
ResourceId: myDemoResource.ID().ToIDOutput().ToStringOutput(),
HttpMethod: pulumi.String("GET"),
Authorization: pulumi.String("NONE"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigateway_restapi" "MyDemoAPI" {
name = "MyDemoAPI"
description = "This is my API for demonstration purposes"
}
resource "aws_apigateway_resource" "MyDemoResource" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
parent_id = aws_apigateway_restapi.MyDemoAPI.root_resource_id
path_part = "mydemoresource"
}
resource "aws_apigateway_method" "MyDemoMethod" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
resource_id = aws_apigateway_resource.MyDemoResource.id
http_method = "GET"
authorization = "NONE"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.RestApi;
import com.pulumi.aws.apigateway.RestApiArgs;
import com.pulumi.aws.apigateway.Resource;
import com.pulumi.aws.apigateway.ResourceArgs;
import com.pulumi.aws.apigateway.Method;
import com.pulumi.aws.apigateway.MethodArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myDemoAPI = new RestApi("myDemoAPI", RestApiArgs.builder()
.name("MyDemoAPI")
.description("This is my API for demonstration purposes")
.build());
var myDemoResource = new Resource("myDemoResource", ResourceArgs.builder()
.restApi(myDemoAPI.id())
.parentId(myDemoAPI.rootResourceId())
.pathPart("mydemoresource")
.build());
var myDemoMethod = new Method("myDemoMethod", MethodArgs.builder()
.restApi(myDemoAPI.id())
.resourceId(myDemoResource.id())
.httpMethod("GET")
.authorization("NONE")
.build());
}
}
resources:
myDemoAPI:
type: aws:apigateway:RestApi
name: MyDemoAPI
properties:
name: MyDemoAPI
description: This is my API for demonstration purposes
myDemoResource:
type: aws:apigateway:Resource
name: MyDemoResource
properties:
restApi: ${myDemoAPI.id}
parentId: ${myDemoAPI.rootResourceId}
pathPart: mydemoresource
myDemoMethod:
type: aws:apigateway:Method
name: MyDemoMethod
properties:
restApi: ${myDemoAPI.id}
resourceId: ${myDemoResource.id}
httpMethod: GET
authorization: NONE
Usage with Cognito User Pool Authorizer
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const config = new pulumi.Config();
const cognitoUserPoolName = config.requireObject<any>("cognitoUserPoolName");
const _this = aws.cognito.getUserPools({
name: cognitoUserPoolName,
});
const thisRestApi = new aws.apigateway.RestApi("this", {name: "with-authorizer"});
const thisResource = new aws.apigateway.Resource("this", {
restApi: thisRestApi.id,
parentId: thisRestApi.rootResourceId,
pathPart: "{proxy+}",
});
const thisAuthorizer = new aws.apigateway.Authorizer("this", {
name: "CognitoUserPoolAuthorizer",
type: "COGNITO_USER_POOLS",
restApi: thisRestApi.id,
providerArns: _this.then(_this => _this.arns),
});
const any = new aws.apigateway.Method("any", {
restApi: thisRestApi.id,
resourceId: thisResource.id,
httpMethod: "ANY",
authorization: "COGNITO_USER_POOLS",
authorizerId: thisAuthorizer.id,
requestParameters: {
"method.request.path.proxy": true,
},
});
import pulumi
import pulumi_aws as aws
config = pulumi.Config()
cognito_user_pool_name = config.require_object("cognitoUserPoolName")
this = aws.cognito.get_user_pools(name=cognito_user_pool_name)
this_rest_api = aws.apigateway.RestApi("this", name="with-authorizer")
this_resource = aws.apigateway.Resource("this",
rest_api=this_rest_api.id,
parent_id=this_rest_api.root_resource_id,
path_part="{proxy+}")
this_authorizer = aws.apigateway.Authorizer("this",
name="CognitoUserPoolAuthorizer",
type="COGNITO_USER_POOLS",
rest_api=this_rest_api.id,
provider_arns=this.arns)
any = aws.apigateway.Method("any",
rest_api=this_rest_api.id,
resource_id=this_resource.id,
http_method="ANY",
authorization="COGNITO_USER_POOLS",
authorizer_id=this_authorizer.id,
request_parameters={
"method.request.path.proxy": True,
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var cognitoUserPoolName = config.RequireObject<dynamic>("cognitoUserPoolName");
var @this = Aws.Cognito.GetUserPools.Invoke(new()
{
Name = cognitoUserPoolName,
});
var thisRestApi = new Aws.ApiGateway.RestApi("this", new()
{
Name = "with-authorizer",
});
var thisResource = new Aws.ApiGateway.Resource("this", new()
{
RestApi = thisRestApi.Id,
ParentId = thisRestApi.RootResourceId,
PathPart = "{proxy+}",
});
var thisAuthorizer = new Aws.ApiGateway.Authorizer("this", new()
{
Name = "CognitoUserPoolAuthorizer",
Type = "COGNITO_USER_POOLS",
RestApi = thisRestApi.Id,
ProviderArns = @this.Apply(@this => @this.Apply(getUserPoolsResult => getUserPoolsResult.Arns)),
});
var any = new Aws.ApiGateway.Method("any", new()
{
RestApi = thisRestApi.Id,
ResourceId = thisResource.Id,
HttpMethod = "ANY",
Authorization = "COGNITO_USER_POOLS",
AuthorizerId = thisAuthorizer.Id,
RequestParameters =
{
{ "method.request.path.proxy", true },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigateway"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
var cognitoUserPoolName interface{}
cfg.RequireObject("cognitoUserPoolName", &cognitoUserPoolName)
this, err := cognito.GetUserPools(ctx, &cognito.GetUserPoolsArgs{
Name: cognitoUserPoolName,
}, nil)
if err != nil {
return err
}
thisRestApi, err := apigateway.NewRestApi(ctx, "this", &apigateway.RestApiArgs{
Name: pulumi.String("with-authorizer"),
})
if err != nil {
return err
}
thisResource, err := apigateway.NewResource(ctx, "this", &apigateway.ResourceArgs{
RestApi: thisRestApi.ID().ToIDOutput().ToStringOutput(),
ParentId: thisRestApi.RootResourceId,
PathPart: pulumi.String("{proxy+}"),
})
if err != nil {
return err
}
thisAuthorizer, err := apigateway.NewAuthorizer(ctx, "this", &apigateway.AuthorizerArgs{
Name: pulumi.String("CognitoUserPoolAuthorizer"),
Type: pulumi.String("COGNITO_USER_POOLS"),
RestApi: thisRestApi.ID().ToIDOutput().ToStringOutput(),
ProviderArns: toPulumiStringArray(this.Arns),
})
if err != nil {
return err
}
_, err = apigateway.NewMethod(ctx, "any", &apigateway.MethodArgs{
RestApi: thisRestApi.ID().ToIDOutput().ToStringOutput(),
ResourceId: thisResource.ID().ToIDOutput().ToStringOutput(),
HttpMethod: pulumi.String("ANY"),
Authorization: pulumi.String("COGNITO_USER_POOLS"),
AuthorizerId: thisAuthorizer.ID().ToIDOutput().ToStringOutput(),
RequestParameters: pulumi.BoolMap{
"method.request.path.proxy": pulumi.Bool(true),
},
})
if err != nil {
return err
}
return nil
})
}
func toPulumiStringArray(arr []string) pulumi.StringArray {
var pulumiArr pulumi.StringArray
for _, v := range arr {
pulumiArr = append(pulumiArr, pulumi.String(v))
}
return pulumiArr
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_cognito_getuserpools" "this" {
name = var.cognitoUserPoolName
}
resource "aws_apigateway_restapi" "this" {
name = "with-authorizer"
}
resource "aws_apigateway_resource" "this" {
rest_api = aws_apigateway_restapi.this.id
parent_id = aws_apigateway_restapi.this.root_resource_id
path_part = "{proxy+}"
}
resource "aws_apigateway_authorizer" "this" {
name = "CognitoUserPoolAuthorizer"
type = "COGNITO_USER_POOLS"
rest_api = aws_apigateway_restapi.this.id
provider_arns = data.aws_cognito_getuserpools.this.arns
}
resource "aws_apigateway_method" "any" {
rest_api = aws_apigateway_restapi.this.id
resource_id = aws_apigateway_resource.this.id
http_method = "ANY"
authorization = "COGNITO_USER_POOLS"
authorizer_id = aws_apigateway_authorizer.this.id
request_parameters = {
"method.request.path.proxy" = true
}
}
variable "cognitoUserPoolName" {
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cognito.CognitoFunctions;
import com.pulumi.aws.cognito.inputs.GetUserPoolsArgs;
import com.pulumi.aws.apigateway.RestApi;
import com.pulumi.aws.apigateway.RestApiArgs;
import com.pulumi.aws.apigateway.Resource;
import com.pulumi.aws.apigateway.ResourceArgs;
import com.pulumi.aws.apigateway.Authorizer;
import com.pulumi.aws.apigateway.AuthorizerArgs;
import com.pulumi.aws.apigateway.Method;
import com.pulumi.aws.apigateway.MethodArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var cognitoUserPoolName = config.require("cognitoUserPoolName");
final var this = CognitoFunctions.getUserPools(GetUserPoolsArgs.builder()
.name(cognitoUserPoolName)
.build());
var thisRestApi = new RestApi("thisRestApi", RestApiArgs.builder()
.name("with-authorizer")
.build());
var thisResource = new Resource("thisResource", ResourceArgs.builder()
.restApi(thisRestApi.id())
.parentId(thisRestApi.rootResourceId())
.pathPart("{proxy+}")
.build());
var thisAuthorizer = new Authorizer("thisAuthorizer", AuthorizerArgs.builder()
.name("CognitoUserPoolAuthorizer")
.type("COGNITO_USER_POOLS")
.restApi(thisRestApi.id())
.providerArns(this_.arns())
.build());
var any = new Method("any", MethodArgs.builder()
.restApi(thisRestApi.id())
.resourceId(thisResource.id())
.httpMethod("ANY")
.authorization("COGNITO_USER_POOLS")
.authorizerId(thisAuthorizer.id())
.requestParameters(Map.of("method.request.path.proxy", true))
.build());
}
}
configuration:
cognitoUserPoolName:
type: object
resources:
thisRestApi:
type: aws:apigateway:RestApi
name: this
properties:
name: with-authorizer
thisResource:
type: aws:apigateway:Resource
name: this
properties:
restApi: ${thisRestApi.id}
parentId: ${thisRestApi.rootResourceId}
pathPart: '{proxy+}'
thisAuthorizer:
type: aws:apigateway:Authorizer
name: this
properties:
name: CognitoUserPoolAuthorizer
type: COGNITO_USER_POOLS
restApi: ${thisRestApi.id}
providerArns: ${this.arns}
any:
type: aws:apigateway:Method
properties:
restApi: ${thisRestApi.id}
resourceId: ${thisResource.id}
httpMethod: ANY
authorization: COGNITO_USER_POOLS
authorizerId: ${thisAuthorizer.id}
requestParameters:
method.request.path.proxy: true
variables:
this:
fn::invoke:
function: aws:cognito:getUserPools
arguments:
name: ${cognitoUserPoolName}
Import
Identity Schema
Required
restApiId(String) ID of the associated REST API.resourceId(String) API resource ID.httpMethod(String) HTTP Method.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import aws.apigateway.Method using REST-API-ID/RESOURCE-ID/HTTP-METHOD. For example:
$ pulumi import aws:apigateway/method:Method example 12345abcde/67890fghij/GET
Constructors
- Method(String name, {MethodArgs? args, CustomResourceOptions? options})
-
Creates a new Method.
nameThe Pulumi resource name.argsArguments used to configure this Method. The set of arguments for Method.optionsResource options controlling this resource's behavior. - Method.reference(String urn)
- Creates a typed reference to an existing Method resource.
Properties
-
apiKeyRequired
↔ Output<
bool?> -
Specify if the method requires an API key
latefinal
-
Type of authorization used for the method (
NONE,CUSTOM,AWS_IAM,COGNITO_USER_POOLS)latefinal -
Authorization scopes used when the authorization is
COGNITO_USER_POOLSlatefinal -
Authorizer id to be used when the authorization is
CUSTOMorCOGNITO_USER_POOLSlatefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
httpMethod
↔ Output<
String> -
HTTP Method (
GET,POST,PUT,DELETE,HEAD,OPTIONS,ANY)latefinal -
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
operationName
↔ Output<
String?> -
Function name that will be given to the method when generating an SDK through API Gateway. If omitted, API Gateway will generate a function name based on the resource path and HTTP verb.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
requestModels
↔ Output<
Map< String, String> ?> -
Map of the API models used for the request's content type where key is the content type (e.g.,
application/json) and value is eitherError,Empty(built-in models) oraws.apigateway.Model'sname.latefinal -
requestParameters
↔ Output<
Map< String, bool> ?> -
Map of request parameters (from the path, query string and headers) that should be passed to the integration. The boolean value indicates whether the parameter is required (
true) or optional (false). For example:requestParameters = {"method.request.header.X-Some-Header" = true "method.request.querystring.some-query-param" = true}would define that the headerX-Some-Headerand the query stringsome-query-parammust be provided in the request.latefinal -
requestValidatorId
↔ Output<
String?> -
ID of a
aws.apigateway.RequestValidatorlatefinal -
resourceId
↔ Output<
String> -
API resource ID
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
restApi
↔ Output<
String> -
ID of the associated REST API
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited