AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

getMethod

Resource Type definition for AWS::ApiGateway::Method

Using getMethod

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMethod(args: GetMethodArgs, opts?: InvokeOptions): Promise<GetMethodResult>
function getMethodOutput(args: GetMethodOutputArgs, opts?: InvokeOptions): Output<GetMethodResult>
def get_method(http_method: Optional[str] = None,
               resource_id: Optional[str] = None,
               rest_api_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetMethodResult
def get_method_output(http_method: Optional[pulumi.Input[str]] = None,
               resource_id: Optional[pulumi.Input[str]] = None,
               rest_api_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetMethodResult]
func LookupMethod(ctx *Context, args *LookupMethodArgs, opts ...InvokeOption) (*LookupMethodResult, error)
func LookupMethodOutput(ctx *Context, args *LookupMethodOutputArgs, opts ...InvokeOption) LookupMethodResultOutput

> Note: This function is named LookupMethod in the Go SDK.

public static class GetMethod 
{
    public static Task<GetMethodResult> InvokeAsync(GetMethodArgs args, InvokeOptions? opts = null)
    public static Output<GetMethodResult> Invoke(GetMethodInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMethodResult> getMethod(GetMethodArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:apigateway:getMethod
  Arguments:
    # Arguments dictionary

The following arguments are supported:

HttpMethod string

The backend system that the method calls when it receives a request.

ResourceId string

The ID of an API Gateway resource.

RestApiId string

The ID of the RestApi resource in which API Gateway creates the method.

HttpMethod string

The backend system that the method calls when it receives a request.

ResourceId string

The ID of an API Gateway resource.

RestApiId string

The ID of the RestApi resource in which API Gateway creates the method.

httpMethod String

The backend system that the method calls when it receives a request.

resourceId String

The ID of an API Gateway resource.

restApiId String

The ID of the RestApi resource in which API Gateway creates the method.

httpMethod string

The backend system that the method calls when it receives a request.

resourceId string

The ID of an API Gateway resource.

restApiId string

The ID of the RestApi resource in which API Gateway creates the method.

http_method str

The backend system that the method calls when it receives a request.

resource_id str

The ID of an API Gateway resource.

rest_api_id str

The ID of the RestApi resource in which API Gateway creates the method.

httpMethod String

The backend system that the method calls when it receives a request.

resourceId String

The ID of an API Gateway resource.

restApiId String

The ID of the RestApi resource in which API Gateway creates the method.

getMethod Result

The following output properties are available:

ApiKeyRequired bool

Indicates whether the method requires clients to submit a valid API key.

AuthorizationScopes List<string>

A list of authorization scopes configured on the method.

AuthorizationType Pulumi.AwsNative.ApiGateway.MethodAuthorizationType

The method's authorization type.

AuthorizerId string

The identifier of the authorizer to use on this method.

Integration Pulumi.AwsNative.ApiGateway.Outputs.MethodIntegration

The backend system that the method calls when it receives a request.

MethodResponses List<Pulumi.AwsNative.ApiGateway.Outputs.MethodResponse>

The responses that can be sent to the client who calls the method.

OperationName string

A friendly operation name for the method.

RequestModels object

The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.

RequestParameters object

The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.

RequestValidatorId string

The ID of the associated request validator.

ApiKeyRequired bool

Indicates whether the method requires clients to submit a valid API key.

AuthorizationScopes []string

A list of authorization scopes configured on the method.

AuthorizationType MethodAuthorizationType

The method's authorization type.

AuthorizerId string

The identifier of the authorizer to use on this method.

Integration MethodIntegration

The backend system that the method calls when it receives a request.

MethodResponses []MethodResponse

The responses that can be sent to the client who calls the method.

OperationName string

A friendly operation name for the method.

RequestModels interface{}

The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.

RequestParameters interface{}

The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.

RequestValidatorId string

The ID of the associated request validator.

apiKeyRequired Boolean

Indicates whether the method requires clients to submit a valid API key.

authorizationScopes List<String>

A list of authorization scopes configured on the method.

authorizationType MethodAuthorizationType

The method's authorization type.

authorizerId String

The identifier of the authorizer to use on this method.

integration MethodIntegration

The backend system that the method calls when it receives a request.

methodResponses List<MethodResponse>

The responses that can be sent to the client who calls the method.

operationName String

A friendly operation name for the method.

requestModels Object

The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.

requestParameters Object

The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.

requestValidatorId String

The ID of the associated request validator.

apiKeyRequired boolean

Indicates whether the method requires clients to submit a valid API key.

authorizationScopes string[]

A list of authorization scopes configured on the method.

authorizationType MethodAuthorizationType

The method's authorization type.

authorizerId string

The identifier of the authorizer to use on this method.

integration MethodIntegration

The backend system that the method calls when it receives a request.

methodResponses MethodResponse[]

The responses that can be sent to the client who calls the method.

operationName string

A friendly operation name for the method.

requestModels any

The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.

requestParameters any

The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.

requestValidatorId string

The ID of the associated request validator.

api_key_required bool

Indicates whether the method requires clients to submit a valid API key.

authorization_scopes Sequence[str]

A list of authorization scopes configured on the method.

authorization_type MethodAuthorizationType

The method's authorization type.

authorizer_id str

The identifier of the authorizer to use on this method.

integration MethodIntegration

The backend system that the method calls when it receives a request.

method_responses Sequence[MethodResponse]

The responses that can be sent to the client who calls the method.

operation_name str

A friendly operation name for the method.

request_models Any

The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.

request_parameters Any

The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.

request_validator_id str

The ID of the associated request validator.

apiKeyRequired Boolean

Indicates whether the method requires clients to submit a valid API key.

authorizationScopes List<String>

A list of authorization scopes configured on the method.

authorizationType "NONE" | "AWS_IAM" | "CUSTOM" | "COGNITO_USER_POOLS"

The method's authorization type.

authorizerId String

The identifier of the authorizer to use on this method.

integration Property Map

The backend system that the method calls when it receives a request.

methodResponses List<Property Map>

The responses that can be sent to the client who calls the method.

operationName String

A friendly operation name for the method.

requestModels Any

The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.

requestParameters Any

The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.

requestValidatorId String

The ID of the associated request validator.

Supporting Types

MethodAuthorizationType

MethodIntegration

Type Pulumi.AwsNative.ApiGateway.MethodIntegrationType

The type of backend that your method is running.

CacheKeyParameters List<string>

A list of request parameters whose values API Gateway caches.

CacheNamespace string

An API-specific tag group of related cached parameters.

ConnectionId string

The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.

ConnectionType Pulumi.AwsNative.ApiGateway.MethodIntegrationConnectionType

The type of the network connection to the integration endpoint.

ContentHandling Pulumi.AwsNative.ApiGateway.MethodIntegrationContentHandling

Specifies how to handle request payload content type conversions.

Credentials string

The credentials that are required for the integration.

IntegrationHttpMethod string

The integration's HTTP method type.

IntegrationResponses List<Pulumi.AwsNative.ApiGateway.Inputs.MethodIntegrationResponse>

The response that API Gateway provides after a method's backend completes processing a request.

PassthroughBehavior Pulumi.AwsNative.ApiGateway.MethodIntegrationPassthroughBehavior

Indicates when API Gateway passes requests to the targeted backend.

RequestParameters object

The request parameters that API Gateway sends with the backend request.

RequestTemplates object

A map of Apache Velocity templates that are applied on the request payload.

TimeoutInMillis int

Custom timeout between 50 and 29,000 milliseconds.

Uri string

The Uniform Resource Identifier (URI) for the integration.

Type MethodIntegrationType

The type of backend that your method is running.

CacheKeyParameters []string

A list of request parameters whose values API Gateway caches.

CacheNamespace string

An API-specific tag group of related cached parameters.

ConnectionId string

The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.

ConnectionType MethodIntegrationConnectionType

The type of the network connection to the integration endpoint.

ContentHandling MethodIntegrationContentHandling

Specifies how to handle request payload content type conversions.

Credentials string

The credentials that are required for the integration.

IntegrationHttpMethod string

The integration's HTTP method type.

IntegrationResponses []MethodIntegrationResponse

The response that API Gateway provides after a method's backend completes processing a request.

PassthroughBehavior MethodIntegrationPassthroughBehavior

Indicates when API Gateway passes requests to the targeted backend.

RequestParameters interface{}

The request parameters that API Gateway sends with the backend request.

RequestTemplates interface{}

A map of Apache Velocity templates that are applied on the request payload.

TimeoutInMillis int

Custom timeout between 50 and 29,000 milliseconds.

Uri string

The Uniform Resource Identifier (URI) for the integration.

type MethodIntegrationType

The type of backend that your method is running.

cacheKeyParameters List<String>

A list of request parameters whose values API Gateway caches.

cacheNamespace String

An API-specific tag group of related cached parameters.

connectionId String

The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.

connectionType MethodIntegrationConnectionType

The type of the network connection to the integration endpoint.

contentHandling MethodIntegrationContentHandling

Specifies how to handle request payload content type conversions.

credentials String

The credentials that are required for the integration.

integrationHttpMethod String

The integration's HTTP method type.

integrationResponses List<MethodIntegrationResponse>

The response that API Gateway provides after a method's backend completes processing a request.

passthroughBehavior MethodIntegrationPassthroughBehavior

Indicates when API Gateway passes requests to the targeted backend.

requestParameters Object

The request parameters that API Gateway sends with the backend request.

requestTemplates Object

A map of Apache Velocity templates that are applied on the request payload.

timeoutInMillis Integer

Custom timeout between 50 and 29,000 milliseconds.

uri String

The Uniform Resource Identifier (URI) for the integration.

type MethodIntegrationType

The type of backend that your method is running.

cacheKeyParameters string[]

A list of request parameters whose values API Gateway caches.

cacheNamespace string

An API-specific tag group of related cached parameters.

connectionId string

The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.

connectionType MethodIntegrationConnectionType

The type of the network connection to the integration endpoint.

contentHandling MethodIntegrationContentHandling

Specifies how to handle request payload content type conversions.

credentials string

The credentials that are required for the integration.

integrationHttpMethod string

The integration's HTTP method type.

integrationResponses MethodIntegrationResponse[]

The response that API Gateway provides after a method's backend completes processing a request.

passthroughBehavior MethodIntegrationPassthroughBehavior

Indicates when API Gateway passes requests to the targeted backend.

requestParameters any

The request parameters that API Gateway sends with the backend request.

requestTemplates any

A map of Apache Velocity templates that are applied on the request payload.

timeoutInMillis number

Custom timeout between 50 and 29,000 milliseconds.

uri string

The Uniform Resource Identifier (URI) for the integration.

type MethodIntegrationType

The type of backend that your method is running.

cache_key_parameters Sequence[str]

A list of request parameters whose values API Gateway caches.

cache_namespace str

An API-specific tag group of related cached parameters.

connection_id str

The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.

connection_type MethodIntegrationConnectionType

The type of the network connection to the integration endpoint.

content_handling MethodIntegrationContentHandling

Specifies how to handle request payload content type conversions.

credentials str

The credentials that are required for the integration.

integration_http_method str

The integration's HTTP method type.

integration_responses Sequence[MethodIntegrationResponse]

The response that API Gateway provides after a method's backend completes processing a request.

passthrough_behavior MethodIntegrationPassthroughBehavior

Indicates when API Gateway passes requests to the targeted backend.

request_parameters Any

The request parameters that API Gateway sends with the backend request.

request_templates Any

A map of Apache Velocity templates that are applied on the request payload.

timeout_in_millis int

Custom timeout between 50 and 29,000 milliseconds.

uri str

The Uniform Resource Identifier (URI) for the integration.

type "AWS" | "AWS_PROXY" | "HTTP" | "HTTP_PROXY" | "MOCK"

The type of backend that your method is running.

cacheKeyParameters List<String>

A list of request parameters whose values API Gateway caches.

cacheNamespace String

An API-specific tag group of related cached parameters.

connectionId String

The ID of the VpcLink used for the integration when connectionType=VPC_LINK, otherwise undefined.

connectionType "INTERNET" | "VPC_LINK"

The type of the network connection to the integration endpoint.

contentHandling "CONVERT_TO_BINARY" | "CONVERT_TO_TEXT"

Specifies how to handle request payload content type conversions.

credentials String

The credentials that are required for the integration.

integrationHttpMethod String

The integration's HTTP method type.

integrationResponses List<Property Map>

The response that API Gateway provides after a method's backend completes processing a request.

passthroughBehavior "WHEN_NO_MATCH" | "WHEN_NO_TEMPLATES" | "NEVER"

Indicates when API Gateway passes requests to the targeted backend.

requestParameters Any

The request parameters that API Gateway sends with the backend request.

requestTemplates Any

A map of Apache Velocity templates that are applied on the request payload.

timeoutInMillis Number

Custom timeout between 50 and 29,000 milliseconds.

uri String

The Uniform Resource Identifier (URI) for the integration.

MethodIntegrationConnectionType

MethodIntegrationContentHandling

MethodIntegrationPassthroughBehavior

MethodIntegrationResponse

StatusCode string

The status code that API Gateway uses to map the integration response to a MethodResponse status code.

ContentHandling Pulumi.AwsNative.ApiGateway.MethodIntegrationResponseContentHandling

Specifies how to handle request payload content type conversions.

ResponseParameters object

The response parameters from the backend response that API Gateway sends to the method response.

ResponseTemplates object

The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.

SelectionPattern string

A regular expression that specifies which error strings or status codes from the backend map to the integration response.

StatusCode string

The status code that API Gateway uses to map the integration response to a MethodResponse status code.

ContentHandling MethodIntegrationResponseContentHandling

Specifies how to handle request payload content type conversions.

ResponseParameters interface{}

The response parameters from the backend response that API Gateway sends to the method response.

ResponseTemplates interface{}

The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.

SelectionPattern string

A regular expression that specifies which error strings or status codes from the backend map to the integration response.

statusCode String

The status code that API Gateway uses to map the integration response to a MethodResponse status code.

contentHandling MethodIntegrationResponseContentHandling

Specifies how to handle request payload content type conversions.

responseParameters Object

The response parameters from the backend response that API Gateway sends to the method response.

responseTemplates Object

The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.

selectionPattern String

A regular expression that specifies which error strings or status codes from the backend map to the integration response.

statusCode string

The status code that API Gateway uses to map the integration response to a MethodResponse status code.

contentHandling MethodIntegrationResponseContentHandling

Specifies how to handle request payload content type conversions.

responseParameters any

The response parameters from the backend response that API Gateway sends to the method response.

responseTemplates any

The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.

selectionPattern string

A regular expression that specifies which error strings or status codes from the backend map to the integration response.

status_code str

The status code that API Gateway uses to map the integration response to a MethodResponse status code.

content_handling MethodIntegrationResponseContentHandling

Specifies how to handle request payload content type conversions.

response_parameters Any

The response parameters from the backend response that API Gateway sends to the method response.

response_templates Any

The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.

selection_pattern str

A regular expression that specifies which error strings or status codes from the backend map to the integration response.

statusCode String

The status code that API Gateway uses to map the integration response to a MethodResponse status code.

contentHandling "CONVERT_TO_BINARY" | "CONVERT_TO_TEXT"

Specifies how to handle request payload content type conversions.

responseParameters Any

The response parameters from the backend response that API Gateway sends to the method response.

responseTemplates Any

The templates that are used to transform the integration response body. Specify templates as key-value pairs (string-to-string mappings), with a content type as the key and a template as the value.

selectionPattern String

A regular expression that specifies which error strings or status codes from the backend map to the integration response.

MethodIntegrationResponseContentHandling

MethodIntegrationType

MethodResponse

StatusCode string

The method response's status code, which you map to an IntegrationResponse.

ResponseModels object

The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

ResponseParameters object

Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

StatusCode string

The method response's status code, which you map to an IntegrationResponse.

ResponseModels interface{}

The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

ResponseParameters interface{}

Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

statusCode String

The method response's status code, which you map to an IntegrationResponse.

responseModels Object

The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

responseParameters Object

Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

statusCode string

The method response's status code, which you map to an IntegrationResponse.

responseModels any

The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

responseParameters any

Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

status_code str

The method response's status code, which you map to an IntegrationResponse.

response_models Any

The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

response_parameters Any

Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

statusCode String

The method response's status code, which you map to an IntegrationResponse.

responseModels Any

The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

responseParameters Any

Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0