github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/apigateway/method.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package apigateway

import (
	"context"
	"reflect"

	"errors"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Provides a HTTP Method for an API Gateway Resource.
//
// ## Example Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/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(),
//				ParentId: myDemoAPI.RootResourceId,
//				PathPart: pulumi.String("mydemoresource"),
//			})
//			if err != nil {
//				return err
//			}
//			_, err = apigateway.NewMethod(ctx, "MyDemoMethod", &apigateway.MethodArgs{
//				RestApi:       myDemoAPI.ID(),
//				ResourceId:    myDemoResource.ID(),
//				HttpMethod:    pulumi.String("GET"),
//				Authorization: pulumi.String("NONE"),
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ## Usage with Cognito User Pool Authorizer
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
//	"github.com/pulumi/pulumi-aws/sdk/v6/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, "")
//			cognitoUserPoolName := cfg.RequireObject("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(),
//				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(),
//				ProviderArns: interface{}(this.Arns),
//			})
//			if err != nil {
//				return err
//			}
//			_, err = apigateway.NewMethod(ctx, "any", &apigateway.MethodArgs{
//				RestApi:       thisRestApi.ID(),
//				ResourceId:    thisResource.ID(),
//				HttpMethod:    pulumi.String("ANY"),
//				Authorization: pulumi.String("COGNITO_USER_POOLS"),
//				AuthorizerId:  thisAuthorizer.ID(),
//				RequestParameters: pulumi.BoolMap{
//					"method.request.path.proxy": pulumi.Bool(true),
//				},
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ## Import
//
// Using `pulumi import`, import `aws_api_gateway_method` using `REST-API-ID/RESOURCE-ID/HTTP-METHOD`. For example:
//
// ```sh
// $ pulumi import aws:apigateway/method:Method example 12345abcde/67890fghij/GET
// ```
type Method struct {
	pulumi.CustomResourceState

	// Specify if the method requires an API key
	ApiKeyRequired pulumi.BoolPtrOutput `pulumi:"apiKeyRequired"`
	// Type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
	Authorization pulumi.StringOutput `pulumi:"authorization"`
	// Authorization scopes used when the authorization is `COGNITO_USER_POOLS`
	AuthorizationScopes pulumi.StringArrayOutput `pulumi:"authorizationScopes"`
	// Authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
	AuthorizerId pulumi.StringPtrOutput `pulumi:"authorizerId"`
	// HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringOutput `pulumi:"httpMethod"`
	// 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.
	OperationName pulumi.StringPtrOutput `pulumi:"operationName"`
	// 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 either `Error`, `Empty` (built-in models) or `apigateway.Model`'s `name`.
	RequestModels pulumi.StringMapOutput `pulumi:"requestModels"`
	// 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 header `X-Some-Header` and the query string `some-query-param` must be provided in the request.
	RequestParameters pulumi.BoolMapOutput `pulumi:"requestParameters"`
	// ID of a `apigateway.RequestValidator`
	RequestValidatorId pulumi.StringPtrOutput `pulumi:"requestValidatorId"`
	// API resource ID
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// ID of the associated REST API
	RestApi pulumi.StringOutput `pulumi:"restApi"`
}

// NewMethod registers a new resource with the given unique name, arguments, and options.
func NewMethod(ctx *pulumi.Context,
	name string, args *MethodArgs, opts ...pulumi.ResourceOption) (*Method, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.Authorization == nil {
		return nil, errors.New("invalid value for required argument 'Authorization'")
	}
	if args.HttpMethod == nil {
		return nil, errors.New("invalid value for required argument 'HttpMethod'")
	}
	if args.ResourceId == nil {
		return nil, errors.New("invalid value for required argument 'ResourceId'")
	}
	if args.RestApi == nil {
		return nil, errors.New("invalid value for required argument 'RestApi'")
	}
	opts = internal.PkgResourceDefaultOpts(opts)
	var resource Method
	err := ctx.RegisterResource("aws:apigateway/method:Method", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetMethod gets an existing Method resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetMethod(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MethodState, opts ...pulumi.ResourceOption) (*Method, error) {
	var resource Method
	err := ctx.ReadResource("aws:apigateway/method:Method", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering Method resources.
type methodState struct {
	// Specify if the method requires an API key
	ApiKeyRequired *bool `pulumi:"apiKeyRequired"`
	// Type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
	Authorization *string `pulumi:"authorization"`
	// Authorization scopes used when the authorization is `COGNITO_USER_POOLS`
	AuthorizationScopes []string `pulumi:"authorizationScopes"`
	// Authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
	AuthorizerId *string `pulumi:"authorizerId"`
	// HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod *string `pulumi:"httpMethod"`
	// 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.
	OperationName *string `pulumi:"operationName"`
	// 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 either `Error`, `Empty` (built-in models) or `apigateway.Model`'s `name`.
	RequestModels map[string]string `pulumi:"requestModels"`
	// 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 header `X-Some-Header` and the query string `some-query-param` must be provided in the request.
	RequestParameters map[string]bool `pulumi:"requestParameters"`
	// ID of a `apigateway.RequestValidator`
	RequestValidatorId *string `pulumi:"requestValidatorId"`
	// API resource ID
	ResourceId *string `pulumi:"resourceId"`
	// ID of the associated REST API
	RestApi interface{} `pulumi:"restApi"`
}

type MethodState struct {
	// Specify if the method requires an API key
	ApiKeyRequired pulumi.BoolPtrInput
	// Type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
	Authorization pulumi.StringPtrInput
	// Authorization scopes used when the authorization is `COGNITO_USER_POOLS`
	AuthorizationScopes pulumi.StringArrayInput
	// Authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
	AuthorizerId pulumi.StringPtrInput
	// HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringPtrInput
	// 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.
	OperationName pulumi.StringPtrInput
	// 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 either `Error`, `Empty` (built-in models) or `apigateway.Model`'s `name`.
	RequestModels pulumi.StringMapInput
	// 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 header `X-Some-Header` and the query string `some-query-param` must be provided in the request.
	RequestParameters pulumi.BoolMapInput
	// ID of a `apigateway.RequestValidator`
	RequestValidatorId pulumi.StringPtrInput
	// API resource ID
	ResourceId pulumi.StringPtrInput
	// ID of the associated REST API
	RestApi pulumi.Input
}

func (MethodState) ElementType() reflect.Type {
	return reflect.TypeOf((*methodState)(nil)).Elem()
}

type methodArgs struct {
	// Specify if the method requires an API key
	ApiKeyRequired *bool `pulumi:"apiKeyRequired"`
	// Type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
	Authorization string `pulumi:"authorization"`
	// Authorization scopes used when the authorization is `COGNITO_USER_POOLS`
	AuthorizationScopes []string `pulumi:"authorizationScopes"`
	// Authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
	AuthorizerId *string `pulumi:"authorizerId"`
	// HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod string `pulumi:"httpMethod"`
	// 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.
	OperationName *string `pulumi:"operationName"`
	// 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 either `Error`, `Empty` (built-in models) or `apigateway.Model`'s `name`.
	RequestModels map[string]string `pulumi:"requestModels"`
	// 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 header `X-Some-Header` and the query string `some-query-param` must be provided in the request.
	RequestParameters map[string]bool `pulumi:"requestParameters"`
	// ID of a `apigateway.RequestValidator`
	RequestValidatorId *string `pulumi:"requestValidatorId"`
	// API resource ID
	ResourceId string `pulumi:"resourceId"`
	// ID of the associated REST API
	RestApi interface{} `pulumi:"restApi"`
}

// The set of arguments for constructing a Method resource.
type MethodArgs struct {
	// Specify if the method requires an API key
	ApiKeyRequired pulumi.BoolPtrInput
	// Type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
	Authorization pulumi.StringInput
	// Authorization scopes used when the authorization is `COGNITO_USER_POOLS`
	AuthorizationScopes pulumi.StringArrayInput
	// Authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
	AuthorizerId pulumi.StringPtrInput
	// HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
	HttpMethod pulumi.StringInput
	// 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.
	OperationName pulumi.StringPtrInput
	// 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 either `Error`, `Empty` (built-in models) or `apigateway.Model`'s `name`.
	RequestModels pulumi.StringMapInput
	// 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 header `X-Some-Header` and the query string `some-query-param` must be provided in the request.
	RequestParameters pulumi.BoolMapInput
	// ID of a `apigateway.RequestValidator`
	RequestValidatorId pulumi.StringPtrInput
	// API resource ID
	ResourceId pulumi.StringInput
	// ID of the associated REST API
	RestApi pulumi.Input
}

func (MethodArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*methodArgs)(nil)).Elem()
}

type MethodInput interface {
	pulumi.Input

	ToMethodOutput() MethodOutput
	ToMethodOutputWithContext(ctx context.Context) MethodOutput
}

func (*Method) ElementType() reflect.Type {
	return reflect.TypeOf((**Method)(nil)).Elem()
}

func (i *Method) ToMethodOutput() MethodOutput {
	return i.ToMethodOutputWithContext(context.Background())
}

func (i *Method) ToMethodOutputWithContext(ctx context.Context) MethodOutput {
	return pulumi.ToOutputWithContext(ctx, i).(MethodOutput)
}

// MethodArrayInput is an input type that accepts MethodArray and MethodArrayOutput values.
// You can construct a concrete instance of `MethodArrayInput` via:
//
//	MethodArray{ MethodArgs{...} }
type MethodArrayInput interface {
	pulumi.Input

	ToMethodArrayOutput() MethodArrayOutput
	ToMethodArrayOutputWithContext(context.Context) MethodArrayOutput
}

type MethodArray []MethodInput

func (MethodArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*Method)(nil)).Elem()
}

func (i MethodArray) ToMethodArrayOutput() MethodArrayOutput {
	return i.ToMethodArrayOutputWithContext(context.Background())
}

func (i MethodArray) ToMethodArrayOutputWithContext(ctx context.Context) MethodArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(MethodArrayOutput)
}

// MethodMapInput is an input type that accepts MethodMap and MethodMapOutput values.
// You can construct a concrete instance of `MethodMapInput` via:
//
//	MethodMap{ "key": MethodArgs{...} }
type MethodMapInput interface {
	pulumi.Input

	ToMethodMapOutput() MethodMapOutput
	ToMethodMapOutputWithContext(context.Context) MethodMapOutput
}

type MethodMap map[string]MethodInput

func (MethodMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*Method)(nil)).Elem()
}

func (i MethodMap) ToMethodMapOutput() MethodMapOutput {
	return i.ToMethodMapOutputWithContext(context.Background())
}

func (i MethodMap) ToMethodMapOutputWithContext(ctx context.Context) MethodMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(MethodMapOutput)
}

type MethodOutput struct{ *pulumi.OutputState }

func (MethodOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**Method)(nil)).Elem()
}

func (o MethodOutput) ToMethodOutput() MethodOutput {
	return o
}

func (o MethodOutput) ToMethodOutputWithContext(ctx context.Context) MethodOutput {
	return o
}

// Specify if the method requires an API key
func (o MethodOutput) ApiKeyRequired() pulumi.BoolPtrOutput {
	return o.ApplyT(func(v *Method) pulumi.BoolPtrOutput { return v.ApiKeyRequired }).(pulumi.BoolPtrOutput)
}

// Type of authorization used for the method (`NONE`, `CUSTOM`, `AWS_IAM`, `COGNITO_USER_POOLS`)
func (o MethodOutput) Authorization() pulumi.StringOutput {
	return o.ApplyT(func(v *Method) pulumi.StringOutput { return v.Authorization }).(pulumi.StringOutput)
}

// Authorization scopes used when the authorization is `COGNITO_USER_POOLS`
func (o MethodOutput) AuthorizationScopes() pulumi.StringArrayOutput {
	return o.ApplyT(func(v *Method) pulumi.StringArrayOutput { return v.AuthorizationScopes }).(pulumi.StringArrayOutput)
}

// Authorizer id to be used when the authorization is `CUSTOM` or `COGNITO_USER_POOLS`
func (o MethodOutput) AuthorizerId() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *Method) pulumi.StringPtrOutput { return v.AuthorizerId }).(pulumi.StringPtrOutput)
}

// HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`)
func (o MethodOutput) HttpMethod() pulumi.StringOutput {
	return o.ApplyT(func(v *Method) pulumi.StringOutput { return v.HttpMethod }).(pulumi.StringOutput)
}

// 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.
func (o MethodOutput) OperationName() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *Method) pulumi.StringPtrOutput { return v.OperationName }).(pulumi.StringPtrOutput)
}

// 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 either `Error`, `Empty` (built-in models) or `apigateway.Model`'s `name`.
func (o MethodOutput) RequestModels() pulumi.StringMapOutput {
	return o.ApplyT(func(v *Method) pulumi.StringMapOutput { return v.RequestModels }).(pulumi.StringMapOutput)
}

// 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 header `X-Some-Header` and the query string `some-query-param` must be provided in the request.
func (o MethodOutput) RequestParameters() pulumi.BoolMapOutput {
	return o.ApplyT(func(v *Method) pulumi.BoolMapOutput { return v.RequestParameters }).(pulumi.BoolMapOutput)
}

// ID of a `apigateway.RequestValidator`
func (o MethodOutput) RequestValidatorId() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *Method) pulumi.StringPtrOutput { return v.RequestValidatorId }).(pulumi.StringPtrOutput)
}

// API resource ID
func (o MethodOutput) ResourceId() pulumi.StringOutput {
	return o.ApplyT(func(v *Method) pulumi.StringOutput { return v.ResourceId }).(pulumi.StringOutput)
}

// ID of the associated REST API
func (o MethodOutput) RestApi() pulumi.StringOutput {
	return o.ApplyT(func(v *Method) pulumi.StringOutput { return v.RestApi }).(pulumi.StringOutput)
}

type MethodArrayOutput struct{ *pulumi.OutputState }

func (MethodArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*Method)(nil)).Elem()
}

func (o MethodArrayOutput) ToMethodArrayOutput() MethodArrayOutput {
	return o
}

func (o MethodArrayOutput) ToMethodArrayOutputWithContext(ctx context.Context) MethodArrayOutput {
	return o
}

func (o MethodArrayOutput) Index(i pulumi.IntInput) MethodOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *Method {
		return vs[0].([]*Method)[vs[1].(int)]
	}).(MethodOutput)
}

type MethodMapOutput struct{ *pulumi.OutputState }

func (MethodMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*Method)(nil)).Elem()
}

func (o MethodMapOutput) ToMethodMapOutput() MethodMapOutput {
	return o
}

func (o MethodMapOutput) ToMethodMapOutputWithContext(ctx context.Context) MethodMapOutput {
	return o
}

func (o MethodMapOutput) MapIndex(k pulumi.StringInput) MethodOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *Method {
		return vs[0].(map[string]*Method)[vs[1].(string)]
	}).(MethodOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*MethodInput)(nil)).Elem(), &Method{})
	pulumi.RegisterInputType(reflect.TypeOf((*MethodArrayInput)(nil)).Elem(), MethodArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*MethodMapInput)(nil)).Elem(), MethodMap{})
	pulumi.RegisterOutputType(MethodOutput{})
	pulumi.RegisterOutputType(MethodArrayOutput{})
	pulumi.RegisterOutputType(MethodMapOutput{})
}