Class MethodArgs

Inheritance

System.Object

InputArgs

ResourceArgs

MethodArgs

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.ApiGateway

Assembly: Pulumi.Aws.dll

Syntax

public sealed class MethodArgs : ResourceArgs

Constructors

MethodArgs()

Declaration

public MethodArgs()

Properties

ApiKeyRequired

Specify if the method requires an API key

Declaration

public Input<bool> ApiKeyRequired { get; set; }

Property Value

Type	Description
Input<System.Boolean>

Authorization

The type of authorization used for the method (NONE, CUSTOM, AWS_IAM, COGNITO_USER_POOLS)

Declaration

public Input<string> Authorization { get; set; }

Property Value

Type	Description
Input<System.String>

AuthorizationScopes

The authorization scopes used when the authorization is COGNITO_USER_POOLS

Declaration

public InputList<string> AuthorizationScopes { get; set; }

Property Value

Type	Description
InputList<System.String>

AuthorizerId

The authorizer id to be used when the authorization is CUSTOM or COGNITO_USER_POOLS

Declaration

public Input<string> AuthorizerId { get; set; }

Property Value

Type	Description
Input<System.String>

HttpMethod

The HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY)

Declaration

public Input<string> HttpMethod { get; set; }

Property Value

Type	Description
Input<System.String>

RequestModels

A 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 aws.apigateway.Model's name.

Declaration

public InputMap<string> RequestModels { get; set; }

Property Value

Type	Description
InputMap<System.String>

RequestParameters

A 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: request_parameters = {"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.

Declaration

public InputMap<bool> RequestParameters { get; set; }

Property Value

Type	Description
InputMap<System.Boolean>

RequestValidatorId

The ID of a aws.apigateway.RequestValidator

Declaration

public Input<string> RequestValidatorId { get; set; }

Property Value

Type	Description
Input<System.String>

ResourceId

The API resource ID

Declaration

public Input<string> ResourceId { get; set; }

Property Value

Type	Description
Input<System.String>

RestApi

The ID of the associated REST API

Declaration

public Input<string> RestApi { get; set; }

Property Value

Type	Description
Input<System.String>